From d10c73a9664dedd0a4791fc18d39b9b6d297facc Mon Sep 17 00:00:00 2001 From: A Holt Date: Tue, 28 Aug 2018 06:07:51 -0400 Subject: [PATCH 1/3] Update README.rst --- roles/calibre-web/README.rst | 38 ++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/roles/calibre-web/README.rst b/roles/calibre-web/README.rst index e248814b8..fce937f87 100644 --- a/roles/calibre-web/README.rst +++ b/roles/calibre-web/README.rst @@ -2,25 +2,29 @@ Calibre-Web README ================== -Calibre-Web server provides a clean interface for browsing, reading and -downloading e-books using an existing Calibre database. +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: -This Ansible role installs Calibre-Web in Internet-in-a-Box (we'll call it -'calibre-web' from here on down, noting that ``calibreweb_*`` variables do not -include the dash, per Ansible recommendations.) + https://github.com/janeczku/calibre-web -Access ------- +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). -After installation you can access calibre-web at http://box/books +Using It +-------- -Log in with administrative account:: +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:: Username: Admin Password: changeme If the default configuration is not found, calibre-web server creates a -new settings file with calibre-web's own default administrative account:: +new settings file with calibre-web's own administrative account default:: Username: admin Password: admin123 @@ -28,7 +32,7 @@ new settings file with calibre-web's own default administrative account:: Backend ------- -You can manage the backend calibre-web server manually with these commands:: +You can manage the backend calibre-web server with these systemd commands:: systemctl enable calibre-web systemctl restart calibre-web @@ -38,8 +42,8 @@ You can manage the backend calibre-web server manually with these commands:: Configuration ------------- -To configure calibre-web, login as user 'Admin' then click on 'Admin' panel on -top. See 'Configuration' options near the bottom of the page. +To configure calibre-web, login as user 'Admin' then click 'Admin' on top. +Check 'Configuration' options near the bottom of the page. Critical settings are stored in:: @@ -67,7 +71,7 @@ Reinstalling calibre-web automatically upgrades to the latest version. 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 -a bare/minimal metadata.db and force default settings. Then run**:: +a bare/minimal metadata.db and force all settings to the default. Then run**:: cd /opt/iiab/iiab ./runrole calibre-web @@ -89,6 +93,10 @@ Known Issues * Trying to access an empty public bookshelf causes a system error. * As of August 2018, calibre-web doesn't yet include Calibre's e-book - conversion functionality (Calibre 3.27.1 [released 2018-07-06] allows + 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). + +* 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 From 97053f9da5659c0b9e60caec301ccb3431fcaf07 Mon Sep 17 00:00:00 2001 From: A Holt Date: Tue, 28 Aug 2018 06:29:28 -0400 Subject: [PATCH 2/3] Update README.rst --- roles/calibre-web/README.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/roles/calibre-web/README.rst b/roles/calibre-web/README.rst index fce937f87..dfa0dd350 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 and arrange -e-books by adjusting their metadata etc: +e-books using an existing Calibre database. Teachers can add upload e-books, +adjust e-book metadata, and create custom book collections ("bookshelves"): +https://github.com/janeczku/calibre-web#about - https://github.com/janeczku/calibre-web - -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). +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). Using It -------- From c7db5918e8ee707a7087e690805b8fed2aad9910 Mon Sep 17 00:00:00 2001 From: A Holt Date: Tue, 28 Aug 2018 06:31:21 -0400 Subject: [PATCH 3/3] Update README.rst --- roles/calibre-web/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/calibre-web/README.rst b/roles/calibre-web/README.rst index dfa0dd350..3b2efca1a 100644 --- a/roles/calibre-web/README.rst +++ b/roles/calibre-web/README.rst @@ -23,7 +23,7 @@ whereas teachers add books using an administrative account, as follows:: Username: Admin Password: changeme -If the default configuration is not found, calibre-web server creates a +If the default configuration is not found, the calibre-web server creates a new settings file with calibre-web's own administrative account default:: Username: admin