* Updated docs to tell the user to read any documentation that came with the
[squirrelmail.git] / UPGRADE
CommitLineData
47f9c368 1Upgrading from 0.3 or higher
2============================
3
4If you are upgrading from versions 0.3 or higher of SquirrelMail, you can
5use this guide to make the transition a bit smoother. If you have been
6using a previous version (0.1 or 0.2), it is suggested that you just start
7from scratch and configure your settings as if it was your first install.
f4057b81 8
2b996daf 9NOTE: The new plugin architecture required the use of some functions which
10are not in all versions of PHP4. You will need at least PHP4 beta2. If you
11need to upgrade please go ahead and install the latest release version of
12PHP4.
f4057b81 13
8462c882 14
151. Backup old install
16======================
2b996daf 17
18Make a backup of your current SquirrelMail directory. If you use "cp", be
19sure to use the "-Rp" options. -R means recursive, and -p will save the
8462c882 20permissions in the directory.
21
22In this example, we assume that your httpd document directory is
23/home/httpd/html, that your SquirrelMail install is located at
24/home/httpd/html/squirrelmail-0.4, and that your new SM version is 0.5.
25Substitute version numbers and names as required.
f4057b81 26
27 $ cd /home/httpd/html
28 $ cp -Rp squirrelmail-0.4 squirrelmail-0.4.bak
29
30
8462c882 312. Unarchive new SquirrelMail
32==============================
33Make sure that you are in your httpd document directory (/home/httpd/html)
34and then unarchive the SquirrelMail archive (whatever the filename is):
2b996daf 35
f4057b81 36 $ tar -zxvf squirrelmail-0.5.tar.gz
37
38
8462c882 393. Copy important files from old install
40=========================================
41The important files to copy are:
42 A. Preferences
43 B. Config details
44 C. Plugins
45 D. Themes (if you've edited or added any of them)
46
47A. Preferences
f4057b81 48
8462c882 49First, copy your preference data over to the new directory. Usually this is
50ok, but if you are upgrading from to 1.0.5 or later from anything less than
511.0.5, we strongly suggest you let your users reset their preferences.
52There were important security upgrades in 1.0.5 regarding preference files.
f4057b81 53
54 $ cp squirrelmail-0.4.bak/data/* squirrelmail-0.5/data
8462c882 55
56B. Config details
57
58If at all possible, start the configuration process from scratch. It is
59much less prone to missing configuration options than copying your old
60configuration. Ideally, you should just run conf.pl to reconfigure
61SquirrelMail. If you decide to copy your old config.php over, we strongly
62recommend that you run conf.pl to make sure things are correct and then save
63the config file.
64
f4057b81 65 $ cp squirrelmail-0.4.bak/config/config.php squirrelmail-0.5/config
66
8462c882 67C. Copy plugins
68
69Like SquirrelMail, plugins are fequently updated for improvements, as well
70as to make them compatible with new SquirrelMail releases. It is suggested
71that you download a new plugins archive at the same time you download your
72SquirrelMail install, and that you install your plugins fresh (it's easy,
73don't panic!).
74
75If you prefer to just copy your old plugins over (if it's the same version
76or if you are lazy), you may do so. If you notice irregularities with the
77plugins under the new SquirrelMail, try installing new versions of the
78plugins.
79
80 $ cp -Rp squirrelmail-0.4.bak/plugins/* squirrelmail-0.5/plugins
81
82D. Copy themes
83
84If you've created or modified themes, you should copy just those to the new
85SquirrelMail themes direcory. To just copy them all over to the new
86SquirrelMail installation, you can run one command.
87
88 $ cp squirrelmail-0.4.bak/themes/* squirrelmail-0.5/themes/
89
90(While you are at it, you should send them to us! We might add them to the
91themes in the standard install!)
f4057b81 92
93
944. Change permissions
95======================
96The web server must have write permission to the data directory. In this
97example, we assume that user "nobody" and group "nobody" are the web server
98as is often the case with Apache.
99
100 $ cd squirrelmail-0.5
101 $ chown -R nobody.nobody data
8462c882 102
103See INSTALL for alternate userid/groupid pairs. Additionally, if "chown
104user.group" doesn't work, you can use "chown user" and "chgrp group"
105instead. See the man pages for these commands for more information.
106
107
1085. Run conf.pl
109===============
110Run config/conf.pl to see the new configuration options available with the
111new version, as well as to verify that all of your old options are set
112properly.
f4057b81 113
114
8462c882 1156. DONE!
f4057b81 116=========
2b996daf 117That should be all! The most important part is copying your users'
118preference files back into the new data directory. This will insure that
8462c882 119your users will have their old preferences. Remember to do so with caution,
120especially if you are upgrading from a version before 1.0.5 to version 1.0.5
121or later.