centralizing password reading and saving functions.
[squirrelmail.git] / INSTALL
CommitLineData
d68a3926 1Installing SquirrelMail
2=======================
3
3b3d853f 4Table of Contents:
46f33521 5 0. (QUICK!) Quick install guide
238d4cfc 6 1. (PHP) Configure your webserver to work with PHP
3b3d853f 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
14
46f33521 150. QUICK INSTALL GUIDE
16----------------------
17cec454 17
46f33521 18Each of these steps is covered in detail below.
17cec454 19
238d4cfc 20- Install webserver and PHP (at least 4.1.0).
46f33521 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/conf.pl 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 http://www.example.com/yourwebmaillocation/src/configtest.php
32 to test your configuration for common errors.
33- Browse to http://www.example.com/yourwebmaillocation/ to log in.
2a32fc83 34
1067414d 35
238d4cfc 361. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP
37--------------------------------------------
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
238d4cfc 41 the standard suffix .php for all PHP files.
598294a7 42
46f33521 43 You can find PHP at http://www.php.net. 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
bee552c7 51
0dc92cda 52 --with-pear and --with-mysql
bee552c7 53 For MySQL storage of preferences or addressbooks. You will need PHP
1131d10f 54 compiled with --with-pgsql option, if you want to use PostgreSQL instead
bee552c7 55 of MySQL. You will need PHP with appropriate database extension, if you
1131d10f 56 want to use any other database.
0dc92cda 57
58 --with-openssl
59 Required for encrypted IMAP or SMTP connections (TLS)
60
61 --with-mcrypt
62 Can be used by SquirrelSpell plugin for encryption of personal
63 dictionaries
64
65 --with-iconv or --with-recode
66 Can be used by Eastern charset decoding functions
67
68 --enable-mbstring
bee552c7 69 Required for Japanese translation. Optional for translations that
0dc92cda 70 use non-ISO-8859-1 charset
17cec454 71
46f33521 72 If you want your users to attach files to their mails, make sure
73 File Uploads in php.ini is set to On.
17cec454 74
17cec454 75
762. SETTING UP IMAP
77------------------
78
46f33521 79 This depends a lot on the server your choose. See the documentation
80 that comes with your server.
598294a7 81
46f33521 82 If you're concerned about people accessing it directly, you can
83 limit access to only the IP of the webserver.
84
17cec454 85
863. OBTAINING AND INSTALLING SQUIRRELMAIL
87----------------------------------------
88
ef1932a4 89 SquirrelMail is constantly being improved. Therefore you should always
46f33521 90 get the newest version around. Look at http://www.squirrelmail.org
ef1932a4 91 to see what it is. If you want to be bleeding edge you might want to
92 consider using the latest CVS version (with the latest and most
46f33521 93 fashionable bugs).
17cec454 94
95a. Download SquirrelMail
96
97 Get SquirrelMail from the address above if you do not have it or are
98 uncertain if you have the newest version. Untar (again tar xvfz
99 filename.tgz) SquirrelMail in a directory that is readable for your
100 webserver.
101
102b. Setting up directories
103
104 SquirrelMail uses two directories to store user configuration and
105 attachments that are about to be sent. You might want to have these
106 directories outside of your web tree.
107
108 The data directory is used for storing user preferences, like
368ab966 109 signature, name and theme. You need to create this directory yourself.
110 Recommended location is under /var, for example:
111 /var/local/squirrelmail/data
112 This directory must be writable by the webserver. If your webserver is
113 running as the user "nobody" and group "nobody" you can fix this by
114 running:
65b14f90 115
368ab966 116 $ chown -R nobody:nobody /path/to/your/datadir
4bc627ae 117
118 Keep in mind that with different installations, the web server could
598294a7 119 typically run as userid/groupid of nobody/nobody, nobody/nogroup,
120 apache/apache or www-data/www-data. The best way to find out is to read
ff65039a 121 the web server's configuration file.
4bc627ae 122
17cec454 123 There also needs to be a directory where attachments are stored
124 before they are sent. Since personal mail is stored in this
125 directory you might want to be a bit careful about how you set it
126 up. It should be owned by another user than the webserver is running
127 as (root might be a good choice) and the webserver should have write
128 and execute permissions on the directory, but should not have read
129 permissions. You could do this by running these commands (still
130 granted that the webserver is running as nobody/nobody)
131
390372b4 132 $ cd /var/some/place
133 $ mkdir SomeDirectory
134 $ chgrp -R nobody SomeDirectory
135 $ chmod 730 SomeDirectory
17cec454 136
137 If you trust all the users on you system not to read mail they are
368ab966 138 not supposed to read, you can simply use /tmp as you attachments
139 directory.
598294a7 140
141 If a user is aborting a mail but has uploaded some attachments to it
142 the files will be lying around in this directory forever if you do not
390372b4 143 remove them. To fix this, it is recommended to create a cron job that
144 deletes everything in the attachment directory. Something similar
4bc627ae 145 to the following will be good enough:
390372b4 146
368ab966 147 $ cd /var/local/squirrelmail/attach
390372b4 148 $ rm -f *
598294a7 149
4bc627ae 150 However, this will delete attachments that are currently in use by people
151 sending email when the cron job runs. You can either (1) make sure that
152 the cron job runs at an obscure hour and hope that nobody gets upset, or
153 (2) you can run a modified version of the commands above. Check out the
154 man pages for other commands such as 'find' or 'tmpreaper'.
598294a7 155
4bc627ae 156 One sample script you could set up that would erase all attachments, but
157 wouldn't erase preferences, address books, or the like (just in case your
598294a7 158 attachment directory is the same as your data directory) might look like
4bc627ae 159 this:
598294a7 160
368ab966 161 $ rm `find /var/local/squirrelmail/attach -atime +2 | grep -v "\." | grep -v _`
598294a7 162
4bc627ae 163 Remember to be careful with whatever method you do use, and to test out
164 the command before it potentially wipes out everyone's preferences.
17cec454 165
166c. Setting up SquirrelMail
167
86bb50f8 168 There are three ways to configure SquirrelMail. In the config/ directory,
be8e07f8 169 there is a perl script called conf.pl that will aid you in the
390372b4 170 configuration process. This is the recommended way of handling
be8e07f8 171 the config.
172
86bb50f8 173 There's also a plugin called 'administrator' for the webinterface but you'll
174 have to be able to at least log in to SquirrelMail first.
175
390372b4 176 You can also copy the config/config_default.php file to config/config.php
be8e07f8 177 and edit that manually.
65b14f90 178
cbd6543c 179 After you've created a configuration, you can use your webbrowser to
13721b47 180 browse to http://your-squirrelmail-location/src/configtest.php.
cbd6543c 181 This will perform some basic checks on your config to make sure
182 everything works like it should.
183
184
17cec454 1854. RUNNING SQUIRRELMAIL
186-----------------------
65b14f90 187
429f8906 188 Point your browser at the URL at which SquirrelMail is installed. A
598294a7 189 possible example of this is:
bee552c7 190 http://www.example.com/squirrelmail
598294a7 191
3d8fe250 192 It should be pretty straight forward to use. Some more documentation
429f8906 193 might show up one day or another.
8c086db6 194
195
1965. RUSSIAN CHARSETS
197-------------------
198
199 For information on how to make SquirrelMail work with Russian
77180a75 200 Apache, see the russian_apache.txt in the doc/ subdirectory.
2481e3c1 201
46f33521 202
2481e3c1 2036. TRANSLATIONS
204---------------
205
598294a7 206 In order to use translated versions of SquirrelMail, you need
2481e3c1 207 to download and install locale packages that contain translations
598294a7 208 that you want to use with SquirrelMail.
209
2481e3c1 210 Locale packages can be downloaded from SquirrelMail SourceForge
211 project page.
598294a7 212
bee552c7 213 http://sourceforge.net/project/showfiles.php?group_id=311&package_id=110388
598294a7 214
512d4b31 215 Each translation contains an install script that copies the required files
216 into their appropriate locations. If you can't run that script, you can
86bb50f8 217 extract the contents of a translation package into your SquirrelMail
512d4b31 218 directory.
598294a7 219
512d4b31 220 NOTE No.1: *-src.tar.gz, *-src.tar.bz2 and *-src.zip archives do not contain
86bb50f8 221 compiled translation files. You will need to run the "compilelocales" script
2481e3c1 222 in order to get all gettext binary translations.
598294a7 223
2481e3c1 224 NOTE No.2: You might need to restart your webserver before using translations.
225 If you can't do that, install your translations _before_ you use SquirrelMail.
c650b678 226
bee552c7 227
c650b678 2287. PLUGINS
229----------
230
bee552c7 231 The SquirrelMail package includes some standard plugins. These plugins can be
512d4b31 232 enabled in the SquirrelMail configuration script.
c650b678 233
234 Included plugins can use additional configuration files:
235 * change_password
236 configuration file is required. Without it plugin defaults to invalid
237 backend. See plugins/change_password/README
238 * filters, fortune, mail_fetch, newmail, translate
239 configuration files are optional. See README files in plugin directories.
240 * squirrelspell
241 configuration is stored in plugins/squirrelspell/sqspell_config.php
242 Default configuration might not work on your server.
243 * administrator
bee552c7 244 plugin must be setup correctly in order to detect administrative user.
c650b678 245 See plugins/administrator/INSTALL