← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Jelmer Vernooij
  • Date: 2009-06-02 22:10:00 UTC
  • mto: This revision was merged to the branch mainline in revision 360.
  • Revision ID: jelmer@samba.org-20090602221000-qdrc9hagb5h3w6to
Install the bzr plugin for loggerhead in setup.py.

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
40
40
Loggerhead will notice and refresh, and Bazaar uses its own branch
41
41
locking to prevent corruption.
42
42
 
43
 
To run loggerhead as a linux daemon:
 
43
To run loggerhead as a linux daemon: 
44
44
1) Copy loggerheadd to /etc/init.d
45
45
2) Edit the file to configure where your loggerhead is installed, and which
46
46
   serve-branches options you would like.
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.
101
116
 
102
117
 
103
118
SUPPORT
113
128
Bugs are tracked on Launchpad; start at:
114
129
 
115
130
    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