← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Jelmer Vernooij
  • Date: 2008-08-06 18:33:20 UTC
  • mto: (197.1.9 pathargs)
  • mto: This revision was merged to the branch mainline in revision 202.
  • Revision ID: jelmer@samba.org-20080806183320-6llann0k480dlb9y
add --log-folder option.

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