INSTALL

   1 1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP4
   2 ---------------------------------------------
   3
   4   If your webserver does not already have PHP4 you must configure it
   5   to work with PHP4. SquirrelMail uses the standard suffix .php for
   6   all PHP4 files. This is a quick and dirty guide to installing PHP4
   7   to run as CGI under Apache. How you end up doing this is up to you
   8   (your mileage may vary).
   9
  10 a. Obtaining and compiling PHP4
  11
  12   Point your favorite webserver at http://www.php.net/version4/ and
  13   download the source. Untar (tar xvfz filename-you-downloaded.tgz)
  14   the source, cd into the directory and run configure. To make PHP4
  15   work with SquirrelMail a commandline like this should do:
  16
  17    ./configure --enable-track-vars --enable-force-cgi-redirect --with-gettext
  18
  19   If you have a database like MySQL you might want to add something
  20   like --with-mysql to get database functionality.
  21
  22   If you're going to use LDAP in the addressbook, you must compile PHP4
  23   with --with-ldap (see the PHP4 docs for more information).
  24
  25   Run make to build the binary file. This will generate a binary file
  26   called "php". Move this file into a CGI-directory.
  27
  28   You might also want to read the INSTALL file in the PHP-distribution
  29   :-)
  30
  31 b. Changing php.ini
  32
  33   PHP defaults to look for php.ini (PHP's configuration file) in
  34   /usr/local/lib.  However, for security reasons, it is suggested
  35   that the location of this file is changed to someplace else.  This
  36   can be done at configure time with the configuration directive
  37   --with-config-file-path=PATH.
  38
  39   Edit the php.ini file and make sure session.use_cookies is 1.  Also
  40   be sure to change the session.save_path to someplace that can only
  41   be read and written to by the webserver.  session.save_path is the
  42   location that PHP's session data will be written to.
  43
  44   SECURITY WARNING - If a user has access to write PHP scripts on your
  45   system and knows the location where PHP stores session data, he
  46   could get a listing of the sessions being used and then read a given
  47   session's data with his own PHP script.  Caution should be used when
  48   setting up permissions and locations of php.ini and the session data.
  49
  50 c. Setting up .php files to use PHP4
  51
  52   You need to create a .htaccess file in you SquirrelMail directory
  53   that looks something like this:
  54
  55     AddType application/php4script .php
  56     Action application/php4script /cgi-bin/php
  57
  58   You could also add these lines to your Apache configuration file.
  59
  60 d. Running into trouble
  61
  62   Setting up Apache with PHP4 can be a non-trivial task. Read the PHP4
  63   and Apache documentation carefully if you run into trouble. If you
  64   have an experienced system administrator around ask her/him to help
  65   you.
  66
  67 2. SETTING UP IMAP
  68 ------------------
  69
  70   This is not covered here :-/
  71
  72 3. OBTAINING AND INSTALLING SQUIRRELMAIL
  73 ----------------------------------------
  74
  75   SquirrelMail is still under development. Therefore you should always
  76   get the newest version around. Look at
  77   http://squirrelmail.sourceforge.net/index.php3?page=5 to see what it
  78   is. If you want to be bleeding edge you might want to consider using
  79   the latest CVS version (with the latest and most fashionable of
  80   bugs).
  81
  82 a. Download SquirrelMail
  83
  84   Get SquirrelMail from the address above if you do not have it or are
  85   uncertain if you have the newest version. Untar (again tar xvfz
  86   filename.tgz) SquirrelMail in a directory that is readable for your
  87   webserver.
  88
  89 b. Setting up directories
  90
  91   SquirrelMail uses two directories to store user configuration and
  92   attachments that are about to be sent. You might want to have these
  93   directories outside of your web tree.
  94
  95   The data directory is used for storing user preferences, like
  96   signature, name and theme. When unpacking the sources this directory
  97   is created as data/ in you SquirrelMail directory. This directory
  98   must be writable by the webserver. If your webserver is running as
  99   the user nobody you can fix this by running:
 100
 101     chown -R nobody data
 102     chgrp -R nobody data
 103
 104   There also needs to be a directory where attachments are stored
 105   before they are sent. Since personal mail is stored in this
 106   directory you might want to be a bit careful about how you set it
 107   up. It should be owned by another user than the webserver is running
 108   as (root might be a good choice) and the webserver should have write
 109   and execute permissions on the directory, but should not have read
 110   permissions. You could do this by running these commands (still
 111   granted that the webserver is running as nobody/nobody)
 112
 113     cd /var/some/place
 114     mkdir SomeDirectory
 115     chgrp -R nobody SomeDirectory
 116     chmod 730 SomeDirectory
 117
 118   If you trust all the users on you system not to read mail they are
 119   not supposed to read change the last line to chmod 777 SomeDirectory
 120   or simply use /tmp as you attachments directory. If a user is
 121   aborting a mail but has uploaded som attachments to it the files
 122   will be lying around in this directory forever if you do not remove
 123   them.
 124
 125 c. Setting up SquirrelMail
 126
 127   There are two ways to configure Squirrelmail.  In the config/ directory,
 128   there is a perl script called conf.pl that will aid you in the
 129   configuration process.  This is the most recommended way of handling
 130   the config.
 131
 132   You can also copy the config/config_default.php file to config.php
 133   and edit that manually.
 134
 135 4. RUNNING SQUIRRELMAIL
 136 -----------------------
 137
 138   Point your browser at the URL at which SquirrelMail is installed. It
 139   should be pretty stright forward to use. Some more documentation
 140   might show up onbe day or another.
 141
 142
 143 5. RUSSIAN CHARSETS
 144 -------------------
 145
 146   For information on how to make SquirrelMail work with Russian
 147   Apache, see the README.russian_apache in the doc/ subdirectory.