Skip to content

Commit ec4977e

Browse files
committed
Condense Modes & Licensing: just describe the modes, point at Paid Offerings for details
1 parent 1f80f1e commit ec4977e

1 file changed

Lines changed: 14 additions & 191 deletions

File tree

docs/Modes-and-Licensing.md

Lines changed: 14 additions & 191 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
sidebar_position: 6
33
id: Modes and Licensing
44
title: Modes & Licensing
5-
description: How Desktop, Self-hosted, and Stirling Cloud modes differ - features, credits, and licensing
5+
description: The different ways to run Stirling PDF and where credits / licensing apply
66
tags:
77
- Licensing
8-
- Pricing
98
- Modes
109
- Cloud
1110
- Self-host
@@ -14,230 +13,54 @@ tags:
1413

1514
# Modes and Licensing
1615

17-
Stirling PDF runs in several different modes depending on how you deploy it. This page explains what each mode does, which features are available, where credits apply, and what the license terms cover.
18-
19-
If you've ever asked "do credits apply if I download the Windows app?" or "can I use this commercially on the free plan?", this is the page for you.
16+
Stirling PDF runs in several modes depending on how you deploy it. This page is just an overview of what each mode is - for pricing, feature matrix, and full license terms see [Paid Offerings](./Paid-Offerings.md).
2017

2118
---
2219

23-
## The five modes at a glance
20+
## At a glance
2421

2522
| Mode | What it is | Where files are processed | Credits? | License gate |
2623
|---|---|---|---|---|
27-
| **Desktop - Local** | Native Windows/Mac/Linux app, no sign-in | Your device (bundled local backend) | No | Free |
24+
| **Desktop - Local** | Native Windows/Mac/Linux app, no sign-in | Your device | No | Free |
2825
| **Desktop + Stirling Cloud** | Same desktop app, signed in to Stirling Cloud | Mix: local for basic tools, cloud for advanced | Yes, on cloud-routed ops | Cloud account |
29-
| **Desktop + Self-hosted server** | Desktop app pointed at your own Stirling server | Your server | No | Whatever your server has (Free/Server/Enterprise) |
26+
| **Desktop + Self-hosted server** | Desktop app pointed at your own Stirling server | Your server | No | Whatever your server has |
3027
| **Web - Self-hosted** | Docker / Kubernetes / JAR, accessed via browser | Your server | No | Free / Server / Enterprise |
3128
| **Stirling Cloud SaaS** | `stirlingpdf.com` web app | Stirling Cloud | Yes | Cloud account / subscription |
3229

3330
---
3431

35-
## Desktop - Local Mode
36-
37-
The default for the Windows, Mac, and Linux desktop apps. No sign-in, no server, no credits.
38-
39-
### What works locally
40-
41-
Tools that run inside the bundled local backend, with no external dependencies:
42-
43-
- Merge, split, rotate, rearrange, remove pages, crop, scale
44-
- Add password, remove password, change permissions, sign (handwritten or certificate)
45-
- Add watermark, stamp, page numbers
46-
- Multi-tool, compare, read, annotate
47-
- Edit table of contents, extract bookmarks
48-
- Most operations that don't need a server
49-
50-
### What does not work locally
51-
52-
Some tools need server-side processing and are **not bundled with the desktop app**. Attempting to use them shows:
53-
54-
> *"This tool requires an account. Sign in to Stirling Cloud or connect to a self-hosted server to use it."*
32+
## Desktop - Local
5533

56-
These tools include:
34+
The default for the Windows, Mac, and Linux desktop apps. No sign-in, no server, no credits. Basic PDF tools (merge, split, rotate, sign, watermark, page operations, etc.) run entirely on your device.
5735

58-
- OCR (PDF → searchable PDF)
59-
- Conversions: PDF ↔ Word / Excel / PowerPoint / HTML / XML / EPUB / PDF/A
60-
- HTML / URL / Markdown / EML → PDF
61-
- Compression and repair
62-
- Image scan extraction
63-
- Replace/invert colors, scanner effect, vector export
64-
65-
To use those, either **sign in to Stirling Cloud** or **connect to a self-hosted server**.
66-
67-
### Switching to local from another mode
68-
69-
In the desktop app: open settings and choose "Local". Every operation then runs against the bundled local backend.
36+
Tools that need server-side processing (OCR, document-format conversions, compression, repair) are not available in this mode - sign in to Stirling Cloud or connect to a self-hosted server to use them.
7037

7138
---
7239

7340
## Desktop + Stirling Cloud
7441

