← 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: 2009-06-25 08:18:02 UTC
  • mto: This revision was merged to the branch mainline in revision 1322.
  • Revision ID: grantw@unimelb.edu.au-20090625081802-g3oh4bv9emfjly53
Add some initial installation docs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/install.rst
55
55
Installing from source
56
56
======================
57
57
 
 
58
While installing from a distribution package is often a better idea for
 
59
users, developers will need to install from a plain source tree.
 
60
 
 
61
To get the tree, either grab and extract a release tarball, or get the
 
62
very latest code using bzr: ::
 
63
 
 
64
   bzr get lp:ivle
 
65
 
 
66
You should then change into the new source directory.
 
67
 
 
68
As IVLE needs to compile some binaries, you must first build, then
 
69
install it: ::
 
70
 
 
71
   ./setup.py build
 
72
   sudo ./setup.py install
 
73
 
 
74
Unlike the package, you will have to manually set up the database and
 
75
configuration.
 
76
 
 
77
.. TODO: Separate IVLE PostgreSQL account.
 
78
 
 
79
First you must create a PostgreSQL database, and populate it with the
 
80
IVLE schema. You may use any name for the database. ::
 
81
 
 
82
   sudo -u postgres createdb ivle
 
83
   sudo -u postgres createlang plpgsql ivle
 
84
   sudo -u postgres psql -d ivle < userdb/users.sql
 
85
 
 
86
The configuration wizard - ``ivle-config`` - will ask you a series of
 
87
questions. Apart from database settings, the defaults should be correct
 
88
for a development system. If deploying IVLE properly - particularly on
 
89
multiple nodes - several options will need to be changed. Watching
 
90
carefully, run: ::
 
91
 
 
92
   sudo ivle-config
 
93
 
 
94
 
58
95
Basic configuration
59
96
===================
60
97
 
61
98
.. Note: Place here only the configuration required to get the system
62
99
   installed and running. Any further configuration should go in config.rst.
63
100
 
 
101
IVLE needs a directory hierarchy in which to store filesystem data, which
 
102
by default lives in ``/var/lib/ivle``. Create it now. ::
 
103
 
 
104
   sudo ivle-createdatadirs
 
105
 
 
106
.. TODO: Setting jail/devmode, jail/suite, jail/extra_packages...
 
107
         We also need to document setting of the default mirror, once
 
108
         issue #150 is fixed.
 
109
 
 
110
You will require a self-contained jail environment in which to safely
 
111
execute student code. The creation process basically downloads a minimal
 
112
Ubuntu system and installs it in ``/var/lib/ivle/jails/__base__``. Note
 
113
that this could download a couple of hundred megabytes. You should
 
114
replace the URL with a good close Ubuntu mirror. ::
 
115
 
 
116
   sudo ivle-buildjail -r -m http://url.to.archive/mirror
 
117
 
64
118
.. note::
65
119
   For more advanced configuration, see :ref:`Configuring IVLE
66
120
   <ref-configuring-ivle>`.