Skip to content

Commit c06a214

Browse files
FrooodleFrooodle
authored
distrobution docs (#113)
1 parent 3176dab commit c06a214

4 files changed

Lines changed: 133 additions & 70 deletions

File tree

‎docs/Installation/Mac.md‎

Lines changed: 32 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ sidebar_position: 2
33
id: Mac Installation
44
title: Mac Installation Guide
55
---
6+
7+
import Tabs from '@theme/Tabs';
8+
import TabItem from '@theme/TabItem';
9+
610
# MacOS Installation Guide for Stirling PDF
711

812
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.
2226
- ✅ **No external browser needed** - Uses the built-in window
2327
- ✅ **Menu bar integration** - Feels like a native Mac app
2428

25-
### Installation Steps
29+
### Installation
2630

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

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

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

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

42-
1. Open the downloaded `.dmg` file
43-
2. Drag Stirling PDF to your Applications folder
44+
**2. Install:** open the `.dmg` and drag Stirling PDF to your Applications folder.
4445

45-
![mac-installer.png](/img/mac-installer.png)
46+
![mac-installer.png](/img/mac-installer.png)
4647

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

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

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

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

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

62-
The app will now open normally every time!
64+
```bash
65+
brew upgrade --cask stirling-pdf
66+
```
67+
</TabItem>
68+
</Tabs>
6369

6470
### Using the Desktop App
6571

‎docs/Installation/Unix.md‎

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,49 @@ Native Linux desktop app with all PDF tools available.
2828

2929
### Installation
3030

31-
**1. Download:**
31+
Pick whichever package format matches your distribution.
3232

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

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

37-
```bash
38-
sudo dpkg -i linux-installer.deb
39-
```
51+
```bash
52+
wget https://files.stirlingpdf.com/linux-installer.AppImage
53+
chmod +x linux-installer.AppImage
54+
./linux-installer.AppImage
55+
```
4056

41-
**3. Launch Stirling-PDF:**
42-
- Search for "Stirling-PDF" in your application menu, or
43-
- Run `stirling-pdf` from the terminal
57+
If you see `fuse: device not found` on Ubuntu 22.04+, install FUSE:
58+
59+
```bash
60+
sudo apt-get install libfuse2
61+
```
62+
</TabItem>
63+
<TabItem value="aur" label="AUR (Arch)">
64+
Install via any AUR helper:
65+
66+
```bash
67+
paru -S stirling-pdf-desktop
68+
# or: yay -S stirling-pdf-desktop
69+
```
70+
71+
Package: [stirling-pdf-desktop](https://aur.archlinux.org/packages/stirling-pdf-desktop).
72+
</TabItem>
73+
</Tabs>
4474

4575
### Connecting to a server
4676

‎docs/Installation/Windows.md‎

Lines changed: 61 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ sidebar_position: 2
33
id: Windows Installation
44
title: Windows Guide
55
---
6+
7+
import Tabs from '@theme/Tabs';
8+
import TabItem from '@theme/TabItem';
9+
610
# Windows Installation Guide for Stirling PDF
711

812
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
2327
- ✅ **Better performance** - Optimized for Windows
2428
- ✅ **No browser needed** - Standalone application
2529

26-
### Quick Installation
30+
### Installation
31+
32+
Pick whichever method you prefer. All three install the same desktop app.
33+
34+
<Tabs groupId="windows-install" queryString>
35+
<TabItem value="installer" label="Installer" default>
36+
1. Download: [Stirling PDF Desktop Installer](https://files.stirlingpdf.com/win-installer.exe)
37+
2. Run the installer and follow the prompts (installs to `C:\Program Files\Stirling-PDF`)
38+
3. Launch from the Start Menu - search for "Stirling PDF"
39+
40+
For unattended deployments with a pre-configured server URL, see [Automated Installation](#automated-installation) below.
41+
</TabItem>
42+
<TabItem value="winget" label="winget">
43+
```powershell
44+
winget install StirlingTools.StirlingPDF
45+
```
46+
47+
For unattended deployments with a pre-configured server URL, see [Automated Installation](#automated-installation) below.
48+
</TabItem>
49+
<TabItem value="scoop" label="Scoop">
50+
```powershell
51+
scoop bucket add stirling-pdf https://github.com/Stirling-Tools/homebrew-stirling-pdf
52+
scoop install stirling-pdf/stirling-pdf
53+
```
54+
55+
Updates come through automatically on new releases:
2756

28-
1. **Download**: [Stirling PDF Desktop Installer](https://files.stirlingpdf.com/win-installer.exe)
29-
2. **Run the installer** - Follow the prompts (installs to `C:\Program Files\Stirling-PDF`)
30-
3. **Launch from Start Menu** - Search for "Stirling PDF"
31-
4. **Start working with PDFs!**
32-
5. **Optionally connect a server** - For advanced tools, see [Connecting to a server](#connecting-to-a-server) below
57+
```powershell
58+
scoop update stirling-pdf
59+
```
60+
</TabItem>
61+
</Tabs>
3362

3463
### Connecting to a server
3564

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

70-
### Automated Installation (MSI Installer)
99+
### Automated Installation
71100

72-
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.
101+
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`.
73102

74103
**Available Parameters:**
75104

76105
| Parameter | Description | Example Value |
77106
|-----------|-------------|---------------|
78107
| `STIRLING_SERVER_URL` | Pre-configure the server URL that the desktop app connects to | `http://192.168.1.53:2357/` |
79-
| `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) |
80-
81-
**Example Installation Command:**
82-
83-
```batch
84-
msiexec /i "Stirling-PDF-windows-x86_64.msi" /qn STIRLING_SERVER_URL="http://192.168.1.53:2357" STIRLING_LOCK_CONNECTION=1
85-
```
86-
87-
**Command Breakdown:**
88-
- `msiexec` - Windows Installer command-line tool (included with all Windows installations) for installing, modifying, and performing operations on MSI packages
89-
- `/i` - Install the MSI package
90-
- `/qn` - Run silently with no user interface (quiet mode, no UI)
91-
- `STIRLING_SERVER_URL` - Automatically sets the server URL on first launch
92-
- `STIRLING_LOCK_CONNECTION=1` - Locks the connection to the specified server (users cannot change it)
93-
94-
**Additional Parameters:**
95-
96-
| Parameter | Description | Example |
97-
|-----------|-------------|---------|
98-
| `INSTALLDIR` | Custom installation directory | `INSTALLDIR="C:\CustomPath\Stirling-PDF"` |
99-
| `ALLUSERS` | Install for all users (requires admin).<br/>`1` = all users, `0` or omit = current user only | `ALLUSERS=1` |
108+
| `STIRLING_LOCK_CONNECTION` | Lock the connection mode so users cannot change the server. `1` = locked, `0` or omit = unlocked | `1` |
109+
| `INSTALLDIR` | Custom installation directory (MSI only) | `INSTALLDIR="C:\CustomPath\Stirling-PDF"` |
110+
| `ALLUSERS` | Install for all users (requires admin). `1` = all users, `0` or omit = current user | `ALLUSERS=1` |
111+
112+
**Example:**
113+
114+
<Tabs groupId="windows-automated" queryString>
115+
<TabItem value="msi" label="MSI (msiexec)" default>
116+
```batch
117+
msiexec /i "Stirling-PDF-windows-x86_64.msi" /qn STIRLING_SERVER_URL="http://192.168.1.53:2357" STIRLING_LOCK_CONNECTION=1
118+
```
119+
120+
`/i` installs, `/qn` runs silently with no UI. The MSI is available in the [releases](https://github.com/Stirling-Tools/Stirling-PDF/releases/latest).
121+
</TabItem>
122+
<TabItem value="winget" label="winget">
123+
```powershell
124+
winget install StirlingTools.StirlingPDF `
125+
--custom "STIRLING_SERVER_URL=http://192.168.1.53:2357 STIRLING_LOCK_CONNECTION=1"
126+
```
127+
128+
`--custom` forwards parameters straight to the underlying MSI, so the same properties work.
129+
</TabItem>
130+
</Tabs>
100131

101132
**Technical Details:**
102133

@@ -106,12 +137,8 @@ msiexec /i "Stirling-PDF-windows-x86_64.msi" /qn STIRLING_SERVER_URL="http://192
106137
- Per-user install: `%APPDATA%\stirling.pdf.dev\stirling-provisioning.json`
107138
- All-users install: `%PROGRAMDATA%\Stirling-PDF\stirling-provisioning.json`
108139
- **URL Format**: Must include protocol (`http://` or `https://`), trailing slash is optional
109-
110-
**Notes:**
111-
- The MSI installer is available in the [releases](https://github.com/Stirling-Tools/Stirling-PDF/releases/latest)
112140
- When `STIRLING_LOCK_CONNECTION=1` is set, users cannot modify the server URL in the application settings
113-
- For unattended installations without parameters, omit the custom properties
114-
- System-wide provisioning files (`%PROGRAMDATA%`) are not deleted after being applied, allowing reinstallation with same settings
141+
- System-wide provisioning files (`%PROGRAMDATA%`) are not deleted after being applied, allowing reinstallation with the same settings
115142

116143
## Server Version (For Hosting and Sharing)
117144

‎docusaurus.config.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ const config = {
111111
lastVersion: 'current',
112112
versions: {
113113
current: {
114-
label: '2.0 (Current)',
114+
label: '2+ (Current)',
115115
banner: 'none',
116116
badge: false,
117117
},

0 commit comments

Comments
 (0)