File tree Expand file tree Collapse file tree 2 files changed +38
-0
lines changed
Expand file tree Collapse file tree 2 files changed +38
-0
lines changed Original file line number Diff line number Diff line change 1+ :::info Default Config File
2+ When you start Unpackerr in Docker it checks for a ` /config ` directory. If one exists, and there is
3+ no ` unpackerr.conf ` file within it, a brand new file is written with all default values. We still
4+ recommend using the [ generator] ( https://notifiarr.com/unpackerr ) to build yourself a new file.
5+ Replace the file or contents with those from the generator and restart the container.
6+ :::
7+
8+ - Copy the [ example config file] ( https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example )
9+ from the repo, or [ generate one] ( https://notifiarr.com/unpackerr ) .
10+ - Then grab the image from DockerHub or GHCR.
11+ - Run the image using a ` volume ` mount for the config file's directory.
12+ - ** The config file must be located at ` /config/unpackerr.conf ` .**
13+ - Recommend bind-mounting ` /config ` volume as an app-data directory. Example Follows.
Original file line number Diff line number Diff line change 1+ :::tip Data Mount
2+ The ` /data ` or ` /downloads ` mount you use for Starr apps should be set the same for Unpackerr.
3+ Using the same mount path keeps consistency and makes troubleshooting Unpackerr easier.
4+ Most importantly, it allows Unpackerr to find your files.
5+
6+ This means that if you mount ` /mnt/storage/downloads:/downloads ` on your Starr apps you should
7+ also mount ` /mnt/storage/downloads:/downloads ` on your Unpackerr container. If you mount
8+ ` /mnt/user/data:/data ` on your Starr apps, mount the same path on Unpackerr.
9+ ** Make sure Unpackerr can find the downloads in the same place that Sonarr and Radarr find them.**
10+ :::
11+
12+ This is the most important part. Look at your download client (like Qbit), Sonarr and Radarr in your
13+ existing compose or docker run commands; look for ` volumes: ` or ` docker run -v ` .
14+ One of these volumes is your download mount. It's usually ` /data ` or ` /downloads ` and looks like this:
15+
16+ ``` shell
17+ docker run -v /mnt/storage/downloads:/downloads
18+ ```
19+
20+ or
21+
22+ ``` yaml
23+ volumes :
24+ - /mnt/storage/downloads:/downloads
25+ ` ` `
You can’t perform that action at this time.
0 commit comments