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

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