Changed regexps
[squirrelmail.git] / UPGRADE
1 Upgrading from 0.3 or higher 
2 ============================
3
4 If you are upgrading from versions 0.3 or higher of SquirrelMail, you can
5 use this guide to make the transition a bit smoother.  If you have been
6 using a previous version (0.1 or 0.2), it is suggested that you just start
7 from scratch and configure your settings as if it was your first install.
8
9 NOTE: The new plugin architecture required the use of some functions which
10 are not in all versions of PHP4. You will need at least PHP4 beta2. If you
11 need to upgrade please go ahead and install the latest release version of
12 PHP4.
13
14 1.  Backups
15 ===========
16
17 Make a backup of your current SquirrelMail directory.  If you use "cp", be
18 sure to use the "-Rp" options.  -R means recursive, and -p will save the
19 permissions in the directory.  In this example, we assume that your httpd
20 document directory is /home/httpd/html.
21
22   $ cd /home/httpd/html
23   $ cp -Rp squirrelmail-0.4 squirrelmail-0.4.bak
24
25
26 2.  Unarchives Squirrelmail-0.5.tar.gz
27 ======================================
28 Make sure that you're in your httpd document directory (/home/httpd/html)
29 and then unarchive the squirrelmail archive (whatever the filename is): 
30
31   $ tar -zxvf squirrelmail-0.5.tar.gz
32
33
34 3.  Copy backups in place
35 =========================
36 Here is the main part.  There are two parts to this step: copy preferences,
37 and copy config details.  The preference files are backwards compatible, so
38 it is fine to copy the old user preferences into the new directory.
39 However, the configuration file has changed quite a bit, so you will want to
40 be sure to run the configure script (conf.pl) to set up any new config
41 details.
42
43 First, copy the files in place:
44   
45   $ cp squirrelmail-0.4.bak/data/* squirrelmail-0.5/data
46   $ cp squirrelmail-0.4.bak/config/config.php squirrelmail-0.5/config
47
48 Note that if at all possible, start the configuration process from scratch.
49 It is less prone to missing configuration options than copying your old
50 configuration.  The ideal solution would be to copy your users' preference
51 files, and then run conf.pl to re-configure SquirrelMail (without using the
52 old config file).  If you do copy the config.php file, you will want to run
53 conf.pl and check for new options.
54
55
56 4.  Change permissions
57 ======================
58 The web server must have write permission to the data directory.  In this
59 example, we assume that user "nobody" and group "nobody" are the web server
60 as is often the case with Apache.
61
62   $ cd squirrelmail-0.5
63   $ chown -R nobody.nobody data
64
65
66 5.  DONE!
67 =========
68 That should be all!  The most important part is copying your users'
69 preference files back into the new data directory.  This will insure that
70 your users will have their old preferences.