← 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-03 03:30:38 UTC
  • mto: (359.3.3 hpss-writes)
  • mto: This revision was merged to the branch mainline in revision 362.
  • Revision ID: mnordhoff@mattnordhoff.com-20090603033038-v7rycl4x7ivrxhit
Add an --allow-writes option to serve-branches and "bzr serve"

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
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`
31
28
 
32
29
Then simply run the 'serve-branches' with the branch you want to
33
30
serve on the command line:
43
40
Loggerhead will notice and refresh, and Bazaar uses its own branch
44
41
locking to prevent corruption.
45
42
 
46
 
To run loggerhead as a linux daemon:
 
43
To run loggerhead as a linux daemon: 
47
44
1) Copy loggerheadd to /etc/init.d
48
45
2) Edit the file to configure where your loggerhead is installed, and which
49
46
   serve-branches options you would like.
66
63
USING A CONFIG FILE
67
64
-------------------
68
65
 
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.
 
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.
77
91
 
78
92
 
79
93
SERVING LOGGERHEAD FROM BEHIND APACHE
93
107
run behind a proxy at the root of a site, but if you're running it at
94
108
some path into the site, you'll need to specify is using '--prefix=/some_path'.
95
109
 
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.
 
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.
104
116
 
105
117
 
106
118
SUPPORT
116
128
Bugs are tracked on Launchpad; start at:
117
129
 
118
130
    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