← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README

  • Committer: Matt Nordhoff
  • Date: 2009-06-26 09:42:43 UTC
  • Revision ID: mnordhoff@mattnordhoff.com-20090626094243-8ia9poyixoj1en6l
Pass around and use argv correctly

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
1
1
LOGGERHEAD
2
2
==========
3
3
 
4
 
[ Version 1.6 for Bazaar 1.6 ]
 
4
[ Version 1.10 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 
 
14
Loggerhead depends on:
 
15
 
15
16
1) SimpleTAL for templating.
16
 
   on ubuntu package `sudo apt-get install python-simpletal`
 
17
   On Ubuntu, `sudo apt-get install python-simpletal`
17
18
   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`
 
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`
20
24
   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`
 
25
4) Paste Deploy  (optional, needed when proxying through Apache)
 
26
   On Ubuntu, `sudo apt-get install python-pastedeploy`
23
27
   or use `easy_install PasteDeploy`
24
28
 
25
29
Then simply run the 'serve-branches' with the branch you want to
36
40
Loggerhead will notice and refresh, and Bazaar uses its own branch
37
41
locking to prevent corruption.
38
42
 
 
43
To run loggerhead as a linux daemon: 
 
44
1) Copy loggerheadd to /etc/init.d
 
45
2) Edit the file to configure where your loggerhead is installed, and which
 
46
   serve-branches options you would like.
 
47
3) Register the service
 
48
   cd /etc/init.d
 
49
   a) on upstart based systems like Ubuntu run: 
 
50
      update-rc.d loggerheadd defaults
 
51
   b) on Sysvinit based systems like Centos or SuSE run:
 
52
      chkconfig --add loggerheadd
 
53
 
 
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
 
39
62
 
40
63
USING A CONFIG FILE
41
64
-------------------
42
65
 
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.
 
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.
68
74
 
69
75
 
70
76
SERVING LOGGERHEAD FROM BEHIND APACHE
76
82
configuration is one way to do this::
77
83
 
78
84
    <Location "/branches/">
79
 
        ProxyPass http://127.0.0.1:8080/
80
 
        ProxyPassReverse http://127.0.0.1:8080/
 
85
        ProxyPass http://127.0.0.1:8080/branches/
 
86
        ProxyPassReverse http://127.0.0.1:8080/branches/
81
87
    </Location>
82
88
 
83
89
If Paste Deploy is installed, the 'serve-branches' script can be
84
90
run behind a proxy at the root of a site, but if you're running it at
85
91
some path into the site, you'll need to specify is using '--prefix=/some_path'.
86
92
 
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
 
 
 
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.
94
101
 
95
102
SUPPORT
96
103
-------