Requirements
Collect these before you run the installer. Each item links to the step that uses it.
Server
Section titled “Server”- A Linux server, AMD64 or ARM64, that you reach over SSH.
- Bash, curl, and Docker Engine with the Compose plugin. Your user must be able to run
dockerwithoutsudo. - Disk space for your music, plus a little for the databases.
You don’t need Go or a source checkout: the bot runs from a ready-made Docker image.
Telegram
Section titled “Telegram”- A bot token from @BotFather.
api_idandapi_hashfrom my.telegram.org. The stack runs a local Telegram Bot API server so the bot can handle files up to 2000 MiB; it needs these credentials.- Your numeric Telegram user ID.
Set up Telegram explains how to get each of them. The installer walks you through the same steps.
If Telegram is blocked where the server runs, you also need a proxy that reaches it. See when Telegram is blocked.
Navidrome
Section titled “Navidrome”The deployment sample runs Navidrome 0.64.2 and Postgres 18.
To connect a Navidrome you already run, you also need:
- its administrator login and password;
- a version with multiple libraries; check yours against the one above before connecting an older release;
- a way to add a mount for a new music folder to it.
A domain, for listening outside your network
Section titled “A domain, for listening outside your network”To open Navidrome from your phone or send listening links, you need a domain or subdomain pointing at the server and ports 80 and 443 open. Uploads and sharing audio files in Telegram work without one. See HTTPS and public access.
Next step
Section titled “Next step”- Install on a new server if you don’t run Navidrome yet.
- Connect an existing Navidrome if you do.