4
[ Version 1.6 for Bazaar 1.6 ]
4
[ Version 1.17 for Bazaar 1.17 ]
6
6
Loggerhead is a web viewer for Bazaar branches. It can be used to
7
7
navigate a branch history, annotate files, perform searches... all the
14
Loggerhead depends on:
15
16
1) SimpleTAL for templating.
16
on Ubuntu package `sudo apt-get install python-simpletal`
17
On Ubuntu, `sudo apt-get install python-simpletal`
17
18
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`
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`
20
24
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`
25
4) Paste Deploy (optional, needed when proxying through Apache)
26
On Ubuntu, `sudo apt-get install python-pastedeploy`
23
27
or use `easy_install PasteDeploy`
25
29
Then simply run the 'serve-branches' with the branch you want to
36
40
Loggerhead will notice and refresh, and Bazaar uses its own branch
37
41
locking to prevent corruption.
39
To run loggerhead as a linux daemon:
43
To run loggerhead as a linux daemon:
40
44
1) Copy loggerheadd to /etc/init.d
41
45
2) Edit the file to configure where your loggerhead is installed, and which
42
46
serve-branches options you would like.
47
51
b) on Sysvinit based systems like Centos or SuSE run:
48
52
chkconfig --add loggerheadd
55
LOGGERHEAD AS A BAZAAR PLUGIN
56
-----------------------------
58
This branch contains experimental support for using Loggerhead as a Bazaar
59
plugin. To use it, place the top-level Loggerhead directory (the one
60
containing this file) at ``~/.bazaar/plugins/loggerhead``.
50
63
USING A CONFIG FILE
51
64
-------------------
53
Previous versions of Loggerhead read their configuration from a config
54
file. This mode of operation is still supported by the
55
'start-loggerhead' script. A 'loggerhead.conf.example' file is
56
included in the source which has comments explaining the various
59
Loggerhead can then be started by running::
63
This will run loggerhead in the background, listening on port 8080 by
66
To stop Loggerhead, run::
70
In the configuration file you can configure projects, and branches per
71
project. The idea is that you could be publishing several (possibly
72
unrelated) projects through the same loggerhead instance, and several
73
branches for the same project. See the "loggerhead.conf.example" file
74
included with the source.
76
A debug and access log are stored in the logs/ folder, relative to
77
the location of the start-loggerhead script.
66
To hide branches from being displayed, add to ``~/.bazaar/locations.conf``,
67
under the branch's section:
73
More configuration options to come soon.
80
76
SERVING LOGGERHEAD FROM BEHIND APACHE
86
82
configuration is one way to do this::
88
84
<Location "/branches/">
89
ProxyPass http://127.0.0.1:8080/
90
ProxyPassReverse http://127.0.0.1:8080/
85
ProxyPass http://127.0.0.1:8080/branches/
86
ProxyPassReverse http://127.0.0.1:8080/branches/
93
89
If Paste Deploy is installed, the 'serve-branches' script can be
94
90
run behind a proxy at the root of a site, but if you're running it at
95
91
some path into the site, you'll need to specify is using '--prefix=/some_path'.
100
To speed up the display of the changelog view for large trees,
101
loggerhead can be configured to cache the files changes between
102
revisions. Set the 'cachepath' value in the config file.
97
Search is currently supported by using the bzr-search plugin (available
98
at: ``https://launchpad.net/bzr-search``
99
You need to have the plugin installed and each branch indexed to allow
100
searching on branches.
115
112
Bugs are tracked on Launchpad; start at:
117
114
https://bugs.launchpad.net/loggerhead
120
To run loggerhead tests, you will need the package python-nose,
121
and run in the loggerhead directory:
added
removed
README
