← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to doc/man/install.rst

  • Committer: William Grant
  • Date: 2010-02-26 04:05:57 UTC
  • Revision ID: grantw@unimelb.edu.au-20100226040557-xttf63vmxjs1oh8v
Shuffle all of the manual instructions one layer deeper, into the 'Manual steps' section.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/install.rst
82
82
 
83
83
When setting up a development IVLE environment on Ubuntu 9.04 or later,
84
84
there are scripts to automate most of the process. First get and extract
85
 
a release, or check out the latest code from the bzr branch: ::
 
85
`a release tarball <https://launchpad.net/ivle/+download>`, or check out
 
86
the latest code from the Bazaar branch: ::
86
87
 
87
88
   bzr get lp:ivle
88
89
 
90
91
source tree. The remaining steps assume that you are in this new
91
92
directory.
92
93
 
 
94
 
 
95
Automated setup
 
96
---------------
 
97
 
93
98
The ``ivle-dev-setup`` script will configure PostgreSQL, Apache, IVLE
94
99
and the filesystem to cooperate, getting you most of the way to a
95
100
working system in just one step: ::
166
171
    python-formencode python-genshi python-psycopg2 python-svn python-storm \
167
172
    libjs-jquery postgresql subversion debootstrap rsync build-essential
168
173
 
169
 
While installing from a distribution package is often a better idea for
170
 
users, developers will need to install from a plain source tree.
171
 
 
172
 
To get the tree, either grab and extract a release tarball, or get the
173
 
very latest code using bzr: ::
174
 
 
175
 
   bzr get lp:ivle
176
 
 
177
 
You should then change into the new source directory.
178
 
 
179
174
As IVLE needs to compile some binaries, you must first build, then
180
 
install it: ::
 
175
install it. From the source directory created earlier: ::
181
176
 
182
177
   ./setup.py build
183
178
   sudo ./setup.py install
184
179
 
185
 
Unlike the package, you will have to manually set up the database and
186
 
configuration.
 
180
 
 
181
Setting up the database
 
182
~~~~~~~~~~~~~~~~~~~~~~~
187
183
 
188
184
First, it is recommended that you create a separate database user for IVLE.
189
185
You may use any name for the user. ::
208
204
   sudo ivle-config
209
205
 
210
206
 
211
 
Basic configuration
212
 
===================
213
 
 
214
 
.. Note: Place here only the configuration required to get the system
215
 
   installed and running. Any further configuration should go in config.rst.
 
207
Creating the data tree
 
208
~~~~~~~~~~~~~~~~~~~~~~
216
209
 
217
210
IVLE needs a directory hierarchy in which to store filesystem data, which
218
211
by default lives in ``/var/lib/ivle``. Create it now. ::
221
214
 
222
215
 
223
216
Configuring the jail environment
224
 
--------------------------------
 
217
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
225
218
 
226
219
You will require a self-contained jail environment in which to safely
227
220
execute student code. 
244
237
 
245
238
   sudo ivle-buildjail -r
246
239
 
 
240
 
247
241
Configuring Apache
248
 
------------------
 
242
~~~~~~~~~~~~~~~~~~
249
243
 
250
244
IVLE makes use of two Apache virtual hosts: one for the application itself,
251
245
and one for the Subversion services. There are example configuration files
262
256
 
263
257
 
264
258
Configuring hostname resolution
265
 
--------------------------------
 
259
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
266
260
 
267
261
All of IVLE's hostnames need to be resolvable from the local system. For a
268
262
production environment, this would be done in DNS. For a development system,
281
275
 
282
276
 
283
277
Configuring the user management server
284
 
--------------------------------------
 
278
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
285
279
 
286
280
You need to have the IVLE user management server (``usrmgt-server``) running
287
281
for many parts of IVLE to operate properly, so it should be configured to
295
289
 
296
290
 
297
291
Creating the initial user
298
 
-------------------------
 
292
~~~~~~~~~~~~~~~~~~~~~~~~~
299
293
 
300
294
The final step in getting a usable IVLE set up is creating a user. You'll
301
295
probably want admin privileges - if not, drop the ``--admin``. ::