← 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-10-17 06:19:40 UTC
  • mto: (329.2.2 trailing-whitespace)
  • mto: This revision was merged to the branch mainline in revision 392.
  • Revision ID: mnordhoff@mattnordhoff.com-20091017061940-w9tcvy0xs1irno3y
Some random PEP 8 and otehr stylistic changes.

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`
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
 
39
 
To run loggerhead as a linux daemon: 
 
43
To run loggerhead as a linux daemon:
40
44
1) Copy loggerheadd to /etc/init.d
41
45
2) Edit the file to configure where your loggerhead is installed, and which
42
46
   serve-branches options you would like.
59
63
USING A CONFIG FILE
60
64
-------------------
61
65
 
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.
 
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.
87
74
 
88
75
 
89
76
SERVING LOGGERHEAD FROM BEHIND APACHE
103
90
run behind a proxy at the root of a site, but if you're running it at
104
91
some path into the site, you'll need to specify is using '--prefix=/some_path'.
105
92
 
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
 
 
 
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.
113
101
 
114
102
SUPPORT
115
103
-------
124
112
Bugs are tracked on Launchpad; start at:
125
113
 
126
114
    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