← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Martin Pool
  • Date: 2009-01-23 22:36:38 UTC
  • mto: This revision was merged to the branch mainline in revision 298.
  • Revision ID: mbp@sourcefrog.net-20090123223638-s57mqtpu4um3stes
Act as a plugin only when loaded by bzr; update docs

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:
 
39
To run loggerhead as a linux daemon: 
44
40
1) Copy loggerheadd to /etc/init.d
45
41
2) Edit the file to configure where your loggerhead is installed, and which
46
42
   serve-branches options you would like.
63
59
USING A CONFIG FILE
64
60
-------------------
65
61
 
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.
 
62
Previous versions of Loggerhead read their configuration from a config
 
63
file.  This mode of operation is still supported by the
 
64
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
 
65
included in the source which has comments explaining the various
 
66
options.
 
67
 
 
68
Loggerhead can then be started by running::
 
69
 
 
70
    $ ./start-loggerhead
 
71
 
 
72
This will run loggerhead in the background, listening on port 8080 by
 
73
default.
 
74
 
 
75
To stop Loggerhead, run::
 
76
 
 
77
    $ ./stop-loggerhead
 
78
 
 
79
In the configuration file you can configure projects, and branches per
 
80
project.  The idea is that you could be publishing several (possibly
 
81
unrelated) projects through the same loggerhead instance, and several
 
82
branches for the same project.  See the "loggerhead.conf.example" file
 
83
included with the source.
 
84
 
 
85
A debug and access log are stored in the logs/ folder, relative to
 
86
the location of the start-loggerhead script.
74
87
 
75
88
 
76
89
SERVING LOGGERHEAD FROM BEHIND APACHE
82
95
configuration is one way to do this::
83
96
 
84
97
    <Location "/branches/">
85
 
        ProxyPass http://127.0.0.1:8080/branches/
86
 
        ProxyPassReverse http://127.0.0.1:8080/branches/
 
98
        ProxyPass http://127.0.0.1:8080/
 
99
        ProxyPassReverse http://127.0.0.1:8080/
87
100
    </Location>
88
101
 
89
102
If Paste Deploy is installed, the 'serve-branches' script can be
90
103
run behind a proxy at the root of a site, but if you're running it at
91
104
some path into the site, you'll need to specify is using '--prefix=/some_path'.
92
105
 
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.
 
106
FILES CHANGED CACHE
 
107
-------------------
 
108
 
 
109
To speed up the display of the changelog view for large trees,
 
110
loggerhead can be configured to cache the files changes between
 
111
revisions.  Set the 'cachepath' value in the config file.
 
112
 
101
113
 
102
114
SUPPORT
103
115
-------
112
124
Bugs are tracked on Launchpad; start at:
113
125
 
114
126
    https://bugs.launchpad.net/loggerhead
115
 
 
116
 
 
117
 
HACKING
118
 
-------
119
 
 
120
 
To run loggerhead tests, you will need the package python-nose,
121
 
and run in the loggerhead directory:
122
 
 
123
 
    nosetests
124