1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
Loggerhead: A web viewer for ``bzr`` branches
==============================================
Loggerhead is a web viewer for projects in bazaar. It can be used to navigate
a branch history, annotate files, view patches, perform searches, etc.
Loggerhead is heavily based on `bazaar-webserve
<https://launchpad.net/bzr-webserve>`_, which was, in turn, loosely
based on `hgweb <http://mercurial.selenic.com/wiki/HgWebDirStepByStep>`_.
Getting Started
---------------
Loggerhead depends on the following Python libraries.:
- SimpleTAL for templating.
- simplejson for producing JSON data.
- Paste for the server. (You need version 1.2 or newer of Paste).
- Paste Deploy (optional, needed when proxying through Apache).
- flup (optional, needed to use FastCGI, SCGI or AJP).
Installing Dependencies Using Ubuntu Packages
#############################################
.. code-block:: sh
$ sudo apt-get install python-simpletal
$ sudo apt-get install python-simplejson
$ sudo apt-get install python-paste
$ sudo apt-get install python-pastedeploy
$ sudo apt-get install python-flup
Installing Dependencies Using :command:`easy_install`
#####################################################
.. code-block:: sh
$ easy_install \
-f http://www.owlfish.com/software/simpleTAL/py2compatible/download.html \
SimpleTAL
$ easy_install simplejson
$ easy_install Paste
$ easy_install PasteDeploy
$ easy_install flup
Running the Standalone Loggerhead Server
----------------------------------------
After installing all the dependencies, you should be able to run
:command:`serve-branches` with the branch you want to serve on the
command line:
.. code-block:: sh
./serve-branches ~/path/to/branch
By default, the script listens on port 8080, so head to
http://localhost:8080/ in your browser to see the branch.
You can also pass a directory that contains branches to the script,
and it will serve a very simple directory listing at other pages.
You may update the Bazaar branches being viewed at any time.
Loggerhead will notice and refresh, and Bazaar uses its own branch
locking to prevent corruption.
See :doc:`serve-branches` for all command line options.
Running Loggerhead as a Daemon
------------------------------
To run Loggerhead as a linux daemon:
1) Copy the ``loggerheadd`` scipt to ``/etc/init.d``
.. code-block:: sh
$ sudo cp ./loggerheadd /etc/init.d
2) Edit the file to configure where your Loggerhead is installed, and which
serve-branches options you would like.
.. code-block:: sh
$ sudo vim /etc/init.d/loggerheadd
3) Register the service
.. code-block:: sh
# on upstart based systems like Ubuntu run:
$ sudo update-rc.d loggerheadd defaults
# on Sysvinit based systems like Centos or SuSE run:
$ sudo chkconfig --add loggerheadd
Using Loggerhead as a Bazaar Plugin
------------------------------------
This branch contains experimental support for using Loggerhead as a Bazaar
plugin. To use it, place the top-level Loggerhead directory (the one
containing this file) at ``~/.bazaar/plugins/loggerhead``. E.g.:
.. code-block:: sh
$ bzr branch lp:loggerhead ~/.bazaar/plugins/loggerhead
$ cd ~/myproject
$ bzr serve --http
Using a Config File
-------------------
To hide branches from being displayed, add to ``~/.bazaar/locations.conf``,
under the branch's section:
.. code-block:: ini
[/path/to/branch]
http_serve = False
More configuration options to come soon.
Serving Loggerhead behind Apache
--------------------------------
If you want to view Bazaar branches from your existing Apache
installation, you'll need to configure Apache to proxy certain
requests to Loggerhead. Adding lines like this to you Apache
configuration is one way to do this:
.. code-block:: apache
<Location "/branches/">
ProxyPass http://127.0.0.1:8080/branches/
ProxyPassReverse http://127.0.0.1:8080/branches/
</Location>
If Paste Deploy is installed, the :command:`serve-branches` script can be
run behind a proxy at the root of a site, but if you're running it at
some path into the site, you'll need to specify is using
``--prefix=/some_path``.
Search
------
Search is currently supported by using the bzr-search plugin (available
at: https://launchpad.net/bzr-search ).
You need to have the plugin installed and each branch indexed to allow
searching on branches.
Command-Line Reference
----------------------
.. toctree::
:maxdepth: 2
serve-branches
start-loggerhead
stop-loggerhead
Support
-------
Discussion should take place on the bazaar-dev mailing list at
mailto:bazaar@lists.canonical.com. You can join the list at
<https://lists.ubuntu.com/mailman/listinfo/bazaar>. You don't need to
subscribe to post, but your first post will be held briefly for manual
moderation.
Bugs are tracked on Launchpad; start at:
https://bugs.launchpad.net/loggerhead
Hacking
-------
To run Loggerhead tests, you will need to install the package ``python-nose``,
and run its :command:`nosetests` script in the Loggerhead directory:
.. code-block:: sh
nosetests
License
-------
GNU GPLv2 or later.
See Also
--------
https://launchpad.net/loggerhead
Index
=====
- :ref:`genindex`
|