Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

App passwords

App passwords are credentials you create for the Subsonic clients (phone app, desktop player, speakers…).

They can be:

  • used as the API key (apiKey), which is the recommended way
  • used as the password of a legacy login (p, or t+s tokens), if you tick Usable as a password when creating it and legacy_auth is enabled.

By default an app password is API-key only (so that the server can just keep a hash of it). Legacy Subsonic logins require the full secret to be stored (to check the t+s token).

Creating one

  • Web UI: on your account page, or in the admin panel’s Connections tab. The secret is shown once:, copy it.
  • Command line: see create-app-password.

Access levels

AccessAllows
Full accessEverything (whihin the user’s capabilities)
Read onlyBrowsing, searching and streaming. Anything that changes data is refused with Subsonic error 50

Notes

  • Secretes that are also useable as password need to be stored in full (encrypted with the server key BEETSTREAMNEXT_KEY).

  • Changing your account password does not revoke your app passwords.

  • Wrong app passwords count towards the rate limiter like any failed login.

  • Secrets are never shown again, never logged, and never part of the account data export (only the name, access, and dates are).

  • Upgrading from a BeetstreamNext version with a single API key per user: that key becomes an app password named Default API key with full access. It only works as an apiKey (not as a legacy password), since its secret was never stored in a recoverable form.

Important

Your account password is only for the Web UI.

If you are upgrading, every client that used your account password now needs an app password.