← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README

  • Committer: razamatan
  • Date: 2011-02-17 19:51:25 UTC
  • mto: This revision was merged to the branch mainline in revision 431.
  • Revision ID: razamatan@retral.net-20110217195125-hy625rem0zwx6mnw
explicit favicons

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
1
 
LOGGERHEAD
 
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.
9
 
 
10
 
To get started, first you need to create a 'loggerhead.conf' file
11
 
specifying the branches you want to view.  A 'loggerhead.conf.example'
12
 
file is included in the source which has comments explaining the
13
 
various options.
14
 
 
15
 
Loggerhead can then be started by running::
16
 
 
17
 
    $ ./start-loggerhead.py
18
 
 
19
 
This will run loggerhead in the background.  It listens on port 8080
20
 
by default, so go to http://localhost:8080/ in your browser to see the
21
 
list of bublished branches.
22
 
 
23
 
To stop Loggerhead, run::
24
 
 
25
 
    $ ./stop-loggerhead.py
26
 
 
27
 
If you want to view Bazaar branches from your existing Apache
28
 
installation, you'll need to configure Apache to proxy certain
29
 
requests to Loggerhead.  Adding lines like this to you Apache
30
 
configuration is one way to do this::
31
 
 
32
 
    <Location "/branches/">
33
 
        ProxyPass http://127.0.0.1:8080/
34
 
        ProxyPassReverse http://127.0.0.1:8080/
35
 
    </Location>
36
 
 
37
 
In the configuration file you can configure projects, and branches per
38
 
project.  The idea is that you could be publishing several (possibly
39
 
unrelated) projects through the same loggerhead instance, and several
40
 
branches for the same project.  See the "loggerhead.conf.example" file
41
 
included with the source.
42
 
 
43
 
Although Loggerhead is a TurboGears (http://www.turbogears.org)
44
 
project, don't bother with "dev.cfg" or any of the other TurboGears
45
 
config files.  Loggerhead overrides those values with its own.
46
 
 
47
 
A debug and access log are stored in the logs/ folder, relative to
48
 
the location of the start-loggerhead.py script.
49
 
 
50
 
You may update the Bazaar branch at any time (for example, from a cron).
51
 
Loggerhead will notice and refresh, and Bazaar uses its own branch
52
 
locking to prevent corruption.
53
 
 
54
 
 
55
 
CACHES
56
 
------
57
 
 
58
 
To speed up operations with large branches, loggerhead can be configured
59
 
to create three caches per branch when it first launches:
60
 
 
61
 
    - a revision data cache
62
 
    - a cache of files changed in a revision
63
 
    - a text searching cache
64
 
 
65
 
You can put the cache folder anywhere.
66
 
 
67
 
The revision data cache and text searching cache will be automatically
68
 
filled once loggerhead starts up.  The caches for a branch with 15,000
69
 
revisions take about four minutes each on a fairly fast machine, but
70
 
mileage may vary.  Once they are built, they update every six hours or
71
 
so but usually finish quickly (or instantly) after the initial creation.
72
 
 
73
 
 
74
 
SUPPORT
75
 
-------
76
 
 
77
 
Loggerhead is loosely based on bazaar-webserve, which was loosely
78
 
based on hgweb.  Discussion should take place on the bazaar-dev
79
 
mailing list at bazaar@lists.canonical.com.  You can join the list at
80
 
<https://lists.ubuntu.com/mailman/listinfo/bazaar>.  You don't need to
81
 
subscribe to post, but your first post will be held briefly for manual
82
 
moderation.
83
 
 
 
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.