Skip to content

Commit 84b82aa

Browse files
authored
remove v2 stuff and minor cleanup and fix links (#107)
1 parent 3ffa4dc commit 84b82aa

11 files changed

Lines changed: 10 additions & 202 deletions

docs/Configuration/Configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ Stirling PDF determines the interface language using this priority order:
136136

137137
To force a specific default language regardless of browser settings, users must manually select it via the language globe icon.
138138

139-
> 💡 **Tip**: Set `SYSTEM_DEFAULTLOCALE` to your organization's primary language. Users can always override it using the language selector in the top-right corner.
139+
> **Tip**: Set `SYSTEM_DEFAULTLOCALE` to your organization's primary language. Users can always override it using the language selector in the top-right corner.
140140

141141
### File Upload Limits
142142

docs/Configuration/System and Security.md

Lines changed: 0 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -136,65 +136,6 @@ java -jar Stirling-PDF.jar
136136

137137
---
138138

139-
## Split Deployment Configuration
140-
141-
Stirling PDF supports separating frontend and backend for better scalability and deployment flexibility.
142-
143-
### Deployment Modes
144-
145-
Configure deployment mode via the `MODE` environment variable:
146-
147-
| Mode | Description | Use Case |
148-
|------|-------------|----------|
149-
| `BOTH` | Frontend + Backend (default) | Single container deployment |
150-
| `BACKEND` | Backend only | API service, split deployment |
151-
| `FRONTEND` | Frontend only | Static frontend serving |
152-
153-
### Frontend URL Configuration
154-
155-
When using split deployment or load balancers, configure the frontend URL for generating links:
156-
157-
```yaml
158-
system:
159-
frontendUrl: 'https://pdf.example.com'
160-
```
161-
162-
**Environment Variable:**
163-
```bash
164-
SYSTEM_FRONTENDURL=https://pdf.example.com
165-
```
166-
167-
**Use Cases:**
168-
- Email invite links point to correct frontend
169-
- Download links reference proper URL
170-
- API responses include frontend URLs
171-
172-
### CORS Configuration
173-
174-
When frontend and backend are on different domains, enable CORS:
175-
176-
```yaml
177-
system:
178-
corsAllowedOrigins:
179-
- 'https://pdf.example.com'
180-
- 'https://pdf-staging.example.com'
181-
```
182-
183-
**Environment Variable:**
184-
```bash
185-
SYSTEM_CORSALLOWEDORIGINS=https://pdf.example.com,https://pdf-staging.example.com
186-
```
187-
188-
**Security Best Practices:**
189-
- Only specify trusted origins
190-
- Never use wildcard (`*`) in production
191-
- Always use HTTPS in production
192-
- Keep list minimal
193-
194-
**Learn more:** [Security - CORS Configuration](../Functionality/Security#cors-configuration)
195-
196-
---
197-
198139
## Server Certificates
199140

200141
Stirling PDF can auto-generate certificates for the "Sign with Stirling PDF" feature.
@@ -473,8 +414,6 @@ customFiles/
473414
system:
474415
defaultLocale: 'en-US' # Set the default language (e.g. 'de-DE', 'fr-FR', etc)
475416
googlevisibility: false # 'true' to allow Google visibility (via robots.txt), 'false' to disallow
476-
corsAllowedOrigins: [] # Add frontend URLs for split deployment
477-
frontendUrl: '' # Set for split deployment
478417
serverCertificate:
479418
enabled: true
480419
organizationName: Stirling-PDF
@@ -516,30 +455,10 @@ customFiles/
516455
environment:
517456
DISABLE_ADDITIONAL_FEATURES: false
518457
SECURITY_ENABLELOGIN: true
519-
SYSTEM_CORSALLOWEDORIGINS: https://pdf.example.com
520-
SYSTEM_FRONTENDURL: https://pdf.example.com
521458
SECURITY_JWT_PERSISTENCE: true
522459
SYSTEM_SERVERCERTIFICATE_ENABLED: true
523460
```
524461
</TabItem>
525-
<TabItem value="split-deployment" label="Split Deployment">
526-
**Backend Container:**
527-
```yaml
528-
environment:
529-
MODE: BACKEND
530-
DISABLE_ADDITIONAL_FEATURES: false
531-
SECURITY_ENABLELOGIN: true
532-
SYSTEM_CORSALLOWEDORIGINS: https://pdf.example.com
533-
SYSTEM_FRONTENDURL: https://pdf.example.com
534-
```
535-
536-
**Frontend Container:**
537-
```yaml
538-
environment:
539-
MODE: FRONTEND
540-
VITE_API_BASE_URL: http://backend:8080
541-
```
542-
</TabItem>
543462
</Tabs>
544463

545464
---

docs/FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,5 +108,5 @@ To disable authentication in the with-login version:
108108
</TabItem>
109109
</Tabs>
110110

111-
For more details, see the [System and Security Configuration](./Configuration/System%20and%20Security.md#disabling-login) documentation.
111+
For more details, see the [System and Security Configuration](./Configuration/System%20and%20Security.md#running-without-authentication) documentation.
112112

docs/Functionality/Mobile-Scanner.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: Scan documents from your mobile phone and upload them directly to y
88

99
The Mobile Scanner lets you scan documents using your phone camera and upload them directly to your Stirling PDF instance. Generate a QR code on your desktop, scan it with your phone, and your photos are transferred automatically - no cables, no cloud services, no manual file handling.
1010

11-
Depending on your [server settings](/Configuration/Mobile-Scanner), uploaded images can be automatically converted to PDF with configurable page format, resolution, and scaling options.
11+
Depending on your [server settings](../Configuration/Mobile-Scanner.md), uploaded images can be automatically converted to PDF with configurable page format, resolution, and scaling options.
1212

1313
## How It Works
1414

@@ -28,4 +28,4 @@ Depending on your [server settings](/Configuration/Mobile-Scanner), uploaded ima
2828

2929
## Configuration
3030

31-
See [Mobile Scanner Configuration](/Configuration/Mobile-Scanner) for enable/disable and PDF conversion settings.
31+
See [Mobile Scanner Configuration](../Configuration/Mobile-Scanner.md) for enable/disable and PDF conversion settings.

docs/Functionality/Multi-Tool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: Visual page editor for PDF manipulation
1111

1212
Multi-Tool is Stirling PDF's visual page editor. Upload PDFs and manipulate pages directly - rotate, reorder, delete, split, and insert pages or files.
1313

14-
:::tip V2.0 Feature
14+
:::tip
1515
Multi-Tool uses browser file storage so you can upload files once and work with them without re-uploading.
1616
:::
1717

docs/Functionality/Read-and-Annotate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: Interactive PDF viewer with annotation tools for reading and markup
1111

1212
Interactive PDF viewer and annotation system. Read PDFs directly in your browser while adding comments, highlights, drawings, shapes, and other markup.
1313

14-
:::tip V2.0 Feature
14+
:::tip
1515
Built with **[EmbedPDF](https://www.embedpdf.com/)**, an advanced open-source PDF viewer with full support for PDF annotation standards.
1616
:::
1717

docs/Functionality/Security/Certificate-Signing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,6 @@ Ensure `SYSTEM_SERVERCERTIFICATE_ENABLED=true` is set. Check logs with `docker l
267267

268268
## Related
269269

270-
- [System and Security Settings](../../Configuration/System%20and%20Security#signature-validation)
270+
- [System and Security Settings](../../Configuration/System%20and%20Security.md#signature-validation)
271271
- [Sign (Handwritten)](./Sign.md)
272-
- [Settings Changes (V2)](../../Migration/Settings-Changes#pdf-signature-validation)
272+
- [Settings Changes](../../Migration/Settings-Changes.md#pdf-signature-validation)

docs/Migration/Breaking-Changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -715,7 +715,7 @@ WARN: Unknown configuration key: premium.proFeatures.googleDrive
715715
716716
**Symptom:** Custom navbar/homepage not appearing.
717717
718-
**Solution:** Template system removed. Use in-app settings or custom CSS instead. See [Template Customization](#-template-customization-system-removed).
718+
**Solution:** Template system removed. Use in-app settings or custom CSS instead.
719719
720720
---
721721

docs/Migration/New-Features.md

Lines changed: 0 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -134,72 +134,6 @@ After installation:
134134

135135
---
136136

137-
## 🔀 Split Deployment Architecture
138-
139-
**NEW:** Deploy frontend and backend separately for better scalability.
140-
141-
### What's New
142-
143-
Three deployment modes:
144-
145-
#### 1. Unified Mode (Default)
146-
Single container with frontend + backend together.
147-
148-
```bash
149-
docker run -d \
150-
-p 8080:8080 \
151-
stirlingtools/stirling-pdf:latest
152-
```
153-
154-
#### 2. Split Mode
155-
Frontend and backend in separate containers.
156-
157-
**Backend:**
158-
```bash
159-
docker run -d \
160-
-e MODE=BACKEND \
161-
-p 8081:8080 \
162-
stirlingtools/stirling-pdf:latest
163-
```
164-
165-
**Frontend:**
166-
```bash
167-
docker run -d \
168-
-e MODE=FRONTEND \
169-
-e VITE_API_BASE_URL=http://backend:8080 \
170-
-p 8080:8080 \
171-
stirlingtools/stirling-pdf:latest
172-
```
173-
174-
#### 3. Backend-Only Mode
175-
Use as API-only service.
176-
177-
```bash
178-
docker run -d \
179-
-e MODE=BACKEND \
180-
-p 8080:8080 \
181-
stirlingtools/stirling-pdf:latest
182-
```
183-
184-
### Benefits
185-
186-
- **Independent Scaling:** Scale frontend and backend separately
187-
- **CDN Integration:** Serve static frontend from CDN
188-
- **Development:** Work on frontend without running backend
189-
- **Security:** Separate concerns, different security zones
190-
191-
### CORS Configuration
192-
193-
New settings for split deployment:
194-
195-
```yaml
196-
system:
197-
corsAllowedOrigins: ['https://pdf.example.com']
198-
frontendUrl: 'https://pdf.example.com'
199-
```
200-
201-
**Learn More:** [Docker Installation - Split Mode](../Installation/Docker%20Install#split-deployment-advanced-users)
202-
203137
---
204138

205139
## ⌨️ Custom Keyboard Shortcuts
@@ -692,7 +626,6 @@ ui:
692626
- ✉️ **Email Invitations** - Streamlined user onboarding
693627
- ⌨️ **Custom Keyboard Shortcuts** - Quick tool access
694628
- 🔄 **Enhanced Session Management** - Better token management with rotation
695-
- 🏗️ **Split Deployment** - Scale frontend and backend independently
696629

697630
---
698631

docs/Migration/Settings-Changes.md

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -66,33 +66,6 @@ system:
6666
6767
---
6868
69-
### Split Deployment Support
70-
71-
**New settings added:**
72-
73-
```yaml
74-
system:
75-
corsAllowedOrigins: [] # NEW in V2
76-
frontendUrl: '' # NEW in V2
77-
```
78-
79-
**What it does:**
80-
- `corsAllowedOrigins`: Allow frontend from different origin
81-
- `frontendUrl`: Base URL for generating invite links
82-
83-
**Migration:** Leave empty for unified deployment (default).
84-
85-
**Example split deployment:**
86-
```yaml
87-
system:
88-
corsAllowedOrigins: ['https://pdf.example.com']
89-
frontendUrl: 'https://pdf.example.com'
90-
```
91-
92-
**Learn more:** [Docker Installation - Split Mode](../Installation/Docker%20Install#split-deployment-advanced-users)
93-
94-
---
95-
9669
### Enhanced JWT Configuration
9770
9871
**Changed settings:**
@@ -265,8 +238,6 @@ Use this checklist when upgrading your `settings.yml`:
265238
- [ ] **Add `ui.logoStyle: classic`** if you want to explicitly set logo
266239
- [ ] **Configure `security.validation`** if you need custom signature validation
267240
- [ ] **Set `system.serverCertificate`** options if needed
268-
- [ ] **Add `system.corsAllowedOrigins`** if using split deployment
269-
- [ ] **Set `system.frontendUrl`** if using split deployment
270241
- [ ] **Enable `mail.enableInvites`** if you want email invitations
271242

272243
---
@@ -289,10 +260,6 @@ SYSTEM_SERVERCERTIFICATE_ENABLED=true
289260
SYSTEM_SERVERCERTIFICATE_ORGANIZATIONNAME="My Company"
290261
SYSTEM_SERVERCERTIFICATE_VALIDITY=365
291262
292-
# Split deployment
293-
SYSTEM_CORSALLOWEDORIGINS=https://pdf.example.com
294-
SYSTEM_FRONTENDURL=https://pdf.example.com
295-
296263
# JWT
297264
SECURITY_JWT_PERSISTENCE=true
298265
SECURITY_JWT_ENABLEKEYROTATION=true

0 commit comments

Comments
 (0)