Updated some documentation
[squirrelmail.git] / INSTALL
CommitLineData
17cec454 11. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP4
2---------------------------------------------
f8f9bed9 3
17cec454 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).
9b57e848 9
17cec454 10a. Obtaining and compiling PHP4
f8f9bed9 11
17cec454 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:
f8f9bed9 16
17cec454 17 ./configure --enable-track-vars --enable-force-cgi-redirect --with-gettext
f8ba9180 18
17cec454 19 If you have a database like MySQL you might want to add something
20 like --with-mysql to get database functionality.
21
22 Run make to build the binary file. This will generate a binary file
23 called "php". Move this file into a CGI-directory.
24
25 You might also want to read the INSTALL file in the PHP-distribution
26 :-)
27
28b. Setting up .php files to use PHP4
29
30 You need to create a .htaccess file in you SquirrelMail directory
31 that looks something like this:
32
33 AddType application/php4script .php
34 Action application/php4script /cgi-bin/php
35
36 You could also add these lines to your Apache configuration file.
37
38c. Running into trouble
39
40 Setting up Apache with PHP4 can be a non-trivial task. Read the PHP4
41 and Apache documentation carefully if you run into trouble. If you
42 have an experienced system administrator around ask her/him to help
43 you.
44
452. SETTING UP IMAP
46------------------
47
48 This is not covered here :-/
49
503. OBTAINING AND INSTALLING SQUIRRELMAIL
51----------------------------------------
52
53 SquirrelMail is still under development. Therefore you should always
54 get the newest version around. Look at
55 http://squirrelmail.sourceforge.net/index.php3?page=5 to see what it
56 is. If you want to be bleeding edge you might want to consider using
57 the latest CVS version (with the latest and most fashionable of
58 bugs).
59
60a. Download SquirrelMail
61
62 Get SquirrelMail from the address above if you do not have it or are
63 uncertain if you have the newest version. Untar (again tar xvfz
64 filename.tgz) SquirrelMail in a directory that is readable for your
65 webserver.
66
67b. Setting up directories
68
69 SquirrelMail uses two directories to store user configuration and
70 attachments that are about to be sent. You might want to have these
71 directories outside of your web tree.
72
73 The data directory is used for storing user preferences, like
74 signature, name and theme. When unpacking the sources this directory
75 is created as data/ in you SquirrelMail directory. This directory
76 must be writable by the webserver. If your webserver is running as
77 the user nobody you can fix this by running:
65b14f90 78
33daaa7d 79 chown -R nobody data
80 chgrp -R nobody data
17cec454 81
82 There also needs to be a directory where attachments are stored
83 before they are sent. Since personal mail is stored in this
84 directory you might want to be a bit careful about how you set it
85 up. It should be owned by another user than the webserver is running
86 as (root might be a good choice) and the webserver should have write
87 and execute permissions on the directory, but should not have read
88 permissions. You could do this by running these commands (still
89 granted that the webserver is running as nobody/nobody)
90
91 cd /var/some/place
92 mkdir SomeDirectory
93 chgrp -R nobody SomeDirectory
94 chmod 730 SomeDirectory
95
96 If you trust all the users on you system not to read mail they are
97 not supposed to read change the last line to chmod 777 SomeDirectory
98 or simply use /tmp as you attachments directory. If a user is
99 aborting a mail but has uploaded som attachments to it the files
100 will be lying around in this directory forever if you do not remove
101 them.
102
103c. Setting up SquirrelMail
104
105 All configuration directives you need to worry about in SquirrelMail
106 is in the file config/config.php in you SquirrelMail directory. This
107 file is pretty well commented.
65b14f90 108
17cec454 1094. RUNNING SQUIRRELMAIL
110-----------------------
65b14f90 111
17cec454 112 Point your browser at the URL at which SquirrelMail is installed. It
113 should be pretty stright forward to use. Some more documentation
c973661d 114 might show up onbe day or another.