aboutsummaryrefslogtreecommitdiffstats
path: root/lib/eldap/README
diff options
context:
space:
mode:
authorDan Gudmundsson <dgud@erlang.org>2012-03-29 09:29:43 +0200
committerDan Gudmundsson <dgud@erlang.org>2012-03-29 09:29:58 +0200
commit472a3d910595d7de1e49f241c1d241827b5c0bf4 (patch)
tree6a8af070bf98697cd0e08823722176c72beffbc7 /lib/eldap/README
parentccc9e16381244760b3013e11b6fe8f1fe2a0a809 (diff)
parent1ff967c2a574161aef4c88177da534b45d9ebd80 (diff)
downloadotp-472a3d910595d7de1e49f241c1d241827b5c0bf4.tar.gz
otp-472a3d910595d7de1e49f241c1d241827b5c0bf4.tar.bz2
otp-472a3d910595d7de1e49f241c1d241827b5c0bf4.zip
Merge branch 'dgud/eldap' into maint
* dgud/eldap: [eldap] Fix parse_port error handling [eldap] Add rudimentary docs [eldap] Add asn.1 compilation options [eldap] Add dereference options in search [eldap] Remove broken functionality [eldap] Add infrastructure [eldap] Initial copy of Tobbe's eldap client OTP-10034
Diffstat (limited to 'lib/eldap/README')
-rw-r--r--lib/eldap/README33
1 files changed, 33 insertions, 0 deletions
diff --git a/lib/eldap/README b/lib/eldap/README
new file mode 100644
index 0000000000..e1bde9d658
--- /dev/null
+++ b/lib/eldap/README
@@ -0,0 +1,33 @@
+Hi,
+
+This is 'eldap', the Erlang LDAP library.
+
+It exports an API that can do all possible operations
+you may want to do against an LDAP server. The code has
+been tested to work at some point, but only the bind
+and search operations are running daily in our products,
+so there may be bugs lurking in some parts of the code.
+
+To just use eldap for doing authentication, do like in:
+
+ {ok,X} = eldap:open(["ldap.mycorp.com"], []).
+ eldap:simple_bind(X, "uid=tobbe,ou=People,dc=mycorp,dc=com", "passwd").
+
+In the doc/README.example you'll find a trace from a
+Erlang shell session as an example on how to setup a
+connection, authenticate (bind) and perform a search.
+Note that by using the option {ssl, true}, you should
+be able to setup an SSL tunnel (LDAPS) if your Erlang
+system has been configured with SSL.
+
+In the test directory there are some hints and examples
+on how to test the code and how to setup and populate
+an OpenLDAP server. The 'eldap' code has been tested
+agains OpenLDAP, IPlanet and ActiveDirectory servers.
+
+If you plan to incorporate this code into your system
+I suggest that you build a server/supervisor harnesk
+that uses 'eldap' (as we have done in our products).
+
+Good luck !
+/Tobbe