4
[ Version 1.2 for Bazaar 1.2 ]
4
[ version 1.2 for bazaar 1.2 ]
6
Loggerhead is a web viewer for Bazaar branches. It can be used to
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
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::
10
This is a TurboGears (http://www.turbogears.org) project. It can be
17
13
$ ./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::
15
This will run loggerhead in the background. To stop it, run::
25
17
$ ./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::
19
If you're not familiar with TurboGears, the simplest way to get running
20
is to add the lines like the following to your apache configuration::
32
22
<Location "/branches/">
33
23
ProxyPass http://127.0.0.1:8080/
34
24
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
27
The config file is "loggerhead.conf". In there, you can configure
28
projects, and branches per project. The idea is that you could be
29
publishing several (possibly unrelated) projects through the same
30
loggerhead instance, and several branches for the same project. A
31
commented example of a configuration file is loggerhead.conf.example
41
32
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
34
Don't bother with "dev.cfg" or any of the other TurboGears config files.
35
Loggerhead overrides those values with its own.
37
A debug and access log are stored in the logs/ folder.
43
To speed up operations with large branches, loggerhead can be configured
44
to create three caches per branch when it first launches:
46
- a revision data cache
47
- a cache of files changed in a revision
48
- a text searching cache
50
You can put the cache folder anywhere, but I find that a folder under
51
the branch's .bzr/ folder is the simplest place.
53
The revision data cache and text searching cache will be automatically
54
filled once loggerhead starts up. The caches for a branch with 15,000
55
revisions take about four minutes each on a fairly fast machine, but
56
mileage may vary. Once they are built, they update every six hours or
57
so but usually finish quickly (or instantly) after the initial creation.
59
You may update the bazaar branch at any time (for example, from a cron).
60
Loggerhead will notice and refresh, and bazaar uses its own branch
52
61
locking to prevent corruption.
58
To speed up the display of the changelog view for large trees,
59
loggerhead can be configured to cache the files changes between
60
revisions. Set the 'cachepath' value in the config file.
66
Loggerhead is loosely based on bazaar-webserve, which was loosely
67
based on hgweb. Discussion should take place on the bazaar-dev
68
mailing list at bazaar@lists.canonical.com. You can join the list at
69
<https://lists.ubuntu.com/mailman/listinfo/bazaar>. You don't need to
70
subscribe to post, but your first post will be held briefly for manual
67
This is loosely based on bazaar-webserve, which was loosely based on hgweb.
68
Discussion should take place on the bazaar-dev mailing list.
added
removed
README.txt
