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

Andrew Dolgov a298797c61 default to dark theme on index to prevent white flashes 4 days ago
css 6920124b40 remove unneeded <b> tags from reader title 5 months ago
db 05b286c2b5 add db/ 2 years ago
img 65ef787572 update icon 1 year ago
js bafd0b7474 enable automatic night mode for index pages 1 month ago
lib bafd0b7474 enable automatic night mode for index pages 1 month ago
sessions e12535e601 add .empty back 2 years ago
themes 235438373a lower contrast a bit on night themes 4 days ago
.eslintrc.js 922d399dd0 add eslintrc 7 months ago
.gitignore 4d108431dd add some placeholder stuff for ttf files 5 months ago
COPYING 1acf84942d add COPYING 2 years ago
README.md 11bcabe3bf update README 2 months ago
backend.php 337bd2bdf5 add basic wiktionary support 7 months ago
config.php-dist fbe4290156 upd config dist 10 months ago
db.php dfee22901d * use PDO::sqlite 2 years ago
index.php a298797c61 default to dark theme on index to prevent white flashes 4 days ago
login.php 499e7ad0bd update launcher icons 1 year ago
logout.php dcffa74b03 force logout user when login from is rendered 1 year ago
manifest.json 65ef787572 update icon 1 year ago
offline.html a298797c61 default to dark theme on index to prevent white flashes 4 days ago
read.html 351f32cd42 default.css: auto switch night/day modes 1 month ago
schema.sql 55f2b0090a add basic favorites via a horrible hack 2 years ago
sessions.php dcffa74b03 force logout user when login from is rendered 1 year ago
useradm.php 76760cffe0 update password if adding but user exists 1 year ago
worker.js bafd0b7474 enable automatic night mode for index pages 1 month ago

README.md

The Epube

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

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

Copyright (c) 2017 Andrew Dolgov (unless explicitly stated otherwise).

Requirements

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

Installation

Always use latest Git code from master branch. Ignore the releases page, it doesn't mean anything.

git clone https://git.tt-rss.org/fox/the-epube.git the-epube

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)

Acknowledgements

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

License

GNU GPL version 3.