aboutsummaryrefslogtreecommitdiff
path: root/roles/calibre/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'roles/calibre/README.md')
-rw-r--r--roles/calibre/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/roles/calibre/README.md b/roles/calibre/README.md
new file mode 100644
index 0000000..1dbc079
--- /dev/null
+++ b/roles/calibre/README.md
@@ -0,0 +1,16 @@
+# calibre-web
+
+Installed calibre-web with optional features if specified.
+Assumes the ssl cert and key are located at `/etc/ssl/certs/FQDN.(pem | key)`.
+
+```yaml
+ssl: true
+
+features:
+ - ldap
+ - oauth
+ - metadata
+ - comics
+```
+
+[List of possible features](https://github.com/janeczku/calibre-web/wiki/Dependencies-in-Calibre-Web-Linux-Windows)