antifuchs/ComicOPDS
1
0
Fork 0
forked from FrederikBaerentsen/ComicOPDS
Code Pull Requests Activity

Updated docs

Browse Source
This commit is contained in:
FrederikBaerentsen
2025-09-10 20:26:35 +02:00
parent 33415bee7b
commit 9d835930d1
3 changed files with 22 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -1
View File
@@ -1,6 +1,7 @@
# 📚 ComicOPDS
ComicOPDS is a lightweight [OPDS 1.2](https://specs.opds.io/opds-1.2) server written in Python, designed for serving **CBZ comics** with metadata extracted from `ComicInfo.xml`.
It's optimized for large libraries (10k–100k+ comics), supports FastAPI + SQLite + FTS5 search, thumbnail caching, and streaming (OPDS PSE 1.1).
Works great with [Panels for iOS](https://panels.app) and other OPDS readers.
@@ -64,4 +65,4 @@ Works great with [Panels for iOS](https://panels.app) and other OPDS readers.
---
*Made with ❤️ for comic book enthusiasts*
*Made with ❤️ for comic book enthusiasts*
docs/configuration.md
+18 -18
View File
@@ -2,24 +2,24 @@
### Environment Variables
| Variable | Default | Description |
|-----------------------|-------------|-------------|
| `CONTENT_BASE_DIR` | `/library` | Path inside the container where your comics are stored (mounted volume). |
| `PAGE_SIZE` | `50` | Number of entries per page in OPDS feeds. Increase/decrease depending on client performance. |
| `SERVER_BASE` | (required) | Public base URL (e.g. `http://10.0.0.1:8382` or `https://comics.example.com`). Used in generated OPDS links. |
| `URL_PREFIX` | `""` | Path prefix when serving behind a reverse proxy (e.g. `/comics`). Leave empty if served at root or subdomain. |
| `DISABLE_AUTH` | `false` | If `true`, disables authentication completely (public access). |
| `OPDS_BASIC_USER` | `admin` | Username for HTTP Basic Auth. Ignored if `DISABLE_AUTH=true`. |
| `OPDS_BASIC_PASS` | `change-me` | Password for HTTP Basic Auth. Ignored if `DISABLE_AUTH=true`. |
| `ENABLE_WATCH` | `false` | Watch filesystem for changes and update index incrementally. (`true`/`false`). |
| `AUTO_INDEX_ON_START` | `false` | If `true`, reindexes library on every container start. Recommended `false` for large libraries. |
| `PRECACHE_THUMBS` | `false` | If `true`, enables thumbnail generation when reindexing or via dashboard. |
| `PRECACHE_ON_START` | `false` | If `true`, automatically triggers full thumbnail pre-cache at container start. Recommended `false` for large libraries. |
| `THUMB_WORKERS` | `3` | Number of parallel workers for thumbnail generation. Tune for your CPU/IO capacity. |
| `PAGE_CACHE_TTL_DAYS` | `14` | Delete page-caches that have been idle for more than this many days. |
| `PAGE_CACHE_MAX_BYTES` | `10737418240` | Maximum total size of page-cache (10 GiB default). |
| `PAGE_CACHE_AUTOCLEAN` | `true` | Enable automatic background cleanup of page-caches. |
| `PAGE_CACHE_CLEAN_INTERVAL_MIN` | `360` | Run page-cache cleanup every N minutes (360 = 6 hours). |
| Variable | Default | Required | Description |
|-----------------------|-------------|----------|-------------|
| `CONTENT_BASE_DIR` | `/library` | Required | Path inside the container where your comics are stored (mounted volume). |
| `SERVER_BASE` | (none) | Required | Public base URL (e.g. `http://10.0.0.1:8382` or `https://comics.example.com`). Used in generated OPDS links. |
| `URL_PREFIX` | `""` | Optional | Path prefix when serving behind a reverse proxy (e.g. `/comics`). Leave empty if served at root or subdomain. |
| `PAGE_SIZE` | `50` | Optional | Number of entries per page in OPDS feeds. Increase/decrease depending on client performance. |
| `DISABLE_AUTH` | `false` | Optional | If `true`, disables authentication completely (public access). |
| `OPDS_BASIC_USER` | `admin` | Optional | Username for HTTP Basic Auth. Ignored if `DISABLE_AUTH=true`. |
| `OPDS_BASIC_PASS` | `change-me` | Optional | Password for HTTP Basic Auth. Ignored if `DISABLE_AUTH=true`. |
| `ENABLE_WATCH` | `false` | Optional | Watch filesystem for changes and update index incrementally. (`true`/`false`). |
| `AUTO_INDEX_ON_START` | `false` | Optional | If `true`, reindexes library on every container start. Recommended `false` for large libraries. |
| `PRECACHE_THUMBS` | `false` | Optional | If `true`, enables thumbnail generation when reindexing or via dashboard. |
| `PRECACHE_ON_START` | `false` | Optional | If `true`, automatically triggers full thumbnail pre-cache at container start. Recommended `false` for large libraries. |
| `THUMB_WORKERS` | `3` | Optional | Number of parallel workers for thumbnail generation. Tune for your CPU/IO capacity. |
| `PAGE_CACHE_TTL_DAYS` | `14` | Optional | Delete page caches that have been idle for more than this many days. |
| `PAGE_CACHE_MAX_BYTES`| `10737418240` | Optional | Maximum total size of page cache (10 GiB default). |
| `PAGE_CACHE_AUTOCLEAN`| `true` | Optional | Enable automatic background cleanup of page caches. |
| `PAGE_CACHE_CLEAN_INTERVAL_MIN` | `360` | Optional | Run page cache cleanup every N minutes (360 = 6 hours). |
### 📚 Recommended Settings for Large Libraries (30k–100k+ comics)
docs/quickstart.md
+2 -2
View File
@@ -41,7 +41,7 @@ services:
- "./data:/data"
```
> 💡 This minimal configuration includes only the required environment variables. For additional optional settings like authentication, caching, and performance tuning, see the complete list at [Configuration](docs/configuration.md).
> 💡 This minimal configuration includes only the required environment variables. For additional optional settings like authentication, caching, and performance tuning, see the complete list at [Configuration](configuration.md).
### Launch Commands
@@ -61,4 +61,4 @@ docker compose down
- 📡 **OPDS Feed**: http://localhost:8382/
- 📊 **Dashboard**: http://localhost:8382/dashboard
- 🧠 **Smart Lists**: http://localhost:8382/search
- 🧠 **Smart Lists**: http://localhost:8382/search