1
.. IVLE - Informatics Virtual Learning Environment
2
Copyright (C) 2007-2009 The University of Melbourne
4
.. This program is free software; you can redistribute it and/or modify
5
it under the terms of the GNU General Public License as published by
6
the Free Software Foundation; either version 2 of the License, or
7
(at your option) any later version.
9
.. This program is distributed in the hope that it will be useful,
10
but WITHOUT ANY WARRANTY; without even the implied warranty of
11
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
GNU General Public License for more details.
14
.. You should have received a copy of the GNU General Public License
15
along with this program; if not, write to the Free Software
16
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
.. _ref-admin-scripts:
24
IVLE has a number of Admin scripts to configure IVLE or for functionality not
25
directly in the web application.
27
Most of these script are required to be run as root.
32
.. program:: ivle-addexercise
34
:program:`ivle-addexercise <EXERCISE>`
36
Adds an XML encoded exercise to the IVLE database.
38
.. cmdoption:: <EXERCISE>
40
The XML file containing the exercise to be uploaded.
45
.. program:: ivle-adduser
47
:program:`ivle-adduser [OPTIONS] <LOGIN> <FULLNAME>`
49
Script to create a new user.
51
.. FIXME: "This can also be done through the administration interface."
54
This script wraps common.makeuser. It also creates a unix account which
55
common.makeuser does not. (This script may not be appropriate for production
56
on a multi-node environment)
58
.. cmdoption:: <LOGIN>
60
The login name of the new user
62
.. cmdoption:: <FULLNAME>
64
The full name of the user
66
.. cmdoption:: -p <PASSWORD>, --password <PASSWORD>
70
.. cmdoption:: -n <NICK>, --nick <NICK>
72
Display name (defaults to <FULLNAME>)
74
.. cmdoption:: -e <EMAIL>, --email <EMAIL>
78
.. cmdoption:: -s <SID>, --studentid <SID>
82
.. cmdoption:: --admin
84
Give the user full administrative privileges
90
.. program:: ivle-buildjail
92
:program:`ivle-buildjail [OPTIONS]`
94
.. cmdoption:: -r, --recreate
96
Completely recreate the jail - don't just update its IVLE code.
100
This may download hundreds of megabytes from the location specified by
103
.. cmdoption:: -u, --upgrade
105
Apply any package updates in the jail.
107
.. cmdoption:: -m <MIRROR>, --mirror <MIRROR>
115
.. program:: ivle-cloneworksheets
117
:program:`ivle-cloneworksheets <OLDSUBJECTCODE> <OLDYEAR> <OLDSEMESTER>
118
<NEWSUBJECTCODE> <NEWYEAR> <NEWSEMESTER>`
120
Populates the subject specified by ``<NEWSUBJECTCODE> <NEWYEAR>
121
<NEWSEMESTER>`` with a copy of the worksheets from the subject specified by
122
``<OLDSUBJECTCODE> <OLDYEAR> <OLDSEMESTER>``.
128
.. program:: ivle-config
130
:program:`ivle-config [ARG1] [ARG2] ...`
132
Configures IVLE with machine-specific details, most notably, various paths.
133
Either prompts the administrator for these details or accepts them as
136
Command-line arguments may be any of the :ref:`configuration option
137
<ref-configuration-options>` used in :file:`ivle.conf`. They are provided in
138
the form of :samp:`--{section}/{subsection}/{property} {VALUE}` such as
139
``--urls/root ivle.org`` or ``--media/externals/jquery
140
/usr/share/javascript/jquery``.
142
Automatically creates the file :file:`/etc/ivle.conf`.
148
.. program:: ivle-createdatadirs
150
:program:`ivle-createdatadirs`
152
Creates an IVLE data hierarchy if it does not already exist.
158
.. program:: ivle-enrol
160
:program:`ivle-enrol <LOGIN> <SUBJECTCODE> <YEAR> <SEMESTER> [ROLE]`
162
Script to enrol a user in an offering.
164
.. cmdoption:: <LOGIN>
166
The login of the user to enrol.
168
.. cmdoption:: <SUBJECTCODE>
170
The subject code of the offering.
172
.. cmdoption:: <YEAR>
174
The year of the offering.
176
.. cmdoption:: <SEMESTER>
178
The semester of the offering
180
.. cmdoption:: [ROLE]
182
Set the role of the user. Should be one of 'student' (default), 'tutor' or
189
.. program:: ivle-enrolallusers
191
:program:`ivle-enrolallusers`
193
Script to add enrolments for all users on the system.
194
Pulls from the configured :ref:`subject pulldown module
195
<ref-subject-pulldown-modules>` the subjects each student
196
is enrolled in, and adds enrolments to the database.
197
Does not remove any enrolments.
199
Requires root to run.
201
.. cmdoption:: -u <LOGIN>, --user <LOGIN>
203
Just perform enrolment for user ``<LOGIN>``
205
.. cmdoption:: -v, --verbose
207
Print out the details of each enrolment.
209
.. cmdoption:: -y, --year
211
If specified, year to make enrolments for (default is the current year)
214
ivle-fetchsubmissions
215
---------------------
217
.. program:: ivle-fetchsubmissions
219
:program:`ivle-fetchsubmissions [OPTIONS] <SUBJECT> <PROJECTNAME>`
221
Retrieves all submissions for a given project. Places each submission in its
222
own directory, in a subdirectory of '.'. Any errors are reported to stderr
223
(otherwise is silent).
225
Requires root to run.
227
.. cmdoption:: <SUBJECT>
229
The short name given to the subject
231
.. cmdoption:: <PROJECTNAME>
233
The name of the project to retrieve.
235
.. cmdoption:: -s <SEMESTER>, --semester <SEMESTER>
237
Semester of the subject's offering (eg. 2009/1). Defaults to the currently
240
.. cmdoption:: -d <PATH>, --dest <PATH>
242
Destination directory (defaults to '.') to place submissions. Will create
243
subdirectories in this directory of the form
244
``subject/year/semester/project``.
246
.. cmdoption:: -z, --zip
248
Store each submission in a Zip file.
250
.. cmdoption:: -v, --verbose
252
Print out the name of each submission as it is extracted.
254
.. cmdoption:: --no-txt
256
Disable writing a text file with metadata about each submission.
262
.. program:: ivle-listusers
264
:program:`ivle-listusers [OPTIONS]`
266
Gets a list of all users in the IVLE database.
268
Requires root to run.
270
.. cmdoption:: -n, --names
272
Only prints the logins of users
278
.. program:: ivle-marks
280
:program:`ivle-marks [OPTIONS] <SUBJECT>`
282
Reports each student's marks for a given subject offering.
284
Requires root to run.
286
.. cmdoption:: <SUBJECT>
288
The short name given to the subject
290
.. cmdoption:: -s <SEMESTER>, --semester <SEMESTER>
292
Semester of the subject's offering (eg. 2009/1). Defaults to the currently
295
.. cmdoption:: -c <CUTOFF>, --cutoff <CUTOFF>
297
Cutoff date (calculate the marks as of this date). Should be provided in
298
the form of ``YYYY-MM-DD H:M:S``.
304
.. program:: ivle-mountallusers
306
:program:`ivle-mountallusers`
308
Attempts to mount the jails of all users.
312
Administrators should not be required to manually run this script for
313
regular operation. IVLE will automatically mount user's jails on demand.
315
Requires root to run.
317
.. cmdoption:: -v, --verbose
319
Prints the details of each user's jail being mounted/unmounted
321
.. cmdoption:: -u, --unmount
323
Unmount jails instead of mounting them.
326
ivle-refreshfilesystem
327
----------------------
329
.. program:: ivle-refreshfilesystem
331
:program:`ivle-refreshfilesystem`
333
Refresh parts of the filesystem that are generated from the database.
335
In particular, the Subversion authorisation files are rewritten.
341
.. program:: ivle-remakeuser
343
:program:`ivle-remakeuser [OPTIONS] <USER>`
345
:program:`ivle-remakeuser [OPTIONS] -a`
347
Rebuilds the Jail of a user or all users in IVLE. This will not delete the
348
data of the users being rebuilt.
350
Requires root to run.
352
.. cmdoption:: <USER>
354
Login of the user whose Jail will be rebuilt.
356
.. cmdoption:: -v, --verbose
358
Prints the details of each user's jail being remade.
360
.. cmdoption:: -a, --all
362
Rebuild all users Jails.
368
.. program:: ivle-showenrolment
370
:program:`ivle-showenrolment <USER>`
372
Shows the enrolments of a user. Prints subject code, subject name, year,
373
semester and role the user has in each subject they are enrolled in.
375
Requires root to run.
377
.. cmdoption:: <USER>
379
Login of the user to view enrolments details.
added
removed
doc/man/scripts.rst
