docs: add new Access Control and Logs documentation pages
- Documented Access Control features (e.g., Device Approvals, Password Rotation, 2FA, Custom Login Pages). - Added detailed descriptions for Logs & Analytics (Access Logs, Request Logs, Action Logs). - Included configuration instructions and feature-specific notes for Pangolin Cloud and Enterprise Edition. Signed-off-by: Stefan Mogeritsch <stefan.mo.co@gmail.com>
This commit is contained in:
@@ -0,0 +1,230 @@
|
||||
> ## Documentation Index
|
||||
> Fetch the complete documentation index at: https://docs.pangolin.net/llms.txt
|
||||
> Use this file to discover all available pages before exploring further.
|
||||
|
||||
# Enterprise Edition
|
||||
|
||||
> Learn about Enterprise Edition features, licensing, and how to get started
|
||||
|
||||
<div id="pangolin-toc-cta" className="pangolin-toc-cta-source">
|
||||
<Card title="Try free on Pangolin Cloud" icon="cloud" href="https://app.pangolin.net/auth/signup" arrow="true" cta="Sign up free">
|
||||
Fastest way to get started with Pangolin using the hosted control plane. No credit card required.
|
||||
</Card>
|
||||
</div>
|
||||
|
||||
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
|
||||
|
||||
### 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
|
||||
|
||||
## Licensing Overview
|
||||
|
||||
The Enterprise Edition is distributed under the **Fossorial Commercial License**, which provides different terms based
|
||||
on your organization's revenue:
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Personal Use">
|
||||
**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
|
||||
|
||||
<Check>
|
||||
You still need to acquire a valid license key to unlock Enterprise features, even with free licensing.
|
||||
</Check>
|
||||
|
||||
</Tab>
|
||||
|
||||
<Tab title="Business Use">
|
||||
**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
|
||||
|
||||
<Warning>
|
||||
Businesses exceeding the revenue threshold must purchase a commercial license to use Enterprise Edition features.
|
||||
</Warning>
|
||||
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
To see pricing tiers for the self-hosted Enterprise Edition for
|
||||
businesses, [click here](https://pangolin.net/pricing?hosting=self-host). For more on how to purchase a key,
|
||||
see [Purchase a license key](/self-host/purchase-license-key).
|
||||
|
||||
## Getting Your License Key
|
||||
|
||||
<Steps>
|
||||
<Step title="Create an account">
|
||||
Visit [app.pangolin.net](https://app.pangolin.net) and create your account.
|
||||
</Step>
|
||||
|
||||
<Step title="Navigate to licenses">
|
||||
After logging in, go to the **Licenses** section in your account dashboard.
|
||||
</Step>
|
||||
|
||||
<Step title="Fill out the application">
|
||||
Complete the license application form.
|
||||
|
||||
<Tip>
|
||||
Inaccurate representation is a violation of the license and will result in the license being revoked.
|
||||
</Tip>
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Receive your key">
|
||||
Once approved, you'll receive your license key immediately. You can then activate it in your Pangolin instance in the Server Admin panel.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## 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.
|
||||
|
||||
<Info>
|
||||
If you're running multiple Pangolin instances for high availability, each database needs its own license key.
|
||||
</Info>
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I get a trial license?">
|
||||
Businesses that don't qualify for free personal licensing can reach out to [support@pangolin.net](mailto:support@pangolin.net) for a trial license key to test Enterprise features before purchasing.
|
||||
|
||||
<Warning>
|
||||
Trial keys are only available for organizations that exceed the personal license revenue threshold.
|
||||
</Warning>
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="What if I'm unsure about my license type?">
|
||||
**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.
|
||||
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## Activating Enterprise Edition
|
||||
|
||||
<Steps>
|
||||
<Step title="Use Enterprise Edition image">
|
||||
Update your Docker Compose configuration to use the Enterprise Edition image:
|
||||
|
||||
```yaml theme={null}
|
||||
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`). Make sure to use the correct image.
|
||||
</Warning>
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Restart Pangolin">
|
||||
Restart your Pangolin services to activate the license:
|
||||
|
||||
```bash theme={null}
|
||||
sudo docker compose restart pangolin
|
||||
```
|
||||
|
||||
</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 naviage to the License section (`/admin/license`). Enter and activate the license key.
|
||||
|
||||
<Info>
|
||||
The license key should be provided exactly as received in your email confirmation.
|
||||
</Info>
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Verify activation">
|
||||
Check your Pangolin dashboard to confirm Enterprise Edition features are unlocked.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## 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
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Can I switch between editions?">
|
||||
You can switch from Community to Enterprise Edition by:
|
||||
|
||||
1. Updating your Docker image to `fosrl/ee-<version>`
|
||||
2. Adding your license key to the configuration
|
||||
3. Restarting the services
|
||||
|
||||
<Warning>
|
||||
Switching back to Community Edition will disable Enterprise features and may require data migration.
|
||||
</Warning>
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Is Enterprise Edition opt-in?">
|
||||
Enterprise Edition is fully opt-in. You can continue using the Community Edition.
|
||||
|
||||
<Check>
|
||||
The Community Edition will always remain free and open source with full AGPL-3 compliance.
|
||||
</Check>
|
||||
|
||||
</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="Can I use Enterprise Edition for personal projects?">
|
||||
Individuals and small businesses under the revenue threshold can use Enterprise Edition for personal projects at no cost.
|
||||
|
||||
<Info>
|
||||
Personal use is explicitly allowed under the free license terms.
|
||||
</Info>
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Are there special license terms for educational institutions, non-profits, or government organizations?">
|
||||
**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.
|
||||
|
||||
<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>
|
||||
|
||||
Reference in New Issue
Block a user