← 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
 
1
loggerhead:  A web viewer for ``bzr`` branches
2
2
==============================================
3
3
 
4
 
Loggerhead is a web viewer for projects in Bazaar. It can be used to navigate 
 
4
Loggerhead is a web viewer for projects in bazaar. It can be used to navigate 
5
5
a branch history, annotate files, view patches, perform searches, etc.
6
 
Loggerhead is heavily based on `bazaar-webserve
7
 
<https://launchpad.net/bzr-webserve>`_, which was, in turn, loosely
8
 
based on `hgweb <http://mercurial.selenic.com/wiki/HgWebDirStepByStep>`_.
9
 
 
 
6
It is heavily based on ``bazaar-webserve``, which is itself based on ``hgweb``
 
7
for Mercurial.
10
8
 
11
9
Getting Started
12
10
---------------
17
15
 
18
16
- simplejson for producing JSON data.
19
17
 
20
 
- Paste for the server. (You need version 1.2 or newer of Paste).
21
 
 
22
 
- Paste Deploy  (optional, needed when proxying through Apache).
23
 
 
24
 
- flup (optional, needed to use FastCGI, SCGI or AJP).
 
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)
25
23
 
26
24
 
27
25
Installing Dependencies Using Ubuntu Packages
75
73
Running Loggerhead as a Daemon
76
74
------------------------------
77
75
 
78
 
To run Loggerhead as a linux daemon:
 
76
To run loggerhead as a linux daemon:
79
77
 
80
78
1) Copy the ``loggerheadd`` scipt to ``/etc/init.d``
81
79
 
83
81
 
84
82
   $ sudo cp ./loggerheadd /etc/init.d
85
83
 
86
 
2) Edit the file to configure where your Loggerhead is installed, and which
 
84
2) Edit the file to configure where your loggerhead is installed, and which
87
85
   serve-branches options you would like.
88
86
 
89
87
.. code-block:: sh
92
90
 
93
91
3) Register the service
94
92
 
 
93
a) on upstart based systems like Ubuntu run: 
 
94
 
95
95
.. code-block:: sh
96
96
 
97
 
   # on upstart based systems like Ubuntu run: 
98
97
   $ sudo update-rc.d loggerheadd defaults
99
98
 
100
 
   # on Sysvinit based systems like Centos or SuSE run:
 
99
b) on Sysvinit based systems like Centos or SuSE run:
 
100
 
 
101
.. code-block:: sh
 
102
 
101
103
   $ sudo chkconfig --add loggerheadd
102
104
 
103
105
 
106
108
 
107
109
This branch contains experimental support for using Loggerhead as a Bazaar
108
110
plugin.  To use it, place the top-level Loggerhead directory (the one
109
 
containing COPYING.txt) at ``~/.bazaar/plugins/loggerhead``.  E.g.:
110
 
 
111
 
.. code-block:: sh
112
 
 
113
 
   $ bzr branch lp:loggerhead ~/.bazaar/plugins/loggerhead
114
 
   $ cd ~/myproject
115
 
   $ bzr serve --http
 
111
containing this file) at ``~/.bazaar/plugins/loggerhead``.
116
112
 
117
113
 
118
114
Using a Config File
129
125
More configuration options to come soon.
130
126
 
131
127
 
132
 
Serving Loggerhead behind Apache
133
 
--------------------------------
 
128
Serving Loggerhead from Behind Apache
 
129
-------------------------------------
134
130
 
135
131
If you want to view Bazaar branches from your existing Apache
136
132
installation, you'll need to configure Apache to proxy certain
137
 
requests to Loggerhead.  Adding lines like this to your Apache
 
133
requests to Loggerhead.  Adding lines like this to you Apache
138
134
configuration is one way to do this:
139
135
 
140
136
.. code-block:: apache
146
142
 
147
143
If Paste Deploy is installed, the :command:`serve-branches` script can be
148
144
run behind a proxy at the root of a site, but if you're running it at
149
 
some path into the site, you'll need to specify it using
 
145
some path into the site, you'll need to specify is using
150
146
``--prefix=/some_path``.
151
147
 
152
148
 
159
155
You need to have the plugin installed and each branch indexed to allow
160
156
searching on branches.
161
157
 
162
 
Command-Line Reference
163
 
----------------------
 
158
Contents:
164
159
 
165
160
.. toctree::
166
161
   :maxdepth: 2
173
168
Support
174
169
-------
175
170
 
176
 
Discussion should take place on the bazaar-dev mailing list at
177
 
mailto:bazaar@lists.canonical.com.  You can join the list at
 
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
178
174
<https://lists.ubuntu.com/mailman/listinfo/bazaar>.  You don't need to
179
175
subscribe to post, but your first post will be held briefly for manual
180
176
moderation.
181
177
 
182
 
Bugs, support questions and merge proposals are tracked on Launchpad, e.g:
 
178
Bugs are tracked on Launchpad; start at:
183
179
 
184
180
    https://bugs.launchpad.net/loggerhead
185
181
 
187
183
Hacking
188
184
-------
189
185
 
190
 
To run Loggerhead tests, you will need to install the package ``python-nose``,
191
 
and run its :command:`nosetests` script in the Loggerhead directory:
 
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:
192
188
 
193
189
.. code-block:: sh
194
190
 
205
201
 
206
202
https://launchpad.net/loggerhead
207
203
 
208
 
Index
209
 
=====
210
 
 
211
 
- :ref:`genindex`
 
204
Indices and tables
 
205
==================
 
206
 
 
207
* :ref:`genindex`
 
208
* :ref:`modindex`
 
209
* :ref:`search`
 
210