~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Robey Pointer
  • Date: 2006-12-20 00:43:10 UTC
  • Revision ID: robey@lag.net-20061220004310-8twtvx7mtt48d75z
add footer banners for bazaar and loggerhead, and slightly improve the config
file docs.

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
 
 
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
 
9
7
This is a TurboGears (http://www.turbogears.org) project.  It can be
10
 
started by running::
11
 
 
12
 
    $ ./start-loggerhead.py
 
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 &
13
14
    
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/">
 
15
and add the following lines to your apache configuration::
 
16
 
 
17
    <Location "/bzr.dev/">
22
18
        ProxyPass http://127.0.0.1:8080/
23
19
        ProxyPassReverse http://127.0.0.1:8080/
24
20
    </Location>
25
21
    
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.
 
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.
35
27
 
36
28
 
37
29
CACHES
38
30
------
39
31
 
40
 
To speed up most operations, loggerhead will start creating two caches per
41
 
branch when it first launches:
 
32
To speed up most operations, loggerhead will start creating two caches
 
33
when it first launches:
42
34
 
43
35
    - a revision data cache
44
36
    - a text searching cache
48
40
 
49
41
The caches for a branch with 10,000 revisions take about 15 minutes each
50
42
on my machine, but YMMV.  Once they are built, they update every six hours
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.
 
43
or so but usually finish quickly (or instantly).  Until the revision cache
 
44
is built, all operations will be slow.
53
45
 
54
46
You may update the bazaar branch at any time (for example, from a cron).
55
47
Loggerhead will notice and refresh, and bazaar uses its own branch locking