4
[ Version 1.6 for Bazaar 1.6 ]
4
[ Version 1.2 for Bazaar 1.2 ]
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 SimpleTAL for templating and Paste for the
15
server. So you need these installed -- on Ubuntu you want the
16
'python-simpletal' and 'python-paste' packages installed. You need
17
version 1.2 or newer of Paste.
19
Then simply run the 'serve-branches' with the branch you want to
20
serve on the command line:
22
./serve-branches ~/path/to/branch
24
The script listens on port 8080 so head to http://localhost:8080/ in
25
your browser to see the branch. You can also pass a directory that
26
contains branches to the script, and it will serve a very simple
27
directory listing at other pages.
29
You may update the Bazaar branches being viewed at any time.
30
Loggerhead will notice and refresh, and Bazaar uses its own branch
31
locking to prevent corruption.
37
Previous versions of Loggerhead read their configuration from a config
38
file. This mode of operation is still supported by the
39
'start-loggerhead' script. A 'loggerhead.conf.example' file is
40
included in the source which has comments explaining the various
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
43
15
Loggerhead can then be started by running::
17
$ ./start-loggerhead.py
47
This will run loggerhead in the background, listening on port 8080 by
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.
50
23
To stop Loggerhead, run::
54
In the configuration file you can configure projects, and branches per
55
project. The idea is that you could be publishing several (possibly
56
unrelated) projects through the same loggerhead instance, and several
57
branches for the same project. See the "loggerhead.conf.example" file
58
included with the source.
60
A debug and access log are stored in the logs/ folder, relative to
61
the location of the start-loggerhead script.
64
SERVING LOGGERHEAD FROM BEHIND APACHE
65
-------------------------------------
25
$ ./stop-loggerhead.py
67
27
If you want to view Bazaar branches from your existing Apache
68
28
installation, you'll need to configure Apache to proxy certain
74
34
ProxyPassReverse http://127.0.0.1:8080/
77
If Paste Deploy is installed, the 'serve-branches' script can be
78
run behind a proxy at the root of a site, but if you're running it at
79
some path into the site, you'll need to add a 'prefix' argument to the
80
PrefixMiddleware call in the script. More flexible configuration
81
should be added soon...
87
To speed up the display of the changelog view for large trees,
88
loggerhead can be configured to cache the files changes between
89
revisions. Set the 'cachepath' value in the config file.
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.
58
To speed up operations with large branches, loggerhead can be configured
59
to create three caches per branch when it first launches:
61
- a revision data cache
62
- a cache of files changed in a revision
63
- 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.
added
removed
README.txt
