← Back to branch summary

~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:
README.txt
1
 
Loggerhead
 
1
LOGGERHEAD
2
2
==========
3
3
 
4
 
Overview
5
 
--------
6
 
 
7
 
Loggerhead is a web viewer for Bazaar branches. Its lets users do
8
 
stuff like:
9
 
 
10
 
* navigate through branch history
11
 
* view the files in a given revision
12
 
* annotate files (i.e. find out the origin of each line of a file)
13
 
* perform searches.
14
 
 
15
 
 
16
 
Documentation
17
 
-------------
18
 
 
19
 
See docs/index.rst for installation instructions and basic
20
 
documentation.
21
 
 
22
 
 
23
 
Licensing
24
 
---------
25
 
 
26
 
This software is (C) Copyright Canonical Limited 2006-10 under the
27
 
GPL Version 2 or later. Please see the file COPYING.txt for the
28
 
licence details.
 
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.
 
6
 
 
7
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 &
 
14
    
 
15
and add the following lines to your apache configuration::
 
16
 
 
17
    <Location "/bzr.dev/">
 
18
        ProxyPass http://127.0.0.1:8080/
 
19
        ProxyPassReverse http://127.0.0.1:8080/
 
20
    </Location>
 
21
    
 
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.
 
27
 
 
28
 
 
29
CACHES
 
30
------
 
31
 
 
32
To speed up most operations, loggerhead will start creating two caches
 
33
when it first launches:
 
34
 
 
35
    - a revision data cache
 
36
    - a text searching cache
 
37
 
 
38
You can put the cache folder anywhere, but I find that a folder under
 
39
the branch's .bzr/ folder is the simplest place.
 
40
 
 
41
The caches for a branch with 10,000 revisions take about 15 minutes each
 
42
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.
 
45
 
 
46
You may update the bazaar branch at any time (for example, from a cron).
 
47
Loggerhead will notice and refresh, and bazaar uses its own branch locking
 
48
to prevent corruption.
 
49
 
 
50
 
 
51
SUPPORT
 
52
-------
 
53
 
 
54
This is loosely based on bazaar-webserve, which was loosely based on hgweb.
 
55
Discussion should take place on the bazaar-dev mailing list.
 
56