From 859809736dfc91721d7d67055d202248806dab06 Mon Sep 17 00:00:00 2001
From: Stephan Bosch <stephan@rename-it.nl>
Date: Thu, 24 Jul 2014 09:27:14 +0200
Subject: [PATCH] Adjusted documentation to mention LDAP support can be
compiled as a plugin.
---
INSTALL | 11 +++++++++--
doc/script-location-ldap.txt | 11 ++++++++++-
2 files changed, 19 insertions(+), 3 deletions(-)
diff --git a/INSTALL b/INSTALL
index e97ad12ba..6f157b870 100644
--- a/INSTALL
+++ b/INSTALL
@@ -48,6 +48,12 @@ the Pigeonhole build:
In fact, it may not compile at all. Enable this only when you are eager to
test some of the new development functionality.
+ --with-ldap=no
+ Controls wether Sieve LDAP support is built. This allows retrieving Sieve
+ scripts from an LDAP database. When set to `yes', support is built in. When
+ set to `plugin', LDAP support is compiled into a Sieve plugin called
+ `sieve_storage_ldap'.
+
Configuration
=============
@@ -184,8 +190,9 @@ plugin section of the config file (default values are shown if applicable):
The Pigeonhole Sieve interpreter can have plugins of its own. Using this
setting, the used plugins can be specified. Check the Dovecot wiki
(wiki2.dovecot.org) or the pigeonhole website (http://pigeonhole.dovecot.org)
- for available plugins. The sieve_extprograms plugin is included in this
- release.
+ for available plugins. The `sieve_extprograms' plugin is included in this
+ release. LDAP support may also be compiled as a plugin called
+ `sieve_storage_ldap'.
sieve_user_log =
The path to the file where the user log file is written. If not configured, a
diff --git a/doc/script-location-ldap.txt b/doc/script-location-ldap.txt
index ff5893a2c..e69b1ee0e 100644
--- a/doc/script-location-ldap.txt
+++ b/doc/script-location-ldap.txt
@@ -17,10 +17,19 @@ retrieved from an LDAP database. The bindir= option needs to be specified in the
location specification. Refer to the INSTALL file for more general information
about configuration of script locations.
+Depending on how Pigeonhole was configured and compiled (refer to INSTALL file
+for more information), LDAP support may only be available from a plugin called
+`sieve_storage_ldap'.
+
Configuration
=============
-The script location syntax is specialized as follows:
+If support for the LDAP location type is compiled as a plugin, it needs to be
+added to the sieve_plugins setting before it can be used, e.g.:
+
+sieve_plugins = sieve_storage_ldap
+
+The script location syntax is specified as follows:
location = ldap:<config-file>[;<option>[=<value>][;...]]
--
GitLab