Skip to content

Authentication

Mattia edited this page Mar 9, 2026 · 2 revisions

First Launch

On the very first launch, you will be presented with a Login screen containing three fields:

Field What to Enter
Server URL The full URL of your server, including the protocol. Example: https://music.example.com
Username Your Subsonic username
Password Your password

Use Tab / Shift+Tab (or Up / Down) to move between fields, and press Enter on the password field to connect.

Note: The URL must include the protocol (http:// or https://). SubTUI will show an error if it is missing.

Credentials File

Once you log in, your credentials are saved to ~/.config/subtui/credentials.toml. You can also edit this file directly instead of using the login screen.

[server]
url = "https://music.example.com"
username = "your_username"
password = "your_password"

[security]
redact_credentials_in_logs = true

Important: Your credentials are currently stored in plaintext on disk. The file is created with 0600 permissions (owner read/write only), but you should be aware of this limitation.

Security Settings

The redact_credentials_in_logs option is enabled by default and should be left set to true. It prevents your server URL, username, and password from appearing in SubTUI's debug log. This setting is primarily there for development and debugging purposes, if you need to inspect the raw API calls being made, you can temporarily set it to false, but remember to re-enable it afterwards.

Clone this wiki locally