Backup_Repos/komga
1
0
Fork 0
mirror of https://github.com/gotson/komga.git synced 2025-12-06 08:32:25 +01:00
Code Issues Projects Releases Wiki Activity

update docker documentation to use --mount instead of -v for docker, and long syntax for docker-compose volumes, so that the /config directory is not created by root if missing [travis skip]

Browse source
This commit is contained in:
Gauthier Roebroeck 2019-10-23 12:47:07 +08:00
parent c6d9fd1b22
commit 642f7dae54
1 changed files with 20 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
DOCKERHUB.md
View file

@ -28,8 +28,8 @@ docker create \
--user 1000:1000 \
-p 8080:8080 \
-e KOMGA_LIBRARIES_SCAN_DIRECTORY_EXCLUSIONS=#recycle,@eaDir
-v path/to/data:/config \
-v path/to/books:/books \
--mount type=bind,source=/path/to/config,target=/config \
--mount type=bind,source=/path/to/books,target=/books \
--restart unless-stopped \
gotson/komga
```
@ -38,15 +38,22 @@ docker create \
```
---
version: '3'
version: '3.3'
services:
komga:
image: gotson/komga
container_name: komga
volumes:
- path/to/data:/config
- path/to/books:/books
- /etc/timezone:/etc/timezone:ro
- type: bind
source: /path/to/data
target: /config
- type: bind
source: /path/to/books
target: /books
- type: bind
source: /etc/timezone
target: /etc/timezone
read_only: true
ports:
- 8080:8080
user: "1000:1000"
@ -61,13 +68,13 @@ Container images are configured using parameters passed at runtime (such as thos
These parameters are separated by a colon and indicate `external:internal` respectively.
For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
| Parameter | Function |
|:----------------------------------------------:|-----------------------------------------------------------------------|
| `-p 8080` | The port for the Komga APIs and web interface |
| `--user: 1000:1000` | User:Group identifier - see below for explanation |
| `-v /config` | Database and Komga configurations |
| `-v /books` | Location of books library on disk |
| `-e KOMGA_LIBRARIES_SCAN_DIRECTORY_EXCLUSIONS` | Comma-separated list of patterns to exclude directories from the scan |
| Parameter | Function |
|:---------------------------------------------------------:|-----------------------------------------------------------------------|
| `-p 8080` | The port for the Komga APIs and web interface |
| `--user: 1000:1000` | User:Group identifier - see below for explanation |
| `--mount type=bind,source=/path/to/config,target=/config` | Database and Komga configurations |
| `--mount type=bind,source=/path/to/books,target=/books` | Location of books library on disk |
| `-e KOMGA_LIBRARIES_SCAN_DIRECTORY_EXCLUSIONS` | Comma-separated list of patterns to exclude directories from the scan |
## User / Group Identifiers