Skip to content

Commit 5bf9a35

Browse files
authored
Merge pull request #51 from Unpackerr/docs/xt-page
Add xt documentation page
2 parents ad83012 + 0d60690 commit 5bf9a35

35 files changed

Lines changed: 325 additions & 200 deletions

‎docs/downloaders/torrent.md‎

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,8 @@
11
---
22
id: torrent
33
title: Torrent Downloaders
4-
pagination_prev: unpackerr/troubleshooting
5-
pagination_next: downloaders/usenet
6-
description: Information about torrent downloaders.
4+
unlisted: true
5+
description: Moved to Download Clients.
76
---
87

9-
# Torrent Downloaders
10-
11-
Find information about Torrent download clients on this page. It's a bit sparse, so please help us
12-
[edit this page](https://github.com/Unpackerr/unpackerr.github.io/blob/main/docs/downloaders/torrent.md).
13-
14-
## qBittorrent
15-
16-
## Deluge
17-
18-
## Transmission
19-
20-
## rTorrent
21-
22-
## uTorrent
8+
This page moved to [Download Clients](/docs/unpackerr/download-clients).

‎docs/downloaders/usenet.md‎

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,8 @@
11
---
22
id: usenet
33
title: Usenet Downloaders
4-
pagination_prev: downloaders/torrent
5-
pagination_next: introduction
6-
description: Information about usenet downloaders.
4+
unlisted: true
5+
description: Moved to Download Clients.
76
---
87

9-
# Usenet Downloaders
10-
11-
Find information about Usenet download clients on this page. It's a bit sparse, so please help us
12-
[edit this page](https://github.com/Unpackerr/unpackerr.github.io/blob/main/docs/downloaders/usenet.md).
13-
14-
## SABnzbd
15-
16-
Generally Unpackerr is not required for Sabnzbd.
17-
18-
- Navigate to [Job Actions](https://sabnzbd.org/wiki/extra/job-options) in [Categories](https://sabnzbd.org/wiki/configuration/4.2/categories)
19-
- Set the value to `+Unpack` or `+Delete`
20-
21-
## NZBGet
22-
23-
This is depressing, but...NZBGet is no longer developed.
24-
25-
## Easynews
26-
27-
Nothing here yet.
28-
29-
## Newsleecher
30-
31-
This is empty... :(
32-
33-
## Newsbin Pro
34-
35-
Yup, also empty.
8+
This page moved to [Download Clients](/docs/unpackerr/download-clients).

‎docs/install/archlinux.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
id: archlinux
33
title: Arch Linux
4-
pagination_prev: install/choosemethod
5-
pagination_next: install/configuration
64
description: Install Unpackerr on an Arch Linux server.
75
---
86

‎docs/install/choosemethod.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
22
id: choosemethod
33
title: Choose Install Method
4-
pagination_prev: introduction
5-
pagination_next: null
64
description: Choose an Unpackerr install method.
75
---
86

9-
We recommended to installing Unpackerr the same way you installed your
7+
We recommend installing Unpackerr the same way you installed your
108
Starr or download apps. If your existing infrastructure exists in Docker,
119
then Unpackerr should probably live in Docker too.
1210

@@ -17,14 +15,16 @@ reside. Read more about that on the [Docker page](docker#folder-watcher).
1715
## Instructions Available
1816

1917
- [Docker](/docs/install/docker): [Compose](/docs/install/compose),
20-
[unRAID](/docs/install/unraid), [TrueNAS Scale](/docs/install/truenas-scale)
18+
[unRAID](/docs/install/unraid), [TrueNAS](/docs/install/truenas-scale)
2119
- [FreeBSD](/docs/install/freebsd)
2220
- [Linux: with root](/docs/install/linux), [without root / seedbox](/docs/install/seedbox)
2321
- [macOS](/docs/install/macos)
2422
- [Windows](/docs/install/windows)
2523

24+
Need a one-shot command-line extractor instead of a daemon? See [xt](/docs/xt).
25+
2626
:::tip[CPU Hog]
27-
Unpackerr uses a lot CPU while extracting, and tends not to work well when
27+
Unpackerr uses a lot of CPU while extracting, and tends not to work well when
2828
running on smaller systems like Synology NAS devices. Running Unpackerr on
2929
a system with a large CPU is ideal to avoid system performance degradation.
3030
The application uses only a few CPU cycles at idle to poll Starr apps and/or

‎docs/install/compose.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
id: compose
33
title: Docker Compose
4-
pagination_prev: install/docker
5-
pagination_next: install/configuration
64
description: Install Unpackerr with Docker Compose!
75
---
86

@@ -18,9 +16,11 @@ import DataMount from './includes/dockerdatamount.md';
1816
- Then start it, like this:
1917

2018
```shell
21-
docker-compose up -d
19+
docker compose up -d
2220
```
2321

22+
Compose V1 used `docker-compose` (hyphen). Compose V2 is `docker compose` (space).
23+
2424
Here's an example minimal compose file. This works well, and all the defaults should work for you too.
2525
The [`user:` parameter](https://docs.docker.com/compose/compose-file/05-services/#user) controls
2626
the uid and gid that the app runs as. The default is root if you don't include it, but you should definitely

‎docs/install/configuration.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
id: configuration
33
title: Application Configuration
4-
pagination_prev: install/choosemethod
5-
pagination_next: unpackerr/troubleshooting
64
description: Unpackerr configurations explained.
75
---
86

@@ -18,7 +16,7 @@ and [example config](https://github.com/Unpackerr/unpackerr/blob/main/examples/u
1816

1917
## Config
2018

21-
- Setting a log file is strongly recommend. This makes it much easier to troubleshoot problems.
19+
- Setting a log file is strongly recommended. This makes it much easier to troubleshoot problems.
2220
- To use a config file in Docker, mount `/config` to the container and Unpackerr will write a config file.
2321
- Update the new file at `/config/unpackerr.conf` and restart the container.
2422
- When using a config file you must uncomment at minimum the `[[header]]` <font color="gray">
@@ -42,7 +40,7 @@ add another `[[header]]` <font color="gray">ex. `[[sonarr]]`</font> and the
4240
`url`/`api_key`/etc under it. When adding a second instance to the __environment
4341
variables__, you must increment the `0` to a `1`. And to a `2` if you have 3
4442
instances. There is no limit to the number of supported instances. This notation
45-
works for all starr apps, folders, command hooks, and web hooks.
43+
works for all Starr apps, folders, command hooks, and webhooks.
4644

4745
<details>
4846
<summary>Config examples with multiple instances.</summary>
@@ -121,12 +119,12 @@ _<font color="gray">This feature was added in Unpackerr v0.14.0.</font>_
121119

122120
## Event IDs
123121

124-
Event IDs are needed/used in command hooks and webhooks.
122+
Event IDs are used in command hooks and webhooks.
125123

126124
`0` = all, `1` = queued, `2` = extracting, `3` = extract failed, `4` = extracted,
127125
`5` = imported, `6` = deleting, `7` = delete failed, `8` = deleted, `9` = nothing extracted
128126

129-
The 'nothing extracted' event (9) only fires for the folder watcher, not starr apps.
127+
The `nothing extracted` event (`9`) only fires for the folder watcher, not Starr apps.
130128

131129
---
132130

‎docs/install/docker.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
id: docker
33
title: Docker Basics
4-
pagination_prev: install/choosemethod
5-
pagination_next: install/configuration
64
description: Install Unpackerr using Docker!
75
---
86

@@ -23,8 +21,8 @@ GoLift software has a [Docker Open Source Sponsorship](https://docs.docker.com/t
2321
That means there are **no pull limits for any [`golift/*` image on Docker Hub](https://hub.docker.com/u/golift).**
2422
Even if you're not logged in.
2523

26-
This project builds automatically in [Docker Cloud](https://hub.docker.com/r/golift/unpackerr) and creates
27-
[ready-to-use multi-architecture images](https://hub.docker.com/r/golift/unpackerr/tags) images.
24+
This project builds automatically on [Docker Hub](https://hub.docker.com/r/golift/unpackerr) and creates
25+
[ready-to-use multi-architecture images](https://hub.docker.com/r/golift/unpackerr/tags).
2826
The `latest` tag is always a [tagged release on GitHub](https://github.com/Unpackerr/unpackerr/releases).
2927

3028
- Pull the DockerHub image with this command:
@@ -49,7 +47,7 @@ The `latest` tag is always a [tagged release on GitHub](https://github.com/Unpac
4947
```shell
5048
docker pull golift/unpackerr
5149
docker run -d -v /mnt/HostDownloads:/downloads \
52-
-e "UN_SONARR_0_URL=http://localhost:8989" \
50+
-e "UN_SONARR_0_URL=http://sonarr:8989" \
5351
-e "UN_SONARR_0_API_KEY=kjsdkasjdaksdj" golift/unpackerr
5452
docker logs <container id from docker run>
5553
```
@@ -84,7 +82,7 @@ The `golift` docker container runs as uid 0 (root) by default. This is probably
8482
Make sure to set the correct uid and gid with the `--user` parameter. Example:
8583

8684
```bash
87-
# This commands runs golift/unpackerr with UID 1000 and GID 100.
85+
# This command runs golift/unpackerr with UID 1000 and GID 100.
8886
docker run --user 1000:100 -d -v /mnt/data:/data -v /mnt/config:/config golift/unpackerr
8987
```
9088

@@ -97,12 +95,12 @@ Find examples in the [Docker Compose instruction](compose).
9795
### Hotio
9896

9997
The primary difference between the golift and hotio containers is how you set the uid and gid.
100-
Hotio does not user the `--user` parameter and instead sets the UID and GID with environment
98+
Hotio does not use the `--user` parameter and instead sets the UID and GID with environment
10199
variables. *Passing the `--user` parameter to the hotio container will render it inoperable.*
102100
Pass the `PUID` and `PGID` environment variables when using hotio's container. Example:
103101

104102
```bash
105-
# This commands runs hotio/unpackerr with UID 1000 and GID 100.
103+
# This command runs hotio/unpackerr with UID 1000 and GID 100.
106104
docker run -e PUID=1000 -e PGID=100 -d -v /mnt/data:/data -v /mnt/config:/config hotio/unpackerr
107105
```
108106

‎docs/install/freebsd.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
id: freebsd
33
title: FreeBSD
4-
pagination_prev: install/choosemethod
5-
pagination_next: install/configuration
64
description: Install Unpackerr on a FreeBSD server.
75
---
86

97
import ArchiveAccess from './includes/archiveaccess.md';
108

119
1. Download a package from the [latest release](https://github.com/Unpackerr/unpackerr/releases/latest).
12-
1. Install it with `pkg add -f` (the force flag is required because the package has
13-
[a bug](https://github.com/Unpackerr/unpackerr/issues/352))
10+
1. Install it with `pkg add`. Older packages were labeled with the wrong architecture
11+
([issue 352](https://github.com/Unpackerr/unpackerr/issues/352)); if `pkg` refuses
12+
the file, use `pkg add -f`.
1413
1. Edit the config file at `/etc/unpackerr/unpackerr.conf`,
1514
or [generate one](https://notifiarr.com/unpackerr) and start it.
1615
1. Not many folks use FreeBSD, but we can try to help if you drop by the [Discord](https://golift.io/discord).

‎docs/install/includes/linuxpermissions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ user or group read and write access to your archives. That may mean adding the `
33
user, for example, to the `debian-transmission` group.
44
You would do that with a command such as `sudo usermod -aG debian-transmission unpackerr`
55

6-
It's only suggested you do run `usermod` if you know what it does and how to set a umask.
6+
Only run `usermod` if you know what it does and how to set a umask.
77
You probably instead want to change the uid and/or gid as shown next.
88

99
### Change the uid/gid

‎docs/install/linux.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
id: linux
3-
title: Repository
4-
pagination_prev: install/choosemethod
5-
pagination_next: install/configuration
3+
title: Linux
64
description: Install Unpackerr on a Linux server.
75
---
86

0 commit comments

Comments
 (0)