source: trunk/LATMOS-Accounts/man/man8/latmos-accounts-base-ldap.pod @ 2502

# $Id$

=head1 DESCRIPTION

=head1 OPENLDAP SETUP

Some openldap schema are need to make LA to works:

=head2 Mandatory Schema

=over 4

=item core.schema

=item cosine.schema

=item inetorgperson.schema

=item misc.schema

=item nis.schema

=item openldap.schema

=item samba.schema

=back

=head2 MODULE

To be able to properly groupOfNames object you are encourage to load B<memberof.la> module

=head1 SPECIFIC SETUP PARAMTERS

=head2 server

The server name to use to access to ldap base

=head2 topdn

The base dn of the ldap

=head2 login

The dn to use to connect to the ldap

=head2 password

The password to cuse to connect to ldap server

=head2 ssl

If set, try to connect using ssl

=head2 tls

If set start tls encryption on standard ldap port.

C<ssl> parameter must not be set in this case.

=head2 user_container

The dn subpart of the container where user are located and will be created

=head2 group_container

The dn subpart of the container where groups are located and will be created

=head2 groupofnames_container

The dn subpart of the container where groupOfnames will be stored if set.

To have C<memberOf> attribute created on user object ensure openldap
module C<memberof> is enable before setting this parameter.

=head2 user_key_attribute, group_key_attribute

Specify the attribute to use to uniquely identify an object. The default is
C<cn>.

=head2 user_dn_attribute, group_dn_attribute

Specify the attribute to use forge the C<dn> of new object. The default is
C<cn>.

=head1 SETUP EXAMPLE

    [ldap]
    type=ldap
    server=ldap.domain
    topdn=dc=domain
    login = cn=root,dc=domain
    password = myPass
    user_container = ou=users
    group_container = ou=groups
    aliases_container = ou=aliases
    onlyaddress_container = ou=addressbook
    groupofnames_container = ou=groupofnames
    ssl=1