external/iiab
1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-02-15 04:32:11 +00:00
Code Issues Releases Wiki Activity

Update documentation

Browse source
This commit is contained in:
Arky 2018-08-27 17:58:11 +07:00
parent f8c50aa589
commit 826cf7b443
1 changed files with 21 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -2,29 +2,27 @@
Calibre-web README Calibre-web README
==================== ====================
This Ansible role installs Calibre Web within Internet-in-a-Box. Calibre Web is This Ansible role installs Calibre-web in Internet-in-a-Box. Calibre-web server
a web app providing a clean interface for browsing, reading and downloading eBooks provides a clean interface for browsing, reading and downloading eBooks
using an existing Calibre database. using an existing Calibre database.
Access Access
------ ------
If enabled and with the default settings Calibre-web should be accessible at http://box/calibre-web. After installation you can access Calibre-web at `http://box/calibre-web` using the
This is front-end application running under Apache2 httpd. following IIAB calibre-web administration account.
To login to Calibre-web enter
Username: Admin Username: Admin
Password: changme Password: changme
When a configuration is not found calibre-web uses its default administration credentials. If the default configuration is not found calibre-web server creates a new settings file
with calibre-web default administration 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 the following commands:
@ -39,29 +37,33 @@ You can manage the backend Calibre-web server manually with the following comman
Configuration Configuration
------------- -------------
You can login using the default administration account. Then select "Configuration" To configure calibre-web, first login as 'Admin'. Then select 'Configuration'
under admin panel. under the admin panel.
The default database path is /library/calibre-web/
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 Upgrading
--------- ---------
Reinstalling Calibre-web automatically upgrades to the latest version. Please backup your configuration 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. before reinstalling. To retain your configuration set `calibreweb_provision` variable to False.
You can manually upgrade while following commands: You can manually upgrade using 'git' command:
$ cd /opt/calibre-web $ cd /opt/calibre-web
$ sudo git pull $ sudo git pull
Backup Content Backuping Content
-------------- --------------
Calibre-web stores its configuration into SQLite database file /library/calibre-web/app.db. Calibre-web stores eBooks and various configuration settings under /library/calibre-web.
The content is stored in various folders under /library/calibre-web. Please backup the files before Please backup this folder before upgrading. Also set `calibreweb_provision` variable to
upgrading. Also set calibreweb_provision variable to False before upgrading. False before upgrading to prevent the Provision script from over-writting your settings.
Known Issues Known Issues
------------ ------------
Current implementation of the calibre-web in Internet in a box doesn't include https/SSL configuration. Trying to access a empty public bookshelf causes a system error.
Some of the administration login urls might not work.
Current implementation of the calibre-web in Internet in a box doesn't include ebook converter program.