X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=INSTALL;h=612eeb98dd3d7cc30af30ea9a9bb5b8285fcf031;hp=9f5bfb23e599a028363f293d4b284d61b41e5baf;hb=46489d06566e040f4852385cc6862f65009dfe97;hpb=77180a756d97ef3a08d1029eccb8e8ec9e780a35 diff --git a/INSTALL b/INSTALL index 9f5bfb23..612eeb98 100644 --- a/INSTALL +++ b/INSTALL @@ -3,7 +3,7 @@ Installing SquirrelMail Table of Contents: 0. (QUICK!) Quick install guide - 1. (PHP4) Configure your webserver to work with PHP4 + 1. (PHP) Configure your webserver to work with PHP 2. (IMAP) Setting up IMAP (not covered) 3. (INSTALL) Obtaining and installing SquirrelMail 4. (RUN) Running SquirrelMail @@ -17,7 +17,7 @@ Table of Contents: Each of these steps is covered in detail below. -- Install webserver and PHP4 (at least 4.1.0). +- Install webserver and PHP (at least 4.1.0). - 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). @@ -33,12 +33,12 @@ Each of these steps is covered in detail below. - Browse to http://www.example.com/yourwebmaillocation/ to log in. -1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP4 ---------------------------------------------- +1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP +-------------------------------------------- If your webserver does not already have PHP you must configure it to work with PHP. You need at least PHP v4.1.0. SquirrelMail uses - the standard suffix .php for all PHP4 files. + the standard suffix .php for all PHP files. You can find PHP at http://www.php.net. See the documentation that comes with PHP for instructions how to set it up. @@ -46,15 +46,33 @@ Each of these steps is covered in detail below. The PHP IMAP extension is NOT necessary 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) + --with-ldap + Required for LDAP addressbooks - 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. + --with-pear and --with-mysql + For MySQL storage of preferences or addressbooks. You will need PHP + compiled with --with-pgsql option, if you want to use PostgreSQL instead + of MySQL. You will need PHP with appropriate database extension, if you + want to use any other database. + --with-openssl + Required for encrypted IMAP or SMTP connections (TLS) + + --with-mcrypt + Can be used by SquirrelSpell plugin for encryption of personal + dictionaries + + --with-iconv or --with-recode + Can be used by Eastern charset decoding functions + + --enable-mbstring + Required for Japanese translation. Optional for translations that + use non-ISO-8859-1 charset + + It is highly advised to NOT turn on register_globals, as this can lead + to security holes. If you must use register_globals for some applications, + turn it on locally for only those directories, or turn it off for the + SquirrelMail folder. If you want your users to attach files to their mails, make sure File Uploads in php.ini is set to On. @@ -75,7 +93,7 @@ Each of these steps is covered in detail below. 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 + consider using the latest SVN version (with the latest and most fashionable bugs). a. Download SquirrelMail @@ -92,13 +110,14 @@ b. Setting up directories 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: + signature, name and theme. You need to create this directory yourself. + Recommended location is under /var, for example: + /var/local/squirrelmail/data + This directory must be writable by the webserver. If your webserver is + running as the user "nobody" and group "nobody" you can fix this by + running: - $ chown -R nobody data - $ chgrp -R nobody data + $ chown -R nobody:nobody /var/local/squirrelmail/data Keep in mind that with different installations, the web server could typically run as userid/groupid of nobody/nobody, nobody/nogroup, @@ -109,19 +128,19 @@ b. Setting up directories 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 + as (root might be a good choice) and the webserver should have directory + write and execute permissions, but should not have read permissions. You could do this by running these commands (still - granted that the webserver is running as nobody/nobody) + granted that the webserver is running as nobody/nobody): - $ cd /var/some/place - $ mkdir SomeDirectory - $ chgrp -R nobody SomeDirectory - $ chmod 730 SomeDirectory + $ cd /var/local/squirrelmail/ + $ mkdir attach + $ chgrp -R nobody attach + $ chmod 730 attach - 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 you trust all the users at your system not to read mail they are + not supposed to read, you can 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 @@ -129,7 +148,7 @@ b. Setting up directories deletes everything in the attachment directory. Something similar to the following will be good enough: - $ cd /var/attach/directory + $ cd /var/local/squirrelmail/attach $ rm -f * However, this will delete attachments that are currently in use by people @@ -143,24 +162,27 @@ b. Setting up directories attachment directory is the same as your data directory) might look like this: - $ rm `find /var/attach/directory -atime +2 | grep -v "\." | grep -v _` + $ rm `find /var/local/squirrelmail/attach -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 two ways to configure SquirrelMail. In the config/ directory, + 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 + This will perform some basic checks on your configuration to make sure everything works like it should. @@ -169,7 +191,7 @@ c. Setting up SquirrelMail Point your browser at the URL at which SquirrelMail is installed. A possible example of this is: - http://www.yourdomain.com/squirrelmail + http://www.example.com/squirrelmail It should be pretty straight forward to use. Some more documentation might show up one day or another. @@ -192,24 +214,25 @@ c. Setting up SquirrelMail Locale packages can be downloaded from SquirrelMail SourceForge project page. - http://sourceforge.net/project/showfiles.php?group_id=311&package_id=110388 + 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 translation packages into your SquirrelMail + 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 + 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. + 7. PLUGINS ---------- - The SquirrelMail package includes some standard plugins. These plugins can be + The SquirrelMail package includes some standard plugins. These plugins can be enabled in the SquirrelMail configuration script. Included plugins can use additional configuration files: @@ -220,7 +243,7 @@ c. Setting up SquirrelMail configuration files are optional. See README files in plugin directories. * squirrelspell configuration is stored in plugins/squirrelspell/sqspell_config.php - Default configuration might not work on your server. + The default configuration might not work at your server. * administrator - plugin must be setup correctly in order to detect administrative user. + plugin must be setup correctly in order to detect administrative user. See plugins/administrator/INSTALL