~loggerhead-team/loggerhead/trunk-rich

44 by Robey Pointer
better readme
1
LOGGERHEAD
2
==========
3
146.1.5 by Michael Hudson
review comments
4
[ Version 1.2 for Bazaar 1.2 ]
59 by Robey Pointer
add version info to readme
5
146.1.5 by Michael Hudson
review comments
6
Loggerhead is a web viewer for Bazaar branches.  It can be used to
146.1.1 by Michael Hudson
release preparations
7
navigate a branch history, annotate files, perform searches... all the
8
usual things.
44 by Robey Pointer
better readme
9
10
This is a TurboGears (http://www.turbogears.org) project.  It can be
89 by Robey Pointer
fix up dev.cfg so that nobody will ever have to edit it, by letting the
11
started by running::
12
13
    $ ./start-loggerhead.py
146.1.1 by Michael Hudson
release preparations
14
89 by Robey Pointer
fix up dev.cfg so that nobody will ever have to edit it, by letting the
15
This will run loggerhead in the background.  To stop it, run::
16
17
    $ ./stop-loggerhead.py
18
146.1.1 by Michael Hudson
release preparations
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::
44 by Robey Pointer
better readme
21
52 by Robey Pointer
update README
22
    <Location "/branches/">
44 by Robey Pointer
better readme
23
        ProxyPass http://127.0.0.1:8080/
24
        ProxyPassReverse http://127.0.0.1:8080/
25
    </Location>
146.1.1 by Michael Hudson
release preparations
26
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
32
included with the source.
44 by Robey Pointer
better readme
33
89 by Robey Pointer
fix up dev.cfg so that nobody will ever have to edit it, by letting the
34
Don't bother with "dev.cfg" or any of the other TurboGears config files.
35
Loggerhead overrides those values with its own.
36
37
A debug and access log are stored in the logs/ folder.
38
44 by Robey Pointer
better readme
39
40
CACHES
41
------
42
146.1.1 by Michael Hudson
release preparations
43
To speed up operations with large branches, loggerhead can be configured
44
to create three caches per branch when it first launches:
44 by Robey Pointer
better readme
45
46
    - a revision data cache
146.1.1 by Michael Hudson
release preparations
47
    - a cache of files changed in a revision
44 by Robey Pointer
better readme
48
    - a text searching cache
49
146.1.5 by Michael Hudson
review comments
50
You can put the cache folder anywhere.  A folder under the branch's
51
.bzr/ folder is a convenient place.
44 by Robey Pointer
better readme
52
146.1.1 by Michael Hudson
release preparations
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.
44 by Robey Pointer
better readme
58
146.1.5 by Michael Hudson
review comments
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
146.1.1 by Michael Hudson
release preparations
61
locking to prevent corruption.
44 by Robey Pointer
better readme
62
63
64
SUPPORT
65
-------
66
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.