shinkro config.toml

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
###[shinkro]
### Username and Password is required for basic authentication.
###Discord webhook, and BaseUrl are optional.
###LogLevel can be set to any one of the following: "INFO", "ERROR", "DEBUG", "TRACE"
###LogxMaxSize is in MB.
###[plex]
###PlexUser and AnimeLibraries must be set to the correct values. 
###AnimeLibraries is a list of your plex library names that contain anime - the ones shinkro will use to update your MAL account.
###Example: AnimeLibraries = ["Anime", "Anime Movies"]
###Url and Token are optional - only required if you have anime libraries that use the plex agents.

[shinkro]
Username = ""
Password = ""
Host = "127.0.0.1"
Port = 7011
ApiKey = "{secret}"
#BaseUrl = "/shinkro"
#DiscordWebhookUrl = ""
LogLevel = "INFO"
LogMaxSize = 50
LogMaxBackups = 3

[plex]
PlexUsername = ""
AnimeLibraries = []
#Url = "http://127.0.0.1:32400"
#Token = "<Value of X-Plex-Token>"

Config options exaplained

shinkro.Username: Username for shinkro's basic authentication.

shinkro.Password: Password for shinkro's basic authentication, set it to a strong one.

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

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

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

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

(optional)shinkro.DiscordWebhookUrl: Discord webhook url that you can set to enable discord notifications.

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

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

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

plex.PlexUsername: Your Plex username, required by shinkro to ensure that the webhook request is coming from your user.

plex.AnimeLibraries: A comma separated list of the names of your anime libraries. shinkro will only work for the libraries mentioned here.

(optional)plex.Url: The url to your plex server. You need to set this only if you are using Plex metadata agents for your libraries.

(optional)plex.Token: A token to access your plex server. See official plex article. You need to set this if you are using Plex metadata agents for your libraries.