Skip to content

headless #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Frooodle merged 2 commits into from
Feb 11, 2026
Merged

headless #101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e0c3fd
headless
Frooodle Feb 11, 2026
06a0f11
updates
Frooodle Feb 11, 2026
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
46 changes: 46 additions & 0 deletions docs/Installation/Windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,52 @@ Stirling PDF for Windows comes in two versions: a **Desktop Application** for pe
- Unlimited file storage (not limited by browser)
- System tray icon for quick access

### Automated Installation (MSI Installer)

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.

**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` |

**Technical Details:**

- **Default Install Location**: `C:\Program Files\Stirling-PDF`
- **Settings Storage**: `%APPDATA%\stirling.pdf.dev\connection.json` (per-user settings)
- **Provisioning File**:
- 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

## Server Version (For Hosting and Sharing)

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