Skip to content

Commit 2032e2c

Browse files
authored
Document certificate file upload flow for license activation (#117)
1 parent 44f996d commit 2032e2c

1 file changed

Lines changed: 29 additions & 11 deletions

File tree

docs/Paid-Offerings.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -99,18 +99,37 @@ If you purchased in-app, your license is automatically activated. No further act
9999

100100
### Manual Activation
101101

102+
Stirling PDF accepts two manual activation inputs from the admin UI: a license **key** (string), or a license **certificate file** (`.lic` / `.cert`, used for offline / air-gapped Enterprise activation).
103+
104+
#### Option 1 - License Key
105+
102106
If you purchased via the website and received a license key by email:
103107

104-
1. **Admin Settings**: Log in as an admin and navigate to Settings → Admin Plan
105-
2. **Enter License Key**: Paste your license key in the provided field
106-
3. **Activate**: Click "Activate License"
107-
4. **Confirmation**: Your plan features will be enabled immediately
108+
1. **Admin Settings**: Log in as an admin and navigate to Settings → Plan
109+
2. **Open License Input**: Expand the "Got a license key or certificate file?" section
110+
3. **Select Input Type**: Make sure "License Key" is selected
111+
4. **Enter License Key**: Paste your license key in the provided field
112+
5. **Activate**: Save to apply the license
113+
6. **Confirmation**: Your plan features will be enabled immediately
114+
115+
#### Option 2 - Certificate File (Air-Gapped / Offline)
116+
117+
If you received a `.lic` or `.cert` certificate file (typically issued for Enterprise customers who need to activate without outbound internet access):
118+
119+
1. **Admin Settings**: Log in as an admin and navigate to Settings → Plan
120+
2. **Open License Input**: Expand the "Got a license key or certificate file?" section
121+
3. **Select Input Type**: Switch to "Certificate File"
122+
4. **Choose File**: Click "Choose License File" and select your `.lic` or `.cert` file (must start with `-----BEGIN LICENSE FILE-----`)
123+
5. **Upload**: The file is uploaded, validated, saved to your `configs/` folder, and activated automatically. Any previous certificate is backed up to `configs/backup/`
124+
6. **Confirmation**: Your plan features will be enabled immediately
125+
126+
Both flows activate dynamically and do not strictly require a restart.
108127

109-
**No restart required** - license activation is dynamic!
128+
> **Recommended**: Restart the Stirling PDF installation after activation. While the license is applied immediately, restarting ensures all components (security profile, premium feature gates, user/seat counters, scheduled validation jobs) pick up the new license state from a clean startup. This avoids edge cases where cached state from before activation lingers in a long-running process.
110129
111130
### Legacy - settings.yml Activation
112131

113-
For advanced users or air-gapped environments, you can still activate via `settings.yml`:
132+
For scripted deployments or fully automated provisioning, you can still activate via `settings.yml` directly:
114133

115134
1. Navigate to the Stirling PDF config folder
116135
2. Open `settings.yml`
@@ -126,15 +145,14 @@ premium:
126145
5. Change `enabled` from `false` to `true`
127146
6. Restart Stirling PDF
128147

129-
For 100% offline air-gapped environments (Enterprise only), you can request a certificate file:
148+
To reference a certificate file from `settings.yml` instead of uploading via the UI:
130149

131-
1. Contact support to receive your `.crt` or `.lic` certificate file
132-
2. Place the certificate in your config folder (e.g., `configs/cert.crt`)
133-
3. Use the `file:` prefix to specify the certificate path:
150+
1. Place your `.lic` or `.cert` certificate in the config folder (e.g., `configs/cert.lic`)
151+
2. Use the `file:` prefix to point at the certificate path:
134152

135153
```yaml
136154
premium:
137-
key: file:configs/cert.crt
155+
key: file:configs/cert.lic
138156
enabled: true
139157
```
140158

0 commit comments

Comments
 (0)