Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 66 lines (41 sloc) 2.101 kb
1d5f088 @marutosi README.rdoc: fix travis link
marutosi authored
1 = Net::LDAP for Ruby {<img src="https://travis-ci.org/ruby-ldap/ruby-net-ldap.png" />}[https://travis-ci.org/ruby-ldap/ruby-net-ldap]
dcbb201 Documentation clean-up and license change.
Austin Ziegler authored
2
3 == Description
4
84e42ce Merging an ugly set of changes I had forgotten about.
Austin Ziegler authored
5 Net::LDAP for Ruby (also called net-ldap) implements client access for the
6 Lightweight Directory Access Protocol (LDAP), an IETF standard protocol for
7 accessing distributed directory services. Net::LDAP is written completely in
8 Ruby with no external dependencies. It supports most LDAP client features and a
9 subset of server features as well.
10
11 Net::LDAP has been tested against modern popular LDAP servers including
12 OpenLDAP and Active Directory. The current release is mostly compliant with
13 earlier versions of the IETF LDAP RFCs (2251–2256, 2829–2830, 3377, and 3771).
14 Our roadmap for Net::LDAP 1.0 is to gain full <em>client</em> compliance with
a046753 Fixing a spelling error.
Austin Ziegler authored
15 the most recent LDAP RFCs (4510–4519, plus portions of 4520–4532).
dcbb201 Documentation clean-up and license change.
Austin Ziegler authored
16
17 == Where
18
19 * {GitHub}[https://github.com/ruby-ldap/ruby-net-ldap]
84e42ce Merging an ugly set of changes I had forgotten about.
Austin Ziegler authored
20 * {ruby-ldap@googlegroups.com}[http://groups.google.com/group/ruby-ldap]
dcbb201 Documentation clean-up and license change.
Austin Ziegler authored
21
22 == Synopsis
23
24 See Net::LDAP for documentation and usage samples.
25
26 == Requirements
27
1115cf9 Updating readme with ruby version, removing ancient setup instructions
Rory O'Connell authored
28 Net::LDAP requires a Ruby 1.9.3 compatible interpreter or better.
dcbb201 Documentation clean-up and license change.
Austin Ziegler authored
29
30 == Install
31
32 Net::LDAP is a pure Ruby library. It does not require any external libraries.
33 You can install the RubyGems version of Net::LDAP available from the usual
34 sources.
35
84e42ce Merging an ugly set of changes I had forgotten about.
Austin Ziegler authored
36 gem install net-ldap
37
38 Simply require either 'net-ldap' or 'net/ldap'.
dcbb201 Documentation clean-up and license change.
Austin Ziegler authored
39
937b8fe Add rubocop to project
Rufus Post authored
40 == Develop
41
42 This task will run the test suite and the
43 {RuboCop}[https://github.com/bbatsov/rubocop] static code analyzer.
44
45 rake rubotest
46
47 To run the integration tests against an LDAP server:
48
49 cd test/support/vm/openldap
50 vagrant up
51 cd ../../../..
52 INTEGRATION=openldap bundle exec rake rubotest
53
bee19ae @jch propose new release process
jch authored
54 == Release
55
56 This section is for gem maintainers to cut a new version of the gem.
57
46c3250 @mtodd Fix minor release notes in README
mtodd authored
58 * Update lib/net/ldap/version.rb to next version number X.X.X following {semver}(http://semver.org/).
59 * Update `History.rdoc`. Get latest changes with `git log --oneline vLAST_RELEASE..HEAD | grep Merge`
937b8fe Add rubocop to project
Rufus Post authored
60
bee19ae @jch propose new release process
jch authored
61 * On the master branch, run `script/release`
62
dcbb201 Documentation clean-up and license change.
Austin Ziegler authored
63 :include: Contributors.rdoc
64
65 :include: License.rdoc
Something went wrong with that request. Please try again.