iv-org/documentation
1
0
Fork 0
mirror of https://github.com/iv-org/documentation.git synced 2025-01-18 10:37:12 -05:00
Code Issues Packages Projects Releases Wiki Activity

add part about cache directory permissions + rename companion container name

Browse Source
This commit is contained in:
Émilien (perso) 2024-12-25 09:35:35 +00:00 committed by GitHub
parent b09c0beaf7
commit e4b7a0cf48
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/companion-installation.md
View File

@ -42,7 +42,13 @@ Make sure to run the newer Docker Compose V2: https://docs.docker.com/compose/in
cd invidious cd invidious
``` ```
2. Edit the docker-compose.yml with this content: 2. Assign the correct permissions to Invidious companion for the cache directory:
```bash
mkdir -p /var/tmp/youtubei.js
chown 10001:10001 -R /var/tmp/youtubei.js
```
3. Edit the docker-compose.yml with this content:
```docker ```docker
version: "3" version: "3"
@ -52,6 +58,7 @@ Make sure to run the newer Docker Compose V2: https://docs.docker.com/compose/in
image: quay.io/invidious/invidious:companion image: quay.io/invidious/invidious:companion
# image: quay.io/invidious/invidious:companion-arm64 # ARM64/AArch64 devices # image: quay.io/invidious/invidious:companion-arm64 # ARM64/AArch64 devices
restart: unless-stopped restart: unless-stopped
# Remove "127.0.0.1:" if used from an external IP
ports: ports:
- "127.0.0.1:3000:3000" - "127.0.0.1:3000:3000"
environment: environment:
@ -68,7 +75,7 @@ Make sure to run the newer Docker Compose V2: https://docs.docker.com/compose/in
check_tables: true check_tables: true
invidious_companion: invidious_companion:
# URL used for the internal communication between invidious and invidious companion # URL used for the internal communication between invidious and invidious companion
- private_url: "http://invidious_companion:8282/" - private_url: "http://companion:8282/"
# (public) URL used for the communication between your browser and invidious companion # (public) URL used for the communication between your browser and invidious companion
# IF you are using a reverse proxy OR accessing invidious from an external IP then you NEED to change this value # IF you are using a reverse proxy OR accessing invidious from an external IP then you NEED to change this value
# Please consult for more doc: https://github.com/unixfox/invidious/blob/invidious-companion/config/config.example.yml#L57-L88 # Please consult for more doc: https://github.com/unixfox/invidious/blob/invidious-companion/config/config.example.yml#L57-L88
@ -92,7 +99,7 @@ Make sure to run the newer Docker Compose V2: https://docs.docker.com/compose/in
depends_on: depends_on:
- invidious-db - invidious-db
invidious_companion: companion:
image: quay.io/invidious/invidious-companion:latest image: quay.io/invidious/invidious-companion:latest
environment: environment:
- SERVER_SECRET_KEY=CHANGE_ME!!SAME_AS_INVIDIOUS_COMPANION_SECRET_KEY_FROM_INVIDIOUS_CONFIG - SERVER_SECRET_KEY=CHANGE_ME!!SAME_AS_INVIDIOUS_COMPANION_SECRET_KEY_FROM_INVIDIOUS_CONFIG
@ -100,6 +107,7 @@ Make sure to run the newer Docker Compose V2: https://docs.docker.com/compose/in
# Please consult for more doc: https://github.com/iv-org/invidious-companion/wiki/Environment-variables # Please consult for more doc: https://github.com/iv-org/invidious-companion/wiki/Environment-variables
# - SERVER_BASE_URL=http://localhost:8282 # - SERVER_BASE_URL=http://localhost:8282
restart: unless-stopped restart: unless-stopped
# Remove "127.0.0.1:" if used from an external IP
ports: ports:
- "127.0.0.1:8282:8282" - "127.0.0.1:8282:8282"
logging: logging:
@ -136,7 +144,7 @@ Make sure to run the newer Docker Compose V2: https://docs.docker.com/compose/in
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. 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.
3. Run the docker composition: 4. Run the docker composition:
``` ```
docker compose up -d docker compose up -d