Skip to content

Commit ec088e4

Browse files
committed
doc updates
1 parent 3f36000 commit ec088e4

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

docs/install/configuration.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,16 @@ 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)
1313
to paint the full picture of how to configure Unpackerr.
1414

15+
## Config Generator
16+
17+
[Notifiarr](https://notifiarr.com) hosts a configuration file maker.
18+
Simply fill in a web form, and click a button to get a working config file.
19+
20+
- **Access the generator here: https://notifiarr.com/unpackerr.php**
21+
1522
## Config File Notes
1623

24+
- Setting a log file is strongly recommend. This makes it much easier to troubleshoot problems.
1725
- To use a config file in Docker, mount `/config` to the container and Unpackerr will write a config file.
1826
- When using a config file you must uncomment at minimum the `[[header]]` (`[[radarr]]`), `url` and `api_key`.
1927
- Uncomment means remove the hash `#` at the beginning of the line.
@@ -30,6 +38,14 @@ url = "http://radarr4k"
3038
api_key = "32morecharacters"
3139
```
3240

41+
- Same example using env variables.
42+
43+
```
44+
UN_RADARR_0_URL=http://radarr
45+
UN_RADARR_0_API_KEY=32characters
46+
UN_RADARR_1_URL=http://radarr4k
47+
UN_RADARR_1_API_KEY=32morecharacters
48+
```
3349
## Global Settings
3450

3551
|Config Name|Variable Name|Default / Note|
@@ -50,9 +66,7 @@ api_key = "32morecharacters"
5066
|file_mode|`UN_FILE_MODE`|`0644` / Extracted files are written with this mode|
5167
|dir_mode|`UN_DIR_MODE`|`0755` / Extracted folders are written with this mode|
5268
|passwords|`UN_PASSWORD_0`|No default; empty list. Provide a list of RAR passwords to try.|
53-
|folder.interval|`UN_FOLDER_INTERVAL`|`1s` / How often poller (if enabled) checks for new folders.|
54-
55-
Setting a log file is strongly recommend. This makes is much easier to troubleshoot problems.
69+
|folders.interval|`UN_FOLDERS_INTERVAL`|`1s` / How often poller (if enabled) checks for new folders.|
5670

5771
:::info Passwords
5872
If a wrong password is provided, the entire archive must
@@ -134,6 +148,20 @@ It provides no UI. This may change in the future. The web server was added in v0
134148
|readarr.delete_delay|`UN_READARR_0_DELETE_DELAY`|`5m` / Extracts are deleted this long after import, `-1s` to disable|
135149
|readarr.syncthing|`UN_READARR_0_SYNCTHING`|`false` / Setting this to true makes unpackerr wait for syncthing to finish|
136150

151+
## Whisparr
152+
153+
|Config Name|Variable Name|Default / Note|
154+
|---|---|---|
155+
|whisparr.url|`UN_WHISPARR_0_URL`|No Default. Something like: `http://localhost:8787`|
156+
|whisparr.api_key|`UN_WHISPARR_0_API_KEY`|No Default. Provide URL and API key if you use Readarr|
157+
|whisparr.paths|`UN_WHISPARR_0_PATHS_0`|`/downloads` List of paths where content is downloaded for Readarr. Used as fallback if the path Readarr reports does not exist or is not accessible|
158+
|whisparr.protocols|`UN_WHISPARR_0_PROTOCOLS`|`torrent` Protocols to process. Alt: `torrent,usenet`|
159+
|whisparr.timeout|`UN_WHISPARR_0_TIMEOUT`|`10s` / How long to wait for the app to respond|
160+
|whisparr.delete_orig|`UN_WHISPARR_0_DELETE_ORIG`|`false` / Delete archives after import? Recommend not setting this to true|
161+
|whisparr.delete_delay|`UN_WHISPARR_0_DELETE_DELAY`|`5m` / Extracts are deleted this long after import, `-1s` to disable|
162+
|whisparr.syncthing|`UN_WHISPARR_0_SYNCTHING`|`false` / Setting this to true makes unpackerr wait for syncthing to finish|
163+
164+
137165
## Folder
138166

139167
Folders are a way to watch a folder for things to extract. You can use this to

0 commit comments

Comments
 (0)