Skip to content

Configuration

Janis Hutz edited this page Sep 30, 2026 · 3 revisions

Config File

MusicPlayer is configured through a config.yml file in the same directory as the musicplayer executable. Download the config.yml file from the releases, or from the repo directly, it contains explanations for all the options.

Further, if you use the yaml language server, you can get completion that are provided by the schema linked in that file.

Environment Variables (backend only)

The following Environment Variables are used to configure OpenID Connect login (via .env file typically):

OIDC_ISSUER=<url>
OIDC_CLIENT_ID=<id>
OIDC_CLIENT_SECRET=<secret>

If you further want to use the store SDK, then also add

STORE_SERVICE_ID=<id>
STORE_SERVICE_SECRET=<secret>

to the .env file.

Frontend

The frontend by default (i.e. in all pre-built versions) expects the backend to be at api.<frontend hostname>. If you want to use a different layout, you can do that by bundling it yourself using the build.sh script found in the web directory in the repository.

The following environment variables are respected during build:

  • VITE_BACKEND_URL=<url to backend> (if unset (or ""), will default to api.<frontend hostname>)

Clone this wiki locally