Adding kink's instuctions
[squirrelmail.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 5a75c96aa400c51bb7de5f403a51af381ff02193..049f6e67fcc29f71aa061abd23495d71a78117d6 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -3,7 +3,7 @@ Installing SquirrelMail
 
 Table of Contents:
   0.  (QUICK!)   Quick install guide
-  1.  (PHP4)     Configure your webserver to work with PHP4
+  1.  (PHP)      Configure your webserver to work with PHP
   2.  (IMAP)     Setting up IMAP (not covered)
   3.  (INSTALL)  Obtaining and installing SquirrelMail
   4.  (RUN)      Running SquirrelMail
@@ -17,7 +17,7 @@ Table of Contents:
 
 Each of these steps is covered in detail below.
 
-- Install webserver and PHP4 (at least 4.1.0).
+- Install webserver and PHP (at least 4.1.0).
 - Install IMAP server (see docs of that server).
 - Unpack the SquirrelMail package in a web-accessible location.
 - Select a data-dir and attachment dir, outside the webtree (e.g. in /var).
@@ -33,12 +33,12 @@ Each of these steps is covered in detail below.
 - Browse to http://www.example.com/yourwebmaillocation/ to log in.
 
 
-1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP4
----------------------------------------------
+1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP
+--------------------------------------------
 
   If your webserver does not already have PHP you must configure it
   to work with PHP. You need at least PHP v4.1.0. SquirrelMail uses
-  the standard suffix .php for all PHP4 files.
+  the standard suffix .php for all PHP files.
 
   You can find PHP at http://www.php.net. See the documentation that
   comes with PHP for instructions how to set it up.
@@ -106,13 +106,14 @@ b. Setting up directories
   directories outside of your web tree.
 
   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 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:
+  signature, name and theme. You need to create this directory yourself.
+  Recommended location is under /var, for example:
+  /var/local/squirrelmail/data
+  This directory must be writable by the webserver. If your webserver is
+  running as the user "nobody" and group "nobody" you can fix this by
+  running:
 
-    $ chown -R nobody data
-    $ chgrp -R nobody data
+    $ chown -R nobody:nobody /path/to/your/datadir
 
   Keep in mind that with different installations, the web server could
   typically run as userid/groupid of nobody/nobody, nobody/nogroup,
@@ -134,8 +135,8 @@ b. Setting up directories
     $ 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
-  or simply use /tmp as you attachments directory.
+  not supposed to read, you can 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
@@ -143,7 +144,7 @@ b. Setting up directories
   deletes everything in the attachment directory.  Something similar
   to the following will be good enough:
 
-    $ cd /var/attach/directory
+    $ cd /var/local/squirrelmail/attach
     $ rm -f *
 
   However, this will delete attachments that are currently in use by people
@@ -157,18 +158,21 @@ b. Setting up directories
   attachment directory is the same as your data directory) might look like
   this:
 
-    $ rm `find /var/attach/directory -atime +2 | grep -v "\." | grep -v _`
+    $ rm `find /var/local/squirrelmail/attach -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 are three 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 recommended way of handling
   the config.
 
+  There's also a plugin called 'administrator' for the webinterface but you'll
+  have to be able to at least log in to SquirrelMail first.
+
   You can also copy the config/config_default.php file to config/config.php
   and edit that manually.
 
@@ -210,11 +214,11 @@ c. Setting up SquirrelMail
 
   Each translation contains an install script that copies the required files
   into their appropriate locations. If you can't run that script, you can
-  extract the contents of translation packages into your SquirrelMail
+  extract the contents of a translation package into your SquirrelMail
   directory.
 
   NOTE No.1: *-src.tar.gz, *-src.tar.bz2 and *-src.zip archives do not contain
-  compiled translation files. You will need to run the compilelocales script
+  compiled translation files. You will need to run the "compilelocales" script
   in order to get all gettext binary translations.
 
   NOTE No.2: You might need to restart your webserver before using translations.