From 8292a54fa573b49e423b78b5608af1ec22546b54 Mon Sep 17 00:00:00 2001 From: David Newhall II Date: Fri, 2 Aug 2024 13:43:55 -0700 Subject: [PATCH] missed files --- docs/install/includes/dockerconfigfile.md | 13 ++++++++++++ docs/install/includes/dockerdatamount.md | 25 +++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 docs/install/includes/dockerconfigfile.md create mode 100644 docs/install/includes/dockerdatamount.md diff --git a/docs/install/includes/dockerconfigfile.md b/docs/install/includes/dockerconfigfile.md new file mode 100644 index 0000000..d9492a5 --- /dev/null +++ b/docs/install/includes/dockerconfigfile.md @@ -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. diff --git a/docs/install/includes/dockerdatamount.md b/docs/install/includes/dockerdatamount.md new file mode 100644 index 0000000..3e3766f --- /dev/null +++ b/docs/install/includes/dockerdatamount.md @@ -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 +```