mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Templated Files

LICENSE
LinuxServer-CI 2019-02-14 23:59:05 +00:00
rodzic 8145afef08
commit f70c05f26c
1 zmienionych plików z 112 dodań i 63 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

175
images/docker-mylar.md
Wyświetl plik

@ -1,97 +1,146 @@
[linuxserverurl]: https://linuxserver.io # [linuxserver/mylar](https://github.com/linuxserver/docker-mylar)
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: https://github.com/evilhero/mylar
[hub]: https://hub.docker.com/r/linuxserver/mylar/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] [![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](https://images.microbadger.com/badges/version/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar "Get your own version badge on microbadger.com")
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mylar.svg)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mylar.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-mylar/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mylar/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mylar/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mylar/latest/index.html)
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: [Mylar](https://github.com/evilhero/mylar) is an automated Comic Book downloader (cbr/cbz) for use with SABnzbd, NZBGet and torrents.
* [forum.linuxserver.io][forumurl]
* [IRC][ircurl] on freenode at `#linuxserver.io`
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
# linuxserver/mylar ## Supported Architectures
[![](https://images.microbadger.com/badges/version/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mylar.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mylar.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-mylar)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-mylar/)
An automated Comic Book downloader (cbr/cbz) for use with SABnzbd, NZBGet and torrents. [mylar](https://github.com/evilhero/mylar) 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).
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 |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
[![mylar](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/mylar-icon.png)][appurl]
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
``` ```
docker create \ docker create \
--name=mylar \ --name=mylar \
-v <path to data>:/config \ -e PUID=1001 \
-v <downloads-folder>:/downloads \ -e PGID=1001 \
-v <comics-folder>:/comics \ -p 8090:8090 \
-e PGID=<gid> -e PUID=<uid> \ -v <path to data>:/config \
-e TZ=<timezone> \ -v <comics-folder>:/comics \
-p 8090:8090 \ -v <downloads-folder>:/downloads \
linuxserver/mylar --restart unless-stopped \
linuxserver/mylar
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
mylar:
image: linuxserver/mylar
container_name: mylar
environment:
- PUID=1001
- PGID=1001
volumes:
- <path to data>:/config
- <comics-folder>:/comics
- <downloads-folder>:/downloads
ports:
- 8090:8090
mem_limit: 4096m
restart: unless-stopped
``` ```
## Parameters ## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. 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.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 ### Ports (`-p`)
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
| Parameter | Function |
| :----: | --- |
| `8090` | WebUI |
* `-p 8090` - the port(s) ### Environment Variables (`-e`)
* `-v /config` - where mylar should store config files
* `-v /downloads` - map to your downloads folder
* `-v /comics` - map to your comics folder
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
* `-e TZ` for setting timezone information, eg Europe/London
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it mylar /bin/bash`. | Env | Function |
| :----: | --- |
| `PUID=1001` | for UserID - see below for explanation |
| `PGID=1001` | for GroupID - see below for explanation |
### User / Group Identifiers ### Volume Mappings (`-v`)
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™. | Volume | Function |
| :----: | --- |
| `/config` | Where mylar should store config files. |
| `/comics` | Map to your comics folder. |
| `/downloads` | Map to your downloads folder. |
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
## 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=1001` and `PGID=1001`, to find yours use `id user` as below:
``` ```
$ id <dockeruser> $ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
``` ```
## Setting up the application ## Application Setup
The web ui for settings etc, is on `<your-ip>:8090` The web ui for settings etc, is on `<your-ip>:8090`
For more detailed setup refer [mylar](https://github.com/evilhero/mylar). For more detailed setup refer [Mylar](https://github.com/evilhero/mylar).
## Info
* To monitor the logs of the container in realtime `docker logs -f mylar`.
* container version number ## Support Info
`docker inspect -f '{{ index .Config.Labels "build_version" }}' mylar` * Shell access whilst the container is running:
* `docker exec -it mylar /bin/bash`
* image version number * To monitor the logs of the container in realtime:
* `docker logs -f mylar`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/mylar` * Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' mylar`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/mylar`
## Versions ## Versions
+ **17.08.18:** Rebase to alpine 3.8. * **11.02.19:** - Pipeline logic and multi arch.
+ **06.07.18:** Add `html5lib` python package * **17.08.18:** - Rebase to alpine 3.8.
+ **14.06.18:** Add `requests` python package * **06.07.18:** - Add `html5lib` python package.
+ **12.12.17:** Rebase to alpine 3.7. * **14.06.18:** - Add `requests` python package.
+ **21.07.17:** Internal git pull instead of at runtime. * **12.12.17:** - Rebase to alpine 3.7.
+ **25.05.17:** Rebase to alpine 3.6. * **21.07.17:** - Internal git pull instead of at runtime.
+ **19.02.17:** Use quiet option for cleaner console log, * **25.05.17:** - Rebase to alpine 3.6.
app logs to file anyways. * **19.02.17:** - Use quiet option for cleaner console log, app logs to file anyways.
+ **07.02.17:** Rebase to alpine 3.5. * **07.02.17:** - Rebase to alpine 3.5.
+ **14.10.16:** Add version layer information. * **14.10.16:** - Add version layer information.
+ **10.09.16:** Add layer badges to README. * **10.09.16:** - Add layer badges to README.
+ **28.08.16:** Add badges to README. * **28.08.16:** - Add badges to README.
+ **08.08.16:** Rebase to alpine linux. * **08.08.16:** - Rebase to alpine linux.
+ **26.01.16:** Initial Release. * **26.01.16:** - Initial release.