← 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 15:44:51 UTC
  • mto: This revision was merged to the branch mainline in revision 405.
  • Revision ID: tseaver@agendaless.com-20100323154451-enjul7pa2crkk18b
Add Sphinx-based documentation.

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