Skip to content

Commit 3239b82

Browse files
committed
add arch linux installation instructions
1 parent 79d6838 commit 3239b82

File tree

5 files changed

+77
-36
lines changed

5 files changed

+77
-36
lines changed

docs/install/archlinux.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
id: archlinux
3+
title: Arch Linux Install
4+
pagination_prev: install/choosemethod
5+
pagination_next: install/configuration
6+
description: Install Unpackerr on an Arch Linux server.
7+
---
8+
9+
import ArchiveAccess from './includes/archiveaccess.md';
10+
import Permissions from './includes/linuxpermissions.md';
11+
12+
:::info Root Access
13+
This installation method requires root. If you don't have root on your shell,
14+
then check out the <a href="/docs/install/seedbox">non-root directions</a>.
15+
:::
16+
17+
Arch does not use a repository, so binary packages are built and uploaded to GitHub
18+
for each release. Download the `zst` package for your architecture from the
19+
[releases page](https://github.com/Unpackerr/unpackerr/releases/latest)
20+
and install it with `pacman -U <file or url>`. Alternatively, you can build
21+
it yourself using the [public AUR](https://aur.archlinux.org/packages/unpackerr).
22+
23+
If you don't want to bother figuring out which file you need, use the
24+
[install.sh](https://github.com/Unpackerr/unpackerr/blob/main/init/install.sh) script.
25+
It downloads and trusts the [GoLift GPG public key](https://golift.io/gpg) and then
26+
installs the binary Unpackerr package in one command, like this:
27+
28+
```shell
29+
# Pick curl or wget. Run only one of these:
30+
curl -sL https://raw.githubusercontent.com/Unpackerr/unpackerr/main/init/install.sh | sudo bash
31+
wget -qO- https://raw.githubusercontent.com/Unpackerr/unpackerr/main/init/install.sh | sudo bash
32+
```
33+
34+
You can run this script any time to update to the latest version. Run it weekly in cron to keep up to date automatically.
35+
36+
<ArchiveAccess />
37+
38+
## Permissions
39+
40+
<Permissions />
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
On Linux, unpackerr runs as `user:group` `unpackerr:unpackerr`. You will need to give that
2+
user or group read and write access to your archives. That may mean adding the `unpackerr`
3+
user, for example, to the `debian-transmission` group.
4+
You would do that with a command such as `sudo usermod -aG debian-transmission unpackerr`
5+
6+
It's only suggested you do run `usermod` if you know what it does and how to set a umask.
7+
You probably instead want to change the uid and/or gid as shown next.
8+
9+
### Change the uid/gid
10+
11+
If you wish to change the user and/or group that unpackerr runs as you need to do exactly this, **and only this**:
12+
13+
1. Run this command:
14+
- `sudo systemctl edit unpackerr.service`
15+
1. The previous command opens your `$EDITOR` with a commented out version of the unpackerr service unit.
16+
1. Add the following content to the file editor between the comments.
17+
Replace `newuser` and `newgroup` with your new values.
18+
```systemd
19+
[Service]
20+
User=newuser
21+
Group=newgroup
22+
```
23+
1. Run this to read the new systemd service override file:
24+
- `sudo systemctl daemon-reload`
25+
1. Run this to start unpackerr with the new user and group:
26+
- `sudo systemctl restart unpackerr`

docs/install/linux.md

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
11
---
22
id: linux
3-
title: Repository
3+
title: Linux Repository
44
pagination_prev: install/choosemethod
55
pagination_next: install/configuration
66
description: Install Unpackerr on a Linux server.
77
---
88

99
import ArchiveAccess from './includes/archiveaccess.md';
10-
11-
# Linux Repositories
10+
import Permissions from './includes/linuxpermissions.md';
1211

1312
:::info Root Access
1413
This installation method requires root. If you don't have root on your shell,
1514
then check out the <a href="/docs/install/seedbox">non-root directions</a>.
1615
:::
1716

18-
## Install
19-
2017
Linux binaries are distributed through `yum` and `apt` repositories.
2118
Using a repository allows easier upgrades and access to additional software.
2219
Use the command (script) below to automatically install the GoLift repo and
@@ -38,32 +35,7 @@ sudo systemctl restart unpackerr
3835

3936
## Permissions
4037

41-
On Linux, unpackerr runs as `user:group` `unpackerr:unpackerr`. You will need to give that
42-
user or group read and write access to your archives. That may mean adding the `unpackerr`
43-
user, for example, to the `debian-transmission` group.
44-
You would do that with a command such as `sudo usermod -aG debian-transmission unpackerr`
45-
46-
It's only suggested you do run `usermod` if you know what it does and how to set a umask.
47-
You probably instead want to change the uid and/or gid as shown next.
48-
49-
### Change the uid/gid
50-
51-
If you wish to change the user and/or group that unpackerr runs as you need to do exactly this, **and only this**:
52-
53-
1. Make this folder:
54-
- `sudo mkdir -p /etc/systemd/system/unpackerr.service.d/`
55-
1. Make this file:
56-
- `sudo touch /etc/systemd/system/unpackerr.service.d/override.conf`
57-
1. Add the following content to the file. Replace `newuser` and `newgroup` with your new values.
58-
```systemd
59-
[Service]
60-
User=newuser
61-
Group=newgroup
62-
```
63-
1. Run this to read the new systemd service override file:
64-
- `sudo systemctl daemon-reload`
65-
1. Run this to start unpackerr with the new user and group:
66-
- `sudo systemctl restart unpackerr`
38+
<Permissions />
6739

6840
---
6941

docs/install/seedbox.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
22
id: seedbox
3-
title: Seedbox
3+
title: Seedbox Install
44
pagination_prev: install/linux
55
pagination_next: install/configuration
66
description: Install Unpackerr on a Linux server without root.
77
---
88

99
import ArchiveAccess from './includes/archiveaccess.md';
1010

11-
# Linux Seedbox
12-
1311
Learn how to install Unpackerr on your linux shell without root.
1412

1513
1. Download a binary from the [latest release](https://github.com/Unpackerr/unpackerr/releases/latest).
@@ -25,6 +23,8 @@ Learn how to install Unpackerr on your linux shell without root.
2523

2624
<ArchiveAccess />
2725

26+
## Install Script
27+
2828
Here's a simple script that automates the above steps.
2929
You should take some time to understand how [screen](https://wiki.archlinux.org/title/GNU_Screen)
3030
works if you use this solution. Please read and understand what the script does before running it.
@@ -75,7 +75,10 @@ screen -dmS unpackerr $HOME/unpackerr/unpackerr -c $HOME/unpackerr/unpackerr.con
7575
crontab -
7676
```
7777

78-
After you run this script, and exit `nano`, Unpackerr will be running in the background.
78+
After you run this script, and exit `nano` (with `ctrl+x`), Unpackerr will be running in the background.
79+
80+
## Screen Usage
81+
7982
If you're not familiar with `screen`, here's a quick primer:
8083

8184
- Run `screen -r` to re-attach Unpackerr's screen to your terminal.

sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module.exports = {
88
'install/freebsd',
99
'install/macos',
1010
'install/windows',
11-
{"Linux": [ 'install/linux', 'install/seedbox']},
11+
{"Linux": [ 'install/linux', 'install/archlinux', 'install/seedbox']},
1212
'install/configuration',
1313
]
1414
},

0 commit comments

Comments
 (0)