4
[ Version 1.17 for Bazaar 1.17 ]
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
14
Loggerhead depends on:
16
1) SimpleTAL for templating.
17
On Ubuntu, `sudo apt-get install python-simpletal`
18
or download from http://www.owlfish.com/software/simpleTAL/download.html
19
2) simplejson for producing JSON data.
20
On Ubuntu, `sudo apt-get install python-simplejson`
21
or use `easy_install simplejson`.
22
3) Paste for the server. (You need version 1.2 or newer of Paste.)
23
On Ubuntu, `sudo apt-get install python-paste`
24
or use `easy_install Paste`
25
4) Paste Deploy (optional, needed when proxying through Apache)
26
On Ubuntu, `sudo apt-get install python-pastedeploy`
27
or use `easy_install PasteDeploy`
28
5) flup (optional, needed to use FastCGI, SCGI or AJP)
29
On Ubuntu, `sudo apt-get install python-flup`
30
or use `easy_install flup`
32
Then simply run the 'serve-branches' with the branch you want to
33
serve on the command line:
35
./serve-branches ~/path/to/branch
37
The script listens on port 8080 so head to http://localhost:8080/ in
38
your browser to see the branch. You can also pass a directory that
39
contains branches to the script, and it will serve a very simple
40
directory listing at other pages.
42
You may update the Bazaar branches being viewed at any time.
43
Loggerhead will notice and refresh, and Bazaar uses its own branch
44
locking to prevent corruption.
46
To run loggerhead as a linux daemon:
47
1) Copy loggerheadd to /etc/init.d
48
2) Edit the file to configure where your loggerhead is installed, and which
49
serve-branches options you would like.
50
3) Register the service
52
a) on upstart based systems like Ubuntu run:
53
update-rc.d loggerheadd defaults
54
b) on Sysvinit based systems like Centos or SuSE run:
55
chkconfig --add loggerheadd
58
LOGGERHEAD AS A BAZAAR PLUGIN
59
-----------------------------
61
This branch contains experimental support for using Loggerhead as a Bazaar
62
plugin. To use it, place the top-level Loggerhead directory (the one
63
containing this file) at ``~/.bazaar/plugins/loggerhead``.
69
To hide branches from being displayed, add to ``~/.bazaar/locations.conf``,
70
under the branch's section:
76
More configuration options to come soon.
79
SERVING LOGGERHEAD FROM BEHIND APACHE
80
-------------------------------------
82
If you want to view Bazaar branches from your existing Apache
83
installation, you'll need to configure Apache to proxy certain
84
requests to Loggerhead. Adding lines like this to you Apache
85
configuration is one way to do this::
87
<Location "/branches/">
88
ProxyPass http://127.0.0.1:8080/branches/
89
ProxyPassReverse http://127.0.0.1:8080/branches/
92
If Paste Deploy is installed, the 'serve-branches' script can be
93
run behind a proxy at the root of a site, but if you're running it at
94
some path into the site, you'll need to specify is using '--prefix=/some_path'.
100
Search is currently supported by using the bzr-search plugin (available
101
at: ``https://launchpad.net/bzr-search``
102
You need to have the plugin installed and each branch indexed to allow
103
searching on branches.
109
Loggerhead is loosely based on bazaar-webserve, which was loosely
110
based on hgweb. Discussion should take place on the bazaar-dev
111
mailing list at bazaar@lists.canonical.com. You can join the list at
112
<https://lists.ubuntu.com/mailman/listinfo/bazaar>. You don't need to
113
subscribe to post, but your first post will be held briefly for manual
116
Bugs are tracked on Launchpad; start at:
118
https://bugs.launchpad.net/loggerhead
124
To run loggerhead tests, you will need the package python-nose,
125
and run in the loggerhead directory:
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
