First run

Open http://192.168.1.10:1077 (your host’s address). The navigation on the left has Library, Add songs, Wanted, Match, Activity, Settings, System, Tasks, Backup and Logs.

Signing in

Authentication is set in the server section of /config/config.yml:

Key	Values	Default
`auth`	`forms`, `none`, `external`	`forms`
`auth_required`	`enabled`, `disabledForLocalAddresses`	`disabledForLocalAddresses`

forms is a login page with a username and password stored by Wondarr.
none turns authentication off. Only use it on a network you trust.
external leaves authentication to a reverse proxy in front of Wondarr.
With auth_required: disabledForLocalAddresses, callers on your local network skip the login: the request comes from a loopback, link-local or private address (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16), carries no reverse-proxy header (X-Forwarded-For, Forwarded, X-Real-IP and the like), and is addressed to a local-looking name (an IP address, localhost, a name with no dot, or one ending in .local, .lan, .home.arpa or .internal). Behind a reverse proxy everyone logs in. To add other names, list them in server.allowed_hosts (Configuration). Set auth_required: enabled to require a login from every address.

Both can be set from the environment: APP__SERVER__AUTH and APP__SERVER__AUTH_REQUIRED.

The first time you open the login page and no login exists yet, it asks you to Create your login: a username (at most 64 characters) and a password of at least 8 characters, typed twice. That form only appears to a local caller (the same rule as above, and never behind a reverse proxy); from anywhere else the page tells you to create the login from a device on the same network as Wondarr. If you open Wondarr from your own network by an internal domain name such as wondarr.ad.example.com, which is not one of the local-looking names above, the page names it and shows no form: open Wondarr by its IP address, or add the name to server.allowed_hosts in config.yml and reload. Once a login exists the page is the normal sign-in form. Failed sign-ins are limited to 10 a minute per address; past that the login page says to wait a minute. Changing the username or password signs every other browser out.

You can also set or change the login any time under Settings → General → Security → Login: a Username and a Password, typed twice. Do one or the other from your local network before you reach Wondarr from anywhere else.

The same card shows the API key that tools such as Prowlarr, autobrr, Homepage and Unpackerr need: Show reveals it and the copy button copies it. (The login can also be set through the API: PUT /api/v1/auth/user with {"username": …, "password": …} and the API key.)

Optional keys: AcoustID and Last.fm

Under Settings → General → Metadata services you can add two optional keys. Each field shows “Stored — type to replace” once a key is saved (the key itself is never shown again), has a Test button that makes one call to the service with the key you typed, and a link to where the key is made.

AcoustID client key (acoustid.org/new-application): fingerprint verification of downloads, and identifying the files of a reference library. Without it, downloads are verified by probe and length only.
Last.fm API key (last.fm/api/account/create): what Last.fm knows about a song on its page, and the default key for Last.fm import lists.

The keys are saved to acoustid.client_key and lastfm.api_key in /config/config.yml and take effect at once. A key set by APP__ACOUSTID__CLIENT_KEY or APP__LASTFM__API_KEY shows as read-only. See Configuration.

Your first library

A library called Music exists from the start: root path /data/music, layout Plexamp. Change it under Settings → Library. The fields are:

Name and Root path: the folder inside the container where songs are filed.
Layout: Flat, Artist, Artist → Album or Plexamp.
Naming template: the path each song is filed under. The page shows a preview, a Tokens helper, and a button that resets it to the layout’s preset. The Plexamp preset is {Album Artist Name}/{Album Title}[ ({Release Year})]/{medium:0}{track:00} - {Track Title}.
Album policy: how a stand-alone song gets an album. The default, Fewest albums, uses the fewest real albums per artist and puts the rest in a Singles album. The others are Singles only, Original album and Single release. Minimum tracks per real album (default 2) applies to Fewest albums.
Plex music section and Library folder as Plex sees it: see Plex.

The Plexamp preset keeps an album folder level on purpose. Plex groups music by folder and tags, and the preset makes the album tags deliberate so Plex does not split or rename albums.

Add library… creates another library. Convert existing files… and Compact library… are for files already in a library.

Quality profiles

Two profiles are seeded, under Settings → Quality profiles:

Standard 320: the cutoff is MP3-320. AAC-256 counts as meeting it. FLAC is allowed, upgrades are on.
Lossless: the cutoff is FLAC. High-lossy files (MP3-320, MP3-VBR-V0, AAC-320) are accepted as a stop-gap, and Wondarr keeps looking for lossless.

A song is wanted until a file meets the profile’s cutoff. Below the cutoff, Wondarr keeps searching for an upgrade.

Adding the first songs

Go to Add songs. It has three tabs.

Search: type Artist - Title, a MusicBrainz or Deezer link, or an ISRC. Choose the right recording from the candidates and press Add. A monitored song is searched for straight away (search.search_on_add, on by default).
Album: search for an album (Artist - Album), pick a release and add songs from its tracklist.
Paste a list: one Artist - Title per line, up to 1000 lines. Pick the Quality profile and press Add all.

Watch progress under Activity → Queue, and finished and failed grabs under History. Songs still waiting for a file are under Wanted.

Before Wondarr finds anything on Soulseek you need a Soulseek account: see Soulseek.