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