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
|
|
|
|
|
e-books using an existing Calibre database. Teachers can add and arrange
|
|
|
|
|
e-books by adjusting their metadata etc:
|
2018-08-28 00:33:55 +00:00
|
|
|
|
2018-08-28 10:07:51 +00:00
|
|
|
https://github.com/janeczku/calibre-web
|
2018-08-13 17:11:42 +00:00
|
|
|
|
2018-08-28 10:07:51 +00:00
|
|
|
This Ansible role installs Calibre-Web to your Internet-in-a-Box, as a possible
|
|
|
|
|
alternative to Calibre (we'll call it 'calibre-web' from here down, noting that
|
|
|
|
|
``calibreweb_*`` variables do not include the dash, 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-08-28 10:07:51 +00:00
|
|
|
After installation, try out calibre-web at http://box/books (or box.lan/books).
|
|
|
|
|
|
|
|
|
|
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-08-27 14:51:38 +00:00
|
|
|
If the default configuration is not found, calibre-web server creates a
|
2018-08-28 10:07:51 +00:00
|
|
|
new settings file with calibre-web's own administrative account default::
|
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-08-28 10:07:51 +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
|
|
|
|
|
|
|
|
Configuration
|
|
|
|
|
-------------
|
|
|
|
|
|
2018-08-28 10:07:51 +00:00
|
|
|
To configure calibre-web, login as user 'Admin' then click 'Admin' on top.
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
Back Up Your Content
|
|
|
|
|
--------------------
|
|
|
|
|
|
2018-08-28 00:33:55 +00:00
|
|
|
Please back up the entire folder ``/library/calibre-web`` before upgrading —
|
2018-08-27 23:00:01 +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
|
|
|
|
|
|
|
|
Reinstalling calibre-web automatically upgrades to the latest version.
|
2018-08-14 02:29:59 +00:00
|
|
|
|
2018-08-27 23:00:01 +00:00
|
|
|
Back up your content **and** settings before reinstalling, as explained above.
|
|
|
|
|
|
|
|
|
|
**Move your /library/calibre-web/metadata.db if you're sure you want to install
|
2018-08-28 10:07:51 +00:00
|
|
|
a bare/minimal metadata.db and force all settings to the default. Then run**::
|
2018-08-27 23:00:01 +00:00
|
|
|
|
|
|
|
|
cd /opt/iiab/iiab
|
|
|
|
|
./runrole calibre-web
|
|
|
|
|
|
2018-08-28 00:27:50 +00:00
|
|
|
Or, to reinstall all of Internet-in-a-Box::
|
2018-08-27 23:00:01 +00:00
|
|
|
|
|
|
|
|
cd /opt/iiab/iiab
|
|
|
|
|
./iiab-install --reinstall
|
2018-08-14 02:29:59 +00:00
|
|
|
|
2018-08-27 23:00:01 +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
|
|
|
|
2018-08-27 23:00:01 +00:00
|
|
|
cd /opt/iiab/calibre-web
|
|
|
|
|
git pull
|
2018-08-14 02:29:59 +00:00
|
|
|
|
|
|
|
|
Known Issues
|
|
|
|
|
------------
|
2018-08-27 14:51:38 +00:00
|
|
|
|
2018-08-28 00:33:55 +00:00
|
|
|
* Trying to access an empty public bookshelf causes a system error.
|
2018-08-27 10:58:11 +00:00
|
|
|
|
2018-08-28 00:41:52 +00:00
|
|
|
* 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-08-28 00:41:52 +00:00
|
|
|
teachers to convert between PDF, epub, txt etc — to permit reading on a wider
|
|
|
|
|
array client devices and client software).
|
2018-08-28 10:07:51 +00:00
|
|
|
|
|
|
|
|
* calibre-web does not currently use version numbers, so glitches might
|
|
|
|
|
occasionally arise using its master branch. Please assist us in reporting
|
|
|
|
|
issues here, if they do arise: https://github.com/janeczku/calibre-web/issues
|
