1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
Installing SquirrelMail
=======================
Table of Contents:
0. (QUICK!) Quick install guide
1. (PHP4) Configure your webserver to work with PHP4
2. (IMAP) Setting up IMAP (not covered)
3. (INSTALL) Obtaining and installing SquirrelMail
4. (RUN) Running SquirrelMail
5. (CHARSETS) Russian Charsets
6. (LOCALES) Translations of SquirrelMail
0. QUICK INSTALL GUIDE
----------------------
Each of these steps is covered in detail below.
- Install webserver and PHP4 (at least 4.0.6).
- Install IMAP server (see docs of that server).
- Unpack the SquirrelMail package in a web-accessible location.
- Select a data-dir and attachment dir, outside the webtree (e.g. in /var).
The data-dir (for user prefs) should be owned by the user the webserver
runs as (eg www-data). The attachment dir (for uploading files as
attachments) should be file mode 0730 and in the same group as the
webserver.
- Run config/conf.pl from the command line. Use the D option to load
predefined options for specific IMAP servers, and edit at least the
Server Settings and General Options (datadir).
- Browse to http://www.example.com/yourwebmaillocation/src/configtest.php
to test your configuration for common errors.
- Browse to http://www.example.com/yourwebmaillocation/ to log in.
1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP4
---------------------------------------------
If your webserver does not already have PHP you must configure it
to work with PHP. You need at least PHP v4.0.6. SquirrelMail uses
the standard suffix .php for all PHP4 files.
You can find PHP at http://www.php.net. See the documentation that
comes with PHP for instructions how to set it up.
The PHP IMAP extension is NOT neccessary at all (but won't harm)!
Below is a list of optional PHP extensions:
--with-ldap Required for LDAP addressbooks
--with-mhash Will improve charset decoding if present
--with-mysql For MySQL storage of preferences or addressbooks
--with-openssl When you want to use encrypted IMAP connections (TLS)
If you're going to use LDAP in the addressbook, you must compile PHP
with the LDAP extension. Include the MHASH extension to improve
performance in character set decoding.
If you want your users to attach files to their mails, make sure
File Uploads in php.ini is set to On.
2. SETTING UP IMAP
------------------
This depends a lot on the server your choose. See the documentation
that comes with your server.
If you're concerned about people accessing it directly, you can
limit access to only the IP of the webserver.
3. OBTAINING AND INSTALLING SQUIRRELMAIL
----------------------------------------
SquirrelMail is constantly being improved. Therefore you should always
get the newest version around. Look at http://www.squirrelmail.org
to see what it is. If you want to be bleeding edge you might want to
consider using the latest CVS version (with the latest and most
fashionable bugs).
a. Download SquirrelMail
Get SquirrelMail from the address above if you do not have it or are
uncertain if you have the newest version. Untar (again tar xvfz
filename.tgz) SquirrelMail in a directory that is readable for your
webserver.
b. Setting up directories
SquirrelMail uses two directories to store user configuration and
attachments that are about to be sent. You might want to have these
directories outside of your web tree.
The data directory is used for storing user preferences, like
signature, name and theme. When unpacking the sources this directory
is created as data/ in your SquirrelMail directory. This directory
must be writable by the webserver. If your webserver is running as
the user "nobody" you can fix this by running:
$ chown -R nobody data
$ chgrp -R nobody data
Keep in mind that with different installations, the web server could
typically run as userid/groupid of nobody/nobody, nobody/nogroup,
apache/apache or www-data/www-data. The best way to find out is to read
the web server's configuration file.
There also needs to be a directory where attachments are stored
before they are sent. Since personal mail is stored in this
directory you might want to be a bit careful about how you set it
up. It should be owned by another user than the webserver is running
as (root might be a good choice) and the webserver should have write
and execute permissions on the directory, but should not have read
permissions. You could do this by running these commands (still
granted that the webserver is running as nobody/nobody)
$ cd /var/some/place
$ mkdir SomeDirectory
$ chgrp -R nobody SomeDirectory
$ chmod 730 SomeDirectory
If you trust all the users on you system not to read mail they are
not supposed to read change the last line to chmod 777 SomeDirectory
or simply use /tmp as you attachments directory.
If a user is aborting a mail but has uploaded some attachments to it
the files will be lying around in this directory forever if you do not
remove them. To fix this, it is recommended to create a cron job that
deletes everything in the attachment directory. Something similar
to the following will be good enough:
$ cd /var/attach/directory
$ rm -f *
However, this will delete attachments that are currently in use by people
sending email when the cron job runs. You can either (1) make sure that
the cron job runs at an obscure hour and hope that nobody gets upset, or
(2) you can run a modified version of the commands above. Check out the
man pages for other commands such as 'find' or 'tmpreaper'.
One sample script you could set up that would erase all attachments, but
wouldn't erase preferences, address books, or the like (just in case your
attachment directory is the same as your data directory) might look like
this:
$ rm `find /var/attach/directory -atime +2 | grep -v "\." | grep -v _`
Remember to be careful with whatever method you do use, and to test out
the command before it potentially wipes out everyone's preferences.
c. Setting up SquirrelMail
There are three ways to configure SquirrelMail. In the config/ directory,
there is a perl script called conf.pl that will aid you in the
configuration process. This is the recommended way of handling
the config.
There's also a plugin called 'administrator' for the webinterface but you'll
have to be able to at least log in to SquirrelMail first.
You can also copy the config/config_default.php file to config/config.php
and edit that manually.
After you've created a configuration, you can use your webbrowser to
browse to http://your-squirrelmail-location/src/configtest.php.
This will perform some basic checks on your config to make sure
everything works like it should.
4. RUNNING SQUIRRELMAIL
-----------------------
Point your browser at the URL at which SquirrelMail is installed. A
possible example of this is:
http://www.example.com/squirrelmail
It should be pretty straight forward to use. Some more documentation
might show up one day or another.
5. RUSSIAN CHARSETS
-------------------
For information on how to make SquirrelMail work with Russian
Apache, see the README.russian_apache in the doc/ subdirectory.
6. TRANSLATIONS
---------------
In order to use translated versions of SquirrelMail, you need
to download and install locale packages that contain translations
that you want to use with SquirrelMail.
Locale packages can be downloaded from SquirrelMail SourceForge
project page.
http://sourceforge.net/project/showfiles.php?group_id=311&package_id=110388
Each translation contains an install script that copies the required files
into their appropriate locations. If you can't run that script, you can extract
the contents of a translation package into your SquirrelMail directory.
NOTE No.1: *-src.tar.gz, *-src.tar.bz2 and *-src.zip archives do not contain
compiled translation files. You will need to run the `compilelocales` script
in order to get all gettext binary translations.
NOTE No.2: You might need to restart your webserver before using translations.
If you can't do that, install your translations _before_ you use SquirrelMail.
|