<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>3.11.5. Upgrading with a Tarball — Bugzilla 5.0.4 documentation</title>
<link rel="stylesheet" href="../_static/bugzilla.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '5.0.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="3.11.6. Upgrading a Customized or Extended Bugzilla" href="upgrading-customizations.html" />
<link rel="prev" title="3.11.4. Migrating from a Tarball" href="migrating-from-a-tarball.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="upgrading-customizations.html" title="3.11.6. Upgrading a Customized or Extended Bugzilla"
accesskey="N">next</a></li>
<li class="right" >
<a href="migrating-from-a-tarball.html" title="3.11.4. Migrating from a Tarball"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Bugzilla 5.0.4 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >3. Installation and Maintenance Guide</a> »</li>
<li class="nav-item nav-item-2"><a href="upgrading.html" accesskey="U">3.11. Upgrading</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="upgrading-with-a-tarball">
<span id="id1"></span><h1>3.11.5. Upgrading with a Tarball<a class="headerlink" href="#upgrading-with-a-tarball" title="Permalink to this headline">¶</a></h1>
<p>If you are unable (or unwilling) to use Git, another option is to obtain a
tarball of the latest version from our website and upgrade your Bugzilla
installation using that.</p>
<p>Without a source code management system to help you, the process may be
trickier.</p>
<div class="section" id="before-you-upgrade">
<h2>3.11.5.1. Before You Upgrade<a class="headerlink" href="#before-you-upgrade" title="Permalink to this headline">¶</a></h2>
<p>Before you start your upgrade, there are a few important
steps to take:</p>
<ol class="arabic simple">
<li>Read the
<a class="reference external" href="http://www.bugzilla.org/releases/">Release Notes</a> of the version you're
upgrading to and all intermediate versions, particularly the "Notes for
Upgraders" sections, if present. They may make you aware of additional
considerations.</li>
<li>Run the <a class="reference internal" href="sanity-check.html#sanity-check"><span class="std std-ref">Sanity Check</span></a> on your installation. Attempt to fix all
warnings that the page produces before you start, or it's
possible that you may experience problems during your upgrade.</li>
<li>Work out how to <a class="reference internal" href="backups.html#backups"><span class="std std-ref">back up</span></a> your Bugzilla entirely, and
how to restore from a backup if need be.</li>
</ol>
<div class="section" id="customized-bugzilla">
<h3>Customized Bugzilla?<a class="headerlink" href="#customized-bugzilla" title="Permalink to this headline">¶</a></h3>
<p>If you have modified the code or templates of your Bugzilla,
then upgrading requires a bit more thought and effort than the simple process
below. See <a class="reference internal" href="../integrating/templates.html#template-method"><span class="std std-ref">Choosing a Customization Method</span></a> for a discussion of the various methods of
code customization that may have been used.</p>
<p>The larger the jump you are trying to make, the more difficult it
is going to be to upgrade if you have made local code customizations.
Upgrading from 4.2 to 4.2.1 should be fairly painless even if
you are heavily customized, but going from 2.18 to 4.2 is going
to mean a fair bit of work re-writing your local changes to use
the new files, logic, templates, etc. If you have done no local
changes at all, however, then upgrading should be approximately
the same amount of work regardless of how long it has been since
your version was released.</p>
<p>If you have made customizations, you should do the upgrade on a test system
with the same configuration and make sure all your customizations still work.
If not, port and test them so you have them ready to reapply once you do
the upgrade for real.</p>
<p>As you are using a tarball and not an SCM, it's not at all easy to see if
you've made local code customizations. You may have to use institutional
knowledge, or download a fresh copy of your <em>current</em> version of Bugzilla
and compare the two directories. If you find that you have, you'll need
to turn them into a patch file, perhaps by diffing the two directories,
and then reapply that patch file later. If you are customizing Bugzilla
locally, please consider
<a class="reference internal" href="migrating-from-a-tarball.html#migrating-from-a-tarball"><span class="std std-ref">rebasing your install on top of git</span></a>.</p>
</div>
</div>
<div class="section" id="getting-the-new-bugzilla">
<span id="upgrade-files-tarball"></span><h2>3.11.5.2. Getting The New Bugzilla<a class="headerlink" href="#getting-the-new-bugzilla" title="Permalink to this headline">¶</a></h2>
<p>Download a copy of the latest version of Bugzilla from the
<a class="reference external" href="http://www.bugzilla.org/download/">Download Page</a> into a separate
directory (which we will call <code class="file docutils literal"><span class="pre">bugzilla-new</span></code>) alongside your existing
Bugzilla installation (which we will assume is in a directory called
<code class="file docutils literal"><span class="pre">bugzilla</span></code>).</p>
</div>
<div class="section" id="copy-across-data-and-modules">
<h2>3.11.5.3. Copy Across Data and Modules<a class="headerlink" href="#copy-across-data-and-modules" title="Permalink to this headline">¶</a></h2>
<p>Copy the contents of the following directories from your current installation
of Bugzilla into the corresponding directory in <code class="file docutils literal"><span class="pre">bugzilla-new/</span></code>:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>lib/
data/
template/en/custom (may or may not exist)
</pre></div>
</div>
<p>You also need to copy any extensions you have written or installed, which are
in the <code class="file docutils literal"><span class="pre">extensions/</span></code> directory. Bugzilla ships with some extensions,
so again if you want to know if any of the installed extensions are yours,
you may have to compare with a clean copy of your current version. You can
disregard any which have a <code class="file docutils literal"><span class="pre">disabled</span></code> file - those are not enabled.</p>
<p>Lastly, copy the following file from your current installation of Bugzilla
into the corresponding place in <code class="file docutils literal"><span class="pre">bugzilla-new/</span></code>:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>localconfig
</pre></div>
</div>
<p>This file contains your database password and access details.</p>
</div>
<div class="section" id="swap-the-new-version-in">
<h2>3.11.5.4. Swap The New Version In<a class="headerlink" href="#swap-the-new-version-in" title="Permalink to this headline">¶</a></h2>
<p>Now we swap the directories over. From the directory containing the
<code class="file docutils literal"><span class="pre">bugzilla</span></code> and <code class="file docutils literal"><span class="pre">bugzilla-new</span></code> directories, run:</p>
<p><strong class="command">mv bugzilla bugzilla-old</strong></p>
<p><strong class="command">mv bugzilla-new bugzilla</strong></p>
<p><strong class="command">cd bugzilla</strong></p>
</div>
<div class="section" id="upgrading-the-database">
<h2>3.11.5.5. Upgrading the Database<a class="headerlink" href="#upgrading-the-database" title="Permalink to this headline">¶</a></h2>
<p>Run <code class="file docutils literal"><span class="pre">checksetup.pl</span></code>. This will do everything required to convert
your existing database and settings to the new version.</p>
<p><strong class="command">cd $BUGZILLA_HOME</strong></p>
<p><strong class="command">./checksetup.pl</strong></p>
<blockquote>
<div><div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">For some upgrades, running <code class="file docutils literal"><span class="pre">checksetup.pl</span></code> on a large
installation (75,000 or more bugs) can take a long time,
possibly several hours, if e.g. indexes need to be rebuilt. If this
length of downtime would be a problem for you, you can determine
timings for your particular situation by doing a test upgrade on a
development server with the production data.</p>
</div>
</div></blockquote>
<p><code class="file docutils literal"><span class="pre">checksetup.pl</span></code> may also tell you that you need some additional
Perl modules, or newer versions of the ones you have. You will need to
install these, either system-wide or using the <code class="file docutils literal"><span class="pre">install-module.pl</span></code>
script that <code class="file docutils literal"><span class="pre">checksetup.pl</span></code> recommends.</p>
</div>
<div class="section" id="finishing-the-upgrade">
<h2>3.11.5.6. Finishing The Upgrade<a class="headerlink" href="#finishing-the-upgrade" title="Permalink to this headline">¶</a></h2>
<ol class="arabic simple">
<li>Reactivate Bugzilla by clear the text that you put into the
<span class="param">shutdownhtml</span> parameter.</li>
<li>Run another <a class="reference internal" href="sanity-check.html#sanity-check"><span class="std std-ref">Sanity Check</span></a> on your
upgraded Bugzilla. It is recommended that you fix any problems
you see immediately. Failure to do this may mean that Bugzilla
may not work entirely correctly.</li>
</ol>
<hr class="docutils" />
<p>This documentation undoubtedly has bugs; if you find some, please file
them <a class="reference external" href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation">here</a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/bugzilla.png" alt="Logo"/>
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">3.11.5. Upgrading with a Tarball</a><ul>
<li><a class="reference internal" href="#before-you-upgrade">3.11.5.1. Before You Upgrade</a><ul>
<li><a class="reference internal" href="#customized-bugzilla">Customized Bugzilla?</a></li>
</ul>
</li>
<li><a class="reference internal" href="#getting-the-new-bugzilla">3.11.5.2. Getting The New Bugzilla</a></li>
<li><a class="reference internal" href="#copy-across-data-and-modules">3.11.5.3. Copy Across Data and Modules</a></li>
<li><a class="reference internal" href="#swap-the-new-version-in">3.11.5.4. Swap The New Version In</a></li>
<li><a class="reference internal" href="#upgrading-the-database">3.11.5.5. Upgrading the Database</a></li>
<li><a class="reference internal" href="#finishing-the-upgrade">3.11.5.6. Finishing The Upgrade</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="migrating-from-a-tarball.html"
title="previous chapter">3.11.4. Migrating from a Tarball</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="upgrading-customizations.html"
title="next chapter">3.11.6. Upgrading a Customized or Extended Bugzilla</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="upgrading-customizations.html" title="3.11.6. Upgrading a Customized or Extended Bugzilla"
>next</a></li>
<li class="right" >
<a href="migrating-from-a-tarball.html" title="3.11.4. Migrating from a Tarball"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Bugzilla 5.0.4 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >3. Installation and Maintenance Guide</a> »</li>
<li class="nav-item nav-item-2"><a href="upgrading.html" >3.11. Upgrading</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
</div>
</body>
</html>
