Skip to content

Commit a3eabfc

Browse files
authored
init (#102)
1 parent 3b78d5b commit a3eabfc

7 files changed

Lines changed: 101 additions & 14 deletions

File tree

docs/Configuration/OAuth SSO Configuration.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,8 +440,17 @@ Automatically redirect users to OAuth login page, bypassing the Stirling-PDF log
440440
</TabItem>
441441
</Tabs>
442442

443+
**Auto-login Activation Requirements:**
444+
445+
Auto-login only triggers when **ALL** of the following conditions are met:
446+
447+
1. `ssoAutoLogin` is enabled (as configured above)
448+
2. `loginMethod` is NOT `'all'` and NOT `'normal'` (i.e., SSO-only mode required)
449+
3. Exactly one OAuth provider is configured
450+
443451
**Behavior:**
444-
- Users are automatically redirected to OAuth provider login
452+
- When all conditions are met: Users are automatically redirected to OAuth provider login
453+
- When conditions are not met: Standard login page is displayed
445454
- After 5 failed login attempts (configurable via `security.loginAttemptCount`), auto-redirect is disabled
446455
- Users can still access manual login by navigating directly to `/login`
447456

docs/Configuration/SAML SSO Configuration/SAML SSO Configuration.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -352,9 +352,18 @@ premium:
352352
SSOAutoLogin: true
353353
```
354354

355+
**Auto-login Activation Requirements:**
356+
357+
Auto-login only triggers when **ALL** of the following conditions are met:
358+
359+
1. `ssoAutoLogin` is enabled (as configured above)
360+
2. `loginMethod` is NOT `'all'` and NOT `'normal'` (i.e., SSO-only mode required)
361+
3. Exactly one SAML provider is configured
362+
355363
**Behavior:**
356-
- Users accessing Stirling-PDF are immediately redirected to IdP
357-
- After 5 failed attempts (configurable via `security.loginAttemptCount`), auto-redirect is disabled
364+
- When all conditions are met: Users are automatically redirected to IdP
365+
- When conditions are not met: Standard login page is displayed
366+
- After 5 failed login attempts (configurable via `security.loginAttemptCount`), auto-redirect is disabled
358367
- Users can still manually access `/login` for form login if `loginMethod: all`
359368

360369
## Troubleshooting

docs/Getting Started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,16 +76,16 @@ Choose how you want to run Stirling-PDF based on your needs:
7676

7777
### 🖥️ Desktop Applications
7878

79-
Native apps with offline support and system integration:
79+
Native apps with system integration:
8080

8181
| Platform | Download | Guide |
8282
|----------|----------|-------|
8383
| **Windows** | [Installer](https://files.stirlingpdf.com/win-installer.exe) | [Windows Guide](./Installation/Windows.md) |
8484
| **Mac (Apple Silicon)** | [DMG](https://files.stirlingpdf.com/mac-installer.dmg) | [Mac Guide](./Installation/Mac.md) |
8585
| **Mac (Intel)** | [DMG](https://files.stirlingpdf.com/mac-x86_64-installer.dmg) | [Mac Guide](./Installation/Mac.md) |
86-
| **Linux** | AppImage/DEB/RPM | [Unix Guide](./Installation/Unix.md) |
86+
| **Linux** | [DEB](https://files.stirlingpdf.com/linux-installer.deb) | [Unix Guide](./Installation/Unix.md) |
8787

88-
**Features:** Lightning-fast startup, "Open with" integration, works completely offline
88+
**Features:** Lightning-fast startup, "Open with" integration, sign in with Stirling Cloud or self-hosted server
8989

9090
---
9191

docs/Installation/Mac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Stirling PDF for Mac is available as a **native desktop application** or can run
99

1010
## Desktop Application (Recommended)
1111

12-
**V2.0 brings a native Mac desktop experience** with all PDF tools available offline!
12+
Native Mac desktop app with all PDF tools available.
1313

1414
### What You Get
1515

docs/Installation/Unix.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,56 @@ import TabItem from '@theme/TabItem';
99

1010
# Unix Installation
1111

12+
Stirling PDF on Linux is available as a **native desktop application** or as a **server** using the JAR file.
13+
14+
## Desktop Application (Recommended for Personal Use)
15+
16+
Native Linux desktop app with all PDF tools available.
17+
18+
### What You Get
19+
20+
-**Native Linux application** - Integrated with your desktop environment
21+
-**Open PDFs directly** - Double-click any PDF to open in Stirling-PDF
22+
-**Sign in to start** - Choose Stirling Cloud or your self-hosted server on launch (required before using tools)
23+
-**Processes files locally after sign-in** - All your PDF processing stays on your device
24+
-**All features included** - Every PDF tool available
25+
-**Better performance** - Native Linux integration
26+
-**No browser needed** - Standalone application
27+
28+
### Installation
29+
30+
**1. Download:**
31+
32+
[Stirling-PDF Desktop Installer (DEB)](https://files.stirlingpdf.com/linux-installer.deb)
33+
34+
**2. Install the application:**
35+
36+
```bash
37+
sudo dpkg -i linux-installer.deb
38+
```
39+
40+
**3. Launch Stirling-PDF:**
41+
- Search for "Stirling-PDF" in your application menu, or
42+
- Run `stirling-pdf` from the terminal
43+
44+
### Choosing your connection
45+
46+
On first launch, you'll be prompted to choose how to connect:
47+
48+
**Stirling Cloud**
49+
- Sign in with your Stirling Cloud account
50+
- All PDF processing stays on your device — your files never leave your machine
51+
- Login is required because optional cloud assists for advanced tasks are planned for a future release
52+
53+
**Self-hosted Server**
54+
- Enter the URL of your own Stirling-PDF server instance (e.g., `http://192.168.1.53:8080`)
55+
- Files are processed on your server, keeping data under your control
56+
- Useful for team deployments or running your own Stirling-PDF server
57+
58+
---
59+
60+
## Server Version (For Hosting and Sharing)
61+
1262
To run the application without Docker/Podman, you will need to manually install all dependencies and build the necessary components.
1363

1464
Note that some dependencies might not be available in the standard repositories of all Linux distributions, and may require additional steps to install.

docs/Installation/Windows.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Stirling PDF for Windows comes in two versions: a **Desktop Application** for pe
1515

1616
-**Native Windows application** - Feels like a built-in Windows program
1717
-**Open PDFs directly** - Double-click any PDF to open in Stirling-PDF
18-
-**Works completely offline** - No internet required after installation
18+
-**Sign in to start** - Choose Stirling Cloud or your self-hosted server on first launch (required before using tools)
19+
-**Processes files locally after sign-in** - All your PDF processing stays on your device
1920
-**All features included** - Every PDF tool available
2021
-**Automatic updates** - Stay current with latest features
2122
-**Better performance** - Optimized for Windows
@@ -26,7 +27,22 @@ Stirling PDF for Windows comes in two versions: a **Desktop Application** for pe
2627
1. **Download**: [Stirling-PDF Desktop Installer](https://files.stirlingpdf.com/win-installer.exe)
2728
2. **Run the installer** - Follow the prompts (installs to `C:\Program Files\Stirling-PDF`)
2829
3. **Launch from Start Menu** - Search for "Stirling-PDF"
29-
4. **Start working with PDFs!**
30+
4. **Sign in** - Choose how to connect (see [Choosing your connection](#choosing-your-connection) below)
31+
5. **Start working with PDFs!**
32+
33+
### Choosing your connection
34+
35+
On first launch, you'll be prompted to choose how to connect:
36+
37+
**Stirling Cloud**
38+
- Sign in with your Stirling Cloud account
39+
- All PDF processing stays on your device — your files never leave your machine
40+
- Login is required because optional cloud assists for advanced tasks are planned for a future release
41+
42+
**Self-hosted Server**
43+
- Enter the URL of your own Stirling-PDF server instance (e.g., `http://192.168.1.53:8080`)
44+
- Files are processed on your server, keeping data under your control
45+
- Useful for team deployments or running your own Stirling-PDF server
3046

3147
### Using the Desktop App
3248

docs/Migration/New-Features.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Original.pdf → [Compress] → v1 → [Add Pages] → v2 → [Watermark] → v3
8787

8888
---
8989

90-
## 🖥️ Desktop Applications (Tauri)
90+
## 🖥️ Desktop Applications
9191

9292
**NEW:** Native desktop apps for Windows, Mac, and Linux.
9393

@@ -96,7 +96,7 @@ Original.pdf → [Compress] → v1 → [Add Pages] → v2 → [Watermark] → v3
9696
- **Lightning Fast:** 0.3 second startup time
9797
- **Native Integration:** "Open with Stirling-PDF" in file explorer
9898
- **System Default:** Set as default PDF viewer
99-
- **Offline Capable:** Full functionality without server
99+
- **Sign in with Stirling Cloud or self-hosted server** - Choose your connection on launch
100100
- **Resource Efficient:** Uses ~50MB RAM vs browser ~200MB
101101

102102
### Platform Support
@@ -105,7 +105,7 @@ Original.pdf → [Compress] → v1 → [Add Pages] → v2 → [Watermark] → v3
105105
|----------|--------|----------|
106106
| **Windows** | `.exe` installer | Context menu integration |
107107
| **macOS** | `.dmg` | Dock integration |
108-
| **Linux** | `.AppImage`, `.deb` | Desktop file integration |
108+
| **Linux** | `.deb` | Desktop file integration |
109109

110110
### Key Differences from Web
111111

@@ -124,10 +124,13 @@ After installation:
124124
1. Right-click any PDF in file explorer
125125
2. Select "Open with Stirling-PDF"
126126
3. PDF opens directly in app
127-
4. Process immediately
127+
4. Sign in (if needed)
128+
5. Process immediately
128129

129130
**Learn More:**
130-
- [Installation Guide](../Installation/Windows.md)
131+
- [Windows Installation](../Installation/Windows.md)
132+
- [Mac Installation](../Installation/Mac.md)
133+
- [Linux Installation](../Installation/Unix.md)
131134

132135
---
133136

0 commit comments

Comments
 (0)