Skip to content

Commit

Permalink
missed files
Browse files Browse the repository at this point in the history
  • Loading branch information
davidnewhall committed Aug 2, 2024
1 parent 4afa4c8 commit 8292a54
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/install/includes/dockerconfigfile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
:::info Default Config File
When you start Unpackerr in Docker it checks for a `/config` directory. If one exists, and there is
no `unpackerr.conf` file within it, a brand new file is written with all default values. We still
recommend using the [generator](https://notifiarr.com/unpackerr) to build yourself a new file.
Replace the file or contents with those from the generator and restart the container.
:::

- Copy the [example config file](https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example)
from the repo, or [generate one](https://notifiarr.com/unpackerr).
- Then grab the image from DockerHub or GHCR.
- Run the image using a `volume` mount for the config file's directory.
- **The config file must be located at `/config/unpackerr.conf`.**
- Recommend bind-mounting `/config` volume as an app-data directory. Example Follows.
25 changes: 25 additions & 0 deletions docs/install/includes/dockerdatamount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
:::tip Data Mount
The `/data` or `/downloads` mount you use for Starr apps should be set the same for Unpackerr.
Using the same mount path keeps consistency and makes troubleshooting Unpackerr easier.
Most importantly, it allows Unpackerr to find your files.

This means that if you mount `/mnt/storage/downloads:/downloads` on your Starr apps you should
also mount `/mnt/storage/downloads:/downloads` on your Unpackerr container. If you mount
`/mnt/user/data:/data` on your Starr apps, mount the same path on Unpackerr.
**Make sure Unpackerr can find the downloads in the same place that Sonarr and Radarr find them.**
:::

This is the most important part. Look at your download client (like Qbit), Sonarr and Radarr in your
existing compose or docker run commands; look for `volumes:` or `docker run -v`.
One of these volumes is your download mount. It's usually `/data` or `/downloads` and looks like this:

```shell
docker run -v /mnt/storage/downloads:/downloads
```

or

```yaml
volumes:
- /mnt/storage/downloads:/downloads
```

0 comments on commit 8292a54

Please sign in to comment.