4
[ Version 1.2 for Bazaar 1.2 ]
4
[ Version 1.6 for Bazaar 1.6 ]
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
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
1) SimpleTAL for templating.
16
on ubuntu package `sudo apt-get install python-simpletal`
17
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`
20
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`
23
or use `easy_install PasteDeploy`
25
Then simply run the 'serve-branches' with the branch you want to
26
serve on the command line:
28
./serve-branches ~/path/to/branch
30
The script listens on port 8080 so head to http://localhost:8080/ in
31
your browser to see the branch. You can also pass a directory that
32
contains branches to the script, and it will serve a very simple
33
directory listing at other pages.
35
You may update the Bazaar branches being viewed at any time.
36
Loggerhead will notice and refresh, and Bazaar uses its own branch
37
locking to prevent corruption.
43
Previous versions of Loggerhead read their configuration from a config
44
file. This mode of operation is still supported by the
45
'start-loggerhead' script. A 'loggerhead.conf.example' file is
46
included in the source which has comments explaining the various
15
49
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.
53
This will run loggerhead in the background, listening on port 8080 by
23
56
To stop Loggerhead, run::
25
$ ./stop-loggerhead.py
60
In the configuration file you can configure projects, and branches per
61
project. The idea is that you could be publishing several (possibly
62
unrelated) projects through the same loggerhead instance, and several
63
branches for the same project. See the "loggerhead.conf.example" file
64
included with the source.
66
A debug and access log are stored in the logs/ folder, relative to
67
the location of the start-loggerhead script.
70
SERVING LOGGERHEAD FROM BEHIND APACHE
71
-------------------------------------
27
73
If you want to view Bazaar branches from your existing Apache
28
74
installation, you'll need to configure Apache to proxy certain
34
80
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.
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.
83
If Paste Deploy is installed, the 'serve-branches' script can be
84
run behind a proxy at the root of a site, but if you're running it at
85
some path into the site, you'll need to specify is using '--prefix=/some_path'.
90
To speed up the display of the changelog view for large trees,
91
loggerhead can be configured to cache the files changes between
92
revisions. Set the 'cachepath' value in the config file.
added
removed
README.txt
