aboutsummaryrefslogtreecommitdiffstats
path: root/addon/ldapauth
diff options
context:
space:
mode:
Diffstat (limited to 'addon/ldapauth')
-rw-r--r--addon/ldapauth/README17
-rw-r--r--addon/ldapauth/ldapauth.php8
2 files changed, 24 insertions, 1 deletions
diff --git a/addon/ldapauth/README b/addon/ldapauth/README
new file mode 100644
index 000000000..cf28ef1e0
--- /dev/null
+++ b/addon/ldapauth/README
@@ -0,0 +1,17 @@
+Authenticate a user against an LDAP directory
+Useful for Windows Active Directory and other LDAP-based organisations
+to maintain a single password across the organisation.
+
+Optionally authenticates only if a member of a given group in the directory.
+
+The person must have registered with Friendika using the normal registration
+procedures in order to have a Friendika user record, contact, and profile.
+
+Note when using with Windows Active Directory: you may need to set TLS_CACERT in your site
+ldap.conf file to the signing cert for your LDAP server.
+
+The required configuration options for this module may be set in the .htconfig.php file
+e.g.:
+
+$a->config['ldapauth']['ldap_server'] = 'host.example.com';
+...etc.
diff --git a/addon/ldapauth/ldapauth.php b/addon/ldapauth/ldapauth.php
index 2ec30caad..7230302e9 100644
--- a/addon/ldapauth/ldapauth.php
+++ b/addon/ldapauth/ldapauth.php
@@ -1,5 +1,11 @@
<?php
-
+/**
+ * Name: LDAP Authenticate
+ * Description: Authenticate a user against an LDAP directory
+ * Version: 1.0
+ * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
+ */
+
/**
* Friendika addon
*