Documentation & Setup

Get started with Rainfall in your Discord server or self-host your own dedicated cluster.

Invite the Bot

Add Rainfall to your Discord server using the official OAuth2 authorization link. Make sure to grant the requested permissions so the bot can join voice channels and post the interactive message control panel.

Authorize Rainfall

Join a Voice Channel & Play

Connect to any voice channel in your Discord server, then run either a slash command or a prefix command:

/play query: Bohemian Rhapsody
# Or using the prefix:
!play Bohemian Rhapsody

The bot will connect to your voice channel and automatically deploy the signature 15-button control panel with track suggestions into your text channel.

Configure Server Preferences

Server administrators can configure custom prefixes, designate DJ roles, or lock commands to specific channels:

/prefix new_prefix: ? # Changes prefix to ?

/djrole role: @DJ # Assigns DJ role

/allowedchannels action: Add Current Channel # Restricts commands

/247 # Keeps bot in voice 24/7

Self-Hosting With Docker Compose

Rainfall is designed for effortless deployment with Docker Compose. The stack includes the Discord bot, the REST & WebSocket API, the Next.js dashboard, PostgreSQL, Redis, and a Lavalink v4 node:

git clone <repo>
cp .env.example .env
docker compose -f infrastructure/docker/docker-compose.yml up -d