Skip to content

Commit e4b7a0c

Browse files
authored
add part about cache directory permissions + rename companion container name
1 parent b09c0be commit e4b7a0c

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/companion-installation.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,13 @@ Make sure to run the newer Docker Compose V2: https://docs.docker.com/compose/in
4242
cd invidious
4343
```
4444

45-
2. Edit the docker-compose.yml with this content:
45+
2. Assign the correct permissions to Invidious companion for the cache directory:
46+
```bash
47+
mkdir -p /var/tmp/youtubei.js
48+
chown 10001:10001 -R /var/tmp/youtubei.js
49+
```
50+
51+
3. Edit the docker-compose.yml with this content:
4652

4753
```docker
4854
version: "3"
@@ -52,6 +58,7 @@ Make sure to run the newer Docker Compose V2: https://docs.docker.com/compose/in
5258
image: quay.io/invidious/invidious:companion
5359
# image: quay.io/invidious/invidious:companion-arm64 # ARM64/AArch64 devices
5460
restart: unless-stopped
61+
# Remove "127.0.0.1:" if used from an external IP
5562
ports:
5663
- "127.0.0.1:3000:3000"
5764
environment:
@@ -68,7 +75,7 @@ Make sure to run the newer Docker Compose V2: https://docs.docker.com/compose/in
6875
check_tables: true
6976
invidious_companion:
7077
# URL used for the internal communication between invidious and invidious companion
71-
- private_url: "http://invidious_companion:8282/"
78+
- private_url: "http://companion:8282/"
7279
# (public) URL used for the communication between your browser and invidious companion
7380
# IF you are using a reverse proxy OR accessing invidious from an external IP then you NEED to change this value
7481
# Please consult for more doc: https://github.com/unixfox/invidious/blob/invidious-companion/config/config.example.yml#L57-L88
@@ -92,14 +99,15 @@ Make sure to run the newer Docker Compose V2: https://docs.docker.com/compose/in
9299
depends_on:
93100
- invidious-db
94101
95-
invidious_companion:
102+
companion:
96103
image: quay.io/invidious/invidious-companion:latest
97104
environment:
98105
- SERVER_SECRET_KEY=CHANGE_ME!!SAME_AS_INVIDIOUS_COMPANION_SECRET_KEY_FROM_INVIDIOUS_CONFIG
99106
# SET this value IF you are using a reverse proxy OR accessing invidious from an external IP.
100107
# Please consult for more doc: https://github.com/iv-org/invidious-companion/wiki/Environment-variables
101108
# - SERVER_BASE_URL=http://localhost:8282
102109
restart: unless-stopped
110+
# Remove "127.0.0.1:" if used from an external IP
103111
ports:
104112
- "127.0.0.1:8282:8282"
105113
logging:
@@ -136,7 +144,7 @@ Make sure to run the newer Docker Compose V2: https://docs.docker.com/compose/in
136144

137145
Note: This compose is made for a true "production" setup, where Invidious is behind a reverse proxy. If you prefer to directly access Invidious, replace `127.0.0.1:3000:3000` with `3000:3000` under the `ports:` section.
138146

139-
3. Run the docker composition:
147+
4. Run the docker composition:
140148

141149
```
142150
docker compose up -d

0 commit comments

Comments
 (0)