Skip to content

Commit 3b78d5b

Browse files
authored
headless (#101)
* headless * updates
1 parent f1213c8 commit 3b78d5b

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

docs/Installation/Windows.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,52 @@ Stirling PDF for Windows comes in two versions: a **Desktop Application** for pe
5050
- Unlimited file storage (not limited by browser)
5151
- System tray icon for quick access
5252

53+
### Automated Installation (MSI Installer)
54+
55+
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.
56+
57+
**Available Parameters:**
58+
59+
| Parameter | Description | Example Value |
60+
|-----------|-------------|---------------|
61+
| `STIRLING_SERVER_URL` | Pre-configure the server URL that the desktop app connects to | `http://192.168.1.53:2357/` |
62+
| `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) |
63+
64+
**Example Installation Command:**
65+
66+
```batch
67+
msiexec /i "Stirling-PDF-windows-x86_64.msi" /qn STIRLING_SERVER_URL="http://192.168.1.53:2357" STIRLING_LOCK_CONNECTION=1
68+
```
69+
70+
**Command Breakdown:**
71+
- `msiexec` - Windows Installer command-line tool (included with all Windows installations) for installing, modifying, and performing operations on MSI packages
72+
- `/i` - Install the MSI package
73+
- `/qn` - Run silently with no user interface (quiet mode, no UI)
74+
- `STIRLING_SERVER_URL` - Automatically sets the server URL on first launch
75+
- `STIRLING_LOCK_CONNECTION=1` - Locks the connection to the specified server (users cannot change it)
76+
77+
**Additional Parameters:**
78+
79+
| Parameter | Description | Example |
80+
|-----------|-------------|---------|
81+
| `INSTALLDIR` | Custom installation directory | `INSTALLDIR="C:\CustomPath\Stirling-PDF"` |
82+
| `ALLUSERS` | Install for all users (requires admin).<br/>`1` = all users, `0` or omit = current user only | `ALLUSERS=1` |
83+
84+
**Technical Details:**
85+
86+
- **Default Install Location**: `C:\Program Files\Stirling-PDF`
87+
- **Settings Storage**: `%APPDATA%\stirling.pdf.dev\connection.json` (per-user settings)
88+
- **Provisioning File**:
89+
- Per-user install: `%APPDATA%\stirling.pdf.dev\stirling-provisioning.json`
90+
- All-users install: `%PROGRAMDATA%\Stirling-PDF\stirling-provisioning.json`
91+
- **URL Format**: Must include protocol (`http://` or `https://`), trailing slash is optional
92+
93+
**Notes:**
94+
- The MSI installer is available in the [releases](https://github.com/Stirling-Tools/Stirling-PDF/releases/latest)
95+
- When `STIRLING_LOCK_CONNECTION=1` is set, users cannot modify the server URL in the application settings
96+
- For unattended installations without parameters, omit the custom properties
97+
- System-wide provisioning files (`%PROGRAMDATA%`) are not deleted after being applied, allowing reinstallation with same settings
98+
5399
## Server Version (For Hosting and Sharing)
54100

55101
Want to host Stirling-PDF on a Windows server for multiple users? Use the server version.

0 commit comments

Comments
 (0)