Your first 10 minutes

A walk-through for a brand-new install: start the container, run the setup wizard, switch on a few providers, trigger the first search and check that it worked. Each step names the labels you will see on screen.

1. Start the container

Follow Installation and run docker compose up -d. When the container is up, open http://<HOST_IP>:5765/ in a browser (port 5765 is the default).

2. First visit: password and scheduler profile

The first page is Welcome to Sublarr. You can either set a password (Set Password & Continue, at least 8 characters) or choose Continue without password (open access). You can change this later under Settings → System.

A small dialog then asks for a scheduler profile: Light, Balanced or Aggressive. The recommended one is preselected, based on the CPU cores and RAM Sublarr detects. Accept it, or pick Later to be asked again after seven days.

3. Open the setup wizard

The guided wizard does not open by itself. Open Settings → General → App & Interface, scroll to Setup wizard and click Open wizard. (The wizard lives at /onboarding, so http://<HOST_IP>:5765/onboarding works too.)

The steps below are the ones you see in Sonarr / Radarr Mode. Every step has Back and Next; the last one has Finish Setup.

1. Setup Mode — choose Sonarr / Radarr Mode. (Standalone Mode is for pointing Sublarr at media folders directly, without Sonarr or Radarr.)
2. Library type — pick Anime, Movies or Mixed library. This only selects matching scoring defaults and stays adjustable under Settings → Subtitles → Scoring. You have to pick one to continue.
3. Sonarr / Radarr — enter Sonarr URL and Sonarr API Key, then click Test Sonarr connection. Radarr works the same way (Radarr URL (optional), Radarr API Key (optional), Test Radarr connection). The API key is in Sonarr or Radarr under Settings → General.
4. Path Mapping — leave it empty if Sublarr sees your media under the same paths as Sonarr and Radarr. Otherwise enter remote_prefix=local_prefix pairs, separated by ; — for example /data/media=/mnt/media. See Path Mapping.
5. Target language and Source language — subtitles are searched in the target language. The source language is only used when Sublarr has to translate. The defaults are German (target) and English (source). Per-series rules live in language profiles, see Language Profiles.
6. Providers — optional API keys for OpenSubtitles, Jimaku and SubDL. Skip them here if you do not have any yet; section 4 below covers providers in more detail.
7. Automation — Search for missing subtitles automatically is on by default, and How often to search defaults to 6 hours (1, 3, 6, 12 or 24 hours are available). Upgrade existing subtitles when better matches are found is on by default as well.
8. Ollama and Media Servers (Optional) — not needed for a first download. Click Next (or Skip for media servers).
9. Performance — the same Light / Balanced / Aggressive choice as in step 2. Pick the recommended one.
10. First Scan — click Start First Scan. Sublarr reads your library from Sonarr and Radarr and fills the Wanted list. Then click Finish Setup.

4. Enable a few providers

Open Settings → Providers (the page is called Providers & Credentials). The built-in providers are already listed; click one to open its editor, which has an Enabled switch and a Test button. Test only works while the provider is enabled. Credentials are saved when you leave the field.

• No account needed: AnimeTosho, Podnapisi and Gestdown have no credential fields. Make sure they are enabled and press Test.
• OpenSubtitles: enter the API Key (required — the REST key from your opensubtitles.com account, not opensubtitles.org). Username and Password are optional; Sublarr logs in with them when both are filled in. Then press Test.

The full list, with which providers need an account, is on Settings — Providers.

5. Trigger the first search

Sublarr searches on its own schedule (every 6 hours with the wizard default), but you do not have to wait. Open Wanted in the sidebar:

• Refresh (top right) re-scans your library and updates the list.
• Search all starts a batch search over the wanted items and shows its progress at the top of the page.
• The magnifier button on a single row (Search providers) searches just that item and shows a Search started… toast — a good first test with one episode or movie.

See the status legend for what the status badges mean.

6. Check that it worked

Open Activity and switch to the History tab. Every downloaded subtitle is listed with its provider, language, format and score. The Queue tab shows work that is still running. The subtitle file itself is written next to the video file, so your media server picks it up on its next library refresh.

Nothing found?

• A row that is still wanted after a search means no provider returned a candidate good enough. Items that keep finding nothing are searched less and less often; Reset search attempts in the Wanted toolbar releases them again — see Parked items.
• Go through Subtitles are never downloaded: provider enabled and healthy, language profile, path mapping.
• Failed Test buttons and the real error messages are in Logs (Logs in the sidebar).
• To change a wizard answer later, rerun the wizard (step 3) or edit single values under Settings → Connections and Settings → Providers.

From here: Migrating from Bazarr if you are switching, or the User Guide for everything else.