Skip to content

Commit 72849d1

Browse files
committed
compose updates
1 parent b533d7f commit 72849d1

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

docs/install/compose.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ docker-compose up -d
1919
```
2020

2121
Here's an example minimal compose file. This works, and all the defaults should work for you too.
22-
Set `PUID`, `PGID` and `TZ` in your compose `.env` for this example to work correctly.
22+
The [`user:` parameter](https://docs.docker.com/compose/compose-file/05-services/#user) controls
23+
the uid and gid that the app runs as. The default is root if you don't include it.
24+
25+
Find your [TZ identifier here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
2326

2427
```yaml
2528
services:
@@ -29,17 +32,23 @@ services:
2932
volumes:
3033
- /mnt/storage/downloads:/downloads
3134
restart: always
32-
user: ${PUID}:${PGID}
35+
user: 1001:100
3336
environment:
34-
- TZ=${TZ}
37+
- TZ=America/New_York
3538
- UN_LOG_FILE=/downloads/unpackerr.log
3639
- UN_SONARR_0_URL=http://sonarr:8989
3740
- UN_SONARR_0_API_KEY=32coolcatcharacters
3841
- UN_RADARR_0_URL=http://radarr:7878
3942
- UN_RADARR_0_API_KEY=32coolkatcharacters
4043
```
4144
42-
# Data Mount
45+
And if you're trying to watch a folder, add this `environment:` variable with your folder:
46+
47+
```
48+
- UN_FOLDER_0_PATH=/downloads/autoxtract
49+
```
50+
51+
## Data Mount
4352
4453
:::info Data Mount
4554
The `/data` or `/downloads` mount you use for Starr apps should be set the same for Unpackerr.
@@ -63,7 +72,7 @@ existing compose; look for `volumes:`. One of these volumes is your download mou
6372

6473
Simply copy the downloads storage volume from your Starr apps or download client to Unpackerr.
6574

66-
# Log File
75+
## Log File
6776

6877
**Set a log file.** You'll need it to figure out what Unpackerr did. Put it in your download location.
6978
Example:
@@ -76,7 +85,7 @@ Example:
7685
Replace `/downloads/unpackerr.log` with `/data/unpackerr.log` if you mounted `/data` in `volumes:`.
7786
Or whatever download path you mounted; just put it there for ease of finding it.
7887

79-
# More Notes
88+
## More Notes
8089

8190
:::warning Security Opts
8291
Do not include this in your compose. It will make Unpackerr not work properly. If you know how
@@ -88,7 +97,7 @@ to adjust caps, go for it, but please don't ask for help without removing this f
8897
```
8998
:::
9099

91-
# Config File
100+
## Config File
92101

93102
_Very Optional:_
94103

0 commit comments

Comments
 (0)