* added vcard url, skeleton functions. slow but not to slow ;) more is to come !
[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 v4.0.2. 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   Squirrelmail 1.2.x also requires register_globals to be enabled. 
63
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.
69
70   FILE UPLOADS - Note that sending messages will not work if your
71   "file_uploads" setting is "Off". Squirrelmail requires that setting
72   enabled in order to work.
73
74 c. Setting up .php files to use PHP4
75
76   You need to create a .htaccess file in you SquirrelMail directory
77   that looks something like this:
78
79     AddType application/php4script .php
80     Action application/php4script /cgi-bin/php
81
82   You could also add these lines to your Apache configuration file.
83
84 d. Running into trouble
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.
90
91 2. SETTING UP IMAP
92 ------------------
93
94   This is not covered here :-/
95
96 3. OBTAINING AND INSTALLING SQUIRRELMAIL
97 ----------------------------------------
98
99   SquirrelMail is still under development. Therefore you should always
100   get the newest version around. Look at
101   http://www.squirrelmail.org/index.php3?page=5 to see what it
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).
105
106 a. Download SquirrelMail
107
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.
112
113 b. Setting up directories
114
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.
118
119   The data directory is used for storing user preferences, like
120   signature, name and theme. When unpacking the sources this directory
121   is created as data/ in your SquirrelMail directory. This directory
122   must be writable by the webserver. If your webserver is running as
123   the user "nobody" you can fix this by running:
124
125     $ chown -R nobody data
126     $ chgrp -R nobody data
127
128   Keep in mind that with different installations, the web server could
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.
132
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)
141
142     $ cd /var/some/place
143     $ mkdir SomeDirectory
144     $ chgrp -R nobody SomeDirectory
145     $ chmod 730 SomeDirectory
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
149   or simply use /tmp as you attachments directory. 
150   
151   If a user is aborting a mail but has uploaded some attachments to it 
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
155   to the following will be good enough:
156
157     $ cd /var/attach/directory
158     $ rm -f *
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'.
165   
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:
170    
171     $ rm `find /var/attach/directory -atime +2 | grep -v "\." | grep -v _`
172     
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.
175
176 c. Setting up SquirrelMail
177
178   There are two ways to configure Squirrelmail.  In the config/ directory,
179   there is a perl script called conf.pl that will aid you in the
180   configuration process.  This is the recommended way of handling
181   the config.
182
183   You can also copy the config/config_default.php file to config/config.php
184   and edit that manually.
185
186 4. RUNNING SQUIRRELMAIL
187 -----------------------
188
189   Point your browser at the URL at which SquirrelMail is installed.  A
190   possible example of this is: 
191      http://www.yourdomain.com/squirrelmail
192      
193   It should be pretty straight forward to use. Some more documentation
194   might show up one day or another.
195
196
197 5. RUSSIAN CHARSETS
198 -------------------
199
200   For information on how to make SquirrelMail work with Russian
201   Apache, see the README.russian_apache in the doc/ subdirectory.