docker-documentation/images/docker-mylar3.md

174 wiersze
8.6 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-16 03:59:01 +00:00
---
title: mylar3
---
2021-04-20 04:04:12 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-mylar3/blob/master/.github/CONTRIBUTING.md -->
2020-09-28 12:07:43 +00:00
# [linuxserver/mylar3](https://github.com/linuxserver/docker-mylar3)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-mylar3.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-mylar3)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-mylar3.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-mylar3/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-mylar3/packages)
2020-12-16 14:41:28 +00:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-mylar3/container_registry)
2021-10-05 03:57:07 +00:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/mylar3)
2020-09-28 12:07:43 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mylar3.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/mylar3)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mylar3.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/mylar3)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-mylar3%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mylar3/job/master/)
2020-11-03 17:27:54 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fmylar3%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/mylar3/latest/index.html)
2020-09-28 12:07:43 +00:00
[Mylar3](https://github.com/mylar3/mylar3) is an automated Comic Book downloader (cbr/cbz) for use with NZB and torrents written in python. It supports SABnzbd, NZBGET, and many torrent clients in addition to DDL.
## Supported Architectures
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2021-10-05 03:57:07 +00:00
Simply pulling `lscr.io/linuxserver/mylar3` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2020-09-28 12:07:43 +00:00
The architectures supported by this image are:
| Architecture | Tag |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
2020-12-22 02:30:32 +00:00
## Version Tags
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
| Tag | Description |
| :----: | --- |
| latest | Stable Mylar3 releases |
| nightly | Commits to Mylar3 `python3-dev` branch |
2020-09-28 12:07:43 +00:00
2021-04-20 04:04:12 +00:00
## Application Setup
The web ui for settings etc, is on `<your-ip>:8090`
For more detailed setup options, refer to [Mylar3](https://github.com/mylar3/mylar3).
2020-09-28 12:07:43 +00:00
## Usage
2021-07-06 03:57:45 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2020-09-28 12:07:43 +00:00
2021-07-06 03:57:45 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2020-09-28 12:07:43 +00:00
```yaml
---
version: "2.1"
services:
mylar3:
2021-10-05 03:57:07 +00:00
image: lscr.io/linuxserver/mylar3
2020-09-28 12:07:43 +00:00
container_name: mylar3
environment:
- PUID=1000
- PGID=1000
volumes:
- /path/to/data:/config
- /path/to/comics:/comics
- /path/to/downloads:/downloads
ports:
- 8090:8090
restart: unless-stopped
```
2021-07-06 03:57:45 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-04 13:35:54 +00:00
2021-04-20 04:04:12 +00:00
```bash
2020-10-04 13:35:54 +00:00
docker run -d \
--name=mylar3 \
-e PUID=1000 \
-e PGID=1000 \
-p 8090:8090 \
-v /path/to/data:/config \
-v /path/to/comics:/comics \
-v /path/to/downloads:/downloads \
--restart unless-stopped \
2021-10-05 03:57:07 +00:00
lscr.io/linuxserver/mylar3
2020-10-04 13:35:54 +00:00
```
2020-09-28 12:07:43 +00:00
## Parameters
Docker images are configured using parameters passed at runtime (such as those above). 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.
### Ports (`-p`)
| Parameter | Function |
| :----: | --- |
| `8090` | WebUI |
### Environment Variables (`-e`)
| Env | Function |
| :----: | --- |
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
### Volume Mappings (`-v`)
| Volume | Function |
| :----: | --- |
| `/config` | Where mylar should store config files. |
| `/comics` | Map to your comics folder. |
| `/downloads` | Map to your downloads folder. |
2021-10-05 03:57:07 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2020-09-28 12:07:43 +00:00
## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-20 04:04:12 +00:00
```bash
2020-09-28 12:07:43 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
## User / Group Identifiers
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2021-04-20 04:04:12 +00:00
```bash
2020-09-28 12:07:43 +00:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Docker Mods
2021-04-20 04:04:12 +00:00
2020-10-04 13:35:54 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=mylar3&query=%24.mods%5B%27mylar3%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=mylar3 "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-09-28 12:07:43 +00:00
2020-10-04 13:35:54 +00:00
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
2020-09-28 12:07:43 +00:00
## Support Info
* Shell access whilst the container is running:
* `docker exec -it mylar3 /bin/bash`
* To monitor the logs of the container in realtime:
* `docker logs -f mylar3`
* Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' mylar3`
* Image version number
2021-10-05 03:57:07 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mylar3`
2020-09-28 12:07:43 +00:00
## Versions
2021-05-25 20:21:15 +00:00
* **25.05.21:** - Add `libwebp` support.
2021-05-17 14:50:02 +00:00
* **17.05.21:** - Add linuxserver wheel index.
2021-02-10 16:14:24 +00:00
* **23.01.21:** - Rebasing to alpine 3.13.
2021-01-10 14:09:25 +00:00
* **03.01.21:** - Output mylar log to docker log.
2020-12-22 02:30:32 +00:00
* **21.12.20:** - Release `nightly` tag based on commits to upstream `python3-dev` branch.
2020-09-28 12:07:43 +00:00
* **28.09.20:** - Initial release.