From b6dfd14797dab04d819228d87eaae1c655f786fa Mon Sep 17 00:00:00 2001 From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com> Date: Fri, 24 Apr 2026 13:18:36 +0100 Subject: [PATCH 1/2] distrobution docs --- docs/Installation/Mac.md | 58 ++++++++++++---------- docs/Installation/Unix.md | 48 ++++++++++++++---- docs/Installation/Windows.md | 95 +++++++++++++++++++++++------------- docusaurus.config.js | 2 +- 4 files changed, 133 insertions(+), 70 deletions(-) diff --git a/docs/Installation/Mac.md b/docs/Installation/Mac.md index 8bffeff3..63323429 100644 --- a/docs/Installation/Mac.md +++ b/docs/Installation/Mac.md @@ -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. @@ -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) | + + + **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) + + + ```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 + ``` + + ### Using the Desktop App diff --git a/docs/Installation/Unix.md b/docs/Installation/Unix.md index 649a69b0..690eceab 100644 --- a/docs/Installation/Unix.md +++ b/docs/Installation/Unix.md @@ -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) + + + ```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. + + + ```bash + wget https://files.stirlingpdf.com/linux-installer.rpm + sudo dnf install ./linux-installer.rpm + ``` + + + 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 + ``` + + + 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). + + ### Connecting to a server diff --git a/docs/Installation/Windows.md b/docs/Installation/Windows.md index 56064828..d3fe60fe 100644 --- a/docs/Installation/Windows.md +++ b/docs/Installation/Windows.md @@ -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. @@ -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. + + + + 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. + + + ```powershell + winget install StirlingTools.StirlingPDF + ``` + + For unattended deployments with a pre-configured server URL, see [Automated Installation](#automated-installation) below. + + + ```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 + ``` + + ### Connecting to a server @@ -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.
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).
`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:** + + + + ```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). + + + ```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. + + **Technical Details:** @@ -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) diff --git a/docusaurus.config.js b/docusaurus.config.js index fec765be..1e9a4f02 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -111,7 +111,7 @@ const config = { lastVersion: 'current', versions: { current: { - label: '2.0 (Current)', + label: '2+ (Current)', banner: 'none', badge: false, }, From ec943a288a456e8e287897c1655254d3e1806ad6 Mon Sep 17 00:00:00 2001 From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com> Date: Fri, 24 Apr 2026 13:21:57 +0100 Subject: [PATCH 2/2] distrobution docs --- docs/Installation/Mac.md | 2 +- docs/Installation/Unix.md | 2 +- docs/Installation/Windows.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/Installation/Mac.md b/docs/Installation/Mac.md index 63323429..363a0057 100644 --- a/docs/Installation/Mac.md +++ b/docs/Installation/Mac.md @@ -30,7 +30,7 @@ Native Mac desktop app with all PDF tools available. Pick whichever method you prefer. Both install the same desktop app. - + **1. Download the right version for your Mac:** diff --git a/docs/Installation/Unix.md b/docs/Installation/Unix.md index 690eceab..ec67fccc 100644 --- a/docs/Installation/Unix.md +++ b/docs/Installation/Unix.md @@ -30,7 +30,7 @@ Native Linux desktop app with all PDF tools available. Pick whichever package format matches your distribution. - + ```bash wget https://files.stirlingpdf.com/linux-installer.deb diff --git a/docs/Installation/Windows.md b/docs/Installation/Windows.md index d3fe60fe..aa3e0f0e 100644 --- a/docs/Installation/Windows.md +++ b/docs/Installation/Windows.md @@ -31,7 +31,7 @@ Stirling PDF for Windows comes in two versions: a **Desktop Application** for pe Pick whichever method you prefer. All three install the same desktop app. - + 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`) @@ -111,7 +111,7 @@ Silent/headless installation with custom parameters, ideal for IT deployments (S **Example:** - + ```batch msiexec /i "Stirling-PDF-windows-x86_64.msi" /qn STIRLING_SERVER_URL="http://192.168.1.53:2357" STIRLING_LOCK_CONNECTION=1