1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
## The Epube
Self-hosted web EPUB reader using EPUB.js, Bootstrap, and Calibre.
* responsive, offline-capable design;
* integrates with Calibre library;
* multi-device sync of last-read pages (when online);
* word definition lookups using dictd / Wiktionary;
* supports Chrome homescreen "app mode";
* optional hyphenation using [hyphen](https://github.com/ytiurin/hyphen) library;
* various themes, etc;
See also:
* [Android client (wrapper)](https://git.tt-rss.org/fox/the-epube-android)
* [Demo](https://srv.tt-rss.org/books/) (login as <code>demo</code>, <code>demo</code>; database is restored every three hours)
### Screenshots
#### Library
<a href="https://tt-rss.org/images/epube/library1.png?2"><img src="https://tt-rss.org/images/epube/library1_small.png?3"></a>
#### Reader
<a href="https://tt-rss.org/images/epube/reader2.png?4"><img src="https://tt-rss.org/images/epube/reader2_small.png?5"></a>
### UI cheat sheet
* Switch pages: Left, Right, Mouse wheel, swipe left/right, space, taps/clicks on left and right sides of the window
* Show UI if it's hidden: escape or tap somewhere in the middle of reader window
* Dictionary lookup: double click/select one word
### Installation
I suggest using compose with my [Docker Hub](https://hub.docker.com/u/cthulhoo) images (note `static-dockerhub` [branch](https://git.tt-rss.org/fox/epube-docker-compose.git/tree/?h=static-dockerhub) below). Those go through a proper CI/CD pipeline so there are some safeguards involved which would hopefully prevent a broken image getting pushed out.
```sh
git clone -b static-dockerhub https://git.tt-rss.org/fox/epube-docker-compose.git epube-docker-compose
cd epube-docker-compose
cp .env-dist .env
vi .env
docker-compose up
```
Alternatively, you can use [master branch](https://git.tt-rss.org/fox/epube-docker-compose.git/) compose file which would build a DIY image using latest Epube source from Git:
```sh
git clone https://git.tt-rss.org/fox/epube-docker-compose.git epube-docker-compose
cd epube-docker-compose
cp .env-dist .env
vi .env
docker-compose up --build
```
---------------
For host installation, see [README.md](https://git.tt-rss.org/fox/the-epube.git/tree/README.md)
### FAQ
#### Moving between pages is slow with some books
This happens sometime on slow devices, i.e. phones. The usual reason is Epub chapters are too large. Those can be split into smaller sections with Calibre epub converter: *EPUB Output -> Split files larger than ->* set a smaller value, 100KB should be fine.
|
