web EPUB reader using EPUB.js, Bootstrap, and Calibre.

Andrew Dolgov 506a5a877e use cog for settings 22 hours ago
css 4f1c7a977b code/layout cleanup 1 week ago
db 05b286c2b5 add db/ 2 years ago
img 65ef787572 update icon 2 months ago
js 8edc1c85da fix cover placeholders 1 week ago
lib 8c6eba87d9 sync accent color to icon 2 months ago
sessions e12535e601 add .empty back 1 year ago
themes b5a23ba421 reader.css: use updated link colors 2 months ago
.gitignore 51d521bed6 upd .gitignore 1 week ago
COPYING 1acf84942d add COPYING 1 year ago
README.md aed2e8d8f6 upd README 1 week ago
backend.php c62fa6c187 cover: add last-modified 5 months ago
config.php-dist fbe4290156 upd config dist 1 week ago
db.php dfee22901d * use PDO::sqlite 1 year ago
index.php 8edc1c85da fix cover placeholders 1 week ago
login.php 499e7ad0bd update launcher icons 2 months ago
logout.php dcffa74b03 force logout user when login from is rendered 5 months ago
manifest.json 65ef787572 update icon 2 months ago
offline.html 4f1c7a977b code/layout cleanup 1 week ago
read.html 506a5a877e use cog for settings 22 hours ago
schema.sql 55f2b0090a add basic favorites via a horrible hack 1 year ago
sessions.php dcffa74b03 force logout user when login from is rendered 5 months ago
useradm.php 76760cffe0 update password if adding but user exists 11 months ago
worker.js e0ceffe287 worker: fix some lint issues 2 months ago

README.md

The Epube

web EPUB reader using EPUB.js, Bootstrap, and Calibre.

  • responsive design
  • has transparent offline mode via service workers
  • can optionally store files locally for later reading
  • supports word definition lookups using dictd
  • supports Chrome homescreen "app mode"
  • has several color themes

Screenshots

See here: https://git.tt-rss.org/fox/the-epube/wiki/Home

Installation

WARNING: since database folder is, by default, accessible for unauthenticated HTTP requests it is recommended to set SCRATCH_DB to a secure random value (i.e. db/long-random-string.db) or put it outside of scope accessible by your http server. Alternatively, you can simply block access to db:

location /the-epube/db {
   deny all;
}
  1. Initialize scratch.db

    sqlite3 db/scratch.db < schema.sql
  2. Ensure both scratch.db and its containing folder (i.e. db/) are writable by the application, normally this means chown-ing them as www-data or whatever user your httpd is running under.

    chown www-data db/ db/scratch.db
  3. Copy config.php-dist to config.php and edit path to Calibre, etc.

  4. Setup users via useradm.php (command line)

Upgrading

When upgrading from an older Git snapshot which used HTTP Authentication:

  1. Disable HTTP Authentication in httpd configuration
  2. Reopen browser to clear HTTP auth
  3. Add two new tables to scratch.db (epube_users & epube_sessions)
  4. Add users via useradm.php (use same names as http auth, all data will be kept)

Requirements

  • HTTPS: required for service workers to work
  • PDO::sqlite
  • Calibre books directory and metadata.db

Acknowledgements

Normal favicon from Silk icon pack - http://www.famfamfam.com/lab/icons/silk/

License

GNU GPL version 3.