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