Skip to content

docs: describe how Sportarr shows are matched and where their artwork comes from #164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Sportarr wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −0
Draft

docs: describe how Sportarr shows are matched and where their artwork comes from #164

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
545b755
docs: describe how Sportarr shows are matched and where their artwork…
Sportarr Aug 26, 2026
3981ced
docs(sportarr): correct the sportarr.net default and cover the refresh
Sportarr Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,17 @@ Sonarr's configuration is required to use its parameters in rules and to remove

Sportarr runs alongside Sonarr and Radarr, and all three can be configured at once. Sportarr's configuration is required to use its parameters in rules and manage sports leagues, seasons, and events. Maintainerr requires Sportarr 4.0.1022 or later.

Maintainerr matches a show to its league through the `sportarr` id the Sportarr media server agents
stamp on it, for example `lg-000278`. A library that has not been refreshed since those agents
started stamping it carries only the numeric alias they write into the tvdb namespace, and
Maintainerr resolves the league from that instead. Posters, backdrops and descriptions for those
shows come from the configured Sportarr connection. For a league none of your connections tracks,
Maintainerr can read that artwork from sportarr.net instead, which is off unless you set the
`SPORTARR_NET` environment variable to `on`. Nothing is requested from sportarr.net otherwise.

Artwork and descriptions are cached. `Refresh Metadata` in the Sportarr server dialog drops that
cache, so the next view fetches them again.

| Setting | Description |
| ----------- | ------------------------------------------- |
| Server Name | A friendly name to help identify the server |
Expand Down