diff --git a/roles/calibre-web/README.rst b/roles/calibre-web/README.rst index e7c735158..9c6b50420 100644 --- a/roles/calibre-web/README.rst +++ b/roles/calibre-web/README.rst @@ -1,31 +1,34 @@ -==================== -Calibre-web README -==================== +================== +Calibre-Web README +================== -This Ansible role installs Calibre-web in Internet-in-a-Box. Calibre-web server -provides a clean interface for browsing, reading and downloading eBooks -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). The calibre-web server provides a clean +interface for browsing, reading and downloading e-books using an existing +Calibre database. Access ------ -After installation you can access Calibre-web at `http://box/calibre-web` using the -following IIAB calibre-web administration account. +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 + Username: Admin - Password: changme + Password: changeme -If the default configuration is not found calibre-web server creates a new settings file -with calibre-web default administration account. +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 the following commands: +------- + +You can manage the backend calibre-web server manually with these commands: systemctl enable calibre-web @@ -37,18 +40,21 @@ You can manage the backend Calibre-web server manually with the following comman 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. - -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. +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 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: @@ -57,13 +63,18 @@ $ cd /opt/calibre-web $ sudo git pull 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 -False before upgrading to prevent the Provision script from over-writting your settings. +----------------- + +calibre-web stores e-books and various configuration settings under +/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 ------------ + 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).