You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Configuration/System and Security.md
+55-3Lines changed: 55 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,17 +10,18 @@ Stirling PDF allows customization of system and security settings. For security
10
10
11
11
## Basic Security Settings
12
12
13
-
-`enableLogin`: Enables or disables the login functionality
13
+
-`enableLogin`: Enables or disables the login functionality (default: `true`)
14
14
-`csrfDisabled`: Set to 'true' to disable CSRF protection (not recommended for production)
15
15
-`defaultLocale`: Set the default language (e.g. 'de-DE', 'fr-FR', etc)
16
16
-`googlevisibility`: 'true' to allow Google visibility (via robots.txt), 'false' to disallow
17
17
18
18
## Authentication Setup
19
19
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
+
20
22
### Prerequisites
21
23
1. Ensure the `/configs` directory is mounted as a volume in Docker for persistence across updates
22
24
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`
24
25
25
26
### Initial Login Credentials
26
27
- Default Username: `admin`
@@ -56,6 +57,57 @@ When using the API:
56
57
X-API-KEY: your-api-key-here
57
58
```
58
59
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:
Copy file name to clipboardExpand all lines: docs/FAQ.md
+61Lines changed: 61 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,9 @@
2
2
sidebar_position: 8
3
3
title: FAQ
4
4
---
5
+
import Tabs from '@theme/Tabs';
6
+
import TabItem from '@theme/TabItem';
7
+
5
8
# Frequently Asked Questions
6
9
7
10
### 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
44
47
45
48
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.
46
49
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:
**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
+
104
122
### Running the Server
105
123
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)
107
125
108
126
2.**Open Terminal** and navigate to the download folder:
Copy file name to clipboardExpand all lines: docs/Installation/Unix.md
+16-2Lines changed: 16 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -134,9 +134,23 @@ Install the following software:
134
134
135
135
### Step 4: Grab latest Stirling-PDF Jar
136
136
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)
**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.
**Required:**[Java JDK 21](https://download.oracle.com/java/21/latest/jdk-21_windows-x64_bin.exe) - Server versions need Java installed
70
75
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
+
71
78
### Server Installation Steps
72
79
73
80
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
+
```
76
86
4.**Access** via browser at `http://localhost:8080`
77
87
5.**Share the URL** with users on your network (e.g., `http://your-server-ip:8080`)
0 commit comments