Welcome to the official documentation for Pangolin, a modern reverse proxy and networking solution. This documentation site is hosted at docs.digpangolin.com and provides comprehensive guides, API references, and resources for getting started with Pangolin.
This documentation covers everything you need to know about Pangolin, including:
- Installation and setup guides
- Configuration options
- API reference
- Self-hosting instructions
- Development and contribution guidelines
All contributions to improve this documentation are welcome! Feel free to submit issues or pull requests to help make these docs better for everyone.
This documentation site is built using Mintlify. If you'd like to contribute to the documentation or run it locally for development, follow the instructions below.
Install the Mintlify CLI to preview your documentation changes locally:
npm i -g mintRun the following command at the root of your documentation, where your docs.json is located:
mint devView your local preview at http://localhost:3000.
Install our GitHub app from your dashboard to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
- If your dev environment isn't running: Run
mint updateto ensure you have the most recent version of the CLI. - If a page loads as a 404: Make sure you are running in a folder with a valid
docs.json.