Settings and environment
The settings file
Section titled “The settings file”The settings are saved in config.json: data/config.json in the repository
when S.O.K runs from source, and the folders given in
Set up for the installed app. The file is
written each time a setting changes (ConfigManager.set()), and created with
the default values when it is missing. With SOK_CONFIG_DIR set, it is in that
folder, with its key, the rename history and the log (data_dir() and
log_dir() in sok.config.config_manager).
| Key | Default | In the settings | Effect |
|---|---|---|---|
language |
en |
Appearance | Language of the interface and of the folder names (Season, Saison…) |
theme |
system on macOS, dark elsewhere |
Appearance | light, dark, or system to follow the system |
use_system_accent |
false |
Appearance (macOS) | Uses the accent color of macOS instead of orange |
default_video_path, default_music_path, default_books_path, default_games_path |
empty | Default Folders | Destination folder filled in on the pages of that type |
movie_format |
{title} ({year}) |
Output Formats | Name of a movie. Also {quality} |
video_format |
{title} S{season}E{episode} {episode_title} |
Output Formats | Name of an episode. Also {season_num}, {episode_num} (not padded) |
music_format |
{artist} - {album}/{track} - {title} |
Output Formats | Folders and name of a track: one part per folder, the name last. Also {year} |
book_format |
{author} - {title} ({year}) |
Output Formats | Name of a book found online. Also {series}, {series_number} (from the file name) |
game_format |
{title} {tags} |
Output Formats | Name of a one-file game found online. Also {year}, {platform}; {tags} are those of the dump |
input_patterns |
{} |
Input Formats | Patterns of the file names, per kind: episode, movie, music, book, game (Reading the file names) |
create_folders |
true |
Behavior | Creates the missing folders; when off, a file whose folder is missing is an error |
backup_before_rename |
true |
Behavior | Keeps a replaced file as <name>.backup |
skip_duplicates |
true |
Behavior | Leaves a file in place when its new name already exists |
file_mode |
move |
Behavior | move, link (hard link, the source stays) or copy (File modes) |
subtitles_follow_video |
true |
Behavior | Moves the subtitles of a video with it (Subtitles) |
log_operations |
true |
Behavior | Writes each move to the log |
download_posters |
false |
Behavior | Saves the poster or cover of each item after a rename (Posters and covers) |
preferred_api_video, preferred_api_music, preferred_api_books, preferred_api_games |
tmdb, deezer, google_books, igdb |
Preferred API | Service searched for that type, when its key is available (Choosing the API) |
check_updates |
true |
About | Looks for a new release at startup (Updates) |
use_discord_rpc |
false |
About | Shows the activity of S.O.K in Discord |
api_key_*, spotify_*, igdb_*, google_books_api_key, client_id_discord |
empty | API Keys | The user’s own keys (see below) |
In the formats, a value that a file does not have is left out with the text
around it: without a year, {title} ({year}) gives Title. Folder and file
names then lose the characters that Windows does not accept:
< > : " / \ | ? *.
Read a setting with get_config_manager().get(key, default), and change it with
set(key, value), which saves the file.
Where an API key comes from
Section titled “Where an API key comes from”For each service, get() returns the first key it finds:
- The user’s key, typed in Settings › API Keys and saved in
config.json. - The key of the build, in the
Constantsclass (sok/core/constants.py) of a compiled app. See Building. - The environment: the variables of
.envat the repository root, or of the shell.
With SOK_ENV_KEYS_WIN set to 1, true, yes or on (the S.O.K Server
image sets it), a key of the environment comes first: the key given to the
container is the one used. The user’s key stays saved, and the build keys never
come before it. env_locked(key) says whether a key is taken from the
environment that way, for the settings to show it locked.
The API Keys section only shows the user’s keys (get_user_value()), never
those of the build or of .env. A key typed in its field is saved on Enter or
when the field loses the focus (ApiSection._save_key), without the spaces
around it; an emptied field removes the key. The media manager is then built
again, so the next search uses the new key.
Protection
Section titled “Protection”- In
config.json, the user’s keys are encrypted with Fernet and saved asENC:…. The encryption key is.local.key, next toconfig.json, created at the first start (hidden on Windows). Aconfig.jsoncopied to another computer without its.local.keyloses its keys: S.O.K logs the failure and leaves them empty. - In a build, the keys of
.envare encrypted intoConstantsbyscripts/build_sok.py, and decrypted when they are read (Constants.get()). This keeps them out of a plain reading of the executable; it does not make them secret from someone who takes the app apart.
Debugger check
Section titled “Debugger check”At startup, sok.core.security.check_security() quits S.O.K, on Windows only,
when a native debugger is attached (Visual Studio, WinDbg, x64dbg…). This also
applies when S.O.K runs from source. Python debuggers, such as the ones of VS
Code and PyCharm, are not native debuggers and are not detected.
Environment variables
Section titled “Environment variables”| Variable | Effect |
|---|---|
API_KEY_TMDB_V4, API_KEY_TVDB, API_KEY_OMDB |
Keys of the video services (TMDB: the v4 read token) |
API_KEY_LASTFM, SPOTIFY_CLIENT_ID, SPOTIFY_CLIENT_SECRET |
Keys of the music services |
GOOGLE_BOOKS_API_KEY |
Key of Google Books |
IGDB_CLIENT_ID, IGDB_CLIENT_SECRET, API_KEY_RAWG |
Keys of the game services |
API_KEY_FANART |
Key of Fanart.tv |
CLIENT_ID_DISCORD |
Application of the Discord activity |
SOK_LOG_LEVEL |
Level of the log: DEBUG, INFO (default), WARNING… |
SOK_ENV_KEYS_WIN |
1: the keys of the environment win over those of the settings (Where an API key comes from) |
SOK_CONFIG_DIR |
Folder of config.json, .local.key, history.json and logs/ (/config in the Docker image) |
.env.example lists the keys with the page where each one is created. Deezer,
MusicBrainz and Open Library need none.
The installed app also uses variables set by the system: APPIMAGE and APPDIR
(Linux, set by the AppImage), XDG_DATA_HOME and XDG_STATE_HOME (Linux
folders).