diff --git a/roles/calibre-web/README.rst b/roles/calibre-web/README.rst index 3ce5241f5..b2527156a 100644 --- a/roles/calibre-web/README.rst +++ b/roles/calibre-web/README.rst @@ -3,14 +3,14 @@ Calibre-Web README ================== Calibre-Web provides a clean interface for browsing, reading and downloading -e-books using an existing Calibre database. Teachers can add upload e-books, -adjust e-book metadata, and create custom book collections ("bookshelves"): +e-books using an existing Calibre database. Teachers can upload e-books, +adjust e-book metadata, and create custom e-book collections ("bookshelves"): https://github.com/janeczku/calibre-web#about -This Ansible role installs Calibre-Web as part of 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). +This Ansible role installs Calibre-Web as part of your Internet-in-a-Box (IIAB) +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). Using It -------- @@ -24,7 +24,7 @@ whereas teachers add books using an administrative account, as follows:: Password: changeme If the default configuration is not found, the calibre-web server creates a -new settings file with calibre-web's own administrative account default:: +new settings file with calibre-web's own default administrative account:: Username: admin Password: admin123 @@ -42,7 +42,7 @@ You can manage the backend calibre-web server with these systemd commands:: Configuration ------------- -To configure calibre-web, login as user 'Admin' then click 'Admin' on top. +To configure calibre-web, log in as user 'Admin' then click 'Admin' on top. Check 'Configuration' options near the bottom of the page. Critical settings are stored in:: @@ -57,8 +57,8 @@ See also:: /library/calibre-web/metadata_db_prefs_backup.json -Back Up Your Content --------------------- +Back Up Everything +------------------ Please back up the entire folder ``/library/calibre-web`` before upgrading — as it contains your calibre-web content **and** settings! @@ -66,17 +66,19 @@ as it contains your calibre-web content **and** settings! Upgrading --------- -Reinstalling calibre-web automatically upgrades to the latest version. +Reinstalling calibre-web automatically upgrades to the latest version if your +Internet-in-a-Box (IIAB) is online. -Back up your content **and** settings before reinstalling, as explained above. +But first: back up your content **and** settings, as explained above. -**Move your /library/calibre-web/metadata.db if you're sure you want to install -a bare/minimal metadata.db and force all settings to the default. Then run**:: +**Then move your /library/calibre-web/metadata.db out of the way, if you're +sure you want to (re)install bare/minimal metadata, and force all calibre-web +settings to the default. Then run**:: cd /opt/iiab/iiab ./runrole calibre-web -Or, to reinstall all of Internet-in-a-Box:: +Or, to reinstall all of IIAB:: cd /opt/iiab/iiab ./iiab-install --reinstall @@ -92,21 +94,22 @@ Known Issues * Trying to access an empty public bookshelf causes a system error. -* It's sometime impossible to set the language of an e-book: `#1040 `_ - `janeczku/calibre-web#593 `_ +* As of August 2018, it's sometimes impossible to set the language of an + e-book: `#1040 `_, `janeczku/calibre-web#593 `_ * As of August 2018, calibre-web doesn't yet include Calibre's e-book conversion functionality (e.g. Calibre 3.27.1 [released 2018-07-06] allows - teachers to convert between PDF, epub, txt etc — to permit reading on a wider - array client devices and client software). + teachers to convert between PDF, EPUB, HTML, TXT etc — to permit reading on a + wider array client devices and client software). * http://192.168.0.x:8083 does not work, as a result of `iptables `_, even when ``services_externally_visible: true``. This is fixable, but perhaps - it's not a priority, as {http://192.168.0.x/books, http://box/books, etc} URL's - all work. + it's not a priority, as URL's like {http://192.168.0.x/books, + http://10.8.0.x/books, http://127.0.0.1/books and http://box/books} all work. * calibre-web does not currently use version numbers, so glitches might - occasionally arise using its master branch. + occasionally arise, when upstream developers change its master branch without + warning. * *Please assist us in reporting serious issues here:* https://github.com/janeczku/calibre-web/issues