b7dc2c50b7
* initial commit * add non-rootless warning * fix identifier to calibre-web * add trailing version number * fix ref to music, and fix link name to CW --------- Co-authored-by: Slavi Pantaleev <slavi@devture.com>
6.2 KiB
Calibre-Web
Calibre-Web is a web app that offers a clean and intuitive interface for browsing, reading, and downloading eBooks using a valid Calibre database.
Warning Paperless-ngx currently does not support running the container rootless, therefore the role has not the usual security features of other services provided by this playbook. This put your system more at higher risk as vulnerabilities can have a higher impact.
Dependencies
This service requires the following other services:
- a Traefik reverse-proxy server
Configuration
To enable this service, add the following configuration to your vars.yml file and re-run the installation process:
########################################################################
# #
# calibre-web #
# #
########################################################################
calibre_web_enabled: true
calibre_web_hostname: mash.example.com
calibre_web_path_prefix: /calibre-web
# By default, calibre_web will look at the /books directory for your Calibre database.
#
# You'd need to mount some book directory into the calibre_web container, like shown below.
# The "Syncthing integration" section below may be relevant.
# calibre_web_container_additional_volumes:
# - type: bind
# src: /on-host/path/to/books
# dst: /books
########################################################################
# #
# /calibre-web #
# #
########################################################################
URL
In the example configuration above, we configure the service to be hosted at https://mash.example.com/calibre-web.
You can remove the calibre_web_path_prefix variable definition, to make it default to /, so that the service is served at https://mash.example.com/.
Authentication
The default username is admin and the default password is admin123.
You'll be able to change the username and password, and add additional users in the web UI.
On the initial setup screen, enter /books as your calibre library location. If you haven't placed a Calibre database in that directory on the host yet, it will error as an invalid location.
Syncthing integration
If you've got a Syncthing service running, you can use it to synchronize your books directory onto the server and then mount it as read-only into the calibre_web container.
We recommend that you make use of the aux role to create some shared directory like this:
########################################################################
# #
# aux #
# #
########################################################################
aux_directory_definitions:
- dest: "{{ mash_playbook_base_path }}/storage"
- dest: "{{ mash_playbook_base_path }}/storage/books"
########################################################################
# #
# /aux #
# #
########################################################################
You can then mount this {{ mash_playbook_base_path }}/storage/books directory into the Syncthing container and synchronize it with some other computer:
########################################################################
# #
# syncthing #
# #
########################################################################
# Other Syncthing configuration..
syncthing_container_additional_volumes:
- type: bind
src: "{{ mash_playbook_base_path }}/storage/books"
dst: /books
########################################################################
# #
# /syncthing #
# #
########################################################################
Finally, mount the {{ mash_playbook_base_path }}/storage/books directory into the calibre-web container as read-only:
########################################################################
# #
# calibre-web #
# #
########################################################################
# Other calibre-web configuration..
calibre_web_container_additional_volumes:
- type: bind
src: "{{ mash_playbook_base_path }}/storage/books"
dst: /books
########################################################################
# #
# /calibre-web #
# #
########################################################################
Usage
After installation, you can go to the calibre-web URL, as defined in calibre_web_hostname and calibre_web_path_prefix.
Recommended other services
- Syncthing - a continuous file synchronization program which synchronizes files between two or more computers in real time. See Syncthing integration