Added basic framework for plugin support. Very little code so far. Two
[squirrelmail.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 01638ee67209801bcd9d0022116a6be2fbd47b7e..77181a7e584b801baa48b59b5bac657f006f3aee 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,12 @@
-Sorry for the incomplete documentation at this time.  Here is a quick
-overview of how to install SquirrelMail.
+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
 ---------------------------------------------
@@ -22,13 +29,35 @@ a. Obtaining and compiling PHP4
   If you have a database like MySQL you might want to add something
   like --with-mysql to get database functionality.
 
+  If you're going to use LDAP in the addressbook, you must compile PHP4
+  with --with-ldap (see the PHP4 docs for more information).
+
   Run make to build the binary file. This will generate a binary file
   called "php". Move this file into a CGI-directory.
 
   You might also want to read the INSTALL file in the PHP-distribution
   :-)
 
-b. Setting up .php files to use PHP4
+b. Changing php.ini
+
+  PHP defaults to look for php.ini (PHP's configuration file) in
+  /usr/local/lib.  However, for security reasons, it is suggested
+  that the location of this file is changed to someplace else.  This
+  can be done at configure time with the configuration directive
+  --with-config-file-path=PATH.
+
+  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 - 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
 
   You need to create a .htaccess file in you SquirrelMail directory
   that looks something like this:
@@ -38,7 +67,7 @@ b. Setting up .php files to use PHP4
 
   You could also add these lines to your Apache configuration file.
 
-c. Running into trouble
+d. Running into trouble
 
   Setting up Apache with PHP4 can be a non-trivial task. Read the PHP4
   and Apache documentation carefully if you run into trouble. If you
@@ -55,7 +84,7 @@ c. 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).
@@ -105,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.
\ No newline at end of file
+  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.