4.0 KiB
Configuration
VibeSonic is configured entirely through environment variables. There is
no separate config file — everything needed to run the server is
available via VIBESONIC_* variables, with sane defaults for everything
except the session secret.
| Variable | Default | Description |
|---|---|---|
VIBESONIC_LISTEN_ADDR |
:8080 |
HTTP listen address |
VIBESONIC_DATA_DIR |
/var/lib/vibesonic |
Directory for the database, resized cover-art cache, etc. |
VIBESONIC_DB |
<DATA_DIR>/vibesonic.db |
Path to the SQLite database file |
VIBESONIC_MUSIC_DIRS |
(none) | Colon-separated list of music folders to import on startup, e.g. /music:/music-lossless:/audiobooks. Additional folders can also be added later from the admin UI. |
VIBESONIC_FFMPEG_PATH |
ffmpeg (from PATH) |
Path to the ffmpeg binary |
VIBESONIC_FFPROBE_PATH |
ffprobe (from PATH) |
Path to the ffprobe binary |
VIBESONIC_MPV_PATH |
mpv (from PATH) |
Path to the mpv binary, used as the Subsonic jukebox's playback backend. If not found, the jukebox is administratively unavailable and jukeboxControl returns a clear error instead of a fake success. |
VIBESONIC_SCAN_INTERVAL |
1h |
How often to rescan enabled music folders, as a Go duration (30m, 6h, ...). A startup scan always runs regardless of this value. |
VIBESONIC_SESSION_SECRET |
(none) | Reserved for future use hardening session cookies beyond their database-backed random IDs. Not required to run, but recommended to set (e.g. openssl rand -hex 32) — VibeSonic logs a warning at startup if it's empty. |
VIBESONIC_COOKIE_SECURE |
false |
Whether session/CSRF cookies get the Secure attribute. Set to true when VibeSonic is served over HTTPS (including through a TLS-terminating reverse proxy); leave it off for direct plain-HTTP access. |
VIBESONIC_ENABLE_EXTERNAL_METADATA |
false |
Enable optional MusicBrainz/Cover Art Archive lookups for songs/albums that already carry a locally-tagged MusicBrainz ID. VibeSonic works fully offline with this off; it's the only feature that makes outbound Internet requests. |
VIBESONIC_ENABLE_ARTIST_PHOTOS |
false |
Enable auto-fetching an artist photo for every artist with no manually-set one: fanart.tv (only when both VIBESONIC_FANART_TV_API_KEY is set and the artist has a tagged MusicBrainz ID), falling back to a direct name search against Wikidata/Wikimedia Commons — this never calls the MusicBrainz API itself. Off by default for the same offline-first reason as VIBESONIC_ENABLE_EXTERNAL_METADATA. An admin can always set a photo manually from an artist's edit page regardless of this setting, and can trigger a one-off bulk fetch (with per-artist results, including any errors) from Admin → System Settings regardless of this toggle. |
VIBESONIC_FANART_TV_API_KEY |
(none) | Optional personal fanart.tv API key, tried first (for artists with a tagged MusicBrainz ID) when VIBESONIC_ENABLE_ARTIST_PHOTOS is on. Leave unset to go straight to the Wikidata name search. |
VIBESONIC_PODCASTS_ALLOW_PRIVATE_NETWORKS |
false |
Allow podcast feed/enclosure URLs to resolve to loopback/LAN/link-local addresses. Leave this off unless you intentionally host podcast feeds on a private network — see docs/security.md. |
External authentication
See docs/external-auth.md for the full
VIBESONIC_EXTAUTH_* reference.
First run
On a database with no users yet, every request redirects to /setup,
which walks you through creating the administrator account and your
first music folder, detects ffmpeg/ffprobe, and kicks off the first
scan. VibeSonic never ships default credentials — the administrator
account only exists once you create it through this wizard.
Migrations
Schema migrations are embedded in the binary (migrations/*.sql) and
applied automatically on startup, tracked in a schema_migrations table.
There is nothing to run manually.