diff --git a/README.md b/README.md index cf983ec..9850e31 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,5 @@ # Pangolin Documentation -Welcome to the official documentation for [Pangolin](https://github.com/fosrl/pangolin), a modern reverse proxy and networking solution. This documentation site is hosted at [docs.pangolin.net](https://docs.pangolin.net) and provides comprehensive guides, API references, and resources for getting started with Pangolin. - -## About This Documentation - -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. - -## Development & Contributing - This documentation site is built using [Mintlify](https://mintlify.com). If you'd like to contribute to the documentation or run it locally for development, follow the instructions below. ### Local Development diff --git a/about/how-pangolin-works.mdx b/about/how-pangolin-works.mdx index 6e7a254..75cbc1f 100644 --- a/about/how-pangolin-works.mdx +++ b/about/how-pangolin-works.mdx @@ -66,7 +66,7 @@ Users authenticate through the client using their accounts. Machines connect wit Clients are available for Mac, Windows, and Linux. They work transparently with applications, so no application configuration is required. - + Learn about clients and where to download them for Mac, Windows, and Linux. diff --git a/additional-resources/trust-center.mdx b/additional-resources/trust-center.mdx index ce9df79..5be1101 100644 --- a/additional-resources/trust-center.mdx +++ b/additional-resources/trust-center.mdx @@ -6,4 +6,4 @@ icon: "scale-balanced" - [Terms of Service](https://pangolin.net/terms-of-service.html) - [Privacy Policy](https://pangolin.net/privacy-policy.html) - [AGLPv3](https://www.gnu.org/licenses/gpl-3.0.en.html) -- [Fossorial Commercial License (FCL)](https://pangolin.net/fcl.hmtl) +- [Fossorial Commercial License (FCL)](https://pangolin.net/fcl.html) diff --git a/manage/access-control/forwarded-headers.mdx b/manage/access-control/forwarded-headers.mdx index bdc5a1f..7e2d695 100644 --- a/manage/access-control/forwarded-headers.mdx +++ b/manage/access-control/forwarded-headers.mdx @@ -18,6 +18,7 @@ Pangolin forwards the following headers to your backend when user identity is av | `Remote-User` | Unique username or user ID | `user_123` | | `Remote-Email` | User's email address | `john.doe@example.com` | | `Remote-Name` | User's full name | `John Doe` | +| `Remote-Role` | User's role or group membership | `admin` | ## Authentication Methods diff --git a/manage/access-control/rules.mdx b/manage/access-control/rules.mdx index b7993e7..052053f 100644 --- a/manage/access-control/rules.mdx +++ b/manage/access-control/rules.mdx @@ -71,7 +71,7 @@ CIDR (Classless Inter-Domain Routing) notation specifies IP address ranges using **Examples:** -- `144.234.11.22/24` - Matches all 256 IPs from 192.168.1.0 to 192.168.1.255 +- `192.168.1.0/0` - Matches all 256 IPs from 192.168.1.0 to 192.168.1.255 - `10.0.0.0/8` - Matches any IP starting with 10 (16.7 million addresses) - `2001:db8::/32` - Matches a range of IPv6 addresses - `0.0.0.0/0` - Matches all IPv4 addresses diff --git a/manage/clients/install-client.mdx b/manage/clients/install-client.mdx index 631e6fd..b6391d9 100644 --- a/manage/clients/install-client.mdx +++ b/manage/clients/install-client.mdx @@ -227,7 +227,9 @@ services: ### Windows Service -On Windows, olm has to be installed and run as a Windows service. When running it with the cli args, it will attempt to install and run the service to function like a cli tool. You can also run the following: +On Windows, olm has to be installed and run as a Windows service. When running it with the cli args, it will attempt to install and run the service to function like a cli tool. + +Minimum Windows version: Windows 10 #### Service Management Commands diff --git a/manage/sites/install-kubernetes.mdx b/manage/sites/install-kubernetes.mdx index 12c5cc2..f0fb719 100644 --- a/manage/sites/install-kubernetes.mdx +++ b/manage/sites/install-kubernetes.mdx @@ -41,13 +41,13 @@ All Fossorial Helm charts are available on Artifact Hub. See diff --git a/self-host/advanced/config-file.mdx b/self-host/advanced/config-file.mdx index 1b22786..7af91be 100644 --- a/self-host/advanced/config-file.mdx +++ b/self-host/advanced/config-file.mdx @@ -791,38 +791,6 @@ This section contains the complete reference for all configuration options in `c -### DNS Configuration - - - DNS settings for domain name resolution and CNAME extensions. - - - - List of nameservers used for DNS resolution. - - **Example**: `["ns1.example.com", "ns2.example.com"]` - - **Default**: `["ns1.pangolin.net", "ns2.pangolin.net", "ns3.pangolin.net"]` - - - These nameservers are used for DNS queries and domain resolution. - - - - - Domain extension used for CNAME record management. - - **Example**: `cname.example.com` - - **Default**: `cname.pangolin.net` - - - Used for creating CNAME records for dynamic domain routing. - - - - - ## Environment Variables Some configuration values can be set using environment variables for enhanced security: diff --git a/self-host/advanced/integration-api.mdx b/self-host/advanced/integration-api.mdx index 207707d..b804467 100644 --- a/self-host/advanced/integration-api.mdx +++ b/self-host/advanced/integration-api.mdx @@ -35,6 +35,7 @@ Add the following configuration to your `config/traefik/dynamic_config.yml` to e - web middlewares: - redirect-to-https + - badger # If you have Badger >=1.3.0 and it's enabled in the middlewares section of the dynamic config int-api-router: rule: "Host(`api.example.com`)" diff --git a/self-host/enterprise-edition.mdx b/self-host/enterprise-edition.mdx index 8f3c5ab..18c5821 100644 --- a/self-host/enterprise-edition.mdx +++ b/self-host/enterprise-edition.mdx @@ -27,7 +27,7 @@ The Enterprise Edition is distributed under the **Fossorial Commercial License** **Free for individuals and small businesses** - - **Revenue threshold**: Less than $100,000 USD annual revenue + - **Revenue threshold**: Less than $100,000 USD gross annual revenue - **License cost**: Free - **Features**: Full access to all "Paid Features" - **Usage**: Personal and small business use allowed @@ -40,7 +40,7 @@ The Enterprise Edition is distributed under the **Fossorial Commercial License** **Larger businesses require a paid license** - - **Revenue threshold**: $100,000+ USD annual revenue + - **Revenue threshold**: $100,000+ USD gross annual revenue - **License cost**: Paid license required - **Features**: Full access to all "Paid Features" - **Usage**: Business use with commercial terms @@ -189,4 +189,14 @@ Include your organization details and use case for faster assistance. Personal use is explicitly allowed under the free license terms. + + + **No exceptions - same license terms apply** + + Educational institutions, non-profit organizations, and government entities are subject to the same license terms as all other organizations. There are no special exceptions or discounts for these groups. + + + If you have questions about how your organization's revenue is calculated for licensing purposes, contact [sales@pangolin.net](mailto:sales@pangolin.net). + + diff --git a/self-host/manual/docker-compose.mdx b/self-host/manual/docker-compose.mdx index 9954d1a..ae6ed4f 100644 --- a/self-host/manual/docker-compose.mdx +++ b/self-host/manual/docker-compose.mdx @@ -254,6 +254,10 @@ Create `config/traefik/dynamic_config.yml`: ```yaml title="config/traefik/dynamic_config.yml" http: middlewares: + badger: + plugin: + badger: + disableForwardAuth: true redirect-to-https: redirectScheme: scheme: https @@ -267,6 +271,7 @@ http: - web middlewares: - redirect-to-https + - badger # Next.js router (handles everything except API and WebSocket paths) next-router: @@ -274,6 +279,8 @@ http: service: next-service entryPoints: - websecure + middlewares: + - badger tls: certResolver: letsencrypt @@ -283,6 +290,8 @@ http: service: api-service entryPoints: - websecure + middlewares: + - badger tls: certResolver: letsencrypt @@ -292,6 +301,8 @@ http: service: api-service entryPoints: - websecure + middlewares: + - badger tls: certResolver: letsencrypt diff --git a/self-host/manual/unraid.mdx b/self-host/manual/unraid.mdx index 79e29f1..61e8b37 100644 --- a/self-host/manual/unraid.mdx +++ b/self-host/manual/unraid.mdx @@ -170,6 +170,10 @@ The domain you enter here is what will be used to access the main Pangolin dashb ```yaml title="pangolin/config/traefik/dynamic_config.yml" http: middlewares: + badger: + plugin: + badger: + disableForwardAuth: true redirect-to-https: redirectScheme: scheme: https @@ -183,6 +187,7 @@ http: - web middlewares: - redirect-to-https + - badger # Next.js router (handles everything except API and WebSocket paths) next-router: @@ -190,6 +195,8 @@ http: service: next-service entryPoints: - websecure + middlewares: + - badger tls: certResolver: letsencrypt @@ -199,6 +206,8 @@ http: service: api-service entryPoints: - websecure + middlewares: + - badger tls: certResolver: letsencrypt @@ -208,6 +217,8 @@ http: service: api-service entryPoints: - websecure + middlewares: + - badger tls: certResolver: letsencrypt diff --git a/self-host/supporter-program.mdx b/self-host/supporter-program.mdx index d6348a5..e432e91 100644 --- a/self-host/supporter-program.mdx +++ b/self-host/supporter-program.mdx @@ -79,7 +79,7 @@ Pangolin self-hosted will always be free and open source, but maintaining the pr -Github sponsors does not currently support other payment methods but we can process these things manually and send you a key. Please reach out to contact@pangolin.net and we will get you sorted. +Github sponsors does not currently support other payment methods. We hope to add more options in the future. **Unlimited usage**