← 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:28:03 UTC
  • mto: This revision was merged to the branch mainline in revision 405.
  • Revision ID: tseaver@agendaless.com-20100325102803-y42pjxwkzbshzjya
Consistent punctuation.

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
25
25
4) Paste Deploy  (optional, needed when proxying through Apache)
26
26
   On Ubuntu, `sudo apt-get install python-pastedeploy`
27
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`
28
31
 
29
32
Then simply run the 'serve-branches' with the branch you want to
30
33
serve on the command line:
40
43
Loggerhead will notice and refresh, and Bazaar uses its own branch
41
44
locking to prevent corruption.
42
45
 
43
 
To run loggerhead as a linux daemon: 
 
46
To run loggerhead as a linux daemon:
44
47
1) Copy loggerheadd to /etc/init.d
45
48
2) Edit the file to configure where your loggerhead is installed, and which
46
49
   serve-branches options you would like.
63
66
USING A CONFIG FILE
64
67
-------------------
65
68
 
66
 
Previous versions of Loggerhead read their configuration from a config
67
 
file.  This mode of operation is still supported by the
68
 
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
69
 
included in the source which has comments explaining the various
70
 
options.
71
 
 
72
 
Loggerhead can then be started by running::
73
 
 
74
 
    $ ./start-loggerhead
75
 
 
76
 
This will run loggerhead in the background, listening on port 8080 by
77
 
default.
78
 
 
79
 
To stop Loggerhead, run::
80
 
 
81
 
    $ ./stop-loggerhead
82
 
 
83
 
In the configuration file you can configure projects, and branches per
84
 
project.  The idea is that you could be publishing several (possibly
85
 
unrelated) projects through the same loggerhead instance, and several
86
 
branches for the same project.  See the "loggerhead.conf.example" file
87
 
included with the source.
88
 
 
89
 
A debug and access log are stored in the logs/ folder, relative to
90
 
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.
91
77
 
92
78
 
93
79
SERVING LOGGERHEAD FROM BEHIND APACHE
107
93
run behind a proxy at the root of a site, but if you're running it at
108
94
some path into the site, you'll need to specify is using '--prefix=/some_path'.
109
95
 
110
 
FILES CHANGED CACHE
111
 
-------------------
112
 
 
113
 
To speed up the display of the changelog view for large trees,
114
 
loggerhead can be configured to cache the files changes between
115
 
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.
116
104
 
117
105
 
118
106
SUPPORT
128
116
Bugs are tracked on Launchpad; start at:
129
117
 
130
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