From 4a9044535998c51bfbe58662b995413f28fd5a20 Mon Sep 17 00:00:00 2001 From: David Newhall II Date: Wed, 26 Aug 2026 01:49:10 -0700 Subject: [PATCH 1/3] Fix docs grammar, Starr facts, and leftover site chrome. Correct Prowlarr/Whisparr coverage, log paths, Docker Hub wording, and the Docusaurus navbar leftover so the handwritten pages match the app. Co-authored-by: Cursor --- docs/install/choosemethod.md | 6 ++-- docs/install/compose.md | 4 ++- docs/install/configuration.md | 13 +++---- docs/install/docker.md | 12 +++---- docs/install/freebsd.md | 5 +-- docs/install/includes/linuxpermissions.md | 2 +- docs/install/linux.md | 2 +- docs/install/macos.md | 6 ++-- docs/install/seedbox.md | 6 ++-- docs/install/unraid.md | 10 +++--- docs/install/windows.md | 15 ++++---- docs/introduction.md | 43 +++++++++++----------- docs/unpackerr/faq.md | 44 ++++++++++++----------- docs/unpackerr/troubleshooting.md | 16 +++++---- docusaurus.config.js | 6 ++-- 15 files changed, 101 insertions(+), 89 deletions(-) diff --git a/docs/install/choosemethod.md b/docs/install/choosemethod.md index 032fc36..c61b9b3 100644 --- a/docs/install/choosemethod.md +++ b/docs/install/choosemethod.md @@ -6,7 +6,7 @@ pagination_next: null description: Choose an Unpackerr install method. --- -We recommended to installing Unpackerr the same way you installed your +We recommend installing Unpackerr the same way you installed your Starr or download apps. If your existing infrastructure exists in Docker, then Unpackerr should probably live in Docker too. @@ -17,14 +17,14 @@ reside. Read more about that on the [Docker page](docker#folder-watcher). ## Instructions Available - [Docker](/docs/install/docker): [Compose](/docs/install/compose), - [unRAID](/docs/install/unraid), [TrueNAS Scale](/docs/install/truenas-scale) + [unRAID](/docs/install/unraid), [TrueNAS](/docs/install/truenas-scale) - [FreeBSD](/docs/install/freebsd) - [Linux: with root](/docs/install/linux), [without root / seedbox](/docs/install/seedbox) - [macOS](/docs/install/macos) - [Windows](/docs/install/windows) :::tip[CPU Hog] -Unpackerr uses a lot CPU while extracting, and tends not to work well when +Unpackerr uses a lot of CPU while extracting, and tends not to work well when running on smaller systems like Synology NAS devices. Running Unpackerr on a system with a large CPU is ideal to avoid system performance degradation. The application uses only a few CPU cycles at idle to poll Starr apps and/or diff --git a/docs/install/compose.md b/docs/install/compose.md index 78812b1..ac84f29 100644 --- a/docs/install/compose.md +++ b/docs/install/compose.md @@ -18,9 +18,11 @@ import DataMount from './includes/dockerdatamount.md'; - Then start it, like this: ```shell -docker-compose up -d +docker compose up -d ``` +Compose V1 used `docker-compose` (hyphen). Compose V2 is `docker compose` (space). + Here's an example minimal compose file. This works well, and all the defaults should work for you too. The [`user:` parameter](https://docs.docker.com/compose/compose-file/05-services/#user) controls the uid and gid that the app runs as. The default is root if you don't include it, but you should definitely diff --git a/docs/install/configuration.md b/docs/install/configuration.md index 882763c..d4341c3 100644 --- a/docs/install/configuration.md +++ b/docs/install/configuration.md @@ -18,7 +18,7 @@ and [example config](https://github.com/Unpackerr/unpackerr/blob/main/examples/u ## Config -- Setting a log file is strongly recommend. This makes it much easier to troubleshoot problems. +- Setting a log file is strongly recommended. This makes it much easier to troubleshoot problems. - To use a config file in Docker, mount `/config` to the container and Unpackerr will write a config file. - Update the new file at `/config/unpackerr.conf` and restart the container. - When using a config file you must uncomment at minimum the `[[header]]` @@ -42,7 +42,7 @@ add another `[[header]]` ex. `[[sonarr]]` and the `url`/`api_key`/etc under it. When adding a second instance to the __environment variables__, you must increment the `0` to a `1`. And to a `2` if you have 3 instances. There is no limit to the number of supported instances. This notation -works for all starr apps, folders, command hooks, and web hooks. +works for all Starr apps, folders, command hooks, and webhooks.
Config examples with multiple instances. @@ -121,12 +121,9 @@ _This feature was added in Unpackerr v0.14.0._ ## Event IDs -Event IDs are needed/used in command hooks and webhooks. - -`0` = all, `1` = queued, `2` = extracting, `3` = extract failed, `4` = extracted, -`5` = imported, `6` = deleting, `7` = delete failed, `8` = deleted, `9` = nothing extracted - -The 'nothing extracted' event (9) only fires for the folder watcher, not starr apps. +Command hooks and webhooks use numeric event IDs; those settings list them. +`0` sends all events. Event `9` (nothing extracted) only fires for the folder +watcher, not Starr apps. --- diff --git a/docs/install/docker.md b/docs/install/docker.md index 747886f..36e72a6 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -23,8 +23,8 @@ GoLift software has a [Docker Open Source Sponsorship](https://docs.docker.com/t 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. +This project builds automatically on [Docker Hub](https://hub.docker.com/r/golift/unpackerr) and creates +[ready-to-use multi-architecture images](https://hub.docker.com/r/golift/unpackerr/tags). The `latest` tag is always a [tagged release on GitHub](https://github.com/Unpackerr/unpackerr/releases). - Pull the DockerHub image with this command: @@ -49,7 +49,7 @@ The `latest` tag is always a [tagged release on GitHub](https://github.com/Unpac ```shell docker pull golift/unpackerr docker run -d -v /mnt/HostDownloads:/downloads \ - -e "UN_SONARR_0_URL=http://localhost:8989" \ + -e "UN_SONARR_0_URL=http://sonarr:8989" \ -e "UN_SONARR_0_API_KEY=kjsdkasjdaksdj" golift/unpackerr docker logs ``` @@ -84,7 +84,7 @@ The `golift` docker container runs as uid 0 (root) by default. This is probably Make sure to set the correct uid and gid with the `--user` parameter. Example: ```bash -# This commands runs golift/unpackerr with UID 1000 and GID 100. +# This command runs golift/unpackerr with UID 1000 and GID 100. docker run --user 1000:100 -d -v /mnt/data:/data -v /mnt/config:/config golift/unpackerr ``` @@ -97,12 +97,12 @@ Find examples in the [Docker Compose instruction](compose). ### Hotio The primary difference between the golift and hotio containers is how you set the uid and gid. -Hotio does not user the `--user` parameter and instead sets the UID and GID with environment +Hotio does not use 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. +# This command runs hotio/unpackerr with UID 1000 and GID 100. docker run -e PUID=1000 -e PGID=100 -d -v /mnt/data:/data -v /mnt/config:/config hotio/unpackerr ``` diff --git a/docs/install/freebsd.md b/docs/install/freebsd.md index 7a18aa4..a4974cb 100644 --- a/docs/install/freebsd.md +++ b/docs/install/freebsd.md @@ -9,8 +9,9 @@ description: Install Unpackerr on a FreeBSD server. import ArchiveAccess from './includes/archiveaccess.md'; 1. Download a package from the [latest release](https://github.com/Unpackerr/unpackerr/releases/latest). -1. Install it with `pkg add -f` (the force flag is required because the package has - [a bug](https://github.com/Unpackerr/unpackerr/issues/352)) +1. Install it with `pkg add`. Older packages were labeled with the wrong architecture + ([issue 352](https://github.com/Unpackerr/unpackerr/issues/352)); if `pkg` refuses + the file, use `pkg add -f`. 1. Edit the config file at `/etc/unpackerr/unpackerr.conf`, or [generate one](https://notifiarr.com/unpackerr) and start it. 1. Not many folks use FreeBSD, but we can try to help if you drop by the [Discord](https://golift.io/discord). diff --git a/docs/install/includes/linuxpermissions.md b/docs/install/includes/linuxpermissions.md index 6ed9be4..d591cfe 100644 --- a/docs/install/includes/linuxpermissions.md +++ b/docs/install/includes/linuxpermissions.md @@ -3,7 +3,7 @@ user or group read and write access to your archives. That may mean adding the ` user, for example, to the `debian-transmission` group. You would do that with a command such as `sudo usermod -aG debian-transmission unpackerr` -It's only suggested you do run `usermod` if you know what it does and how to set a umask. +Only run `usermod` if you know what it does and how to set a umask. You probably instead want to change the uid and/or gid as shown next. ### Change the uid/gid diff --git a/docs/install/linux.md b/docs/install/linux.md index 7ce39ca..5c62796 100644 --- a/docs/install/linux.md +++ b/docs/install/linux.md @@ -1,6 +1,6 @@ --- id: linux -title: Repository +title: Linux pagination_prev: install/choosemethod pagination_next: install/configuration description: Install Unpackerr on a Linux server. diff --git a/docs/install/macos.md b/docs/install/macos.md index 02906e0..a4b5143 100644 --- a/docs/install/macos.md +++ b/docs/install/macos.md @@ -1,6 +1,6 @@ --- id: macos -title: MacOS +title: macOS pagination_prev: install/choosemethod pagination_next: install/configuration description: Install Unpackerr on a macOS system. @@ -8,8 +8,6 @@ description: Install Unpackerr on a macOS system. import ArchiveAccess from './includes/archiveaccess.md'; - - ## Universal Binary App 1. Download a `.dmg` file from the @@ -21,3 +19,5 @@ import ArchiveAccess from './includes/archiveaccess.md'; 1. Click the menu bar icon again and select `Quit`. Then open the app again. 1. View the logs by clicking the menu bar icon and `Logs` -> `View`. 1. You can add it to `Login Items` to run it automatically when you login. + + diff --git a/docs/install/seedbox.md b/docs/install/seedbox.md index 3ef2323..bbaeed4 100644 --- a/docs/install/seedbox.md +++ b/docs/install/seedbox.md @@ -8,7 +8,7 @@ description: Install Unpackerr on a Linux server without root. import ArchiveAccess from './includes/archiveaccess.md'; -**These directions explain how to install Unpackerr on your linux shell without root.** +**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, @@ -18,7 +18,7 @@ import ArchiveAccess from './includes/archiveaccess.md'; 1. Download the [example config file](https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example), or [generate one](https://notifiarr.com/unpackerr). 1. Edit config file to suit your needs: `nano unpackerr.conf` -1. Put both on your Linux shell server, in an `~/unapckerr/` folder. +1. Put both on your Linux shell server, in an `~/unpackerr/` folder. 1. Run Unpackerr in the background, `screen` is the easiest way to do so. @@ -60,7 +60,7 @@ wget https://raw.githubusercontent.com/Unpackerr/unpackerr/$TAG/examples/unpacke chmod 0600 $HOME/unpackerr/unpackerr.conf # This opens nano, so you may edit unpackerr.conf to suit your needs. -# Set a starr app url and api key, and a log file at minimum. +# Set a Starr app url and api key, and a log file at minimum. # "~/unpackerr/unpackerr.log" is a good path for a log file. nano $HOME/unpackerr/unpackerr.conf diff --git a/docs/install/unraid.md b/docs/install/unraid.md index 216d1f4..16cdeb0 100644 --- a/docs/install/unraid.md +++ b/docs/install/unraid.md @@ -19,12 +19,12 @@ On the install screen, fill in the `URL` and `API_KEY` for one or more of the St :::note[Multiple Instances] If you have, for instance, two Radarrs, you can simply add two new variables: `UN_RADARR_1_URL` and `UN_RADARR_1_API_KEY`. If you have 3, then increase -the `1` to a `2` and so on. This works for all starr apps, folders, webhooks and command +the `1` to a `2` and so on. This works for all Starr apps, folders, webhooks and command hooks. There is no limit to how many you may configure. ::: -It's also recommend that you set a log file. -It's recommended to put it in your downloads location, and an example follows. +It's also recommended that you set a log file. +Put it in your downloads location; an example follows. ![Bind volume for Unpackerr log file](/img/screenshots/unraid/bindvolume.png "bind volume") @@ -50,7 +50,7 @@ In other words, if Unpackerr has `/downloads <-> /mnt/user/downloads` and Sonarr `/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. -![Unpackerr volume mount](/img/screenshots/unraid/unpackerrmount.png "unapackerr mount") +![Unpackerr volume mount](/img/screenshots/unraid/unpackerrmount.png "unpackerr mount") ::: ## Permissions @@ -58,7 +58,7 @@ must edit the Unpackerr `/downloads` mount, and change the _Container Path_ to ` Set the UID and GID by adding `--user uid:gid` to the `Extra Parameters` section of the unraid template after enabling the `Advanced` view. ![Enable Docker advanced view](/img/screenshots/unraid/advancedview.png "advanced view") -You must make these match your starr app so hard links work correctly. +You must make these match your Starr app so hard links work correctly. **Other containers, use env variables such as `PUID` and `PGID`, but the Go Lift unpackerr container does not use these.** e.g. If Sonarr has `PUID` of `99` and `PGID` of `100`, then you must diff --git a/docs/install/windows.md b/docs/install/windows.md index 232c2c0..620a2cf 100644 --- a/docs/install/windows.md +++ b/docs/install/windows.md @@ -40,8 +40,8 @@ The following content was provided by a community member, [IamGimli](https://git If you want unpackerr to run automatically upon Windows boot, without a user needing to be logged-on, follow these instructions: -Download and configure unpackerr according to the instructions on the -[main page](https://github.com/davidnewhall/unpackerr). +Download and configure unpackerr according to the instructions +[above](#windows-installation). Make sure unpackerr runs without error messages in the logs before you continue. Once you've confirmed that unpackerr is properly configured, close it by right-clicking its icon in the taskbar and selecting `Quit`. @@ -77,8 +77,8 @@ Windows Registry Editor Version 5.00 "FailureActionsOnNonCrashFailures"=dword:00000001 [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\unpackerr-Service\Parameters] -"AppDirectory"="C:\\Program Files\\unpackerr" -"Application"="C:\\Program Files\\unpackerr\\unpackerr.amd64.exe" +"AppDirectory"="C:\\ProgramData\\unpackerr" +"Application"="C:\\ProgramData\\unpackerr\\unpackerr.amd64.exe" "AppParameters"="" [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\unpackerr-Service\Parameters\AppExit] @@ -87,9 +87,10 @@ Windows Registry Editor Version 5.00 Replace **accountname** with the name of the local user account that you want unpackerr to run under. Make sure that account has all the permissions required -to access to all of the paths that unpackerr will use. Also make sure that the -"AppDirectory" and "Application" fields point to the location where you installed -unpackerr, making sure to double up the backslashes in the path. +to access all of the paths that unpackerr will use. Also make sure that the +"AppDirectory" and "Application" fields match the location where you installed +unpackerr (`C:\ProgramData\unpackerr` in the steps above), doubling the +backslashes in the path. Save the file and then double-click it. You'll get a warning that importing registry keys could harm your system, click "Yes". diff --git a/docs/introduction.md b/docs/introduction.md index ba04fc6..1ec4476 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -8,7 +8,7 @@ description: Introduction and explanation of Unpackerr. Unpackerr is an application that runs on Windows, macOS, Linux, FreeBSD and in Docker. You can use it to watch a download folder and extract new items. -The more common use is to watch starr apps (radarr, sonarr, readarr, lidarr, whisparr) +The more common use is to watch Starr apps (Radarr, Sonarr, Readarr, Lidarr, Whisparr) and extract items they download. It can do both, at the same time even. ## Features @@ -28,18 +28,19 @@ and extract items they download. It can do both, at the same time even. ## Description This application runs as a daemon on your download host. It checks for completed -downloads and extracts them so Lidarr, Radarr, Readarr, and Sonarr may import them. -There are a handful of options out there for extracting and deleting files after -your client downloads them. I just didn't care for any of them, so I wrote my own. -I wanted a small single-binary with reasonable logging that can extract downloaded -archives and clean up the mess after they've been imported. +downloads and extracts them so Lidarr, Radarr, Readarr, Sonarr, and Whisparr may +import them. There are a handful of options out there for extracting and deleting +files after your client downloads them. I just didn't care for any of them, so I +wrote my own. I wanted a small single-binary with reasonable logging that can extract +downloaded archives and clean up the mess after they've been imported. -Not a starr app user, and just need to extract files? We do that too. This +Not a Starr app user, and just need to extract files? We do that too. This application can run standalone and extract files found in a "watch" folder. In other words, you can configure this application to watch your download folder, and it will -happily extract everything you download. This has nothing to do with the four Starr -apps mentioned in the previous paragraph. This Folder-watch feature may be used with -or without Starr apps. +happily extract everything you download. This has nothing to do with the Starr +apps mentioned in the previous paragraph. This folder-watch feature may be used with +or without Starr apps. For a one-shot command-line extractor (no daemon, no Starr +polling), see [xt](/docs/xt). ## Archives Supported @@ -49,26 +50,28 @@ encrypted rars and 7zips. And ISO disc images. Need something else? Ask. Does it too much? Let me know what knobs you need. [Open a request](https://github.com/Unpackerr/unpackerr/issues/new)! -Unpackerr will decompress archives of these types: +Unpackerr uses [xtractr](https://github.com/golift/xtractr) and decompresses archives +of these common types: - `rar`, `tar`, `tgz`, `gz`, `zip`, `7z`, `bz2`, `tbz2`, `iso` - Multi-file archives are supported with RAR and 7ZIP formats. - Password protected archives are supported with RAR and 7ZIP formats. -- Archives are detected by the file extension. ISO is disabled by default. +- Archives are detected by the file extension. ISO is disabled by default + (`extract_isos`). Many more extensions (xz, zst, lz4, and others) are also supported. ## Starr Logic -The application polls Radarr, Readarr, Sonarr and Lidarr at the `interval` configured. -The queued items are inspected for completeness. +The application polls Radarr, Readarr, Sonarr, Lidarr, and Whisparr at the `interval` +configured. The queued items are inspected for completeness. -When Unpackerr finds an item in a starr app, the download location is checked for an -archive file. If an extractable archive exists, and the starr app has `status=Completed` +When Unpackerr finds an item in a Starr app, the download location is checked for an +archive file. If an extractable archive exists, and the Starr app has `status=Completed` from your download client, Unpackerr will extract the file. Files are extracted to a temporary folder, and then moved back into the download location for -_Completed Download Handling_ to import them. When the item falls out of the starr app +_Completed Download Handling_ to import them. When the item falls out of the Starr app queue, the extracted files are deleted. -# Attribution +## Attribution The following fine folks are providing their services, completely free! These service integrations are used for things like storage, building, compiling, distribution and @@ -76,7 +79,7 @@ documentation support. This project succeeds because of them. Thank you! [![packagecloud](https://docs.golift.io/integrations/packagecloud.png "PackageCloud.io")](https://packagecloud.io) [![GitHub](https://docs.golift.io/integrations/octocat.png "GitHub")](https://GitHub.com) -[![Docker Cloud](https://docs.golift.io/integrations/docker.png "Docker Cloud")](https://cloud.docker.com) +[![Docker Hub](https://docs.golift.io/integrations/docker.png "Docker Hub")](https://hub.docker.com/r/golift/unpackerr) [![Homebrew](https://docs.golift.io/integrations/homebrew.png "Homebrew")](https://brew.sh) [![Go Lift](https://docs.golift.io/integrations/golift.png "Go Lift")](https://golift.io) -[![CloudFlare](https://docs.golift.io/integrations/cloudflare.png "CloudFlare")](https://cloudflare.com) +[![Cloudflare](https://docs.golift.io/integrations/cloudflare.png "Cloudflare")](https://cloudflare.com) diff --git a/docs/unpackerr/faq.md b/docs/unpackerr/faq.md index 4a12f14..758a170 100644 --- a/docs/unpackerr/faq.md +++ b/docs/unpackerr/faq.md @@ -6,50 +6,54 @@ pagination_next: unpackerr/troubleshooting description: Frequently asked questions about Unpackerr installation and troubleshooting. --- -## 0. Why do I need Unpackerr? +## 1. Why do I need Unpackerr? Great question! It has two answers. -1. If you've ever had things stuck in your Starr app queues because they are RAR (or z7, etc) - files then you've been in the situation Unpackerr fixes. If this is a common occurrence, then - Unpackerr is for you. If you don't download compressed files, we're happy to admit this isn't - for you. -1. Unpackerr can also extract files in a _watched_ (download) folder. If you download a lot of - stuff and like it to be automatically extracted, then you can use Unpackerr for that purpose - as well. No Starr apps required; just something that downloads archives to folders. +1. If you've ever had things stuck in your Starr app queues because they are RAR (or 7z, + etc) files then you've been in the situation Unpackerr fixes. If this is a common + occurrence, then Unpackerr is for you. If you don't download compressed files, we're + happy to admit this isn't for you. +1. Unpackerr can also extract files in a _watched_ (download) folder. If you download a + lot of stuff and like it to be automatically extracted, then you can use Unpackerr + for that purpose as well. No Starr apps required; just something that downloads + archives to folders. -## 1. What is a Starr app? +## 2. What is a Starr app? -Lidarr, Prowlarr, Radarr, Readarr, Sonarr, Whisparr +Lidarr, Radarr, Readarr, Sonarr, Whisparr -## 2. Why does Unpackerr show things not in my starr app? +Unpackerr integrates with those apps. Prowlarr is also a Starr app, but Unpackerr does +not talk to it. + +## 3. Why does Unpackerr show things not in my Starr app? Unpackerr uses the `unknown` item flag when requesting the queue. -Recently, starr apps do show unknown items by default. However, +Recently, Starr apps do show unknown items by default. However, your installation may have shown unknown items disabled. #### Do This -1. Go into each of your starr apps +1. Go into each of your Starr apps 1. Navigate to the **Activity Queue** 1. Click **Options** in the top right 1. Check the box to enable **Show Unknown Items**. -## 3. What do I do with unknown items? +## 4. What do I do with unknown items? These items are often caused by having incorrect or an absence of categories (or labels/tags depending on your download client). -Make sure you configure categories in each starr app. Once those +Make sure you configure categories in each Starr app. Once those are configured, you should import or force-remove the unknown -items to make them go away. Another common problem is the starr -apps are unable to match the download to a know media type +items to make them go away. Another common problem is the Starr +apps are unable to match the download to a known media type (book/movie/tv series/episode/song/etc.) -## 4. Why aren't hard links working? +## 5. Why aren't hard links working? The most common cause for this is that Unpackerr is running as, -and writing files as a user other than the user that your starr +and writing files as a user other than the user that your Starr apps run as. If you're in Docker, this is likely happening because the container was not started with the proper uid and gid. See the Permissions section on the [Docker](/docs/install/docker#permissions) @@ -60,6 +64,6 @@ If you're running in Linux, see the Permissions section on the on how to fix the problem. If hard links don't work **at all** it could indicate another problem -with your starr app setup. See [TRaSH's Guides](https://trash-guides.info/Hardlinks/Hardlinks-and-Instant-Moves/) +with your Starr app setup. See [TRaSH's Guides](https://trash-guides.info/Hardlinks/Hardlinks-and-Instant-Moves/) and the [Servarr Team's Docker Guide](https://wiki.servarr.com/docker-guide) for details on Docker path best-practices. diff --git a/docs/unpackerr/troubleshooting.md b/docs/unpackerr/troubleshooting.md index 0715ead..e34c774 100644 --- a/docs/unpackerr/troubleshooting.md +++ b/docs/unpackerr/troubleshooting.md @@ -34,15 +34,19 @@ description: Tips and Tricks for troubleshooting Unpackerr installations. If transfers are in an Error state they will not be extracted. -**Permissions** tend to mess things up too, so make sure the user unpackerr runs as can read +**Permissions** tend to mess things up too, so make sure the user Unpackerr runs as can read and write to your download location. -Default Log files: +## Log files -- Linux: `/var/log/messages` or `/var/log/syslog` (w/ default syslog) -- FreeBSD: `/var/log/syslog` (w/ default syslog) -- macOS: `/usr/local/var/log/unpackerr.log` or `~/.unpackerr/unpackerr.log` -- Windows: `~/.unpackerr/unpackerr.log` +If you set `log_file`, that path is where Unpackerr writes. The Windows tray install +documents `C:\ProgramData\unpackerr\logs\unpackerr.log` when you configure it that way. + +If `log_file` is unset: + +- Linux: `/var/log/messages` or `/var/log/syslog` (default syslog) +- FreeBSD: `/var/log/syslog` (default syslog) +- macOS and Windows GUI: `~/.unpackerr/unpackerr.log` Still having problems? [Let us know](https://github.com/Unpackerr/unpackerr/issues/new) or [find help on Discord](https://golift.io/discord). diff --git a/docusaurus.config.js b/docusaurus.config.js index 1b42710..9c3adfe 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -4,7 +4,7 @@ /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'Unpackerr Extracter', + title: 'Unpackerr', tagline: 'Automated Archive Extractions', favicon: 'img/favicon.ico', @@ -72,8 +72,8 @@ const config = { position: 'left', }, { - href: 'https://github.com/facebook/docusaurus', - label: 'Docusaurus', + href: 'https://github.com/Unpackerr/unpackerr', + label: 'GitHub', position: 'right', }, ], From 282c82819c79cfb60f7ba8f759588a4b02b5536e Mon Sep 17 00:00:00 2001 From: David Newhall II Date: Wed, 26 Aug 2026 16:02:38 -0700 Subject: [PATCH 2/3] Restore webhook event IDs and list every xtractr archive type. Co-authored-by: Cursor --- docs/install/configuration.md | 9 ++++++--- docs/introduction.md | 19 +++++++++++++------ 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/docs/install/configuration.md b/docs/install/configuration.md index d4341c3..ec44ea4 100644 --- a/docs/install/configuration.md +++ b/docs/install/configuration.md @@ -121,9 +121,12 @@ _This feature was added in Unpackerr v0.14.0._ ## Event IDs -Command hooks and webhooks use numeric event IDs; those settings list them. -`0` sends all events. Event `9` (nothing extracted) only fires for the folder -watcher, not Starr apps. +Event IDs are used in command hooks and webhooks. + +`0` = all, `1` = queued, `2` = extracting, `3` = extract failed, `4` = extracted, +`5` = imported, `6` = deleting, `7` = delete failed, `8` = deleted, `9` = nothing extracted + +The `nothing extracted` event (`9`) only fires for the folder watcher, not Starr apps. --- diff --git a/docs/introduction.md b/docs/introduction.md index 1ec4476..ab0d181 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -51,13 +51,20 @@ too much? Let me know what knobs you need. [Open a request](https://github.com/Unpackerr/unpackerr/issues/new)! Unpackerr uses [xtractr](https://github.com/golift/xtractr) and decompresses archives -of these common types: - -- `rar`, `tar`, `tgz`, `gz`, `zip`, `7z`, `bz2`, `tbz2`, `iso` -- Multi-file archives are supported with RAR and 7ZIP formats. -- Password protected archives are supported with RAR and 7ZIP formats. +of these types: + +- Zip: `zip` +- RAR: `rar`, `r00` +- 7-Zip: `7z`, `7z.001` +- tar: `tar`, `tar.gz`, `tgz`, `tar.bz2`, `tbz`, `tbz2`, `tar.xz`, `txz`, `tar.z`, `tz`, `tlz` +- gzip / bzip2 / xz / zstd: `gz`, `gzip`, `bz2`, `xz`, `zst`, `zstd` +- Other compressors: `lz4`, `lz`, `lzip`, `lzma`, `lzma2`, `z`, `br`, `brotli`, `s2`, `snappy`, `sz`, `zlib`, `zz` +- Packages and images: `iso`, `cpio`, `cpio.gz`, `cpgz`, `ar`, `deb`, `rpm` +- Cue sheets (FLAC splits): `cue`, `cue.txt` +- Multi-file archives are supported with RAR and 7-Zip. +- Password protected archives are supported with RAR and 7-Zip. - Archives are detected by the file extension. ISO is disabled by default - (`extract_isos`). Many more extensions (xz, zst, lz4, and others) are also supported. + (`extract_isos`). ## Starr Logic From 4aa180df774bec412aafa8b495c1b9e2aa305deb Mon Sep 17 00:00:00 2001 From: David Newhall II Date: Wed, 26 Aug 2026 17:08:25 -0700 Subject: [PATCH 3/3] Wrap a compressor list line so markdownlint MD013 passes. Co-authored-by: Cursor --- docs/introduction.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/introduction.md b/docs/introduction.md index ab0d181..e614a9d 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -58,7 +58,8 @@ of these types: - 7-Zip: `7z`, `7z.001` - tar: `tar`, `tar.gz`, `tgz`, `tar.bz2`, `tbz`, `tbz2`, `tar.xz`, `txz`, `tar.z`, `tz`, `tlz` - gzip / bzip2 / xz / zstd: `gz`, `gzip`, `bz2`, `xz`, `zst`, `zstd` -- Other compressors: `lz4`, `lz`, `lzip`, `lzma`, `lzma2`, `z`, `br`, `brotli`, `s2`, `snappy`, `sz`, `zlib`, `zz` +- Other compressors: `lz4`, `lz`, `lzip`, `lzma`, `lzma2`, `z`, `br`, `brotli`, + `s2`, `snappy`, `sz`, `zlib`, `zz` - Packages and images: `iso`, `cpio`, `cpio.gz`, `cpgz`, `ar`, `deb`, `rpm` - Cue sheets (FLAC splits): `cue`, `cue.txt` - Multi-file archives are supported with RAR and 7-Zip.