From 9f05c2553beb52120e502eed30d5454e7ab33207 Mon Sep 17 00:00:00 2001 From: Roxedus Date: Tue, 23 Mar 2021 18:06:29 +0100 Subject: [PATCH] Add nightly to version matrix --- README.md | 11 ++++++++++- readme-vars.yml | 11 +++++++++-- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bb5542c..17b24d3 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,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 @@ -165,7 +173,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` @@ -253,6 +261,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## 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 diff --git a/readme-vars.yml b/readme-vars.yml index 3558090..85f4093 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -16,6 +16,12 @@ available_architectures: - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"} - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"} +# development version +development_versions: true +development_versions_items: + - { tag: "latest", desc: "Releases of Calibre-Web" } + - { tag: "nightly", desc: "Commits to the master branch of Calibre-Web" } + # container parameters common_param_env_vars_enabled: true param_container_name: "{{ project_name }}" @@ -54,8 +60,8 @@ app_setup_block: | **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` To reverse proxy with our Letsencrypt docker container we include a preconfigured reverse proxy config, for other instances of Nginx use the following location block: @@ -72,6 +78,7 @@ app_setup_block: | # changelog changelogs: - { date: "10.02.21:", desc: "Add libxrandr2"} + - { date: "25.01.21:", desc: "Add nightly tag"} - { date: "19.01.21:", desc: "Add python3-pkg-resources"} - { date: "13.01.21:", desc: "Rebase to Ubuntu Focal, see [here](https://docs.linuxserver.io/faq#my-host-is-incompatible-with-images-based-on-ubuntu-focal) for troubleshooting armhf." } - { date: "12.10.20:", desc: "Add libxi6"}