<!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.2. Linux — 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.3. Windows" href="windows.html" />
<link rel="prev" title="3.1. Quick Start (Ubuntu Linux 14.04)" href="quick-start.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="windows.html" title="3.3. Windows"
accesskey="N">next</a></li>
<li class="right" >
<a href="quick-start.html" title="3.1. Quick Start (Ubuntu Linux 14.04)"
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" accesskey="U">3. Installation and Maintenance Guide</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="linux">
<span id="id1"></span><h1>3.2. Linux<a class="headerlink" href="#linux" title="Permalink to this headline">¶</a></h1>
<p>Some Linux distributions include Bugzilla and its dependencies in their
package management systems. If you have root access, installing Bugzilla on
any Linux system could be as simple as finding the Bugzilla package in the
package management application and installing it. There may be a small bit
of additional configuration required.</p>
<p>If you are installing your machine from scratch, <a class="reference internal" href="quick-start.html#quick-start"><span class="std std-ref">Quick Start (Ubuntu Linux 14.04)</span></a> may be
the best instructions for you.</p>
<div class="section" id="install-packages">
<span id="linux-install-packages"></span><h2>3.2.1. Install Packages<a class="headerlink" href="#install-packages" title="Permalink to this headline">¶</a></h2>
<p>Use your distribution's package manager to install Perl, your preferred
database engine (MySQL if in doubt), and a webserver (Apache if in doubt).
Some distributions even have a Bugzilla package, although that will vary
in age.</p>
<p>The commands below will install those things and some of Bugzilla's other
prerequisites as well. If you find a package doesn't install or the name
is not found, just remove it from the list and reissue the command. If you
want to use a different database or webserver, substitute the package
names as appropriate.</p>
<div class="section" id="fedora-and-red-hat">
<h3>3.2.1.1. Fedora and Red Hat<a class="headerlink" href="#fedora-and-red-hat" title="Permalink to this headline">¶</a></h3>
<p>The following command will install Red Hat's packaged version of Bugzilla:</p>
<p><strong class="command">yum install bugzilla httpd mysql-server</strong></p>
<p>Then, you can skip to <a class="reference internal" href="#linux-config-database"><span class="std std-ref">configuring your database</span></a>.
It may be useful to know that Fedora stores the Bugzilla files in
<code class="file docutils literal"><span class="pre">/usr/share/bugzilla</span></code>, so that's where you'll run <code class="file docutils literal"><span class="pre">checksetup.pl</span></code>.</p>
<p>If you want to install a version of Bugzilla from the Bugzilla project, you
will instead need:</p>
<p><strong class="command">yum install httpd mysql-server mod_perl mod_perl-devel httpd-devel
gd-devel mysql-devel
graphviz patchutils gcc 'perl(Apache2::SizeLimit)' 'perl(Authen::Radius)'
'perl(Authen::SASL)' 'perl(Cache::Memcached)' 'perl(CGI)' 'perl(Chart::Lines)'
'perl(Daemon::Generic)' 'perl(Date::Format)' 'perl(DateTime)'
'perl(DateTime::TimeZone)' 'perl(DBI)' 'perl(Digest::SHA)' 'perl(Email::MIME)'
'perl(Email::Reply)' 'perl(Email::Sender)' 'perl(Encode)' 'perl(Encode::Detect)'
'perl(File::MimeInfo::Magic)' 'perl(GD)' 'perl(GD::Graph)'
'perl(GD::Text)' 'perl(HTML::FormatText::WithLinks)' 'perl(HTML::Parser)'
'perl(HTML::Scrubber)' 'perl(IO::Scalar)' 'perl(JSON::RPC)' 'perl(JSON::XS)'
'perl(List::MoreUtils)' 'perl(LWP::UserAgent)' 'perl(Math::Random::ISAAC)'
'perl(MIME::Parser)' 'perl(mod_perl2)' 'perl(Net::LDAP)' 'perl(Net::SMTP::SSL)'
'perl(PatchReader)' 'perl(SOAP::Lite)' 'perl(Template)'
'perl(Template::Plugin::GD::Image)' 'perl(Test::Taint)' 'perl(TheSchwartz)'
'perl(URI)' 'perl(XMLRPC::Lite)' 'perl(XML::Twig)'</strong></p>
<p>If you are running RHEL6, you will have to enable the "RHEL Server Optional"
channel in RHN to get some of those packages.</p>
<p>If you plan to use a database other than MySQL, you will need to also install
the appropriate packages for that.</p>
</div>
<div class="section" id="ubuntu-and-debian">
<h3>3.2.1.2. Ubuntu and Debian<a class="headerlink" href="#ubuntu-and-debian" title="Permalink to this headline">¶</a></h3>
<p><strong class="command">apt-get install git nano</strong></p>
<p><strong class="command">apt-get install apache2 mysql-server libappconfig-perl
libdate-calc-perl libtemplate-perl libmime-perl build-essential
libdatetime-timezone-perl libdatetime-perl libemail-sender-perl
libemail-mime-perl libemail-mime-modifier-perl libdbi-perl libdbd-mysql-perl
libcgi-pm-perl libmath-random-isaac-perl libmath-random-isaac-xs-perl
apache2-mpm-prefork libapache2-mod-perl2 libapache2-mod-perl2-dev
libchart-perl libxml-perl libxml-twig-perl perlmagick libgd-graph-perl
libtemplate-plugin-gd-perl libsoap-lite-perl libhtml-scrubber-perl
libjson-rpc-perl libdaemon-generic-perl libtheschwartz-perl
libtest-taint-perl libauthen-radius-perl libfile-slurp-perl
libencode-detect-perl libmodule-build-perl libnet-ldap-perl
libauthen-sasl-perl libtemplate-perl-doc libfile-mimeinfo-perl
libhtml-formattext-withlinks-perl libgd-dev libmysqlclient-dev lynx-cur
graphviz python-sphinx</strong></p>
<p>If you plan to use a database other than MySQL, you will need to also install
the appropriate packages for that.</p>
</div>
<div class="section" id="gentoo">
<h3>3.2.1.3. Gentoo<a class="headerlink" href="#gentoo" title="Permalink to this headline">¶</a></h3>
<p><strong class="command">emerge -av bugzilla</strong></p>
<p>will install Bugzilla and all its dependencies. If you don't have the vhosts
USE flag enabled, Bugzilla will end up in <code class="file docutils literal"><span class="pre">/var/www/localhost/bugzilla</span></code>.</p>
<p>Then, you can skip to <a class="reference internal" href="#linux-config-database"><span class="std std-ref">configuring your database</span></a>.</p>
</div>
</div>
<div class="section" id="perl">
<span id="linux-install-perl"></span><h2>3.2.2. Perl<a class="headerlink" href="#perl" title="Permalink to this headline">¶</a></h2>
<p>Test which version of Perl you have installed with:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ perl -v
</pre></div>
</div>
<p>Bugzilla requires at least Perl 5.10.1.</p>
</div>
<div class="section" id="bugzilla">
<span id="linux-install-bzfiles"></span><h2>3.2.3. Bugzilla<a class="headerlink" href="#bugzilla" title="Permalink to this headline">¶</a></h2>
<p>The best way to get Bugzilla is to check it out from git:</p>
<p><strong class="command">git clone --branch release-X.X-stable https://github.com/bugzilla/bugzilla</strong></p>
<p>Run the above command in your home directory, replacing "X.X" with the 2-digit
version number of the stable release of Bugzilla that you want - e.g. "4.4".</p>
<p>If that's not possible, you can
<a class="reference external" href="http://www.bugzilla.org/download/">download a tarball of Bugzilla</a>.</p>
<p>Place Bugzilla in a suitable directory, accessible by the default web server
user (probably <code class="docutils literal"><span class="pre">apache</span></code> or <code class="docutils literal"><span class="pre">www-data</span></code>).
Good locations are either directly in the web server's document directory
(often <code class="file docutils literal"><span class="pre">/var/www/html</span></code>) or in <code class="file docutils literal"><span class="pre">/usr/local</span></code>, either with a
symbolic link to the web server's document directory or an alias in the web
server's configuration.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">The default Bugzilla distribution is NOT designed to be placed
in a <code class="file docutils literal"><span class="pre">cgi-bin</span></code> directory. This
includes any directory which is configured using the
<code class="docutils literal"><span class="pre">ScriptAlias</span></code> directive of Apache.</p>
</div>
</div>
<div class="section" id="perl-modules">
<span id="linux-install-perl-modules"></span><h2>3.2.4. Perl Modules<a class="headerlink" href="#perl-modules" title="Permalink to this headline">¶</a></h2>
<p>Bugzilla requires a number of Perl modules. You can install these globally
using your system's package manager, or install Bugzilla-only copies. At
times, Bugzilla may require a version of a Perl module newer than the one
your distribution packages, in which case you will need to install a
Bugzilla-only copy of the newer version.</p>
<p>At this point you probably need to become <code class="docutils literal"><span class="pre">root</span></code>, e.g. by using
<strong class="command">su</strong>. You should remain as root until the end of the install. This
can be avoided in some circumstances if you are a member of your webserver's
group, but being root is easier and will always work.</p>
<p>To check whether you have all the required modules, run:</p>
<p><strong class="command">./checksetup.pl --check-modules</strong></p>
<p>You can run this command as many times as necessary.</p>
<p>If you have not already installed the necessary modules, and want to do it
system-wide, invoke your package manager appropriately at this point.
Alternatively, you can install all missing modules locally (i.e. just for
Bugzilla) like this:</p>
<p><strong class="command">./install-module.pl --all</strong></p>
<p>Or, you can pass an individual module name:</p>
<p><strong class="command">./install-module.pl <modulename></strong></p>
</div>
<div class="section" id="web-server">
<span id="linux-config-webserver"></span><h2>3.2.5. Web Server<a class="headerlink" href="#web-server" title="Permalink to this headline">¶</a></h2>
<p>Any web server that is capable of running CGI scripts can be made to work.
We have specific configuration instructions for the following:</p>
<ul class="simple">
<li><a class="reference internal" href="apache.html#apache"><span class="std std-ref">Apache</span></a></li>
</ul>
</div>
<div class="section" id="database-engine">
<span id="linux-config-database"></span><h2>3.2.6. Database Engine<a class="headerlink" href="#database-engine" title="Permalink to this headline">¶</a></h2>
<p>Bugzilla supports MySQL, PostgreSQL, Oracle and SQLite as database servers.
You only require one of these systems to make use of Bugzilla. MySQL is
most commonly used. SQLite is good for trial installations as it requires no
setup. Configure your server according to the instructions below:</p>
<ul class="simple">
<li><a class="reference internal" href="mysql.html#mysql"><span class="std std-ref">MySQL</span></a></li>
<li><a class="reference internal" href="postgresql.html#postgresql"><span class="std std-ref">PostgreSQL</span></a></li>
<li><a class="reference internal" href="oracle.html#oracle"><span class="std std-ref">Oracle</span></a></li>
<li><a class="reference internal" href="sqlite.html#sqlite"><span class="std std-ref">SQLite</span></a></li>
</ul>
</div>
<div class="section" id="localconfig">
<h2>3.2.7. localconfig<a class="headerlink" href="#localconfig" title="Permalink to this headline">¶</a></h2>
<p>You should now change into the Bugzilla directory and run
<code class="file docutils literal"><span class="pre">checksetup.pl</span></code>, without any parameters:</p>
<p><strong class="command">./checksetup.pl</strong></p>
<p><code class="file docutils literal"><span class="pre">checksetup.pl</span></code> will write out a file called <code class="file docutils literal"><span class="pre">localconfig</span></code>.
This file contains the default settings for a number of
Bugzilla parameters, the most important of which are the group your web
server runs as, and information on how to connect to your database.</p>
<p>Load this file in your editor. You will need to check/change <code class="docutils literal"><span class="pre">$db_driver</span></code>
and <code class="docutils literal"><span class="pre">$db_pass</span></code>, which are respectively the type of the database you are
using and the password for the <code class="docutils literal"><span class="pre">bugs</span></code> database user you have created.
<code class="docutils literal"><span class="pre">$db_driver</span></code> can be either <code class="docutils literal"><span class="pre">mysql</span></code>, <code class="docutils literal"><span class="pre">Pg</span></code> (PostgreSQL), <code class="docutils literal"><span class="pre">Oracle</span></code> or
<code class="docutils literal"><span class="pre">Sqlite</span></code>. All values are case sensitive.</p>
<p>Set the value of <code class="docutils literal"><span class="pre">$webservergroup</span></code> to the group your web server runs as.</p>
<ul class="simple">
<li>Fedora/Red Hat: <code class="docutils literal"><span class="pre">apache</span></code></li>
<li>Debian/Ubuntu: <code class="docutils literal"><span class="pre">www-data</span></code></li>
<li>Mac OS X: <code class="docutils literal"><span class="pre">_www</span></code></li>
<li>Windows: ignore this setting; it does nothing</li>
</ul>
<p>The other options in the <code class="file docutils literal"><span class="pre">localconfig</span></code> file are documented by their
accompanying comments. If you have a non-standard database setup, you may
need to change one or more of the other <code class="docutils literal"><span class="pre">$db_*</span></code> parameters.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you are using Oracle, <code class="docutils literal"><span class="pre">$db_name</span></code> should be set to
the SID name of your database (e.g. <code class="docutils literal"><span class="pre">XE</span></code> if you are using Oracle XE).</p>
</div>
</div>
<div class="section" id="checksetup-pl">
<h2>3.2.8. checksetup.pl<a class="headerlink" href="#checksetup-pl" title="Permalink to this headline">¶</a></h2>
<p>Next, run <code class="file docutils literal"><span class="pre">checksetup.pl</span></code> an additional time:</p>
<p><strong class="command">./checksetup.pl</strong></p>
<p>It reconfirms that all the modules are present, and notices the altered
localconfig file, which it assumes you have edited to your
satisfaction. It compiles the UI templates,
connects to the database using the <code class="docutils literal"><span class="pre">bugs</span></code>
user you created and the password you defined, and creates the
<code class="docutils literal"><span class="pre">bugs</span></code> database and the tables therein.</p>
<p>After that, it asks for details of an administrator account. Bugzilla
can have multiple administrators - you can create more later - but
it needs one to start off with.
Enter the email address of an administrator, his or her full name,
and a suitable Bugzilla password.</p>
<p><code class="file docutils literal"><span class="pre">checksetup.pl</span></code> will then finish. You may rerun
<code class="file docutils literal"><span class="pre">checksetup.pl</span></code> at any time if you wish.</p>
</div>
<div class="section" id="success">
<h2>3.2.9. Success<a class="headerlink" href="#success" title="Permalink to this headline">¶</a></h2>
<p>Your Bugzilla should now be working. Check by running:</p>
<p><strong class="command">./testserver.pl http://<your-bugzilla-server>/</strong></p>
<p>If that passes, access <code class="docutils literal"><span class="pre">http://<your-bugzilla-server>/</span></code> in your browser -
you should see the Bugzilla front page. Of course, if you installed Bugzilla
in a subdirectory, make sure that's in the URL.</p>
<p>Next, do the <a class="reference internal" href="essential-post-install-config.html#essential-post-install-config"><span class="std std-ref">Essential Post-Installation Configuration</span></a>.</p>
<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.2. Linux</a><ul>
<li><a class="reference internal" href="#install-packages">3.2.1. Install Packages</a><ul>
<li><a class="reference internal" href="#fedora-and-red-hat">3.2.1.1. Fedora and Red Hat</a></li>
<li><a class="reference internal" href="#ubuntu-and-debian">3.2.1.2. Ubuntu and Debian</a></li>
<li><a class="reference internal" href="#gentoo">3.2.1.3. Gentoo</a></li>
</ul>
</li>
<li><a class="reference internal" href="#perl">3.2.2. Perl</a></li>
<li><a class="reference internal" href="#bugzilla">3.2.3. Bugzilla</a></li>
<li><a class="reference internal" href="#perl-modules">3.2.4. Perl Modules</a></li>
<li><a class="reference internal" href="#web-server">3.2.5. Web Server</a></li>
<li><a class="reference internal" href="#database-engine">3.2.6. Database Engine</a></li>
<li><a class="reference internal" href="#localconfig">3.2.7. localconfig</a></li>
<li><a class="reference internal" href="#checksetup-pl">3.2.8. checksetup.pl</a></li>
<li><a class="reference internal" href="#success">3.2.9. Success</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="quick-start.html"
title="previous chapter">3.1. Quick Start (Ubuntu Linux 14.04)</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="windows.html"
title="next chapter">3.3. Windows</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="windows.html" title="3.3. Windows"
>next</a></li>
<li class="right" >
<a href="quick-start.html" title="3.1. Quick Start (Ubuntu Linux 14.04)"
>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>
</ul>
</div>
<div class="footer" role="contentinfo">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
</div>
</body>
</html>
