You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f4033d1
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/install/configuration.md
+25-22Lines changed: 25 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,8 +19,8 @@ and [example config](https://github.com/Unpackerr/unpackerr/blob/main/examples/u
19
19
- Setting a log file is strongly recommended. This makes it much easier to troubleshoot problems.
20
20
- To use a config file in Docker, mount `/config` to the container and Unpackerr will write a config file.
21
21
- 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]]` <fontcolor="gray">
23
-
ex. `[[radarr]]`</font>, `url` and `api_key`.
22
+
- When using a config file you must uncomment at minimum the `[header.key]` <fontcolor="gray">
23
+
ex. `[radarr.0]`</font>, `url` and `api_key`.
24
24
- Uncomment means remove the hash `#` at the beginning of the line.
25
25
- The config file format is [TOML](https://toml.io).
26
26
- 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.
35
35
36
36
### Two+ Instances
37
37
38
-
When adding a second (or third+) instance to the __config file__, you just
39
-
add another `[[header]]`<fontcolor="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 <fontcolor="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.
44
44
45
45
<details>
46
46
<summary>Config examples with multiple instances.</summary>
47
47
48
48
- Config File example with two Radarrs and two Folders.
49
49
50
-
```yaml
51
-
[[radarr]]
50
+
```toml
51
+
[radarr.0]
52
52
url = "http://radarr"
53
53
api_key = "32characters"
54
54
55
-
[[radarr]]
55
+
[radarr.uhd]
56
+
name = "4K"
56
57
url = "http://radarr4k"
57
58
api_key = "32morecharacters"
58
59
59
-
[[folder]]
60
+
[folder.0]
60
61
path = "/data/downloads/software/"
61
62
62
-
[[folder]]
63
+
[folder.games]
63
64
path = "/data/downloads/games/"
64
65
```
65
66
@@ -68,22 +69,24 @@ works for all Starr apps, folders, command hooks, and webhooks.
68
69
```shell
69
70
UN_RADARR_0_URL=http://radarr
70
71
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
73
74
UN_FOLDER_0_PATH=/data/downloads/software/
74
-
UN_FOLDER_1_PATH=/data/downloads/games/
75
+
UN_FOLDER_games_PATH=/data/downloads/games/
75
76
```
76
77
77
78
</details>
78
79
79
80
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.
81
82
82
83
### Whisparr
83
84
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).
87
90
88
91
{/* The Global content is generated from here: https://github.com/Unpackerr/unpackerr/tree/main/init/config*/}
89
92
<Global />
@@ -103,8 +106,8 @@ by setting the value to `filepath:/path/to/file.txt`. In other words, if you wan
103
106
your Radarr API key to be read from a separate file, instead of storing it directly
104
107
in the config file or environment variables you can do this:
0 commit comments