From 9b3bc1dfe636ff7fc6059517a0bcdf19dc9bb847 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 20 Apr 2021 04:04:12 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-mylar3.md | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/images/docker-mylar3.md b/images/docker-mylar3.md index 083e7dce9..ecf11906a 100755 --- a/images/docker-mylar3.md +++ b/images/docker-mylar3.md @@ -1,6 +1,9 @@ --- title: mylar3 --- + + + # [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) @@ -38,6 +41,11 @@ This image provides various versions that are available via tags. `latest` tag u | latest | Stable Mylar3 releases | | nightly | Commits to Mylar3 `python3-dev` branch | +## Application Setup + +The web ui for settings etc, is on `:8090` +For more detailed setup options, refer to [Mylar3](https://github.com/mylar3/mylar3). + ## Usage Here are some example snippets to help you get started creating a container from this image. @@ -67,7 +75,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=mylar3 \ -e PUID=1000 \ @@ -80,7 +88,6 @@ docker run -d \ ghcr.io/linuxserver/mylar3 ``` - ## Parameters Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. @@ -91,7 +98,6 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `8090` | WebUI | - ### Environment Variables (`-e`) | Env | Function | @@ -107,15 +113,13 @@ Docker images are configured using parameters passed at runtime (such as those a | `/comics` | Map to your comics folder. | | `/downloads` | Map to your downloads folder. | - - ## Environment variables from files (Docker secrets) You can set any environment variable from a file by using a special prepend `FILE__`. As an example: -``` +```bash -e FILE__PASSWORD=/run/secrets/mysecretpassword ``` @@ -126,7 +130,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ 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`. @@ -135,23 +138,17 @@ Ensure any volume directories on the host are owned by the same user you specify In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -``` +```bash $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` -## Application Setup - -The web ui for settings etc, is on `:8090` -For more detailed setup options, refer to [Mylar3](https://github.com/mylar3/mylar3). - - ## Docker Mods + [![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.") 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. - ## Support Info * Shell access whilst the container is running: