Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 3 additions & 17 deletions docs/downloaders/torrent.md
Original file line number Diff line number Diff line change
@@ -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).
33 changes: 3 additions & 30 deletions docs/downloaders/usenet.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 0 additions & 2 deletions docs/install/archlinux.md
Original file line number Diff line number Diff line change
@@ -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.
---

Expand Down
2 changes: 0 additions & 2 deletions docs/install/choosemethod.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: choosemethod
title: Choose Install Method
pagination_prev: introduction
pagination_next: null
description: Choose an Unpackerr install method.
---

Expand Down
2 changes: 0 additions & 2 deletions docs/install/compose.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: compose
title: Docker Compose
pagination_prev: install/docker
pagination_next: install/configuration
description: Install Unpackerr with Docker Compose!
---

Expand Down
2 changes: 0 additions & 2 deletions docs/install/configuration.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: configuration
title: Application Configuration
pagination_prev: install/choosemethod
pagination_next: unpackerr/troubleshooting
description: Unpackerr configurations explained.
---

Expand Down
2 changes: 0 additions & 2 deletions docs/install/docker.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: docker
title: Docker Basics
pagination_prev: install/choosemethod
pagination_next: install/configuration
description: Install Unpackerr using Docker!
---

Expand Down
2 changes: 0 additions & 2 deletions docs/install/freebsd.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: freebsd
title: FreeBSD
pagination_prev: install/choosemethod
pagination_next: install/configuration
description: Install Unpackerr on a FreeBSD server.
---

Expand Down
2 changes: 0 additions & 2 deletions docs/install/linux.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: linux
title: Linux
pagination_prev: install/choosemethod
pagination_next: install/configuration
description: Install Unpackerr on a Linux server.
---

Expand Down
2 changes: 0 additions & 2 deletions docs/install/macos.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: macos
title: macOS
pagination_prev: install/choosemethod
pagination_next: install/configuration
description: Install Unpackerr on a macOS system.
---

Expand Down
2 changes: 0 additions & 2 deletions docs/install/seedbox.md
Original file line number Diff line number Diff line change
@@ -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.
---

Expand Down
57 changes: 32 additions & 25 deletions docs/install/truenas-scale.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 0 additions & 2 deletions docs/install/unraid.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: unraid
title: unRAID
pagination_prev: install/docker
pagination_next: install/configuration
description: Install Unpackerr on your unRAID server!
---

Expand Down
2 changes: 0 additions & 2 deletions docs/install/windows.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: windows
title: Windows
pagination_prev: install/choosemethod
pagination_next: install/configuration
description: Install Unpackerr on a Windows system.
---

Expand Down
2 changes: 0 additions & 2 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: introduction
title: Introduction
pagination_prev: null
pagination_next: install/choosemethod
description: Introduction and explanation of Unpackerr.
---

Expand Down
41 changes: 41 additions & 0 deletions docs/unpackerr/download-clients.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 0 additions & 2 deletions docs/unpackerr/faq.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: faq
title: FAQs
pagination_prev: introduction
pagination_next: unpackerr/troubleshooting
description: Frequently asked questions about Unpackerr installation and troubleshooting.
---

Expand Down
2 changes: 0 additions & 2 deletions docs/unpackerr/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: troubleshooting
title: Troubleshooting
pagination_prev: unpackerr/faq
pagination_next: downloaders/torrent
description: Tips and Tricks for troubleshooting Unpackerr installations.
---

Expand Down
2 changes: 0 additions & 2 deletions docs/xt.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: xt
title: eXtractor Tool
pagination_prev: null
pagination_next: null
description: Recursively decompress archives
---

Expand Down
12 changes: 9 additions & 3 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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: '<a href="https://golift.io"><img src="https://docs.golift.io/integrations/golift.png" /></a>',
defaultStyle: true,
},
'xt',
],
};

Expand Down
Binary file removed static/img/screenshots/truenas-scale/app-config.png
Binary file not shown.
Binary file removed static/img/screenshots/truenas-scale/app-storage.png
Binary file not shown.
Binary file removed static/img/screenshots/truenas-scale/discover.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading