khord
Docker app from khord's Repository
Overview
Runtime arguments
- Web UI
http://[IP]:[PORT:3000]/- Network
bridge- Shell
sh- Privileged
- false
Template configuration
Port exposed by the container. Point your reverse proxy (NGINX Proxy Manager, Swag, etc.) at this port — do not expose it directly to the internet.
- Target
- 3000
- Default
- 3000
- Value
- 3000
Directory where the SQLite database and thumbnail cache are stored.
- Target
- /data
- Default
- /mnt/user/appdata/khord/data
- Value
- /mnt/user/appdata/khord/data
Publicly accessible URL for this instance, e.g. https://khord.yourdomain.com.
- Target
- PUBLIC_APP_URL
- Default
- https://khord.yourdomain.com
Comma-separated email addresses granted admin/owner privileges. The first account registered with a matching email receives the admin role automatically.
- Target
- OWNER_EMAILS
Spotify app client ID from developer.spotify.com. Optional — enables Spotify URL resolution and playlist import. Both Client ID and Client Secret are required together. After setting, enable Spotify in the admin panel Settings tab.
- Target
- PUBLIC_SPOTIFY_CLIENT_ID
Spotify app client secret from developer.spotify.com. Required alongside Spotify Client ID. Keep this private. Note: the account that owns the Spotify app must have an active Spotify Premium subscription.
- Target
- SPOTIFY_CLIENT_SECRET
YouTube Data API v3 key from console.cloud.google.com. Optional — enables YouTube Music URL resolution when sharing songs. Also enable YouTube Music in the admin panel Settings tab. Note: free quota is ~100 searches/day (100 units per call, 10,000/day limit).
- Target
- YOUTUBE_API_KEY
MusicKit JWT from developer.apple.com → Keys. Optional — enables Apple Music playlist import. Requires an Apple Developer account ($99/yr). Tokens are valid up to 6 months; regenerate before expiry. After setting, enable in the instance admin panel under Settings.
- Target
- PUBLIC_APPLE_MUSIC_DEV_TOKEN
Maximum number of registered users. 0 = unlimited. Can also be adjusted live from the /admin panel.
- Target
- MAX_USERS
- Default
- 0
- Value
- 0
Display name shown in the UI and page titles.
- Target
- PUBLIC_APP_NAME
- Default
- Khord
- Value
- Khord
One-line tagline shown on the home page.
- Target
- PUBLIC_APP_TAGLINE
- Default
- Share music, listen anywhere.
- Value
- Share music, listen anywhere.
Set to true to hide album art thumbnails on song cards. Can also be toggled live from the /admin panel.
- Target
- DISABLE_ALBUM_ART
- Default
- false
- Value
- false
UI color theme. Requires a container restart to apply. Options — neutral dark: dark, zinc, slate, gray, neutral, stone. Neutral light: light, zinc-light, slate-light, neutral-light, stone-light. Chromatic dark: navy, teal, emerald, rose, violet.
- Target
- PUBLIC_THEME
- Default
- dark
- Value
- dark
File name of the SQLite database stored in the Data Path directory. Only change this if you need to rename the database file.
- Target
- INDEXER_DB_NAME
- Default
- khord.db
- Value
- khord.db
Directory for the server-side album art disk cache. Lives inside the Data Path volume by default. Manage cache size from the admin panel (Admin → Cache tab).
- Target
- THUMBNAIL_CACHE_DIR
- Default
- /data/thumbnails
- Value
- /data/thumbnails
Categories
Details
ghcr.io/khordapp/khord:latestRun Khord on Unraid.
Khord is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.