2011-03-18 02:15:25 +01:00
|
|
|
|
= Net::LDAP for Ruby
|
|
|
|
|
|
|
|
|
|
|
|
== Description
|
|
|
|
|
|
|
2011-03-18 02:37:17 +01:00
|
|
|
|
Net::LDAP for Ruby (also called net-ldap) implements client access for the
|
|
|
|
|
|
Lightweight Directory Access Protocol (LDAP), an IETF standard protocol for
|
|
|
|
|
|
accessing distributed directory services. Net::LDAP is written completely in
|
|
|
|
|
|
Ruby with no external dependencies. It supports most LDAP client features and a
|
|
|
|
|
|
subset of server features as well.
|
|
|
|
|
|
|
|
|
|
|
|
Net::LDAP has been tested against modern popular LDAP servers including
|
|
|
|
|
|
OpenLDAP and Active Directory. The current release is mostly compliant with
|
|
|
|
|
|
earlier versions of the IETF LDAP RFCs (2251–2256, 2829–2830, 3377, and 3771).
|
|
|
|
|
|
Our roadmap for Net::LDAP 1.0 is to gain full <em>client</em> compliance with
|
2011-03-22 05:41:46 +01:00
|
|
|
|
the most recent LDAP RFCs (4510–4519, plus portions of 4520–4532).
|
2011-03-18 02:15:25 +01:00
|
|
|
|
|
|
|
|
|
|
== Where
|
|
|
|
|
|
|
|
|
|
|
|
* {RubyForge}[http://rubyforge.org/projects/net-ldap]
|
|
|
|
|
|
* {GitHub}[https://github.com/ruby-ldap/ruby-net-ldap]
|
2011-03-18 02:37:17 +01:00
|
|
|
|
* {ruby-ldap@googlegroups.com}[http://groups.google.com/group/ruby-ldap]
|
|
|
|
|
|
* {Documentation}[http://net-ldap.rubyforge.org/]
|
2011-03-18 02:15:25 +01:00
|
|
|
|
|
|
|
|
|
|
The Net::LDAP for Ruby documentation, project description, and main downloads
|
|
|
|
|
|
can currently be found on {RubyForge}[http://rubyforge.org/projects/net-ldap].
|
|
|
|
|
|
|
|
|
|
|
|
== Synopsis
|
|
|
|
|
|
|
|
|
|
|
|
See Net::LDAP for documentation and usage samples.
|
|
|
|
|
|
|
|
|
|
|
|
== Requirements
|
|
|
|
|
|
|
|
|
|
|
|
Net::LDAP requires a Ruby 1.8.7 interpreter or better.
|
|
|
|
|
|
|
|
|
|
|
|
== Install
|
|
|
|
|
|
|
|
|
|
|
|
Net::LDAP is a pure Ruby library. It does not require any external libraries.
|
|
|
|
|
|
You can install the RubyGems version of Net::LDAP available from the usual
|
|
|
|
|
|
sources.
|
|
|
|
|
|
|
2011-03-18 02:37:17 +01:00
|
|
|
|
gem install net-ldap
|
|
|
|
|
|
|
|
|
|
|
|
Simply require either 'net-ldap' or 'net/ldap'.
|
2011-03-18 02:15:25 +01:00
|
|
|
|
|
2011-03-18 02:37:17 +01:00
|
|
|
|
For non-RubyGems installations of Net::LDAP, you can use Minero Aoki's
|
|
|
|
|
|
{setup.rb}[http://i.loveruby.net/en/projects/setup/] as the layout of
|
|
|
|
|
|
Net::LDAP is compliant. The setup installer is not included in the
|
|
|
|
|
|
Net::LDAP repository.
|
2011-03-18 02:15:25 +01:00
|
|
|
|
|
|
|
|
|
|
:include: Contributors.rdoc
|
|
|
|
|
|
|
|
|
|
|
|
:include: License.rdoc
|
