]> git.sur5r.net Git - contagged/blobdiff - README
added default escaping for smarty
[contagged] / README
diff --git a/README b/README
index a69db6459a751255cb8fe0d5712fa68d4dddaff5..d37c79668fc95542068e25f9e3b04a7dbc664794 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,9 @@
 === ABOUT ===
 
 === ABOUT ===
 
-LDAPab is a webbased address book for small companies. It features a public
+ConTagged is a webbased address book for small companies. It features a public
 address book which is writable for all company staff and a personal address
 address book which is writable for all company staff and a personal address
-book for each staff member. LDAPab require an already setup LDAP server to
-authenticate users.
+book for each staff member. ConTagged requires an already setup LDAP server to
+authenticate users and store it's data.
 
 === REQUIREMENTS ===
 
 
 === REQUIREMENTS ===
 
@@ -11,18 +11,21 @@ You need to have a running LDAP Server with some users (objectClass=posixUser)
 in it. It is important that you already have these users because LDAPab uses
 them to authenticate.
 
 in it. It is important that you already have these users because LDAPab uses
 them to authenticate.
 
-You need a webserver (peferable Apache) with PHP4. PHP4 needs to be compiled
-with LDAP support (compiled in or as extension)
+You need a webserver (peferable Apache) with PHP (4.3 or higher). PHP needs to
+be compiled with LDAP support (compiled in or as extension)
 
 === SETUP LDAPab ===
 
 Copy the contents of the .tgz file to a directory below your webserver document
 root. Make sure the webserver is able to write to the cache directory which is
 
 === SETUP LDAPab ===
 
 Copy the contents of the .tgz file to a directory below your webserver document
 root. Make sure the webserver is able to write to the cache directory which is
-used for the template engines cache files. A 'chmod 777 cache' will do.
+used for the template engine's cache files. A 'chmod 777 cache' will do.
 
 Open the config.php file in your favourite editor and edit the options
 according to your needs. Some knowlege about LDAP may come in handy.
 
 
 Open the config.php file in your favourite editor and edit the options
 according to your needs. Some knowlege about LDAP may come in handy.
 
+If HTTP auth is wanted have a look at the provided _htaccess file, edit it as
+needed and rename it back to .htaccess
+
 === SETUP THE LDAP SERVER ===
 
 The following only describes what to do for open-ldap 2.0! If you use any
 === SETUP THE LDAP SERVER ===
 
 The following only describes what to do for open-ldap 2.0! If you use any
@@ -32,12 +35,13 @@ You need to include the inetOrgPerson schema in you slapd.conf:
 
   include /etc/ldap/schema/inetorgperson.schema
 
 
   include /etc/ldap/schema/inetorgperson.schema
 
-If youwant to use the extended schema (currently only for birthday support) you
-need to copy the ldapab.schema file to /etc/ldap/schema/ and include it, too.
-Be sure to enable the extended option in config.php.
+If youwant to use the extended schema (needed for tagging and birthday support)
+you need to copy the ldapab.schema file to /etc/ldap/schema/ and include it, too.
 
   include         /etc/ldap/schema/ldapab.schema
 
 
   include         /etc/ldap/schema/ldapab.schema
 
+Be sure to enable the extended option in config.php.
+
 To setup the access rights add the following statement to your slapd.conf. Of
 course you have to replace "o=cosmocode,c=de" with your own root DN. The first
 entry may have to adjusted also if your users aren't stored in a ou=people
 To setup the access rights add the following statement to your slapd.conf. Of
 course you have to replace "o=cosmocode,c=de" with your own root DN. The first
 entry may have to adjusted also if your users aren't stored in a ou=people
@@ -45,8 +49,8 @@ entry. Make sure you include these lines before other access control lists that
 match these parts of the ldap tree. If you are unsure have a look at the
 included slapd.example file
 
 match these parts of the ldap tree. If you are unsure have a look at the
 included slapd.example file
 
-  access  to dn="(.*,)?ou=contacts,cn=([^,]+),ou=people,(.*)$"
-          by dn="cn=$2,ou=people,$3" write
+  access  to dn.regex="(.*,)?ou=contacts,cn=([^,]+),ou=people,(.*)$"
+          by dn.regex="cn=$2,ou=people,$3" write
           by * none
 
   access to dn.subtree="ou=contacts,o=cosmocode,c=de"
           by * none
 
   access to dn.subtree="ou=contacts,o=cosmocode,c=de"
@@ -59,15 +63,15 @@ The last thing is to add the contacts leafs to your LDAP tree. You'll need to
 add a global contacts leaf at top.
 
   eg: 'ou=contacts,o=cosmocode,c=de'
 add a global contacts leaf at top.
 
   eg: 'ou=contacts,o=cosmocode,c=de'
-  
+
 And a contacts leaf for every user.
 
   eg: 'ou=contacts,cn=Joe Schmoe,ou=people,o=cosmocode,c=de'
 
 
 If you made everything correct you can point your webbrowser to the newly
 And a contacts leaf for every user.
 
   eg: 'ou=contacts,cn=Joe Schmoe,ou=people,o=cosmocode,c=de'
 
 
 If you made everything correct you can point your webbrowser to the newly
-installed LDAPab and use it :-) If you encounter problems try to enable logging
-in your LDAP server to see what the problem is.
+installed ConTagged and use it :-) If you encounter problems try to enable
+logging in your LDAP server to see what the problem is.
 
 === FEEDBACK, PATCHES, SUPPORT ===
 
 
 === FEEDBACK, PATCHES, SUPPORT ===
 
@@ -78,17 +82,18 @@ but we can't promise to answer, to fix bugs or include feature wishes. However
 don't hesitate to contact us but understand that our core business has priority
 over this project.
 
 don't hesitate to contact us but understand that our core business has priority
 over this project.
 
-To contact us send a mail to ldapab@cosmocode.de
+To contact us send a mail to ldapab@cosmocode.de or visit our homepage at
+http://www.cosmocode.de
 
 === KNOWN BUGS ===
 
 
 === KNOWN BUGS ===
 
-LDAPab was only tested with open-ldap 2.1 - there may be problems with other
+ConTagged was only tested with open-ldap 2.1 - there may be problems with other
 LDAP Servers.
 
 === LICENSE ===
 
 LDAP Servers.
 
 === LICENSE ===
 
-LDAPab - An LDAP based Company Address Book
-Copyright 2004 - CosmoCode GmbH
+ConTagged - An LDAP based Company Address Book
+Copyright 2004 - 2006 - CosmoCode GmbH
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License as
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License as
@@ -103,5 +108,5 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-      
+
 See COPYING for details
 See COPYING for details