Bot Updating Templated Files

linuxserver · Dec 1, 2024 · 4ec313d · 4ec313d
1 parent b2901f3
commit 4ec313d
Showing 1 changed file with 89 additions and 53 deletions.
diff --git a/readme-vars.yml b/readme-vars.yml
@@ -10,38 +10,33 @@ project_blurb: |
   [{{ project_name|capitalize }}]({{ project_url }}) is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.   It is also possible to integrate google drive and edit metadata and your calibre library through the app itself.
 
   This software is a fork of library and licensed under the GPL v3 License.
-
 # supported architectures
 available_architectures:
-  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
-  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
-
+  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
+  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-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" }
-
+  - {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 }}"
 param_usage_include_env: true
 param_env_vars:
-  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
+  - {env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London."}
 param_usage_include_vols: true
 param_volumes:
-  - { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Where calibre-web stores the internal database and config." }
-  - { vol_path: "/books", vol_host_path: "/path/to/calibre/library", desc: "Where your preexisting calibre database is located." }
+  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Where calibre-web stores the internal database and config."}
+  - {vol_path: "/books", vol_host_path: "/path/to/calibre/library", desc: "Where your preexisting calibre database is located."}
 param_usage_include_ports: true
 param_ports:
-  - { external_port: "8083", internal_port: "8083", port_desc: "WebUI" }
-
+  - {external_port: "8083", internal_port: "8083", port_desc: "WebUI"}
 # optional container parameters
 opt_param_usage_include_env: true
 opt_param_env_vars:
-  - { env_var: "DOCKER_MODS", env_value: "linuxserver/mods:universal-calibre", desc: "#optional & **x86-64 only** Adds the ability to perform ebook conversion"}
-  - { env_var: "OAUTHLIB_RELAX_TOKEN_SCOPE", env_value: "1", desc: "Optionally set this to allow Google OAUTH to work" }
-
+  - {env_var: "DOCKER_MODS", env_value: "linuxserver/mods:universal-calibre", desc: "#optional & **x86-64 only** Adds the ability to perform ebook conversion"}
+  - {env_var: "OAUTHLIB_RELAX_TOKEN_SCOPE", env_value: "1", desc: "Optionally set this to allow Google OAUTH to work"}
 # application setup block
 app_setup_block_enabled: true
 app_setup_block: |
@@ -64,43 +59,84 @@ app_setup_block: |
   To use this option add the optional environmental variable as shown in the docker-mods section 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` on versions 0.6.21 and lower. For 0.6.22 and higher, set the directory, `/usr/bin/` only.
 
   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`
-
-
+# init diagram
+init_diagram: |
+  "calibre-web:nightly": {
+    docker-mods
+    base {
+      fix-attr +\nlegacy cont-init
+    }
+    docker-mods -> base
+    legacy-services
+    custom services
+    init-services -> legacy-services
+    init-services -> custom services
+    custom services -> legacy-services
+    legacy-services -> ci-service-check
+    init-migrations -> init-adduser
+    init-config -> init-calibre-web-config
+    init-os-end -> init-config
+    init-calibre-web-config -> init-config-end
+    init-config -> init-config-end
+    init-os-end -> init-crontab-config
+    init-mods-end -> init-custom-files
+    base -> init-envfile
+    base -> init-migrations
+    base -> init-mods
+    init-config-end -> init-mods
+    init-mods -> init-mods-end
+    init-mods-package-install -> init-mods-end
+    init-mods -> init-mods-package-install
+    base -> init-os-end
+    init-adduser -> init-os-end
+    init-envfile -> init-os-end
+    init-migrations -> init-os-end
+    init-custom-files -> init-services
+    init-mods-end -> init-services
+    init-services -> svc-calibre-web
+    svc-calibre-web -> legacy-services
+    init-services -> svc-cron
+    svc-cron -> legacy-services
+  }
+  Base Images: {
+    "baseimage-ubuntu:jammy"
+  }
+  "calibre-web:nightly" <- Base Images
 # changelog
 changelogs:
-  - { date: "26.08.24:", desc: "Add new dep, xdg-utils."}
-  - { date: "07.07.24:", desc: "Add new dep, libmagic1."}
-  - { date: "17.10.23:", desc: "Remove some packages that are required by the calibre mod but not the base container."}
-  - { date: "07.10.23:", desc: "Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar). Switch to Python virtual environment."}
-  - { date: "13.04.23:", desc: "Deprecate armhf."}
-  - { date: "27.03.23:", desc: "Add cmake as build dep for Levenshtein."}
-  - { date: "27.12.22:", desc: "Add ghostscript, libxtst6, libxkbfile-dev."}
-  - { date: "20.12.22:", desc: "Improve init script and prevent harmless error."}
-  - { date: "19.10.22:", desc: "Rebase to jammy. Upgrade to s6v3. Clean up build dependencies."}
-  - { date: "04.11.21:", desc: "Update pip arguments to ignore distro installed packages."}
-  - { date: "24.06.21:", desc: "Add note on optional OAUTHLIB_RELAX_TOKEN_SCOPE for Google OAUTH support."}
-  - { date: "17.05.21:", desc: "Add linuxserver wheel index."}
-  - { 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"}
-  - { date: "12.07.20:", desc: "Add kepubify for arm64v8" }
-  - { date: "05.06.20:", desc: "Add kepubify for x86-64 and arm32v7" }
-  - { date: "06.05.20:", desc: "Add libxslt1.1 and update ImageMagick policy" }
-  - { date: "19.01.20:", desc: "Adding LDAP libs." }
-  - { date: "13.10.19:", desc: "Migrate to Python3." }
-  - { date: "01.08.19:", desc: "Add libxcomposite1." }
-  - { date: "13.06.19:", desc: "Add docker mod to enable optional ebook conversion on x86-64.  Add unrar." }
-  - { date: "02.06.19:", desc: "Rebase to Ubuntu Bionic & add Gdrive support." }
-  - { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
-  - { date: "23.02.19:", desc: "Rebase to alpine 3.9, use repo version of imagemagick." }
-  - { date: "11.02.19:", desc: "Add pipeline logic and multi arch." }
-  - { date: "03.01.19:", desc: "Remove guest user from default app.db." }
-  - { date: "16.08.18:", desc: "Rebase to alpine 3.8." }
-  - { date: "03.07.18:", desc: "New build pushed, all versions below `67` have [vulnerability](https://github.com/janeczku/calibre-web/issues/534)." }
-  - { date: "05.01.18:", desc: "Deprecate cpu_core routine lack of scaling." }
-  - { date: "06.12.17:", desc: "Rebase to alpine 3.7." }
-  - { date: "27.11.17:", desc: "Use cpu core counting routine to speed up build time." }
-  - { date: "24.07.17:", desc: "Curl version for imagemagick." }
-  - { date: "17.07.17:", desc: "Initial release." }
+  - {date: "26.08.24:", desc: "Add new dep, xdg-utils."}
+  - {date: "07.07.24:", desc: "Add new dep, libmagic1."}
+  - {date: "17.10.23:", desc: "Remove some packages that are required by the calibre mod but not the base container."}
+  - {date: "07.10.23:", desc: "Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar). Switch to Python virtual environment."}
+  - {date: "13.04.23:", desc: "Deprecate armhf."}
+  - {date: "27.03.23:", desc: "Add cmake as build dep for Levenshtein."}
+  - {date: "27.12.22:", desc: "Add ghostscript, libxtst6, libxkbfile-dev."}
+  - {date: "20.12.22:", desc: "Improve init script and prevent harmless error."}
+  - {date: "19.10.22:", desc: "Rebase to jammy. Upgrade to s6v3. Clean up build dependencies."}
+  - {date: "04.11.21:", desc: "Update pip arguments to ignore distro installed packages."}
+  - {date: "24.06.21:", desc: "Add note on optional OAUTHLIB_RELAX_TOKEN_SCOPE for Google OAUTH support."}
+  - {date: "17.05.21:", desc: "Add linuxserver wheel index."}
+  - {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"}
+  - {date: "12.07.20:", desc: "Add kepubify for arm64v8"}
+  - {date: "05.06.20:", desc: "Add kepubify for x86-64 and arm32v7"}
+  - {date: "06.05.20:", desc: "Add libxslt1.1 and update ImageMagick policy"}
+  - {date: "19.01.20:", desc: "Adding LDAP libs."}
+  - {date: "13.10.19:", desc: "Migrate to Python3."}
+  - {date: "01.08.19:", desc: "Add libxcomposite1."}
+  - {date: "13.06.19:", desc: "Add docker mod to enable optional ebook conversion on x86-64.  Add unrar."}
+  - {date: "02.06.19:", desc: "Rebase to Ubuntu Bionic & add Gdrive support."}
+  - {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
+  - {date: "23.02.19:", desc: "Rebase to alpine 3.9, use repo version of imagemagick."}
+  - {date: "11.02.19:", desc: "Add pipeline logic and multi arch."}
+  - {date: "03.01.19:", desc: "Remove guest user from default app.db."}
+  - {date: "16.08.18:", desc: "Rebase to alpine 3.8."}
+  - {date: "03.07.18:", desc: "New build pushed, all versions below `67` have [vulnerability](https://github.com/janeczku/calibre-web/issues/534)."}
+  - {date: "05.01.18:", desc: "Deprecate cpu_core routine lack of scaling."}
+  - {date: "06.12.17:", desc: "Rebase to alpine 3.7."}
+  - {date: "27.11.17:", desc: "Use cpu core counting routine to speed up build time."}
+  - {date: "24.07.17:", desc: "Curl version for imagemagick."}
+  - {date: "17.07.17:", desc: "Initial release."}