<!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.1. Quick Start (Ubuntu Linux 14.04) — 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.2. Linux" href="linux.html" />
<link rel="prev" title="3. Installation and Maintenance Guide" href="index.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="linux.html" title="3.2. Linux"
accesskey="N">next</a></li>
<li class="right" >
<a href="index.html" title="3. Installation and Maintenance Guide"
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="quick-start-ubuntu-linux-14-04">
<span id="quick-start"></span><h1>3.1. Quick Start (Ubuntu Linux 14.04)<a class="headerlink" href="#quick-start-ubuntu-linux-14-04" title="Permalink to this headline">¶</a></h1>
<p>This quick start guide makes installing Bugzilla as simple as possible for
those who are able to choose their environment. It creates a system using
Ubuntu Linux 14.04 LTS, Apache and MySQL. It requires a little familiarity
with Linux and the command line.</p>
<div class="section" id="obtain-your-hardware">
<h2>3.1.1. Obtain Your Hardware<a class="headerlink" href="#obtain-your-hardware" title="Permalink to this headline">¶</a></h2>
<p>Ubuntu 14.04 LTS Server requires a 64-bit processor.
Bugzilla itself has no prerequisites beyond that, although you should pick
reliable hardware. You can also probably use any 64-bit virtual machine
or cloud instance that you have root access on.</p>
</div>
<div class="section" id="install-the-os">
<h2>3.1.2. Install the OS<a class="headerlink" href="#install-the-os" title="Permalink to this headline">¶</a></h2>
<p>Get <a class="reference external" href="http://www.ubuntu.com/download/server">Ubuntu Server 14.04 LTS</a>
and follow the <a class="reference external" href="http://www.ubuntu.com/download/server/install-ubuntu-server">installation instructions</a>.
Here are some tips:</p>
<ul class="simple">
<li>Choose any server name you like.</li>
<li>When creating the initial Linux user, call it <code class="docutils literal"><span class="pre">bugzilla</span></code>, give it a
strong password, and write that password down.</li>
<li>You do not need an encrypted home directory.</li>
<li>Choose all the defaults for the "partitioning" part (excepting of course
where the default is "No" and you need to press "Yes" to continue).</li>
<li>Choose "install security updates automatically" unless you want to do
them manually.</li>
<li>From the install options, choose "OpenSSH Server" and "LAMP Server".</li>
<li>Set the password for the MySQL root user to a strong password, and write
that password down.</li>
<li>Install the Grub boot loader to the Master Boot Record.</li>
</ul>
<p>Reboot when the installer finishes.</p>
</div>
<div class="section" id="become-root">
<h2>3.1.3. Become root<a class="headerlink" href="#become-root" title="Permalink to this headline">¶</a></h2>
<p>ssh to the machine as the 'bugzilla' user, or start a console. Then:</p>
<p><strong class="command">sudo su</strong></p>
</div>
<div class="section" id="install-prerequisites">
<h2>3.1.4. Install Prerequisites<a class="headerlink" href="#install-prerequisites" title="Permalink to this headline">¶</a></h2>
<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>This will take a little while. It's split into two commands so you can do
the next steps (up to step 7) in another terminal while you wait for the
second command to finish. If you start another terminal, you will need to
<strong class="command">sudo su</strong> again.</p>
</div>
<div class="section" id="download-bugzilla">
<h2>3.1.5. Download Bugzilla<a class="headerlink" href="#download-bugzilla" title="Permalink to this headline">¶</a></h2>
<p>Get it from our Git repository:</p>
<p><strong class="command">cd /var/www/html</strong></p>
<p><strong class="command">git clone --branch release-X.X-stable https://github.com/bugzilla/bugzilla bugzilla</strong></p>
<p>(where "X.X" is the 2-digit version number of the stable release of Bugzilla
that you want - e.g. 5.0)</p>
</div>
<div class="section" id="configure-mysql">
<h2>3.1.6. Configure MySQL<a class="headerlink" href="#configure-mysql" title="Permalink to this headline">¶</a></h2>
<p>The following instructions use the simple <code class="file docutils literal"><span class="pre">nano</span></code> editor, but feel
free to use any text editor you are comfortable with.</p>
<p><strong class="command">nano /etc/mysql/my.cnf</strong></p>
<p>Set the following values, which increase the maximum attachment size and
make it possible to search for short words and terms:</p>
<ul class="simple">
<li>Alter on Line 52: <code class="docutils literal"><span class="pre">max_allowed_packet=100M</span></code></li>
<li>Add as new line 32, in the <code class="docutils literal"><span class="pre">[mysqld]</span></code> section: <code class="docutils literal"><span class="pre">ft_min_word_len=2</span></code></li>
</ul>
<p>Save and exit.</p>
<p>Then, add a user to MySQL for Bugzilla to use:</p>
<p><strong class="command">mysql -u root -p -e "GRANT ALL PRIVILEGES ON bugs.* TO bugs@localhost IDENTIFIED BY '$db_pass'"</strong></p>
<p>Replace <code class="docutils literal"><span class="pre">$db_pass</span></code> with a strong password you have generated. Write it down.
When you run the above command, it will prompt you for the MySQL root password
that you configured when you installed Ubuntu. You should make <code class="docutils literal"><span class="pre">$db_pass</span></code>
different to that password.</p>
<p>Restart MySQL:</p>
<p><strong class="command">service mysql restart</strong></p>
</div>
<div class="section" id="configure-apache">
<h2>3.1.7. Configure Apache<a class="headerlink" href="#configure-apache" title="Permalink to this headline">¶</a></h2>
<p><strong class="command">nano /etc/apache2/sites-available/bugzilla.conf</strong></p>
<p>Paste in the following and save:</p>
<div class="highlight-apache"><div class="highlight"><pre><span></span><span class="nb">ServerName</span> localhost
<span class="nt"><Directory</span> <span class="s">/var/www/html/bugzilla</span><span class="nt">></span>
<span class="nb">AddHandler</span> cgi-script .cgi
<span class="nb">Options</span> +ExecCGI
<span class="nb">DirectoryIndex</span> index.cgi index.html
<span class="nb">AllowOverride</span> <span class="k">All</span>
<span class="nt"></Directory></span>
</pre></div>
</div>
<p><strong class="command">a2ensite bugzilla</strong></p>
<p><strong class="command">a2enmod cgi headers expires</strong></p>
<p><strong class="command">service apache2 restart</strong></p>
</div>
<div class="section" id="check-setup">
<h2>3.1.8. Check Setup<a class="headerlink" href="#check-setup" title="Permalink to this headline">¶</a></h2>
<p>Bugzilla comes with a <code class="file docutils literal"><span class="pre">checksetup.pl</span></code> script which helps with the
installation process. It will need to be run twice. The first time, it
generates a config file (called <code class="file docutils literal"><span class="pre">localconfig</span></code>) for the database
access information, and the second time (step 10)
it uses the info you put in the config file to set up the database.</p>
<p><strong class="command">cd /var/www/html/bugzilla</strong></p>
<p><strong class="command">./checksetup.pl</strong></p>
</div>
<div class="section" id="edit-localconfig">
<h2>3.1.9. Edit <code class="file docutils literal"><span class="pre">localconfig</span></code><a class="headerlink" href="#edit-localconfig" title="Permalink to this headline">¶</a></h2>
<p><strong class="command">nano localconfig</strong></p>
<p>You will need to set the following values:</p>
<ul class="simple">
<li>Line 29: set <code class="docutils literal"><span class="pre">$webservergroup</span></code> to <code class="docutils literal"><span class="pre">www-data</span></code></li>
<li>Line 67: set <code class="docutils literal"><span class="pre">$db_pass</span></code> to the password for the <code class="docutils literal"><span class="pre">bugs</span></code> user you created
in MySQL a few steps ago</li>
</ul>
</div>
<div class="section" id="check-setup-again">
<h2>3.1.10. Check Setup (again)<a class="headerlink" href="#check-setup-again" title="Permalink to this headline">¶</a></h2>
<p>Run the <code class="file docutils literal"><span class="pre">checksetup.pl</span></code> script again to set up the database.</p>
<p><strong class="command">./checksetup.pl</strong></p>
<p>It will ask you to give an email address, real name and password for the
first Bugzilla account to be created, which will be an administrator.
Write down the email address and password you set.</p>
</div>
<div class="section" id="test-server">
<h2>3.1.11. Test Server<a class="headerlink" href="#test-server" title="Permalink to this headline">¶</a></h2>
<p><strong class="command">./testserver.pl http://localhost/bugzilla</strong></p>
<p>All the tests should pass. You will get warnings about deprecation from
the <code class="docutils literal"><span class="pre">Chart::Base</span></code> Perl module; just ignore those.</p>
</div>
<div class="section" id="access-via-web-browser">
<h2>3.1.12. Access Via Web Browser<a class="headerlink" href="#access-via-web-browser" title="Permalink to this headline">¶</a></h2>
<p>Access the front page:</p>
<p><strong class="command">lynx http://localhost/bugzilla</strong></p>
<p>It's not really possible to use Bugzilla for real through Lynx, but you
can view the front page to validate visually that it's up and running.</p>
<p>You might well need to configure your DNS such that the server has, and
is reachable by, a name rather than IP address. Doing so is out of scope
of this document. In the mean time, it is available on your local network
at <code class="docutils literal"><span class="pre">http://<ip</span> <span class="pre">address>/bugzilla</span></code>, where <code class="docutils literal"><span class="pre"><ip</span> <span class="pre">address></span></code> is (unless you
have a complex network setup) the "inet addr" value displayed when you run
<strong class="command">ifconfig eth0</strong>.</p>
</div>
<div class="section" id="configure-bugzilla">
<h2>3.1.13. Configure Bugzilla<a class="headerlink" href="#configure-bugzilla" title="Permalink to this headline">¶</a></h2>
<p>Once you have worked out how to access your Bugzilla in a graphical
web browser, bring up the front page, click <span class="guilabel">Log In</span> in the
header, and log in as the admin user you defined in step 10.</p>
<p>Click the <span class="guilabel">Parameters</span> link on the page it gives you, and set
the following parameters in the <span class="guilabel">Required Settings</span> section:</p>
<ul class="simple">
<li><span class="param">urlbase</span>:
<span class="paramval">http://<servername>/bugzilla/</span> or <span class="paramval">http://<ip address>/bugzilla/</span></li>
</ul>
<p>Click <span class="guilabel">Save Changes</span> at the bottom of the page.</p>
<p>There are several ways to get Bugzilla to send email. The easiest is to
use Gmail, so we do that here so you have it working. Visit
<a class="reference external" href="https://gmail.com">https://gmail.com</a> and create a new Gmail account for your Bugzilla to use.
Then, open the <span class="guilabel">Email</span> section of the Parameters using the link
in the left column, and set the following parameter values:</p>
<ul class="simple">
<li><span class="param">mail_delivery_method</span>: <span class="paramval">SMTP</span></li>
<li><span class="param">mailfrom</span>: <span class="paramval">new_gmail_address@gmail.com</span></li>
<li><span class="param">smtpserver</span>: <span class="paramval">smtp.gmail.com:465</span></li>
<li><span class="param">smtp_username</span>: <span class="paramval">new_gmail_address@gmail.com</span></li>
<li><span class="param">smtp_password</span>: <span class="paramval">new_gmail_password</span></li>
<li><span class="param">smtp_ssl</span>: <span class="paramval">On</span></li>
</ul>
<p>Click <span class="guilabel">Save Changes</span> at the bottom of the page.</p>
<p>And you're all ready to go. :-)</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.1. Quick Start (Ubuntu Linux 14.04)</a><ul>
<li><a class="reference internal" href="#obtain-your-hardware">3.1.1. Obtain Your Hardware</a></li>
<li><a class="reference internal" href="#install-the-os">3.1.2. Install the OS</a></li>
<li><a class="reference internal" href="#become-root">3.1.3. Become root</a></li>
<li><a class="reference internal" href="#install-prerequisites">3.1.4. Install Prerequisites</a></li>
<li><a class="reference internal" href="#download-bugzilla">3.1.5. Download Bugzilla</a></li>
<li><a class="reference internal" href="#configure-mysql">3.1.6. Configure MySQL</a></li>
<li><a class="reference internal" href="#configure-apache">3.1.7. Configure Apache</a></li>
<li><a class="reference internal" href="#check-setup">3.1.8. Check Setup</a></li>
<li><a class="reference internal" href="#edit-localconfig">3.1.9. Edit <code class="file docutils literal"><span class="pre">localconfig</span></code></a></li>
<li><a class="reference internal" href="#check-setup-again">3.1.10. Check Setup (again)</a></li>
<li><a class="reference internal" href="#test-server">3.1.11. Test Server</a></li>
<li><a class="reference internal" href="#access-via-web-browser">3.1.12. Access Via Web Browser</a></li>
<li><a class="reference internal" href="#configure-bugzilla">3.1.13. Configure Bugzilla</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">3. Installation and Maintenance Guide</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="linux.html"
title="next chapter">3.2. Linux</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="linux.html" title="3.2. Linux"
>next</a></li>
<li class="right" >
<a href="index.html" title="3. Installation and Maintenance Guide"
>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>
