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
11 changes: 10 additions & 1 deletion docs/Configuration/OAuth SSO Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,8 +440,17 @@ Automatically redirect users to OAuth login page, bypassing the Stirling-PDF log
</TabItem>
</Tabs>

**Auto-login Activation Requirements:**

Auto-login only triggers when **ALL** of the following conditions are met:

1. `ssoAutoLogin` is enabled (as configured above)
2. `loginMethod` is NOT `'all'` and NOT `'normal'` (i.e., SSO-only mode required)
3. Exactly one OAuth provider is configured

**Behavior:**
- Users are automatically redirected to OAuth provider login
- When all conditions are met: Users are automatically redirected to OAuth provider login
- When conditions are not met: Standard login page is displayed
- After 5 failed login attempts (configurable via `security.loginAttemptCount`), auto-redirect is disabled
- Users can still access manual login by navigating directly to `/login`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -352,9 +352,18 @@ premium:
SSOAutoLogin: true
```

**Auto-login Activation Requirements:**

Auto-login only triggers when **ALL** of the following conditions are met:

1. `ssoAutoLogin` is enabled (as configured above)
2. `loginMethod` is NOT `'all'` and NOT `'normal'` (i.e., SSO-only mode required)
3. Exactly one SAML provider is configured

**Behavior:**
- Users accessing Stirling-PDF are immediately redirected to IdP
- After 5 failed attempts (configurable via `security.loginAttemptCount`), auto-redirect is disabled
- When all conditions are met: Users are automatically redirected to IdP
- When conditions are not met: Standard login page is displayed
- After 5 failed login attempts (configurable via `security.loginAttemptCount`), auto-redirect is disabled
- Users can still manually access `/login` for form login if `loginMethod: all`

## Troubleshooting
Expand Down
6 changes: 3 additions & 3 deletions docs/Getting Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,16 +76,16 @@ Choose how you want to run Stirling-PDF based on your needs:

### 🖥️ Desktop Applications

Native apps with offline support and system integration:
Native apps with system integration:

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

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

---

Expand Down
2 changes: 1 addition & 1 deletion docs/Installation/Mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Stirling PDF for Mac is available as a **native desktop application** or can run

## Desktop Application (Recommended)

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

### What You Get

Expand Down
50 changes: 50 additions & 0 deletions docs/Installation/Unix.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,56 @@ import TabItem from '@theme/TabItem';

# Unix Installation

Stirling PDF on Linux is available as a **native desktop application** or as a **server** using the JAR file.

## Desktop Application (Recommended for Personal Use)

Native Linux desktop app with all PDF tools available.

### What You Get

- ✅ **Native Linux application** - Integrated with your desktop environment
- ✅ **Open PDFs directly** - Double-click any PDF to open in Stirling-PDF
- ✅ **Sign in to start** - Choose Stirling Cloud or your self-hosted server on launch (required before using tools)
- ✅ **Processes files locally after sign-in** - All your PDF processing stays on your device
- ✅ **All features included** - Every PDF tool available
- ✅ **Better performance** - Native Linux integration
- ✅ **No browser needed** - Standalone application

### Installation

**1. Download:**

[Stirling-PDF Desktop Installer (DEB)](https://files.stirlingpdf.com/linux-installer.deb)

**2. Install the application:**

```bash
sudo dpkg -i linux-installer.deb
```

**3. Launch Stirling-PDF:**
- Search for "Stirling-PDF" in your application menu, or
- Run `stirling-pdf` from the terminal

### Choosing your connection

On first launch, you'll be prompted to choose how to connect:

**Stirling Cloud**
- Sign in with your Stirling Cloud account
- All PDF processing stays on your device — your files never leave your machine
- Login is required because optional cloud assists for advanced tasks are planned for a future release

**Self-hosted Server**
- Enter the URL of your own Stirling-PDF server instance (e.g., `http://192.168.1.53:8080`)
- Files are processed on your server, keeping data under your control
- Useful for team deployments or running your own Stirling-PDF server

---

## Server Version (For Hosting and Sharing)

To run the application without Docker/Podman, you will need to manually install all dependencies and build the necessary components.

Note that some dependencies might not be available in the standard repositories of all Linux distributions, and may require additional steps to install.
Expand Down
20 changes: 18 additions & 2 deletions docs/Installation/Windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Stirling PDF for Windows comes in two versions: a **Desktop Application** for pe

- ✅ **Native Windows application** - Feels like a built-in Windows program
- ✅ **Open PDFs directly** - Double-click any PDF to open in Stirling-PDF
- ✅ **Works completely offline** - No internet required after installation
- ✅ **Sign in to start** - Choose Stirling Cloud or your self-hosted server on first launch (required before using tools)
- ✅ **Processes files locally after sign-in** - All your PDF processing stays on your device
- ✅ **All features included** - Every PDF tool available
- ✅ **Automatic updates** - Stay current with latest features
- ✅ **Better performance** - Optimized for Windows
Expand All @@ -26,7 +27,22 @@ Stirling PDF for Windows comes in two versions: a **Desktop Application** for pe
1. **Download**: [Stirling-PDF Desktop Installer](https://files.stirlingpdf.com/win-installer.exe)
2. **Run the installer** - Follow the prompts (installs to `C:\Program Files\Stirling-PDF`)
3. **Launch from Start Menu** - Search for "Stirling-PDF"
4. **Start working with PDFs!**
4. **Sign in** - Choose how to connect (see [Choosing your connection](#choosing-your-connection) below)
5. **Start working with PDFs!**

### Choosing your connection

On first launch, you'll be prompted to choose how to connect:

**Stirling Cloud**
- Sign in with your Stirling Cloud account
- All PDF processing stays on your device — your files never leave your machine
- Login is required because optional cloud assists for advanced tasks are planned for a future release

**Self-hosted Server**
- Enter the URL of your own Stirling-PDF server instance (e.g., `http://192.168.1.53:8080`)
- Files are processed on your server, keeping data under your control
- Useful for team deployments or running your own Stirling-PDF server

### Using the Desktop App

Expand Down
13 changes: 8 additions & 5 deletions docs/Migration/New-Features.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Original.pdf → [Compress] → v1 → [Add Pages] → v2 → [Watermark] → v3

---

## 🖥️ Desktop Applications (Tauri)
## 🖥️ Desktop Applications

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

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

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

### Key Differences from Web

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

**Learn More:**
- [Installation Guide](../Installation/Windows.md)
- [Windows Installation](../Installation/Windows.md)
- [Mac Installation](../Installation/Mac.md)
- [Linux Installation](../Installation/Unix.md)

---

Expand Down