2018-09-12 16:32:40 +00:00
.. |ss| raw :: html
<strike>
.. |se| raw :: html
</strike>
2018-09-12 16:41:58 +00:00
.. |nbsp| unicode :: 0xA0
:trim:
2018-08-27 14:51:38 +00:00
==================
Calibre-Web README
==================
2018-08-13 17:11:42 +00:00
2018-08-28 10:07:51 +00:00
Calibre-Web provides a clean interface for browsing, reading and downloading
2018-08-29 21:26:45 +00:00
e-books using an existing Calibre database. Teachers can upload e-books,
adjust e-book metadata, and create custom e-book collections ("bookshelves"):
2018-08-28 10:29:28 +00:00
https://github.com/janeczku/calibre-web#about
2018-08-29 21:26:45 +00:00
This Ansible role installs Calibre-Web as part of your Internet-in-a-Box (IIAB)
2018-09-12 18:12:22 +00:00
as a possible alternative to Calibre.
2021-12-30 20:12:40 +00:00
*WARNING: Calibre-Web depends on Calibre's own* `` /usr/bin/ebook-convert `` *program,
2018-09-12 18:12:22 +00:00
so we strongly recommend you also install Calibre during your IIAB
installation!*
2018-09-12 17:56:06 +00:00
Please note Calibre-Web's Ansible playbook is `` /opt/iiab/iiab/roles/calibre-web ``
2018-09-12 17:59:24 +00:00
whereas its Ansible variables `` calibreweb_* `` do **not** include the dash,
2018-09-12 17:56:06 +00:00
per Ansible recommendations.
2018-08-13 17:11:42 +00:00
2018-08-28 10:07:51 +00:00
Using It
--------
2018-08-28 00:20:51 +00:00
2018-09-12 17:56:06 +00:00
After installation, try out Calibre-Web at http://box/books (or box.lan/books).
2018-08-28 10:07:51 +00:00
Typically students access it without a password (to read and download books)
whereas teachers add books using an administrative account, as follows::
2018-08-13 17:11:42 +00:00
2018-08-27 23:00:01 +00:00
Username: Admin
Password: changeme
2018-08-13 17:11:42 +00:00
2018-09-12 17:56:06 +00:00
If the default configuration is not found, the Calibre-Web server creates a
2018-08-29 21:26:45 +00:00
new settings file with calibre-web's own default administrative account::
2018-08-15 13:35:10 +00:00
2018-08-27 23:00:01 +00:00
Username: admin
Password: admin123
2018-08-15 13:35:10 +00:00
2018-08-13 17:11:42 +00:00
Backend
2018-08-27 14:51:38 +00:00
-------
2018-09-12 17:56:06 +00:00
You can manage the backend Calibre-Web server with these systemd commands::
2018-08-13 17:11:42 +00:00
systemctl enable calibre-web
2018-08-27 23:00:01 +00:00
systemctl restart calibre-web
2018-08-13 17:11:42 +00:00
systemctl status calibre-web
systemctl stop calibre-web
2018-08-14 02:29:59 +00:00
2023-07-22 23:15:19 +00:00
Errors and warnings can be seen if you run::
journalctl -u calibre-web
Log verbosity level can be `adjusted <https://github.com/janeczku/calibre-web/wiki/Configuration#logfile-configuration> `_ within Calibre-Web's web **Configuration > Basic Configuration > Logfile Configuration** .
2018-08-14 02:29:59 +00:00
Configuration
-------------
2018-09-12 17:56:06 +00:00
To configure Calibre-Web, log in as user 'Admin' then click 'Admin' on top.
2018-08-28 10:07:51 +00:00
Check 'Configuration' options near the bottom of the page.
2018-08-27 10:58:11 +00:00
2018-08-28 00:27:50 +00:00
Critical settings are stored in::
2018-08-27 23:00:01 +00:00
/library/calibre-web/config/app.db
2018-08-28 00:27:50 +00:00
Your e-book metadata is stored in a Calibre-style database::
2018-08-27 23:00:01 +00:00
/library/calibre-web/metadata.db
2018-08-28 00:27:50 +00:00
See also::
2018-08-27 23:00:01 +00:00
/library/calibre-web/metadata_db_prefs_backup.json
2022-03-08 03:20:26 +00:00
Finally, take note of Calibre-Web's `FAQ <https://github.com/janeczku/calibre-web/wiki/FAQ> `_ and official docs on its `Runtime Configuration Options <https://github.com/janeczku/calibre-web/wiki/Configuration> `_ and `Command Line Interface <https://github.com/janeczku/calibre-web/wiki/Command-Line-Interface> `_ .
2019-02-27 00:59:40 +00:00
2018-08-29 21:14:16 +00:00
Back Up Everything
------------------
2018-08-27 23:00:01 +00:00
2018-08-28 00:33:55 +00:00
Please back up the entire folder `` /library/calibre-web `` before upgrading —
2018-09-12 17:56:06 +00:00
as it contains your Calibre-Web content **and** settings!
2018-08-15 13:35:10 +00:00
2018-08-14 02:29:59 +00:00
Upgrading
---------
2018-08-27 14:51:38 +00:00
2018-09-12 17:56:06 +00:00
Reinstalling Calibre-Web automatically upgrades to the latest version if your
2018-08-29 21:26:45 +00:00
Internet-in-a-Box (IIAB) is online.
2018-08-14 02:29:59 +00:00
2018-08-29 21:26:45 +00:00
But first: back up your content **and** settings, as explained above.
2018-08-27 23:00:01 +00:00
2022-03-07 15:24:42 +00:00
**Also move your /library/calibre-web/config/app.db AND/OR
2022-03-07 15:26:22 +00:00
/library/calibre-web/metadata.db out of the way — if you're sure you want to
2022-03-07 15:24:42 +00:00
fully reset your Calibre-Web settings (to install defaults) AND/OR remove all
2022-03-07 13:44:28 +00:00
e-book metadata! Then run**::
2018-08-27 23:00:01 +00:00
cd /opt/iiab/iiab
2022-03-07 15:34:36 +00:00
./runrole --reinstall calibre-web
2018-08-14 02:29:59 +00:00
2018-09-12 17:56:06 +00:00
Or, if you just want to upgrade Calibre-Web code alone, prior to proceeding
2018-08-28 00:27:50 +00:00
manually::
2018-08-14 02:29:59 +00:00
2022-02-16 04:55:25 +00:00
cd /usr/local/calibre-web-py3
2018-08-27 23:00:01 +00:00
git pull
2018-08-14 02:29:59 +00:00
2022-03-07 13:52:00 +00:00
This older way *is no longer recommended* ::
cd /opt/iiab/iiab
2022-03-08 03:20:26 +00:00
./iiab-install --reinstall # OR: ./iiab-configure
2022-03-07 13:52:00 +00:00
2018-08-14 02:29:59 +00:00
Known Issues
------------
2018-08-27 14:51:38 +00:00
2018-09-12 16:41:58 +00:00
* |ss| Trying to access an empty public bookshelf causes a system error. |se| |nbsp| Appears fixed as of 2018-09-12: `janeczku/calibre-web#620 <https://github.com/janeczku/calibre-web/issues/620> `_
2018-08-27 10:58:11 +00:00
2018-09-12 16:32:40 +00:00
* |ss| As of August 2018, it's sometimes impossible to set the language of an
2018-09-12 16:41:58 +00:00
e-book: `#1040 <https://github.com/iiab/iiab/issues/1040> `_ , `janeczku/calibre-web#593 <https://github.com/janeczku/calibre-web/issues/593> `_ |se| |nbsp| Appears fixed as of 2018-09-12: `janeczku/calibre-web#620 <https://github.com/janeczku/calibre-web/issues/620> `_
2018-08-29 16:55:11 +00:00
2018-09-12 17:56:06 +00:00
* |ss| As of August 2018, Calibre-Web doesn't yet include Calibre's e-book
2018-08-28 10:07:51 +00:00
conversion functionality (e.g. Calibre 3.27.1 [released 2018-07-06] allows
2018-09-12 22:30:42 +00:00
teachers to convert between PDF, EPUB, TXT etc — to permit reading on a
wider array client devices and client software). |se| |nbsp| Fixed by
`janeczku/calibre-web#609 <https://github.com/janeczku/calibre-web/issues/609> `_
in early September 2018.
2018-09-12 17:17:03 +00:00
2018-09-12 22:30:42 +00:00
* |ss| This new Calibre-Web feature (which depends on Calibre's ebook-converter
program) needs to be manually configured as of 2018-09-12:
`janeczku/calibre-web#624 <https://github.com/janeczku/calibre-web/issues/624> `_
|se| |nbsp| Fixed by `#1127 <https://github.com/iiab/iiab/pull/1127> `_ on 2018-09-12.
2018-09-12 22:48:57 +00:00
To manually enable the converting of e-books (automated above, should no
longer be necessary!) log in to http://box/books as Admin/changeme (etc) then
click Admin -> Basic Configuration -> External binaries. Then change these
2 settings:
2018-09-12 17:17:03 +00:00
* Change radio button "No converter" to "Use calibre's ebook converter"
* In textfield "Path to convertertool" type in: `` /usr/bin/ebook-convert ``
2018-09-12 22:48:57 +00:00
Then:
2018-09-12 17:17:03 +00:00
* Submit
2018-09-12 17:56:06 +00:00
* Verify that "ebook-convert" appears on Calibre-Web's "About" page at http://box/books/stats
* Test it by clicking any e-book -> Edit metadata -> Convert book format
2018-08-28 10:07:51 +00:00
2018-09-12 22:30:42 +00:00
* |ss| http://192.168.0.x:8083 does not work, as a result of `iptables <https://github.com/iiab/iiab/blob/master/roles/network/templates/gateway/iiab-gen-iptables#L93> `_ ,
2018-08-29 17:27:09 +00:00
even when `` services_externally_visible: true `` . This is fixable, but perhaps
2018-08-29 21:35:47 +00:00
it's not a priority, as URL's like {http://192.168.0.x/books,
2018-09-12 22:30:42 +00:00
http://10.8.0.x/books, http://127.0.0.1/books and http://box/books} all work. |se| |nbsp| Marked as "wontfix" on 2018-09-12: `#1050 <https://github.com/iiab/iiab/issues/1050> `_
2018-08-29 17:27:09 +00:00
2020-02-02 17:30:19 +00:00
* |ss| Calibre-Web does not currently use version numbers, so glitches may
2018-08-29 21:42:22 +00:00
occasionally arise, when upstream developers change its master branch without
2020-02-02 17:30:19 +00:00
warning. |se|
2018-08-29 17:27:09 +00:00
2020-02-02 17:30:19 +00:00
* |ss| Imagemagick policy prevents generating thumbnails for PDF's during upload: `#1530 <https://github.com/iiab/iiab/issues/1530> `_ `janeczku/calibre-web#827 <https://github.com/janeczku/calibre-web/issues/827> `_ |se|
2019-03-02 17:45:55 +00:00
2021-12-30 20:12:40 +00:00
* |ss| Upload of not supported file formats gives no feedback to the user: `janeczku/calibre-web#828 <https://github.com/janeczku/calibre-web/issues/828> `_ |se| |nbsp| Fixed by `361a124 <https://github.com/janeczku/calibre-web/commit/361a1243d732116e6f520fabbaae017068b86037> `_ on 2019-02-27.
2019-03-02 17:45:55 +00:00
2018-08-29 17:27:09 +00:00
* *Please assist us in reporting serious issues here:*
https://github.com/janeczku/calibre-web/issues
