wording updates on a few files, write compose instructions

Author: davidnewhall

docs/install/compose.md

@@ -9,19 +9,94 @@ description: Install Unpackerr with Docker Compose!
 - Copy the [example docker-compose.yml](https://github.com/Unpackerr/unpackerr/blob/main/examples/docker-compose.yml)
   from the repo.
 - Update the docker-compose.yml file with your environment variable values for your installation.
-- Recommend removing variables you are not using; the defaults are found on the Configuration page.
-- Then start it.
+- Remove variables you did not change; the defaults are found on the Configuration page.
+- Again, remove the variables you don't set or change. You can always add them back later.
+- **Do not quote variable values, this isn't bash.**
+- Then start it, like this:
 
 ```shell
 docker-compose up -d
 ```
 
-:::warning Data Mount
-The `/data` or `/downloads` mount you use for starr apps should be set the same for unpackerr.
+Here's an example minimal compose file. This works, and all the defaults should work for you too.
+Set `PUID`, `PGID` and `TZ` in your compose `.env` for this example to work correctly.
+
+```yaml
+services:
+  unpackerr:
+    image: golift/unpackerr
+    container_name: unpackerr
+    volumes:
+      - /mnt/storage/downloads:/downloads
+    restart: always
+    user: ${PUID}:${PGID}
+    environment:
+      - TZ=${TZ}
+      - UN_LOG_FILE=/downloads/unpackerr.log
+      - UN_SONARR_0_URL=http://sonarr:8989
+      - UN_SONARR_0_API_KEY=32coolcatcharacters
+      - UN_RADARR_0_URL=http://radarr:7878
+      - UN_RADARR_0_API_KEY=32coolkatcharacters
+```
+
+# Data Mount
+
+:::info 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/HostDownloads:/downloads` on your starr apps you should
-also mount `/mnt/HostDownloads:/downloads` on your unpackerr container. If you mount
-`/mnt/user/data:/data` on your starr apps, mount the same path on Unpackerr.
+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; look for `volumes:`. One of these volumes is your download mount. It's usually
+`/data` or `/downloads` and looks like this:
+
+```yaml
+    volumes:
+      - /mnt/storage/downloads:/downloads
+```
+
+Simply copy the downloads storage volume from your Starr apps or download client to Unpackerr.
+
+# Log File
+
+**Set a log file.** You'll need it to figure out what Unpackerr did. Put it in your download location.
+Example:
+
+```yaml
+    environment:
+      - UN_LOG_FILE=/downloads/unpackerr.log
+```
+
+Replace `/downloads/unpackerr.log` with `/data/unpackerr.log` if you mounted `/data` in `volumes:`.
+Or whatever download path you mounted; just put it there for ease of finding it.
+
+# More Notes
+:::warning Security Opts
+Do not include this in your compose. It will make Unpackerr not work properly. If you know how
+to adjust caps, go for it, but please don't ask for help without removing this first:
+
+```yaml
+    security_opt:
+       - no-new-privileges:true
+```
+:::
+
+# Config File
+
+_Very Optional:_
+
+You may also use a config file with or instead of environment variables. Name the file `unpackerr.conf`
+and mount the folder it's in to `/config`, so the file becomes available at `/config/unpackerr.conf`.
+Here's an example volume mount. You need one like this that ends with `/config`. Put the file in the
+folder on the left side.
+
+```yaml
+    volumes:
+      - /mnt/appdata/unpackerr:/config
+```

docs/install/docker.md

@@ -23,19 +23,20 @@ docker logs <container id from docker run>
 ```
 
 :::warning Data Mount
-The `/data` or `/downloads` mount you use for starr apps should be set the same for unpackerr.
+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/HostDownloads:/downloads` on your starr apps you should
-also mount `/mnt/HostDownloads:/downloads` on your unpackerr container. If you mount
-`/mnt/user/data:/data` on your starr apps, mount the same path on Unpackerr.
+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.**
 :::
 
 ## Docker Example with config file
 
 - Copy the [example config file](https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example)
-  from the repo.
+  from the repo, or [generate one](https://notifiarr.com/unpackerr.php).
 - Then grab the image from docker hub and run it using an overlay for the config file's directory.
 - The config file must be at `/config/unpackerr.conf`.
 - Recommend bind-mounting `/config` as an app-data directory. Example Follows.
@@ -48,9 +49,9 @@ docker logs <container id from docker run>
 
 ## More Dockers
 
- If you want a container that has a bit more to it, you can try a third party option.
- The container provided by golift is from scratch so it has nothing more than a binary
- and a config file (with our defaults).
+If you want a container that has a bit more to it, you can try a third party option.
+The container provided by golift is built `FROM scratch` so it has nothing more in the
+container than a binary and a config file (with our defaults).
 
 - **[@hotio](https://github.com/hotio) maintains a
     [Custom Docker Container](https://hub.docker.com/r/hotio/unpackerr)
@@ -69,8 +70,9 @@ docker run --user 1000:100 -d -v /mnt/data:/data -v /mnt/config:/config golift/u
 ### Hotio
 
 The primary difference between the golift and hotio containers is how you set the uid and gid.
-Hotdio does not user the `--user` parameter and instead sets the UID and GID with environment variables.
-Pass the `PUID` and `PGID` env variables when using hotio's container. Example:
+Hotio does not user the `--user` parameter and instead sets the UID and GID with environment
+variables. *Passing the `--user` parameter to the hotio container will render it inoperable.*
+Pass the `PUID` and `PGID` environment variables when using hotio's container. Example:
 
 ```bash
 # This commands runs hotio/unpackerr with UID 1000 and GID 100.

docs/install/seedbox.md

@@ -14,7 +14,8 @@ Learn how to install Unpackerr on your linux shell without root.
 
 1. Download and extract a binary from the [releases](https://github.com/Unpackerr/unpackerr/releases) page.
 1. Rename the file to `unpackerr` and make it executable: `chmod +x unpackerr`
-1. Download the [example config file](https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example).
+1. Download the [example config file](https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example),
+   or [generate one](https://notifiarr.com/unpackerr.php).
 1. Edit config file to suit your needs: `nano unpackerr.conf`
 1. Put both on your Linux shell server, in an `~/unapckerr/` folder.
 1. Run Unpackerr in the background, `screen` is the easiest way to do so.

docs/install/truenas-scale.md

@@ -34,7 +34,7 @@ You will need the following items before getting started:
 The goal is make the config file available @ `/config/unpackerr.conf` inside the container.
 Using this container path will allow Unpackerr to find your configuration automatically.
 You may also need to correct ownership of the file on the host so unpackerr can read it.
-Use `chown` to do that. Something like: `chown apps:apps /mnt/default/unpackerr/unpackerr.conf`
+Use `chown` to do that; something like: `chown apps:apps /mnt/default/unpackerr/unpackerr.conf`
 :::
 
 ## Installing the App

docs/install/unraid.md

@@ -23,8 +23,8 @@ the `1` to a `2` and so on. This works for all starr apps, folders, webhooks and
 hooks. There is no limit to how many you may configure.
 :::
 
-It's also recommend that you set a log file. It's easy to put it your downloads location,
-example follows.
+It's also recommend that you set a log file.
+It's recommended to put it in your downloads location, and an example follows.
 
 ![](/img/screenshots/unraid/bindvolume.png "bind volume")
 
@@ -44,6 +44,9 @@ not what you want. **Do this:**
 ![](/img/screenshots/unraid/starrmounts.png "starr mounts")
 
 If the highlighted portions above are not identical to the one below, then things are bound to work poorly.
+In other words, if Unpackerr has `/downloads <-> /mnt/user/downloads` and Sonarr has
+`/data <-> /mnt/user/downloads`, Unpackerr will not be able to find your files. In this hypothetical, you
+must edit the Unpackerr `/downloads` mount, and change the _Container Path_ to `/data` so it matches Sonarr.
 
 ![](/img/screenshots/unraid/unpackerrmount.png "unapackerr mount")
 :::