← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Michael Hudson
  • Date: 2008-09-24 04:52:40 UTC
  • mto: (217.1.9 logging)
  • mto: This revision was merged to the branch mainline in revision 226.
  • Revision ID: michael.hudson@canonical.com-20080924045240-9vut19xgxid7txcr
whitespace, style, typos

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.txt
1
1
LOGGERHEAD
2
2
==========
3
3
 
4
 
[ Version 1.17 for Bazaar 1.17 ]
 
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
40
36
Loggerhead will notice and refresh, and Bazaar uses its own branch
41
37
locking to prevent corruption.
42
38
 
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
 
 
62
39
 
63
40
USING A CONFIG FILE
64
41
-------------------
65
42
 
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.
 
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.
74
68
 
75
69
 
76
70
SERVING LOGGERHEAD FROM BEHIND APACHE
82
76
configuration is one way to do this::
83
77
 
84
78
    <Location "/branches/">
85
 
        ProxyPass http://127.0.0.1:8080/branches/
86
 
        ProxyPassReverse http://127.0.0.1:8080/branches/
 
79
        ProxyPass http://127.0.0.1:8080/
 
80
        ProxyPassReverse http://127.0.0.1:8080/
87
81
    </Location>
88
82
 
89
83
If Paste Deploy is installed, the 'serve-branches' script can be
90
84
run behind a proxy at the root of a site, but if you're running it at
91
85
some path into the site, you'll need to specify is using '--prefix=/some_path'.
92
86
 
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.
 
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.
101
93
 
102
94
 
103
95
SUPPORT
113
105
Bugs are tracked on Launchpad; start at:
114
106
 
115
107
    https://bugs.launchpad.net/loggerhead
116
 
 
117
 
 
118
 
HACKING
119
 
-------
120
 
 
121
 
To run loggerhead tests, you will need the package python-nose,
122
 
and run in the loggerhead directory:
123
 
 
124
 
    nosetests