Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Configuration/Automation/Telegram Bot.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Stirling PDF can run a Telegram bot that accepts PDF files from chats and return
Free on all license tiers.

:::warning Community feature - not recommended for Enterprise use
The Telegram bot integration is a **community-built feature** in **beta**. It is not built, tested, or supported by Stirling Tools and is not covered by the Server / Enterprise support SLA. **We do not recommend it for Enterprise or production-critical deployments.** Raise issues on GitHub or in the community Discord. Behaviour and config keys may change in future releases.
The Telegram bot integration is a **community-built feature** in **beta**. It is not built, tested, or supported by Stirling Tools and is not covered by the Team / Enterprise support SLA. **We do not recommend it for Enterprise or production-critical deployments.** Raise issues on GitHub or in the community Discord. Behaviour and config keys may change in future releases.
:::

---
Expand Down
2 changes: 1 addition & 1 deletion docs/Configuration/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ For advanced features and specific use cases, see these detailed guides:
### Authentication & Security

**[Single Sign-On (SSO)](./Security/Single%20Sign-On%20Configuration.md)**
- OAuth2 (Google, GitHub, Keycloak, OIDC) - Server tier
- OAuth2 (Google, GitHub, Keycloak, OIDC) - Team tier
- SAML2 (Okta, Azure AD) - Enterprise tier
- Complete configuration examples

Expand Down
4 changes: 2 additions & 2 deletions docs/Configuration/Operations/Performance-Optimization.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ services:
- External PostgreSQL database (enterprise feature)
- Shared `/configs` volume across instances for consistent settings

:::tip Server/Enterprise Recommended
For large organizations, **Server or Enterprise plans** provide SSO, external database support, advanced monitoring, and dedicated support.
:::tip Team/Enterprise Recommended
For large organizations, **Team or Enterprise plans** provide SSO, external database support, advanced monitoring, and dedicated support.