75-
The desktop app, signed in to your Stirling Cloud account.
76-
77-
### How it routes
78-
79-
- **Auth and team endpoints** always go to Stirling Cloud.
80-
- **Tool endpoints** first try the bundled local backend. If the local backend supports the tool, it runs locally (no credits). If not, the request is routed to the Stirling Cloud backend, **which is when credits are consumed**.
81-
- This means simple tools (merge, split, rotate) run locally even when signed in to Cloud; advanced tools (OCR, conversions) run on Cloud.
82-
83-
### When credits apply
84-
85-
Credits **only** apply when a tool is routed to the Stirling Cloud backend. Examples:
86-
87-
- Compress / Convert / OCR / Cert-sign / Timestamp → routed to Cloud → credits used
88-
- Merge / Split / Rotate / Sign / Watermark → handled locally → no credits
89-
90-
This is why local-only operations stay free even on a paid Stirling Cloud account.
42+
The desktop app signed in to your Stirling Cloud account. Basic tools still run locally for free; advanced tools route to Stirling Cloud and consume credits.
9143

9244
---
9345

9446
## Desktop + Self-hosted server
9547

96-
Point the desktop app at a Stirling PDF server you run (Docker, Kubernetes, or JAR).
97-
98-
### How it routes
99-
100-
- **All tool requests** go to the configured remote server.
101-
- If the remote server is unreachable, supported tools fall back to the bundled local backend (so basic ops keep working during outages).
102-
- **No credits** - credits do not apply in self-hosted mode regardless of who initiated the request.
103-
104-
### Why this mode exists
105-
106-
Best of both worlds: keep the native app experience and the OS-level credential storage, while having full feature access (OCR, conversions, etc.) backed by your own infrastructure.
107-
108-
Common pattern: run Stirling PDF in Docker on a NAS or VM, distribute the desktop app to colleagues, and point everyone at the shared server.
109-
110-
### Locking the server URL
111-
112-
For IT-managed deployments, the MSI installer (Windows) can lock the connection mode so end users can't change the server. See [Automated Installation](./Installation/Windows.md#automated-installation).
48+
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.
11349

11450
---
11551

11652
## Web - Self-hosted
11753

118-
Stirling PDF running in Docker, Kubernetes, or as a bare-metal JAR, accessed via web browser.
119-
120-
### Credits
121-
122-
**Never applicable.** Self-hosted deployments don't have credits.
123-
124-
### License tiers
125-
126-
The web self-hosted build has feature gates based on your license:
127-
128-
- **Free** (no license key): All PDF operations, secure login, up to 5 users, community support.
129-
- **Server license** ($99/month or $999/year): Adds unlimited users, SSO/OAuth2 (Google, GitHub, Keycloak, any OIDC), Google Drive integration, external database (PostgreSQL), and editing text in PDFs.
130-
- **Enterprise license** (custom pricing): Adds SAML SSO, audit logging, usage tracking, Prometheus monitoring, custom PDF metadata, and per-seat licensing.
131-
132-
See [Paid Offerings](./Paid-Offerings.md) for the full feature matrix and current pricing.
133-
134-
### The 5-user limit (Free plan)
135-
136-
Free deployments are capped at **5 user accounts in the database**. This is checked when creating a new user, not on login. Attempting to create the 6th user returns:
137-
138-
> `Maximum number of users reached. Allowed: 5, Available slots: 0`
139-
140-
The limit applies to the total number of user accounts in the system, not concurrent sessions. To raise it, install a Server license (unlimited users) or an Enterprise license (seat-capped).
141-
142-
### V1 → V2 grandfathering
143-
144-
If you upgraded from Stirling PDF V1 to V2 with existing users:
145-
146-
- Your existing user count is preserved, so an install with 50 V1 users keeps working on the Free plan after the upgrade.
147-
- Existing OAuth/SAML users keep SSO access without a paid license. New OAuth/SAML users on the same install still require a paid license.
148-
149-
Fresh V2 installs don't get grandfathering - the 5-user limit applies and OAuth/SAML require a paid license.
54+
Stirling PDF running in Docker, Kubernetes, or as a bare-metal JAR, accessed via a browser. **No credits ever.** License tier determines which advanced features (unlimited users, SSO, SAML, audit logs, etc.) are unlocked - see [Paid Offerings](./Paid-Offerings.md).
15055

15156
---
15257

15358
## Stirling Cloud SaaS
15459

