Skip to content

Commit ad3cead

Browse files
committed
add password section
1 parent ec088e4 commit ad3cead

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ gem install --no-document mdl
6060
mdl docs
6161
```
6262

63-
Seriously, run mdl before commititng.
63+
Seriously, run mdl before committing.
6464

65-
## Codespell
65+
## Codespell Linter
6666

6767
```shell
6868
brew install codespell

docs/install/configuration.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ api_key = "32morecharacters"
4040

4141
- Same example using env variables.
4242

43-
```
43+
```shell
4444
UN_RADARR_0_URL=http://radarr
4545
UN_RADARR_0_API_KEY=32characters
4646
UN_RADARR_1_URL=http://radarr4k
@@ -68,12 +68,32 @@ UN_RADARR_1_API_KEY=32morecharacters
6868
|passwords|`UN_PASSWORD_0`|No default; empty list. Provide a list of RAR passwords to try.|
6969
|folders.interval|`UN_FOLDERS_INTERVAL`|`1s` / How often poller (if enabled) checks for new folders.|
7070

71-
:::info Passwords
71+
## Secrets and Passwords
72+
7273
If a wrong password is provided, the entire archive must
7374
be read before we know it's a bad password.
7475
Providing many passwords here can drastically slow down
7576
extractions and cause extra disk IO. You may also specify
76-
a password file by providing a "password" in this format: `filepath:/path/to/passwords.txt`
77+
a password file by providing a "password" in this format: `filepath:/path/to/passwords.txt`.
78+
The file must contain 1 password per line.
79+
80+
:::info Other Secrets
81+
You may store any string parameter (except time intervals) into a separate file
82+
by setting the value to `filepath:/path/to/file.txt`. In other words, if you want
83+
your Radarr API key to be read from a separate file, instead of storing it directly
84+
in the config file or environment variables you can do this:
85+
```toml
86+
[[radarr]]
87+
url = "https://some.url/radarr"
88+
api_key = "filepath:/etc/secrets/radarr.txt"
89+
```
90+
91+
or:
92+
```shell
93+
UN_RADARR_0_API_KEY=filepath:/etc/secrets/radarr.txt
94+
```
95+
96+
Then store the API key (and only the API key) in `/etc/secrets/radarr.txt`.
7797
:::
7898

7999
## Webserver
@@ -161,7 +181,6 @@ It provides no UI. This may change in the future. The web server was added in v0
161181
|whisparr.delete_delay|`UN_WHISPARR_0_DELETE_DELAY`|`5m` / Extracts are deleted this long after import, `-1s` to disable|
162182
|whisparr.syncthing|`UN_WHISPARR_0_SYNCTHING`|`false` / Setting this to true makes unpackerr wait for syncthing to finish|
163183

164-
165184
## Folder
166185

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

0 commit comments

Comments
 (0)