git.sur5r.net Git - contagged/blob - README

   1 === ABOUT ===
   2
   3 LDAPab is a webbased address book for small companies. It features a public
   4 address book which is writable for all company staff and a personal address
   5 book for each staff member. LDAPab require an already setup LDAP server to
   6 authenticate users.
   7
   8 === REQUIREMENTS ===
   9
  10 You need to have a running LDAP Server with some users (objectClass=posixUser)
  11 in it. It is important that you already have these users because LDAPab uses
  12 them to authenticate.
  13
  14 You need a webserver (peferable Apache) with PHP4. PHP4 needs to be compiled
  15 with LDAP support (compiled in or as extension)
  16
  17 === SETUP LDAPab ===
  18
  19 Copy the contents of the .tgz file to a directory below your webserver document
  20 root. Make sure the webserver is able to write to the cache directory which is
  21 used for the template engines cache files. A 'chmod 777 cache' will do.
  22
  23 Open the config.php file in your favourite editor and edit the options
  24 according to your needs. Some knowlege about LDAP may come in handy.
  25
  26 === SETUP THE LDAP SERVER ===
  27
  28 The following only describes what to do for open-ldap 2.0! If you use any
  29 other LDAP server you're left to our own.
  30
  31 You need to include the inetOrgPerson schema in you slapd.conf:
  32
  33   include /etc/ldap/schema/inetorgperson.schema
  34
  35 If youwant to use the extended schema (currently only for birthday support) you
  36 need to copy the ldapab.schema file to /etc/ldap/schema/ and include it, too.
  37 Be sure to enable the extended option in config.php.
  38
  39   include         /etc/ldap/schema/ldapab.schema
  40
  41 To setup the access rights add the following statement to your slapd.conf. Of
  42 course you have to replace "o=cosmocode,c=de" with your own root DN. The first
  43 entry may have to adjusted also if your users aren't stored in a ou=people
  44 entry. Make sure you include these lines before other access control lists that
  45 match these parts of the ldap tree. If you are unsure have a look at the
  46 included slapd.example file
  47
  48   access  to dn="(.*,)?ou=contacts,cn=([^,]+),ou=people,(.*)$"
  49           by dn="cn=$2,ou=people,$3" write
  50           by * none
  51
  52   access to dn.subtree="ou=contacts,o=cosmocode,c=de"
  53          by users write
  54          by * read
  55
  56 After this modifications you have to restart the slapd server.
  57
  58 The last thing is to add the contacts leafs to your LDAP tree. You'll need to
  59 add a global contacts leaf at top.
  60
  61   eg: 'ou=contacts,o=cosmocode,c=de'
  62
  63 And a contacts leaf for every user.
  64
  65   eg: 'ou=contacts,cn=Joe Schmoe,ou=people,o=cosmocode,c=de'
  66
  67
  68 If you made everything correct you can point your webbrowser to the newly
  69 installed LDAPab and use it :-) If you encounter problems try to enable logging
  70 in your LDAP server to see what the problem is.
  71
  72 === FEEDBACK, PATCHES, SUPPORT ===
  73
  74 This software was developed to satisfy a need in our company. We give it to the
  75 public because it may be helpful to other companies with the same needs.
  76 However this is not a supported product. We like to get feedback and patches
  77 but we can't promise to answer, to fix bugs or include feature wishes. However
  78 don't hesitate to contact us but understand that our core business has priority
  79 over this project.
  80
  81 To contact us send a mail to ldapab@cosmocode.de
  82
  83 === KNOWN BUGS ===
  84
  85 LDAPab was only tested with open-ldap 2.1 - there may be problems with other
  86 LDAP Servers.
  87
  88 === LICENSE ===
  89
  90 LDAPab - An LDAP based Company Address Book
  91 Copyright 2004 - CosmoCode GmbH
  92
  93 This program is free software; you can redistribute it and/or
  94 modify it under the terms of the GNU General Public License as
  95 published by the Free Software Foundation; either version 2 of
  96 the License, or (at your option) any later version.
  97
  98 This program is distributed in the hope that it will be useful,
  99 but WITHOUT ANY WARRANTY; without even the implied warranty of
 100 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 101 GNU General Public License for more details.
 102
 103 You should have received a copy of the GNU General Public License
 104 along with this program; if not, write to the Free Software
 105 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 106
 107 See COPYING for details