~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-07 11:01:50 UTC
  • mfrom: (1341.1.3 trunk)
  • Revision ID: grantw@unimelb.edu.au-20091207110150-jct30a9yru432ddn
Fix up the project set creation UI a bit.

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
   along with this program; if not, write to the Free Software
16
16
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
17
 
18
 
.. _ref-install:
19
 
 
20
18
************
21
19
Installation
22
20
************
28
26
might work too. Debian/Ubuntu package names are given after the name of the
29
27
software.
30
28
 
31
 
.. If this list changes, you also need to change the list below, and
32
 
   the list in bin/ivle-dev-setup.
 
29
.. If this list changes, you also need to change the list below.
33
30
 
34
31
* Ubuntu 8.04 or later (other distros should work with some tweaking, but are untested)
35
32
* Apache 2.x (``apache2``) with modules:
44
41
   + Genshi (``python-genshi``)
45
42
   + psycopg2 (``python-psycopg2``)
46
43
   + pysvn (``python-svn``)
 
44
   + Routes (``python-routes``)
47
45
   + Storm (``python-storm``)
48
46
* jQuery (``libjs-jquery``)
49
47
* PostgreSQL 8.3 or later (``postgresql``)
58
56
Installing from a Debian package
59
57
================================
60
58
 
61
 
.. _database-setup:
62
 
 
63
 
 
64
59
Installing from source
65
60
======================
66
61
 
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 ``admin`` 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.
 
62
.. If this list changes, you also need to change the list above.
145
63
 
146
64
If you want to grab all of the required packages in one command, use::
147
65
 
148
66
    sudo apt-get install apache2 libapache2-mod-python libapache2-svn \
149
67
    python2.6 python-cjson python-configobj python-docutils python-epydoc \
150
 
    python-formencode python-genshi python-psycopg2 python-svn python-storm \
151
 
    libjs-jquery postgresql subversion debootstrap rsync build-essential
 
68
    python-formencode python-genshi python-psycopg2 python-svn python-routes \
 
69
    python-storm libjs-jquery postgresql subversion debootstrap rsync \
 
70
    build-essential
152
71
 
153
72
While installing from a distribution package is often a better idea for
154
73
users, developers will need to install from a plain source tree.
234
153
IVLE makes use of two Apache virtual hosts: one for the application itself,
235
154
and one for the Subversion services. There are example configuration files
236
155
in ``examples/config/apache.conf`` and ``examples/config/apache-svn.conf``,
237
 
which will run IVLE at http://ivle.localhost/.
 
156
which will run IVLE at ``http://ivle.localhost/``.
238
157
 
239
158
On a Debian or Ubuntu system, just copy those two files into
240
159
``/etc/apache2/sites-available`` under appropriate names (eg. ``ivle`` and
286
205
 
287
206
   sudo ivle-adduser --admin -p password username 'Full Name'
288
207
 
289
 
You should then be able to browse to http://ivle.localhost/, and
 
208
You should then be able to browse to ``http://ivle.localhost/``, and
290
209
log in with that username and password.
291
210
 
292
 
*Alternatively*, you may wish to import the IVLE sample data, for a complete
293
 
working IVLE environment (not for production use). See :ref:`sample-data`.
294
 
 
295
211
.. note::
296
212
   For more advanced configuration, see :ref:`Configuring IVLE
297
213
   <ref-configuring-ivle>`.