← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to docs/index.rst

[rs=igc] update to lp:loggerhead trunk

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
 
oggerhead is heavily based on `bazaar-webserve
 
6
Loggerhead 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
 
 
97
95
.. code-block:: sh
98
96
 
 
97
   # on upstart based systems like Ubuntu run: 
99
98
   $ sudo update-rc.d loggerheadd defaults
100
99
 
101
 
b) on Sysvinit based systems like Centos or SuSE run:
102
 
 
103
 
.. code-block:: sh
104
 
 
 
100
   # on Sysvinit based systems like Centos or SuSE run:
105
101
   $ sudo chkconfig --add loggerheadd
106
102
 
107
103
 
110
106
 
111
107
This branch contains experimental support for using Loggerhead as a Bazaar
112
108
plugin.  To use it, place the top-level Loggerhead directory (the one
113
 
containing this file) at ``~/.bazaar/plugins/loggerhead``.  E.g.:
 
109
containing COPYING.txt) at ``~/.bazaar/plugins/loggerhead``.  E.g.:
114
110
 
115
111
.. code-block:: sh
116
112
 
133
129
More configuration options to come soon.
134
130
 
135
131
 
136
 
Serving Loggerhead from Behind Apache
137
 
-------------------------------------
 
132
Serving Loggerhead behind Apache
 
133
--------------------------------
138
134
 
139
135
If you want to view Bazaar branches from your existing Apache
140
136
installation, you'll need to configure Apache to proxy certain
141
 
requests to Loggerhead.  Adding lines like this to you Apache
 
137
requests to Loggerhead.  Adding lines like this to your Apache
142
138
configuration is one way to do this:
143
139
 
144
140
.. code-block:: apache
150
146
 
151
147
If Paste Deploy is installed, the :command:`serve-branches` script can be
152
148
run behind a proxy at the root of a site, but if you're running it at
153
 
some path into the site, you'll need to specify is using
 
149
some path into the site, you'll need to specify it using
154
150
``--prefix=/some_path``.
155
151
 
156
152
 
183
179
subscribe to post, but your first post will be held briefly for manual
184
180
moderation.
185
181
 
186
 
Bugs are tracked on Launchpad; start at:
 
182
Bugs, support questions and merge proposals are tracked on Launchpad, e.g:
187
183
 
188
184
    https://bugs.launchpad.net/loggerhead
189
185
 
191
187
Hacking
192
188
-------
193
189
 
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
To run Loggerhead tests, you will need to install the package ``python-nose``,
 
191
and run its :command:`nosetests` script in the Loggerhead directory:
196
192
 
197
193
.. code-block:: sh
198
194