From 4d40d4b06c25649dbbfd99f7b38db664029bd553 Mon Sep 17 00:00:00 2001
From: Rose Liverman <rose@tangentfox.com>
Date: Sat, 24 Jan 2026 20:44:19 -0700
Subject: [PATCH] added config for CWA

---
 calibre-web-automated/ReadMe.md          |  2 +
 calibre-web-automated/docker-compose.yml | 65 ++++++++++++++++++++++++
 2 files changed, 67 insertions(+)
 create mode 100644 calibre-web-automated/ReadMe.md
 create mode 100644 calibre-web-automated/docker-compose.yml

diff --git a/calibre-web-automated/ReadMe.md b/calibre-web-automated/ReadMe.md
new file mode 100644
index 0000000..533432e
--- /dev/null
+++ b/calibre-web-automated/ReadMe.md
@@ -0,0 +1,2 @@
+# Calibre Web Automated (CWA)
+Modified from [official instructions](https://github.com/crocodilestick/Calibre-Web-Automated?tab=readme-ov-file#using-docker-compose-recommended).
diff --git a/calibre-web-automated/docker-compose.yml b/calibre-web-automated/docker-compose.yml
new file mode 100644
index 0000000..779839b
--- /dev/null
+++ b/calibre-web-automated/docker-compose.yml
@@ -0,0 +1,65 @@
+# TODO set volume directories
+# TODO set user/group IDs
+# TODO set timezone (TZ)
+
+volumes:
+  config:
+    driver: local
+    driver_opts:
+      type: none
+      o: bind
+      device: /mnt/apple/calibre/config
+  ingest:
+    driver: local
+    driver_opts:
+      type: none
+      o: bind
+      device: /mnt/apple/calibre/ingest
+  library:
+    driver: local
+    driver_opts:
+      type: none
+      o: bind
+      device: /mnt/apple/calibre/library
+  plugins:
+    driver: local
+    driver_opts:
+      type: none
+      o: bind
+      device: /mnt/apple/calibre/plugins
+
+services:
+  calibre-web-automated:
+    image: crocodilestick/calibre-web-automated:latest
+    container_name: calibre-web-automated
+    environment:
+      # Only change these if you know what you're doing
+      - PUID=1004
+      - PGID=1004
+      # Edit to match your current timezone https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+      - TZ=America/Denver
+      # Hardcover API Key required for Hardcover as a Metadata Provider, get one here: https://docs.hardcover.app/api/getting-started/
+      - HARDCOVER_TOKEN=your_hardcover_api_key_here
+      # If your library is on a network share (e.g., NFS/SMB), disable WAL to reduce locking issues
+      # Accepts: true/false (default: false)
+      - NETWORK_SHARE_MODE=false
+      # Override the default port (8083) for the web server.
+      # Accepts any valid port number.
+      - CWA_PORT_OVERRIDE=8083
+    volumes:
+      # CW users migrating should stop their existing CW instance, make a copy of the config folder, and bind that here to carry over all of their user settings ect.
+      - config:/config
+      # This is an ingest dir, NOT a library one. Anything added here will be automatically added to your library according to the settings you have configured in CWA Settings page. All files placed here are REMOVED AFTER PROCESSING
+      - ingest:/cwa-book-ingest
+      # If you don't have an existing library, CWA will automatically create one at the bind provided here
+      - library:/calibre-library
+      # If you use calibre plugins, you can bind your plugins folder here to have CWA attempt to add them to its workflow (WIP)
+      # If you are starting with a fresh install, you also need to copy customize.py.json to the Calibre config volume above, in /path/to/config/folder/.config/calibre/customize.py.json, see the note below for more info
+      - plugins:/config/.config/calibre/plugins
+    # ports:
+    #   # Change the first number to change the port you want to access the Web UI, not the second
+    #   - 8083:8083
+    # If you set CWA_PORT_OVERRIDE to a port below 1024, you may need to uncomment the following line:
+    # cap_add:
+    #   - NET_BIND_SERVICE
+    restart: unless-stopped