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