← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README

  • Committer: Tres Seaver
  • Date: 2010-03-25 10:25:13 UTC
  • mto: This revision was merged to the branch mainline in revision 405.
  • Revision ID: tseaver@agendaless.com-20100325102513-imvok1jbu36cxg0t
Use 'Loggerhead' as the display name;  fix typos.

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.17 for Bazaar 1.17 ]
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`
 
28
5) flup (optional, needed to use FastCGI, SCGI or AJP)
 
29
   On Ubuntu, `sudo apt-get install python-flup`
 
30
   or use `easy_install flup`
24
31
 
25
32
Then simply run the 'serve-branches' with the branch you want to
26
33
serve on the command line:
36
43
Loggerhead will notice and refresh, and Bazaar uses its own branch
37
44
locking to prevent corruption.
38
45
 
39
 
To run loggerhead as a linux daemon: 
 
46
To run loggerhead as a linux daemon:
40
47
1) Copy loggerheadd to /etc/init.d
41
48
2) Edit the file to configure where your loggerhead is installed, and which
42
49
   serve-branches options you would like.
47
54
   b) on Sysvinit based systems like Centos or SuSE run:
48
55
      chkconfig --add loggerheadd
49
56
 
 
57
 
 
58
LOGGERHEAD AS A BAZAAR PLUGIN
 
59
-----------------------------
 
60
 
 
61
This branch contains experimental support for using Loggerhead as a Bazaar
 
62
plugin.  To use it, place the top-level Loggerhead directory (the one
 
63
containing this file) at ``~/.bazaar/plugins/loggerhead``.
 
64
 
 
65
 
50
66
USING A CONFIG FILE
51
67
-------------------
52
68
 
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.
 
69
To hide branches from being displayed, add to ``~/.bazaar/locations.conf``,
 
70
under the branch's section:
 
71
 
 
72
    [/path/to/branch]
 
73
    http_serve = False
 
74
 
 
75
 
 
76
More configuration options to come soon.
78
77
 
79
78
 
80
79
SERVING LOGGERHEAD FROM BEHIND APACHE
86
85
configuration is one way to do this::
87
86
 
88
87
    <Location "/branches/">
89
 
        ProxyPass http://127.0.0.1:8080/
90
 
        ProxyPassReverse http://127.0.0.1:8080/
 
88
        ProxyPass http://127.0.0.1:8080/branches/
 
89
        ProxyPassReverse http://127.0.0.1:8080/branches/
91
90
    </Location>
92
91
 
93
92
If Paste Deploy is installed, the 'serve-branches' script can be
94
93
run behind a proxy at the root of a site, but if you're running it at
95
94
some path into the site, you'll need to specify is using '--prefix=/some_path'.
96
95
 
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.
 
96
 
 
97
SEARCH
 
98
------
 
99
 
 
100
Search is currently supported by using the bzr-search plugin (available
 
101
at: ``https://launchpad.net/bzr-search``
 
102
You need to have the plugin installed and each branch indexed to allow
 
103
searching on branches.
103
104
 
104
105
 
105
106
SUPPORT
115
116
Bugs are tracked on Launchpad; start at:
116
117
 
117
118
    https://bugs.launchpad.net/loggerhead
 
119
 
 
120
 
 
121
HACKING
 
122
-------
 
123
 
 
124
To run loggerhead tests, you will need the package python-nose,
 
125
and run in the loggerhead directory:
 
126
 
 
127
    nosetests