Skip to content

Commit 4ec313d

Browse files
Bot Updating Templated Files
1 parent b2901f3 commit 4ec313d

File tree

1 file changed

+89
-53
lines changed

1 file changed

+89
-53
lines changed

readme-vars.yml

Lines changed: 89 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,33 @@ project_blurb: |
1010
[{{ 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.
1111
1212
This software is a fork of library and licensed under the GPL v3 License.
13-
1413
# supported architectures
1514
available_architectures:
16-
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
17-
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
18-
15+
- {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
16+
- {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
1917
# development version
2018
development_versions: true
2119
development_versions_items:
22-
- { tag: "latest", desc: "Releases of Calibre-Web" }
23-
- { tag: "nightly", desc: "Commits to the master branch of Calibre-Web" }
24-
20+
- {tag: "latest", desc: "Releases of Calibre-Web"}
21+
- {tag: "nightly", desc: "Commits to the master branch of Calibre-Web"}
2522
# container parameters
2623
common_param_env_vars_enabled: true
2724
param_container_name: "{{ project_name }}"
2825
param_usage_include_env: true
2926
param_env_vars:
30-
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
27+
- {env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London."}
3128
param_usage_include_vols: true
3229
param_volumes:
33-
- { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Where calibre-web stores the internal database and config." }
34-
- { vol_path: "/books", vol_host_path: "/path/to/calibre/library", desc: "Where your preexisting calibre database is located." }
30+
- {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Where calibre-web stores the internal database and config."}
31+
- {vol_path: "/books", vol_host_path: "/path/to/calibre/library", desc: "Where your preexisting calibre database is located."}
3532
param_usage_include_ports: true
3633
param_ports:
37-
- { external_port: "8083", internal_port: "8083", port_desc: "WebUI" }
38-
34+
- {external_port: "8083", internal_port: "8083", port_desc: "WebUI"}
3935
# optional container parameters
4036
opt_param_usage_include_env: true
4137
opt_param_env_vars:
42-
- { env_var: "DOCKER_MODS", env_value: "linuxserver/mods:universal-calibre", desc: "#optional & **x86-64 only** Adds the ability to perform ebook conversion"}
43-
- { env_var: "OAUTHLIB_RELAX_TOKEN_SCOPE", env_value: "1", desc: "Optionally set this to allow Google OAUTH to work" }
44-
38+
- {env_var: "DOCKER_MODS", env_value: "linuxserver/mods:universal-calibre", desc: "#optional & **x86-64 only** Adds the ability to perform ebook conversion"}
39+
- {env_var: "OAUTHLIB_RELAX_TOKEN_SCOPE", env_value: "1", desc: "Optionally set this to allow Google OAUTH to work"}
4540
# application setup block
4641
app_setup_block_enabled: true
4742
app_setup_block: |
@@ -64,43 +59,84 @@ app_setup_block: |
6459
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.
6560
6661
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`
67-
68-
62+
# init diagram
63+
init_diagram: |
64+
"calibre-web:nightly": {
65+
docker-mods
66+
base {
67+
fix-attr +\nlegacy cont-init
68+
}
69+
docker-mods -> base
70+
legacy-services
71+
custom services
72+
init-services -> legacy-services
73+
init-services -> custom services
74+
custom services -> legacy-services
75+
legacy-services -> ci-service-check
76+
init-migrations -> init-adduser
77+
init-config -> init-calibre-web-config
78+
init-os-end -> init-config
79+
init-calibre-web-config -> init-config-end
80+
init-config -> init-config-end
81+
init-os-end -> init-crontab-config
82+
init-mods-end -> init-custom-files
83+
base -> init-envfile
84+
base -> init-migrations
85+
base -> init-mods
86+
init-config-end -> init-mods
87+
init-mods -> init-mods-end
88+
init-mods-package-install -> init-mods-end
89+
init-mods -> init-mods-package-install
90+
base -> init-os-end
91+
init-adduser -> init-os-end
92+
init-envfile -> init-os-end
93+
init-migrations -> init-os-end
94+
init-custom-files -> init-services
95+
init-mods-end -> init-services
96+
init-services -> svc-calibre-web
97+
svc-calibre-web -> legacy-services
98+
init-services -> svc-cron
99+
svc-cron -> legacy-services
100+
}
101+
Base Images: {
102+
"baseimage-ubuntu:jammy"
103+
}
104+
"calibre-web:nightly" <- Base Images
69105
# changelog
70106
changelogs:
71-
- { date: "26.08.24:", desc: "Add new dep, xdg-utils."}
72-
- { date: "07.07.24:", desc: "Add new dep, libmagic1."}
73-
- { date: "17.10.23:", desc: "Remove some packages that are required by the calibre mod but not the base container."}
74-
- { date: "07.10.23:", desc: "Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar). Switch to Python virtual environment."}
75-
- { date: "13.04.23:", desc: "Deprecate armhf."}
76-
- { date: "27.03.23:", desc: "Add cmake as build dep for Levenshtein."}
77-
- { date: "27.12.22:", desc: "Add ghostscript, libxtst6, libxkbfile-dev."}
78-
- { date: "20.12.22:", desc: "Improve init script and prevent harmless error."}
79-
- { date: "19.10.22:", desc: "Rebase to jammy. Upgrade to s6v3. Clean up build dependencies."}
80-
- { date: "04.11.21:", desc: "Update pip arguments to ignore distro installed packages."}
81-
- { date: "24.06.21:", desc: "Add note on optional OAUTHLIB_RELAX_TOKEN_SCOPE for Google OAUTH support."}
82-
- { date: "17.05.21:", desc: "Add linuxserver wheel index."}
83-
- { date: "10.02.21:", desc: "Add libxrandr2"}
84-
- { date: "25.01.21:", desc: "Add nightly tag"}
85-
- { date: "19.01.21:", desc: "Add python3-pkg-resources"}
86-
- { 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." }
87-
- { date: "12.10.20:", desc: "Add libxi6"}
88-
- { date: "12.07.20:", desc: "Add kepubify for arm64v8" }
89-
- { date: "05.06.20:", desc: "Add kepubify for x86-64 and arm32v7" }
90-
- { date: "06.05.20:", desc: "Add libxslt1.1 and update ImageMagick policy" }
91-
- { date: "19.01.20:", desc: "Adding LDAP libs." }
92-
- { date: "13.10.19:", desc: "Migrate to Python3." }
93-
- { date: "01.08.19:", desc: "Add libxcomposite1." }
94-
- { date: "13.06.19:", desc: "Add docker mod to enable optional ebook conversion on x86-64. Add unrar." }
95-
- { date: "02.06.19:", desc: "Rebase to Ubuntu Bionic & add Gdrive support." }
96-
- { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
97-
- { date: "23.02.19:", desc: "Rebase to alpine 3.9, use repo version of imagemagick." }
98-
- { date: "11.02.19:", desc: "Add pipeline logic and multi arch." }
99-
- { date: "03.01.19:", desc: "Remove guest user from default app.db." }
100-
- { date: "16.08.18:", desc: "Rebase to alpine 3.8." }
101-
- { date: "03.07.18:", desc: "New build pushed, all versions below `67` have [vulnerability](https://github.com/janeczku/calibre-web/issues/534)." }
102-
- { date: "05.01.18:", desc: "Deprecate cpu_core routine lack of scaling." }
103-
- { date: "06.12.17:", desc: "Rebase to alpine 3.7." }
104-
- { date: "27.11.17:", desc: "Use cpu core counting routine to speed up build time." }
105-
- { date: "24.07.17:", desc: "Curl version for imagemagick." }
106-
- { date: "17.07.17:", desc: "Initial release." }
107+
- {date: "26.08.24:", desc: "Add new dep, xdg-utils."}
108+
- {date: "07.07.24:", desc: "Add new dep, libmagic1."}
109+
- {date: "17.10.23:", desc: "Remove some packages that are required by the calibre mod but not the base container."}
110+
- {date: "07.10.23:", desc: "Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar). Switch to Python virtual environment."}
111+
- {date: "13.04.23:", desc: "Deprecate armhf."}
112+
- {date: "27.03.23:", desc: "Add cmake as build dep for Levenshtein."}
113+
- {date: "27.12.22:", desc: "Add ghostscript, libxtst6, libxkbfile-dev."}
114+
- {date: "20.12.22:", desc: "Improve init script and prevent harmless error."}
115+
- {date: "19.10.22:", desc: "Rebase to jammy. Upgrade to s6v3. Clean up build dependencies."}
116+
- {date: "04.11.21:", desc: "Update pip arguments to ignore distro installed packages."}
117+
- {date: "24.06.21:", desc: "Add note on optional OAUTHLIB_RELAX_TOKEN_SCOPE for Google OAUTH support."}
118+
- {date: "17.05.21:", desc: "Add linuxserver wheel index."}
119+
- {date: "10.02.21:", desc: "Add libxrandr2"}
120+
- {date: "25.01.21:", desc: "Add nightly tag"}
121+
- {date: "19.01.21:", desc: "Add python3-pkg-resources"}
122+
- {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."}
123+
- {date: "12.10.20:", desc: "Add libxi6"}
124+
- {date: "12.07.20:", desc: "Add kepubify for arm64v8"}
125+
- {date: "05.06.20:", desc: "Add kepubify for x86-64 and arm32v7"}
126+
- {date: "06.05.20:", desc: "Add libxslt1.1 and update ImageMagick policy"}
127+
- {date: "19.01.20:", desc: "Adding LDAP libs."}
128+
- {date: "13.10.19:", desc: "Migrate to Python3."}
129+
- {date: "01.08.19:", desc: "Add libxcomposite1."}
130+
- {date: "13.06.19:", desc: "Add docker mod to enable optional ebook conversion on x86-64. Add unrar."}
131+
- {date: "02.06.19:", desc: "Rebase to Ubuntu Bionic & add Gdrive support."}
132+
- {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
133+
- {date: "23.02.19:", desc: "Rebase to alpine 3.9, use repo version of imagemagick."}
134+
- {date: "11.02.19:", desc: "Add pipeline logic and multi arch."}
135+
- {date: "03.01.19:", desc: "Remove guest user from default app.db."}
136+
- {date: "16.08.18:", desc: "Rebase to alpine 3.8."}
137+
- {date: "03.07.18:", desc: "New build pushed, all versions below `67` have [vulnerability](https://github.com/janeczku/calibre-web/issues/534)."}
138+
- {date: "05.01.18:", desc: "Deprecate cpu_core routine lack of scaling."}
139+
- {date: "06.12.17:", desc: "Rebase to alpine 3.7."}
140+
- {date: "27.11.17:", desc: "Use cpu core counting routine to speed up build time."}
141+
- {date: "24.07.17:", desc: "Curl version for imagemagick."}
142+
- {date: "17.07.17:", desc: "Initial release."}

0 commit comments

Comments
 (0)