todo about caching

[squirrelmail.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 84d3a794157b7499982a80d3478748597aa607db..9f5bfb23e599a028363f293d4b284d61b41e5baf 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -9,6 +9,7 @@ Table of Contents:
   4.  (RUN)      Running SquirrelMail
   5.  (CHARSETS) Russian Charsets
   6.  (LOCALES)  Translations of SquirrelMail
+  7.  (PLUGINS)  Installation of included plugins
 
 
 0. QUICK INSTALL GUIDE
@@ -21,7 +22,7 @@ Each of these steps is covered in detail below.
 - 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
+  runs as (e.g. 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
@@ -42,7 +43,7 @@ Each of these steps is covered in detail below.
   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)!
+  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
@@ -178,7 +179,7 @@ c. Setting up SquirrelMail
 -------------------
 
   For information on how to make SquirrelMail work with Russian
-  Apache, see the README.russian_apache in the doc/ subdirectory.
+  Apache, see the russian_apache.txt in the doc/ subdirectory.
 
 
 6. TRANSLATIONS
@@ -193,13 +194,33 @@ c. Setting up SquirrelMail
 
   http://sourceforge.net/project/showfiles.php?group_id=311&package_id=110388
 
-  Each translation contains install script that copies required files
-  into appropriate locations. If you can't run that script, you can extract
-  contents of translation packages into your SquirrelMail directory.
+  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
+  directory.
 
-  NOTE No.1: *-src.tar.gz, *-src.tar.bz2 and *-src.zip archives does not contain
-  compiled translation files. You will need to run compilelocales script
+  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.
+
+7. PLUGINS
+----------
+
+  The SquirrelMail package includes some standard plugins. These plugins can be 
+  enabled in the SquirrelMail configuration script.
+
+  Included plugins can use additional configuration files:
+  * change_password
+    configuration file is required. Without it plugin defaults to invalid
+    backend. See plugins/change_password/README
+  * filters, fortune, mail_fetch, newmail, translate
+    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.
+  * administrator
+    plugin must be setup correctly in order to detect administrative user. 
+    See plugins/administrator/INSTALL