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

« back to all changes in this revision

Viewing changes to doc/man/sample.rst

  • Committer: Matt Giuca
  • Date: 2009-12-08 05:22:45 UTC
  • Revision ID: matt.giuca@gmail.com-20091208052245-04kgsqg1cva40iav
Added a script ivle-loadsampledata.
doc/man/sample: Instructions on using this script to load the sample data into
a fresh installation of IVLE.

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
.. _sample-data:
 
19
 
18
20
***********
19
21
Sample data
20
22
***********
32
34
 
33
35
The data is stored in an SQL dump file, in ``examples/db/sample.sql``.
34
36
 
35
 
You must import this data into a **fresh** IVLE database. You can
36
 
re-initialise your database by running ``sudo -u postgres dropdb ivle``, and
37
 
then following the database setup instructions, in the section
38
 
:ref:`database-setup`.
39
 
 
40
 
The data may be imported by running the following command::
41
 
 
42
 
    sudo -u postgres psql ivle < examples/db/sample.sql
43
 
 
44
 
.. XXX
45
 
.. warning:: Instructions on fixing up the user's repositories and file
46
 
   systems to come.
 
37
You must import this data into a **fresh** IVLE database. If you already have
 
38
a working IVLE install, it will have to be erased. A script is provided
 
39
which performs the following tasks:
 
40
 
 
41
* Unmounts all users with accounts in the current database,
 
42
* Drops the IVLE database if it already exists (prompting first),
 
43
* Creates and initialises a new IVLE database, as per :ref:`database-setup`,
 
44
* Populates the database with the sample data,
 
45
* Creates data directories and subversion repositories for all users, backing
 
46
  up directories for any existing users.
 
47
 
 
48
The script is executed with the following command::
 
49
 
 
50
    sudo ivle-loadsampledata examples/db/sample.sql
 
51
 
 
52
.. warning:: This script essentially destroys all contents in an existing IVLE
 
53
   installation. Be sure you wish to do this.
 
54
 
 
55
.. note:: The script may fail at the "dropping database" phase if Apache or
 
56
   another process are using the database. It is best to stop Apache before
 
57
   executing the script.
 
58
 
 
59
   If the database exists, but is not properly initialised, then the script
 
60
   may fail. In this case, you should manually run ``ivle-mountallusers -u``,
 
61
   then drop the database, to ensure a clean build.
47
62
 
48
63
What is included
49
64
================