fix for broken drafts. Patch from Ryan O'Neill

[squirrelmail.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 77181a7e584b801baa48b59b5bac657f006f3aee..2116f8b6e65ab577580aff5531b8f9c0b73abee5 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,3 +1,6 @@
+Installing SquirrelMail
+=======================
+

 Table of Contents:
   1.  (PHP4)     Configure your webserver to work with PHP4
   2.  (IMAP)     Setting up IMAP (not covered)
 Table of Contents:
   1.  (PHP4)     Configure your webserver to work with PHP4
   2.  (IMAP)     Setting up IMAP (not covered)


@@ -17,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).
 
   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 beta2. 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
 a. Obtaining and compiling PHP4
 
   Point your favorite webserver at http://www.php.net/version4/ and


@@ -50,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.
   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 
 
   SECURITY WARNING - If a user has access to write PHP scripts on your 
   system and knows the location where PHP stores session data, he 


@@ -104,13 +114,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
 
   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
   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.

 
 

-    chown -R nobody data
-    chgrp -R nobody data
-  

   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
   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


@@ -120,26 +135,48 @@ b. Setting up directories
   permissions. You could do this by running these commands (still
   granted that the webserver is running as nobody/nobody)
 
   permissions. You could do this by running these commands (still
   granted that the webserver is running as nobody/nobody)
 

-    cd /var/some/place
-    mkdir SomeDirectory
-    chgrp -R nobody SomeDirectory
-    chmod 730 SomeDirectory
+    $ cd /var/some/place
+    $ mkdir SomeDirectory
+    $ chgrp -R nobody SomeDirectory
+    $ chmod 730 SomeDirectory

 
   If you trust all the users on you system not to read mail they are
   not supposed to read change the last line to chmod 777 SomeDirectory
 
   If you trust all the users on you system not to read mail they are
   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 the files
-  will be lying around in this directory forever if you do not remove
-  them.
+  or simply use /tmp as you attachments directory. 
+  
+  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 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
 
   There are two ways to configure Squirrelmail.  In the config/ directory,
   there is a perl script called conf.pl that will aid you in the
 
 c. Setting up SquirrelMail
 
   There are two ways to configure Squirrelmail.  In the config/ directory,
   there is a perl script called conf.pl that will aid you in the

-  configuration process.  This is the most recommended way of handling
+  configuration process.  This is the recommended way of handling

   the config.
 
   the config.
 

-  You can also copy the config/config_default.php file to config.php
+  You can also copy the config/config_default.php file to config/config.php

   and edit that manually.
 
 4. RUNNING SQUIRRELMAIL
   and edit that manually.
 
 4. RUNNING SQUIRRELMAIL


@@ -149,7 +186,7 @@ c. Setting up SquirrelMail
   possible example of this is: 
      http://www.yourdomain.com/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.
 
 
   might show up one day or another.