Ivan Schaller
b7ff17f35b
Some checks failed
ci/woodpecker/pr/test_tox_amd64 Pipeline is pending
ci/woodpecker/push/tests Pipeline failed
ci/woodpecker/pr/tests Pipeline failed
ci/woodpecker/pr/test_tox_arm64 unknown status
ci/woodpecker/pr/test_docker_amd64 unknown status
ci/woodpecker/pr/test_release unknown status
ci/woodpecker/pr/test_docker_arm64 unknown status
146 lines
5.4 KiB
Markdown
146 lines
5.4 KiB
Markdown
# Docker container of manga-dlp
|
|
|
|
## Quick start
|
|
|
|
> the pdf creation only works on amd64 images, as it unfortunately is incompatible with arm64.
|
|
|
|
```sh
|
|
# with docker-compose
|
|
curl -O docker-compose.yml https://raw.githubusercontent.com/olofvndrhr/manga-dlp/master/docker/docker-compose.yml
|
|
# adjust settings to your needs
|
|
docker-compose up -d
|
|
|
|
# with docker run
|
|
docker run -v ./downloads:/app/downloads -v ./mangas.txt:/app/mangas.txt olofvndrhr/manga-dlp
|
|
```
|
|
|
|
## Change UID/GID
|
|
|
|
> The default UID and GID are 4444.
|
|
|
|
You can change the UID and GID of the container user simply with:
|
|
|
|
```yml
|
|
# docker-compose.yml
|
|
environment:
|
|
- PUID=<userid>
|
|
- PGID=<groupid>
|
|
```
|
|
|
|
```sh
|
|
docker run -e PUID=<userid> -e PGID=<groupid>
|
|
```
|
|
|
|
## Environment variables
|
|
|
|
You can configure the default schedule via environment variables. Don't forget to set `MDLP_GENERATE_SCHEDULE` to "true"
|
|
, else
|
|
it will not generate it (it will just use the default one).
|
|
|
|
For more info's about the options, you can look in the main scripts [README.md](../)
|
|
|
|
| ENV Variable | Default | manga-dlp option | Info |
|
|
|:-----------------------|:----------------|:------------------------------------|--------------------------------------------------------------------------|
|
|
| MDLP_GENERATE_SCHEDULE | false | none | Has to be set to "true" to generate the config via environment variables |
|
|
| MDLP_PATH | /app/downloads | --path | |
|
|
| MDLP_READ | /app/mangas.txt | --read | |
|
|
| MDLP_LANGUAGE | en | --language | |
|
|
| MDLP_CHAPTERS | all | --chapter | |
|
|
| MDLP_FILE_FORMAT | cbz | --format | |
|
|
| MDLP_WAIT | 0.5 | --wait | |
|
|
| MDLP_FORCEVOL | false | --forcevol | |
|
|
| MDLP_LOG_LEVEL | <none> | --warn / --debug / --loglevel <INT> | Can either be set to: warn, debug or a custom loglevel integer |
|
|
|
|
## Run commands in container
|
|
|
|
> You don't need to use the full path of manga-dlp.py because `/app` already is the working directory
|
|
|
|
You can simply use the `docker exec` command to run the scripts like normal.
|
|
|
|
```sh
|
|
docker exec <container name> python3 manga-dlp.py <options>
|
|
```
|
|
|
|
## Run your own schedule
|
|
|
|
The default config runs `manga-dlp.py` once a day at 12:00 and fetches every chapter of the mangas listed in the file
|
|
`mangas.txt` in the root directory of this repo.
|
|
|
|
#### Default schedule
|
|
|
|
```sh
|
|
#!/bin/bash
|
|
|
|
python3 /app/manga-dlp.py \
|
|
--path /app/downloads \
|
|
--read /app/mangas.txt \
|
|
--chapters all \
|
|
--wait 2 \
|
|
--warn
|
|
```
|
|
|
|
To use your own schedule you need to mount (override) the default schedule or add new ones to the crontab.
|
|
|
|
> Don't forget to add the cron entries for every new schedule
|
|
|
|
```yml
|
|
# docker-compose.yml
|
|
volumes:
|
|
- ./crontab:/etc/cron.d/mangadlp # overwrites the default crontab
|
|
- ./crontab2:/etc/cron.d/something # adds a new one crontab file
|
|
- ./schedule1.sh:/app/schedules/daily.sh # overwrites the default schedule
|
|
- ./schedule2.sh:/app/schedules/weekly.sh # adds a new schedule
|
|
```
|
|
|
|
```sh
|
|
docker run -v ./crontab:/etc/cron.d/mangadlp # overwrites the default crontab
|
|
docker run -v ./crontab2:/etc/cron.d/something # adds a new one crontab file
|
|
docker run -v ./schedule1.sh:/app/schedules/daily.sh # overwrites the default schedule
|
|
docker run -v ./schedule2.sh:/app/schedules/weekly.sh # adds a new schedule
|
|
```
|
|
|
|
#### Default crontab file
|
|
|
|
```sh
|
|
SHELL=/bin/bash
|
|
PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
|
|
|
|
# default crontab to run manga-dlp once a day
|
|
# and get all (new) chapters of the mangas in
|
|
# the file mangas.txt
|
|
# "/proc/1/fd/1 2>&1" is to show the logs in the container
|
|
# "s6-setuidgid abc" is used to set the permissions
|
|
|
|
0 12 * * * root s6-setuidgid abc /app/schedules/daily.sh > /proc/1/fd/1 2>&1
|
|
```
|
|
|
|
## Add mangas to mangas.txt
|
|
|
|
If you use the default crontab you still need to add some mangas to mangas.txt. This is done almost identical to adding
|
|
your own cron schedule. If you use a custom cron schedule you need to mount the file you specified with `--read`.
|
|
|
|
```yml
|
|
# docker-compose.yml
|
|
volumes:
|
|
- ./mangas.txt:/app/mangas.txt
|
|
```
|
|
|
|
```sh
|
|
docker run -v ./mangas.txt:/app/mangas.txt
|
|
```
|
|
|
|
## Change download directory
|
|
|
|
Per default as in the script, it downloads everything to "downloads" in the scripts root directory. This data does not
|
|
persist with container recreation, so you need to mount it. This is already done in the quick start section. If you want
|
|
to change the path of the host, simply change `./downloads/` to a path of your choice.
|
|
|
|
```yml
|
|
# docker-compose.yml
|
|
volumes:
|
|
- ./downloads/:/app/downloads
|
|
```
|
|
|
|
```sh
|
|
docker run -v ./downloads/:/app/downloads
|
|
```
|