diff --git a/docs/downloaders/torrent.md b/docs/downloaders/torrent.md index 624777b..80197af 100644 --- a/docs/downloaders/torrent.md +++ b/docs/downloaders/torrent.md @@ -1,22 +1,8 @@ --- id: torrent title: Torrent Downloaders -pagination_prev: unpackerr/troubleshooting -pagination_next: downloaders/usenet -description: Information about torrent downloaders. +unlisted: true +description: Moved to Download Clients. --- -# Torrent Downloaders - -Find information about Torrent download clients on this page. It's a bit sparse, so please help us -[edit this page](https://github.com/Unpackerr/unpackerr.github.io/blob/main/docs/downloaders/torrent.md). - -## qBittorrent - -## Deluge - -## Transmission - -## rTorrent - -## uTorrent +This page moved to [Download Clients](/docs/unpackerr/download-clients). diff --git a/docs/downloaders/usenet.md b/docs/downloaders/usenet.md index 15cc71d..1c46461 100644 --- a/docs/downloaders/usenet.md +++ b/docs/downloaders/usenet.md @@ -1,35 +1,8 @@ --- id: usenet title: Usenet Downloaders -pagination_prev: downloaders/torrent -pagination_next: introduction -description: Information about usenet downloaders. +unlisted: true +description: Moved to Download Clients. --- -# Usenet Downloaders - -Find information about Usenet download clients on this page. It's a bit sparse, so please help us -[edit this page](https://github.com/Unpackerr/unpackerr.github.io/blob/main/docs/downloaders/usenet.md). - -## SABnzbd - -Generally Unpackerr is not required for Sabnzbd. - -- Navigate to [Job Actions](https://sabnzbd.org/wiki/extra/job-options) in [Categories](https://sabnzbd.org/wiki/configuration/4.2/categories) -- Set the value to `+Unpack` or `+Delete` - -## NZBGet - -This is depressing, but...NZBGet is no longer developed. - -## Easynews - -Nothing here yet. - -## Newsleecher - -This is empty... :( - -## Newsbin Pro - -Yup, also empty. +This page moved to [Download Clients](/docs/unpackerr/download-clients). diff --git a/docs/install/archlinux.md b/docs/install/archlinux.md index a7c9c20..fd368df 100644 --- a/docs/install/archlinux.md +++ b/docs/install/archlinux.md @@ -1,8 +1,6 @@ --- id: archlinux title: Arch Linux -pagination_prev: install/choosemethod -pagination_next: install/configuration description: Install Unpackerr on an Arch Linux server. --- diff --git a/docs/install/choosemethod.md b/docs/install/choosemethod.md index c61b9b3..82a2830 100644 --- a/docs/install/choosemethod.md +++ b/docs/install/choosemethod.md @@ -1,8 +1,6 @@ --- id: choosemethod title: Choose Install Method -pagination_prev: introduction -pagination_next: null description: Choose an Unpackerr install method. --- diff --git a/docs/install/compose.md b/docs/install/compose.md index ac84f29..d2f64ee 100644 --- a/docs/install/compose.md +++ b/docs/install/compose.md @@ -1,8 +1,6 @@ --- id: compose title: Docker Compose -pagination_prev: install/docker -pagination_next: install/configuration description: Install Unpackerr with Docker Compose! --- diff --git a/docs/install/configuration.md b/docs/install/configuration.md index ec44ea4..c68d509 100644 --- a/docs/install/configuration.md +++ b/docs/install/configuration.md @@ -1,8 +1,6 @@ --- id: configuration title: Application Configuration -pagination_prev: install/choosemethod -pagination_next: unpackerr/troubleshooting description: Unpackerr configurations explained. --- diff --git a/docs/install/docker.md b/docs/install/docker.md index 36e72a6..de6ca76 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -1,8 +1,6 @@ --- id: docker title: Docker Basics -pagination_prev: install/choosemethod -pagination_next: install/configuration description: Install Unpackerr using Docker! --- diff --git a/docs/install/freebsd.md b/docs/install/freebsd.md index a4974cb..be14c3a 100644 --- a/docs/install/freebsd.md +++ b/docs/install/freebsd.md @@ -1,8 +1,6 @@ --- id: freebsd title: FreeBSD -pagination_prev: install/choosemethod -pagination_next: install/configuration description: Install Unpackerr on a FreeBSD server. --- diff --git a/docs/install/linux.md b/docs/install/linux.md index 5c62796..e339a01 100644 --- a/docs/install/linux.md +++ b/docs/install/linux.md @@ -1,8 +1,6 @@ --- id: linux 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 a4b5143..23acbb6 100644 --- a/docs/install/macos.md +++ b/docs/install/macos.md @@ -1,8 +1,6 @@ --- id: macos title: macOS -pagination_prev: install/choosemethod -pagination_next: install/configuration description: Install Unpackerr on a macOS system. --- diff --git a/docs/install/seedbox.md b/docs/install/seedbox.md index bbaeed4..0ee2dd8 100644 --- a/docs/install/seedbox.md +++ b/docs/install/seedbox.md @@ -1,8 +1,6 @@ --- id: seedbox title: Seedbox -pagination_prev: install/linux -pagination_next: install/configuration description: Install Unpackerr on a Linux server without root. --- diff --git a/docs/install/truenas-scale.md b/docs/install/truenas-scale.md index fd7debb..2dc36d5 100644 --- a/docs/install/truenas-scale.md +++ b/docs/install/truenas-scale.md @@ -1,43 +1,50 @@ --- id: truenas-scale -title: TrueNAS Scale -pagination_prev: install/choosemethod -pagination_next: install/configuration -description: Install Unpackerr on TrueNAS Scale using TrueCharts. +title: TrueNAS +description: Install Unpackerr on TrueNAS SCALE or Community Edition. --- -## TrueCharts +The TrueCharts catalog is discontinued. Install Unpackerr with Portainer, Dockge, +or a custom app. ## Portainer -On TrueNAS Scale ElectricEel and later the use of docker containers is supported. To simplify installation, -install a container manager such as Portainer or Dockge from the inbuilt application catalogue. -This guide is based on the usage of Portainer. -![Portainer App Install](438751966-5e05d82c-7202-454b-a642-c120d86a5439.png) -![Portainer UI Open](438751972-c988a742-fd4f-4b95-b465-d58c108e785d.png) +On TrueNAS SCALE ElectricEel and later (and TrueNAS Community Edition), Docker +containers are supported. To simplify installation, install a container manager +such as Portainer or Dockge from the built-in application catalogue. +This guide uses Portainer. -Generate the contents of docker-compose.yml via [Notifiarr/Unpackerr](https://notifiarr.com/unpackerr) -or write this yourself. +![Portainer App Install](/img/screenshots/truenas/portainer-install.png) +![Portainer UI Open](/img/screenshots/truenas/portainer-ui.png) + +Generate `docker-compose.yml` with the [Unpackerr config generator](https://notifiarr.com/unpackerr) +or write it yourself. See [Docker Compose](/docs/install/compose) for a minimal +example. Map the same download folder your Starr apps use, and set `user:` to +the correct uid and gid. In Portainer, navigate to stacks, and add a new stack. -![Portainer Instance](438751979-fbc398b6-f0f2-4422-bf62-1c6a9d04b978.png) -![Stacks Section](438751985-b761fda1-793a-4ff3-a387-91084b406af2.png) -Name it 'unpackerr' and paste the contents of your previously created docker-compose.yml -![Stacks List](438751991-89cdbc39-9b7a-458e-8464-d29f0236d288.png) -![Create Unpackerr Stack](438751996-479f01b6-dc98-472a-8cf1-eafb40b4925a.png) +![Portainer Instance](/img/screenshots/truenas/portainer-instance.png) +![Stacks Section](/img/screenshots/truenas/stacks-section.png) + +Name it `unpackerr` and paste the contents of your compose file. + +![Stacks List](/img/screenshots/truenas/stacks-list.png) +![Create Unpackerr Stack](/img/screenshots/truenas/create-stack.png) + +Confirm the host directory mapping and user/group IDs for your TrueNAS instance, +then create the stack. + +![Deploy Stack](/img/screenshots/truenas/deploy-stack.png) -Ensure the details are correct for your TrueNAS instance (i.e. the relevant directory is mapped and the -user/group IDs are correct) and then create the stack. -![Deploy Stack](438751935-3cd78746-c0e1-4761-a163-05df93202f4c.png) +Portainer deploys the stack from here. +When it is running, open the unpackerr stack and review the logs. +You should see pending files for connected applications being extracted. -Portainer will do everything from here. -Once done, to confirm it is working open the unpackerr stack and review the logs. -You should see any pending files for connected applications being extracted. -![Log View](438751959-0dbedfb9-626c-44ce-910f-14ebfaeaa0d6.png) +![Log View](/img/screenshots/truenas/log-view.png) ## TrueNAS Custom App -There may be a way to install unpackerr directly without the use of a container manager. +There may be a way to install Unpackerr directly without a container manager. If you work that out, please [edit this page](https://github.com/Unpackerr/unpackerr.github.io/blob/main/docs/install/truenas-scale.md) so others can benefit from your tribulations. diff --git a/docs/install/unraid.md b/docs/install/unraid.md index 16cdeb0..73eea4f 100644 --- a/docs/install/unraid.md +++ b/docs/install/unraid.md @@ -1,8 +1,6 @@ --- id: unraid title: unRAID -pagination_prev: install/docker -pagination_next: install/configuration description: Install Unpackerr on your unRAID server! --- diff --git a/docs/install/windows.md b/docs/install/windows.md index 620a2cf..5c194b1 100644 --- a/docs/install/windows.md +++ b/docs/install/windows.md @@ -1,8 +1,6 @@ --- id: windows title: Windows -pagination_prev: install/choosemethod -pagination_next: install/configuration description: Install Unpackerr on a Windows system. --- diff --git a/docs/introduction.md b/docs/introduction.md index e614a9d..2a70e1f 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,8 +1,6 @@ --- id: introduction title: Introduction -pagination_prev: null -pagination_next: install/choosemethod description: Introduction and explanation of Unpackerr. --- diff --git a/docs/unpackerr/download-clients.md b/docs/unpackerr/download-clients.md new file mode 100644 index 0000000..e944ba5 --- /dev/null +++ b/docs/unpackerr/download-clients.md @@ -0,0 +1,41 @@ +--- +id: download-clients +title: Download Clients +description: How download clients relate to Unpackerr. +--- + +Unpackerr does not talk to torrent or Usenet clients. It polls Starr app queues +and optionally watches folders. The client only matters for categories, paths, +and whether it already unpacks the download. + +## Categories and labels + +Unknown queue items are often missing a category (or label/tag, depending on +the client). Configure categories in each Starr app so downloads are associated +with the right instance. See the [FAQ](/docs/unpackerr/faq) for unknown items. + +## Paths + +The download client, Starr apps, and Unpackerr must see the same download path +inside their containers (or on disk). See [Troubleshooting](/docs/unpackerr/troubleshooting) +for good and bad mount examples. + +## Do not double-unpack + +If the download client already unpacks archives, Unpackerr has nothing to extract. +Leave client unpacking **or** use Unpackerr; not both. + +## SABnzbd + +SABnzbd can unpack on its own. If that is enough, you do not need Unpackerr for +those downloads. + +- Navigate to [Job Actions](https://sabnzbd.org/wiki/extra/job-options) in + [Categories](https://sabnzbd.org/wiki/configuration/4.2/categories) +- Set the value to `+Unpack` or `+Delete` + +## NZBGet + +[NZBGet](https://nzbget.com/) is actively maintained again. Unpackerr is still +useful if NZBGet is not unpacking completed jobs, or if you want Starr-queue +driven extraction and cleanup. diff --git a/docs/unpackerr/faq.md b/docs/unpackerr/faq.md index 758a170..443c752 100644 --- a/docs/unpackerr/faq.md +++ b/docs/unpackerr/faq.md @@ -1,8 +1,6 @@ --- id: faq title: FAQs -pagination_prev: introduction -pagination_next: unpackerr/troubleshooting description: Frequently asked questions about Unpackerr installation and troubleshooting. --- diff --git a/docs/unpackerr/troubleshooting.md b/docs/unpackerr/troubleshooting.md index e34c774..374d41f 100644 --- a/docs/unpackerr/troubleshooting.md +++ b/docs/unpackerr/troubleshooting.md @@ -1,8 +1,6 @@ --- id: troubleshooting title: Troubleshooting -pagination_prev: unpackerr/faq -pagination_next: downloaders/torrent description: Tips and Tricks for troubleshooting Unpackerr installations. --- diff --git a/docs/xt.md b/docs/xt.md index 2d489f9..66ed03d 100644 --- a/docs/xt.md +++ b/docs/xt.md @@ -1,8 +1,6 @@ --- id: xt title: eXtractor Tool -pagination_prev: null -pagination_next: null description: Recursively decompress archives --- diff --git a/sidebars.js b/sidebars.js index 6769d8a..b83fdee 100644 --- a/sidebars.js +++ b/sidebars.js @@ -10,17 +10,23 @@ const sidebars = { 'install/macos', 'install/windows', {Linux: ['install/linux', 'install/archlinux', 'install/seedbox']}, - 'install/configuration', ], }, + 'install/configuration', 'unpackerr/faq', - {'Tips & Tricks': ['unpackerr/troubleshooting', 'downloaders/torrent', 'downloaders/usenet']}, + 'unpackerr/troubleshooting', + 'unpackerr/download-clients', + { + type: 'category', + label: 'xt', + collapsed: false, + items: ['xt'], + }, { type: 'html', value: '', defaultStyle: true, }, - 'xt', ], }; diff --git a/static/img/screenshots/truenas-scale/app-config.png b/static/img/screenshots/truenas-scale/app-config.png deleted file mode 100644 index 1fa6959..0000000 Binary files a/static/img/screenshots/truenas-scale/app-config.png and /dev/null differ diff --git a/static/img/screenshots/truenas-scale/app-storage.png b/static/img/screenshots/truenas-scale/app-storage.png deleted file mode 100644 index 3951ac1..0000000 Binary files a/static/img/screenshots/truenas-scale/app-storage.png and /dev/null differ diff --git a/static/img/screenshots/truenas-scale/discover.png b/static/img/screenshots/truenas-scale/discover.png deleted file mode 100644 index e13e724..0000000 Binary files a/static/img/screenshots/truenas-scale/discover.png and /dev/null differ diff --git a/static/img/screenshots/truenas-scale/download-config.png b/static/img/screenshots/truenas-scale/download-config.png deleted file mode 100644 index da909b4..0000000 Binary files a/static/img/screenshots/truenas-scale/download-config.png and /dev/null differ diff --git a/static/img/screenshots/truenas-scale/view-logs.png b/static/img/screenshots/truenas-scale/view-logs.png deleted file mode 100644 index 4c2b610..0000000 Binary files a/static/img/screenshots/truenas-scale/view-logs.png and /dev/null differ diff --git a/docs/install/438751996-479f01b6-dc98-472a-8cf1-eafb40b4925a.png b/static/img/screenshots/truenas/create-stack.png similarity index 100% rename from docs/install/438751996-479f01b6-dc98-472a-8cf1-eafb40b4925a.png rename to static/img/screenshots/truenas/create-stack.png diff --git a/docs/install/438751935-3cd78746-c0e1-4761-a163-05df93202f4c.png b/static/img/screenshots/truenas/deploy-stack.png similarity index 100% rename from docs/install/438751935-3cd78746-c0e1-4761-a163-05df93202f4c.png rename to static/img/screenshots/truenas/deploy-stack.png diff --git a/docs/install/438751959-0dbedfb9-626c-44ce-910f-14ebfaeaa0d6.png b/static/img/screenshots/truenas/log-view.png similarity index 100% rename from docs/install/438751959-0dbedfb9-626c-44ce-910f-14ebfaeaa0d6.png rename to static/img/screenshots/truenas/log-view.png diff --git a/docs/install/438751966-5e05d82c-7202-454b-a642-c120d86a5439.png b/static/img/screenshots/truenas/portainer-install.png similarity index 100% rename from docs/install/438751966-5e05d82c-7202-454b-a642-c120d86a5439.png rename to static/img/screenshots/truenas/portainer-install.png diff --git a/docs/install/438751979-fbc398b6-f0f2-4422-bf62-1c6a9d04b978.png b/static/img/screenshots/truenas/portainer-instance.png similarity index 100% rename from docs/install/438751979-fbc398b6-f0f2-4422-bf62-1c6a9d04b978.png rename to static/img/screenshots/truenas/portainer-instance.png diff --git a/docs/install/438751972-c988a742-fd4f-4b95-b465-d58c108e785d.png b/static/img/screenshots/truenas/portainer-ui.png similarity index 100% rename from docs/install/438751972-c988a742-fd4f-4b95-b465-d58c108e785d.png rename to static/img/screenshots/truenas/portainer-ui.png diff --git a/docs/install/438751991-89cdbc39-9b7a-458e-8464-d29f0236d288.png b/static/img/screenshots/truenas/stacks-list.png similarity index 100% rename from docs/install/438751991-89cdbc39-9b7a-458e-8464-d29f0236d288.png rename to static/img/screenshots/truenas/stacks-list.png diff --git a/docs/install/438751985-b761fda1-793a-4ff3-a387-91084b406af2.png b/static/img/screenshots/truenas/stacks-section.png similarity index 100% rename from docs/install/438751985-b761fda1-793a-4ff3-a387-91084b406af2.png rename to static/img/screenshots/truenas/stacks-section.png