[Learn more](../../Server-Admin-Onboarding.md#step-10-paid-plans-serverenterprise)
:::
Expand Down
8 changes: 4 additions & 4 deletions docs/Configuration/Security/OAuth SSO Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ tags: [enterprise, management, feature, advanced feature]
---

# OAuth 2.0 Single Sign-On Configuration
> **Tier**: Server
> **Tier**: Team

Stirling PDF supports Single Sign-On (SSO) using OAuth 2.0 OpenID Connect (OIDC). This allows users to log in using accounts from external providers such as Google, GitHub, Keycloak, Authentik, and others.

Expand All @@ -15,7 +15,7 @@ Stirling PDF supports Single Sign-On (SSO) using OAuth 2.0 OpenID Connect (OIDC)
Before configuring OAuth 2.0 SSO, ensure you have:

- [ ] Stirling PDF with login enabled (`security.enableLogin: true`)
- [ ] Valid license for the Server tier or higher
- [ ] Valid license for the Team tier or higher
- [ ] An OAuth 2.0 provider account (Google, GitHub, Keycloak, etc.)
- [ ] Registered OAuth application with your provider
- [ ] OAuth Client ID and Client Secret from your provider
Expand Down Expand Up @@ -418,7 +418,7 @@ If your Stirling PDF backend is accessible at a different URL than the frontend,
Verify the backend URL is correct by checking that `https://your-domain.com/api/v1/info/status` is accessible.

### Auto-Login Feature
> **Tier**: Server
> **Tier**: Team

Automatically redirect users to OAuth login page, bypassing the Stirling PDF login screen.

Expand Down Expand Up @@ -529,7 +529,7 @@ The claims are logged at `INFO` level on each login (and again at `ERROR` level

- OAuth users must be manually promoted to admin role after first login
- Provider discovery requires `/.well-known/openid-configuration` endpoint support
- Auto-login feature requires the Server tier (or higher)
- Auto-login feature requires the Team tier (or higher)

## See Also

Expand Down
2 changes: 1 addition & 1 deletion docs/Configuration/Security/SAML SSO Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags: [enterprise, management, feature, advanced feature, saml]

Stirling PDF supports SAML 2.0 Single Sign-On for enterprise deployments. This allows integration with Identity Providers (IdP) like Okta, Azure AD, Google Workspace, OneLogin, Authentik, and others.

> **Looking for OAuth 2.0 SSO?** See [OAuth SSO Configuration](./OAuth%20SSO%20Configuration.md) (Server tier).
> **Looking for OAuth 2.0 SSO?** See [OAuth SSO Configuration](./OAuth%20SSO%20Configuration.md) (Team tier).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags: [enterprise, management, feature, advanced feature]
Stirling PDF supports Single Sign-On (SSO) authentication through two protocols:

## OAuth 2.0 / OpenID Connect (OIDC)
> **Tier**: Server
> **Tier**: Team

OAuth 2.0 SSO allows login via popular identity providers like:
- Google
Expand Down
2 changes: 1 addition & 1 deletion docs/Configuration/Storage/DATABASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ tags: [server, database, management]
---

# Database Backups
> **Tier**: Server
> **Tier**: Team

## Functionality Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/Configuration/Storage/External Database.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ tags: [server, database]
---

# Using an External Database
> **Tier**: Server
> **Tier**: Team

It is possible to use your own external database with Stirling PDF rather than the default H2 database if you wish.
PostgreSQL is currently the only supported variant, others will be added on request.
Expand Down
2 changes: 1 addition & 1 deletion docs/Configuration/Storage/Google Drive File Picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ tags: [server, management, feature, advanced feature]
---

# Google Drive File Picker
> **Tier**: Server
> **Tier**: Team

Stirling PDF allows users to select Files for processing through tools via google drive.

Expand Down
2 changes: 1 addition & 1 deletion docs/Getting Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Upgrading from V1? What's new in V2 and how to upgrade smoothly
**[Production Deployment Guide](./Server-Admin-Onboarding.md)**
Complete walkthrough: installation - configuration - security - monitoring

**[Paid Offerings (Server & Enterprise)](./Paid-Offerings)**
**[Paid Offerings (Team & Enterprise)](./Paid-Offerings)**
External databases, Google Drive integration, SSO, advanced monitoring, and priority support

**[Configuration Options](./Configuration/Customisation/Extra-Settings.md)**
Expand Down
4 changes: 2 additions & 2 deletions docs/Modes-and-Licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The desktop app signed in to your Stirling.com Cloud account. Basic tools still

### With a self-hosted server

The desktop app pointed at a Stirling PDF instance you run yourself. All tools route to your server and **no credits apply**. Whichever license tier your server runs (Free, Server, Enterprise) is what the desktop client gets.
The desktop app pointed at a Stirling PDF instance you run yourself. All tools route to your server and **no credits apply**. Whichever license tier your server runs (Free, Team, Enterprise) is what the desktop client gets.

---

Expand All @@ -60,7 +60,7 @@ The hosted version at [stirling.com/app](https://stirling.com/app). All processi

## More than 5 users

The free tier covers up to 5 users. Once you have more than 5, you need a paid Server or Enterprise plan. Server includes 100 users and adds capacity in blocks of 100; Enterprise is sized to your organization under a custom agreement. A paid plan also adds:
The free tier covers up to 5 users. Once you have more than 5, you need a paid Team or Enterprise plan. Team includes 100 users and adds capacity in blocks of 100; Enterprise is sized to your organization under a custom agreement. A paid plan also adds:

- Official support (tickets, SLAs, priority responses)
- SSO, SAML, audit logging, and other paid-tier features
Expand Down
32 changes: 16 additions & 16 deletions docs/Paid-Offerings.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@
sidebar_position: 8
id: Paid-Offerings
title: Paid Offerings
description: Server and Enterprise paid plans for Stirling PDF
description: Team and Enterprise paid plans for Stirling PDF
tags:
- Enterprise
- Server
- Team
- Paid
- Pricing

---
# Stirling PDF Paid Offerings

Stirling PDF offers Server and Enterprise paid plans. These provide the same great software with added features, streamlined license management, and support options.
Stirling PDF offers Team and Enterprise paid plans. These provide the same great software with added features, streamlined license management, and support options.

> This page covers **self-hosted** Server and Enterprise licensing (a license key, no credits). Stirling Cloud and the credit-based Processor plan are separate offerings - see [Modes](./Modes-and-Licensing.md) for how the deployment modes compare, and [stirling.com/pricing](https://www.stirling.com/pricing) for the full plan lineup.
> This page covers **self-hosted** Team and Enterprise licensing (a license key, no credits). Stirling Cloud and the credit-based Processor plan are separate offerings - see [Modes](./Modes-and-Licensing.md) for how the deployment modes compare, and [stirling.com/pricing](https://www.stirling.com/pricing) for the full plan lineup.

## Available Plans

Expand All @@ -28,7 +28,7 @@ Stirling PDF offers Server and Enterprise paid plans. These provide the same gre
- Regular updates
- **Perfect for**: Personal use, small teams, or evaluation

### Server Plan
### Team Plan
- **Cost**: $99/month or $999/year (save $189 with annual billing)
- **Available billing**: Monthly or Yearly
- **Users**: 100 users included. Add capacity in blocks of 100 users as your team grows
Expand All @@ -51,7 +51,7 @@ Stirling PDF offers Server and Enterprise paid plans. These provide the same gre
- **Available billing**: Agreed as part of your contract
- **Users**: Sized to your organization, with volume discounts as you scale
- **Features**:
- All Server Plan features, plus:
- All Team Plan features, plus:
- Air-gapped / offline deployment, activated with a [certificate file](#option-2-certificate-file-air-gapped-offline) instead of an online key check
- Uptime SLAs
- Custom procurement, security review, and contract terms
Expand All @@ -73,10 +73,10 @@ Stirling PDF offers Server and Enterprise paid plans. These provide the same gre

### In-App Purchase (Recommended)

Stirling PDF offers streamlined in-app purchasing and license activation. This covers the Server plan; Enterprise is quoted and issued by sales rather than bought in-app.
Stirling PDF offers streamlined in-app purchasing and license activation. This covers the Team plan; Enterprise is quoted and issued by sales rather than bought in-app.

1. **Navigate to Settings**: Log in as an admin and go to Settings → Plan
2. **Select Your Plan**: Choose the Server plan (100 users included, capacity added in blocks of 100)
2. **Select Your Plan**: Choose the Team plan (100 users included, capacity added in blocks of 100)
3. **Choose Billing Period**: Select monthly or yearly billing (yearly saves money)
4. **Complete Checkout**: You'll be redirected to Stripe's secure checkout
5. **Automatic Activation**: After payment, your license key is automatically retrieved and activated
Expand Down Expand Up @@ -203,24 +203,24 @@ premium:
Stirling PDF uses an **installation-based licensing model**:

- Each license is tied to a specific installation (identified by machine fingerprint)
- **Server Plan**: $99/month covers one installation with 100 users included
- **Team Plan**: $99/month covers one installation with 100 users included
- Capacity is added in blocks of 100 users, so you get one bill instead of per-seat licenses
- Example: 100 users = under $1 per user per month
- **Enterprise Plan**: Capacity and terms are set in your contract, with volume discounts as you scale
- [Contact sales](https://www.stirling.com/contact-us) for a quote covering your user count, deployment model, and SLA

## Upgrading Your Plan

You can upgrade from Free → Server at any time:
You can upgrade from Free → Team at any time:

1. Navigate to Settings → Plan
2. On the plan tier you want, click "Upgrade"
3. Complete checkout
4. Your existing license will be automatically upgraded

Moving Server → Enterprise goes through sales - use the "Contact Us" button on the Enterprise tier in Settings → Plan, or [contact sales](https://www.stirling.com/contact-us).
Moving Team → Enterprise goes through sales - use the "Contact Us" button on the Enterprise tier in Settings → Plan, or [contact sales](https://www.stirling.com/contact-us).

Adding more user capacity to an existing Server plan is coming soon as an in-app feature. Until it lands, email support@stirlingpdf.com and we'll add the block for you.
Adding more user capacity to an existing Team plan is coming soon as an in-app feature. Until it lands, email support@stirlingpdf.com and we'll add the block for you.

**Note**: When upgrading, your new plan starts immediately and you'll be credited for any unused time on your previous plan.

Expand All @@ -230,9 +230,9 @@ Adding more user capacity to an existing Server plan is coming soon as an in-app
- GitHub Issues: [github.com/Stirling-Tools/Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF)
- Discord: Join our community server

### Email Support (Server & Enterprise)
### Email Support (Team & Enterprise)
- Email: support@stirlingpdf.com
- Response time: 1-2 business days (Server), Priority response (Enterprise)
- Response time: 1-2 business days (Team), Priority response (Enterprise)

### Enterprise Support
- Priority email support
Expand All @@ -249,7 +249,7 @@ A: Yes! The Free plan includes all features for up to 5 users. Test thoroughly b
A: Your license remains active until the end of your billing period, then reverts to Free plan limits.

**Q: What happens when we pass 100 users?**
A: The Server plan includes 100 users. When you need more, capacity is added in blocks of 100 - you stay on one bill rather than buying individual seats. Adding a block from inside the app is coming soon; in the meantime, email support@stirlingpdf.com.
A: The Team plan includes 100 users. When you need more, capacity is added in blocks of 100 - you stay on one bill rather than buying individual seats. Adding a block from inside the app is coming soon; in the meantime, email support@stirlingpdf.com.

**Q: How is Enterprise priced?**
A: Custom, based on your user count, deployment model, and the terms you need. It is not sold in-app - [contact sales](https://www.stirling.com/contact-us) for a quote. Volume discounts apply as you scale. If you want to see it working first, [book a demo](https://www.stirling.com/book-a-demo).
Expand All @@ -261,7 +261,7 @@ A: Contact support@stirlingpdf.com for license transfers. Enterprise customers h
A: License activation requires internet for initial verification. Enterprise customers running air-gapped can request offline certificate files instead.

**Q: What's the difference between monthly and yearly billing?**
A: Yearly billing offers significant savings. For Server plan: $999/year vs $1,188/year monthly (save $189 = almost 2 months free).
A: Yearly billing offers significant savings. For Team plan: $999/year vs $1,188/year monthly (save $189 = almost 2 months free).

**Q: How do I get an invoice?**
A: Invoices are automatically sent via email and accessible through the Billing Portal.
Expand Down
22 changes: 11 additions & 11 deletions docs/Server-Admin-Onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ By the end of this guide, you'll have:
3. ✅ **Settings customized** for your organization
4. ✅ **Security hardened** with HTTPS and proper access controls
5. ✅ **Monitoring setup** to track usage and performance
6. ✅ **Understanding of paid plan** upgrade paths (Server/Enterprise)
6. ✅ **Understanding of paid plan** upgrade paths (Team/Enterprise)

**Time estimate:** 30-60 minutes for basic setup, 2-3 hours for full enterprise configuration

Expand Down Expand Up @@ -510,7 +510,7 @@ MAIL_STARTTLSENABLE=true
**Best for:** Large enterprises, existing SSO infrastructure

**Single Sign-On (SSO) options:**
- **OAuth2:** Server tier - Supports Google, GitHub, Keycloak, any OpenID Connect provider
- **OAuth2:** Team tier - Supports Google, GitHub, Keycloak, any OpenID Connect provider
- **SAML2:** Enterprise tier - Supports Okta, Azure AD, etc.

**Key settings:**
Expand Down Expand Up @@ -1175,10 +1175,10 @@ Protect your users' data and configuration with proper backups.

**\*Note on User Database:**
- **Free edition:** Uses a local H2 database file named `stirling-pdf-DB-<schema-version>.mv.db` (the schema version is embedded in the filename, e.g. `stirling-pdf-DB-2.3.232.mv.db`) - must be backed up. The simplest approach is to back up the whole `configs/` directory.
- **Server/Enterprise:** Should use external PostgreSQL database (backed up separately)
- **Team/Enterprise:** Should use external PostgreSQL database (backed up separately)

:::tip Server/Enterprise Recommendation
Server and Enterprise plan users should configure an external PostgreSQL database instead of using the local H2 database. This provides better reliability, scalability, and backup capabilities.
:::tip Team/Enterprise Recommendation
Team and Enterprise plan users should configure an external PostgreSQL database instead of using the local H2 database. This provides better reliability, scalability, and backup capabilities.

**Learn more:** [External Database Configuration](./Configuration/Storage/External%20Database.md)
:::
Expand Down Expand Up @@ -1312,19 +1312,19 @@ For resource sizing recommendations, scaling guidance, and fine tuning, see the

---

## Step 10: Paid Plans (Server/Enterprise)
## Step 10: Paid Plans (Team/Enterprise)

Stirling-PDF offers **Server and Enterprise paid plans** with additional features for organizations.
Stirling-PDF offers **Team and Enterprise paid plans** with additional features for organizations.

### Key Paid Plan Features

**Authentication & Security:**
- **OAuth2 SSO:** Server tier (Google, GitHub, Keycloak, OIDC)
- **OAuth2 SSO:** Team tier (Google, GitHub, Keycloak, OIDC)
- **SAML2 SSO:** Enterprise tier (Okta, Azure AD, etc.)
- Enhanced security features

**Database & Infrastructure:**
- **External PostgreSQL Database:** Available for Server/Enterprise deployments
- **External PostgreSQL Database:** Available for Team/Enterprise deployments
- Better reliability and scalability than local H2 database
- Professional backup and replication strategies

Expand Down Expand Up @@ -1440,14 +1440,14 @@ Run the built-in [diagnostics tool](./Configuration/Operations/Diagnostics.md) i
- Search GitHub Issues: https://github.com/Stirling-Tools/Stirling-PDF/issues

**For Priority Support:**
- Upgrade to Server or Enterprise plan
- Upgrade to Team or Enterprise plan
- Email: support@stirlingpdf.com
- Get dedicated support team

---

**You're all set!** 🎉

Your Stirling-PDF deployment is ready for production use. If you have any questions or need assistance, don't hesitate to reach out to our community or consider upgrading to a paid plan (Server or Enterprise) for dedicated support.
Your Stirling-PDF deployment is ready for production use. If you have any questions or need assistance, don't hesitate to reach out to our community or consider upgrading to a paid plan (Team or Enterprise) for dedicated support.

Happy PDF processing! 📄✨
Loading