temple/Suwayomi-Server
1
0
Fork 0
mirror of https://github.com/Suwayomi/Suwayomi-Server.git synced 2026-07-03 10:54:38 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated Configuring Tachidesk Server (markdown)

Aria Moradi
2021-10-23 21:20:27 +03:30
parent 8cdf9d3ee9
commit 3c73b813ba
1 changed files with 58 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
Configuring-Tachidesk-Server.md

@@ -1,7 +1,60 @@
# THIS PAGE IS UNDER CONSTRUCTION!
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].
<!--
# Configuration File
*Note:* new keys might be added in the future, Tachidesk-Server doesn't update your conf file so it might be missing some keys.
# JVM parameters
-->
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.
The configuration file is written in HOCON. Google is your friend if you want to know more.
## Configuration Options
### Server ip and port bindings
```conf
server.ip = "0.0.0.0"
server.port = 4567
```
- `server.ip` can be a IP or domain name.
### Socks5 proxy
```
server.socksProxyEnabled = false
server.socksProxyHost = ""
server.socksProxyPort = ""
```
An example configuration can be:
```
server.socksProxyEnabled = true
server.socksProxyHost = "yourproxyhost.com"
server.socksProxyPort = "8080"
```
### webUI
```
server.webUIEnabled = true
server.initialOpenInBrowserEnabled = true
server.webUIInterface = "browser" # "browser" or "electron"
server.electronPath = ""
```
- `server.webUIEnabled` controls if Tachidesk-Server will serve `Tachidesk-WebUI` and if it downloads/updates it on startup.
- `server.initialOpenInBrowserEnabled` controls if Tachidesk-Server will attempt to open a brwoser/electron window on startup, disabling this on headless servers is recommended.
- `server.webUIInterface` which web interface should Tachidesk-Server launch on startup, options are `"browser"` and `"electron"`
- `server.electronPath` path of the main electron executable, should be in double quotes
### Authentication
```
server.basicAuthEnabled = false
server.basicAuthUsername = ""
server.basicAuthPassword = ""
```
- `server.basicAuthEnabled` controls whether if Tachidesk-Server should be protected with [Basic access authentication](https://en.wikipedia.org/wiki/Basic_access_authentication), enabling this options is useful when hosting on a public network/the Internet.
- `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 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
```
server.debugLogsEnabled = false
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.