zervo/seb-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docu

Browse source
This commit is contained in:
anhefti 2020-04-29 16:39:53 +02:00
parent 09edc0d4c9
commit c9e6ff7914
3 changed files with 50 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/client_config.rst
View file

@ -7,23 +7,29 @@ Overview
--------
A client configuration is needed to configure a SEB client to securely connect to the SEB Server and present a list of available exams
for selection. At least one client configuration is needed for an institution that then can exported and be deployed with a SEB within a managed device setup or can be made available within a download link
on a internal or trusted server. Since the client configuration is security relevant because it contains sensitive data to connect to SEB Server,
for selection. At least one client configuration is needed for an institution that can be exported and deployed with a SEB on a managed device setup
or can be made available within a download link on a internal or trusted server. Another scenario would be to send the client configuration to
individual students per mail with instructions on how to install SEB and start it with the configuration to automatically connect to the SEB Server.
However, since the client configuration is security relevant because it contains sensitive data to connect to SEB Server,
there are different security level one can choose to apply within a internal safe e-assessment strategy.
The lowest level of security is to just have one not encrypted client configuration for the whole institution and for all e-assessments.
In this case the sensitive data is more exposed to be compromised and misused by others because of the missing encryption and also it takes
more effort to deal with such an issue while there is only one client configuration used by all e-assessments of the institution.
The lowest level of security is to just have one not encrypted client configuration for the whole institution and for all e-assessments provided
at this institution with SEB Server.
In this case the sensitive data is more exposed to be compromised and misused by others because of the missing password protection and it also takes
more effort to deal with such an issue while there is only one client configuration used by all e-assessments of the institution. If the one client
configuration has been compromised and a misuse has been detected the concerned client configuration can be deactivated to prevent further misuse. A
new one can be created and delivered or updated but since it is only one configuration used for the institution all actual download links have to
be updated and all students awaiting a prepared exam has to be informed and supported with the new configuration (link)
The currently highest level of security is to have encrypted and different client configuration for different e-assessment or semester-wise.
In this case the client configuration is encrypted with a password that can be defines by a institutional- or exam-administrator while
The currently highest level of security is to have encrypted and different client configuration for different e-assessment.
In this case the client configuration is encrypted with a password that can be defined by a institutional- or exam-administrator while
creating the client configuration. Once the SEB loads such a client configuration it will fist prompt the user about the password that must be
given to proceed and connect to the SEB Server.
given by the student to proceed and connect to the SEB Server.
Usually a client configuration is created or maintained by an institutional administrator or by an exam administrator. Exam supporter role has
Usually a client configuration can be created or maintained by an institutional administrator or by an exam administrator. Exam supporter role has
no access to client configurations and a SEB administrator is able to see client configurations of other institutions but not to create or modify them.
To see the list of all available client configuration for an institution and the specific user-role, go to the sub-section "Client Configuration"
You can see a list of all available client configuration for an institution by going to the sub-section "Client Configuration"
of the "Configuration" section on the menu on the left hand side.
.. image:: images/client_config/list.png
@ -90,7 +96,7 @@ Use Cases
**Create Client Configuration**
As an Institutional Administrator one should create a new secure client configuration for the upcoming semester. The setup shall operate with
As an Institutional Administrator you should create a new secure client configuration for the upcoming semester. The setup shall operate with
secure configurations because the configuration file may be exposed to the public Internet. And the setup shall also have a proper fallback
strategy where SEB clients uses the a given start URL in fallback case.

29
docs/exam.rst
View file

@ -1,2 +1,29 @@
Prepare Exam
============
=============
This chapter is about setting up and prepare a already imported exam on SEB Server. If you don't have imported a course or quiz from LMS
as an exam into SEB Server, please see the previous chapter for detailed guidance about hot to import an exam.
To find a specific exam that has already been imported, go to "Exam Administration" / "Exam" on the navigation menu on the left hand side to
see a list of all available exams. You are able to filter and sort the list as usual to find to right course for import.
.. note::
The "Start-Time" filter is usually set to the date one year before now or to some other default date in the past. The list shows only
the courses that has a start-time after that time. If you have long running courses and it may possible that a course has been stated
a year or two ago, you habe to adapt this "Start-Time" filter to view those courses that has been started before.
Double click on the list entry of the exam or select the list entry and use the "View Exam" action of the action pain on the right hand side to
open the exam in the detail view. Within the detail view of the exam you are able to edit the exam attribute, apply SEB exam configuration and
indicators for monitoring as well as defining details of the SEB restriction if this feature is available from the LMS.
.. note::
If an exam is already running bit is missing some essential setup, this is noted by displaying a red framed message on the top of
the side that points out the missing configuration parts. A running exam with missing parts is also marked red in the lists to indicate
that they are not ready to go and needs some missing setup or preparation.
.. image:: images/exam/lmsExamLookup.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examNotReady.png

5
docs/exam_import.rst
View file

@ -12,6 +12,11 @@ You will find the list of available courses provided form all LMS that are bound
section on the left hand side and choosing "LMS Exam Lookup". The SEB Server will present you the list of all available courses and you
are able to filter and sort the list as usual to find to right course for import.
.. note::
The "Start-Time" filter is usually set to the date one year before now or to some other default date in the past. The list shows only
the courses that has a start-time after that time. If you have long running courses and it may possible that a course has been stated
a year or two ago, you habe to adapt this "Start-Time" filter to view those courses that has been started before.
.. image:: images/exam/lmsExamLookup.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/lmsExamLookup.png