Skip to content

Commit 3b5d4c8

Browse files
committed
WIP
1 parent dd7b7a1 commit 3b5d4c8

File tree

15 files changed

+1929
-177
lines changed

15 files changed

+1929
-177
lines changed

.claude/settings.local.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@
22
"permissions": {
33
"allow": [
44
"Bash(npm run docusaurus:*)",
5-
"Bash(cat:*)"
5+
"Bash(cat:*)",
6+
"Bash(tree:*)"
67
],
78
"deny": [],
8-
"ask": []
9+
"ask": [],
10+
"additionalDirectories": [
11+
"/mnt/c/Users/systo/git/Stirling-PDFNew/"
12+
]
913
}
1014
}

docs/Advanced Configuration/How to add configurations.md

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,54 @@ Stirling PDF allows easy customization of the app.
1111
Includes things like
1212

1313
- Custom application name
14-
- Custom slogans, icons, HTML, images CSS etc (via file overrides)
14+
- Security settings
15+
- Feature toggles
16+
- System behavior
17+
- And much more
1518

16-
There are two options for this, either using the generated settings file ``settings.yml``
17-
This file is located in the ``/configs`` directory and follows standard YAML formatting
19+
## V2.0 - In-App Settings (Recommended)
1820

19-
Environment variables are also supported and would override the settings file
20-
For example in the settings.yml you have
21+
:::tip New in V2.0
22+
**Admin users can now configure all settings directly in the application!**
2123

22-
```
24+
If you have login enabled (`SECURITY_ENABLELOGIN=true`) and are logged in as an admin, navigate to the **Settings** menu in the application to configure everything through the UI. Changes apply immediately without restarting.
25+
26+
This is the easiest and recommended way to manage Stirling-PDF V2.0.
27+
:::
28+
29+
## Configuration Methods
30+
31+
There are three ways to configure Stirling-PDF (in order of precedence):
32+
33+
1. **In-App Settings** (V2.0+, requires admin login) - Configure via the Settings menu
34+
2. **Environment Variables** - Set via Docker, docker-compose, or system environment
35+
3. **settings.yml file** - Located in the `/configs` directory
36+
37+
**Precedence**: Environment variables override settings.yml. In-app settings update the settings.yml file.
38+
39+
### Using settings.yml
40+
41+
The settings file is located in the `/configs` directory and follows standard YAML formatting.
42+
43+
Example:
44+
```yaml
2345
security:
24-
enableLogin: 'true'
46+
enableLogin: true
47+
```
48+
49+
### Using Environment Variables
50+
51+
Environment variables override the settings file.
52+
53+
For example, to override the setting above:
54+
```bash
55+
SECURITY_ENABLELOGIN=true
2556
```
2657

27-
To have this via an environment variable you would have ``SECURITY_ENABLELOGIN``
58+
**Format rule**: Convert YAML paths to environment variables by:
59+
- Replacing `.` with `_`
60+
- Making everything UPPERCASE
61+
- Example: `security.enableLogin``SECURITY_ENABLELOGIN`
2862

2963
The Current list of settings is
3064

docs/Advanced Configuration/Pipeline.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ title: Pipeline Automation
77

88
# Pipeline Configuration and Usage Tutorial
99

10+
:::info V2.0 Update - New "Automate" Feature
11+
In V2.0, the pipeline frontend interface has been replaced with the new **"Automate"** feature, which offers an improved user experience for creating and managing automation workflows. The backend pipeline system (JSON configuration and folder scanning) continues to work the same way.
12+
13+
**What changed:**
14+
- ✅ Backend pipeline processing - **No changes**
15+
- ✅ JSON pipeline configurations - **Still work exactly the same**
16+
- ✅ Folder scanning with pipelines - **Still works the same**
17+
- 🆕 Frontend interface - **Now called "Automate" with better UX**
18+
19+
If you have existing pipeline JSON files, they continue to work in V2.0's Automate feature.
20+
:::
21+
22+
## About Pipeline Automation
23+
1024
- Configure the pipeline config file and input files to run files against it.
1125
- For reuse, download the config file and re-upload it when needed, or place it in `/pipeline/defaultWebUIConfigs/` to auto-load in the web UI for all users.
1226

docs/Advanced Configuration/UI Customisation.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,22 @@ These settings (in Settings.yml) control system behavior and customization capab
2222

2323
## V2.0 UI Customization Notes
2424

25-
**Important**: Stirling-PDF V2.0 uses a React-based frontend. The V1.5 `customFiles/` folder system for overriding templates **no longer works** in V2.0.
25+
### In-App Settings Management (V2.0+)
26+
27+
**New in V2.0**: If you have login enabled and are logged in as an admin, you can now configure all settings directly in the application through the **Settings** menu. No need to edit `settings.yml` manually!
28+
29+
**How to access:**
30+
1. Enable login: `SECURITY_ENABLELOGIN=true`
31+
2. Log in as an admin user
32+
3. Navigate to **Settings** in the application
33+
4. Configure all options through the UI
34+
5. Changes apply immediately
35+
36+
This is the recommended way to manage settings in V2.0 for production deployments.
37+
38+
### Template Customization Changes
39+
40+
**Important**: The V1 `customFiles/` folder system for overriding templates has been replaced with a new customization approach due to the UI framework change in V2.0.
2641

2742
For advanced UI customization in V2.0:
2843
1. Clone or download the repository
@@ -34,7 +49,7 @@ Example docker-compose with custom frontend:
3449
```yaml
3550
services:
3651
stirling-pdf:
37-
image: docker.stirlingpdf.com/stirlingtools/stirling-pdf:latest
52+
image: stirlingtools/stirling-pdf:latest
3853
ports:
3954
- '8080:8080'
4055
volumes:
@@ -43,11 +58,11 @@ services:
4358
- MODE=BOTH
4459
```
4560
46-
The following environment-based customizations are still supported without rebuilding:
47-
- Application name and branding
48-
- Update notification settings
49-
- Language settings
50-
- Theme preferences (via application settings)
61+
The following customizations work without rebuilding:
62+
- Application name and branding (via environment variables or in-app settings)
63+
- Update notification settings (via in-app settings if admin)
64+
- Language settings (via in-app settings)
65+
- Theme preferences (via in-app settings)
5166
5267
## Configuration Examples
5368

0 commit comments

Comments
 (0)