← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to docs/index.rst

  • Committer: Tres Seaver
  • Date: 2010-03-23 19:54:47 UTC
  • mto: This revision was merged to the branch mainline in revision 405.
  • Revision ID: tseaver@agendaless.com-20100323195447-sfo0bjbqgpzca1na
ReST fixups, better cross-references.

Show diffs side-by-side

added added

removed removed

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