/usr/share/doc/loggerhead/html/index.html is in loggerhead-doc 1.19~bzr461-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 | <!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>Loggerhead: A web viewer for bzr branches — Loggerhead v1.17 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.17',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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="top" title="Loggerhead v1.17 documentation" href="#" />
<link rel="next" title="serve-branches" href="serve-branches.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="serve-branches.html" title="serve-branches"
accesskey="N">next</a> |</li>
<li><a href="#">Loggerhead v1.17 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="loggerhead-a-web-viewer-for-bzr-branches">
<h1>Loggerhead: A web viewer for <tt class="docutils literal"><span class="pre">bzr</span></tt> branches<a class="headerlink" href="#loggerhead-a-web-viewer-for-bzr-branches" title="Permalink to this headline">¶</a></h1>
<p>Loggerhead is a web viewer for projects in Bazaar. It can be used to navigate
a branch history, annotate files, view patches, perform searches, etc.
Loggerhead is heavily based on <a class="reference external" href="https://launchpad.net/bzr-webserve">bazaar-webserve</a>, which was, in turn, loosely
based on <a class="reference external" href="http://mercurial.selenic.com/wiki/HgWebDirStepByStep">hgweb</a>.</p>
<div class="section" id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
<p>Loggerhead depends on the following Python libraries.:</p>
<ul class="simple">
<li>SimpleTAL for templating.</li>
<li>simplejson for producing JSON data.</li>
<li>Paste for the server. (You need version 1.2 or newer of Paste).</li>
<li>Paste Deploy (optional, needed when proxying through Apache).</li>
<li>flup (optional, needed to use FastCGI, SCGI or AJP).</li>
</ul>
<div class="section" id="installing-dependencies-using-ubuntu-packages">
<h3>Installing Dependencies Using Ubuntu Packages<a class="headerlink" href="#installing-dependencies-using-ubuntu-packages" title="Permalink to this headline">¶</a></h3>
<div class="highlight-sh"><div class="highlight"><pre><span class="nv">$ </span>sudo apt-get install python-simpletal
<span class="nv">$ </span>sudo apt-get install python-simplejson
<span class="nv">$ </span>sudo apt-get install python-paste
<span class="nv">$ </span>sudo apt-get install python-pastedeploy
<span class="nv">$ </span>sudo apt-get install python-flup
</pre></div>
</div>
</div>
<div class="section" id="installing-dependencies-using-easy-install">
<h3>Installing Dependencies Using <strong class="command">easy_install</strong><a class="headerlink" href="#installing-dependencies-using-easy-install" title="Permalink to this headline">¶</a></h3>
<div class="highlight-sh"><div class="highlight"><pre><span class="nv">$ </span>easy_install <span class="se">\</span>
-f http://www.owlfish.com/software/simpleTAL/py2compatible/download.html <span class="se">\</span>
SimpleTAL
<span class="nv">$ </span>easy_install simplejson
<span class="nv">$ </span>easy_install Paste
<span class="nv">$ </span>easy_install PasteDeploy
<span class="nv">$ </span>easy_install flup
</pre></div>
</div>
</div>
</div>
<div class="section" id="running-the-standalone-loggerhead-server">
<h2>Running the Standalone Loggerhead Server<a class="headerlink" href="#running-the-standalone-loggerhead-server" title="Permalink to this headline">¶</a></h2>
<p>After installing all the dependencies, you should be able to run
<strong class="command">serve-branches</strong> with the branch you want to serve on the
command line:</p>
<div class="highlight-sh"><div class="highlight"><pre>./serve-branches ~/path/to/branch
</pre></div>
</div>
<p>By default, the script listens on port 8080, so head to
<a class="reference external" href="http://localhost:8080/">http://localhost:8080/</a> in your browser to see the branch.</p>
<p>You can also pass a directory that contains branches to the script,
and it will serve a very simple directory listing at other pages.</p>
<p>You may update the Bazaar branches being viewed at any time.
Loggerhead will notice and refresh, and Bazaar uses its own branch
locking to prevent corruption.</p>
<p>See <a class="reference internal" href="serve-branches.html"><em>serve-branches</em></a> for all command line options.</p>
</div>
<div class="section" id="running-loggerhead-as-a-daemon">
<h2>Running Loggerhead as a Daemon<a class="headerlink" href="#running-loggerhead-as-a-daemon" title="Permalink to this headline">¶</a></h2>
<p>To run Loggerhead as a linux daemon:</p>
<ol class="arabic simple">
<li>Copy the <tt class="docutils literal"><span class="pre">loggerheadd</span></tt> scipt to <tt class="docutils literal"><span class="pre">/etc/init.d</span></tt></li>
</ol>
<div class="highlight-sh"><div class="highlight"><pre><span class="nv">$ </span>sudo cp ./loggerheadd /etc/init.d
</pre></div>
</div>
<ol class="arabic simple" start="2">
<li>Edit the file to configure where your Loggerhead is installed, and which
serve-branches options you would like.</li>
</ol>
<div class="highlight-sh"><div class="highlight"><pre><span class="nv">$ </span>sudo vim /etc/init.d/loggerheadd
</pre></div>
</div>
<ol class="arabic simple" start="3">
<li>Register the service</li>
</ol>
<div class="highlight-sh"><div class="highlight"><pre><span class="c"># on upstart based systems like Ubuntu run:</span>
<span class="nv">$ </span>sudo update-rc.d loggerheadd defaults
<span class="c"># on Sysvinit based systems like Centos or SuSE run:</span>
<span class="nv">$ </span>sudo chkconfig --add loggerheadd
</pre></div>
</div>
</div>
<div class="section" id="using-loggerhead-as-a-bazaar-plugin">
<h2>Using Loggerhead as a Bazaar Plugin<a class="headerlink" href="#using-loggerhead-as-a-bazaar-plugin" title="Permalink to this headline">¶</a></h2>
<p>This branch contains experimental support for using Loggerhead as a Bazaar
plugin. To use it, place the top-level Loggerhead directory (the one
containing COPYING.txt) at <tt class="docutils literal"><span class="pre">~/.bazaar/plugins/loggerhead</span></tt>. E.g.:</p>
<div class="highlight-sh"><div class="highlight"><pre><span class="nv">$ </span>bzr branch lp:loggerhead ~/.bazaar/plugins/loggerhead
<span class="nv">$ </span><span class="nb">cd</span> ~/myproject
<span class="nv">$ </span>bzr serve --http
</pre></div>
</div>
</div>
<div class="section" id="using-a-config-file">
<h2>Using a Config File<a class="headerlink" href="#using-a-config-file" title="Permalink to this headline">¶</a></h2>
<p>To hide branches from being displayed, add to <tt class="docutils literal"><span class="pre">~/.bazaar/locations.conf</span></tt>,
under the branch’s section:</p>
<div class="highlight-ini"><div class="highlight"><pre><span class="k">[/path/to/branch]</span>
<span class="na">http_serve</span> <span class="o">=</span> <span class="s">False</span>
</pre></div>
</div>
<p>More configuration options to come soon.</p>
</div>
<div class="section" id="serving-loggerhead-behind-apache">
<h2>Serving Loggerhead behind Apache<a class="headerlink" href="#serving-loggerhead-behind-apache" title="Permalink to this headline">¶</a></h2>
<p>If you want to view Bazaar branches from your existing Apache
installation, you’ll need to configure Apache to proxy certain
requests to Loggerhead. Adding lines like this to your Apache
configuration is one way to do this:</p>
<div class="highlight-apache"><div class="highlight"><pre><span class="nt"><Location</span> <span class="s">"/branches/"</span><span class="nt">></span>
<span class="nb">ProxyPass</span> http://127.0.0.1:8080/branches/
<span class="nb">ProxyPassReverse</span> http://127.0.0.1:8080/branches/
<span class="nt"></Location></span>
</pre></div>
</div>
<p>If Paste Deploy is installed, the <strong class="command">serve-branches</strong> script can be
run behind a proxy at the root of a site, but if you’re running it at
some path into the site, you’ll need to specify it using
<tt class="docutils literal"><span class="pre">--prefix=/some_path</span></tt>.</p>
</div>
<div class="section" id="search">
<h2>Search<a class="headerlink" href="#search" title="Permalink to this headline">¶</a></h2>
<p>Search is currently supported by using the bzr-search plugin (available
at: <a class="reference external" href="https://launchpad.net/bzr-search">https://launchpad.net/bzr-search</a> ).</p>
<p>You need to have the plugin installed and each branch indexed to allow
searching on branches.</p>
</div>
<div class="section" id="command-line-reference">
<h2>Command-Line Reference<a class="headerlink" href="#command-line-reference" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="serve-branches.html"><strong class="command">serve-branches</strong></a><ul>
<li class="toctree-l2"><a class="reference internal" href="serve-branches.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="serve-branches.html#options">Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="serve-branches.html#debugging-options">Debugging Options</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="support">
<h2>Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h2>
<p>Discussion should take place on the bazaar-dev mailing list at
<a class="reference external" href="mailto:bazaar%40lists.canonical.com">mailto:bazaar<span>@</span>lists<span>.</span>canonical<span>.</span>com</a>. You can join the list at
<<a class="reference external" href="https://lists.ubuntu.com/mailman/listinfo/bazaar">https://lists.ubuntu.com/mailman/listinfo/bazaar</a>>. You don’t need to
subscribe to post, but your first post will be held briefly for manual
moderation.</p>
<p>Bugs, support questions and merge proposals are tracked on Launchpad, e.g:</p>
<blockquote>
<div><a class="reference external" href="https://bugs.launchpad.net/loggerhead">https://bugs.launchpad.net/loggerhead</a></div></blockquote>
</div>
<div class="section" id="hacking">
<h2>Hacking<a class="headerlink" href="#hacking" title="Permalink to this headline">¶</a></h2>
<p>To run Loggerhead tests, you will need to install the package <tt class="docutils literal"><span class="pre">python-nose</span></tt>,
and run its <strong class="command">nosetests</strong> script in the Loggerhead directory:</p>
<div class="highlight-sh"><div class="highlight"><pre>nosetests
</pre></div>
</div>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p>GNU GPLv2 or later.</p>
</div>
<div class="section" id="see-also">
<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="https://launchpad.net/loggerhead">https://launchpad.net/loggerhead</a></p>
</div>
</div>
<div class="section" id="index">
<h1>Index<a class="headerlink" href="#index" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Loggerhead: A web viewer for <tt class="docutils literal"><span class="pre">bzr</span></tt> branches</a><ul>
<li><a class="reference internal" href="#getting-started">Getting Started</a><ul>
<li><a class="reference internal" href="#installing-dependencies-using-ubuntu-packages">Installing Dependencies Using Ubuntu Packages</a></li>
<li><a class="reference internal" href="#installing-dependencies-using-easy-install">Installing Dependencies Using <strong class="command">easy_install</strong></a></li>
</ul>
</li>
<li><a class="reference internal" href="#running-the-standalone-loggerhead-server">Running the Standalone Loggerhead Server</a></li>
<li><a class="reference internal" href="#running-loggerhead-as-a-daemon">Running Loggerhead as a Daemon</a></li>
<li><a class="reference internal" href="#using-loggerhead-as-a-bazaar-plugin">Using Loggerhead as a Bazaar Plugin</a></li>
<li><a class="reference internal" href="#using-a-config-file">Using a Config File</a></li>
<li><a class="reference internal" href="#serving-loggerhead-behind-apache">Serving Loggerhead behind Apache</a></li>
<li><a class="reference internal" href="#search">Search</a></li>
<li><a class="reference internal" href="#command-line-reference">Command-Line Reference</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#support">Support</a></li>
<li><a class="reference internal" href="#hacking">Hacking</a></li>
<li><a class="reference internal" href="#license">License</a></li>
<li><a class="reference internal" href="#see-also">See Also</a></li>
</ul>
</li>
<li><a class="reference internal" href="#index">Index</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="serve-branches.html"
title="next chapter"><strong class="command">serve-branches</strong></a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="serve-branches.html" title="serve-branches"
>next</a> |</li>
<li><a href="#">Loggerhead v1.17 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, Loggerhead team (https://launchpad.net/~loggerhead-team).
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.
</div>
</body>
</html>
|