~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

merge jamesh's fix for bug 89854: on error, report an error instead of
trying to redirect to a safe page.  there's no guaranteed safe page.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
LOGGERHEAD
2
2
==========
3
3
 
 
4
[ version 1.1.1 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
 
7
9
This is a TurboGears (http://www.turbogears.org) project.  It can be
8
 
started by running the 'start-loggerhead.py' script.
9
 
 
10
 
If you're not familiar with turbogears, the easiest way to get this script
11
 
started is to run it via::
12
 
 
13
 
    $ nohup ./start-loggerhead.py &
 
10
started by running::
 
11
 
 
12
    $ ./start-loggerhead.py
14
13
    
15
 
and add the following lines to your apache configuration::
16
 
 
17
 
    <Location "/bzr.dev/">
 
14
This will run loggerhead in the background.  To stop it, run::
 
15
 
 
16
    $ ./stop-loggerhead.py
 
17
 
 
18
If you're not familiar with TurboGears, the simplest way to get running is
 
19
to add the following lines to your apache configuration::
 
20
 
 
21
    <Location "/branches/">
18
22
        ProxyPass http://127.0.0.1:8080/
19
23
        ProxyPassReverse http://127.0.0.1:8080/
20
24
    </Location>
21
25
    
22
 
The port configuration is in "dev.cfg".
23
 
 
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.
 
30
 
 
31
Don't bother with "dev.cfg" or any of the other TurboGears config files.
 
32
Loggerhead overrides those values with its own.
 
33
 
 
34
A debug and access log are stored in the logs/ folder.
27
35
 
28
36
 
29
37
CACHES
30
38
------
31
39
 
32
 
To speed up most operations, loggerhead will start creating two caches
33
 
when it first launches:
 
40
To speed up most operations, loggerhead will start creating two caches per
 
41
branch when it first launches:
34
42
 
35
43
    - a revision data cache
36
44
    - a text searching cache
40
48
 
41
49
The caches for a branch with 10,000 revisions take about 15 minutes each
42
50
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.
 
51
or so but usually finish quickly (or instantly) after the initial creation.
 
52
Until the revision cache is built, all operations will be slow.
45
53
 
46
54
You may update the bazaar branch at any time (for example, from a cron).
47
55
Loggerhead will notice and refresh, and bazaar uses its own branch locking