From bf2c2825ac33cc9d4995c4f993a68e90885c3ca8 Mon Sep 17 00:00:00 2001 From: John O'Keefe Date: Sat, 12 Sep 2026 17:50:31 -0400 Subject: [PATCH] chore(deploy): document ARCHIVE_RETENTION_DAYS in compose and .env.example Days an archived item is kept with its reading history before library scans purge it for good (default 90). Set 0 to keep archived items until purged manually from the library admin page. --- .env.example | 4 ++++ docker-compose.yml | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/.env.example b/.env.example index d4721b2..8ee920a 100644 --- a/.env.example +++ b/.env.example @@ -35,5 +35,9 @@ DBPASS=your-secure-database-password-here # BOOKHOARD_CONVERSION_TOOL=/usr/bin/ebook-convert # Conversion Cache TTL: Override default 24h # BOOKHOARD_CONVERSION_CACHE_TTL=48h +# Archive Retention: days to keep archived items (files missing from disk for +# 2+ scans) before they are purged, deleting their reading history with them. +# Set 0 to keep archived items until purged manually on the library admin page. +# ARCHIVE_RETENTION_DAYS=90 # System timezone (fallback for server-side time operations, defaults to UTC) # TZ=America/New_York \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml index 987f90f..9a7d1bf 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -61,6 +61,12 @@ services: BOOKHOARD_CONVERSION_TOOL: ${BOOKHOARD_CONVERSION_TOOL:-/usr/bin/kepubify} BOOKHOARD_CONVERSION_CACHE_TTL: ${BOOKHOARD_CONVERSION_CACHE_TTL:-24h} + # Library Maintenance + # Days an archived item (file missing from disk for 2+ scans) is kept, + # with its reading history, before library scans purge it for good. + # Set 0 to keep archived items until purged manually on the library admin page. + ARCHIVE_RETENTION_DAYS: ${ARCHIVE_RETENTION_DAYS:-90} + # System timezone (fallback for server-side time operations) TZ: ${TZ:-UTC} ports: