New icon theming. Also added basic template for left_main.php

[squirrelmail.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index cf1f63099cd4057f60af73cce44dba595da6a854..d7d1457c7f79f0a652f0bcc38678da19ea9fc20b 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -3,7 +3,7 @@ Installing SquirrelMail
 
 Table of Contents:
   0.  (QUICK!)   Quick install guide
 
 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
   2.  (IMAP)     Setting up IMAP (not covered)
   3.  (INSTALL)  Obtaining and installing SquirrelMail
   4.  (RUN)      Running SquirrelMail


@@ -17,12 +17,12 @@ Table of Contents:
 
 Each of these steps is covered in detail below.
 
 
 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).
   The data-dir (for user prefs) should be owned by the user the webserver
 - 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).
   The data-dir (for user prefs) should be owned by the user the webserver

-  runs as (eg www-data). The attachment dir (for uploading files as
+  runs as (e.g. www-data). The attachment dir (for uploading files as

   attachments) should be file mode 0730 and in the same group as the
   webserver.
 - Run config/conf.pl from the command line. Use the D option to load
   attachments) should be file mode 0730 and in the same group as the
   webserver.
 - Run config/conf.pl from the command line. Use the D option to load


@@ -33,28 +33,46 @@ Each of these steps is covered in detail below.
 - Browse to http://www.example.com/yourwebmaillocation/ to log in.
 
 
 - 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
 
   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.
 
 
   You can find PHP at http://www.php.net. See the documentation that
   comes with PHP for instructions how to set it up.
 

-  The PHP IMAP extension is NOT neccessary at all (but won't harm)!
+  The PHP IMAP extension is NOT necessary at all (but won't harm)!

   Below is a list of optional PHP extensions:
 
   Below is a list of optional PHP extensions:
 

-  --with-ldap     Required for LDAP addressbooks
-  --with-mhash    Will improve charset decoding if present
-  --with-mysql    For MySQL storage of preferences or addressbooks
-  --with-openssl  When you want to use encrypted IMAP connections (TLS)
+  --with-ldap
+    Required for LDAP addressbooks

 
 

-  If you're going to use LDAP in the addressbook, you must compile PHP
-  with the LDAP extension. Include the MHASH extension to improve
-  performance in character set decoding.
+  --with-pear and --with-mysql
+    For MySQL storage of preferences or addressbooks. You will need PHP
+    compiled with --with-pgsql option, if you want to use PostgreSQL instead
+    of MySQL. You will need PHP with appropriate database extension, if you
+    want to use any other database.

 
 

+  --with-openssl
+    Required for encrypted IMAP or SMTP connections (TLS)
+
+  --with-mcrypt
+    Can be used by SquirrelSpell plugin for encryption of personal
+    dictionaries
+
+  --with-iconv or --with-recode
+    Can be used by Eastern charset decoding functions
+
+  --enable-mbstring
+    Required for Japanese translation. Optional for translations that
+    use non-ISO-8859-1 charset
+
+  It is highly advised to NOT turn on register_globals, as this can lead
+  to security holes. If you must use register_globals for some applications,
+  turn it on locally for only those directories, or turn it off for the
+  SquirrelMail folder.

   If you want your users to attach files to their mails, make sure
   File Uploads in php.ini is set to On.
 
   If you want your users to attach files to their mails, make sure
   File Uploads in php.ini is set to On.
 


@@ -92,13 +110,14 @@ b. Setting up directories
   directories outside of your web tree.
 
   The data directory is used for storing user preferences, like
   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,
 
   Keep in mind that with different installations, the web server could
   typically run as userid/groupid of nobody/nobody, nobody/nogroup,


@@ -120,8 +139,8 @@ b. Setting up directories
     $ chmod 730 SomeDirectory
 
   If you trust all the users on you system not to read mail they are
     $ 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
 
   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


@@ -129,7 +148,7 @@ b. Setting up directories
   deletes everything in the attachment directory.  Something similar
   to the following will be good enough:
 
   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
     $ rm -f *
 
   However, this will delete attachments that are currently in use by people


@@ -143,18 +162,21 @@ b. Setting up directories
   attachment directory is the same as your data directory) might look like
   this:
 
   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
 
 
   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 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.
 
   You can also copy the config/config_default.php file to config/config.php
   and edit that manually.
 


@@ -169,7 +191,7 @@ c. Setting up SquirrelMail
 
   Point your browser at the URL at which SquirrelMail is installed.  A
   possible example of this is:
 
   Point your browser at the URL at which SquirrelMail is installed.  A
   possible example of this is:

-     http://www.yourdomain.com/squirrelmail
+     http://www.example.com/squirrelmail

 
   It should be pretty straight forward to use. Some more documentation
   might show up one day or another.
 
   It should be pretty straight forward to use. Some more documentation
   might show up one day or another.


@@ -179,7 +201,7 @@ c. Setting up SquirrelMail
 -------------------
 
   For information on how to make SquirrelMail work with Russian
 -------------------
 
   For information on how to make SquirrelMail work with Russian

-  Apache, see the README.russian_apache in the doc/ subdirectory.
+  Apache, see the russian_apache.txt in the doc/ subdirectory.

 
 
 6. TRANSLATIONS
 
 
 6. TRANSLATIONS


@@ -192,24 +214,26 @@ c. Setting up SquirrelMail
   Locale packages can be downloaded from SquirrelMail SourceForge
   project page.
 
   Locale packages can be downloaded from SquirrelMail SourceForge
   project page.
 

-  http://sourceforge.net/project/showfiles.php?group_id=311&package_id=110388
+     http://sourceforge.net/project/showfiles.php?group_id=311&package_id=110388

 
 

-  Each translation contains install script that copies required files
-  into appropriate locations. If you can't run that script, you can extract
-  contents of translation packages into your SquirrelMail directory.
+  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 a translation package into your SquirrelMail
+  directory.

 
 

-  NOTE No.1: *-src.tar.gz, *-src.tar.bz2 and *-src.zip archives does not contain
-  compiled translation files. You will need to run compilelocales script
+  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

   in order to get all gettext binary translations.
 
   NOTE No.2: You might need to restart your webserver before using translations.
   If you can't do that, install your translations _before_ you use SquirrelMail.
 
   in order to get all gettext binary translations.
 
   NOTE No.2: You might need to restart your webserver before using translations.
   If you can't do that, install your translations _before_ you use SquirrelMail.
 

+

 7. PLUGINS
 ----------
 
 7. PLUGINS
 ----------
 

-  SquirrelMail package includes some standard plugins. These plugins can be 
-  enabled in SquirrelMail configuration script.
+  The SquirrelMail package includes some standard plugins. These plugins can be
+  enabled in the SquirrelMail configuration script.

 
   Included plugins can use additional configuration files:
   * change_password
 
   Included plugins can use additional configuration files:
   * change_password


@@ -221,5 +245,5 @@ c. Setting up SquirrelMail
     configuration is stored in plugins/squirrelspell/sqspell_config.php
     Default configuration might not work on your server.
   * administrator
     configuration is stored in plugins/squirrelspell/sqspell_config.php
     Default configuration might not work on your server.
   * administrator

-    plugin must be setup correctly in order to detect administrative user. 
+    plugin must be setup correctly in order to detect administrative user.

     See plugins/administrator/INSTALL
     See plugins/administrator/INSTALL