← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Robey Pointer
  • Date: 2006-12-24 06:54:21 UTC
  • Revision ID: robey@lag.net-20061224065421-7cgh6xo87h63lfg7
webpage tweaks

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.txt
1
1
LOGGERHEAD
2
2
==========
3
3
 
 
4
[ version 1.0 for bazaar 0.13 ]
 
5
 
4
6
Loggerhead is a web viewer for bazaar branches.  It can be used to navigate
5
7
a branch history, annotate files, perform searches... all the usual things.
6
8
 
14
16
    
15
17
and add the following lines to your apache configuration::
16
18
 
17
 
    <Location "/bzr.dev/">
 
19
    <Location "/branches/">
18
20
        ProxyPass http://127.0.0.1:8080/
19
21
        ProxyPassReverse http://127.0.0.1:8080/
20
22
    </Location>
21
23
    
22
24
The port configuration is in "dev.cfg".
23
25
 
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.
 
26
The config file is "loggerhead.conf".  In there, you can configure projects,
 
27
and branches per project.  The idea is that you could be publishing several
 
28
(possibly unrelated) projects through the same loggerhead instance, and 
 
29
several branches for the same project.
27
30
 
28
31
 
29
32
CACHES
30
33
------
31
34
 
32
 
To speed up most operations, loggerhead will start creating two caches
33
 
when it first launches:
 
35
To speed up most operations, loggerhead will start creating two caches per
 
36
branch when it first launches:
34
37
 
35
38
    - a revision data cache
36
39
    - a text searching cache
40
43
 
41
44
The caches for a branch with 10,000 revisions take about 15 minutes each
42
45
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
or so but usually finish quickly (or instantly) after the initial creation.
 
47
Until the revision cache is built, all operations will be slow.
45
48
 
46
49
You may update the bazaar branch at any time (for example, from a cron).
47
50
Loggerhead will notice and refresh, and bazaar uses its own branch locking