mhash is used for string hashing. crypto functions unrelated to charsets.
[squirrelmail.git] / INSTALL
d68a3926 1Installing SquirrelMail
3b3d853f 4Table of Contents:
46f33521 5 0. (QUICK!) Quick install guide
3b3d853f 6 1. (PHP4) Configure your webserver to work with PHP4
7 2. (IMAP) Setting up IMAP (not covered)
8 3. (INSTALL) Obtaining and installing SquirrelMail
9 4. (RUN) Running SquirrelMail
10 5. (CHARSETS) Russian Charsets
46f33521 11 6. (LOCALES) Translations of SquirrelMail
c650b678 12 7. (PLUGINS) Installation of included plugins
3b3d853f 13
17cec454 17
46f33521 18Each of these steps is covered in detail below.
17cec454 19
46f33521 20- Install webserver and PHP4 (at least 4.1.0).
21- Install IMAP server (see docs of that server).
22- Unpack the SquirrelMail package in a web-accessible location.
23- Select a data-dir and attachment dir, outside the webtree (e.g. in /var).
24 The data-dir (for user prefs) should be owned by the user the webserver
512d4b31 25 runs as (e.g. www-data). The attachment dir (for uploading files as
46f33521 26 attachments) should be file mode 0730 and in the same group as the
27 webserver.
28- Run config/ from the command line. Use the D option to load
29 predefined options for specific IMAP servers, and edit at least the
30 Server Settings and General Options (datadir).
31- Browse to
32 to test your configuration for common errors.
33- Browse to to log in.
2a32fc83 34
1067414d 35
17cec454 38
46f33521 39 If your webserver does not already have PHP you must configure it
40 to work with PHP. You need at least PHP v4.1.0. SquirrelMail uses
41 the standard suffix .php for all PHP4 files.
598294a7 42
46f33521 43 You can find PHP at See the documentation that
44 comes with PHP for instructions how to set it up.
17cec454 45
512d4b31 46 The PHP IMAP extension is NOT necessary at all (but won't harm)!
46f33521 47 Below is a list of optional PHP extensions:
17cec454 48
0dc92cda 49 --with-ldap
50 Required for LDAP addressbooks
52 --with-pear and --with-mysql
53 For MySQL storage of preferences or addressbooks
55 --with-openssl
56 Required for encrypted IMAP or SMTP connections (TLS)
58 --with-mcrypt
59 Can be used by SquirrelSpell plugin for encryption of personal
60 dictionaries
62 --with-iconv or --with-recode
63 Can be used by Eastern charset decoding functions
65 --enable-mbstring
66 Required for Japanese translation. Optional for translations that
67 use non-ISO-8859-1 charset
17cec454 68
46f33521 69 If you want your users to attach files to their mails, make sure
70 File Uploads in php.ini is set to On.
17cec454 71
17cec454 72
46f33521 76 This depends a lot on the server your choose. See the documentation
77 that comes with your server.
598294a7 78
46f33521 79 If you're concerned about people accessing it directly, you can
80 limit access to only the IP of the webserver.
17cec454 82
ef1932a4 86 SquirrelMail is constantly being improved. Therefore you should always
46f33521 87 get the newest version around. Look at
ef1932a4 88 to see what it is. If you want to be bleeding edge you might want to
89 consider using the latest CVS version (with the latest and most
46f33521 90 fashionable bugs).
17cec454 91
92a. Download SquirrelMail
94 Get SquirrelMail from the address above if you do not have it or are
95 uncertain if you have the newest version. Untar (again tar xvfz
96 filename.tgz) SquirrelMail in a directory that is readable for your
97 webserver.
99b. Setting up directories
101 SquirrelMail uses two directories to store user configuration and
102 attachments that are about to be sent. You might want to have these
103 directories outside of your web tree.
105 The data directory is used for storing user preferences, like
106 signature, name and theme. When unpacking the sources this directory
b731cd83 107 is created as data/ in your SquirrelMail directory. This directory
17cec454 108 must be writable by the webserver. If your webserver is running as
b731cd83 109 the user "nobody" you can fix this by running:
65b14f90 110
390372b4 111 $ chown -R nobody data
112 $ chgrp -R nobody data
4bc627ae 113
114 Keep in mind that with different installations, the web server could
598294a7 115 typically run as userid/groupid of nobody/nobody, nobody/nogroup,
116 apache/apache or www-data/www-data. The best way to find out is to read
ff65039a 117 the web server's configuration file.
4bc627ae 118
17cec454 119 There also needs to be a directory where attachments are stored
120 before they are sent. Since personal mail is stored in this
121 directory you might want to be a bit careful about how you set it
122 up. It should be owned by another user than the webserver is running
123 as (root might be a good choice) and the webserver should have write
124 and execute permissions on the directory, but should not have read
125 permissions. You could do this by running these commands (still
126 granted that the webserver is running as nobody/nobody)
390372b4 128 $ cd /var/some/place
129 $ mkdir SomeDirectory
130 $ chgrp -R nobody SomeDirectory
131 $ chmod 730 SomeDirectory
17cec454 132
133 If you trust all the users on you system not to read mail they are
134 not supposed to read change the last line to chmod 777 SomeDirectory
598294a7 135 or simply use /tmp as you attachments directory.
137 If a user is aborting a mail but has uploaded some attachments to it
138 the files will be lying around in this directory forever if you do not
390372b4 139 remove them. To fix this, it is recommended to create a cron job that
140 deletes everything in the attachment directory. Something similar
4bc627ae 141 to the following will be good enough:
390372b4 142
143 $ cd /var/attach/directory
144 $ rm -f *
598294a7 145
4bc627ae 146 However, this will delete attachments that are currently in use by people
147 sending email when the cron job runs. You can either (1) make sure that
148 the cron job runs at an obscure hour and hope that nobody gets upset, or
149 (2) you can run a modified version of the commands above. Check out the
150 man pages for other commands such as 'find' or 'tmpreaper'.
598294a7 151
4bc627ae 152 One sample script you could set up that would erase all attachments, but
153 wouldn't erase preferences, address books, or the like (just in case your
598294a7 154 attachment directory is the same as your data directory) might look like
4bc627ae 155 this:
598294a7 156
4bc627ae 157 $ rm `find /var/attach/directory -atime +2 | grep -v "\." | grep -v _`
598294a7 158
4bc627ae 159 Remember to be careful with whatever method you do use, and to test out
160 the command before it potentially wipes out everyone's preferences.
17cec454 161
162c. Setting up SquirrelMail
cbd6543c 164 There are two ways to configure SquirrelMail. In the config/ directory,
be8e07f8 165 there is a perl script called that will aid you in the
390372b4 166 configuration process. This is the recommended way of handling
be8e07f8 167 the config.
390372b4 169 You can also copy the config/config_default.php file to config/config.php
be8e07f8 170 and edit that manually.
65b14f90 171
cbd6543c 172 After you've created a configuration, you can use your webbrowser to
13721b47 173 browse to http://your-squirrelmail-location/src/configtest.php.
cbd6543c 174 This will perform some basic checks on your config to make sure
175 everything works like it should.
65b14f90 180
429f8906 181 Point your browser at the URL at which SquirrelMail is installed. A
598294a7 182 possible example of this is:
429f8906 183
598294a7 184
3d8fe250 185 It should be pretty straight forward to use. Some more documentation
429f8906 186 might show up one day or another.
8c086db6 187
192 For information on how to make SquirrelMail work with Russian
77180a75 193 Apache, see the russian_apache.txt in the doc/ subdirectory.
2481e3c1 194
46f33521 195
2481e3c1 1966. TRANSLATIONS
598294a7 199 In order to use translated versions of SquirrelMail, you need
2481e3c1 200 to download and install locale packages that contain translations
598294a7 201 that you want to use with SquirrelMail.
2481e3c1 203 Locale packages can be downloaded from SquirrelMail SourceForge
204 project page.
598294a7 205
2481e3c1 206
598294a7 207
512d4b31 208 Each translation contains an install script that copies the required files
209 into their appropriate locations. If you can't run that script, you can
210 extract the contents of translation packages into your SquirrelMail
211 directory.
598294a7 212
512d4b31 213 NOTE No.1: *-src.tar.gz, *-src.tar.bz2 and * archives do not contain
214 compiled translation files. You will need to run the compilelocales script
2481e3c1 215 in order to get all gettext binary translations.
598294a7 216
2481e3c1 217 NOTE No.2: You might need to restart your webserver before using translations.
218 If you can't do that, install your translations _before_ you use SquirrelMail.
c650b678 219
512d4b31 223 The SquirrelMail package includes some standard plugins. These plugins can be
224 enabled in the SquirrelMail configuration script.
c650b678 225
226 Included plugins can use additional configuration files:
227 * change_password
228 configuration file is required. Without it plugin defaults to invalid
229 backend. See plugins/change_password/README
230 * filters, fortune, mail_fetch, newmail, translate
231 configuration files are optional. See README files in plugin directories.
232 * squirrelspell
233 configuration is stored in plugins/squirrelspell/sqspell_config.php
234 Default configuration might not work on your server.
235 * administrator
236 plugin must be setup correctly in order to detect administrative user.
237 See plugins/administrator/INSTALL