Skip to content

Configuring Tachidesk Server

Jump to bottom
Aria Moradi edited this page Oct 24, 2021 · 20 revisions

Tachidesk-Server configuration file is named server.conf and is located inside the data directory.

Note: new keys might be added in the future, Tachidesk-Server doesn't update your conf file automatically, so it might be missing some keys.

The reference configuration file can be found here if you mess something up, or 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 in the reference conf file.

The configuration file is written in HOCON. Google is your friend if you want to know more.

Configuration Options

Server ip and port bindings

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 = ""

This section directs Tachidesk-Server to connect to the network through a proxy server.

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, enabling this option 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 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

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.

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.

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
Clone this wiki locally