← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Matt Nordhoff
  • Date: 2009-06-06 12:23:11 UTC
  • mto: This revision was merged to the branch mainline in revision 366.
  • Revision ID: mnordhoff@mattnordhoff.com-20090606122311-j3w680xd2w8g0qif
Syntax (whitespace) tweak

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.txt
1
1
LOGGERHEAD
2
2
==========
3
3
 
4
 
[ Version 1.10 for Bazaar 1.6 ]
 
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
63
63
USING A CONFIG FILE
64
64
-------------------
65
65
 
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.
 
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.
74
91
 
75
92
 
76
93
SERVING LOGGERHEAD FROM BEHIND APACHE
90
107
run behind a proxy at the root of a site, but if you're running it at
91
108
some path into the site, you'll need to specify is using '--prefix=/some_path'.
92
109
 
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.
 
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.
 
116
 
101
117
 
102
118
SUPPORT
103
119
-------