← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Steve 'Ashcrow' Milner
  • Date: 2008-10-24 02:26:05 UTC
  • mto: This revision was merged to the branch mainline in revision 231.
  • Revision ID: stevem@gnulinux.net-20081024022605-bukahu7dovm7ii6u
Updated to follow pep8.

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