From aec1abccb4bb65cce591f2156f162e73c79635f2 Mon Sep 17 00:00:00 2001 From: Roxedus Date: Tue, 23 Mar 2021 19:14:48 +0100 Subject: [PATCH] TEST title header --- images/docker-calibre-web.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/images/docker-calibre-web.md b/images/docker-calibre-web.md index 044d6dd84..6924fe3c2 100644 --- a/images/docker-calibre-web.md +++ b/images/docker-calibre-web.md @@ -1,7 +1,8 @@ --- 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) @@ -17,7 +18,6 @@ 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/). @@ -32,6 +32,14 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## 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 | Releases of Calibre-Web | +| nightly | Commits to the master branch of Calibre-Web | ## Usage @@ -63,7 +71,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=calibre-web \ -e PUID=1000 \ @@ -77,7 +85,6 @@ 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. @@ -88,7 +95,6 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `8083` | WebUI | - ### Environment Variables (`-e`) | Env | Function | @@ -105,15 +111,13 @@ 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 ``` @@ -124,7 +128,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`. @@ -133,7 +136,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) ``` @@ -152,7 +155,7 @@ Unrar is included by default and needs to be set in the Calibre-Web admin page ( **x86-64 only** We have implemented the optional ability to pull in the dependencies to enable ebook conversion utilising Calibre, this means if you don't require this feature the container isn't uneccessarily bloated but should you require it, it is easily available. This optional layer will be rebuilt automatically on our CI pipeline upon new Calibre releases so you can stay up to date. -To use this option add the optional environmental variable as detailed above to pull an addition docker layer to enable ebook conversion and then in the Calibre-Web admin page (Basic Configuration:External Binaries) set the **Path to Calibre E-Book Converter** to `/usr/bin/ebook-convert` +To use this option add the optional environmental variable as detailed above to pull an addition docker layer to enable ebook conversion and then in the Calibre-Web admin page (Basic Configuration:External Binaries) set the **Path to Calibre E-Book Converter** to `/usr/bin/ebook-convert` This image contains the [kepubify](https://pgaskin.net/kepubify/) ebook conversion tool (MIT License) to convert epub to kepub. In the Calibre-Web admin page (Basic Configuration:External Binaries) set the **Path to Kepubify E-Book Converter** to `/usr/bin/kepubify` @@ -167,13 +170,12 @@ To reverse proxy with our Letsencrypt docker container we include a preconfigure } ``` - ## 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: @@ -188,6 +190,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions * **10.02.21:** - Add libxrandr2 +* **25.01.21:** - Add nightly tag * **19.01.21:** - Add python3-pkg-resources * **13.01.21:** - Rebase to Ubuntu Focal, see [here](https://docs.linuxserver.io/faq#my-host-is-incompatible-with-images-based-on-ubuntu-focal) for troubleshooting armhf. * **12.10.20:** - Add libxi6