2020-06-29 07:29:55 +00:00
# linuxserver/mylar
2019-02-05 18:47:24 +00:00
2020-06-29 07:29:55 +00:00
[](https://github.com/linuxserver/docker-mylar) [](https://github.com/linuxserver/docker-mylar/releases) [](https://github.com/linuxserver/docker-mylar/packages) [](https://gitlab.com/Linuxserver.io/docker-mylar/container_registry) [](https://microbadger.com/images/linuxserver/mylar) [](https://hub.docker.com/r/linuxserver/mylar) [](https://hub.docker.com/r/linuxserver/mylar) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mylar/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mylar/latest/index.html)
2019-02-05 18:47:24 +00:00
2020-06-29 07:29:55 +00:00
[Mylar ](https://github.com/evilhero/mylar ) is an automated Comic Book downloader \(cbr/cbz\) for use with SABnzbd, NZBGet and torrents.
2019-02-05 18:47:24 +00:00
2019-02-14 23:59:05 +00:00
## Supported Architectures
2019-02-05 18:47:24 +00:00
2019-09-01 11:55:00 +00:00
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/ ).
2019-02-14 23:59:05 +00:00
Simply pulling `linuxserver/mylar` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Tag |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-14 23:59:05 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 19:56:45 +00:00
| armhf | arm32v7-latest |
2019-02-05 18:47:24 +00:00
2019-02-10 12:54:52 +00:00
## Usage
2019-02-05 19:09:56 +00:00
2019-02-14 23:59:05 +00:00
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-06-29 07:29:55 +00:00
```text
2019-02-05 18:47:24 +00:00
docker create \
2019-02-14 23:59:05 +00:00
--name=mylar \
2019-03-03 12:54:50 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-14 23:59:05 +00:00
-p 8090:8090 \
-v < path to data > :/config \
-v < comics-folder > :/comics \
-v < downloads-folder > :/downloads \
--restart unless-stopped \
linuxserver/mylar
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-12 11:55:18 +00:00
version: "2.1"
2019-02-14 23:59:05 +00:00
services:
mylar:
image: linuxserver/mylar
container_name: mylar
environment:
2019-03-03 12:54:50 +00:00
- PUID=1000
- PGID=1000
2019-02-14 23:59:05 +00:00
volumes:
- < path to data > :/config
- < comics-folder > :/comics
- < downloads-folder > :/downloads
ports:
- 8090:8090
restart: unless-stopped
2019-02-05 18:47:24 +00:00
```
2019-02-10 12:54:52 +00:00
## Parameters
2020-06-29 07:29:55 +00:00
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.
2019-02-14 23:59:05 +00:00
2020-06-29 07:29:55 +00:00
### Ports \(`-p`\)
2019-02-05 18:47:24 +00:00
2019-02-14 23:59:05 +00:00
| Parameter | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-14 23:59:05 +00:00
| `8090` | WebUI |
2019-02-05 18:47:24 +00:00
2020-06-29 07:29:55 +00:00
### Environment Variables \(`-e`\)
2019-02-05 18:47:24 +00:00
2019-02-14 23:59:05 +00:00
| Env | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-03-03 12:54:50 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-05 18:47:24 +00:00
2020-06-29 07:29:55 +00:00
### Volume Mappings \(`-v`\)
2019-02-05 18:47:24 +00:00
2019-02-14 23:59:05 +00:00
| Volume | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-14 23:59:05 +00:00
| `/config` | Where mylar should store config files. |
| `/comics` | Map to your comics folder. |
| `/downloads` | Map to your downloads folder. |
2020-06-29 07:29:55 +00:00
## Environment variables from files \(Docker secrets\)
2020-05-31 11:54:48 +00:00
You can set any environment variable from a file by using a special prepend `FILE__` .
As an example:
2020-06-29 07:29:55 +00:00
```text
2020-05-31 11:54:48 +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
2020-06-29 07:29:55 +00:00
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.
2020-05-03 11:55:15 +00:00
2019-02-14 23:59:05 +00:00
## User / Group Identifiers
2020-06-29 07:29:55 +00:00
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` .
2019-02-14 23:59:05 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-03 12:54:50 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-05 18:47:24 +00:00
2020-06-29 07:29:55 +00:00
```text
2019-02-14 23:59:05 +00:00
$ id username
2019-03-03 12:54:50 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-05 18:47:24 +00:00
```
2019-02-14 23:59:05 +00:00
## Application Setup
2019-02-05 18:47:24 +00:00
2020-06-29 07:29:55 +00:00
The web ui for settings etc, is on `<your-ip>:8090` For more detailed setup refer [Mylar ](https://github.com/evilhero/mylar ).
2019-09-29 11:54:53 +00:00
2020-04-12 11:55:18 +00:00
## Docker Mods
2020-06-29 07:29:55 +00:00
[](https://mods.linuxserver.io/?mod=mylar)
2020-04-12 11:55:18 +00:00
2020-06-29 07:29:55 +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\) can be accessed via the dynamic badge above.
2019-02-05 18:47:24 +00:00
2019-02-14 23:59:05 +00:00
## Support Info
2019-02-05 18:47:24 +00:00
2019-09-01 11:55:00 +00:00
* Shell access whilst the container is running:
2019-02-14 23:59:05 +00:00
* `docker exec -it mylar /bin/bash`
2019-09-01 11:55:00 +00:00
* To monitor the logs of the container in realtime:
2019-02-14 23:59:05 +00:00
* `docker logs -f mylar`
2019-09-01 11:55:00 +00:00
* Container version number
2019-02-14 23:59:05 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' mylar`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/mylar`
2019-02-05 18:47:24 +00:00
2019-02-10 12:54:52 +00:00
## Versions
2019-12-20 22:17:52 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-07-05 19:08:29 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-05-12 11:54:52 +00:00
* **08.05.19:** - Re-install requests pip package to downgrade urllib version suitable for mylar.
2019-03-24 19:56:45 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 16:30:14 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-14 23:59:05 +00:00
* **11.02.19:** - Pipeline logic and multi arch.
* **17.08.18:** - Rebase to alpine 3.8.
* **06.07.18:** - Add `html5lib` python package.
* **14.06.18:** - Add `requests` python package.
* **12.12.17:** - Rebase to alpine 3.7.
* **21.07.17:** - Internal git pull instead of at runtime.
* **25.05.17:** - Rebase to alpine 3.6.
* **19.02.17:** - Use quiet option for cleaner console log, app logs to file anyways.
* **07.02.17:** - Rebase to alpine 3.5.
* **14.10.16:** - Add version layer information.
* **10.09.16:** - Add layer badges to README.
* **28.08.16:** - Add badges to README.
* **08.08.16:** - Rebase to alpine linux.
* **26.01.16:** - Initial release.
2020-06-29 07:29:55 +00:00
