From f188feada26f7274c3cc23d7e5070bc4e14732c0 Mon Sep 17 00:00:00 2001 From: miloschwartz Date: Fri, 12 Jun 2026 15:58:36 -0700 Subject: [PATCH] update enterprise edition docs --- self-host/enterprise-edition.mdx | 350 ++++++++++++++++++----------- self-host/purchase-license-key.mdx | 23 +- 2 files changed, 241 insertions(+), 132 deletions(-) diff --git a/self-host/enterprise-edition.mdx b/self-host/enterprise-edition.mdx index abbc557..5850328 100644 --- a/self-host/enterprise-edition.mdx +++ b/self-host/enterprise-edition.mdx @@ -1,66 +1,74 @@ --- title: "Enterprise Edition" -description: "Learn about Enterprise Edition features, licensing, and how to get started" +description: "Learn about Enterprise Edition licensing, plans, and how to get started" --- import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx"; - - Get a license for Pangolin Enterprise Edition. +When self-hosting Pangolin, you can run the **Community Edition** or the **Enterprise Edition**. Both editions provide the same core functionality. Enterprise Edition unlocks additional features with a license key on the `ee` Docker image. + + +Enterprise Edition is **free** for personal use and organizations with **less than $100,000 USD** gross annual revenue. You still need a valid license key to activate it. + + + +Organizations with **$100,000+ USD** gross annual revenue require a **paid commercial license** to use Enterprise Edition. + + + + + Personal use and small organizations under the revenue threshold. -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. + + Full feature comparison and plan tiers for self-hosted Pangolin. + -## Edition Comparison - -### Community Edition - -- Fully compliant with AGPL-3 license -- All core Pangolin features included - -### Enterprise Edition - -- Distributed under Fossorial Commercial License -- Includes all Community Edition features -- Unlocks "Paid Features" for qualifying users (see below) -- Requires valid license key for activation + + Paid commercial licenses for businesses above the revenue threshold. + + ## Licensing Overview -The Enterprise Edition is distributed under the **Fossorial Commercial License**, which provides different terms based on your organization's revenue: +Enterprise Edition is distributed under the **Fossorial Commercial License**. Your organization's gross annual revenue determines whether you qualify for a free license or need a paid one. - - - **Larger businesses require a paid license** - - - **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 - - - Businesses exceeding the revenue threshold must purchase a commercial license to use Enterprise Edition features. - - - - **Free for individuals and small businesses** - - - **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 - - - You still need to acquire a valid license key to unlock Enterprise features, even with free licensing. - - - +### Personal Use -To see pricing tiers for the self-hosted Enterprise Edition for businesses, [click here](https://pangolin.net/pricing#Self-Hosted). For more on how to purchase a key, see [Purchase a license key](/self-host/purchase-license-key). +Free for individuals and small businesses: -## Getting Your License Key +- **Revenue threshold**: Less than $100,000 USD gross annual revenue +- **License cost**: Free +- **Usage**: Personal and small business use allowed + +You still need to apply for a valid license key to unlock Enterprise features, even with free licensing. + +### Business Use + +Larger businesses require a paid license: + +- **Revenue threshold**: $100,000+ USD gross annual revenue +- **License cost**: Paid license required — see [Self-Hosted pricing](https://pangolin.net/pricing#Self-Hosted) for tiers +- **Usage**: Business use with commercial terms +- **Trial**: Want to evaluate Enterprise Edition before buying? Contact [sales@pangolin.net](mailto:sales@pangolin.net) to request a free limited trial license. + +Businesses exceeding the revenue threshold must purchase a commercial license to use Enterprise Edition. + +## Enterprise Features and Plans + +Enterprise Edition unlocks capabilities beyond Community Edition. Your license tier determines which features and limits apply. + + + The Self-Hosted pricing page is the source of truth for features, limits, and plan tiers. + + + +For setup instructions on a specific feature, search the docs or browse from the pricing page. Individual doc pages mark Enterprise-only features with notes linking back to this page. + + +## Get a Free License (Personal Use) @@ -68,86 +76,104 @@ To see pricing tiers for the self-hosted Enterprise Edition for businesses, [cli - After signing up you will be prompted to create an organization. This is required to apply for a license key. You can use the default organization name or create a custom one. + After signing up you will be prompted to create an organization. This is required to apply for a license key. - - After logging in, go to the **Licenses** section in your account dashboard. - + + Go to the **Licenses** section in your account dashboard and complete the license application form. - - Complete the license application form. - - + Inaccurate 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. + Once approved, you'll receive your license key immediately. Continue to [Activate Enterprise Edition](#activating-enterprise-edition) to use it on your server. -## License Requirements +Organizations above the revenue threshold should [purchase a commercial license](/self-host/purchase-license-key) instead. See [Self-Hosted pricing](https://pangolin.net/pricing#Self-Hosted) for paid tiers. - - - **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. - - +## Purchase a License (Business Use) - - - Businesses that don't qualify for free personal licensing can reach out to support@pangolin.net for a trial license key to test Enterprise features before purchasing. - - - Trial keys are only available for organizations that exceed the personal license revenue threshold. - - +Businesses with $100,000+ USD gross annual revenue need a paid commercial license. - - **Contact us for guidance** - - If you're uncertain whether you qualify for free licensing or need a commercial license, reach out to [sales@pangolin.net](mailto:sales@pangolin.net) with your organization details. - - We'll help determine the appropriate license type and pricing for your use case. - - +### Self-serve Purchase -## Activating Enterprise Edition +You can buy a **Starter** or **Scale** license online at any time through [app.pangolin.net](https://app.pangolin.net). Follow the steps in [Purchase a license key](/self-host/purchase-license-key) to choose your tier, complete checkout, and receive your key immediately. Compare features and limits on the [Self-Hosted pricing page](https://pangolin.net/pricing#Self-Hosted-identity-and-access-management), then activate your key — see [Activate Enterprise Edition](#activating-enterprise-edition). + +### Custom Licensing + +Need more users, more sites, or special add-ons — such as compliance packages, SLA support, pay-by-invoice, or bank transfer? Contact [sales@pangolin.net](mailto:sales@pangolin.net) for a custom quote. + + +Not ready to purchase? Businesses can request a **free limited trial** of Enterprise Edition by emailing [sales@pangolin.net](mailto:sales@pangolin.net). Include your organization details and what you'd like to evaluate. + + +## Upgrade from Community Edition + +If you're already running Community Edition and want Enterprise features: - - Update your Docker Compose configuration to use the Enterprise Edition image: - + + Apply for a [free license](#get-a-free-license-personal-use) or [purchase a commercial license](/self-host/purchase-license-key), depending on your organization's revenue. + + + + Update your Docker Compose configuration: + ```yaml services: pangolin: image: fosrl/pangolin:ee-latest # Enterprise Edition # ... rest of configuration ``` - + - The Enterprise Edition image is tagged 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. + The Enterprise Edition image is tagged with `ee` (e.g., `fosrl/pangolin:ee-latest`) and is different from the Community Edition (`fosrl/pangolin:latest`). - Bring down and restart your Pangolin stack to use the new image: + ```bash + sudo docker compose down && sudo docker compose up -d + ``` + + + Log in with server admin credentials, open the Server Admin panel, and go to the License section at `/admin/license`. Enter and activate your key. + + + + Confirm Enterprise Edition features are unlocked in your dashboard. + + + +## Activating Enterprise Edition + +Use these steps if you're setting up Enterprise Edition for the first time (including after a fresh install with the `ee` image). + + + + Your Docker Compose configuration must use the Enterprise Edition image: + + ```yaml + services: + pangolin: + image: fosrl/pangolin:ee-latest # Enterprise Edition + # ... rest of configuration + ``` + + + ```bash sudo docker compose down && sudo docker compose up -d ``` - 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. - + Log in to the Pangolin instance via the server admin credentials. Visit the Server Admin panel and navigate 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. @@ -158,57 +184,127 @@ To see pricing tiers for the self-hosted Enterprise Edition for businesses, [cli -## Support and Contact - -For licensing questions and quotes, email: [sales@pangolin.net](mailto:sales@pangolin.net) - -Include your organization details and use case for faster assistance. - -## Frequently Asked Questions +### Troubleshooting Activation - - You can switch from Community to Enterprise Edition by: - - 1. Updating your Docker image to `fosrl/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. - + + You're likely running the Community Edition Docker image. Confirm your `docker-compose.yml` uses `fosrl/pangolin:ee-latest` (or a pinned version like `fosrl/pangolin:ee-1.14.1`), not `fosrl/pangolin:latest`. Restart the stack after changing the image: + + ```bash + sudo docker compose down && sudo docker compose up -d + ``` + + Check container logs if the issue persists: + + ```bash + sudo docker compose logs pangolin + ``` + + + + The License section only appears when the Enterprise Edition image is running. Switch to the `ee` image and restart the stack — see the accordion above. + + + + Some features require a valid activated license **and** additional configuration. For example, branding and certain identity provider settings need a [`privateConfig.yml`](/self-host/advanced/private-config-file) file mounted in your container. Verify your license is active and check the docs for the specific feature you're enabling. + + + +## 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. A server is considered to be a single database instance. + + + + Yes. Businesses that require a paid commercial license can request a **free limited trial** of Enterprise Edition by contacting [sales@pangolin.net](mailto:sales@pangolin.net). Include your organization details and which features you want to evaluate. + + Trial licenses are intended for organizations above the personal-use revenue threshold that want to test Enterprise Edition before purchasing. + + + + If you're uncertain whether you qualify for free licensing or need a commercial license, reach out to [sales@pangolin.net](mailto:sales@pangolin.net) with your organization details. + + + +## FAQ + + + + Enterprise Edition unlocks advanced features beyond Community Edition. + + See the [Self-Hosted pricing page](https://pangolin.net/pricing#Self-Hosted-identity-and-access-management) for the full feature comparison — it is the source of truth for what each plan includes. + + + + "Paid Features" refers to the advanced capabilities unlocked by Enterprise Edition with a valid license key. Personal and small-business users get a free license. Larger organizations purchase a paid license. + + For the complete list, see [Self-Hosted pricing](https://pangolin.net/pricing#Self-Hosted). + + + + Yes. Individuals and small businesses under the $100,000 USD revenue threshold can use Enterprise Edition for personal projects at no cost. [Apply for a free license](#get-a-free-license-personal-use) to get started. + + + + Paid tiers unlock features most organizations need at scale: external identity providers and RBAC, multi-organization support and branding, and custom limits with SIEM streaming and SLA support. + + Compare tiers on the [Self-Hosted pricing page](https://pangolin.net/pricing#Self-Hosted) to find the right fit. + + + + No. Self-hosted Enterprise Edition runs on your own infrastructure with a license key on the `ee` Docker image. [Pangolin Cloud](https://app.pangolin.net/auth/signup) is a managed hosting option with its own pricing tab on the [pricing page](https://pangolin.net/pricing#Self-Hosted). Both offer advanced features, but the deployment model is different. - 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. - + Yes. You can continue using the Community Edition indefinitely. Enterprise Edition requires switching to the `ee` Docker image and activating a license key. + + + + Yes. Switching between Community and Enterprise Edition is a **container swap** — update the Docker image in your `docker-compose.yml` and restart the stack: + + - **To Enterprise:** `fosrl/pangolin:ee-latest` (or a pinned `ee-` tag), then activate your license key at `/admin/license` + - **To Community:** `fosrl/pangolin:latest` (or a pinned community tag) + + Community and Enterprise Edition share the same database schema, so there should be no data migration issues. You can freely switch between versions to test. Enterprise-only features are disabled when running the Community image. + + + Always back up your database and configuration before switching editions, just in case. + + + + + Yes. Downgrading is a simple container swap: + + 1. Change your Docker image from `fosrl/pangolin:ee-latest` to `fosrl/pangolin:latest` (or the matching community version tag) + 2. Restart the stack: `sudo docker compose down && sudo docker compose up -d` + + Community and Enterprise Edition use the **same database schema**, so you should not run into data migration issues. You can freely switch between editions to test. Enterprise-only features will be disabled on the Community image, but your existing data remains intact. + + + Always make a backup of your database and configuration before switching, just in case. + 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. - - - - **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. - + No. 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. + If you have questions about how your organization's revenue is calculated for licensing purposes, contact [sales@pangolin.net](mailto:sales@pangolin.net). + +## Support and Contact + +For licensing questions and quotes, email [sales@pangolin.net](mailto:sales@pangolin.net). Include your organization details and use case for faster assistance. \ No newline at end of file diff --git a/self-host/purchase-license-key.mdx b/self-host/purchase-license-key.mdx index ecdd6eb..0ae6611 100644 --- a/self-host/purchase-license-key.mdx +++ b/self-host/purchase-license-key.mdx @@ -11,6 +11,19 @@ import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx"; Buy an Enterprise license key directly from the Pangolin dashboard. You choose your tier, complete checkout, and get your key right away — in the dashboard and by email. +## License tiers + +You can purchase a **self-serve license online at any time** through [app.pangolin.net](https://app.pangolin.net). Two tiers are available for self-serve checkout: + +- **Starter** — For smaller teams getting started with self-hosted Enterprise Edition +- **Scale** — For growing teams that need higher limits and more advanced capabilities + +See the [Self-Hosted pricing page](https://pangolin.net/pricing#Self-Hosted) for a full comparison of features and limits included with each tier. + + +Need more users, more sites, or special add-ons — such as compliance packages, SLA support, pay-by-invoice, or bank transfer? Contact [sales@pangolin.net](mailto:sales@pangolin.net) for a custom quote. + + ## How to buy a license key @@ -56,18 +69,18 @@ Buy an Enterprise license key directly from the Pangolin dashboard. You choose y - We don’t offer a formal trial, but you can evaluate Pangolin using the free Community edition. If you’d like a demo or have questions, email us and we can walk you through it. + Businesses can request a **free limited trial** of Enterprise Edition by contacting [sales@pangolin.net](mailto:sales@pangolin.net). Include your organization details and what you'd like to evaluate. - Licenses are sold as annual subscriptions. If you’d rather pay in 12 monthly installments instead of one yearly payment, contact us and we can see what we can do. + Self-serve licenses (Starter and Scale) are sold as annual subscriptions paid by card at checkout. If you need monthly billing, pay-by-invoice, or bank transfer, contact [sales@pangolin.net](mailto:sales@pangolin.net). - - That’s outside the self-serve license limits. Contact us for a custom quote. + + Self-serve checkout covers **Starter** and **Scale** tiers only. For higher limits, compliance packages, SLA support, pay-by-invoice, bank transfer, or other custom arrangements, contact [sales@pangolin.net](mailto:sales@pangolin.net). - Yes. Contact us — you can purchase as many keys as you need and we’ll add them to your account. + Yes. Purchase additional self-serve keys through the dashboard, or contact [sales@pangolin.net](mailto:sales@pangolin.net) if you need multiple keys added to your account under a custom agreement.