Skip to content

FAQ

Jump to bottom
Skila edited this page Aug 21, 2026 · 8 revisions

FAQ

Do I have to use Discord?

No. The installer TUI asks. Choose No and create a local administrator in the browser. SD_DISCORD_ENABLED=false is the unattended default.

How does Discord admin work?

When Discord is on, SD_ADMIN_DISCORD_ID in .env is granted Administrator on every start. Empty means no one is auto-promoted that way. You can still create administrators under Admin → Users.

How do I find my Discord user, server, or role ID?

Discord User Settings → Advanced → Developer Mode. Right-click the user, server, or role → Copy ID.

New Discord users cannot register

An administrator may have enabled a server and/or role whitelist under Admin → Discord. You must be in that server and, if the role toggle is on, have that role. Existing accounts are not blocked.

Sign-in fails or loops

  • Redirect URL must match exactly: {SD_PUBLIC_URL}/api/v1/auth/discord/callback (no trailing slash on the public URL).
  • SD_PUBLIC_URL must be the URL you type in the browser (scheme, host, port).
  • Behind HTTPS or a reverse proxy, set SD_COOKIE_SECURE=true and SD_TRUSTED_PROXIES to the proxy CIDR.

Which image do I pull?

export SD_IMAGE=ghcr.io/skila1/sounddock:latest

The package must be public, or you must docker login ghcr.io.

How do I update?

sudo sounddock update

If you use extras, start them again with --profile discord and/or --profile cloudflare, then check docker compose ps.

Where is my data?

/opt/sounddock/data and the Postgres volume. uninstall without --purge keeps them.

Can I have more than one Discord administrator?

Set SD_ADMIN_DISCORD_ID to a comma-separated list of user IDs and restart (Discord must be on). If that list is non-empty, Discord users not on it are not auto-administrators.

Remote Import vs playlist URLs

Remote Import is for direct media file URLs. Spotify, YouTube, and similar playlist or page links go under Connected Services / playlist import. SoundDock does not download those providers' audio.

Does the Discord bot play YouTube or Spotify?

No. It searches and streams your library.

Can I build a bot or another app against SoundDock?

Yes. See Integration. Start at /api/docs on your instance.

Health

  • /healthz and /readyz on the server
  • sudo sounddock doctor checks Docker and http://127.0.0.1:8080/healthz

Uninstall

sudo sounddock uninstall          # keep data
sudo sounddock uninstall --purge  # delete /opt/sounddock and volumes

SoundDock

Clone this wiki locally