Skip to content

Commit 61f4dd8

Browse files
committed
doc update
1 parent 2dab77a commit 61f4dd8

File tree

5 files changed

+170
-15
lines changed

5 files changed

+170
-15
lines changed

docs/Configuration/System and Security.md

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,18 @@ Stirling PDF allows customization of system and security settings. For security
1010

1111
## Basic Security Settings
1212

13-
- `enableLogin`: Enables or disables the login functionality
13+
- `enableLogin`: Enables or disables the login functionality (default: `true`)
1414
- `csrfDisabled`: Set to 'true' to disable CSRF protection (not recommended for production)
1515
- `defaultLocale`: Set the default language (e.g. 'de-DE', 'fr-FR', etc)
1616
- `googlevisibility`: 'true' to allow Google visibility (via robots.txt), 'false' to disallow
1717

1818
## Authentication Setup
1919

20+
**Note:** Authentication is **enabled by default**. If you want to run Stirling-PDF without authentication, see the [Disabling Login](#disabling-login) section below.
21+
2022
### Prerequisites
2123
1. Ensure the `/configs` directory is mounted as a volume in Docker for persistence across updates
2224
2. For Docker users: Set `DISABLE_ADDITIONAL_FEATURES=false` in environment variables
23-
3. Enable login either via `settings.yml` or set `SECURITY_ENABLELOGIN=true`
2425

2526
### Initial Login Credentials
2627
- Default Username: `admin`
@@ -56,6 +57,57 @@ When using the API:
5657
X-API-KEY: your-api-key-here
5758
```
5859

60+
## Disabling Login
61+
62+
If you want to run Stirling-PDF without authentication (open access mode), you can disable the login functionality.
63+
64+
### Using Settings File
65+
66+
Edit your `settings.yml` file:
67+
68+
```yaml
69+
security:
70+
enableLogin: false
71+
```
72+
73+
### Using Environment Variables
74+
75+
Set the environment variable when starting Stirling-PDF:
76+
77+
**Docker Run:**
78+
```bash
79+
-e SECURITY_ENABLELOGIN=false
80+
```
81+
82+
**Docker Compose:**
83+
```yaml
84+
environment:
85+
SECURITY_ENABLELOGIN: false
86+
```
87+
88+
**JAR File (Command Line):**
89+
```bash
90+
java -jar Stirling-PDF.jar -DSECURITY_ENABLELOGIN=false
91+
```
92+
93+
**JAR File (Environment Variable):**
94+
```bash
95+
export SECURITY_ENABLELOGIN=false
96+
java -jar Stirling-PDF.jar
97+
```
98+
99+
### When to Disable Login
100+
101+
**Consider disabling login if:**
102+
- Running Stirling-PDF locally for personal use only
103+
- Using it in a completely trusted network environment
104+
- You don't need user management or access control
105+
106+
**Keep login enabled if:**
107+
- Running on a server accessible from the internet
108+
- Multiple users need access with different permissions
109+
- You need audit trails or usage tracking
110+
- Running in a shared or business environment
59111

60112
---
61113

@@ -377,7 +429,7 @@ customFiles/
377429
<TabItem value="settings" label="Settings File">
378430
```yaml
379431
security:
380-
enableLogin: false # set to 'true' to enable login
432+
enableLogin: true # Login enabled by default; set to 'false' to disable
381433
csrfDisabled: true
382434
jwt:
383435
persistence: true

docs/FAQ.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
sidebar_position: 8
33
title: FAQ
44
---
5+
import Tabs from '@theme/Tabs';
6+
import TabItem from '@theme/TabItem';
7+
58
# Frequently Asked Questions
69

710
### Q1: Why are .htm files being downloaded when I use the application?
@@ -44,3 +47,61 @@ No, we track no data without your explicit consent. You can see how, when, and w
4447

4548
Uploads go to the server or desktop instance you're using, not to Stirling servers. The macOS/Windows desktop apps process files locally—even when you pick the Stirling Cloud sign-in today—so your PDFs stay on your device unless you point the app to a remote self-hosted server. Planned SaaS-assisted features (for desktop app) will be opt-in when they arrive.
4649

50+
### Q10: What is the difference between Stirling-PDF.jar and Stirling-PDF-server.jar?
51+
52+
Stirling-PDF comes in two different JAR files depending on your deployment needs:
53+
54+
**Stirling-PDF.jar** (Full Package):
55+
- Bundles the frontend user interface inside the JAR along with the backend server
56+
- Complete standalone application
57+
- Access via web browser at `http://localhost:8080`
58+
- Best for most users and standard deployments
59+
60+
**Stirling-PDF-server.jar** (Backend Only):
61+
- Contains only the backend server
62+
- No bundled frontend UI
63+
- Designed for API access, desktop app integration, or external UI hosted elsewhere
64+
- Best for split deployments, microservices, or custom frontends
65+
66+
Both JAR files include the same backend functionality. The main difference is whether the frontend is bundled with the backend or needs to be hosted separately.
67+
68+
### Q11: How do I disable login/authentication?
69+
70+
Authentication is enabled by default in Stirling-PDF. To disable it:
71+
72+
<Tabs groupId="config-methods">
73+
<TabItem value="settings" label="Settings File">
74+
```yaml
75+
security:
76+
enableLogin: false
77+
```
78+
</TabItem>
79+
<TabItem value="docker-run" label="Docker Run">
80+
```bash
81+
docker run -d \
82+
-p 8080:8080 \
83+
-e SECURITY_ENABLELOGIN=false \
84+
stirlingtools/stirling-pdf:latest
85+
```
86+
</TabItem>
87+
<TabItem value="docker-compose" label="Docker Compose">
88+
```yaml
89+
environment:
90+
SECURITY_ENABLELOGIN: false
91+
```
92+
</TabItem>
93+
<TabItem value="jar-property" label="JAR (Java Property)">
94+
```bash
95+
java -jar Stirling-PDF.jar -DSECURITY_ENABLELOGIN=false
96+
```
97+
</TabItem>
98+
<TabItem value="jar-env" label="JAR (Environment Variable)">
99+
```bash
100+
export SECURITY_ENABLELOGIN=false
101+
java -jar Stirling-PDF.jar
102+
```
103+
</TabItem>
104+
</Tabs>
105+
106+
For more details, see the [System and Security Configuration](./Configuration/System%20and%20Security.md#disabling-login) documentation.
107+

docs/Installation/Mac.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,27 @@ brew install openjdk@21
101101
export PATH="/usr/local/opt/openjdk@21/bin:$PATH"
102102
```
103103

104+
### JAR Downloads
105+
106+
Stirling-PDF comes in two different JAR files:
107+
108+
**Stirling-PDF.jar** (Full Package - Recommended):
109+
- Download: [Stirling-PDF.jar](https://files.stirlingpdf.com/Stirling-PDF.jar)
110+
- Bundles frontend UI + backend server in one file
111+
- Complete standalone web application
112+
- Best for most server deployments
113+
114+
**Stirling-PDF-server.jar** (Backend Only):
115+
- Download: [Stirling-PDF-server.jar](https://files.stirlingpdf.com/Stirling-PDF-server.jar)
116+
- Backend server only (no bundled UI)
117+
- For API access, desktop app, or external UI
118+
- Best for split deployments or custom frontends
119+
120+
**Note:** Login/authentication is enabled by default. You can disable it by setting `SECURITY_ENABLELOGIN=false` as an environment variable. See [FAQ Q11](../FAQ.md#q11-how-do-i-disable-loginauthentication) for details.
121+
104122
### Running the Server
105123

106-
1. **Download the JAR file**: [Stirling-PDF.jar](https://files.stirlingpdf.com/Stirling-PDF.jar)
124+
1. **Download your preferred JAR file** (see above)
107125

108126
2. **Open Terminal** and navigate to the download folder:
109127
```bash

docs/Installation/Unix.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,23 @@ Install the following software:
134134

135135
### Step 4: Grab latest Stirling-PDF Jar
136136

137-
The JAR can be downloaded in two versions, [normal](https://files.stirlingpdf.com/Stirling-PDF.jar) and [security](https://files.stirlingpdf.com/Stirling-PDF-with-login.jar)
137+
Stirling-PDF comes in two different JAR files:
138138

139-
Example for the "normal" version
139+
**Stirling-PDF.jar** (Full Package - Recommended):
140+
- Bundles frontend UI + backend server in one file
141+
- Complete standalone web application
142+
- Best for most server deployments
143+
- Download: [Stirling-PDF.jar](https://files.stirlingpdf.com/Stirling-PDF.jar)
144+
145+
**Stirling-PDF-server.jar** (Backend Only):
146+
- Backend server only (no bundled UI)
147+
- For API access, desktop app, or external UI
148+
- Best for split deployments or custom frontends
149+
- Download: [Stirling-PDF-server.jar](https://files.stirlingpdf.com/Stirling-PDF-server.jar)
150+
151+
**Note:** Login/authentication is enabled by default. You can disable it by setting `SECURITY_ENABLELOGIN=false` as an environment variable. See [FAQ Q11](../FAQ.md#q11-how-do-i-disable-loginauthentication) for details.
152+
153+
Example download and setup:
140154

141155
```bash
142156
sudo wget https://files.stirlingpdf.com/Stirling-PDF.jar

docs/Installation/Windows.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,23 +56,33 @@ Want to host Stirling-PDF on a Windows server for multiple users? Use the server
5656

5757
### Server Downloads
5858

59-
**Without Login (Open Access):**
59+
Stirling-PDF comes in two different JAR files:
60+
61+
**Stirling-PDF.jar** (Full Package - Recommended):
6062
- Download: [Stirling-PDF.jar](https://files.stirlingpdf.com/Stirling-PDF.jar)
61-
- Anyone on your network can access it
62-
- No user accounts needed
63+
- Bundles frontend UI + backend server in one file
64+
- Complete standalone web application
65+
- Access via browser at `http://localhost:8080`
66+
- Best for most server deployments
6367

64-
**With Login (User Management):**
65-
- Download: [Stirling-PDF-with-login.jar](https://files.stirlingpdf.com/Stirling-PDF-with-login.jar)
66-
- Requires user accounts to access
67-
- Better for shared/business environments
68+
**Stirling-PDF-server.jar** (Backend Only):
69+
- Download: [Stirling-PDF-server.jar](https://files.stirlingpdf.com/Stirling-PDF-server.jar)
70+
- Backend server only (no bundled UI)
71+
- For API access, desktop app, or external UI
72+
- Best for split deployments or custom frontends
6873

6974
**Required:** [Java JDK 21](https://download.oracle.com/java/21/latest/jdk-21_windows-x64_bin.exe) - Server versions need Java installed
7075

76+
**Note:** Login/authentication is enabled by default in both versions. You can disable it by setting `SECURITY_ENABLELOGIN=false` as an environment variable. See [FAQ Q11](../FAQ.md#q11-how-do-i-disable-loginauthentication) for details.
77+
7178
### Server Installation Steps
7279

7380
1. **Install Java JDK 21** from the link above
74-
2. **Download** your preferred server version
75-
3. **Run the .exe file**
81+
2. **Download** your preferred JAR file
82+
3. **Run the JAR file:**
83+
```bash
84+
java -jar Stirling-PDF.jar
85+
```
7686
4. **Access** via browser at `http://localhost:8080`
7787
5. **Share the URL** with users on your network (e.g., `http://your-server-ip:8080`)
7888

0 commit comments

Comments
 (0)