From 85ee097a3b450f00181e9ba7a0c26a7333ebcaa0 Mon Sep 17 00:00:00 2001 From: Ghassan Alduraibi Date: Fri, 24 Jun 2022 13:44:38 +0300 Subject: [PATCH] docs: add calibre-web config (#187) * docs: add calibre-web config * docs: update readme with calibre-web config * docs: update calibre-web config with login fix * docs: update calibre-web config with requested changes --- README.md | 1 + example_configs/calibre_web.md | 97 ++++++++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+) create mode 100644 example_configs/calibre_web.md diff --git a/README.md b/README.md index a29b6a9..bdc571e 100644 --- a/README.md +++ b/README.md @@ -198,6 +198,7 @@ configuration files, or guides. See the [`example_configs`](example_configs) folder for help with: - [Authelia](example_configs/authelia_config.yml) - [Bookstack](example_configs/bookstack.env.example) + - [Calibre-Web](example_configs/calibre_web.md) - [Dolibarr](example_configs/dolibarr.md) - [Gitea](example_configs/gitea.md) - [Jellyfin](example_configs/jellyfin.md) diff --git a/example_configs/calibre_web.md b/example_configs/calibre_web.md new file mode 100644 index 0000000..0821a8e --- /dev/null +++ b/example_configs/calibre_web.md @@ -0,0 +1,97 @@ +# Configuration for Calibre-Web + +Replace `dc=example,dc=com` with your LLDAP configured domain. + + +### Login type + +``` +Use LDAP Authentication +``` + +### LDAP Server Host Name or IP Address + +``` +lldap +``` + +### LDAP Server Port + +``` +3890 +``` + +### LDAP Encryption + +``` +none +``` + +### LDAP Authentication + +``` +simple +``` + +### LDAP Administrator Username + +``` +uid=admin,ou=people,dc=example,dc=com +``` + +### LDAP Administrator Password + +``` +CHANGE_ME +``` + +### LDAP Distinguished Name (DN) + +``` +dc=example,dc=com +``` + +### LDAP User Object Filter + +``` +(&(objectclass=person)(uid=%s)) +``` + +### LDAP Server is OpenLDAP? + +``` +yes +``` + +### LDAP Group Object Filter + +``` +(&(objectclass=groupOfUniqueNames)(cn=%s)) +``` + +### LDAP Group Name + +``` +calibre_web +``` + +Note: Create a group in lldap and add users to it that will have access to your Calibre-Web instance + +### LDAP Group Members Field + +``` +uniqueMember +``` + +### LDAP Member User Filter Detection + +``` +Custom Filter +``` + +### LDAP Member User Filter + +``` +(&(objectclass=person)(uid=%s)) +``` +Note: lowercase the word "person" until this bug is fixed