git.sur5r.net Git - contagged/blob - doc/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 ConTagged ===
  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 inc/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 you want to use the extended schema (needed for tagging) you need to copy the
  39 ldapab.schema file to /etc/ldap/schema/ and include it, too.
  40
  41   include         /etc/ldap/schema/ldapab.schema
  42
  43 If you don't use the extended schema you need to edit inc/fields.php as described
  44 below.
  45
  46 To setup the access rights add the following statement to your slapd.conf. Of
  47 course you have to replace "o=cosmocode,c=de" with your own root DN. The first
  48 entry may have to adjusted also if your users aren't stored in a ou=people
  49 entry. Make sure you include these lines before other access control lists that
  50 match these parts of the ldap tree. If you are unsure have a look at the
  51 included slapd.example file
  52
  53   access  to dn.regex="(.*,)?ou=contacts,cn=([^,]+),ou=people,(.*)$"
  54           by dn.regex="cn=$2,ou=people,$3" write
  55           by * none
  56
  57   access to dn.subtree="ou=contacts,o=cosmocode,c=de"
  58          by users write
  59          by * read
  60
  61 After this modifications you have to restart the slapd server.
  62
  63 The last thing is to add the contacts leafs to your LDAP tree. You'll need to
  64 add a global contacts leaf at top.
  65
  66   eg: 'ou=contacts,o=cosmocode,c=de'
  67
  68 And a contacts leaf for every user.
  69
  70   eg: 'ou=contacts,cn=Joe Schmoe,ou=people,o=cosmocode,c=de'
  71
  72
  73 If you made everything correct you can point your webbrowser to the newly
  74 installed ConTagged and use it :-) If you encounter problems try to enable
  75 logging in your LDAP server to see what the problem is.
  76
  77 === USING DIFFERENT OBJECTCLASSES ===
  78
  79 This new version of ConTagged is very flexible in how your contacts should be
  80 stored in your LDAP directory. ConTagged uses internal field names which can be
  81 mapped to arbitrary LDAP attributes.
  82
  83 By default, all contacts are stored with the inetOrgPerson and contactPerson
  84 object classes. If you want to use different classes and attributes, you can to
  85 so by changing the arrays $OCLASSES and $FIELDS in inc/fields.php.
  86
  87 Note: your contacts should *always* use the inetOrgPerson objectclass at
  88 minimum, but you can add any other objectclasses. Examples for OXUserObject
  89 from OpenExchange and evolutionPerson from the Evolution software are given
  90 in fields.php already.
  91
  92 If you want to add new internal field names, you need to adjust the templates
  93 accordingly. If you add support for new schemas, please send your changes to
  94 us for inclusion in a next release.
  95
  96 === FEEDBACK, PATCHES, SUPPORT ===
  97
  98 This software was developed to satisfy a need in our company. We give it to the
  99 public because it may be helpful to other companies with the same needs.
 100 However this is not a supported product. We like to get feedback and patches
 101 but we can't promise to answer, to fix bugs or include feature wishes. However
 102 don't hesitate to contact us but understand that our core business has priority
 103 over this project.
 104
 105 We prefer to receive bug reports and features wishes through the issue tracker
 106 at http://github.com/cosmocode/contagged/issues. If you want to otherwise
 107 contact us, send a mail to ldapab@cosmocode.de or visit our homepage at
 108 http://www.cosmocode.de
 109
 110 === KNOWN BUGS ===
 111
 112 ConTagged was only tested with open-ldap 2.1 - there may be problems with other
 113 LDAP Servers.
 114
 115 === LICENSE ===
 116
 117 ConTagged - An LDAP based Company Address Book
 118 Copyright 2004 - 2010 - CosmoCode GmbH
 119
 120 This program is free software; you can redistribute it and/or
 121 modify it under the terms of the GNU General Public License as
 122 published by the Free Software Foundation; either version 2 of
 123 the License, or (at your option) any later version.
 124
 125 This program is distributed in the hope that it will be useful,
 126 but WITHOUT ANY WARRANTY; without even the implied warranty of
 127 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 128 GNU General Public License for more details.
 129
 130 You should have received a copy of the GNU General Public License
 131 along with this program; if not, write to the Free Software
 132 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 133
 134 See COPYING for details