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`
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`
25
32
Then simply run the 'serve-branches' with the branch you want to
26
33
serve on the command line:
36
43
Loggerhead will notice and refresh, and Bazaar uses its own branch
37
44
locking to prevent corruption.
39
To run loggerhead as a linux daemon:
46
To run loggerhead as a linux daemon:
40
47
1) Copy loggerheadd to /etc/init.d
41
48
2) Edit the file to configure where your loggerhead is installed, and which
42
49
serve-branches options you would like.
59
66
USING A CONFIG FILE
60
67
-------------------
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.
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.
89
79
SERVING LOGGERHEAD FROM BEHIND APACHE
103
93
run behind a proxy at the root of a site, but if you're running it at
104
94
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.
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.
124
116
Bugs are tracked on Launchpad; start at:
126
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: