2018-08-27 14:51:38 +00:00
|
|
|
==================
|
|
|
|
|
Calibre-Web README
|
|
|
|
|
==================
|
2018-08-13 17:11:42 +00:00
|
|
|
|
2018-08-27 15:50:23 +00:00
|
|
|
Calibre-Web server provides a clean interface for browsing, reading and
|
|
|
|
|
downloading e-books using an existing Calibre database. This Ansible role
|
2018-08-27 23:00:01 +00:00
|
|
|
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.)
|
2018-08-13 17:11:42 +00:00
|
|
|
|
|
|
|
|
Access
|
|
|
|
|
------
|
|
|
|
|
|
2018-08-27 23:00:01 +00:00
|
|
|
After installation you can access calibre-web at http://box/calibre-web (in
|
|
|
|
|
future we may consider http://box/books). Log in with administrative account:
|
2018-08-13 17:11:42 +00:00
|
|
|
|
2018-08-27 23:00:01 +00:00
|
|
|
Username: Admin
|
2018-08-13 17:11:42 +00:00
|
|
|
|
2018-08-27 23:00:01 +00:00
|
|
|
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
|
|
|
|
|
new settings file with calibre-web's own default administrative account:
|
2018-08-15 13:35:10 +00:00
|
|
|
|
2018-08-27 23:00:01 +00:00
|
|
|
Username: admin
|
2018-08-15 13:35:10 +00:00
|
|
|
|
2018-08-27 23:00:01 +00:00
|
|
|
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
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
You can manage the backend calibre-web server manually with these 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-27 23:00:01 +00:00
|
|
|
To configure calibre-web, login as user 'Admin' then click on 'Admin' panel on
|
|
|
|
|
top. See 'Configuration' options near the bottom of the page.
|
2018-08-27 10:58:11 +00:00
|
|
|
|
2018-08-27 23:00:01 +00:00
|
|
|
Critical settings are stored in:
|
|
|
|
|
|
|
|
|
|
/library/calibre-web/config/app.db
|
|
|
|
|
|
|
|
|
|
Your e-book metadata is stored in a Calibre-style database:
|
|
|
|
|
|
|
|
|
|
/library/calibre-web/metadata.db
|
|
|
|
|
|
|
|
|
|
See also:
|
|
|
|
|
|
|
|
|
|
/library/calibre-web/metadata_db_prefs_backup.json
|
|
|
|
|
|
|
|
|
|
Back Up Your Content
|
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
Please back up the entire folder ``/library/calibre-web`` before upgrading --
|
|
|
|
|
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
|
|
|
|
|
a bare/minimal metadata.db and force default settings. Then run:**
|
|
|
|
|
|
|
|
|
|
cd /opt/iiab/iiab
|
|
|
|
|
|
|
|
|
|
./runrole calibre-web
|
|
|
|
|
|
|
|
|
|
Or, to reinstall all of Internet-in-a-Box:
|
|
|
|
|
|
|
|
|
|
cd /opt/iiab/iiab
|
2018-08-14 02:29:59 +00:00
|
|
|
|
2018-08-27 23:00:01 +00:00
|
|
|
./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
|
|
|
|
|
manually:
|
2018-08-14 02:29:59 +00:00
|
|
|
|
2018-08-27 23:00:01 +00:00
|
|
|
cd /opt/iiab/calibre-web
|
2018-08-27 14:51:38 +00:00
|
|
|
|
2018-08-27 23:00:01 +00:00
|
|
|
git pull
|
2018-08-14 02:29:59 +00:00
|
|
|
|
|
|
|
|
Known Issues
|
|
|
|
|
------------
|
2018-08-27 14:51:38 +00:00
|
|
|
|
2018-08-27 14:53:43 +00:00
|
|
|
Trying to access an empty public bookshelf causes a system error.
|
2018-08-27 10:58:11 +00:00
|
|
|
|
2018-08-27 14:51:38 +00:00
|
|
|
As of August 2018, calibre-web doesn't include Calibre's e-book conversion
|
|
|
|
|
functionality (Calibre itself allows teachers to convert between PDF, epub, txt
|
|
|
|
|
etc — to permit reading on a wider array client devices and client software).
|
