Skip to content

Commit 684117c

Browse files
committed
update docker docs
1 parent 681f315 commit 684117c

File tree

2 files changed

+38
-27
lines changed

2 files changed

+38
-27
lines changed

docs/install/choosemethod.md

Lines changed: 15 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,31 @@ pagination_next: null
66
description: Choose an Unpackerr install method.
77
---
88

9-
It's generally recommended to install Unpackerr the same way you installed your
10-
Starr or download apps. If your existing infrastructure exists in Docker, then
11-
Unpackerr should probably live in Docker too.
9+
We recommended to installing Unpackerr the same way you installed your
10+
Starr or download apps. If your existing infrastructure exists in Docker,
11+
then Unpackerr should probably live in Docker too.
1212

1313
If you're using the **Folder Watch** feature, then we recommend installing
1414
Unpackerr native (not Docker) on the server where the files-to-be-extracted
15-
reside.
16-
17-
:::caution Docker Folder Watcher
18-
The Folder Watch feature uses `inotify` (a.k.a. `fsnotify`) to identify
19-
changes to the folder. A folder-poller is automatically started when run in
20-
Docker because `inotify` is unreliable.
21-
22-
Watching folders in Docker will cause Unpackerr to constantly poll the
23-
watched-folder for changes. Unpackerr cannot determine when a download is
24-
finished downloading while running in Docker because `inotify` is not reliable.
25-
Make sure to set the `start_delay` high enough to avoid beginning extractions
26-
while files are still being downloaded.
27-
28-
**Alternatively, run Unpackerr as a native service instead of in Docker.**
29-
:::
15+
reside. Read more about that on the [Docker page](docker#folder-watcher).
3016

3117
## Instructions Available
3218

33-
:::tip CPU Hog
34-
Unpackerr uses a lot CPU, and tends not to work well when running on smaller systems like Synology NAS devices.
35-
Running Unpackerr on a system with a large CPU is ideal to avoid system performance degradation.
36-
:::
37-
38-
- [Docker](/docs/install/docker): [Compose](/docs/install/compose), [unRAID](/docs/install/unraid),
39-
[TrueNAS Scale](/docs/install/truenas-scale)
19+
- [Docker](/docs/install/docker): [Compose](/docs/install/compose),
20+
[unRAID](/docs/install/unraid), [TrueNAS Scale](/docs/install/truenas-scale)
4021
- [FreeBSD](/docs/install/freebsd)
41-
- [Linux: with root](/docs/install/linux), [without root (seedbox)](/docs/install/seedbox)
22+
- [Linux: with root](/docs/install/linux), [without root / seedbox](/docs/install/seedbox)
4223
- [macOS](/docs/install/macos)
4324
- [Windows](/docs/install/windows)
4425

26+
:::tip CPU Hog
27+
Unpackerr uses a lot CPU while extracting, and tends not to work well when
28+
running on smaller systems like Synology NAS devices. Running Unpackerr on
29+
a system with a large CPU is ideal to avoid system performance degradation.
30+
The application uses only a few CPU cycles at idle to poll Starr apps and/or
31+
watch folders.
32+
:::
33+
4534
---
4635

4736
## Other Guides

docs/install/docker.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ also mount `/mnt/storage/downloads:/downloads` on your Unpackerr container. If y
3333
**Make sure Unpackerr can find the downloads in the same place that Sonarr and Radarr find them.**
3434
:::
3535

36-
## Docker Example with config file
36+
## Example with config file
3737

3838
- Copy the [example config file](https://github.com/Unpackerr/unpackerr/blob/main/examples/unpackerr.conf.example)
3939
from the repo, or [generate one](https://notifiarr.com/unpackerr.php).
@@ -67,6 +67,12 @@ Make sure to set the correct uid and gid with the `--user` parameter. Example:
6767
docker run --user 1000:100 -d -v /mnt/data:/data -v /mnt/config:/config golift/unpackerr
6868
```
6969

70+
**Replace 1000:100 with the correct uid:gid for your environment.**
71+
One of them must provide write access to your archives.
72+
73+
When using compose, add `user: 1000:100` to the service definition.
74+
Find examples in the [Docker Compose instruction](compose).
75+
7076
### Hotio
7177

7278
The primary difference between the golift and hotio containers is how you set the uid and gid.
@@ -78,3 +84,19 @@ Pass the `PUID` and `PGID` environment variables when using hotio's container. E
7884
# This commands runs hotio/unpackerr with UID 1000 and GID 100.
7985
docker run -e PUID=1000 -e PGID=100 -d -v /mnt/data:/data -v /mnt/config:/config hotio/unpackerr
8086
```
87+
88+
## Folder Watcher
89+
90+
Watching folders in Docker will cause Unpackerr to constantly poll the
91+
watched-folder for changes at a default rate of `1s` (1 second).
92+
93+
The Folder Watch feature uses `inotify` (a.k.a. `fsnotify`) to identify
94+
changes to the watched folder. A folder-poller is automatically started when
95+
run in Docker because `inotify` is unreliable. Disable the folder poller
96+
(and rely on `inotify` only) by setting `folders.interval` to `1ms`.
97+
98+
If Unpackerr has trouble determining when downloads are finished, set
99+
`start_delay` high enough to avoid beginning extracting files that are
100+
still being transferred.
101+
102+
**Alternatively, run Unpackerr as a native service instead of in Docker.**

0 commit comments

Comments
 (0)