config.toml Explained

config.toml explained

The primary configuration entry point for shinkro is config.toml, which should be located in the --config directory you specified to the shinkro process or in $HOME/.config/shinkro directory of the user from which shinkro is running. Do not manually create this config.toml file before running shinkro. Let shinkro create the config.toml on first run, and edit it afterwards.

Example config.toml

###Example config.toml for shinkro
###LogLevel can be set to any one of the following: "INFO", "ERROR", "DEBUG", "TRACE"
###LogxMaxSize is in MB.

Host = "127.0.0.1"

Port = 7011

#BaseUrl = "/shinkro"

SessionSecret = "{secret}"

EncryptionKey = "{secret}"

LogLevel = "INFO"

#LogPath = "/Users/varo/code/my_projects/shinkro/test/configtest/logs/shinkro.log"

#LogMaxSize = 50

#LogMaxBackups = 3

CheckForUpdates = true

Config options exaplained

Host: If you do not plan to use a reverse proxy, change this to 0.0.0.0

Port: Default port for shinkro is 7011. You can change this to another port if the default port is being used by another process.

SessionSecret: It is generated by shinkro on first run when it creates the example config. Do not change manually - shinkro relies on it for web authentication.

EncryptionKey: All your secrets like Plex Tokens and MAL API tokens are encrypted with this key. If it is lost or changed, you will have to re-authenticate with such external services.

(optional)BaseUrl: BaseUrl which you can set for subfolder reverse proxy support.

LogLevel: The log verbosity for shinkro. It can be set to INFO, ERROR, DEBUG, or TRACE.

LogMaxSize: The max size that the log file can get to before being rotated.

LogMaxBackups: The max number of backups of the log file that will be kept.

CheckForUpdates: Enables automatic update checks and notifies you if a newer version is available.