2 Command line and INI configuration🔗ℹ

The package entry point accepts one or more music directories:

The –config option reads defaults from an INI file. The file is normally named rkt-web-player.ini and is read from the current directory when the server is started with –config. Relative paths are interpreted in the process’s working directory.

Command-line values for –listen-ip, –port, –dlna-port, –playlist-keystore, –log-file and –no-browser override the corresponding defaults. Logging retention, log level, authentication and the playback-agent allowlist are configured in the INI file. Libraries configured under [libraries] use the INI key as their display name and the value as the root directory. The legacy [library] paths setting accepts a semicolon-separated list and is also supported. A complete example is:

The [server] section controls the browser server. The default listen-ip is 127.0.0.1, so the interface is local-only by default; 0.0.0.0 or a LAN address makes it reachable from other machines. port defaults to 8080.

The [player] section controls playback. dlna-port defaults to 8734 and must be reachable by network renderers when they play files published by the server. local-output=true (the default) adds the server’s own audio device as an output. playlist-keystore selects the keystore for playlist tabs and language preferences; omission uses data/playlists.keystore below the installed collection. When embedding the player through run-web-player, passing #f disables persistence.

The [logging] section controls the rotating log file. The default file is data/rkt-web-player.log, retention defaults to seven days, and the default level is debug. The level is passed to simple-log; use a level supported by that package.

The [playback-agents] section is a default-deny allowlist. Each key must be the complete 64-character hexadecimal application ID of an agent and a value other than false permits registration. An empty section rejects all agents. This ID is a shared bearer credential, not a replacement for HTTPS.

The [authentication] section enables browser login when [users] has at least one entry. Each user value is an Argon2id hash, not a plaintext password. session-seconds defaults to seven days and is a sliding idle timeout. trusted-proxies is a semicolon-separated list of IP addresses or CIDR ranges whose forwarded client address may be trusted; keep it limited to the actual reverse proxy. The application does not terminate TLS, so use HTTPS at the reverse proxy before exposing an authenticated instance beyond a trusted LAN.

Create a password hash with make-password-hash, or run set-user in the directory containing the INI file. The set-user procedure updates rkt-web-player.ini interactively.