doc updates

Author: davidnewhall

docs/install/archlinux.md

@@ -1,6 +1,6 @@
 ---
 id: archlinux
-title: Arch Linux Install
+title: Arch Linux
 pagination_prev: install/choosemethod
 pagination_next: install/configuration
 description: Install Unpackerr on an Arch Linux server.
@@ -9,6 +9,8 @@ description: Install Unpackerr on an Arch Linux server.
 import ArchiveAccess from './includes/archiveaccess.md';
 import Permissions from './includes/linuxpermissions.md';
 
+# Arch Linux Install
+
 :::info Root Access
 This installation method requires root. If you don't have root on your shell,
 then check out the <a href="/docs/install/seedbox">non-root directions</a>.
@@ -20,6 +22,8 @@ for each release. Download the `zst` package for your architecture from the
 and install it with `pacman -U <file or url>`. Alternatively, you can build
 it yourself using the [public AUR](https://aur.archlinux.org/packages/unpackerr).
 
+## Automatically
+
 If you don't want to bother figuring out which file you need, use the
 [install.sh](https://github.com/Unpackerr/unpackerr/blob/main/init/install.sh) script.
 It downloads and trusts the [GoLift GPG public key](https://golift.io/gpg) and then

docs/install/compose.md

@@ -6,7 +6,10 @@ pagination_next: install/configuration
 description: Install Unpackerr with Docker Compose!
 ---
 
-# Install
+import ConfigFile from './includes/dockerconfigfile.md';
+import DataMount from './includes/dockerdatamount.md';
+
+# Compose Install
 
 - Copy the [example docker-compose.yml](https://github.com/Unpackerr/unpackerr/blob/main/examples/docker-compose.yml)
   from the repo or [generate one](https://notifiarr.com/unpackerr).
@@ -55,25 +58,7 @@ And if you're trying to watch a folder, add this `environment:` variable with _y
 
 ## Data Mount
 
-:::info Important
-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; 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
-```
+<DataMount />
 
 Simply copy the downloads storage volume from your Starr apps or download client to Unpackerr.
 
@@ -92,7 +77,7 @@ Or whatever download path you mounted; just put it there for ease of finding it.
 
 ## More Notes
 
-:::warning Security Opts
+:::danger 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:
 
@@ -104,14 +89,15 @@ to adjust caps, go for it, but please don't ask for help without removing this f
 
 ## Config File
 
-_Very Optional:_
+You may also use a config file with or instead of environment variables.
+**This section is optional and generally not recommended for compose users.**
 
-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.
+<ConfigFile />
 
 ```yaml
     volumes:
       - /mnt/appdata/unpackerr:/config
 ```
+You should have a volume like the one above. It must end with `:/config`.
+Put the `unpackerr.conf` file in the folder on the left side,
+or edit the file unpackerr writes after you start it.

docs/install/docker.md

@@ -6,13 +6,45 @@ pagination_next: install/configuration
 description: Install Unpackerr using Docker!
 ---
 
+import ConfigFile from './includes/dockerconfigfile.md';
+import DataMount from './includes/dockerdatamount.md';
+
 # Docker Installation
 
+If you're using Docker Compose, this page may still contain valuable information for you. Please read it.
+
+## Availability
+
+Images are available on DockerHub and GHCR.
+
+### DockerHub
+
+GoLift software has a [Docker Open Source Sponsorship](https://docs.docker.com/trusted-content/dsos-program/).
+That means there are **no pull limits for any [`golift/*` image on Docker Hub](https://hub.docker.com/u/golift).**
+Even if you're not logged in.
+
 This project builds automatically in [Docker Cloud](https://hub.docker.com/r/golift/unpackerr) and creates
 [ready-to-use multi-architecture images](https://hub.docker.com/r/golift/unpackerr/tags) images.
 The `latest` tag is always a [tagged release on GitHub](https://github.com/Unpackerr/unpackerr/releases).
 
-## Docker Example
+- Pull the DockerHub image with this command:
+  ```shell
+  docker pull golift/unpackerr:latest
+  ```
+
+### GHCR
+
+GitHub Actions also builds a Docker image and stores it in the
+[GitHub container registry](https://github.com/Unpackerr/unpackerr/pkgs/container/unpackerr).
+This image is effectively identical to the DockerHub version; use whichever you prefer.
+The `latest` tag is always a [tagged release on GitHub](https://github.com/Unpackerr/unpackerr/releases).
+
+- Pull the GHCR image with this command:
+  ```
+  docker pull ghcr.io/unpackerr/unpackerr:latest
+  ```
+
+## Example
 
 ```shell
 docker pull golift/unpackerr
@@ -22,31 +54,20 @@ docker run -d -v /mnt/HostDownloads:/downloads \
 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.
-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.**
-:::
+## Config File Example
 
-## Example with config file
-
-- 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 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.
+<ConfigFile />
 
 ```shell
 docker pull golift/unpackerr
 docker run -d -v /mnt/HostDownloads:/downloads -v /folder/with/config/file:/config golift/unpackerr
 docker logs <container id from docker run>
 ```
 
+## Data Mount
+
+<DataMount />
+
 ## More Dockers
 
 If you want a container that has a bit more to it, you can try a third party option.
@@ -90,10 +111,10 @@ docker run -e PUID=1000 -e PGID=100 -d -v /mnt/data:/data -v /mnt/config:/config
 Watching folders in Docker will cause Unpackerr to constantly poll the
 watched-folder for changes at a default rate of `1s` (1 second).
 
-The Folder Watch feature uses `inotify` (a.k.a. `fsnotify`) to identify
-changes to the watched folder. A folder-poller is automatically started when
-run in Docker because `inotify` is unreliable. Disable the folder poller
-(and rely on `inotify` only) by setting `folders.interval` to `1ms`.
+The Folder Watch feature uses `inotify` (a.k.a. `fsnotify`) to identify changes to the
+watched folder. A folder-poller is automatically started when run in Docker because
+`inotify` is unreliable. Disable the folder poller (and rely on `inotify` only) by
+setting `folders.interval` (`UN_FOLDERS_INTERVAL`) to `1ms`.
 
 If Unpackerr has trouble determining when downloads are finished, set
 `start_delay` high enough to avoid beginning extracting files that are

docs/install/linux.md

@@ -1,6 +1,6 @@
 ---
 id: linux
-title: Linux Repository
+title: Repository
 pagination_prev: install/choosemethod
 pagination_next: install/configuration
 description: Install Unpackerr on a Linux server.
@@ -9,16 +9,19 @@ description: Install Unpackerr on a Linux server.
 import ArchiveAccess from './includes/archiveaccess.md';
 import Permissions from './includes/linuxpermissions.md';
 
+# Linux Repository Install
+
+**Linux binaries are distributed through `YUM` and `APT` repositories.**
+Using a repository allows easier upgrades and access to additional software.
+Use the command (script) below to automatically install the GoLift repo and
+unpackerr in one command. If your system does not use `yum` (`rpm`) or `apt`
+(`dpkg`) then these directions are not for you.
+
 :::info Root Access
 This installation method requires root. If you don't have root on your shell,
 then check out the <a href="/docs/install/seedbox">non-root directions</a>.
 :::
 
-Linux binaries are distributed through `yum` and `apt` repositories.
-Using a repository allows easier upgrades and access to additional software.
-Use the command (script) below to automatically install the GoLift repo and
-unpackerr in one command.
-
 ```shell
 curl -s https://golift.io/repo.sh | sudo bash -s - unpackerr
 ```

docs/install/seedbox.md

@@ -1,14 +1,16 @@
 ---
 id: seedbox
-title: Seedbox Install
+title: Seedbox
 pagination_prev: install/linux
 pagination_next: install/configuration
 description: Install Unpackerr on a Linux server without root.
 ---
 
 import ArchiveAccess from './includes/archiveaccess.md';
 
-Learn how to install Unpackerr on your linux shell without root.
+# Seedbox Install
+
+**These directions explain how to install Unpackerr on your linux shell without root.**
 
 1. Download a binary from the [latest release](https://github.com/Unpackerr/unpackerr/releases/latest).
   The `unpackerr.amd64.linux.gz` file is almost certainly what you want to grab,

docs/install/truenas-scale.md

@@ -6,7 +6,7 @@ pagination_next: install/configuration
 description: Install Unpackerr on TrueNAS Scale using TrueCharts.
 ---
 
-# TrueNAS Scale Installation
+# TrueNAS Scale Install
 
 ## TrueCharts
 

docs/install/unraid.md

@@ -6,7 +6,7 @@ pagination_next: install/configuration
 description: Install Unpackerr on your unRAID server!
 ---
 
-## Install
+# unRAID Install
 
 Unpackerr is available in the
 [Community Applications](https://github.com/selfhosters/unRAID-CA-templates/blob/main/templates/unpackerr.xml)