← 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 20:10:58 UTC
  • mto: This revision was merged to the branch mainline in revision 405.
  • Revision ID: tseaver@agendaless.com-20100323201058-mv2i3dgyx2mha8qd
Better section title.

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
 
6
oggerhead is heavily based on `bazaar-webserve
7
7
<https://launchpad.net/bzr-webserve>`_, which was, in turn, loosely
8
8
based on `hgweb <http://mercurial.selenic.com/wiki/HgWebDirStepByStep>`_.
9
9
 
17
17
 
18
18
- simplejson for producing JSON data.
19
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).
 
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
25
 
26
26
 
27
27
Installing Dependencies Using Ubuntu Packages
75
75
Running Loggerhead as a Daemon
76
76
------------------------------
77
77
 
78
 
To run Loggerhead as a linux daemon:
 
78
To run loggerhead as a linux daemon:
79
79
 
80
80
1) Copy the ``loggerheadd`` scipt to ``/etc/init.d``
81
81
 
83
83
 
84
84
   $ sudo cp ./loggerheadd /etc/init.d
85
85
 
86
 
2) Edit the file to configure where your Loggerhead is installed, and which
 
86
2) Edit the file to configure where your loggerhead is installed, and which
87
87
   serve-branches options you would like.
88
88
 
89
89
.. code-block:: sh
92
92
 
93
93
3) Register the service
94
94
 
 
95
a) on upstart based systems like Ubuntu run: 
 
96
 
95
97
.. code-block:: sh
96
98
 
97
 
   # on upstart based systems like Ubuntu run: 
98
99
   $ sudo update-rc.d loggerheadd defaults
99
100
 
100
 
   # on Sysvinit based systems like Centos or SuSE run:
 
101
b) on Sysvinit based systems like Centos or SuSE run:
 
102
 
 
103
.. code-block:: sh
 
104
 
101
105
   $ sudo chkconfig --add loggerheadd
102
106
 
103
107
 
106
110
 
107
111
This branch contains experimental support for using Loggerhead as a Bazaar
108
112
plugin.  To use it, place the top-level Loggerhead directory (the one
109
 
containing COPYING.txt) at ``~/.bazaar/plugins/loggerhead``.  E.g.:
 
113
containing this file) at ``~/.bazaar/plugins/loggerhead``.  E.g.:
110
114
 
111
115
.. code-block:: sh
112
116
 
129
133
More configuration options to come soon.
130
134
 
131
135
 
132
 
Serving Loggerhead behind Apache
133
 
--------------------------------
 
136
Serving Loggerhead from Behind Apache
 
137
-------------------------------------
134
138
 
135
139
If you want to view Bazaar branches from your existing Apache
136
140
installation, you'll need to configure Apache to proxy certain
137
 
requests to Loggerhead.  Adding lines like this to your Apache
 
141
requests to Loggerhead.  Adding lines like this to you Apache
138
142
configuration is one way to do this:
139
143
 
140
144
.. code-block:: apache
146
150
 
147
151
If Paste Deploy is installed, the :command:`serve-branches` script can be
148
152
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
 
153
some path into the site, you'll need to specify is using
150
154
``--prefix=/some_path``.
151
155
 
152
156
 
166
170
   :maxdepth: 2
167
171
 
168
172
   serve-branches
 
173
   start-loggerhead
 
174
   stop-loggerhead
169
175
 
170
176
 
171
177
Support
177
183
subscribe to post, but your first post will be held briefly for manual
178
184
moderation.
179
185
 
180
 
Bugs, support questions and merge proposals are tracked on Launchpad, e.g:
 
186
Bugs are tracked on Launchpad; start at:
181
187
 
182
188
    https://bugs.launchpad.net/loggerhead
183
189
 
185
191
Hacking
186
192
-------
187
193
 
188
 
To run Loggerhead tests, you will need to install the package ``python-nose``,
189
 
and run its :command:`nosetests` script in the Loggerhead directory:
 
194
To run loggerhead tests, you will need to install the package ``python-nose``,
 
195
and run its :command:`nosetests` script in the loggerhead directory:
190
196
 
191
197
.. code-block:: sh
192
198