From 79a22d5af6b55f8e441d058eaa5c3fc4ab4c5b12 Mon Sep 17 00:00:00 2001 From: A Holt Date: Sun, 6 Aug 2023 15:57:15 -0400 Subject: [PATCH] calibre-web/README.rst: Try for < 80 chars for source readability --- roles/calibre-web/README.rst | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/roles/calibre-web/README.rst b/roles/calibre-web/README.rst index 37be1bcc0..d213dc9fa 100644 --- a/roles/calibre-web/README.rst +++ b/roles/calibre-web/README.rst @@ -44,38 +44,48 @@ collections — to help students build the best local community library! Install It ---------- -Install Calibre-Web by setting these 2 variables in `/etc/iiab/local_vars.yml `_:: +Install Calibre-Web by setting these 2 variables in +`/etc/iiab/local_vars.yml `_:: calibreweb_install: True calibreweb_enabled: True -Then install IIAB (`download.iiab.io `_). Or if IIAB's already installed, run:: +Then install IIAB (`download.iiab.io `_). Or if +IIAB's already installed, run:: cd /opt/iiab/iiab sudo ./runrole calibre-web -NOTE: Calibre-Web's Ansible role (playbook) in `/opt/iiab/iiab/roles `_ is ``calibre-web`` which contains a hyphen — *whereas its Ansible variables* ``calibreweb_*`` *do NOT contain a hyphen!* +NOTE: Calibre-Web's Ansible role (playbook) in +`/opt/iiab/iiab/roles `_ is +``calibre-web`` which contains a hyphen — *whereas its Ansible variables* +``calibreweb_*`` *do NOT contain a hyphen!* Using It -------- -Try Calibre-Web on your own IIAB by browsing to http://box/books (or http://box.lan/books). +Try Calibre-Web on your own IIAB by browsing to http://box/books (or +http://box.lan/books). *Students* access it without a password (to read and download books). -*Teachers* add and arrange books using an administrative account, by clicking **Guest** then logging in with:: +*Teachers* add and arrange books using an administrative account, by clicking +**Guest** then logging in with:: Username: Admin Password: changeme 🍒 GURU TIPS 🍒 -* If Calibre-Web's configuration file (app.db) goes missing, the administrative account will revert to:: +* If Calibre-Web's configuration file (app.db) goes missing, the administrative + account will revert to:: Username: admin Password: admin123 -* If you lose your password, you can change it with the ``-s [username]:[newpassword]`` command-line option: https://github.com/janeczku/calibre-web/wiki/FAQ#what-do-i-do-if-i-lose-my-admin-password +* If you lose your password, you can change it with the + ``-s [username]:[newpassword]`` command-line option: + https://github.com/janeczku/calibre-web/wiki/FAQ#what-do-i-do-if-i-lose-my-admin-password Configuration ------------- @@ -98,7 +108,12 @@ See also:: /library/calibre-web/metadata_db_prefs_backup.json -Finally, take note of Calibre-Web's `FAQ `_ and official docs on its `Runtime Configuration Options `_ and `Command Line Interface `_. +Finally, take note of Calibre-Web's +`FAQ `_ and official docs on +its +`Runtime Configuration Options `_ +and +`Command Line Interface `_. Backend ------- @@ -109,7 +124,8 @@ You can manage the backend Calibre-Web server with systemd commands like:: systemctl stop calibre-web systemctl restart calibre-web -Run all commands `as root `_. +Run all commands +`as root `_. Errors and warnings can be seen if you run::