← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Michael Hudson
  • Date: 2008-06-23 02:23:46 UTC
  • mto: This revision was merged to the branch mainline in revision 171.
  • Revision ID: michael.hudson@canonical.com-20080623022346-z8njyfn6q69or4lo
change serve-branches.py to be easier to document :)

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.6 for Bazaar 1.6 ]
 
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
GETTING STARTED
 
11
---------------
 
12
 
 
13
Loggerhead depends on SimpleTAL for templating and Paste for the
 
14
server.  So you need these installed -- on Ubuntu you want the
 
15
'python-simpletal' and 'python-paste' packages installed.  You need
 
16
version 1.2 or newer of Paste.
 
17
 
 
18
Then simply run the 'serve-branches.py' script of loggerhead from the
 
19
directory containing the branches you want to serve.
 
20
 
 
21
For example:
 
22
 
 
23
    XXX
 
24
 
 
25
USING A CONFIG FILE
 
26
-------------------
 
27
 
 
28
Previous versions of Loggerhead read their configuration from a config
 
29
file.  This mode of operation is still supported by the
 
30
'start-loggerhead.py' script.  A 'loggerhead.conf.example' file is
 
31
included in the source which has comments explaining the various
 
32
options.
 
33
 
 
34
Loggerhead can then be started by running::
 
35
 
 
36
    $ ./start-loggerhead.py
 
37
 
 
38
This will run loggerhead in the background.  It listens on port 8080
 
39
by default, so go to http://localhost:8080/ in your browser to see the
 
40
list of bublished branches.
 
41
 
 
42
To stop Loggerhead, run::
 
43
 
 
44
    $ ./stop-loggerhead.py
 
45
 
 
46
In the configuration file you can configure projects, and branches per
 
47
project.  The idea is that you could be publishing several (possibly
 
48
unrelated) projects through the same loggerhead instance, and several
 
49
branches for the same project.  See the "loggerhead.conf.example" file
 
50
included with the source.
 
51
 
 
52
A debug and access log are stored in the logs/ folder, relative to
 
53
the location of the start-loggerhead.py script.
 
54
 
 
55
You may update the Bazaar branch at any time (for example, from a cron).
 
56
Loggerhead will notice and refresh, and Bazaar uses its own branch
 
57
locking to prevent corruption.
 
58
 
 
59
SERVING LOGGERHEAD FROM BEHIND APACHE
 
60
-------------------------------------
 
61
 
 
62
If you want to view Bazaar branches from your existing Apache
 
63
installation, you'll need to configure Apache to proxy certain
 
64
requests to Loggerhead.  Adding lines like this to you Apache
 
65
configuration is one way to do this::
 
66
 
 
67
    <Location "/branches/">
 
68
        ProxyPass http://127.0.0.1:8080/
 
69
        ProxyPassReverse http://127.0.0.1:8080/
 
70
    </Location>
 
71
 
 
72
 
 
73
 
 
74
FILES CHANGED CACHE
 
75
-------------------
 
76
 
 
77
To speed up the display of the changelog view for large trees,
 
78
loggerhead can be configured to cache the files changes between
 
79
revisions.  Set the 'cachepath' value in the config file.
 
80
 
 
81
 
 
82
SUPPORT
 
83
-------
 
84
 
 
85
Loggerhead is loosely based on bazaar-webserve, which was loosely
 
86
based on hgweb.  Discussion should take place on the bazaar-dev
 
87
mailing list at bazaar@lists.canonical.com.  You can join the list at
 
88
<https://lists.ubuntu.com/mailman/listinfo/bazaar>.  You don't need to
 
89
subscribe to post, but your first post will be held briefly for manual
 
90
moderation.
 
91
 
 
92
Bugs are tracked on Launchpad; start at:
 
93
 
 
94
    https://bugs.launchpad.net/loggerhead