external/iiab
1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-03-09 15:40:17 +00:00
Code Issues Releases Wiki Activity

Update README.rst

Browse source
This commit is contained in:
A Holt 2018-08-27 10:51:38 -04:00 • committed by GitHub
parent 700164698f
commit 4bdb987f4c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 37 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

63
roles/calibre-web/README.rst
View file

@ -1,31 +1,34 @@
==================== ==================
Calibre-web README Calibre-Web README
==================== ==================
This Ansible role installs Calibre-web in Internet-in-a-Box. Calibre-web server This Ansible role installs Calibre-Web in Internet-in-a-Box (we'll call it
provides a clean interface for browsing, reading and downloading eBooks "calibre-web" from here on). The calibre-web server provides a clean
using an existing Calibre database. interface for browsing, reading and downloading e-books using an existing
Calibre database.
Access Access
------ ------
After installation you can access Calibre-web at `http://box/calibre-web` using the After installation you can access calibre-web at `http://box:8083` or
following IIAB calibre-web administration account. `http://box/calibre-web` (in future we may consider `http://box/books`).
You can log in with administrative account:
Username: Admin Username: Admin
Password: changme Password: changeme
If the default configuration is not found calibre-web server creates a new settings file If the default configuration is not found, calibre-web server creates a
with calibre-web default administration account. new settings file with calibre-web's own default administrative account:
Username: admin Username: admin
Password: admin123 Password: admin123
Backend Backend
-------- -------
You can manage the backend Calibre-web server manually with the following commands:
You can manage the backend calibre-web server manually with these commands:
systemctl enable calibre-web systemctl enable calibre-web
@ -37,18 +40,21 @@ You can manage the backend Calibre-web server manually with the following comman
Configuration Configuration
------------- -------------
To configure calibre-web, first login as 'Admin'. Then select 'Configuration'
To configure calibre-web, first login as 'Admin'. Then select 'Configuration'
under the admin panel. under the admin panel.
The default calibre-web settings are stored under
The default calibre-web settings are stored under '/library/calibre-web/config/app.db' '/library/calibre-web/config/app.db' database file. The calibre-web stores
database file. The calibre-web stores its eBook information in calibre database its eBook information in calibre database '/library/calibre-web/metadata.db'
'/library/calibre-web/metadata.db' file. file.
Upgrading Upgrading
--------- ---------
Reinstalling Calibre-web automatically upgrades to the latest version. Please backup your configuration
before reinstalling. To retain your configuration set `calibreweb_provision` variable to False. Reinstalling calibre-web automatically upgrades to the latest version.
Please backup your configuration before reinstalling. To retain your
configuration set `calibreweb_provision` variable to False.
You can manually upgrade using 'git' command: You can manually upgrade using 'git' command:
@ -57,13 +63,18 @@ $ cd /opt/calibre-web
$ sudo git pull $ sudo git pull
Backuping Content Backuping Content
-------------- -----------------
Calibre-web stores eBooks and various configuration settings under /library/calibre-web.
Please backup this folder before upgrading. Also set `calibreweb_provision` variable to calibre-web stores e-books and various configuration settings under
False before upgrading to prevent the Provision script from over-writting your settings. /library/calibre-web. Please backup this folder before upgrading. Also set
`calibreweb_provision` variable to False before upgrading to prevent the
Provision script from over-writting your settings.
Known Issues Known Issues
------------ ------------
Trying to access a empty public bookshelf causes a system error. Trying to access a empty public bookshelf causes a system error.
Current implementation of the calibre-web in Internet in a box doesn't include ebook converter program. 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).