~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Robey Pointer
  • Date: 2006-12-20 21:17:53 UTC
  • Revision ID: robey@lag.net-20061220211753-tbgl6hlhdvqt2mu4
add top-level page listing available branches.  also a patch from matty to not require external-url in atom feeds any more

Show diffs side-by-side

added added

removed removed

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