2.7. Upgrading to New Releases

2.7.1. Before You Upgrade

Before you start your upgrade, there are a few important steps to take:

1. Read the Release Notes of the version you're upgrading to, particularly the "Notes for Upgraders" section.

2. View the Sanity Check (Section 3.15) page on your installation before upgrading. Attempt to fix all warnings that the page produces before you go any further, or you may experience problems during your upgrade.

3. Shut down your Bugzilla installation by putting some HTML or text in the shutdownhtml parameter (see Section 3.1).

4. Make a backup of the Bugzilla database. THIS IS VERY IMPORTANT. If anything goes wrong during the upgrade, your installation can be corrupted beyond recovery. Having a backup keeps you safe.

   Upgrading is a one-way process. You cannot "downgrade" an upgraded Bugzilla. If you wish to revert to the old Bugzilla version for any reason, you will have to restore your database from this backup.

   Here are some sample commands you could use to backup your database, depending on what database system you're using. You may have to modify these commands for your particular setup.

   MySQL:

   mysqldump --opt -u bugs -p bugs > bugs.sql

   PostgreSQL:

   pg_dump --no-privileges --no-owner -h localhost -U bugs > bugs.sql

2.7.2. Getting The New Bugzilla

There are three ways to get the new version of Bugzilla. We'll list them here briefly and then explain them more later.

2.7.2.2. Upgrading using CVS

This requires that you have cvs installed (most Unix machines do), and requires that you are able to access cvs-mirror.mozilla.org on port 2401, which may not be an option if you are behind a highly restrictive firewall or don't have Internet access.

The following shows the sequence of commands needed to update a Bugzilla installation via CVS, and a typical series of results.

bash$ cd /var/www/html/bugzilla bash$ cvs login Logging in to :pserver:[email protected]:2401/cvsroot CVS password: ('anonymous', or just leave it blank) bash$ cvs -q update -r BUGZILLA-2_22_1 -dP P checksetup.pl P collectstats.pl P docs/rel_notes.txt P template/en/default/list/quips.html.tmpl (etc.)

If a line in the output from cvs update begins with a C, then that represents a file with local changes that CVS was unable to properly merge. You need to resolve these conflicts manually before Bugzilla (or at least the portion using that file) will be usable.

2.7.2.3. Upgrading using the tarball

If you are unable (or unwilling) to use CVS, another option that's always available is to obtain the latest tarball from the Download Page and create a new Bugzilla installation from that.

This sequence of commands shows how to get the tarball from the command-line; it is also possible to download it from the site directly in a web browser. If you go that route, save the file to the /var/www/html directory (or its equivalent, if you use something else) and omit the first three lines of the example.

bash$ cd /var/www/html bash$ wget https://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.22.1.tar.gz (Output omitted) bash$ tar xzvf bugzilla-2.22.1.tar.gz bugzilla-2.22.1/ bugzilla-2.22.1/.cvsignore (Output truncated) bash$ cd bugzilla-2.22.1 bash$ cp ../bugzilla/localconfig* . bash$ cp -r ../bugzilla/data . bash$ cd .. bash$ mv bugzilla bugzilla.old bash$ mv bugzilla-2.22.1 bugzilla

The cp commands both end with periods which is a very important detail--it means that the destination directory is the current working directory.

This upgrade method will give you a clean install of Bugzilla. That's fine if you don't have any local customizations that you want to maintain. If you do have customizations, then you will need to reapply them by hand to the appropriate files.

2.7.2.4. Upgrading using patches

A patch is a collection of all the bug fixes that have been made since the last bug-fix release.

If you are doing a bug-fix upgrade—that is, one where only the last number of the revision changes, such as from 2.22 to 2.22.1—then you have the option of obtaining and applying a patch file from the Download Page.

As above, this example starts with obtaining the file via the command line. If you have already downloaded it, you can omit the first two commands.

bash$ cd /var/www/html/bugzilla bash$ wget https://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-2.22-to-2.22.1.diff.gz (Output omitted) bash$ gunzip bugzilla-2.22-to-2.22.1.diff.gz bash$ patch -p1 < bugzilla-2.22-to-2.22.1.diff patching file checksetup.pl patching file collectstats.pl (etc.)

Be aware that upgrading from a patch file does not change the entries in your CVS directory. This could make it more difficult to upgrade using CVS (Section 2.7.2.2) in the future.

2.7.3. Completing Your Upgrade

Now that you have the new Bugzilla code, there are a few final steps to complete your upgrade.

1. If your new Bugzilla installation is in a different directory or on a different machine than your old Bugzilla installation, make sure that you have copied the data directory and the localconfig file from your old Bugzilla installation. (If you followed the tarball instructions above, this has already happened.)

2. If this is a major update, check that the configuration (Section 2.2) for your new Bugzilla is up-to-date. Sometimes the configuration requirements change between major versions.

3. If you didn't do it as part of the above configuration step, now you need to run checksetup.pl, which will do everything required to convert your existing database and settings for the new version:

   bash$ cd /var/www/html/bugzilla bash$ ./checksetup.pl

   The period at the beginning of the command ./checksetup.pl is important and can not be omitted.

   If this is a major upgrade (say, 2.22 to 3.0 or similar), running checksetup.pl on a large installation (75,000 or more bugs) can take a long time, possibly several hours.

4. Clear any HTML or text that you put into the shutdownhtml parameter, to re-activate Bugzilla.

5. View the Sanity Check (Section 3.15) page in your upgraded Bugzilla.

   It is recommended that, if possible, you fix any problems you see, immediately. Failure to do this may mean that Bugzilla will not work correctly. Be aware that if the sanity check page contains more errors after an upgrade, it doesn't necessarily mean there are more errors in your database than there were before, as additional tests are added to the sanity check over time, and it is possible that those errors weren't being checked for in the old version.

2.7.4. Automatic Notifications of New Releases

Bugzilla 3.0 introduced the ability to automatically notify administrators when new releases are available, based on the upgrade_notification parameter, see Section 3.1. Administrators will see these notifications when they access the index.cgi page, i.e. generally when logging in. Bugzilla will check once per day for new releases, unless the parameter is set to "disabled". If you are behind a proxy, you may have to set the proxy_url parameter accordingly. If the proxy requires authentication, use the http://user:pass@proxy_url/ syntax.