~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Michael Hudson
  • Date: 2009-03-01 17:47:52 UTC
  • mfrom: (283.1.1 bug-329668)
  • Revision ID: michael.hudson@canonical.com-20090301174752-vpp55v8c3fwyjwmc
fix bug #329668 ("Inventory page uses "//" in links")

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
LOGGERHEAD
2
2
==========
3
3
 
4
 
[ Version 1.10 for Bazaar 1.6 ]
 
4
[ Version 1.6 for Bazaar 1.6 ]
5
5
 
6
6
Loggerhead is a web viewer for Bazaar branches.  It can be used to
7
7
navigate a branch history, annotate files, perform searches... all the
11
11
GETTING STARTED
12
12
---------------
13
13
 
14
 
Loggerhead depends on:
15
 
 
 
14
Loggerhead depends on 
16
15
1) SimpleTAL for templating.
17
 
   On Ubuntu, `sudo apt-get install python-simpletal`
 
16
   on Ubuntu package `sudo apt-get install python-simpletal`
18
17
   or download from http://www.owlfish.com/software/simpleTAL/download.html
19
 
2) simplejson for producing JSON data.
20
 
   On Ubuntu, `sudo apt-get install python-simplejson`
21
 
   or use `easy_install simplejson`.
22
 
3) Paste for the server. (You need version 1.2 or newer of Paste.)
23
 
   On Ubuntu, `sudo apt-get install python-paste`
 
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`
24
20
   or use `easy_install Paste`
25
 
4) Paste Deploy  (optional, needed when proxying through Apache)
26
 
   On Ubuntu, `sudo apt-get install python-pastedeploy`
 
21
3) Paste Deploy  (optional, needed when proxying through Apache)
 
22
   on Ubuntu package `sudo apt-get install python-pastedeploy`
27
23
   or use `easy_install PasteDeploy`
28
24
 
29
25
Then simply run the 'serve-branches' with the branch you want to
51
47
   b) on Sysvinit based systems like Centos or SuSE run:
52
48
      chkconfig --add loggerheadd
53
49
 
54
 
 
55
 
LOGGERHEAD AS A BAZAAR PLUGIN
56
 
-----------------------------
57
 
 
58
 
This branch contains experimental support for using Loggerhead as a Bazaar
59
 
plugin.  To use it, place the top-level Loggerhead directory (the one
60
 
containing this file) at ``~/.bazaar/plugins/loggerhead``.
61
 
 
62
 
 
63
50
USING A CONFIG FILE
64
51
-------------------
65
52
 
66
 
To hide branches from being displayed, add to ``~/.bazaar/locations.conf``,
67
 
under the branch's section:
68
 
 
69
 
    [/path/to/branch]
70
 
    http_serve = False
71
 
 
72
 
 
73
 
More configuration options to come soon.
 
53
Previous versions of Loggerhead read their configuration from a config
 
54
file.  This mode of operation is still supported by the
 
55
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
 
56
included in the source which has comments explaining the various
 
57
options.
 
58
 
 
59
Loggerhead can then be started by running::
 
60
 
 
61
    $ ./start-loggerhead
 
62
 
 
63
This will run loggerhead in the background, listening on port 8080 by
 
64
default.
 
65
 
 
66
To stop Loggerhead, run::
 
67
 
 
68
    $ ./stop-loggerhead
 
69
 
 
70
In the configuration file you can configure projects, and branches per
 
71
project.  The idea is that you could be publishing several (possibly
 
72
unrelated) projects through the same loggerhead instance, and several
 
73
branches for the same project.  See the "loggerhead.conf.example" file
 
74
included with the source.
 
75
 
 
76
A debug and access log are stored in the logs/ folder, relative to
 
77
the location of the start-loggerhead script.
74
78
 
75
79
 
76
80
SERVING LOGGERHEAD FROM BEHIND APACHE
90
94
run behind a proxy at the root of a site, but if you're running it at
91
95
some path into the site, you'll need to specify is using '--prefix=/some_path'.
92
96
 
93
 
 
94
 
SEARCH
95
 
------
96
 
 
97
 
Search is currently supported by using the bzr-search plugin (available
98
 
at: ``https://launchpad.net/bzr-search``
99
 
You need to have the plugin installed and each branch indexed to allow
100
 
searching on branches.
 
97
FILES CHANGED CACHE
 
98
-------------------
 
99
 
 
100
To speed up the display of the changelog view for large trees,
 
101
loggerhead can be configured to cache the files changes between
 
102
revisions.  Set the 'cachepath' value in the config file.
 
103
 
101
104
 
102
105
SUPPORT
103
106
-------