← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Launchpad Patch Queue Manager
  • Date: 2008-02-29 04:43:52 UTC
  • mfrom: (146.1.5 release-prep)
  • Revision ID: launchpad@pqm.canonical.com-20080229044352-zoweuygtkq7uwo37
[r=jml] updates to README.txt and NEWS before release

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
[ 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.
 
9
 
 
10
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::
 
21
 
 
22
    <Location "/branches/">
 
23
        ProxyPass http://127.0.0.1:8080/
 
24
        ProxyPassReverse http://127.0.0.1:8080/
 
25
    </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.
 
38
 
 
39
 
 
40
CACHES
 
41
------
 
42
 
 
43
To speed up operations with large branches, loggerhead can be configured
 
44
to create three caches per branch when it first launches:
 
45
 
 
46
    - a revision data cache
 
47
    - a cache of files changed in a revision
 
48
    - a text searching cache
 
49
 
 
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.
 
62
 
 
63
 
 
64
SUPPORT
 
65
-------
 
66
 
 
67
This is loosely based on bazaar-webserve, which was loosely based on hgweb.
 
68
Discussion should take place on the bazaar-dev mailing list.