<!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.4. Mac OS X — 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.5. Web Server" href="web_server.html" />
<link rel="prev" title="3.3. Windows" href="windows.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="web_server.html" title="3.5. Web Server"
accesskey="N">next</a></li>
<li class="right" >
<a href="windows.html" title="3.3. Windows"
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="mac-os-x">
<span id="id1"></span><h1>3.4. Mac OS X<a class="headerlink" href="#mac-os-x" title="Permalink to this headline">¶</a></h1>
<div class="admonition note" id="macosx-install-packages">
<p class="first admonition-title">Note</p>
<p class="last">The Bugzilla team has very little Mac expertise and we've not been
able to do a successful install of the latest version. We got
close, though. If you've managed it, tell us how and we can update
these docs!</p>
</div>
<div class="section" id="install-packages">
<h2>3.4.1. Install Packages<a class="headerlink" href="#install-packages" title="Permalink to this headline">¶</a></h2>
<p>OS X 10.7 provides Perl 5.12 and Apache 2.2. Install the following additional
packages:</p>
<ul class="simple">
<li>git: Download an installer from
<a class="reference external" href="http://www.git-scm.com/downloads">the git website</a>.</li>
<li>MySQL: Download an installer from
<a class="reference external" href="http://dev.mysql.com/downloads/mysql/">the MySQL website</a>.</li>
</ul>
</div>
<div class="section" id="bugzilla">
<span id="macosx-install-bzfiles"></span><h2>3.4.2. 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".
This will place Bugzilla in the directory <code class="file docutils literal"><span class="pre">$HOME/bugzilla</span></code>.</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>
</div>
<div class="section" id="additional-system-libraries">
<span id="macosx-libraries"></span><h2>3.4.3. Additional System Libraries<a class="headerlink" href="#additional-system-libraries" title="Permalink to this headline">¶</a></h2>
<p>Apple does not include the GD library with Mac OS X. Bugzilla needs this if
you want to display bug graphs, and you need to install it before you try
installing the GD Perl module.</p>
<p>You can use <a class="reference external" href="http://www.macports.org/">MacPorts</a>, <a class="reference external" href="http://brew.sh/">Homebrew</a> or
<a class="reference external" href="http://sourceforge.net/projects/fink/">Fink</a>, all of which can install common
Unix programs on Mac OS X.</p>
<p>If you don't have one of the above installed already, pick one and follow the
instructions for setting it up. Then, use it to install the <code class="file docutils literal"><span class="pre">gd2</span></code> package
(MacPorts/Fink) or the <code class="file docutils literal"><span class="pre">gd</span></code> package (Brew).</p>
<p>The package manager may prompt you to install a number of dependencies; you
will need to agree to this.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">To prevent creating conflicts with the software that Apple
installs by default, Fink creates its own directory tree at <code class="file docutils literal"><span class="pre">/sw</span></code>
where it installs most of
the software that it installs. This means your libraries and headers
will be at <code class="file docutils literal"><span class="pre">/sw/lib</span></code> and <code class="file docutils literal"><span class="pre">/sw/include</span></code> instead
of <code class="file docutils literal"><span class="pre">/usr/lib</span></code> and <code class="file docutils literal"><span class="pre">/usr/include</span></code>. When the
Perl module config script for the GD module asks where your <code class="file docutils literal"><span class="pre">libgd</span></code>
is, be sure to tell it <code class="file docutils literal"><span class="pre">/sw/lib</span></code>.</p>
</div>
</div>
<div class="section" id="perl-modules">
<span id="macosx-install-perl-modules"></span><h2>3.4.4. Perl Modules<a class="headerlink" href="#perl-modules" title="Permalink to this headline">¶</a></h2>
<p>Bugzilla requires a number of Perl modules. On Mac OS X, the easiest thing to
do is to install local copies (rather than system-wide copies) of any ones
that you don't already have. However, if you do want to install them
system-wide, run the below commands as root with the <strong class="command">--global</strong>
option.</p>
<p>To check whether you have all the required modules and what is still missing,
run:</p>
<p><strong class="command">perl checksetup.pl --check-modules</strong></p>
<p>You can run this command as many times as necessary.</p>
<p>Install all missing modules locally like this:</p>
<p><strong class="command">perl install-module.pl --all</strong></p>
</div>
<div class="section" id="web-server">
<span id="macosx-config-webserver"></span><h2>3.4.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>
<p>You'll need to create a symbolic link so the webserver can see Bugzilla:</p>
<p><strong class="command">cd /Library/WebServer/Documents</strong></p>
<p><strong class="command">sudo ln -s $HOME/bugzilla bugzilla</strong></p>
<p>In <span class="guilabel">System Preferences</span> --> <span class="guilabel">Sharing</span>, enable the
<span class="guilabel">Web Sharing</span> checkbox to start Apache.</p>
</div>
<div class="section" id="database-engine">
<span id="macosx-config-database"></span><h2>3.4.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 on Mac OS X. (In fact, we have no reports of anyone using
anything else.) 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.4.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">perl 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.4.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">perl 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.4.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">perl 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.4. Mac OS X</a><ul>
<li><a class="reference internal" href="#install-packages">3.4.1. Install Packages</a></li>
<li><a class="reference internal" href="#bugzilla">3.4.2. Bugzilla</a></li>
<li><a class="reference internal" href="#additional-system-libraries">3.4.3. Additional System Libraries</a></li>
<li><a class="reference internal" href="#perl-modules">3.4.4. Perl Modules</a></li>
<li><a class="reference internal" href="#web-server">3.4.5. Web Server</a></li>
<li><a class="reference internal" href="#database-engine">3.4.6. Database Engine</a></li>
<li><a class="reference internal" href="#localconfig">3.4.7. localconfig</a></li>
<li><a class="reference internal" href="#checksetup-pl">3.4.8. checksetup.pl</a></li>
<li><a class="reference internal" href="#success">3.4.9. Success</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="windows.html"
title="previous chapter">3.3. Windows</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="web_server.html"
title="next chapter">3.5. Web Server</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="web_server.html" title="3.5. Web Server"
>next</a></li>
<li class="right" >
<a href="windows.html" title="3.3. Windows"
>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>
