ldap.conf.adoc: add ldap.conf docu

diff --git a/gen-ldap.conf.5-opts.pl b/gen-ldap.conf.5-opts.pl
new file mode 100755 (executable)
index 0000000..6546178
--- /dev/null
+++ b/gen-ldap.conf.5-opts.pl
@@ -0,0 +1,17 @@
+#!/usr/bin/perl
+
+use lib '.';
+use strict;
+use warnings;
+use PVE::RESTHandler;
+
+use Data::Dumper;
+
+use PMG::LDAPConfig;
+
+my $schema = PMG::LDAPConfig->createSchema(1);
+my $properties = $schema->{properties};
+    
+print PVE::RESTHandler::dump_properties($properties);
+ 
+exit(0);

diff --git a/ldap.conf.5-opts.adoc b/ldap.conf.5-opts.adoc
new file mode 100644 (file)
index 0000000..d72058b
--- /dev/null
+++ b/ldap.conf.5-opts.adoc
@@ -0,0 +1,60 @@
+`accountattr`: `<string>` ('default =' `sAMAccountName, uid`)::
+
+Account attribute name name.
+
+`basedn`: `<string>` ::
+
+Base domain name.
+
+`binddn`: `<string>` ::
+
+Bind domain name.
+
+`bindpw`: `<string>` ::
+
+Bind password.
+
+`comment`: `<string>` ::
+
+Description.
+
+`disable`: `<boolean>` ::
+
+Flag to disable/deactivate the entry.
+
+`filter`: `<string>` ::
+
+LDAP filter.
+
+`groupbasedn`: `<string>` ::
+
+Base domain name for groups.
+
+`groupclass`: `<string>` ('default =' `group, univentionGroup, ipausergroup`)::
+
+List of objectclasses for groups.
+
+`mailattr`: `<string>` ('default =' `mail, userPrincipalName, proxyAddresses, othermailbox, mailAlternativeAddress`)::
+
+List of mail attribute names.
+
+`mode`: `<ldap | ldaps>` ('default =' `ldap`)::
+
+LDAP protocol mode ('ldap' or 'ldaps').
+
+`port`: `<integer> (1 - 65535)` ::
+
+Specify the port to connect to.
+
+`profile`: `<string>` ::
+
+Profile ID.
+
+`server1`: `<string>` ::
+
+Server address.
+
+`server2`: `<string>` ::
+
+Fallback server address. Userd when the first server is not available.
+

diff --git a/ldap.conf.adoc b/ldap.conf.adoc
new file mode 100644 (file)
index 0000000..dbe0c54
--- /dev/null
+++ b/ldap.conf.adoc
@@ -0,0 +1,43 @@
+[[pmg_ldap_configuration_file]]
+ifdef::manvolnum[]
+ldap.conf(5)
+============
+:pmg-toplevel:
+
+NAME
+----
+
+ldap.conf - Proxmox Mail Gateway LDAP Configuration
+
+
+SYNOPSIS
+--------
+
+`/etc/pmg/ldap.conf`
+
+
+DESCRIPTION
+-----------
+endif::manvolnum[]
+ifndef::manvolnum[]
+LDAP Configuration
+==================
+endif::manvolnum[]
+
+The file `/etc/pmg/ldap.conf` contains the LDAP configuration.
+
+
+File Format
+-----------
+
+TODO
+
+Options
+-------
+
+include::ldap.conf.5-opts.adoc[]
+
+
+ifdef::manvolnum[]
+include::pmg-copyright.adoc[]
+endif::manvolnum[]

diff --git a/pmg-admin-guide.adoc b/pmg-admin-guide.adoc
index 8657b6a08404753ef8bfee894fe124f571dcbf0b..9fb960e6e9bd26653e736b352566636823883859 100644 (file)
--- a/pmg-admin-guide.adoc
+++ b/pmg-admin-guide.adoc
@@ -189,6 +189,8 @@ include::cluster.conf.adoc[]
 
 include::user.conf.adoc[]
 
+include::ldap.conf.adoc[]
+
 :leveloffset: 0
 
 :leveloffset: 1