Configuration
Configuration settings for the server instance.
Configuration
The configuration file controls the server behavior, audio quality, sources, and cluster scaling.
Server Settings
Core settings for the server instance.
Prop
Type
Experimental Feature
useBunServer is currently experimental. Use with caution in production environments.
Cluster & Scaling
Settings related to worker clustering and auto-scaling behavior.
General Cluster Options
Prop
Type
Specialized Source Workers
Prop
Type
Hibernation
Prop
Type
Scaling Configuration
These settings control the cluster.scaling behavior.
Prop
Type
Workers Endpoint
Prop
Type
Connection Health
Monitors network health and connection quality for Discord voice.
Prop
Type
Limits
Prop
Type
Audio & Player
Configuration for audio quality, updates, and playback behavior.
Prop
Type
Filters
Toggle built-in audio filters that can be used via the player filters API.
Prop
Type
Voice Receive
Configuration for receiving Discord voice frames over a dedicated WebSocket.
Prop
Type
Audio Mixer
Configuration for the built-in audio mixer (mix layers).
Prop
Type
Sources
Configuration for specific music and media providers.
Primary Platforms
Prop
Type
YouTube
Prop
Type
Spotify
Prop
Type
Apple Music
Prop
Type
Tidal
Prop
Type
Other Sources
Prop
Type
VK Music
Prop
Type
Bilibili
Prop
Type
Pandora
Prop
Type
SoundCloud
Prop
Type
Local Files
Prop
Type
Deezer
Prop
Type
JioSaavn
Prop
Type
Google TTS
Prop
Type
Flowery TTS
Prop
Type
Lyrics
Configuration for lyrics providers.
Prop
Type
Supported Providers: YouTube, Genius, Musixmatch, LRCLib, Apple Music, Bilibili.
Security & Rate Limiting
DOS Protection
Prop
Type
Rate Limit (Global & Per Entity)
Prop
Type
Route Planner (IP Rotation)
Prop
Type
Logging & Metrics
Prop
Type
Plugins
Configuration for loading and managing plugins.
Prop
Type