|Brian Salcedo ee5332b791||2 years ago|
|apps||2 years ago|
|playbooks||2 years ago|
|.gitignore||2 years ago|
|README.md||2 years ago|
|Vagrantfile||2 years ago|
|inventory||2 years ago|
This repository contains Ansible playbooks and Docker Compose files for deploying calibre-web on a Debian 9 Linux server. It uses Traefik for the frontend and automatic Letsencrypt certificate management. This stack can be expanded to include more apps, as detailed at the end of this readme.
Note: In this configuration, Traefik uses ACME HTTP challenge to obtain certificates. The desired DNS record for your calibre-web install MUST be created and resolve to your server IP address before doing these steps!
Edit the following files to suit your installation:
||The Ansible inventory file|
||Holds the FQDN of your calibre-web installation|
inventory: Set the IP or hostname of your VPS in this file.
apps/calibre-web/.env: This file contains an environment variable
CALIBRE_HOST. Set it to the host or domain you wish to serve calibre-web on (e.g. calibre.example.com)
playbooks/roles/site/files/traefik.toml: Traefik configuration. Everything is set here except for your email address for obtaining certificates through Letsencrypt. change [email protected] to your email address.
$ ansible-playbook -i inventory playbooks/main.yml
Books to be imported into calibre-web are placed in
/srv/calibre/books, owned by user
www-data. Before the final steps, place your books there and set the correct permissions:
scp -r mybooks [email protected]:/srv/calibre/books
sudo chown -R www-data: /srv/calibre/books
Adding more applications can be done by first adding a subdirectory in
apps/ and placing a
docker-compose.yml with valid syntax in it. Running Ansible again will then pick up your new app and start the services outlined in your compose file. See the existing compose files as a starting point, and the compose file reference.
Traefik relies on Docker container labels to pass frontend rules that specify how it shall connect to your backend applications. These labels are set in the
docker-compose.yml files under the
labels: key. See the documentation on Traefik frontend rules for more information about how these work.
Letsencrypt certificates are handled automatically by Traefik. Remember: When using ACME HTTP challenge, your domain name must already point to your server so Traefik can complete the challenge and get a valid certificate. This challenge occurs when Traefik sees a container with labels for a domain or subdomain it has not yet seen. Obtained certificates are stored in a file named
acme.json in a docker named-volume
app_traefik mounted at
/data in the running container. You will most likely never have to interact with this file directly.
Renewal of certificates: done automatically when they are due for expiration.
Vagrantfile is included that will call the Ansible playbooks for provisioning. See
playbooks/roles/site/files/traefik-nontls.toml for an HTTP-only Traefik config that can be used for further development and local testing.
Additional security headers for apps: Traefik can set arbitrary headers. It also has predefined labels for setting commonly used security headers: https://docs.traefik.io/configuration/backends/docker/#security-headers See apps/calibre-web/docker-compose.yml for an example of sending HSTS. These are commented out by default.