~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Robey Pointer
  • Date: 2006-12-23 19:29:05 UTC
  • Revision ID: robey@lag.net-20061223192905-wwzq2hluxta8k5mf
add setup.py info so an sdist tarball can be made

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
LOGGERHEAD
2
2
==========
3
3
 
4
 
[ Version 1.2 for Bazaar 1.2 ]
5
 
 
6
 
Loggerhead is a web viewer for Bazaar branches.  It can be used to
7
 
navigate a branch history, annotate files, perform searches... all the
8
 
usual things.
 
4
Loggerhead is a web viewer for bazaar branches.  It can be used to navigate
 
5
a branch history, annotate files, perform searches... all the usual things.
9
6
 
10
7
This is a TurboGears (http://www.turbogears.org) project.  It can be
11
 
started by running::
12
 
 
13
 
    $ ./start-loggerhead.py
14
 
 
15
 
This will run loggerhead in the background.  To stop it, run::
16
 
 
17
 
    $ ./stop-loggerhead.py
18
 
 
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::
 
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 &
 
14
    
 
15
and add the following lines to your apache configuration::
21
16
 
22
17
    <Location "/branches/">
23
18
        ProxyPass http://127.0.0.1:8080/
24
19
        ProxyPassReverse http://127.0.0.1:8080/
25
20
    </Location>
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.
33
 
 
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.
 
21
    
 
22
The port configuration is in "dev.cfg".
 
23
 
 
24
The config file is "loggerhead.conf".  In there, you can configure projects,
 
25
and branches per project.  The idea is that you could be publishing several
 
26
(possibly unrelated) projects through the same loggerhead instance, and 
 
27
several branches for the same project.
38
28
 
39
29
 
40
30
CACHES
41
31
------
42
32
 
43
 
To speed up operations with large branches, loggerhead can be configured
44
 
to create three caches per branch when it first launches:
 
33
To speed up most operations, loggerhead will start creating two caches per
 
34
branch when it first launches:
45
35
 
46
36
    - a revision data cache
47
 
    - a cache of files changed in a revision
48
37
    - a text searching cache
49
38
 
50
 
You can put the cache folder anywhere.  A folder under the branch's
51
 
.bzr/ folder is a convenient place.
52
 
 
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.
58
 
 
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
61
 
locking to prevent corruption.
 
39
You can put the cache folder anywhere, but I find that a folder under
 
40
the branch's .bzr/ folder is the simplest place.
 
41
 
 
42
The caches for a branch with 10,000 revisions take about 15 minutes each
 
43
on my machine, but YMMV.  Once they are built, they update every six hours
 
44
or so but usually finish quickly (or instantly) after the initial creation.
 
45
Until the revision cache is built, all operations will be slow.
 
46
 
 
47
You may update the bazaar branch at any time (for example, from a cron).
 
48
Loggerhead will notice and refresh, and bazaar uses its own branch locking
 
49
to prevent corruption.
62
50
 
63
51
 
64
52
SUPPORT
66
54
 
67
55
This is loosely based on bazaar-webserve, which was loosely based on hgweb.
68
56
Discussion should take place on the bazaar-dev mailing list.
 
57