Skip to content

Commit f4033d1

Browse files
Document named instance keys and Whisparr as [radarr.whisparr].
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 8452a10 commit f4033d1

1 file changed

Lines changed: 25 additions & 22 deletions

File tree

‎docs/install/configuration.md‎

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ and [example config](https://github.com/Unpackerr/unpackerr/blob/main/examples/u
1919
- Setting a log file is strongly recommended. This makes it much easier to troubleshoot problems.
2020
- To use a config file in Docker, mount `/config` to the container and Unpackerr will write a config file.
2121
- Update the new file at `/config/unpackerr.conf` and restart the container.
22-
- When using a config file you must uncomment at minimum the `[[header]]` <font color="gray">
23-
ex. `[[radarr]]`</font>, `url` and `api_key`.
22+
- When using a config file you must uncomment at minimum the `[header.key]` <font color="gray">
23+
ex. `[radarr.0]`</font>, `url` and `api_key`.
2424
- Uncomment means remove the hash `#` at the beginning of the line.
2525
- The config file format is [TOML](https://toml.io).
2626
- Indentation is not important like YAML files, but it's used for ease of readability.
@@ -35,31 +35,32 @@ Simply fill in a web form, and click a button to get a working config file.
3535

3636
### Two+ Instances
3737

38-
When adding a second (or third+) instance to the __config file__, you just
39-
add another `[[header]]` <font color="gray">ex. `[[sonarr]]`</font> and the
40-
`url`/`api_key`/etc under it. When adding a second instance to the __environment
41-
variables__, you must increment the `0` to a `1`. And to a `2` if you have 3
42-
instances. There is no limit to the number of supported instances. This notation
43-
works for all Starr apps, folders, command hooks, and webhooks.
38+
When adding a second (or third+) instance to the __config file__, use another
39+
named table <font color="gray">ex. `[sonarr.0]`, `[sonarr.uhd]`</font> and the
40+
`url`/`api_key`/etc under it. Environment variables use that same key:
41+
`UN_SONARR_0_URL` or `UN_SONARR_uhd_URL`. Array rows from older configs load as
42+
keys `0`, `1`, …. There is no limit to the number of supported instances. This
43+
notation works for all Starr apps, folders, command hooks, and webhooks.
4444

4545
<details>
4646
<summary>Config examples with multiple instances.</summary>
4747

4848
- Config File example with two Radarrs and two Folders.
4949

50-
```yaml
51-
[[radarr]]
50+
```toml
51+
[radarr.0]
5252
url = "http://radarr"
5353
api_key = "32characters"
5454

55-
[[radarr]]
55+
[radarr.uhd]
56+
name = "4K"
5657
url = "http://radarr4k"
5758
api_key = "32morecharacters"
5859

59-
[[folder]]
60+
[folder.0]
6061
path = "/data/downloads/software/"
6162

62-
[[folder]]
63+
[folder.games]
6364
path = "/data/downloads/games/"
6465
```
6566

@@ -68,22 +69,24 @@ works for all Starr apps, folders, command hooks, and webhooks.
6869
```shell
6970
UN_RADARR_0_URL=http://radarr
7071
UN_RADARR_0_API_KEY=32characters
71-
UN_RADARR_1_URL=http://radarr4k
72-
UN_RADARR_1_API_KEY=32morecharacters
72+
UN_RADARR_uhd_URL=http://radarr4k
73+
UN_RADARR_uhd_API_KEY=32morecharacters
7374
UN_FOLDER_0_PATH=/data/downloads/software/
74-
UN_FOLDER_1_PATH=/data/downloads/games/
75+
UN_FOLDER_games_PATH=/data/downloads/games/
7576
```
7677

7778
</details>
7879

7980
Anything that [has a header](https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example#L99)
80-
with double brackets `[[..]]` can be repeated as many times as you'd like.
81+
like `[sonarr.0]` or `[folder.software]` can be repeated with a unique key.
8182

8283
### Whisparr
8384

84-
Whisparr uses the Radarr API. Rename `[[whisparr]]` to `[[radarr]]` (and `UN_WHISPARR_*`
85-
to `UN_RADARR_*`). Set `name = "Whisparr"` if logs and hooks should keep that label.
86-
Existing `[[whisparr]]` blocks still load as Radarr for now.
85+
Whisparr uses the Radarr API. Configure it as `[radarr.whisparr]` (env `UN_RADARR_whisparr_*`). Set `name = "Whisparr"` if logs and hooks should keep that label. Existing `[[whisparr]]` blocks still load as Radarr; a UI Save rewrites them to `[radarr.0]`. Changed in v1.0.0 (September 2026).
86+
87+
### Named instances
88+
89+
Starr apps, folders, webhooks, and command hooks are identified by a short key, not by list position. In the config file use `[sonarr.uhd]`, `[folder.software]`, `[webhook.discord]`; in env use `UN_SONARR_uhd_URL`, `UN_FOLDER_software_PATH`, `UN_WEBHOOK_discord_URL`. The optional `name` on Starr and hooks is only a label (`name = "Starrs & Stripes"`). Existing `[[sonarr]]` / `[[folder]]` / `[[webhook]]` tables still load as keys `0`, `1`, …. Open that section in the web UI and click Save: Unpackerr rewrites the file to named tables automatically. Changed in v1.0.0 (September 2026).
8790

8891
{/* The Global content is generated from here: https://github.com/Unpackerr/unpackerr/tree/main/init/config */}
8992
<Global />
@@ -103,8 +106,8 @@ by setting the value to `filepath:/path/to/file.txt`. In other words, if you wan
103106
your Radarr API key to be read from a separate file, instead of storing it directly
104107
in the config file or environment variables you can do this:
105108

106-
```json
107-
[[radarr]]
109+
```toml
110+
[radarr.0]
108111
url = "https://some.url/radarr"
109112
api_key = "filepath:/etc/secrets/radarr.txt"
110113
```

0 commit comments

Comments
 (0)