Updated Configuring Tachidesk Server (markdown)

Aria Moradi
2021-10-23 22:12:02 +03:30
parent fc7def2925
commit 1a029a9772

@@ -1,6 +1,6 @@
Tachidesk-Server configuration file is named `server.conf` and is located inside (the data directory)[https://github.com/Suwayomi/Tachidesk-Server/wiki/The-Data-Directory].
*Note:* new keys might be added in the future, Tachidesk-Server doesn't update your conf file so it might be missing some keys.
**Note:** new keys might be added in the future, Tachidesk-Server doesn't update your conf file so it might be missing some keys.
The reference configuration file can be found (here)[https://github.com/Suwayomi/Tachidesk-Server/blob/master/server/src/main/resources/server-reference.conf] if you mess something up, you can delete `server.conf` to get a fresh one the next time Tachidesk-Server starts or use the reference file, also this document shows you the default values as they are.
@@ -49,7 +49,7 @@ server.basicAuthPassword = ""
- `server.basicAuthUsername` the username value that you have to provide when authenticating.
- `server.basicAuthPassword` the password value that you have to provide when authenticating.
*Note*: Basic access authentication sends username and password in cleartext and is not completely secure over HTTP, it's recommended to pair this feature with a reverse proxy server like nginx and expose the server over HTTPS. Also your browser caches the credentials, so you should be careful when accessing the server from non-private devices and use incognito mode.
**Note**: Basic access authentication sends username and password in cleartext and is not completely secure over HTTP, it's recommended to pair this feature with a reverse proxy server like nginx and expose the server over HTTPS. Also your browser caches the credentials, so you should be careful when accessing the server from non-private devices and use incognito mode.
### misc
```
@@ -58,3 +58,25 @@ server.systemTrayEnabled = true
```
- `server.debugLogsEnabled` controls whether if Tachidesk-Server should print more information while being run inside a Terminal/CMD/Powershell window.
- `server.systemTrayEnabled = true` whether if Tachidesk-Server should show a System Tray Icon, disabling this on headless servers is recommended.
## Overriding configuration options with command-line arguments
You can override the above configuration options with command-line arguments. Use the pattern bellow.
```
java -Dsuwayomi.tachidesk.config.<configuration option 1>=<configuration value 1> -Dsuwayomi.tachidesk.config.<configuration option 2>=<configuration value 2> ... -Dsuwayomi.tachidesk.config.<configuration option N>=<configuration value N> -jar <path to server jar>
```
for example to force launching Tachidesk-Server in electron you would have something like:
```
java -Dsuwayomi.tachidesk.config.server.webUIInterface=electron -Dsuwayomi.tachidesk.config.server.electronPath="/path/to/electron" -jar Tachidesk-Server-v0.X.Y-rXXXX.jar
```
**Note:** you can put the command above in a custom launcher script like the ones found [here](https://github.com/Suwayomi/Tachidesk-Server/tree/master/scripts/resources).
## Overriding Tachidesk-Server's Data Directory path
The only possible way to override the default Data Directory path is with command-line arguments(the chicken and egg problem!).
Add the special config option `server.rootDir="<path to data directory>"` to your command-line arguments.
For example:
```
java -Dsuwayomi.tachidesk.config.server.rootDir="/path/to/data/directory" -jar Tachidesk-Server-v0.X.Y-rXXXX.jar
```