← 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-12-14 04:48:13 UTC
  • Revision ID: me@williamgrant.id.au-20091214044813-dvsp4zc5rmsmplwq
Update installation docs to prefer use of ivle-dev-setup.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/install.rst
28
28
might work too. Debian/Ubuntu package names are given after the name of the
29
29
software.
30
30
 
31
 
.. If this list changes, you also need to change the list below.
 
31
.. If this list changes, you also need to change the list below, and
 
32
   the list in bin/ivle-dev-setup.
32
33
 
33
34
* Ubuntu 8.04 or later (other distros should work with some tweaking, but are untested)
34
35
* Apache 2.x (``apache2``) with modules:
59
60
 
60
61
.. _database-setup:
61
62
 
 
63
 
62
64
Installing from source
63
65
======================
64
66
 
65
 
.. If this list changes, you also need to change the list above.
 
67
When setting up a development IVLE environment on Ubuntu 9.04 or later,
 
68
there are scripts to automate most of the process. First get and extract
 
69
a release, or check out the latest code from the bzr branch: ::
 
70
 
 
71
   bzr get lp:ivle
 
72
 
 
73
This will create a new directory, ``ivle``, containing a pristine
 
74
source tree. The remaining steps assume that you are in this new
 
75
directory.
 
76
 
 
77
The ``ivle-dev-setup`` script will configure PostgreSQL, Apache, IVLE
 
78
and the filesystem to cooperate, getting you most of the way to a
 
79
working system in just one step: ::
 
80
 
 
81
   bin/ivle-dev-setup
 
82
 
 
83
.. warning::
 
84
   This reconfigures parts of your system, and has the potential to
 
85
   break other applications using Apache or PostgreSQL. It may also
 
86
   fail to execute if you have existing incompatible configurations
 
87
   of those services.
 
88
   
 
89
 
 
90
This may take a few minutes, and will ask you to confirm installation
 
91
of the dependency packages.
 
92
 
 
93
Upon completion, you must build a self-contained jail in which to run
 
94
untrusted user code. ``ivle-dev-setup`` will have configured most of
 
95
the necessary settings, but you may wish to use a local Ubuntu mirror
 
96
to improve speed or minimise download costs. If you don't wish to use
 
97
a special mirror, you may omit the first step. ::
 
98
 
 
99
   sudo ivle-config --jail/mirror http://url.to.mirror/ubuntu
 
100
   sudo ivle-buildjail -r
 
101
 
 
102
.. warning::
 
103
   ``ivle-buildjail`` will download a large volume of package data --
 
104
   potentially some hundreds of megabytes.
 
105
 
 
106
``ivle-buildjail`` will download, unpack and install a minimal Ubuntu
 
107
system and configure it for IVLE usage. This could take a while.
 
108
 
 
109
Once the jail has been successfully built, IVLE is up and running,
 
110
but with no user accounts or other data in place. For development
 
111
or demonstration purposes, sample data (including fictitious users,
 
112
subjects, and projects) can be loaded.
 
113
 
 
114
For other environments, it may be more appropriate to start with an
 
115
empty database and just create users as required.
 
116
 
 
117
To load the sample data: ::
 
118
 
 
119
   sudo ivle-loadsampledata examples/db/sample.sql
 
120
 
 
121
.. warning::
 
122
   If you answer 'yes' to the ``ivle-loadsampledata`` prompt, any
 
123
   existing data in your IVLE database will be **permanently
 
124
   destroyed**.
 
125
 
 
126
... or to add a new admin user: ::
 
127
 
 
128
   sudo ivle-adduser --admin -p password username 'Full Name'
 
129
 
 
130
You should then be able to browse to http://ivle.localhost/, and
 
131
log in with username ``alice`` and password ``password``, or the
 
132
username and password that you gave to ``ivle-adduser``.
 
133
 
 
134
 
 
135
Manual steps
 
136
------------
 
137
 
 
138
If the automatic installation scripts do not work, or if you want more
 
139
control over the whole process, these manual steps are probably for
 
140
you. But you need not read this section at all if you were able to log
 
141
in after following the steps above.
 
142
 
 
143
.. If this list changes, you also need to change the list above, and
 
144
   the command in bin/ivle-dev-setup.
66
145
 
67
146
If you want to grab all of the required packages in one command, use::
68
147
 
155
234
IVLE makes use of two Apache virtual hosts: one for the application itself,
156
235
and one for the Subversion services. There are example configuration files
157
236
in ``examples/config/apache.conf`` and ``examples/config/apache-svn.conf``,
158
 
which will run IVLE at ``http://ivle.localhost/``.
 
237
which will run IVLE at http://ivle.localhost/.
159
238
 
160
239
On a Debian or Ubuntu system, just copy those two files into
161
240
``/etc/apache2/sites-available`` under appropriate names (eg. ``ivle`` and
207
286
 
208
287
   sudo ivle-adduser --admin -p password username 'Full Name'
209
288
 
210
 
You should then be able to browse to ``http://ivle.localhost/``, and
 
289
You should then be able to browse to http://ivle.localhost/, and
211
290
log in with that username and password.
212
291
 
213
292
*Alternatively*, you may wish to import the IVLE sample data, for a complete