4
[ Version 1.2 for Bazaar 1.2 ]
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
10
To get started, first you need to create a 'loggerhead.conf' file
11
specifying the branches you want to view. A 'loggerhead.conf.example'
12
file is included in the source which has comments explaining the
15
Loggerhead can then be started by running::
17
$ ./start-loggerhead.py
19
This will run loggerhead in the background. It listens on port 8080
20
by default, so go to http://localhost:8080/ in your browser to see the
21
list of bublished branches.
23
To stop Loggerhead, run::
25
$ ./stop-loggerhead.py
27
If you want to view Bazaar branches from your existing Apache
28
installation, you'll need to configure Apache to proxy certain
29
requests to Loggerhead. Adding lines like this to you Apache
30
configuration is one way to do this::
32
<Location "/branches/">
4
Loggerhead is a web viewer for bazaar branches. It can be used to navigate
5
a branch history, annotate files, perform searches... all the usual things.
7
This is a TurboGears (http://www.turbogears.org) project. It can be
8
started by running the 'start-loggerhead.py' script.
10
If you're not familiar with turbogears, the easiest way to get this script
11
started is to run it via::
13
$ nohup ./start-loggerhead.py &
15
and add the following lines to your apache configuration::
17
<Location "/bzr.dev/">
33
18
ProxyPass http://127.0.0.1:8080/
34
19
ProxyPassReverse http://127.0.0.1:8080/
37
In the configuration file you can configure projects, and branches per
38
project. The idea is that you could be publishing several (possibly
39
unrelated) projects through the same loggerhead instance, and several
40
branches for the same project. See the "loggerhead.conf.example" file
41
included with the source.
43
Although Loggerhead is a TurboGears (http://www.turbogears.org)
44
project, don't bother with "dev.cfg" or any of the other TurboGears
45
config files. Loggerhead overrides those values with its own.
47
A debug and access log are stored in the logs/ folder, relative to
48
the location of the start-loggerhead.py script.
50
You may update the Bazaar branch at any time (for example, from a cron).
51
Loggerhead will notice and refresh, and Bazaar uses its own branch
52
locking to prevent corruption.
22
The port configuration is in "dev.cfg".
24
The config file is "loggerhead.conf". Currently it can only serve one
25
branch at a time, but in the future I plan to add support for serving
26
multiple branches at once.
58
To speed up operations with large branches, loggerhead can be configured
59
to create three caches per branch when it first launches:
32
To speed up most operations, loggerhead will start creating two caches
33
when it first launches:
61
35
- a revision data cache
62
- a cache of files changed in a revision
63
36
- a text searching cache
65
You can put the cache folder anywhere.
67
The revision data cache and text searching cache will be automatically
68
filled once loggerhead starts up. The caches for a branch with 15,000
69
revisions take about four minutes each on a fairly fast machine, but
70
mileage may vary. Once they are built, they update every six hours or
71
so but usually finish quickly (or instantly) after the initial creation.
38
You can put the cache folder anywhere, but I find that a folder under
39
the branch's .bzr/ folder is the simplest place.
41
The caches for a branch with 10,000 revisions take about 15 minutes each
42
on my machine, but YMMV. Once they are built, they update every six hours
43
or so but usually finish quickly (or instantly). Until the revision cache
44
is built, all operations will be slow.
46
You may update the bazaar branch at any time (for example, from a cron).
47
Loggerhead will notice and refresh, and bazaar uses its own branch locking
48
to prevent corruption.
77
Loggerhead is loosely based on bazaar-webserve, which was loosely
78
based on hgweb. Discussion should take place on the bazaar-dev
79
mailing list at bazaar@lists.canonical.com. You can join the list at
80
<https://lists.ubuntu.com/mailman/listinfo/bazaar>. You don't need to
81
subscribe to post, but your first post will be held briefly for manual
54
This is loosely based on bazaar-webserve, which was loosely based on hgweb.
55
Discussion should take place on the bazaar-dev mailing list.
added
removed
README.txt
