diff options
| author | Andrew Dolgov <fox@fakecake.org> | 2026-06-07 18:48:43 +0300 |
|---|---|---|
| committer | Andrew Dolgov <fox@fakecake.org> | 2026-06-07 18:48:43 +0300 |
| commit | ace3394e9b435e655fa0be5edeb4a0f2af873019 (patch) | |
| tree | bf2bc9fc2154c2d14d989cee78d6697b36d09bd0 | |
| parent | 2465f02b732e35ec8b79ca7f3242f78b527dfded (diff) | |
| download | the-epube-ace3394e9b435e655fa0be5edeb4a0f2af873019.tar.gz the-epube-ace3394e9b435e655fa0be5edeb4a0f2af873019.tar.xz | |
update readme
| -rw-r--r-- | README.md | 54 |
1 files changed, 42 insertions, 12 deletions
diff --git a/README.md b/README.md index 0108c44..f3d3dda 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,53 @@ The Epube ========= -web EPUB reader using EPUB.js, Bootstrap, and Calibre. - -Copyright (c) 2017 Andrew Dolgov (unless explicitly stated otherwise). +Self-hosted web EPUB reader backed by a Calibre library. + +Features +-------- + +- Reads metadata and books from a Calibre library (metadata.db + books directory) +- Full EPUB reader with pagination, table of contents, and search within books +- Offline/PWA support via service worker and IndexedDB caching +- Reading progress tracking per user, synced between sessions +- Favorites system +- Multi-user authentication (local or OpenID Connect) +- Downloads in any format Calibre holds (EPUB, MOBI, etc.) +- Series and author browsing with search +- Night mode, customizable font family/size/line-height +- Word definition lookup via optional dictionary service (dictd) Requirements -============ +------------ + +- PHP 7.1+ +- SQLite or PostgreSQL +- A Calibre library directory +- HTTPS recommended (required for service worker registration) + +Installation +------------ -* HTTPS: required for service workers to work -* Docker -* Calibre books directory and metadata.db +1. Clone this repository. +2. Copy `.env-dist` to `.env` and configure paths and credentials. +3. Ensure the `db/` directory is writable (for SQLite) or set `EPUBE_DB_TYPE=pgsql` for PostgreSQL. +4. Run `npm install && npm run build` and `composer install`. +5. Run `php update.php --update-schema` to initialize the database. +6. Point your web server at the repository root. -Acknowledgements -================ +Docker +------ -Normal favicon from Silk icon pack - http://www.famfamfam.com/lab/icons/silk/ +Development and production deployment via docker-compose: + + docker compose up + +The default setup includes PostgreSQL, the application, and an Nginx frontend. +See `.env-dist` for configuration options. License -======= +------- -GNU GPL version 3. +GNU GPL version 3. See COPYING for details. + +Copyright (c) 2017 Andrew Dolgov (unless explicitly stated otherwise). |
