mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-10-01 10:19:23 +02:00
split enterprise edition page into multiple pages
This commit is contained in:
miloschwartz
@@ -1,317 +0,0 @@
|
||||
---
|
||||
title: "Enterprise Edition"
|
||||
description: "Learn about Enterprise Edition licensing, plans, and how to get started"
|
||||
---
|
||||
|
||||
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.
|
||||
|
||||
<Check>
|
||||
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.
|
||||
</Check>
|
||||
|
||||
<Warning>
|
||||
Organizations with **$100,000+ USD** gross annual revenue require a **paid commercial license** to use Enterprise Edition.
|
||||
</Warning>
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="Get a free license" icon="user" href="#get-a-free-license-personal-use">
|
||||
Personal use and small organizations under the revenue threshold.
|
||||
</Card>
|
||||
|
||||
<Card title="Compare features and plans" icon="table-list" href="https://pangolin.net/pricing#Self-Hosted-identity-and-access-management">
|
||||
Full feature comparison and plan tiers for self-hosted Pangolin.
|
||||
</Card>
|
||||
|
||||
<Card title="Purchase a license" icon="credit-card" href="/self-host/purchase-license-key">
|
||||
Paid commercial licenses for businesses above the revenue threshold.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Licensing Overview
|
||||
|
||||
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.
|
||||
|
||||
### Personal Use
|
||||
|
||||
Free for individuals and small businesses:
|
||||
|
||||
- **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.
|
||||
|
||||
<Card title="View full feature comparison" icon="table-list" href="https://pangolin.net/pricing#Self-Hosted-identity-and-access-management">
|
||||
The Self-Hosted pricing page is the source of truth for features, limits, and plan tiers.
|
||||
</Card>
|
||||
|
||||
<Tip>
|
||||
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.
|
||||
</Tip>
|
||||
|
||||
## Hiding Enterprise Features on Community Edition
|
||||
|
||||
On Community Edition, Enterprise-only capabilities may still appear in the dashboard but remain locked without the `ee` Docker image and a valid license key. To hide those UI elements entirely, set `disable_enterprise_features` under `flags` in your [`config.yml`](/self-host/advanced/config-file):
|
||||
|
||||
```yaml
|
||||
flags:
|
||||
disable_enterprise_features: true
|
||||
```
|
||||
|
||||
When enabled, Enterprise-only features are hidden from the UI. Restart the stack after updating the configuration file.
|
||||
|
||||
## Get a Free License (Personal Use)
|
||||
|
||||
<Steps>
|
||||
<Step title="Create an account">
|
||||
Visit [app.pangolin.net](https://app.pangolin.net) and create your account.
|
||||
</Step>
|
||||
|
||||
<Step title="Create an organization">
|
||||
After signing up you will be prompted to create an organization. This is required to apply for a license key.
|
||||
</Step>
|
||||
|
||||
<Step title="Complete the license application">
|
||||
Go to the **Licenses** section in your account dashboard and complete the license application form.
|
||||
|
||||
<Warning>
|
||||
Inaccurate representation is a violation of the license and will result in the license being revoked.
|
||||
</Warning>
|
||||
</Step>
|
||||
|
||||
<Step title="Receive your key">
|
||||
Once approved, you'll receive your license key immediately. Continue to [Activate Enterprise Edition](#activating-enterprise-edition) to use it on your server.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
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.
|
||||
|
||||
## Purchase a License (Business Use)
|
||||
|
||||
Businesses with $100,000+ USD gross annual revenue need a paid commercial license.
|
||||
|
||||
### Self-serve Purchase
|
||||
|
||||
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.
|
||||
|
||||
<Info>
|
||||
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.
|
||||
</Info>
|
||||
|
||||
## Upgrade from Community Edition
|
||||
|
||||
If you're already running Community Edition and want Enterprise features:
|
||||
|
||||
<Steps>
|
||||
<Step title="Get a license key">
|
||||
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.
|
||||
</Step>
|
||||
|
||||
<Step title="Switch to the Enterprise image">
|
||||
Update your Docker Compose configuration:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
pangolin:
|
||||
image: fosrl/pangolin:ee-latest # Enterprise Edition
|
||||
# ... rest of configuration
|
||||
```
|
||||
|
||||
<Warning>
|
||||
The Enterprise Edition image is tagged with `ee` (e.g., `fosrl/pangolin:ee-latest`) and is different from the Community Edition (`fosrl/pangolin:latest`).
|
||||
</Warning>
|
||||
</Step>
|
||||
|
||||
<Step title="Restart the stack">
|
||||
```bash
|
||||
sudo docker compose down && sudo docker compose up -d
|
||||
```
|
||||
</Step>
|
||||
|
||||
<Step title="Activate your license key">
|
||||
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.
|
||||
</Step>
|
||||
|
||||
<Step title="Verify activation">
|
||||
Confirm Enterprise Edition features are unlocked in your dashboard.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## 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).
|
||||
|
||||
<Steps>
|
||||
<Step title="Use Enterprise Edition image">
|
||||
Your Docker Compose configuration must use the Enterprise Edition image:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
pangolin:
|
||||
image: fosrl/pangolin:ee-latest # Enterprise Edition
|
||||
# ... rest of configuration
|
||||
```
|
||||
</Step>
|
||||
|
||||
<Step title="Restart the stack">
|
||||
```bash
|
||||
sudo docker compose down && sudo docker compose up -d
|
||||
```
|
||||
</Step>
|
||||
|
||||
<Step title="Add license key to instance">
|
||||
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.
|
||||
|
||||
<Info>
|
||||
The license key should be provided exactly as received.
|
||||
</Info>
|
||||
</Step>
|
||||
|
||||
<Step title="Verify activation">
|
||||
Check your Pangolin dashboard to confirm Enterprise Edition features are unlocked.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
### Troubleshooting Activation
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Admin panel still shows Community Edition">
|
||||
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
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="No License section in the admin panel">
|
||||
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.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Enterprise settings are missing after activation">
|
||||
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.
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## License Requirements
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="How many license keys do I need?">
|
||||
**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.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I get a trial license?">
|
||||
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.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="What if I'm unsure about my license type?">
|
||||
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.
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## FAQ
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="What features does Enterprise Edition include?">
|
||||
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.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="What are Paid Features?">
|
||||
"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).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I use Enterprise Edition for personal projects?">
|
||||
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.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Why would a business pay for self-hosted Enterprise Edition?">
|
||||
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.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Is self-hosted Enterprise Edition the same as Pangolin Cloud?">
|
||||
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.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Is Enterprise Edition opt-in?">
|
||||
Yes. You can continue using the Community Edition indefinitely. Enterprise Edition requires switching to the `ee` Docker image and activating a license key.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I switch between editions?">
|
||||
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-<version>` 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.
|
||||
|
||||
<Tip>
|
||||
Always back up your database and configuration before switching editions, just in case.
|
||||
</Tip>
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I downgrade from Enterprise to Community Edition?">
|
||||
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.
|
||||
|
||||
<Tip>
|
||||
Always make a backup of your database and configuration before switching, just in case.
|
||||
</Tip>
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="What happens if my license expires?">
|
||||
If your license expires or becomes invalid:
|
||||
|
||||
- Enterprise features will be disabled
|
||||
- You can renew your license to restore Enterprise features
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Are there special license terms for educational institutions, non-profits, or government organizations?">
|
||||
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.
|
||||
|
||||
<Info>
|
||||
If you have questions about how your organization's revenue is calculated for licensing purposes, contact [sales@pangolin.net](mailto:sales@pangolin.net).
|
||||
</Info>
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## 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.
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
title: "Activate a License"
|
||||
description: "Switch to the Enterprise Edition image and activate a license key"
|
||||
---
|
||||
|
||||
Use these steps after you have a license key from [personal use](/self-host/enterprise-edition/personal-use) or [commercial use](/self-host/enterprise-edition/commercial-use). A new install and an existing Community Edition server follow the same path.
|
||||
|
||||
If you install with the [quick installer](/self-host/quick-install), it asks whether you want Enterprise Edition and writes the image for you. You still add the license key once the stack is up.
|
||||
|
||||
<Steps>
|
||||
<Step title="Get a license key">
|
||||
[Apply for a free license](/self-host/enterprise-edition/personal-use) or [purchase a commercial license](/self-host/enterprise-edition/purchase-license-key), depending on your organization's revenue.
|
||||
</Step>
|
||||
|
||||
<Step title="Use the Enterprise image">
|
||||
In Docker Compose, the default SQLite image is:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
pangolin:
|
||||
image: fosrl/pangolin:ee-latest # Enterprise Edition (SQLite)
|
||||
# ... rest of configuration
|
||||
```
|
||||
|
||||
If you run PostgreSQL, use the Enterprise PostgreSQL image instead:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
pangolin:
|
||||
image: fosrl/pangolin:ee-postgresql-latest # Enterprise Edition (PostgreSQL)
|
||||
# ... rest of configuration
|
||||
```
|
||||
|
||||
<Warning>
|
||||
The Enterprise tags are `ee-latest` for SQLite and `ee-postgresql-latest` for PostgreSQL. They are different images from Community Edition (`fosrl/pangolin:latest` and `fosrl/pangolin:postgresql-latest`).
|
||||
</Warning>
|
||||
</Step>
|
||||
|
||||
<Step title="Restart the stack">
|
||||
```bash
|
||||
sudo docker compose down && sudo docker compose up -d
|
||||
```
|
||||
</Step>
|
||||
|
||||
<Step title="Activate your license key">
|
||||
Log in with server admin credentials, open the Server Admin panel, and go to the License section at `/admin/license`. Enter the key exactly as you received it. That binds the key to this server's [host ID](#host-id).
|
||||
</Step>
|
||||
|
||||
<Step title="Verify activation">
|
||||
Confirm the host shows as licensed. If it shows **Unlicensed** while the key itself is valid, check [License limits](/self-host/enterprise-edition/limits).
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Host ID
|
||||
|
||||
Activating a key binds it to this server. The License page shows the host ID that binding uses, and a key can only be active on one host at a time.
|
||||
|
||||
If you rebuild the server, it often comes back with a new host ID. The key is still bound to the old one, so it will not register again until you clear that binding. In your [Pangolin account](https://app.pangolin.net), open the license table, click the three dots on that license, and reset the associated server. Then activate the key on the new host.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Admin panel still shows Community Edition">
|
||||
You're likely running the Community Edition Docker image. Confirm your `docker-compose.yml` uses an Enterprise tag: `fosrl/pangolin:ee-latest` for SQLite, or `fosrl/pangolin:ee-postgresql-latest` if you run PostgreSQL. You can pin a version the same way, for example `fosrl/pangolin:ee-1.14.1` or `fosrl/pangolin:ee-postgresql-1.14.1`. 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
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="No License section in the admin panel">
|
||||
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.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Enterprise settings are missing after activation">
|
||||
Some features require a valid activated license and additional configuration. Branding and certain identity provider settings need a [`privateConfig.yml`](/self-host/advanced/private-config-file) file mounted in your container. Verify the host license is valid, then check the docs for the feature you are enabling.
|
||||
|
||||
If the key is valid and the host still shows **Unlicensed**, you are over a [user or site limit](/self-host/enterprise-edition/limits).
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: "Commercial Use"
|
||||
description: "Paid Enterprise Edition licenses for organizations above the revenue threshold"
|
||||
---
|
||||
|
||||
Organizations with **$100,000+ USD** gross annual revenue need a paid commercial license to use Enterprise Edition. Compare plans on the [features page](/self-host/enterprise-edition/features).
|
||||
|
||||
<Info>
|
||||
Not ready to purchase? Businesses can request a **free limited trial** by emailing [sales@pangolin.net](mailto:sales@pangolin.net). Include your organization details and what you'd like to evaluate.
|
||||
</Info>
|
||||
|
||||
Individuals and organizations under the revenue threshold should [apply for a free license](/self-host/enterprise-edition/personal-use) instead.
|
||||
|
||||
## Self-serve purchase
|
||||
|
||||
You can buy a **Starter** or **Scale** license online at any time through [app.pangolin.net](https://app.pangolin.net). Follow [Purchase a license key](/self-host/enterprise-edition/purchase-license-key) to choose a tier, complete checkout, and receive your key. Then [activate it](/self-host/enterprise-edition/activate).
|
||||
|
||||
## Custom licensing
|
||||
|
||||
Need more users, more sites, or add-ons such as compliance packages, SLA support, pay-by-invoice, or bank transfer? Contact [sales@pangolin.net](mailto:sales@pangolin.net).
|
||||
|
||||
Custom licenses are for capacity above the Scale tier. Overages can be added monthly and are prorated. Multi-year options are available on request. The [Self-Hosted pricing page](https://pangolin.net/pricing#Self-Hosted) lists the published tiers. Quotes for anything above those tiers come from sales.
|
||||
@@ -0,0 +1,103 @@
|
||||
---
|
||||
title: "Enterprise Edition FAQ"
|
||||
description: "Common questions about Enterprise Edition licensing, editions, and limits"
|
||||
---
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="What features does Enterprise Edition include?">
|
||||
See [Features](/self-host/enterprise-edition/features). The Self-Hosted table on the pricing page is the list of what each plan includes.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="What are Paid Features?">
|
||||
Paid Features are the capabilities unlocked by Enterprise Edition with a valid license key. Who pays depends on revenue: [personal use](/self-host/enterprise-edition/personal-use) is free under the threshold, and [commercial use](/self-host/enterprise-edition/commercial-use) is paid above it. The feature list is on the [features page](/self-host/enterprise-edition/features).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I use Enterprise Edition for personal projects?">
|
||||
Yes. Individuals and small organizations under the $100,000 USD revenue threshold can use Enterprise Edition for personal projects at no cost. [Apply for a free license](/self-host/enterprise-edition/personal-use).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Why would a business pay for self-hosted Enterprise Edition?">
|
||||
Paid tiers raise limits and unlock the capabilities listed in the [feature comparison](/self-host/enterprise-edition/features). [Commercial use](/self-host/enterprise-edition/commercial-use) covers how to buy a Starter, Scale, or custom license.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Is self-hosted Enterprise Edition the same as Pangolin Cloud?">
|
||||
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 tab on the [pricing page](https://pangolin.net/pricing#Self-Hosted). Both offer advanced features. The deployment model is different.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Is Enterprise Edition opt-in?">
|
||||
Yes. You can keep using Community Edition. Enterprise Edition means switching to the `ee` Docker image and activating a license key. See [Activate a license](/self-host/enterprise-edition/activate).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I switch between editions?">
|
||||
Switching 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-<version>` 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 is no data migration. Enterprise-only features are disabled on the Community image.
|
||||
|
||||
<Tip>
|
||||
Back up your database and configuration before switching editions.
|
||||
</Tip>
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I downgrade from Enterprise to Community Edition?">
|
||||
Yes. Change the Docker image from `fosrl/pangolin:ee-latest` to `fosrl/pangolin:latest` (or the matching community version tag), then restart:
|
||||
|
||||
```bash
|
||||
sudo docker compose down && sudo docker compose up -d
|
||||
```
|
||||
|
||||
The database schema is the same, so existing data stays. Enterprise-only features are disabled on the Community image.
|
||||
|
||||
<Tip>
|
||||
Back up your database and configuration before switching.
|
||||
</Tip>
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="What happens if my license expires?">
|
||||
Enterprise features are disabled. Renew the license to turn them back on. This is separate from going over a [user or site limit](/self-host/enterprise-edition/limits), which can show the same red banner while the key itself is still valid.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="The banner says my license is invalid, but the key shows as valid. What does that mean?">
|
||||
The red banner reads:
|
||||
|
||||
> Invalid or expired license keys detected. Follow license terms to continue using all features.
|
||||
|
||||
If the key row is valid and the host shows **Unlicensed**, the usual cause is too many registered users or too many sites. Read [License limits](/self-host/enterprise-edition/limits) before you clear or re-register the key. Re-registering does not fix a capacity violation.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Do machine clients count toward the user limit?">
|
||||
No. Machine clients that authenticate with an ID and secret, and are not tied to a user account, do not count. Devices attached to a person do not count separately either. The registered account does. Details are on [License limits](/self-host/enterprise-edition/limits).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Do archived or blocked users count?">
|
||||
Yes, until you delete the account. Archiving or blocking a device leaves the account in place, and that account still counts.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Does a user in more than one organization count once?">
|
||||
Once. The limit is accounts on the server, not memberships.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="How many license keys do I need?">
|
||||
One key per Pangolin server. A server is one database. You cannot share a single key across multiple servers.
|
||||
|
||||
You can put more than one key on the same server. Capacity adds together. See [License limits](/self-host/enterprise-edition/limits).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I get a trial license?">
|
||||
Businesses that need a paid license can request a free limited trial from [sales@pangolin.net](mailto:sales@pangolin.net). Include your organization details and which features you want to evaluate.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="What if I'm unsure about my license type?">
|
||||
Email [sales@pangolin.net](mailto:sales@pangolin.net) with your organization details.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Are there special terms for educational institutions, non-profits, or government organizations?">
|
||||
No. Educational institutions, non-profits, and government organizations follow the same license terms as everyone else and are not considered personal use. There are no separate exceptions. We do offer discounted pricing for some non-profits and government organizations.
|
||||
|
||||
<Info>
|
||||
If you have questions about how your organization's revenue is calculated, contact [sales@pangolin.net](mailto:sales@pangolin.net).
|
||||
</Info>
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: "Features"
|
||||
description: "Where to compare Enterprise Edition features and plan tiers"
|
||||
---
|
||||
|
||||
The [Self-Hosted pricing comparison](https://pangolin.net/pricing#Self-Hosted-identity-and-access-management) is the source of truth for which features and limits each plan includes.
|
||||
|
||||
<Card title="View the feature comparison" icon="table-list" href="https://pangolin.net/pricing#Self-Hosted-identity-and-access-management">
|
||||
Open the Self-Hosted table on the pricing page.
|
||||
</Card>
|
||||
|
||||
Doc pages for a specific capability note when it requires Enterprise Edition and link back to setup steps for that feature. Search the docs from the pricing table when you want to turn something on.
|
||||
|
||||
[Personal use](/self-host/enterprise-edition/personal-use) covers who qualifies for a free license. [Commercial use](/self-host/enterprise-edition/commercial-use) covers paid tiers. [License limits](/self-host/enterprise-edition/limits) explains how users and sites are counted.
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: "Enterprise Edition"
|
||||
description: "Licensing, plans, and how to get started with self-hosted 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.
|
||||
|
||||
<Check>
|
||||
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.
|
||||
</Check>
|
||||
|
||||
<Warning>
|
||||
Organizations with **$100,000+ USD** gross annual revenue require a **paid commercial license** to use Enterprise Edition.
|
||||
</Warning>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Personal use" icon="user" href="/self-host/enterprise-edition/personal-use">
|
||||
Free license for individuals and organizations under the revenue threshold.
|
||||
</Card>
|
||||
|
||||
<Card title="Commercial use" icon="building" href="/self-host/enterprise-edition/commercial-use">
|
||||
Paid licenses for organizations above the revenue threshold.
|
||||
</Card>
|
||||
|
||||
<Card title="Features" icon="table-list" href="/self-host/enterprise-edition/features">
|
||||
Compare what each plan includes on the pricing page.
|
||||
</Card>
|
||||
|
||||
<Card title="License limits" icon="chart-bar" href="/self-host/enterprise-edition/limits">
|
||||
How users and sites are counted, and what the red license banner means.
|
||||
</Card>
|
||||
|
||||
<Card title="Activate a license" icon="key" href="/self-host/enterprise-edition/activate">
|
||||
Switch to the Enterprise image and add your key.
|
||||
</Card>
|
||||
|
||||
<Card title="Purchase a license" icon="credit-card" href="/self-host/enterprise-edition/purchase-license-key">
|
||||
Buy a Starter or Scale key from the dashboard.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Hiding Enterprise features on Community Edition
|
||||
|
||||
On Community Edition, Enterprise-only capabilities may still appear in the dashboard but remain locked without the `ee` Docker image and a valid license key. To hide those UI elements entirely, set `disable_enterprise_features` under `flags` in your [`config.yml`](/self-host/advanced/config-file):
|
||||
|
||||
```yaml
|
||||
flags:
|
||||
disable_enterprise_features: true
|
||||
```
|
||||
|
||||
When enabled, Enterprise-only features are hidden from the UI. Restart the stack after updating the configuration file.
|
||||
|
||||
## Support and contact
|
||||
|
||||
For licensing questions and quotes, email [sales@pangolin.net](mailto:sales@pangolin.net). Include your organization details and use case.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
title: "License Limits"
|
||||
description: "How Enterprise Edition counts users and sites, and what happens when you go over"
|
||||
---
|
||||
|
||||
A self-hosted Enterprise license has two capacity numbers: **users** and **sites**. The quantities are on your license key. Published tier ceilings are on the [Self-Hosted pricing page](https://pangolin.net/pricing#Self-Hosted). This page explains how those numbers are counted.
|
||||
|
||||
The host license is invalid when registered users **exceed** the user quantity, or sites **exceed** the site quantity. Matching the limit exactly is allowed.
|
||||
|
||||
## How users are counted
|
||||
|
||||
Every registered account counts, whether or not that person has ever connected a device or is online right now.
|
||||
|
||||
The count is one row per account on the server, across every organization. A person who belongs to more than one organization counts **once**. Server admin accounts count, because they are accounts on the server.
|
||||
|
||||
Accounts that have never registered a device or logged in still count. Archiving or blocking a device does not remove the account.
|
||||
|
||||
### What does not count as a user
|
||||
|
||||
- **Machine clients** authenticate with an ID and secret and are not tied to a user account. They do not count.
|
||||
- **Person clients** (devices) do not count on their own. The account they belong to is what counts, even if that account has several devices.
|
||||
- **Concurrent sessions** are not checked against the license.
|
||||
|
||||
## How sites are counted
|
||||
|
||||
Every site on the server counts, across every organization.
|
||||
|
||||
## Where to see the numbers
|
||||
|
||||
- **Server Admin**, **Users** (`/admin/users`): the flattened account list for the whole server, not per organization.
|
||||
- **Server Admin**, **License** (`/admin/license`): usage against the key, shown as used users out of the licensed maximum, and the same for sites.
|
||||
|
||||
## More than one key on the same server
|
||||
|
||||
Each Pangolin server (one database) needs its own license. You cannot share one key across servers.
|
||||
|
||||
You can activate more than one key on the **same** server. User quantities add together, and site quantities add together. The host uses the highest tier among the valid keys.
|
||||
|
||||
A personal-use key does not add capacity when a paid key is also active on that server. The personal key is ignored for the totals.
|
||||
|
||||
## When you are over the limit
|
||||
|
||||
The key itself can still say valid. The host shows **Unlicensed**, and a red banner sits along the bottom of the dashboard:
|
||||
|
||||
> Invalid or expired license keys detected. Follow license terms to continue using all features.
|
||||
|
||||
Enterprise features that need a valid license stay unavailable until you are back within the quantities on the key, and a license left over the limit can be revoked.
|
||||
|
||||
Delete accounts or sites until you are at or under the licensed quantity, or add capacity with a higher tier or another key on the same server. See [Commercial use](/self-host/enterprise-edition/commercial-use).
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: "Personal Use"
|
||||
description: "Free Enterprise Edition licenses for personal use and small organizations"
|
||||
---
|
||||
|
||||
Enterprise Edition is free for individuals and organizations with **less than $100,000 USD** gross annual revenue. Personal and small-business use is allowed.
|
||||
|
||||
You still need to apply for a valid license key. The free license does not activate on its own.
|
||||
|
||||
Apply on [app.pangolin.net](https://app.pangolin.net). Create an account and an organization there so we can track your application and keep the license key. You can sign back in later to copy the key or check usage, then activate it on your own server.
|
||||
|
||||
Signing up also starts a free Pangolin Cloud trial, and you may get emails about it. That trial is separate from your license key. If you only want to self-host, you can ignore Cloud.
|
||||
|
||||
Organizations at or above the revenue threshold need a [paid commercial license](/self-host/enterprise-edition/commercial-use) instead.
|
||||
|
||||
## Get a free license
|
||||
|
||||
<Steps>
|
||||
<Step title="Create an account">
|
||||
Visit [app.pangolin.net](https://app.pangolin.net) and create your account. This is the account we use to track your application and license key.
|
||||
</Step>
|
||||
|
||||
<Step title="Create an organization">
|
||||
After signing up you will be prompted to create an organization. The license application is filed against that organization, so it is required even if you only run one self-hosted server.
|
||||
</Step>
|
||||
|
||||
<Step title="Complete the license application">
|
||||
Go to the **Licenses** section in your account dashboard and complete the license application form.
|
||||
|
||||
<Warning>
|
||||
Inaccurate representation is a violation of the license and will result in the license being revoked.
|
||||
</Warning>
|
||||
</Step>
|
||||
|
||||
<Step title="Receive your key">
|
||||
Once approved, you'll receive your license key immediately. Continue to [Activate a license](/self-host/enterprise-edition/activate) to use it on your server.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
See [Features](/self-host/enterprise-edition/features) for what the license unlocks, and [License limits](/self-host/enterprise-edition/limits) for how users and sites are counted.
|
||||
+2
-2
@@ -3,7 +3,7 @@ title: "Purchase a License Key"
|
||||
description: "How to buy an Enterprise license key for Pangolin from the dashboard"
|
||||
---
|
||||
|
||||
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.
|
||||
Buy an Enterprise license key directly from the Pangolin dashboard or the pricing page at [pangolin.net/pricing](https://pangolin.net/pricing). You choose your tier, complete checkout, and get your key right away.
|
||||
|
||||
## License tiers
|
||||
|
||||
@@ -55,7 +55,7 @@ Need more users, more sites, or special add-ons — such as compliance packages,
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="I reset my host and can’t re-register my key. What do I do?">
|
||||
A license is tied to one host (by host ID) at a time. If you reset your instance and need to use the same key on a new host, contact us at [support@pangolin.net](mailto:support@pangolin.net) and we’ll reset it for you.
|
||||
A license is tied to one host (by host ID) at a time. If you reset your instance and need the same key on a new host, open the license table in your [Pangolin account](https://app.pangolin.net), click the three dots on that license, and reset the associated server. Then register the key on the new host. See [Host ID](/self-host/enterprise-edition/activate#host-id).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="How do I cancel my subscription?">
|
||||
Reference in New Issue
Block a user