feat(calibre-web-automated): replace Calibre Web with Calibre Web Automated

Nitestack · Nitestack · commit dcb0c6df4ad5 · 2025-10-21T19:52:19.000+02:00
diff --git a/README.md b/README.md
@@ -38,7 +38,7 @@ _This [Ansible](https://ansible.com) configuration automates the setup of a Home
 - **Backrest**: Backup Manager (Web GUI for `restic`)
 - **Beszel**: Server Monitoring
 - **Caddy**: Reverse Proxy & TLS
-- **Calibre Web**: eBook Manager
+- **Calibre Web Automated**: eBook Manager
 - **Cloudflare DDNS**: Dynamic DNS Updater
 - **Ente Auth**: Two-factor Authenticator
 - **FreshRSS**: Feed Aggregator
diff --git a/deploy.yml b/deploy.yml
@@ -41,8 +41,8 @@
       tags: glance
     - role: beszel
       tags: beszel
-    - role: calibre_web
-      tags: calibre_web
+    - role: calibre_web_automated
+      tags: calibre_web_automated
     - role: adguard_home
       tags: adguard_home
     - role: adventure_log
diff --git a/group_vars/all/main.yml b/group_vars/all/main.yml
@@ -50,11 +50,11 @@ services:
     domain: "monitor.{{ domain }}"
     container_name: "beszel"
     port: 8090
-  # Calibre Web
-  calibre_web:
+  # Calibre Web Automated
+  calibre_web_automated:
     enabled: true
-    domain: "books.{{ domain }}"
-    container_name: "calibre-web"
+    domain: "lib.{{ domain }}"
+    container_name: "calibre-web-automated"
     port: 8083
   # Ente Auth
   ente_auth:
diff --git a/group_vars/all/vault.yml b/group_vars/all/vault.yml
diff --git a/roles/calibre_web/defaults/main.yml b/roles/calibre_web/defaults/main.yml
diff --git a/roles/calibre_web/tasks/main.yml b/roles/calibre_web/tasks/main.yml
diff --git a/roles/calibre_web/templates/compose.yml.j2 b/roles/calibre_web/templates/compose.yml.j2
diff --git a/roles/calibre_web/vars/main.yml b/roles/calibre_web/vars/main.yml
diff --git a/roles/calibre_web_automated/defaults/main.yml b/roles/calibre_web_automated/defaults/main.yml
@@ -0,0 +1,2 @@
+---
+calibre_web_automated_dir_name: "calibre-web-automated"
diff --git a/roles/calibre_web_automated/tasks/main.yml b/roles/calibre_web_automated/tasks/main.yml
@@ -0,0 +1,13 @@
+---
+- name: Deploy Calibre Web Automated
+  ansible.builtin.include_role:
+    name: service_deploy
+  vars:
+    service_name: "Calibre Web Automated"
+    service_dir_name: "{{ calibre_web_automated_dir_name }}"
+    compose_url: "https://raw.githubusercontent.com/crocodilestick/Calibre-Web-Automated/refs/tags/V3.1.4/docker-compose.yml"
+    data_dirs:
+      - "config"
+      - "upload"
+      - "library"
+      - "plugins"
diff --git a/roles/calibre_web_automated/templates/compose.override.yml.j2 b/roles/calibre_web_automated/templates/compose.override.yml.j2
@@ -0,0 +1,26 @@
+# external-file
+# owner: crocodilestick
+# repo: Calibre-Web-Automated
+# path: docker-compose.yml
+# commit-hash: 3fd97431ca3270b159c6587c9cb190c99b11c8ec
+
+services:
+  calibre-web-automated:
+    image: crocodilestick/calibre-web-automated:V3.1.4@sha256:577e846f104fd21453ef306eefb4a95dd95b3b9ddd2463a150944494284da0fd
+    container_name: "{{ services.calibre_web_automated.container_name }}"
+    restart: always
+    networks:
+      - caddy
+    environment:
+      - TZ={{ timezone }}
+      - HARDCOVER_TOKEN={{ calibre_web_automated_hardcover_token }}
+    volumes:
+      - "{{ calibre_web_automated_data_dir }}/config:/config"
+      - "{{ calibre_web_automated_data_dir }}/upload:/cwa-book-ingest"
+      - "{{ calibre_web_automated_data_dir }}/library:/calibre-library"
+      - "{{ calibre_web_automated_data_dir }}/plugins:/config/.config/calibre/plugins"
+    ports: !reset []
+
+networks:
+  caddy:
+    external: true
diff --git a/roles/calibre_web_automated/vars/main.yml b/roles/calibre_web_automated/vars/main.yml
@@ -0,0 +1,2 @@
+---
+calibre_web_automated_data_dir: "{{ data_base_dir }}/{{ calibre_web_automated_dir_name }}"
diff --git a/roles/glance/files/config/server.yml b/roles/glance/files/config/server.yml
@@ -39,8 +39,8 @@
                 - title: Caddy
                   url: https://caddyserver.com/docs
                   icon: di:caddy
-                - title: Calibre Web
-                  url: https://github.com/janeczku/calibre-web/wiki
+                - title: Calibre Web Automated
+                  url: https://github.com/crocodilestick/Calibre-Web-Automated/wiki
                   icon: di:calibre-web
                 - title: Cloudflare DDNS
                   url: https://github.com/favonia/cloudflare-ddns
@@ -147,10 +147,10 @@
               name: Caddy
               icon: di:caddy
               description: HTTPS Server
-            calibre-web:
-              name: Calibre Web
+            calibre-web-automated:
+              name: Calibre Web Automated
               icon: di:calibre-web
-              url: ${CALIBRE_WEB_URL}
+              url: ${CALIBRE_WEB_AUTOMATED_URL}
               description: eBook Manager
             cloudflare-ddns:
               name: Cloudflare DDNS
@@ -408,7 +408,7 @@
             - garethgeorge/backrest
             - henrygd/beszel
             - caddyserver/caddy
-            - janeczku/calibre-web
+            - crocodilestick/Calibre-Web-Automated
             - favonia/cloudflare-ddns
             - ente-io/ente
             - FreshRSS/FreshRSS
diff --git a/roles/glance/templates/env.j2 b/roles/glance/templates/env.j2
@@ -5,7 +5,7 @@ ADVENTURE_LOG_URL=https://{{ services.adventure_log.domain }}
 AUTHENTIK_URL=https://{{ services.authentik.domain }}
 BACKREST_URL=https://{{ services.backrest.domain }}
 BESZEL_URL=https://{{ services.beszel.domain }}
-CALIBRE_WEB_URL=https://{{ services.calibre_web.domain }}
+CALIBRE_WEB_AUTOMATED_URL=https://{{ services.calibre_web_automated.domain }}
 ENTE_AUTH_URL=https://{{ services.ente_auth.domain }}
 FRESHRSS_URL=https://{{ services.freshrss.domain }}
 GHOSTFOLIO_URL=https://{{ services.ghostfolio.domain }}
diff --git a/roles/service_deploy/defaults/main.yml b/roles/service_deploy/defaults/main.yml
@@ -5,6 +5,9 @@ service_name: "{{ service_dir_name | replace('-', ' ') | title }}"
 # The directory name for the service
 service_dir_name: ""
 
+# Directories to create for the service
+data_dirs: []
+
 # List of additional templates to copy
 service_templates: []
 
diff --git a/roles/service_deploy/tasks/main.yml b/roles/service_deploy/tasks/main.yml
@@ -8,6 +8,27 @@
         state: directory
         mode: "0755"
 
+    - name: "Create data directory for {{ service_name }}"
+      ansible.builtin.file:
+        path: "{{ data_dir }}"
+        state: directory
+        owner: 1000
+        group: 1000
+        mode: "0755"
+      become: true
+
+    - name: "Create and set permissions for additional data directories"
+      ansible.builtin.file:
+        path: "{{ data_dir }}/{{ item }}"
+        state: directory
+        owner: 1000
+        group: 1000
+        mode: "0755"
+      loop: "{{ data_dirs }}"
+      loop_control:
+        label: "{{ item }}"
+      become: true
+
     - name: "Download compose.yml file for {{ service_name }}"
       ansible.builtin.get_url:
         url: "{{ compose_url }}"
diff --git a/roles/service_deploy/vars/main.yml b/roles/service_deploy/vars/main.yml
@@ -1,2 +1,3 @@
 ---
+data_dir: "{{ data_base_dir }}/{{ service_dir_name }}"
 service_dir: "{{ service_base_dir }}/{{ service_dir_name }}"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+---`
	`2`	`+calibre_web_automated_dir_name: "calibre-web-automated"`