155-
The hosted version at `stirlingpdf.com`. All processing happens in Stirling's cloud.
156-
157-
### Credits
158-
159-
Yes - every operation costs credits. Free accounts include a monthly allowance; paid plans include more (or unlimited) credits. Different operations cost different amounts depending on their compute requirements.
160-
161-
### Credit costs at a glance
162-
163-
| Tier | Credits | Example operations |
164-
|---|---|---|
165-
| **Free / Dev** | 0 | API sandbox, folder scanning preview, "developer" UI screens |
166-
| **Small** | 1 | Rotate, remove pages, add text, add password, remove password, crop, flatten, repair, sign, add page numbers, extract pages, rearrange, scale, edit table of contents, multi-tool, compare, add attachments, validate signature, read |
167-
| **Medium** | 3 | Split, merge, watermark, sanitize, add stamp, extract images, redact, change metadata, page layout, annotate, fill form, scanner effect, get PDF info, replace color, remove blanks, auto-rename, booklet imposition, PDF to single page |
168-
| **Large** | 5 | Compress, convert (any format), OCR, cert-sign, timestamp-pdf |
169-
| **Extra Large** | 10 | Automate (pipeline run) |
170-
171-
Unmapped operations default to the **Medium** tier.
172-
173-
Credits reset monthly. Upgrade to a paid plan for more credits (or remove the limit entirely on higher tiers).
174-
175-
### Why credits exist in SaaS but not self-hosted
176-
177-
In SaaS, you're using Stirling's compute. Credits meter that usage. In self-hosted, you're using your own compute - there's nothing for Stirling to meter.
178-
179-
This is also why the same desktop app does and doesn't consume credits depending on which mode you're in: signed in to Cloud, advanced tools route to Stirling's servers → credits; signed in to your own server or running fully local, no credits.
180-
181-
---
182-
183-
## License terms - what's free for commercial use
184-
185-
Stirling PDF's source is split:
186-
187-
- **Most of the codebase is MIT-licensed.** Use it however you like, including commercially, with attribution.
188-
- **The proprietary modules** - the paid backend features, the SaaS frontend, and the desktop client - are covered by the **Stirling PDF User License**, which is not MIT.
189-
190-
### What the Stirling PDF User License says
191-
192-
The user license explicitly limits the free tier to:
193-
194-
> *"internal trial, evaluation, or minimal use"*
195-
196-
…and rules out:
197-
198-
> *"client-facing or commercial contexts"*
199-
200-
…without a paid subscription.
201-
202-
### Practical translation
203-
204-
| Use case | License needed |
205-
|---|---|
206-
| Personal use on your laptop | Free |
207-
| Internal team evaluation / proof of concept | Free |
208-
| Open-source community / hobby projects | Free (MIT for the core code) |
209-
| Production deployment inside a business | Paid (Server or Enterprise) |
210-
| Customer-facing service | Paid |
211-
| Bundling into a commercial product | Paid (contact us about OEM terms) |
212-
| Forking the MIT subset for your own non-commercial project | Free |
213-
214-
If you're not sure where your use case falls, [contact us](https://www.stirling.com/book-a-demo) or email `support@stirlingpdf.com` for a definitive answer.
215-
216-
---
217-
218-
## Quick decision tree
219-
220-
```
221-
Are you running it on your own infrastructure (Docker, K8s, JAR)?
222-
├─ Yes → No credits ever. License is Free for trial/personal, paid for
223-
│ commercial/production. SSO is Server+, SAML is Enterprise+.
224-
└─ No → Are you using the desktop app?
225-
├─ Yes → Are you signed in to Stirling Cloud?
226-
│ ├─ No (local mode) → No credits. Local-only tools only.
227-
│ │ Advanced tools require sign-in or self-host.
228-
│ └─ Yes → Basic tools run locally (free), advanced tools
229-
│ run on Stirling Cloud (uses credits).
230-
└─ No (using stirlingpdf.com web app) → Every operation uses
231-
credits according to the tier.
232-
```
60+
The hosted version at `stirlingpdf.com`. All processing happens in Stirling's cloud, and every operation costs credits. Free accounts include a monthly allowance; paid plans include more credits. See [Paid Offerings](./Paid-Offerings.md) for current pricing.
23361

23462
---
23563

236-
## Related documentation
64+
## Commercial use
23765

238-
- **[Paid Offerings](./Paid-Offerings.md)** - Feature matrix, pricing, what each license unlocks
239-
- **[Installation - Docker](./Installation/Docker%20Install.md)** - Self-hosting via Docker
240-
- **[Installation - Kubernetes](./Installation/Kubernetes.md)** - Self-hosting via Helm
241-
- **[OAuth SSO Configuration](./Configuration/OAuth%20SSO%20Configuration.md)** - Setting up SSO (Server license)
242-
- **[SAML SSO Configuration](./Configuration/SAML%20SSO%20Configuration/SAML%20SSO%20Configuration.md)** - Setting up SAML (Enterprise license)
243-
- **[FAQ](./FAQ.md)** - Other common questions
66+
The free tier of Stirling PDF (across all the above modes) is intended for personal, internal trial, or minimal use. Production and customer-facing commercial use requires a paid Server or Enterprise license. See [Paid Offerings](./Paid-Offerings.md) for details or [contact us](https://www.stirling.com/book-a-demo) if you're not sure where your use case falls.

0 commit comments

Comments
 (0)