Skip to content

Commit 45712fa

Browse files
authored
saml docs (#96)
* test * cleansups * sso too
1 parent 372daf4 commit 45712fa

7 files changed

Lines changed: 1078 additions & 320 deletions

File tree

docs/Configuration/Configuration.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,32 @@ LANGS=en_GB # Available languages
7777
SYSTEM_DEFAULTLOCALE=en-GB # Default language
7878
```
7979

80+
**How language selection works:**
81+
82+
Stirling-PDF determines the interface language using this priority order:
83+
84+
1. **User's manual selection** (highest priority)
85+
- When a user clicks the language globe icon and selects a language
86+
- Choice is stored in browser's localStorage (persists across sessions)
87+
- Storage key: `i18nextLng`
88+
89+
2. **Browser's language preference**
90+
- Automatically detected from browser's `Accept-Language` header via the `navigator` API
91+
- Example: Firefox set to Swedish (sv-SE) will show Swedish UI
92+
93+
3. **System default locale** (lowest priority)
94+
- Set via `SYSTEM_DEFAULTLOCALE` or `system.defaultLocale`
95+
- Only applied if user has no localStorage preference (first-time visitors)
96+
97+
**Example:**
98+
- Config: `SYSTEM_DEFAULTLOCALE=en_GB`
99+
- Browser: Swedish (sv-SE)
100+
- Result: UI shows Swedish (browser preference overrides config)
101+
102+
To force a specific default language regardless of browser settings, users must manually select it via the language globe icon.
103+
104+
> 💡 **Tip**: Set `SYSTEM_DEFAULTLOCALE` to your organization's primary language. Users can always override it using the language selector in the top-right corner.
105+
80106
### Deployment Mode
81107

82108
```bash

docs/Configuration/External Database.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You can configure the new `Datasource` property in your `settings.yml` to connec
2626
```yaml
2727
datasource:
2828
enableCustomDatabase: false
29-
customDatabaseUrl: jdbc:postgresql://localhost:5432/postgres
29+
customDatabackendUrl: jdbc:postgresql://localhost:5432/postgres
3030
username: postgres
3131
password: postgres
3232
type: postgresql
@@ -36,7 +36,7 @@ You can configure the new `Datasource` property in your `settings.yml` to connec
3636
```
3737
3838
- `enableCustomDatabase`: Set this property to `true` to enable use of the custom database **Note: An enterprise license to use this feature**
39-
- `customDatabaseUrl`: Enter the database connection url for the database here. **Note: If you set the `customDatabaseUrl` you do not need to set the type, hostName, port and name, they will all be automatically derived from the url.**
39+
- `customDatabackendUrl`: Enter the database connection url for the database here. **Note: If you set the `customDatabackendUrl` you do not need to set the type, hostName, port and name, they will all be automatically derived from the url.**
4040
- `username`: The username for the database
4141
- `password`: The password for the database
4242

@@ -80,7 +80,7 @@ services:
8080
environment:
8181
DISABLE_ADDITIONAL_FEATURES: "false" "true"
8282
SYSTEM_DATASOURCE_ENABLECUSTOMDATABASE: "true"
83-
SYSTEM_DATASOURCE_CUSTOMDATABASEURL: "jdbc:postgresql://db:5432/stirling_pdf"
83+
SYSTEM_DATASOURCE_CUSTOMDATABACKENDURL: "jdbc:postgresql://db:5432/stirling_pdf"
8484
SYSTEM_DATASOURCE_USERNAME: "admin"
8585
SYSTEM_DATASOURCE_PASSWORD: "stirling"
8686
# further configuration
@@ -89,7 +89,7 @@ services:
8989
- `depends_on`: This specifies any services that your app will need in order to run. Ensure the name matches the container name for your database
9090
- `DISABLE_ADDITIONAL_FEATURES`: Set this to `false` to enable security features
9191
- `SYSTEM_DATASOURCE_ENABLECUSTOMDATABASE`: An environment variable to connect to the database container. Set this to `true` to enable use of the external database
92-
- `SYSTEM_DATASOURCE_CUSTOMDATABASEURL`: An environment variable to connect to the database container. Set the connection url for the database here. **Note: If you set this url you do not need to set the type, hostName, port and name (namely `SYSTEM_DATASOURCE_TYPE`, `SYSTEM_DATASOURCE_HOSTNAME`, `SYSTEM_DATASOURCE_PORT`, `SYSTEM_DATASOURCE_NAME`), they will all be automatically derived from the url.**
92+
- `SYSTEM_DATASOURCE_CUSTOMDATABACKENDURL`: An environment variable to connect to the database container. Set the connection url for the database here. **Note: If you set this url you do not need to set the type, hostName, port and name (namely `SYSTEM_DATASOURCE_TYPE`, `SYSTEM_DATASOURCE_HOSTNAME`, `SYSTEM_DATASOURCE_PORT`, `SYSTEM_DATASOURCE_NAME`), they will all be automatically derived from the url.**
9393
- `SYSTEM_DATASOURCE_USERNAME`: An environment variable to connect to the database container. Set the username for the database. Ensure this matches the corresponding property in your database container
9494
- `SYSTEM_DATASOURCE_PASSWORD`: An environment variable to connect to the database container. Set the password for the database. Ensure this matches the corresponding property in your database container
9595

@@ -103,7 +103,7 @@ services:
103103
environment:
104104
DISABLE_ADDITIONAL_FEATURES: "false" "true"
105105
SYSTEM_DATASOURCE_ENABLECUSTOMDATABASE: "true"
106-
SYSTEM_DATASOURCE_CUSTOMDATABASEURL: "jdbc:postgresql://db:5432/stirling_pdf"
106+
SYSTEM_DATASOURCE_CUSTOMDATABACKENDURL: "jdbc:postgresql://db:5432/stirling_pdf"
107107
SYSTEM_DATASOURCE_USERNAME: "admin"
108108
SYSTEM_DATASOURCE_PASSWORD: "stirling"
109109
# further configuration

0 commit comments

Comments
 (0)