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 requires 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 engine's 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 If HTTP auth is wanted have a look at the provided _htaccess file, edit it as
  27 needed and rename it back to .htaccess
  28
  29 === SETUP THE LDAP SERVER ===
  30
  31 The following only describes what to do for open-ldap 2.0! If you use any
  32 other LDAP server you're left to our own.
  33
  34 You need to include the inetOrgPerson schema in you slapd.conf:
  35
  36   include /etc/ldap/schema/inetorgperson.schema
  37
  38 If youwant to use the extended schema (currently only for birthday support) you
  39 need to copy the ldapab.schema file to /etc/ldap/schema/ and include it, too.
  40 Be sure to enable the extended option in config.php.
  41
  42   include         /etc/ldap/schema/ldapab.schema
  43
  44 To setup the access rights add the following statement to your slapd.conf. Of
  45 course you have to replace "o=cosmocode,c=de" with your own root DN. The first
  46 entry may have to adjusted also if your users aren't stored in a ou=people
  47 entry. Make sure you include these lines before other access control lists that
  48 match these parts of the ldap tree. If you are unsure have a look at the
  49 included slapd.example file
  50
  51   access  to dn="(.*,)?ou=contacts,cn=([^,]+),ou=people,(.*)$"
  52           by dn="cn=$2,ou=people,$3" write
  53           by * none
  54
  55   access to dn.subtree="ou=contacts,o=cosmocode,c=de"
  56          by users write
  57          by * read
  58
  59 After this modifications you have to restart the slapd server.
  60
  61 The last thing is to add the contacts leafs to your LDAP tree. You'll need to
  62 add a global contacts leaf at top.
  63
  64   eg: 'ou=contacts,o=cosmocode,c=de'
  65
  66 And a contacts leaf for every user.
  67
  68   eg: 'ou=contacts,cn=Joe Schmoe,ou=people,o=cosmocode,c=de'
  69
  70
  71 If you made everything correct you can point your webbrowser to the newly
  72 installed LDAPab and use it :-) If you encounter problems try to enable logging
  73 in your LDAP server to see what the problem is.
  74
  75 === FEEDBACK, PATCHES, SUPPORT ===
  76
  77 This software was developed to satisfy a need in our company. We give it to the
  78 public because it may be helpful to other companies with the same needs.
  79 However this is not a supported product. We like to get feedback and patches
  80 but we can't promise to answer, to fix bugs or include feature wishes. However
  81 don't hesitate to contact us but understand that our core business has priority
  82 over this project.
  83
  84 To contact us send a mail to ldapab@cosmocode.de or visit our homepage at
  85 http://www.cosmocode.de
  86
  87 === KNOWN BUGS ===
  88
  89 LDAPab was only tested with open-ldap 2.1 - there may be problems with other
  90 LDAP Servers.
  91
  92 === LICENSE ===
  93
  94 LDAPab - An LDAP based Company Address Book
  95 Copyright 2004 - 2006 - CosmoCode GmbH
  96
  97 This program is free software; you can redistribute it and/or
  98 modify it under the terms of the GNU General Public License as
  99 published by the Free Software Foundation; either version 2 of
 100 the License, or (at your option) any later version.
 101
 102 This program is distributed in the hope that it will be useful,
 103 but WITHOUT ANY WARRANTY; without even the implied warranty of
 104 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 105 GNU General Public License for more details.
 106
 107 You should have received a copy of the GNU General Public License
 108 along with this program; if not, write to the Free Software
 109 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 110
 111 See COPYING for details