Skip to content

Commit

Permalink
Documentation fixups (#34)
Browse files Browse the repository at this point in the history
* Fix env var different syntaxes

* Fix wrong documentation copy pasted
  • Loading branch information
bendem authored Dec 11, 2024
1 parent 1840ee0 commit b96e87d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions docs/Advanced Configuration/How to add configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,12 @@ export UI_APP_NAME="Stirling PDF"

#### Windows (CMD)
```
export UI_APP_NAME="Stirling PDF"
set UI_APP_NAME=Stirling PDF
```

#### Windows (PowerShell)
```
export UI_APP_NAME="Stirling PDF"
$env:UI_APP_NAME = "Stirling PDF"
```

### Docker
Expand All @@ -120,9 +120,9 @@ Simply add these to the end of your script/file

#### Docker run
```
-e UI_APP_NAME=Stirling PDF \
-e UI_HOME_DESCRIPTION=Your locally hosted one-stop-shop for all your PDF needs. \
-e UI_APP_NAVBAR_NAME=Stirling PDF \
-e "UI_APP_NAME=Stirling PDF" \
-e "UI_HOME_DESCRIPTION=Your locally hosted one-stop-shop for all your PDF needs." \
-e "UI_APP_NAVBAR_NAME=Stirling PDF" \
```
#### Docker Compose
```
Expand Down
8 changes: 4 additions & 4 deletions docs/Advanced Configuration/System and Security.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ sidebar_position: 1
Stirling PDF allows custommization of system and security settings
For security please note this section is only enabled if you are using the security jar, for docker that means setting ``DOCKER_ENABLE_SECURITY`` to ``true`` via a environment variable
- ``enableLogin`` This enables or disables the login functionality with
- ``csrfDisabled`` The description to be displayed on the homepage under the navbar that first greets the user
- ``csrfDisabled`` Set to 'true' to disable CSRF protection (not recommended for production)
and
- ``defaultLocale`` The app name to be shown within to navbar for all pages
- ``googlevisibility`` The app name to be shown within to navbar for all pages
- ``defaultLocale`` Set the default language (e.g. 'de-DE', 'fr-FR', etc)
- ``googlevisibility`` 'true' to allow Google visibility (via robots.txt), 'false' to disallow


## Settings file
Expand Down Expand Up @@ -51,4 +51,4 @@ environment:
UI_APP_NAME: Stirling PDF
UI_HOME_DESCRIPTION: Your locally hosted one-stop-shop for all your PDF needs.
UI_APP_NAVBAR_NAME: Stirling PDF
```
```

0 comments on commit b96e87d

Please sign in to comment.