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

fixed docu

Browse source
This commit is contained in:
anhefti 2021-03-31 14:36:26 +02:00
parent b74cf30330
commit 34569e5bbf
2 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/exam_proctoring.rst
View file

@ -1,18 +1,20 @@
.. _sebProctoringSettings-label:
Exam Proctoring
Live Proctoring
===============
If this feature is enabled, you are able to setup a proctoring service for an specified exam that can be used in the monitoring later on while the exam is running and SEB clients are connected.
To be able to use the integrated live proctoring feature with SEB and SEB Server you need an external meeting service that can be used by the SEB Server to automatically create meetings.
If this feature is enabled, you are able to setup a live proctoring service for a specified exam that can be used in the monitoring later on while the exam is running and SEB clients are connected.
.. note::
This feature is still in a prototype state and not all functionality meight work as expected.
To be able to use proctoring features within SEB Server you need a meeting service with scale. Currently supported is `Jitsi Meet <https://jitsi.org/jitsi-meet/>`_ with JWT token authentication enabled.
To be able to use the live proctoring features within SEB Server you need a external meeting service that scales out for the need.
Currently supported is `Jitsi Meet <https://jitsi.org/jitsi-meet/>`_ with JWT token authentication enabled.
A `Zoom meeting service <https://zoom.us/>`_ integration is planed for a future release of SEB Server.
To setup and configure a Jitsi Meet service for testing you can refer to the `Docker installation documentation <https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker>`_
To setup a proctoring service for an exam, go to the view page of the exam and use the "Proctoring Settings" action on the right action pain to open up the proctoring settings dialog.
To setup a live proctoring service for an exam, go to the view page of the exam and use the "Proctoring Settings" action on the right action pain to open up the proctoring settings dialog.
.. image:: images/exam/proctoringSettings.png
:align: center

11
docs/monitoring.rst
View file

@ -80,18 +80,18 @@ overview temporary network latency or other irregularities, when this two time v
In the detail view you are also able to use the instructions "Quit SEB Client" and "Mark as Canceled" for the selected SEB client connection.
Exam Proctoring
Live Proctoring
---------------
When the exam proctoring feature is enabled for the running exam (see **:ref:`seb_proctoringSettings-label`**), SEB Server will automatically create and collect
When the exam live proctoring feature is enabled for the running exam (see :ref:`sebProctoringSettings-label`), SEB Server will automatically create and collect
connected SEB clients into so called collecting rooms. The size of this collecting rooms can be defined within the proctoring settings in the exam.
One ore more proctor can now open such a collecting room and SEB Server will then join the proctor the the meeting where the SEB clients of this room can be seen.
One ore more proctor can then open such a collecting room and SEB Server will join the proctor to the meeting where the participants of this room can be seen.
.. image:: images/monitoring/proctoringExam.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/proctoringExam.png
Within a proctoring window you can user the enabled features of the used meeting service. And you are able to communicate with the SEB clients by using one
Within a live proctoring window you can user the enabled features of the used meeting service. And you are able to communicate with the SEB clients by using one
or more of the following features:
- **Start Audio Broadcast** Will enforce the SEB clients within the particular room to enable receive audio and a proctor can speak to the students that are in the meeting.
@ -111,7 +111,7 @@ When the town-hall is closed all connected SEB clients are enforced to leave the
**Single Room Feature"**
Another proctoring feature can be found in the detailed monitoring view of one particular SEB client connection. The single room features allows a proctor to connect to a single
Another live proctoring feature can be found in the detailed monitoring view of one particular SEB client connection. The single room features allows a proctor to connect to a single
participant and being able to view or communication with just this one participant. You can initiate this single room connection by using the "Single Room Proctoring" action on
the right action pane. SEB Server will then enforce the involved SEB client to leave its collecting room and join a newly created room with the proctor.
Within the single room a proctor has the same features as in the collecting room to communicate with the student or participant.
@ -121,6 +121,7 @@ When the single room is closed the connected SEB clients is enforced to leave th
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/proctoringClient.png
All SEB Client Logs
-------------------