* added vcard url, skeleton functions. slow but not to slow ;) more is to come !
[squirrelmail.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 91a68ec763dfc7df8b0ffdbe0e88dc9629fe21cb..3cdd419d6874c8fe65ef538ac2f554aa044e549a 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -20,6 +20,11 @@ Table of Contents:
   to run as CGI under Apache. How you end up doing this is up to you
   (your mileage may vary).
 
+  NOTE: The new plugin architecture required the use of some functions 
+  which are not in all versions of PHP4. You will need at least 
+  PHP4 v4.0.2. If you need to upgrade please go ahead and install the
+  latest release version of PHP4.
+
 a. Obtaining and compiling PHP4
 
   Point your favorite webserver at http://www.php.net/version4/ and
@@ -53,6 +58,8 @@ b. Changing php.ini
   be sure to change the session.save_path to someplace that can only 
   be read and written to by the webserver.  session.save_path is the
   location that PHP's session data will be written to.
+  
+  Squirrelmail 1.2.x also requires register_globals to be enabled. 
 
   SECURITY WARNING - If a user has access to write PHP scripts on your 
   system and knows the location where PHP stores session data, he 
@@ -60,6 +67,10 @@ b. Changing php.ini
   session's data with his own PHP script.  Caution should be used when 
   setting up permissions and locations of php.ini and the session data.
 
+  FILE UPLOADS - Note that sending messages will not work if your
+  "file_uploads" setting is "Off". Squirrelmail requires that setting
+  enabled in order to work.
+
 c. Setting up .php files to use PHP4
 
   You need to create a .htaccess file in you SquirrelMail directory
@@ -107,13 +118,18 @@ b. Setting up directories
 
   The data directory is used for storing user preferences, like
   signature, name and theme. When unpacking the sources this directory
-  is created as data/ in you SquirrelMail directory. This directory
+  is created as data/ in your SquirrelMail directory. This directory
   must be writable by the webserver. If your webserver is running as
-  the user nobody you can fix this by running:
+  the user "nobody" you can fix this by running:
 
     $ chown -R nobody data
     $ chgrp -R nobody data
-  
+
+  Keep in mind that with different installations, the web server could
+  typically run as userid/groupid of nobody/nobody, nobody/nogroup, 
+  apache/apache or www-data/www-data.  The best way to find out is to read 
+  the web server's configuration file.
+
   There also needs to be a directory where attachments are stored
   before they are sent. Since personal mail is stored in this
   directory you might want to be a bit careful about how you set it
@@ -132,14 +148,30 @@ b. Setting up directories
   not supposed to read change the last line to chmod 777 SomeDirectory
   or simply use /tmp as you attachments directory. 
   
-  If a user is aborting a mail but has uploaded som attachments to it 
+  If a user is aborting a mail but has uploaded some attachments to it 
   the files will be lying around in this directory forever if you do not 
   remove them.  To fix this, it is recommended to create a cron job that
   deletes everything in the attachment directory.  Something similar
-  to the folling will be good enough:
+  to the following will be good enough:
 
     $ cd /var/attach/directory
     $ rm -f *
+    
+  However, this will delete attachments that are currently in use by people
+  sending email when the cron job runs.  You can either (1) make sure that
+  the cron job runs at an obscure hour and hope that nobody gets upset, or
+  (2) you can run a modified version of the commands above.  Check out the
+  man pages for other commands such as 'find' or 'tmpreaper'.
+  
+  One sample script you could set up that would erase all attachments, but
+  wouldn't erase preferences, address books, or the like (just in case your
+  attachment directory is the same as your data directory) might look like 
+  this:
+   
+    $ rm `find /var/attach/directory -atime +2 | grep -v "\." | grep -v _`
+    
+  Remember to be careful with whatever method you do use, and to test out
+  the command before it potentially wipes out everyone's preferences.
 
 c. Setting up SquirrelMail
 
@@ -158,7 +190,7 @@ c. Setting up SquirrelMail
   possible example of this is: 
      http://www.yourdomain.com/squirrelmail
      
-  It should be pretty stright forward to use. Some more documentation
+  It should be pretty straight forward to use. Some more documentation
   might show up one day or another.