Better support for malformed/absent dates and headerlines ending in only "\n".

[squirrelmail.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index f242ce9ce1aabf3f963df9f50fce4fc510b7e5b1..2f8c7081bd160bca350f44d5e087d27f5c131a65 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)


@@ -6,8 +9,6 @@ Table of Contents:
   5.  (CHARSETS) Russian Charsets
 
 
   5.  (CHARSETS) Russian Charsets
 
 

-
-

 1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP4
 ---------------------------------------------
 
 1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP4
 ---------------------------------------------
 


@@ -17,9 +18,15 @@ 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).
 

+  You will need at least PHP v4.0.6. If you need to upgrade please go
+  ahead and install it now.
+

 a. Obtaining and compiling PHP4
 a. Obtaining and compiling PHP4

+  
+  SquirrelMail has not been extensively tested for use with PHP 4.3.x.
+  See the ReleaseNotes file.

 
 

-  Point your favorite webserver at http://www.php.net/version4/ and
+  Point your favorite web browser at http://www.php.net/downloads.php/ and

   download the source. Untar (tar xvfz filename-you-downloaded.tgz)
   the source, cd into the directory and run configure. To make PHP4
   work with SquirrelMail a commandline like this should do:
   download the source. Untar (tar xvfz filename-you-downloaded.tgz)
   the source, cd into the directory and run configure. To make PHP4
   work with SquirrelMail a commandline like this should do:


@@ -57,6 +64,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.
 
   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 attachments will not work if your
+  "file_uploads" setting is "Off". Squirrelmail requires that setting
+  enabled in order to be able to attach files.
+

 c. Setting up .php files to use PHP4
 
   You need to create a .htaccess file in you SquirrelMail directory
 c. Setting up .php files to use PHP4
 
   You need to create a .htaccess file in you SquirrelMail directory


@@ -82,12 +93,11 @@ d. Running into trouble
 3. OBTAINING AND INSTALLING SQUIRRELMAIL
 ----------------------------------------
 
 3. OBTAINING AND INSTALLING SQUIRRELMAIL
 ----------------------------------------
 

-  SquirrelMail is still under development. Therefore you should always
-  get the newest version around. Look at
-  http://squirrelmail.sourceforge.net/index.php3?page=5 to see what it
-  is. If you want to be bleeding edge you might want to consider using
-  the latest CVS version (with the latest and most fashionable of
-  bugs).
+  SquirrelMail is constantly being improved. Therefore you should always
+  get the newest version around. Look at http://www.squirrelmail.org/
+  to see what it is. If you want to be bleeding edge you might want to
+  consider using the latest CVS version (with the latest and most
+  fashionable of bugs).

 
 a. Download SquirrelMail
 
 
 a. Download SquirrelMail
 


@@ -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,34 +135,65 @@ 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
 
 
 c. Setting up SquirrelMail
 

-  There are two ways to configure Squirrelmail.  In the config/ directory,
+  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
   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.
 
   and edit that manually.
 

+  After you've created a configuration, you can use your webbrowser to
+  browse to http://your-squirrelmail-location/src/configtest.php.
+  This will perform some basic checks on your config to make sure
+  everything works like it should.
+
+

 4. RUNNING SQUIRRELMAIL
 -----------------------
 
 4. RUNNING SQUIRRELMAIL
 -----------------------
 

-  Point your browser at the URL at which SquirrelMail is installed. It
-  should be pretty stright forward to use. Some more documentation
-  might show up onbe day or another.
+  Point your browser at the URL at which SquirrelMail is installed.  A
+  possible example of this is: 
+     http://www.yourdomain.com/squirrelmail
+     
+  It should be pretty straight forward to use. Some more documentation
+  might show up one day or another.

 
 
 5. RUSSIAN CHARSETS
 
 
 5. RUSSIAN CHARSETS