Fix requirements to reflect actual requirements according to Marc.
[squirrelmail.git] / INSTALL
d68a3926 1Installing SquirrelMail
3b3d853f 4Table 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
f8f9bed9 16
17cec454 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).
9b57e848 22
8905fa13 23 You will need at least PHP v4.0.6. If you need to upgrade please go
24 ahead and install it now.
eb0a8c50 25
17cec454 26a. Obtaining and compiling PHP4
f11c804f 27
28 SquirrelMail has not been tested for use with PHP 4.3.x. The
29 development team does not recommend the use of this software with
30 PHP 4.3.x until further testing can be done.
f8f9bed9 31
17cec454 32 Point your favorite webserver at and
33 download the source. Untar (tar xvfz filename-you-downloaded.tgz)
34 the source, cd into the directory and run configure. To make PHP4
35 work with SquirrelMail a commandline like this should do:
f8f9bed9 36
17cec454 37 ./configure --enable-track-vars --enable-force-cgi-redirect --with-gettext
f8ba9180 38
17cec454 39 If you have a database like MySQL you might want to add something
40 like --with-mysql to get database functionality.
45c0a3a3 42 If you're going to use LDAP in the addressbook, you must compile PHP4
43 with --with-ldap (see the PHP4 docs for more information).
17cec454 45 Run make to build the binary file. This will generate a binary file
46 called "php". Move this file into a CGI-directory.
48 You might also want to read the INSTALL file in the PHP-distribution
49 :-)
2a32fc83 51b. Changing php.ini
53 PHP defaults to look for php.ini (PHP's configuration file) in
54 /usr/local/lib. However, for security reasons, it is suggested
55 that the location of this file is changed to someplace else. This
56 can be done at configure time with the configuration directive
57 --with-config-file-path=PATH.
a167feaf 59 Edit the php.ini file and make sure session.use_cookies is 1. Also
60 be sure to change the session.save_path to someplace that can only
61 be read and written to by the webserver. session.save_path is the
2a32fc83 62 location that PHP's session data will be written to.
a167feaf 64 SECURITY WARNING - If a user has access to write PHP scripts on your
65 system and knows the location where PHP stores session data, he
66 could get a listing of the sessions being used and then read a given
67 session's data with his own PHP script. Caution should be used when
68 setting up permissions and locations of php.ini and the session data.
2a32fc83 69
76911253 70 FILE UPLOADS - Note that sending attachments will not work if your
1067414d 71 "file_uploads" setting is "Off". Squirrelmail requires that setting
76911253 72 enabled in order to be able to attach files.
1067414d 73
2a32fc83 74c. Setting up .php files to use PHP4
17cec454 75
76 You need to create a .htaccess file in you SquirrelMail directory
77 that looks something like this:
79 AddType application/php4script .php
80 Action application/php4script /cgi-bin/php
82 You could also add these lines to your Apache configuration file.
2a32fc83 84d. Running into trouble
17cec454 85
86 Setting up Apache with PHP4 can be a non-trivial task. Read the PHP4
87 and Apache documentation carefully if you run into trouble. If you
88 have an experienced system administrator around ask her/him to help
89 you.
94 This is not covered here :-/
99 SquirrelMail is still under development. Therefore you should always
100 get the newest version around. Look at
429f8906 101 to see what it
17cec454 102 is. If you want to be bleeding edge you might want to consider using
103 the latest CVS version (with the latest and most fashionable of
104 bugs).
106a. Download SquirrelMail
108 Get SquirrelMail from the address above if you do not have it or are
109 uncertain if you have the newest version. Untar (again tar xvfz
110 filename.tgz) SquirrelMail in a directory that is readable for your
111 webserver.
113b. Setting up directories
115 SquirrelMail uses two directories to store user configuration and
116 attachments that are about to be sent. You might want to have these
117 directories outside of your web tree.
119 The data directory is used for storing user preferences, like
120 signature, name and theme. When unpacking the sources this directory
b731cd83 121 is created as data/ in your SquirrelMail directory. This directory
17cec454 122 must be writable by the webserver. If your webserver is running as
b731cd83 123 the user "nobody" you can fix this by running:
65b14f90 124
390372b4 125 $ chown -R nobody data
126 $ chgrp -R nobody data
4bc627ae 127
128 Keep in mind that with different installations, the web server could
ff65039a 129 typically run as userid/groupid of nobody/nobody, nobody/nogroup,
130 apache/apache or www-data/www-data. The best way to find out is to read
131 the web server's configuration file.
4bc627ae 132
17cec454 133 There also needs to be a directory where attachments are stored
134 before they are sent. Since personal mail is stored in this
135 directory you might want to be a bit careful about how you set it
136 up. It should be owned by another user than the webserver is running
137 as (root might be a good choice) and the webserver should have write
138 and execute permissions on the directory, but should not have read
139 permissions. You could do this by running these commands (still
140 granted that the webserver is running as nobody/nobody)
390372b4 142 $ cd /var/some/place
143 $ mkdir SomeDirectory
144 $ chgrp -R nobody SomeDirectory
145 $ chmod 730 SomeDirectory
17cec454 146
147 If you trust all the users on you system not to read mail they are
148 not supposed to read change the last line to chmod 777 SomeDirectory
390372b4 149 or simply use /tmp as you attachments directory.
4bc627ae 151 If a user is aborting a mail but has uploaded some attachments to it
390372b4 152 the files will be lying around in this directory forever if you do not
153 remove them. To fix this, it is recommended to create a cron job that
154 deletes everything in the attachment directory. Something similar
4bc627ae 155 to the following will be good enough:
390372b4 156
157 $ cd /var/attach/directory
158 $ rm -f *
4bc627ae 159
160 However, this will delete attachments that are currently in use by people
161 sending email when the cron job runs. You can either (1) make sure that
162 the cron job runs at an obscure hour and hope that nobody gets upset, or
163 (2) you can run a modified version of the commands above. Check out the
164 man pages for other commands such as 'find' or 'tmpreaper'.
166 One sample script you could set up that would erase all attachments, but
167 wouldn't erase preferences, address books, or the like (just in case your
168 attachment directory is the same as your data directory) might look like
169 this:
171 $ rm `find /var/attach/directory -atime +2 | grep -v "\." | grep -v _`
173 Remember to be careful with whatever method you do use, and to test out
174 the command before it potentially wipes out everyone's preferences.
17cec454 175
176c. Setting up SquirrelMail
be8e07f8 178 There are two ways to configure Squirrelmail. In the config/ directory,
179 there is a perl script called that will aid you in the
390372b4 180 configuration process. This is the recommended way of handling
be8e07f8 181 the config.
390372b4 183 You can also copy the config/config_default.php file to config/config.php
be8e07f8 184 and edit that manually.
65b14f90 185
65b14f90 188
429f8906 189 Point your browser at the URL at which SquirrelMail is installed. A
190 possible example of this is:
3d8fe250 193 It should be pretty straight forward to use. Some more documentation
429f8906 194 might show up one day or another.
8c086db6 195
200 For information on how to make SquirrelMail work with Russian
201 Apache, see the README.russian_apache in the doc/ subdirectory.