@@ -20,6 +20,8 @@ to paint the full picture of how to configure Unpackerr.
2020- When using a config file you must uncomment at minimum the ` [[header]] ` <font color =" gray " >
2121 ex. ` [[radarr]] ` </font >, ` url ` and ` api_key ` .
2222- Uncomment means remove the hash ` # ` at the beginning of the line.
23+ - The config file format is [ TOML] ( https://toml.io ) .
24+ - Indentation is not important like YAML files, but it's used for ease of readability.
2325
2426### Generator
2527
@@ -35,12 +37,12 @@ add another `[[header]]` <font color="gray">ex. `[[sonarr]]`</font> and the
3537` url ` /` api_key ` /etc under it. When adding a second instance to the __ environment
3638variables__ , you must increment the ` 0 ` to a ` 1 ` . And to a ` 2 ` if you have 3
3739instances. 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.
40+ works for all starr apps, folders, command hooks, and web hooks.
4141
4242<details >
43- <summary >Config File example with two Radarrs and two Folders.</summary >
43+ <summary >Config examples with multiple instances.</summary >
44+
45+ - Config File example with two Radarrs and two Folders.
4446
4547``` yaml
4648[[radarr]]
@@ -58,10 +60,7 @@ with double brackets `[[..]]` can be repeated as many times as you'd like.
5860 path = "/data/downloads/games/"
5961```
6062
61- </details >
62-
63- <details >
64- <summary >Environment Variable example with two Radarrs and two Folders.</summary >
63+ - Environment Variable example with two Radarrs and two Folders setting the same values as above.
6564
6665``` shell
6766UN_RADARR_0_URL=http://radarr
@@ -74,10 +73,13 @@ UN_FOLDER_1_PATH=/data/downloads/games/
7473
7574</details >
7675
76+ Anything that [ has a header] ( https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example#L87 )
77+ with double brackets ` [[..]] ` can be repeated as many times as you'd like.
78+
7779## Global Settings
7880
7981These values must exist at the top of the config file.
80- If you put them anywhere else they may be attached to a ` [[ header] ] ` inadvertently.
82+ If you put them anywhere else they may be attached to a ` [header] ` inadvertently.
8183When using environment variables, you can simply omit the ones you don't set or change from default.
8284
8385<details >
@@ -100,6 +102,9 @@ retry_delay = "5m"
100102parallel = 1
101103file_mode = " 0644"
102104dir_mode = " 0755"
105+
106+ [folders]
107+ interval = " 0s"
103108```
104109
105110- Using environment variables:
@@ -121,6 +126,7 @@ UN_MAX_RETRIES=3
121126UN_PARALLEL=1
122127UN_FILE_MODE=0644
123128UN_DIR_MODE=0755
129+ UN_FOLDERS_INTERVAL=0s
124130```
125131
126132</details >
@@ -143,7 +149,7 @@ UN_DIR_MODE=0755
143149| file_mode| ` UN_FILE_MODE ` | ` 0644 ` / Extracted files are written with this mode|
144150| dir_mode| ` UN_DIR_MODE ` | ` 0755 ` / Extracted folders are written with this mode|
145151| passwords| ` UN_PASSWORD_0 ` | No default; empty list. Provide a list of RAR passwords to try.|
146- | folders.interval| ` UN_FOLDERS_INTERVAL ` | ` 1s ` / How often poller (if enabled) checks for new folders.|
152+ | folders.interval| ` UN_FOLDERS_INTERVAL ` | ` 1s ` / How often poller checks for new folders. Use ` 1ms ` to disable it .|
147153
148154## Secrets and Passwords
149155
@@ -183,7 +189,6 @@ The web server currently only provides prometheus metrics, which you can display
183189It provides no UI. This may change in the future. The web server was added in v0.12.0.
184190:::
185191
186-
187192<details >
188193 <summary >Examples. Prefix: <b >UN_WEBSERVER</b >, Header: <b >[webserver]</b ></summary >
189194
@@ -216,7 +221,6 @@ UN_WEBSERVER_UPSTREAMS=127.0.0.1/32,10.1.2.0/24
216221
217222</details >
218223
219-
220224| Config Name| Variable Name| Default / Note|
221225| ---| ---| ---|
222226| webserver.metrics| ` UN_WEBSERVER_METRICS ` | ` false ` / Set this to true to enable the webserver, and metrics|
0 commit comments