← 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
9
9
Getting Started
10
10
---------------
11
11
 
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:
 
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:
36
56
 
37
57
.. code-block:: sh
38
58
 
39
59
    ./serve-branches ~/path/to/branch
40
60
 
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.
 
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.
45
66
 
46
67
You may update the Bazaar branches being viewed at any time.
47
68
Loggerhead will notice and refresh, and Bazaar uses its own branch
48
69
locking to prevent corruption.
49
70
 
 
71
See :doc:`serve-branches` for all command line options.
 
72
 
 
73
Running Loggerhead as a Daemon
 
74
------------------------------
 
75
 
50
76
To run loggerhead as a linux daemon:
51
77
 
52
 
1) Copy loggerheadd to ``/etc/init.d``
 
78
1) Copy the ``loggerheadd`` scipt to ``/etc/init.d``
 
79
 
 
80
.. code-block:: sh
 
81
 
 
82
   $ sudo cp ./loggerheadd /etc/init.d
53
83
 
54
84
2) Edit the file to configure where your loggerhead is installed, and which
55
85
   serve-branches options you would like.
56
86
 
 
87
.. code-block:: sh
 
88
 
 
89
   $ sudo vim /etc/init.d/loggerheadd
 
90
 
57
91
3) Register the service
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
 
-----------------------------
 
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
------------------------------------
69
108
 
70
109
This branch contains experimental support for using Loggerhead as a Bazaar
71
110
plugin.  To use it, place the top-level Loggerhead directory (the one
83
122
    [/path/to/branch]
84
123
    http_serve = False
85
124
 
86
 
 
87
125
More configuration options to come soon.
88
126
 
89
127
 
112
150
------
113
151
 
114
152
Search is currently supported by using the bzr-search plugin (available
115
 
at: ``https://launchpad.net/bzr-search``
 
153
at: https://launchpad.net/bzr-search ).
 
154
 
116
155
You need to have the plugin installed and each branch indexed to allow
117
156
searching on branches.
118
157
 
 
158
Contents:
 
159
 
 
160
.. toctree::
 
161
   :maxdepth: 2
 
162
 
 
163
   serve-branches
 
164
   start-loggerhead
 
165
   stop-loggerhead
 
166
 
119
167
 
120
168
Support
121
169
-------
135
183
Hacking
136
184
-------
137
185
 
138
 
To run loggerhead tests, you will need the package python-nose,
139
 
and run 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:
140
188
 
141
189
.. code-block:: sh
142
190
 
143
191
    nosetests
144
192
 
 
193
 
145
194
License
146
195
-------
147
196
 
152
201
 
153
202
https://launchpad.net/loggerhead
154
203
 
155
 
Contents:
156
 
 
157
 
.. toctree::
158
 
   :maxdepth: 2
159
 
 
160
 
   serve-branches
161
 
   start-loggerhead
162
 
   stop-loggerhead
163
 
 
164
204
Indices and tables
165
205
==================
166
206