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

Andrew Dolgov 6836be7ced fix keep_ui_checkbox not working 1 week ago
css b5a23ba421 reader.css: use updated link colors 1 month ago
db 05b286c2b5 add db/ 2 years ago
img 65ef787572 update icon 1 month ago
js 6836be7ced fix keep_ui_checkbox not working 1 week ago
lib 8c6eba87d9 sync accent color to icon 1 month ago
sessions e12535e601 add .empty back 1 year ago
themes b5a23ba421 reader.css: use updated link colors 1 month ago
.gitignore 9298f4da48 upd .gitignore 3 months ago
COPYING 1acf84942d add COPYING 1 year ago
README.md 499e7ad0bd update launcher icons 1 month ago
backend.php c62fa6c187 cover: add last-modified 4 months ago
config.php-dist dfee22901d * use PDO::sqlite 1 year ago
db.php dfee22901d * use PDO::sqlite 1 year ago
index.php 7d6dabec3b simplify toolbar buttons 1 month ago
login.php 499e7ad0bd update launcher icons 1 month ago
logout.php dcffa74b03 force logout user when login from is rendered 4 months ago
manifest.json 65ef787572 update icon 1 month ago
offline.html 7d6dabec3b simplify toolbar buttons 1 month ago
read.html 50b99afa06 move inline scripts from read.html to read.js; fix some eslint-related stuff 2 months 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 4 months ago
useradm.php 76760cffe0 update password if adding but user exists 10 months ago
worker.js e0ceffe287 worker: fix some lint issues 1 month 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

  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.