~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Robey Pointer
  • Date: 2006-12-16 01:43:52 UTC
  • Revision ID: robey@lag.net-20061216014352-euf7pthd6ik80p6n
some suggestions from bazaar-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
LOGGERHEAD
2
 
==========
3
 
 
4
 
[ version 1.1.1 for bazaar 0.13 ]
5
 
 
6
 
Loggerhead is a web viewer for bazaar branches.  It can be used to navigate
7
 
a branch history, annotate files, perform searches... all the usual things.
8
 
 
9
 
This is a TurboGears (http://www.turbogears.org) project.  It can be
10
 
started by running::
11
 
 
12
 
    $ ./start-loggerhead.py
13
 
    
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/">
22
 
        ProxyPass http://127.0.0.1:8080/
23
 
        ProxyPassReverse http://127.0.0.1:8080/
24
 
    </Location>
25
 
    
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.
35
 
 
36
 
 
37
 
CACHES
38
 
------
39
 
 
40
 
To speed up most operations, loggerhead will start creating two caches per
41
 
branch when it first launches:
42
 
 
43
 
    - a revision data cache
44
 
    - a text searching cache
45
 
 
46
 
You can put the cache folder anywhere, but I find that a folder under
47
 
the branch's .bzr/ folder is the simplest place.
48
 
 
49
 
The caches for a branch with 10,000 revisions take about 15 minutes each
50
 
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.
53
 
 
54
 
You may update the bazaar branch at any time (for example, from a cron).
55
 
Loggerhead will notice and refresh, and bazaar uses its own branch locking
56
 
to prevent corruption.
57
 
 
58
 
 
59
 
SUPPORT
60
 
-------
61
 
 
62
 
This is loosely based on bazaar-webserve, which was loosely based on hgweb.
63
 
Discussion should take place on the bazaar-dev mailing list.
64
 
 
 
1
loggerhead
 
2
 
 
3
This is a TurboGears (http://www.turbogears.org) project. It can be
 
4
started by running the start-loggerhead.py script.
 
 
b'\\ No newline at end of file'