- added a view header option
[squirrelmail.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 33c223a0e67c58e5e06f693673180ed62ec87836..77181a7e584b801baa48b59b5bac657f006f3aee 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,3 +1,13 @@
+Table of Contents:
+  1.  (PHP4)     Configure your webserver to work with PHP4
+  2.  (IMAP)     Setting up IMAP (not covered)
+  3.  (INSTALL)  Obtaining and installing SquirrelMail
+  4.  (RUN)      Running SquirrelMail
+  5.  (CHARSETS) Russian Charsets
+
+
+
+
 1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP4
 ---------------------------------------------
 
@@ -36,19 +46,16 @@ b. Changing php.ini
   can be done at configure time with the configuration directive
   --with-config-file-path=PATH.
 
-  Squirrelmail does not use cookies as of version 0.4.  Edit the 
-  php.ini file and change session.use_cookies to 0 (false).  Also 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
+  Edit the php.ini file and make sure session.use_cookies is 1.  Also 
+  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.
 
-  SECURITY WARNING - SquirrelMail saves non plaintext passwords in 
-  PHP's session data to log on to the IMAP server.  If a user has 
-  access to write PHP scripts on your system and knows the location 
-  where PHP stores session data, he could get a listing of the 
-  sessions being used and then read a given 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.
+  SECURITY WARNING - If a user has access to write PHP scripts on your 
+  system and knows the location where PHP stores session data, he 
+  could get a listing of the sessions being used and then read a given 
+  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.
 
 c. Setting up .php files to use PHP4
 
@@ -77,7 +84,7 @@ d. Running into trouble
 
   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
+  http://www.squirrelmail.org/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).
@@ -127,13 +134,27 @@ b. Setting up directories
 
 c. Setting up SquirrelMail
 
-  All configuration directives you need to worry about in SquirrelMail
-  is in the file config/config.php in you SquirrelMail directory. This
-  file is pretty well commented.
+  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
+  the config.
+
+  You can also copy the config/config_default.php file to config.php
+  and edit that manually.
 
 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 stright forward to use. Some more documentation
+  might show up one day or another.
+
+
+5. RUSSIAN CHARSETS
+-------------------
+
+  For information on how to make SquirrelMail work with Russian
+  Apache, see the README.russian_apache in the doc/ subdirectory.