From 49567b365815342e6a3f03c2e272f572e9cffb78 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 23 Mar 2021 14:30:17 -0400 Subject: [PATCH] Bot Updating Documentation --- images/docker-calibre-web.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/images/docker-calibre-web.md b/images/docker-calibre-web.md index 6924fe3c2..aa67cf360 100644 --- a/images/docker-calibre-web.md +++ b/images/docker-calibre-web.md @@ -1,8 +1,7 @@ --- title: calibre-web --- - - +# [linuxserver/calibre-web](https://github.com/linuxserver/docker-calibre-web) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-calibre-web.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-calibre-web) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-calibre-web.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-calibre-web/releases) @@ -18,6 +17,7 @@ title: calibre-web This software is a fork of library and licensed under the GPL v3 License. + ## 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/). @@ -71,7 +71,7 @@ services: ### docker cli -```bash +``` docker run -d \ --name=calibre-web \ -e PUID=1000 \ @@ -85,6 +85,7 @@ docker run -d \ ghcr.io/linuxserver/calibre-web ``` + ## 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. @@ -95,6 +96,7 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `8083` | WebUI | + ### Environment Variables (`-e`) | Env | Function | @@ -111,13 +113,15 @@ Docker images are configured using parameters passed at runtime (such as those a | `/config` | Where calibre-web stores the internal database and config. | | `/books` | Where your preexisting calibre database is locate. | + + ## 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 ``` @@ -128,6 +132,7 @@ 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`. @@ -136,7 +141,7 @@ 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) ``` @@ -170,12 +175,13 @@ To reverse proxy with our Letsencrypt docker container we include a preconfigure } ``` -## Docker Mods +## Docker Mods [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=calibre-web&query=%24.mods%5B%27calibre-web%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=calibre-web "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: