Skip .svn dir. Leaving CVS dir in case it is left over in some people's downloaded...
[squirrelmail.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index e2d08e0fa057c6ce1ee593793b6b2b00aab28ee9..d618837651a0bf749f78b6e1f2da307d2bbe8494 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -28,9 +28,9 @@ Each of these steps is covered in detail below.
 - 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
+- Browse to http://example.com/yourwebmaillocation/src/configtest.php
   to test your configuration for common errors.
-- Browse to http://www.example.com/yourwebmaillocation/ to log in.
+- Browse to http://example.com/yourwebmaillocation/ to log in.
 
 
 1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP
@@ -40,7 +40,7 @@ Each of these steps is covered in detail below.
   to work with PHP. You need at least PHP v4.1.0. SquirrelMail uses
   the standard suffix .php for all PHP files.
 
-  You can find PHP at http://www.php.net. See the documentation that
+  You can find PHP at http://php.net. See the documentation that
   comes with PHP for instructions how to set it up.
 
   The PHP IMAP extension is NOT necessary at all (but won't harm)!
@@ -69,6 +69,10 @@ Each of these steps is covered in detail below.
     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.
 
@@ -87,9 +91,9 @@ 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
+  get the newest version around. Look at http://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
@@ -113,7 +117,7 @@ b. Setting up directories
   running as the user "nobody" and group "nobody" you can fix this by
   running:
 
-    $ chown -R nobody:nobody /path/to/your/datadir
+    $ 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,
@@ -124,17 +128,17 @@ 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
+  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.
 
@@ -165,17 +169,20 @@ b. Setting up directories
 
 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.
 
 
@@ -184,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.example.com/squirrelmail
+     http://example.com/squirrelmail
 
   It should be pretty straight forward to use. Some more documentation
   might show up one day or another.
@@ -211,11 +218,11 @@ c. Setting up SquirrelMail
 
   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.
@@ -236,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.
     See plugins/administrator/INSTALL