Skip to content

Commit 1076467

Browse files
committed
Update readme
Signed-off-by: Matt Provost <[email protected]>
1 parent 5318cfd commit 1076467

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Looking to **upgrade from V1 to V2**? Look [here](#upgrading-from-v1-to-v2)
1212
- [Running in docker](#running-in-docker)
1313
- [Docker-compose with config file (recommended)](#docker-docker-compose-together-with-configyaml)
1414
- [Docker-compose only](#docker-specifying-all-settings-in-docker-compose)
15+
- [Config file](#config-file)
1516
- [Upgrading from V1 to V2](#upgrading-from-v1-to-v2)
1617
- [Explanation of the settings](#explanation-of-the-settings)
1718
- [General](#general-settings)
@@ -288,6 +289,29 @@ services:
288289
# - $DOCKERDIR/appdata/decluttarr/logs:/app/logs # Uncomment to get logs in text file, too
289290
# - $DATADIR/media:/media # If you use detect_deletions, add the identical mount paths that you use in your sonarr/radarr instances. This may be different to this example!
290291
```
292+
293+
### Config file
294+
295+
Decluttarr V2 introduces a new configuration file that allows specifying
296+
configurations in YAML instead of through environment variables. It has the
297+
benefit of supporting multiple instances of the arrs and download clients. You
298+
can view [config_example.yaml](./config/config_example.yaml) for an example.
299+
300+
The config file supports environment variables through the `!ENV` tag. For
301+
example, if you don't want to specify API keys statically, you can pass them in
302+
through environment variables and set your configuration to something like:
303+
304+
```yaml
305+
instances:
306+
sonarr:
307+
- base_url: "http://sonarr.media"
308+
api_key: !ENV SONARR_API_KEY
309+
310+
radarr:
311+
- base_url: "http://radarr.media"
312+
api_key: !ENV RADARR_API_KEY
313+
```
314+
291315
## Upgrading from V1 to V2
292316
293317
Decluttarr v2 is a major update with a cleaner config format and powerful new features. Here's what changed and how to upgrade.

0 commit comments

Comments
 (0)