diff --git a/docs.json b/docs.json index d29f2df..11cbe57 100644 --- a/docs.json +++ b/docs.json @@ -126,7 +126,8 @@ "self-host/community-guides/traefiklogsdashboard" ] }, - "self-host/telemetry" + "self-host/telemetry", + "self-host/enterprise-edition" ] }, { diff --git a/self-host/enterprise-edition.mdx b/self-host/enterprise-edition.mdx new file mode 100644 index 0000000..8ca6d78 --- /dev/null +++ b/self-host/enterprise-edition.mdx @@ -0,0 +1,207 @@ +--- +title: "Enterprise Edition" +description: "Learn about Pangolin Enterprise Edition features, licensing, and how to get started" +--- + +When self-hosting Pangolin, you can choose to run the **Community Edition** or the **Enterprise Edition**. Both editions provide the same core functionality, but the Enterprise Edition unlocks additional features for qualifying users. + +## Edition Comparison + + + + • Fully compliant with AGPL-3 license + • All core Pangolin features included + • Perfect for personal use and small teams + + + + • Distributed under Fossorial Commercial License + • Includes all Community Edition features + • Unlocks "Paid Features" for qualifying users + • Requires valid license key for activation + + + +## Licensing Overview + +The Enterprise Edition is distributed under the **Fossorial Commercial License**, which provides different terms based on your organization's revenue: + + + + **Free for individuals and small businesses** + + - **Revenue threshold**: Less than $100,000 USD annual revenue + - **License cost**: Free + - **Features**: Full access to all "Paid Features" + - **Usage**: Personal and small business use allowed + + + You still need to acquire a valid license key to unlock Enterprise features, even with free licensing. + + + + + **Larger businesses require a paid license** + + - **Revenue threshold**: $100,000+ USD annual revenue + - **License cost**: Paid license required + - **Features**: Full access to all "Paid Features" + - **Usage**: Business use with commercial terms + + + Businesses exceeding the revenue threshold must purchase a commercial license to use Enterprise Edition features. + + + + +## Getting Your License Key + + + + Visit [pangolin.fossorial.io](https://pangolin.fossorial.io) and create your account. + + + + After logging in, go to the **Licenses** section in your account dashboard. + + + + Complete the license application form. + + + Innacurate representation is a violation of the license and will result in the license being revoked. + + + + + Once approved, you'll receive your license key immediately. You can then activate it in your Pangolin instance in the Server Admin panel. + + + +## License Requirements + + + + **One key per Pangolin server instance** + + Each host (server) running Pangolin requires its own license key. You cannot share a single key across multiple servers. + + + If you're running multiple Pangolin instances for high availability, each database needs its own license key. + + + + + **7-day trial available for commercial users** + + Businesses that don't qualify for free licensing can request a 7-day trial key to evaluate the platform. Contact [sales@fossorial.io](mailto:sales@fossorial.io) for trial access. + + + Trial keys are only available for organizations that exceed the free license revenue threshold. + + + + + **Contact us for guidance** + + If you're uncertain whether you qualify for free licensing or need a commercial license, reach out to [sales@fossorial.io](mailto:sales@fossorial.io) with your organization details. + + We'll help determine the appropriate license type and pricing for your use case. + + + +## Activating Enterprise Edition + + + + Update your Docker Compose configuration to use the Enterprise Edition image: + + ```yaml + services: + pangolin: + image: fosrl/pangolin:ee-latest # Enterprise Edition + # ... rest of configuration + ``` + + + The Enterprise Edition image is stagged with `ee` (e.g., `fosrl/pangolin:ee-latest`) and is different from the Community Edition (`fosrl/pangolin:latest`). Make sure to use the correct image. + + + + + Restart your Pangolin services to activate the license: + + ```bash + sudo docker compose restart pangolin + ``` + + + + Log in to the Pangolin instance via the server admin credentials. Visit the Server Admin panel and naviage to the License section (`/admin/license`). Enter and activate the license key. + + + The license key should be provided exactly as received in your email confirmation. + + + + + Check your Pangolin dashboard to confirm Enterprise Edition features are unlocked. + + + +## Current Enterprise Features + + +The Enterprise Edition is currently in early development. Available features are nearly identical to the Community Edition, with additional enterprise-specific features rolling out soon. + + +## Support and Contact + + + + **For licensing questions and quotes** + + Email: [sales@fossorial.io](mailto:sales@fossorial.io) + + Include your organization details and use case for faster assistance. + + + +## Frequently Asked Questions + + + + You can switch from Community to Enterprise Edition by: + + 1. Updating your Docker image to `fosrl/pangolin-ee` + 2. Adding your license key to the configuration + 3. Restarting the services + + + Switching back to Community Edition will disable Enterprise features and may require data migration. + + + + + Enterprise Edition is fully opt-in. You can continue using the Community Edition. + + + The Community Edition will always remain free and open source with full AGPL-3 compliance. + + + + + If your license expires or becomes invalid: + + - Enterprise features will be disabled + - You can renew your license to restore Enterprise features + + + + Individuals and small businesses under the revenue threshold can use Enterprise Edition for personal projects at no cost. + + + Personal use is explicitly allowed under the free license terms. + + +