1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-02-15 04:32:11 +00:00
This commit is contained in:
root 2018-08-30 12:35:57 -04:00
commit 78e538b83d
2 changed files with 35 additions and 22 deletions

View file

@ -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,11 +94,22 @@ Known Issues
* Trying to access an empty public bookshelf causes a system error.
* As of August 2018, it's sometimes impossible to set the language of an
e-book: `#1040 <https://github.com/iiab/iiab/issues/1040>`_, `janeczku/calibre-web#593 <https://github.com/janeczku/calibre-web/issues/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 <https://github.com/iiab/iiab/blob/master/roles/network/templates/gateway/iiab-gen-iptables#L93>`_,
even when ``services_externally_visible: true``. This is fixable, but perhaps
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. Please assist us in reporting
issues here, if they do arise: https://github.com/janeczku/calibre-web/issues
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

View file

@ -1,9 +1,9 @@
# Which kiwix-tools to download from http://download.iiab.io/packages/
# As obtained from http://download.kiwix.org/release/kiwix-tools/ or http://download.kiwix.org/nightly/
kiwix_version_armhf: "kiwix-tools_linux-armhf-0.6.0"
kiwix_version_linux64: "kiwix-tools_linux-x86_64-0.6.0"
kiwix_version_i686: "kiwix-tools_linux-i586-0.6.0"
kiwix_version_armhf: "kiwix-tools_linux-armhf-0.6.1"
kiwix_version_linux64: "kiwix-tools_linux-x86_64-0.6.1"
kiwix_version_i686: "kiwix-tools_linux-i586-0.6.1"
# kiwix_src_file_i686: "kiwix-linux-i686.tar.bz2"
# v0.9 for i686 published May 2014 ("use it to test legacy ZIM content")
# v0.10 for i686 published Oct 2016 ("experimental") REPLACED IN EARLY 2018, thx to Matthieu Gautier: