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
58 changes: 32 additions & 26 deletions docs/Installation/Mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ sidebar_position: 2
id: Mac Installation
title: Mac Installation Guide
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# MacOS Installation Guide for Stirling PDF

Stirling PDF for Mac is available as a **native desktop application** or can run as a **server** using the JAR file.
Expand All @@ -22,44 +26,46 @@ Native Mac desktop app with all PDF tools available.
- ✅ **No external browser needed** - Uses the built-in window
- ✅ **Menu bar integration** - Feels like a native Mac app

### Installation Steps
### Installation

**1. Download the right version for your Mac:**
Pick whichever method you prefer. Both install the same desktop app.

| Chip Type | Download Link |
|-----------|--------------|
| **Apple Silicon** (M1/M2/M3) | [Download for Apple Silicon](https://files.stirlingpdf.com/mac-installer.dmg) |
| **Intel** processors | [Download for Intel](https://files.stirlingpdf.com/mac-x86_64-installer.dmg) |
<Tabs groupId="mac-install" queryString>
<TabItem value="dmg" label="DMG Installer" default>
**1. Download the right version for your Mac:**

**Not sure which chip you have?**
- Click the Apple menu → "About This Mac"
- Look at "Chip" or "Processor"
- If it says "M1", "M2", or "M3" → Use Apple Silicon version
- If it says "Intel" → Use Intel version
| Chip Type | Download Link |
|-----------|--------------|
| **Apple Silicon** (M1/M2/M3) | [Download for Apple Silicon](https://files.stirlingpdf.com/mac-installer.dmg) |
| **Intel** processors | [Download for Intel](https://files.stirlingpdf.com/mac-x86_64-installer.dmg) |

**2. Install the application:**
Not sure which chip you have? Click the Apple menu → "About This Mac" and look at "Chip" or "Processor".

1. Open the downloaded `.dmg` file
2. Drag Stirling PDF to your Applications folder
**2. Install:** open the `.dmg` and drag Stirling PDF to your Applications folder.

![mac-installer.png](/img/mac-installer.png)
![mac-installer.png](/img/mac-installer.png)

**3. First-time launch (Security):**
**3. First-time launch (Gatekeeper):** macOS blocks the app on first launch because it's not from the App Store.

macOS will block the app on first launch because it's not from the App Store:
![mac-app-blocked.png](/img/mac-app-blocked.png)

![mac-app-blocked.png](/img/mac-app-blocked.png)
Open **System Settings → Privacy & Security**, scroll to the **Security** section, click **"Open Anyway"** next to the Stirling PDF message, then launch again.

**To allow Stirling PDF:**
1. Open **System Settings** → **Privacy & Security**
2. Scroll down to the **Security** section
3. Click **"Open Anyway"** next to the Stirling PDF message
4. Enter your password if prompted
5. Go back to Applications and launch Stirling PDF again
![mac-security-allow.png](/img/mac-security-allow.png)
</TabItem>
<TabItem value="brew" label="Homebrew">
```bash
brew tap Stirling-Tools/stirling-pdf
brew install --cask stirling-pdf
```

![mac-security-allow.png](/img/mac-security-allow.png)
Updates come through `brew upgrade`:

The app will now open normally every time!
```bash
brew upgrade --cask stirling-pdf
```
</TabItem>
</Tabs>

### Using the Desktop App

Expand Down
48 changes: 39 additions & 9 deletions docs/Installation/Unix.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,49 @@ Native Linux desktop app with all PDF tools available.

### Installation

**1. Download:**
Pick whichever package format matches your distribution.

[Stirling-PDF Desktop Installer (DEB)](https://files.stirlingpdf.com/linux-installer.deb)
<Tabs groupId="linux-install" queryString>
<TabItem value="deb" label="DEB (Debian/Ubuntu)" default>
```bash
wget https://files.stirlingpdf.com/linux-installer.deb
sudo dpkg -i linux-installer.deb
```

**2. Install the application:**
Launch via your application menu or `stirling-pdf` from the terminal.
</TabItem>
<TabItem value="rpm" label="RPM (Fedora/RHEL)">
```bash
wget https://files.stirlingpdf.com/linux-installer.rpm
sudo dnf install ./linux-installer.rpm
```
</TabItem>
<TabItem value="appimage" label="AppImage">
No install required - download, mark executable, run:

```bash
sudo dpkg -i linux-installer.deb
```
```bash
wget https://files.stirlingpdf.com/linux-installer.AppImage
chmod +x linux-installer.AppImage
./linux-installer.AppImage
```

**3. Launch Stirling-PDF:**
- Search for "Stirling-PDF" in your application menu, or
- Run `stirling-pdf` from the terminal
If you see `fuse: device not found` on Ubuntu 22.04+, install FUSE:

```bash
sudo apt-get install libfuse2
```
</TabItem>
<TabItem value="aur" label="AUR (Arch)">
Install via any AUR helper:

```bash
paru -S stirling-pdf-desktop
# or: yay -S stirling-pdf-desktop
```

Package: [stirling-pdf-desktop](https://aur.archlinux.org/packages/stirling-pdf-desktop).
</TabItem>
</Tabs>

### Connecting to a server

Expand Down
95 changes: 61 additions & 34 deletions docs/Installation/Windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ sidebar_position: 2
id: Windows Installation
title: Windows Guide
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Windows Installation Guide for Stirling PDF

Stirling PDF for Windows comes in two versions: a **Desktop Application** for personal use and a **Server Version** for hosting and sharing with others.
Expand All @@ -23,13 +27,38 @@ Stirling PDF for Windows comes in two versions: a **Desktop Application** for pe
- ✅ **Better performance** - Optimized for Windows
- ✅ **No browser needed** - Standalone application

### Quick Installation
### Installation

Pick whichever method you prefer. All three install the same desktop app.

<Tabs groupId="windows-install" queryString>
<TabItem value="installer" label="Installer" default>
1. Download: [Stirling PDF Desktop Installer](https://files.stirlingpdf.com/win-installer.exe)
2. Run the installer and follow the prompts (installs to `C:\Program Files\Stirling-PDF`)
3. Launch from the Start Menu - search for "Stirling PDF"

For unattended deployments with a pre-configured server URL, see [Automated Installation](#automated-installation) below.
</TabItem>
<TabItem value="winget" label="winget">
```powershell
winget install StirlingTools.StirlingPDF
```

For unattended deployments with a pre-configured server URL, see [Automated Installation](#automated-installation) below.
</TabItem>
<TabItem value="scoop" label="Scoop">
```powershell
scoop bucket add stirling-pdf https://github.com/Stirling-Tools/homebrew-stirling-pdf
scoop install stirling-pdf/stirling-pdf
```

Updates come through automatically on new releases:

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!**
5. **Optionally connect a server** - For advanced tools, see [Connecting to a server](#connecting-to-a-server) below
```powershell
scoop update stirling-pdf
```
</TabItem>
</Tabs>

### Connecting to a server

Expand Down Expand Up @@ -67,36 +96,38 @@ The desktop app works fully offline for local PDF tools like merging, splitting,
- Unlimited file storage (not limited by browser)
- System tray icon for quick access

### Automated Installation (MSI Installer)
### Automated Installation

The Windows desktop MSI installer supports silent/headless installation with custom parameters, ideal for IT deployments, deployment scripts (SCCM, Intune, Group Policy), or enforcing connections to self-hosted servers.
Silent/headless installation with custom parameters, ideal for IT deployments (SCCM, Intune, Group Policy) or enforcing connections to self-hosted servers. Works via either the MSI installer directly or `winget --custom`.

**Available Parameters:**

| Parameter | Description | Example Value |
|-----------|-------------|---------------|
| `STIRLING_SERVER_URL` | Pre-configure the server URL that the desktop app connects to | `http://192.168.1.53:2357/` |
| `STIRLING_LOCK_CONNECTION` | Lock the connection mode to prevent users from changing server settings.<br/>Set to `1` to enforce self-hosted server only, preventing accidental connections to external servers. | `1` (locked) or `0` (unlocked) |

**Example Installation Command:**

```batch
msiexec /i "Stirling-PDF-windows-x86_64.msi" /qn STIRLING_SERVER_URL="http://192.168.1.53:2357" STIRLING_LOCK_CONNECTION=1
```

**Command Breakdown:**
- `msiexec` - Windows Installer command-line tool (included with all Windows installations) for installing, modifying, and performing operations on MSI packages
- `/i` - Install the MSI package
- `/qn` - Run silently with no user interface (quiet mode, no UI)
- `STIRLING_SERVER_URL` - Automatically sets the server URL on first launch
- `STIRLING_LOCK_CONNECTION=1` - Locks the connection to the specified server (users cannot change it)

**Additional Parameters:**

| Parameter | Description | Example |
|-----------|-------------|---------|
| `INSTALLDIR` | Custom installation directory | `INSTALLDIR="C:\CustomPath\Stirling-PDF"` |
| `ALLUSERS` | Install for all users (requires admin).<br/>`1` = all users, `0` or omit = current user only | `ALLUSERS=1` |
| `STIRLING_LOCK_CONNECTION` | Lock the connection mode so users cannot change the server. `1` = locked, `0` or omit = unlocked | `1` |
| `INSTALLDIR` | Custom installation directory (MSI only) | `INSTALLDIR="C:\CustomPath\Stirling-PDF"` |
| `ALLUSERS` | Install for all users (requires admin). `1` = all users, `0` or omit = current user | `ALLUSERS=1` |

**Example:**

<Tabs groupId="windows-automated" queryString>
<TabItem value="msi" label="MSI (msiexec)" default>
```batch
msiexec /i "Stirling-PDF-windows-x86_64.msi" /qn STIRLING_SERVER_URL="http://192.168.1.53:2357" STIRLING_LOCK_CONNECTION=1
```

`/i` installs, `/qn` runs silently with no UI. The MSI is available in the [releases](https://github.com/Stirling-Tools/Stirling-PDF/releases/latest).
</TabItem>
<TabItem value="winget" label="winget">
```powershell
winget install StirlingTools.StirlingPDF `
--custom "STIRLING_SERVER_URL=http://192.168.1.53:2357 STIRLING_LOCK_CONNECTION=1"
```

`--custom` forwards parameters straight to the underlying MSI, so the same properties work.
</TabItem>
</Tabs>

**Technical Details:**

Expand All @@ -106,12 +137,8 @@ msiexec /i "Stirling-PDF-windows-x86_64.msi" /qn STIRLING_SERVER_URL="http://192
- Per-user install: `%APPDATA%\stirling.pdf.dev\stirling-provisioning.json`
- All-users install: `%PROGRAMDATA%\Stirling-PDF\stirling-provisioning.json`
- **URL Format**: Must include protocol (`http://` or `https://`), trailing slash is optional

**Notes:**
- The MSI installer is available in the [releases](https://github.com/Stirling-Tools/Stirling-PDF/releases/latest)
- When `STIRLING_LOCK_CONNECTION=1` is set, users cannot modify the server URL in the application settings
- For unattended installations without parameters, omit the custom properties
- System-wide provisioning files (`%PROGRAMDATA%`) are not deleted after being applied, allowing reinstallation with same settings
- System-wide provisioning files (`%PROGRAMDATA%`) are not deleted after being applied, allowing reinstallation with the same settings

## Server Version (For Hosting and Sharing)

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ const config = {
lastVersion: 'current',
versions: {
current: {
label: '2.0 (Current)',
label: '2+ (Current)',
banner: 'none',
badge: false,
},
Expand Down
Loading