* Fixed a couple typos
[squirrelmail.git] / INSTALL
1 Installing SquirrelMail
2 =======================
3
4 Table of Contents:
5   1.  (PHP4)     Configure your webserver to work with PHP4
6   2.  (IMAP)     Setting up IMAP (not covered)
7   3.  (INSTALL)  Obtaining and installing SquirrelMail
8   4.  (RUN)      Running SquirrelMail
9   5.  (CHARSETS) Russian Charsets
10
11
12
13
14 1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP4
15 ---------------------------------------------
16
17   If your webserver does not already have PHP4 you must configure it
18   to work with PHP4. SquirrelMail uses the standard suffix .php for
19   all PHP4 files. This is a quick and dirty guide to installing PHP4
20   to run as CGI under Apache. How you end up doing this is up to you
21   (your mileage may vary).
22
23   NOTE: The new plugin architecture required the use of some functions 
24   which are not in all versions of PHP4. You will need at least 
25   PHP4 beta2. If you need to upgrade please go ahead and install the
26   latest release version of PHP4.
27
28 a. Obtaining and compiling PHP4
29
30   Point your favorite webserver at http://www.php.net/version4/ and
31   download the source. Untar (tar xvfz filename-you-downloaded.tgz)
32   the source, cd into the directory and run configure. To make PHP4
33   work with SquirrelMail a commandline like this should do:
34
35    ./configure --enable-track-vars --enable-force-cgi-redirect --with-gettext
36
37   If you have a database like MySQL you might want to add something
38   like --with-mysql to get database functionality.
39
40   If you're going to use LDAP in the addressbook, you must compile PHP4
41   with --with-ldap (see the PHP4 docs for more information).
42
43   Run make to build the binary file. This will generate a binary file
44   called "php". Move this file into a CGI-directory.
45
46   You might also want to read the INSTALL file in the PHP-distribution
47   :-)
48
49 b. Changing php.ini
50
51   PHP defaults to look for php.ini (PHP's configuration file) in
52   /usr/local/lib.  However, for security reasons, it is suggested
53   that the location of this file is changed to someplace else.  This
54   can be done at configure time with the configuration directive
55   --with-config-file-path=PATH.
56
57   Edit the php.ini file and make sure session.use_cookies is 1.  Also 
58   be sure to change the session.save_path to someplace that can only 
59   be read and written to by the webserver.  session.save_path is the
60   location that PHP's session data will be written to.
61
62   SECURITY WARNING - If a user has access to write PHP scripts on your 
63   system and knows the location where PHP stores session data, he 
64   could get a listing of the sessions being used and then read a given 
65   session's data with his own PHP script.  Caution should be used when 
66   setting up permissions and locations of php.ini and the session data.
67
68 c. Setting up .php files to use PHP4
69
70   You need to create a .htaccess file in you SquirrelMail directory
71   that looks something like this:
72
73     AddType application/php4script .php
74     Action application/php4script /cgi-bin/php
75
76   You could also add these lines to your Apache configuration file.
77
78 d. Running into trouble
79
80   Setting up Apache with PHP4 can be a non-trivial task. Read the PHP4
81   and Apache documentation carefully if you run into trouble. If you
82   have an experienced system administrator around ask her/him to help
83   you.
84
85 2. SETTING UP IMAP
86 ------------------
87
88   This is not covered here :-/
89
90 3. OBTAINING AND INSTALLING SQUIRRELMAIL
91 ----------------------------------------
92
93   SquirrelMail is still under development. Therefore you should always
94   get the newest version around. Look at
95   http://www.squirrelmail.org/index.php3?page=5 to see what it
96   is. If you want to be bleeding edge you might want to consider using
97   the latest CVS version (with the latest and most fashionable of
98   bugs).
99
100 a. Download SquirrelMail
101
102   Get SquirrelMail from the address above if you do not have it or are
103   uncertain if you have the newest version. Untar (again tar xvfz
104   filename.tgz) SquirrelMail in a directory that is readable for your
105   webserver.
106
107 b. Setting up directories
108
109   SquirrelMail uses two directories to store user configuration and
110   attachments that are about to be sent. You might want to have these
111   directories outside of your web tree.
112
113   The data directory is used for storing user preferences, like
114   signature, name and theme. When unpacking the sources this directory
115   is created as data/ in your SquirrelMail directory. This directory
116   must be writable by the webserver. If your webserver is running as
117   the user "nobody" you can fix this by running:
118
119     $ chown -R nobody data
120     $ chgrp -R nobody data
121
122   Keep in mind that with different installations, the web server could
123   typically run as userid/groupid of apache/apache or www-data/www-data.
124   The best way to find out is to read the web server's configuration file.
125
126   There also needs to be a directory where attachments are stored
127   before they are sent. Since personal mail is stored in this
128   directory you might want to be a bit careful about how you set it
129   up. It should be owned by another user than the webserver is running
130   as (root might be a good choice) and the webserver should have write
131   and execute permissions on the directory, but should not have read
132   permissions. You could do this by running these commands (still
133   granted that the webserver is running as nobody/nobody)
134
135     $ cd /var/some/place
136     $ mkdir SomeDirectory
137     $ chgrp -R nobody SomeDirectory
138     $ chmod 730 SomeDirectory
139
140   If you trust all the users on you system not to read mail they are
141   not supposed to read change the last line to chmod 777 SomeDirectory
142   or simply use /tmp as you attachments directory. 
143   
144   If a user is aborting a mail but has uploaded some attachments to it 
145   the files will be lying around in this directory forever if you do not 
146   remove them.  To fix this, it is recommended to create a cron job that
147   deletes everything in the attachment directory.  Something similar
148   to the following will be good enough:
149
150     $ cd /var/attach/directory
151     $ rm -f *
152     
153   However, this will delete attachments that are currently in use by people
154   sending email when the cron job runs.  You can either (1) make sure that
155   the cron job runs at an obscure hour and hope that nobody gets upset, or
156   (2) you can run a modified version of the commands above.  Check out the
157   man pages for other commands such as 'find' or 'tmpreaper'.
158   
159   One sample script you could set up that would erase all attachments, but
160   wouldn't erase preferences, address books, or the like (just in case your
161   attachment directory is the same as your data directory) might look like 
162   this:
163    
164     $ rm `find /var/attach/directory -atime +2 | grep -v "\." | grep -v _`
165     
166   Remember to be careful with whatever method you do use, and to test out
167   the command before it potentially wipes out everyone's preferences.
168
169 c. Setting up SquirrelMail
170
171   There are two ways to configure Squirrelmail.  In the config/ directory,
172   there is a perl script called conf.pl that will aid you in the
173   configuration process.  This is the recommended way of handling
174   the config.
175
176   You can also copy the config/config_default.php file to config/config.php
177   and edit that manually.
178
179 4. RUNNING SQUIRRELMAIL
180 -----------------------
181
182   Point your browser at the URL at which SquirrelMail is installed.  A
183   possible example of this is: 
184      http://www.yourdomain.com/squirrelmail
185      
186   It should be pretty stright forward to use. Some more documentation
187   might show up one day or another.
188
189
190 5. RUSSIAN CHARSETS
191 -------------------
192
193   For information on how to make SquirrelMail work with Russian
194   Apache, see the README.russian_apache in the doc/ subdirectory.