Skip to content

Commit b533d7f

Browse files
committed
more updaes
1 parent 38fb47e commit b533d7f

File tree

6 files changed

+27
-33
lines changed

6 files changed

+27
-33
lines changed

docs/install/compose.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Replace `/downloads/unpackerr.log` with `/data/unpackerr.log` if you mounted `/d
7777
Or whatever download path you mounted; just put it there for ease of finding it.
7878

7979
# More Notes
80+
8081
:::warning Security Opts
8182
Do not include this in your compose. It will make Unpackerr not work properly. If you know how
8283
to adjust caps, go for it, but please don't ask for help without removing this first:
@@ -99,4 +100,4 @@ folder on the left side.
99100
```yaml
100101
volumes:
101102
- /mnt/appdata/unpackerr:/config
102-
```
103+
```

docs/install/freebsd.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,16 @@ description: Install Unpackerr on a FreeBSD server.
99
import ArchiveAccess from './includes/archiveaccess.md';
1010

1111
1. Download a package from the [Releases](https://github.com/Unpackerr/unpackerr/releases) page.
12-
1. Install it, edit config, start it.
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))
14+
1. Edit the config file at `/etc/unpackerr/unpackerr.conf`,
15+
or [generate one](https://notifiarr.com/unpackerr.php) and start it.
1316
1. Not many folks use FreeBSD, but we can try to help if you drop by the [Discord](https://golift.io/discord).
1417

1518
<ArchiveAccess />
1619

1720
## Permissions
1821

19-
On FreeBSD the app runs as `nobody`. That's not very good and will probably change in the future.
22+
On FreeBSD the app runs as user `nobody`. That's not very good and will probably change in the future.
23+
If you know how to change it, please
24+
[let me know](https://github.com/Unpackerr/unpackerr/issues/new) so we can update this page.

docs/install/includes/archiveaccess.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:::caution Archive Access
2-
Requires access to your download location.
2+
Unpackerr requires write access to your download location.
33
Make sure you set the `path` variables correctly in the configuration.
44
Even if they're set incorrectly Unpackerr makes a best effort attempt
55
to locate your downloads. If it can't find your downloads, then the

docs/install/linux.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ unpackerr in one command.
2626
curl -s https://golift.io/repo.sh | sudo bash -s - unpackerr
2727
```
2828

29-
After install, edit the config file and start the service:
29+
After install, edit the config file, or
30+
[generate one](https://notifiarr.com/unpackerr.php) and start the service:
3031

3132
```shell
3233
sudo nano /etc/unpackerr/unpackerr.conf
@@ -42,20 +43,27 @@ user or group read and write access to your archives. That may mean adding the `
4243
user, for example, to the `debian-transmission` group.
4344
You would do that with a command such as `sudo usermod -aG debian-transmission unpackerr`
4445

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+
4549
### Change the uid/gid
4650

4751
If you wish to change the user and/or group that unpackerr runs as you need to do exactly this, **and only this**:
4852

49-
1. Make this folder: `sudo mkdir -p /etc/systemd/system/unpackerr.service.d/`
50-
1. Make this file: `sudo touch /etc/systemd/system/unpackerr.service.d/override.conf`
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`
5157
1. Add the following content to the file. Replace `newuser` and `newgroup` with your new values.
5258
```systemd
5359
[Service]
5460
User=newuser
5561
Group=newgroup
5662
```
57-
1. Run `sudo systemctl daemon-reload` to re-read this new config file.
58-
1. Run `sudo systemctl restart unpackerr` to start unpackerr with the new ID(s).
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`
5967

6068
---
6169

docs/install/macos.md

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,9 @@ description: Install Unpackerr on a macOS system.
88

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

11-
## Brew
12-
13-
1. Use homebrew.
14-
1. Edit config file at `/usr/local/etc/unpackerr/unpackerr.conf`
15-
1. Start it.
16-
1. Like this:
17-
18-
```shell
19-
brew install golift/mugs/unpackerr
20-
vi /usr/local/etc/unpackerr/unpackerr.conf
21-
brew services start unpackerr
22-
```
23-
24-
The `brew services start` command will signal brew to start Unpackerr every time you login.
25-
2611
<ArchiveAccess />
2712

28-
## App
29-
30-
You can also use a GUI app on a Mac instead of CLI via Homebrew:
31-
32-
:::info brew vs app
33-
The `.app` and the Homebrew version are the same application, but one runs in GUI mode and one does not.
34-
:::
13+
## Universal Binary App
3514

3615
1. Download a `.dmg` file from
3716
[the Releases page](https://github.com/Unpackerr/unpackerr/releases) and double-click it.

docs/install/windows.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,16 @@ A default Windows install runs from `C:\`; if you installed Windows in another l
1515
:::
1616

1717
- Browse to `C:\ProgramData` and create a folder named `unpackerr` and then inside that create a `logs` directory.
18-
- Enable hidden files and folders if you dont see `C:\ProgramData`.
18+
- Enable hidden files and folders if you don't see `C:\ProgramData`.
1919
- End result: `C:\ProgramData\unpackerr` and `C:\ProgramData\unpackerr\logs`
2020
- Extract a `.exe.zip` file from [the Releases page](https://github.com/Unpackerr/unpackerr/releases)
2121
into `C:\ProgramData\unpackerr\`.
2222
- Run the `unpackerr.amd64.exe` binary. This starts the app in the system tray.
2323
- Click the systray icon and select `Config` -> `Edit`.
2424
- Uncomment `log_file` (remove the `#`) and set it as shown here:
2525
- `log_file = 'C:\ProgramData\unpackerr\logs\unpackerr.log'`
26-
- Edit the rest of the config to suit your system and save the file.
26+
- Edit the rest of the config to suit your system,
27+
or [generate one](https://notifiarr.com/unpackerr.php) and save the file.
2728
- Click the systray icon again and select `Quit`. Then open the app again.
2829
- View the logs by clicking the systray icon and `Logs` -> `View`.
2930
- Make a shortcut to the application in your Startup menu to run it when you login.

0 commit comments

Comments
 (0)