@@ -12,21 +12,34 @@ You should use the data here along with the data in the
1212[ example config file] ( https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example )
1313to paint the full picture of how to configure Unpackerr.
1414
15- ## Config Generator
15+ ## Config
16+
17+ - Setting a log file is strongly recommend. This makes it much easier to troubleshoot problems.
18+ - To use a config file in Docker, mount ` /config ` to the container and Unpackerr will write a config file.
19+ - Update the new file and restart the container.
20+ - When using a config file you must uncomment at minimum the ` [[header]] ` <font color =" gray " >
21+ ex. ` [[radarr]] ` </font >, ` url ` and ` api_key ` .
22+ - Uncomment means remove the hash ` # ` at the beginning of the line.
23+
24+ ### Generator
1625
1726[ Notifiarr] ( https://notifiarr.com ) hosts a configuration file maker.
1827Simply fill in a web form, and click a button to get a working config file.
1928
2029- ** Access the generator here: https://notifiarr.com/unpackerr.php **
2130
22- ## Config File Notes
31+ ### Two+ Instances
2332
24- - Setting a log file is strongly recommend. This makes it much easier to troubleshoot problems.
25- - To use a config file in Docker, mount ` /config ` to the container and Unpackerr will write a config file.
26- - When using a config file you must uncomment at minimum the ` [[header]] ` (` [[radarr]] ` ), ` url ` and ` api_key ` .
27- - Uncomment means remove the hash ` # ` at the beginning of the line.
28- - If you need more than one Starr app, add another ` [[header]] ` for that app.
29- - Example with two Radarrs:
33+ When adding a second (or third+) instance to the __ config file__ , you just
34+ add another ` [[header]] ` <font color =" gray " >ex. ` [[sonarr]] ` </font > and the
35+ ` url ` /` api_key ` /etc under it. When adding a second instance to the __ environment
36+ variables__ , you must increment the ` 0 ` to a ` 1 ` . And to a ` 2 ` if you have 3
37+ instances. There is no limit to the number of supported instances. This notation
38+ works for all starr apps, folders, command hooks, and web hooks. Anything that [ has
39+ a header] ( https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example#L87 )
40+ with double brackets ` [[..]] ` can be repeated as many times as you'd like.
41+
42+ - Example with two Radarrs and two Folders:
3043
3144``` toml
3245[[radarr ]]
@@ -36,6 +49,12 @@ api_key = "32characters"
3649[[radarr ]]
3750url = " http://radarr4k"
3851api_key = " 32morecharacters"
52+
53+ [[folder ]]
54+ path = " /data/downloads/software/"
55+
56+ [[folder ]]
57+ path = " /data/downloads/games/"
3958```
4059
4160- Same example using env variables.
@@ -45,7 +64,10 @@ UN_RADARR_0_URL=http://radarr
4564UN_RADARR_0_API_KEY=32characters
4665UN_RADARR_1_URL=http://radarr4k
4766UN_RADARR_1_API_KEY=32morecharacters
67+ UN_FOLDER_0_PATH=/data/downloads/software/
68+ UN_FOLDER_1_PATH=/data/downloads/games/
4869```
70+
4971## Global Settings
5072
5173| Config Name| Variable Name| Default / Note|
@@ -94,6 +116,8 @@ UN_RADARR_0_API_KEY=filepath:/etc/secrets/radarr.txt
94116```
95117
96118Then store the API key (and only the API key) in ` /etc/secrets/radarr.txt ` .
119+
120+ _ <font color =" gray " >This feature was added in Unpackerr v0.14.0.</font >_
97121:::
98122
99123## Webserver
0 commit comments