1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-02-12 19:22:24 +00:00
iiab/roles/calibre-web
2018-08-27 13:27:23 -04:00
..
defaults Update main.yml 2018-08-27 12:40:38 -04:00
files Adding 'app.db' settings with IIAB provisioning settings 2018-08-26 13:59:17 +07:00
tasks Update main.yml 2018-08-27 13:27:23 -04:00
templates @jvonau recommends avoiding duplicate call 2018-08-27 11:46:30 -04:00
README.rst Update README.rst 2018-08-27 11:50:23 -04:00

==================
Calibre-Web README
==================

Calibre-Web server provides a clean interface for browsing, reading and
downloading e-books using an existing Calibre database.  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!)

Access
------

After installation you can access calibre-web at `http://box:8083` or
`http://box/calibre-web` (in future we may consider `http://box/books`).
You can log in with administrative account:

 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:

 Username: admin

 Password: admin123

Backend
-------

You can manage the backend calibre-web server manually with these commands:

  systemctl enable calibre-web

  systemctl start calibre-web

  systemctl status calibre-web

  systemctl stop calibre-web

Configuration
-------------

To configure calibre-web, first login as 'Admin'.  Then select 'Configuration'
under the admin panel.

The default calibre-web settings are stored under
'/library/calibre-web/config/app.db' database file. The calibre-web stores
its eBook information in calibre database '/library/calibre-web/metadata.db'
file.

Upgrading
---------

Reinstalling calibre-web automatically upgrades to the latest version.
Please back up your configuration before reinstalling.  To retain your
configuration, set `calibreweb_provision` variable to False.

You can manually upgrade using 'git' command:

$ cd /opt/calibre-web

$ sudo git pull

Backup Your Content
-------------------

calibre-web stores e-books and various configuration settings under
/library/calibre-web.  Please back up this folder before upgrading.  Also set
variable `calibreweb_provision` to False before upgrading, to prevent the
Provision script from overwriting your settings.

Known Issues
------------

Trying to access an empty public bookshelf causes a system error.

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).