Configuration¶

Settings come from environment variables or .env. Lists are written as JSON.

Some can also be changed in the app, under Settings → Server, when .env (or the environment) has ALLOW_REMOTE_SETTINGS=true: Disable online metadata retrieval (the opposite of ARTWORK_ONLINE_LOOKUP), MUSICBRAINZ_CONTACT, FANARTTV_API_KEY, AI_PLAYLISTS_ENABLED, ANTHROPIC_API_KEY, AI_MODEL and the Lidarr settings. Changes apply at once, without a restart, and are saved in data/settings.json (readable by the server's user only). Which value wins: an environment variable (shown as locked in the app), then what was saved in the app, then .env, then the default. "Reset to .env or default" forgets a saved value. API keys are never sent to the app: it only shows whether one is set and its last four characters, and a new one is typed in once. It's off by default because the API has no login: with it on, anyone who can reach Nessie can change these, including putting in API keys. To expose another setting, add it to app/core/editable_settings.py; the app draws its controls from that list.

Command line¶

python -m app.cli scan PATH [--name NAME] [-v]   # create a library if needed, then scan it
python -m app.cli libraries                      # list libraries and their track counts
python -m app.cli give-plays USERNAME            # give the plays from before profiles to someone
python -m app.cli give-likes USERNAME            # and the liked songs from before profiles
python -m app.cli give-playlists USERNAME [NAME…] # give some of the household's playlists to someone
python -m app.cli give-mixes USERNAME [NAME…]     # and some of its custom mixes

-v lists files that couldn't be read. An interrupted scan keeps the batches it finished; run it again to continue.