Skip to content

Commit 681f315

Browse files
committed
doc updates, prettier
1 parent aeb407b commit 681f315

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/install/configuration.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ to paint the full picture of how to configure Unpackerr.
1616

1717
- Setting a log file is strongly recommend. This makes it much easier to troubleshoot problems.
1818
- 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.
19+
- Update the new file at `/config/unpackerr.conf` and restart the container.
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.
@@ -87,7 +87,7 @@ When using environment variables, you can simply omit the ones you don't set or
8787

8888
- Using the config file:
8989

90-
```shell
90+
```json
9191
debug = false
9292
quiet = false
9393
error_stderr = false
@@ -109,7 +109,7 @@ dir_mode = "0755"
109109

110110
- Using environment variables:
111111

112-
```shell
112+
```json
113113
TZ=America/New_York
114114
UN_DEBUG=false
115115
UN_QUIET=false
@@ -165,7 +165,7 @@ You may store any string parameter (except time intervals) into a separate file
165165
by setting the value to `filepath:/path/to/file.txt`. In other words, if you want
166166
your Radarr API key to be read from a separate file, instead of storing it directly
167167
in the config file or environment variables you can do this:
168-
```toml
168+
```json
169169
[[radarr]]
170170
url = "https://some.url/radarr"
171171
api_key = "filepath:/etc/secrets/radarr.txt"
@@ -194,7 +194,7 @@ It provides no UI. This may change in the future. The web server was added in v0
194194

195195
- Using the config file:
196196

197-
```shell
197+
```json
198198
[webserver]
199199
metrics = true
200200
listen_addr = "0.0.0.0:5656"
@@ -240,7 +240,7 @@ UN_WEBSERVER_UPSTREAMS=127.0.0.1/32,10.1.2.0/24
240240

241241
- Using the config file:
242242

243-
```shell
243+
```json
244244
[[sonarr]]
245245
url = "http://127.0.0.1:8989"
246246
api_key = "0123456789abcdef0123456789abcdef"
@@ -284,7 +284,7 @@ UN_SONARR_0_DELETE_DELAY=5m
284284

285285
- Using the config file:
286286

287-
```shell
287+
```json
288288
[[radarr]]
289289
url = "http://127.0.0.1:7878"
290290
api_key = "0123456789abcdef0123456789abcdef"
@@ -328,7 +328,7 @@ UN_RADARR_0_DELETE_DELAY=5m
328328

329329
- Using the config file:
330330

331-
```shell
331+
```json
332332
[[lidarr]]
333333
url = "http://127.0.0.1:8686"
334334
api_key = "0123456789abcdef0123456789abcdef"
@@ -372,7 +372,7 @@ UN_LIDARR_0_DELETE_DELAY=5m
372372

373373
- Using the config file:
374374

375-
```shell
375+
```json
376376
[[readarr]]
377377
url = "http://127.0.0.1:8787"
378378
api_key = "0123456789abcdef0123456789abcdef"
@@ -416,7 +416,7 @@ UN_READARR_0_DELETE_DELAY=5m
416416

417417
- Using the config file:
418418

419-
```shell
419+
```json
420420
[[whisparr]]
421421
url = "http://127.0.0.1:6969"
422422
api_key = "0123456789abcdef0123456789abcdef"
@@ -460,7 +460,7 @@ UN_WHISPARR_0_DELETE_DELAY=5m
460460

461461
- Using the config file:
462462

463-
```shell
463+
```json
464464
[[folder]]
465465
path = '''/some/folder/to/watch'''
466466
extract_path = ''
@@ -475,7 +475,7 @@ UN_WHISPARR_0_DELETE_DELAY=5m
475475

476476
- Using environment variables:
477477

478-
```shell
478+
```json
479479
UN_FOLDER_0_PATH=/some/folder/to/watch
480480
UN_FOLDER_0_EXTRACT_PATH=
481481
UN_FOLDER_0_DELETE_AFTER=10m
@@ -508,7 +508,7 @@ monitor your download client's "move to" path if you're not using it with an Sta
508508

509509
- Using the config file:
510510

511-
```shell
511+
```json
512512
[[cmdhook]]
513513
command = '/my/cool/script' # Path to command or script.
514514
shell = false # Runs the command inside /bin/sh ('nix) or cmd.exe (Windows).
@@ -521,7 +521,7 @@ monitor your download client's "move to" path if you're not using it with an Sta
521521

522522
- Using environment variables:
523523

524-
```shell
524+
```json
525525
UN_CMDHOOK_0_COMMAND=/usr/bin/env
526526
UN_CMDHOOK_0_NAME=
527527
UN_CMDHOOK_0_TIMEOUT=10s
@@ -599,7 +599,7 @@ UN_DATA_ERROR=
599599

600600
- Using the config file:
601601

602-
```shell
602+
```json
603603
[[webhook]]
604604
url = "https://notifiarr.com/api/v1/notification/unpackerr/api_key_from_notifiarr_com"
605605
name = "" # Set this to hide the URL in logs.
@@ -618,7 +618,7 @@ UN_DATA_ERROR=
618618

619619
- Using environment variables:
620620

621-
```shell
621+
```json
622622
UN_WEBHOOK_0_URL=https://a303739bc23bfcfa79b9cf36fd92833x.m.pipedream.net
623623
UN_WEBHOOK_0_NAME=
624624
UN_WEBHOOK_0_NICKNAME=Unpackerr

0 commit comments

Comments
 (0)