4
[ Version 1.6 for Bazaar 1.6 ]
6
Loggerhead is a web viewer for Bazaar branches. It can be used to
7
navigate a branch history, annotate files, perform searches... all the
15
1) SimpleTAL for templating.
16
on Ubuntu package `sudo apt-get install python-simpletal`
17
or download from http://www.owlfish.com/software/simpleTAL/download.html
18
2) Paste for the server. (You need version 1.2 or newer of Paste.)
19
on Ubuntu package `sudo apt-get install python-paste`
20
or use `easy_install Paste`
21
3) Paste Deploy (optional, needed when proxying through Apache)
22
on Ubuntu package `sudo apt-get install python-pastedeploy`
23
or use `easy_install PasteDeploy`
25
Then simply run the 'serve-branches' with the branch you want to
26
serve on the command line:
28
./serve-branches ~/path/to/branch
30
The script listens on port 8080 so head to http://localhost:8080/ in
31
your browser to see the branch. You can also pass a directory that
32
contains branches to the script, and it will serve a very simple
33
directory listing at other pages.
35
You may update the Bazaar branches being viewed at any time.
36
Loggerhead will notice and refresh, and Bazaar uses its own branch
37
locking to prevent corruption.
39
To run loggerhead as a linux daemon:
40
1) Copy loggerheadd to /etc/init.d
41
2) Edit the file to configure where your loggerhead is installed, and which
42
serve-branches options you would like.
43
3) Register the service
45
a) on upstart based systems like Ubuntu run:
46
update-rc.d loggerheadd defaults
47
b) on Sysvinit based systems like Centos or SuSE run:
48
chkconfig --add loggerheadd
51
LOGGERHEAD AS A BAZAAR PLUGIN
52
-----------------------------
54
This branch contains experimental support for using Loggerhead as a Bazaar
55
plugin. To use it, place the top-level Loggerhead directory (the one
56
containing this file) at ``~/.bazaar/plugins/loggerhead``.
62
Previous versions of Loggerhead read their configuration from a config
63
file. This mode of operation is still supported by the
64
'start-loggerhead' script. A 'loggerhead.conf.example' file is
65
included in the source which has comments explaining the various
68
Loggerhead can then be started by running::
72
This will run loggerhead in the background, listening on port 8080 by
75
To stop Loggerhead, run::
79
In the configuration file you can configure projects, and branches per
80
project. The idea is that you could be publishing several (possibly
81
unrelated) projects through the same loggerhead instance, and several
82
branches for the same project. See the "loggerhead.conf.example" file
83
included with the source.
85
A debug and access log are stored in the logs/ folder, relative to
86
the location of the start-loggerhead script.
89
SERVING LOGGERHEAD FROM BEHIND APACHE
90
-------------------------------------
92
If you want to view Bazaar branches from your existing Apache
93
installation, you'll need to configure Apache to proxy certain
94
requests to Loggerhead. Adding lines like this to you Apache
95
configuration is one way to do this::
97
<Location "/branches/">
98
ProxyPass http://127.0.0.1:8080/branches/
99
ProxyPassReverse http://127.0.0.1:8080/branches/
102
If Paste Deploy is installed, the 'serve-branches' script can be
103
run behind a proxy at the root of a site, but if you're running it at
104
some path into the site, you'll need to specify is using '--prefix=/some_path'.
109
To speed up the display of the changelog view for large trees,
110
loggerhead can be configured to cache the files changes between
111
revisions. Set the 'cachepath' value in the config file.
117
Loggerhead is loosely based on bazaar-webserve, which was loosely
118
based on hgweb. Discussion should take place on the bazaar-dev
119
mailing list at bazaar@lists.canonical.com. You can join the list at
120
<https://lists.ubuntu.com/mailman/listinfo/bazaar>. You don't need to
121
subscribe to post, but your first post will be held briefly for manual
124
Bugs are tracked on Launchpad; start at:
126
https://bugs.launchpad.net/loggerhead
7
Loggerhead is a web viewer for Bazaar branches. Its lets users do
10
* navigate through branch history
11
* view the files in a given revision
12
* annotate files (i.e. find out the origin of each line of a file)
19
See docs/index.rst for installation instructions and basic
26
This software is (C) Copyright Canonical Limited 2006-10 under the
27
GPL Version 2 or later. Please see the file COPYING.txt for the
added
removed
README
