update docu
This commit is contained in:
parent
4625e408e2
commit
bdfbbc1af0
9 changed files with 98 additions and 24 deletions
|
@ -1,12 +1,12 @@
|
|||
.. _certifications-label:
|
||||
.. _certificates-label:
|
||||
|
||||
Certifications
|
||||
Certificates
|
||||
====================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
To be bale to upload and store certificates within SEB Server is a new feature since SEB Server version 1.2. This allows an institutional administrator
|
||||
Import and store X.509 certificates within SEB Server is a new feature since SEB Server version 1.2. This allows an institutional administrator
|
||||
or an exam administrator to upload and store certificates for further use within SEB Server.
|
||||
|
||||
.. note::
|
|
@ -30,4 +30,4 @@ SEB Server release, to embed into an exam configuration for SEB to allow certifi
|
|||
connection_config
|
||||
exam_config
|
||||
config_template
|
||||
certifications
|
||||
certificates
|
|
@ -146,7 +146,7 @@ a SEB client must know the same certificate that is been used for encryption whi
|
|||
- Create an new connection configuration or use the list filter and / or the list navigation to find the needed connection configuration.
|
||||
- Fill in the settings as usual and for password encryption define a password in the "Configuration Password" field and confirm the password in the "Confirm Password" field.
|
||||
- For a certificate based encryption select one of the given certificates within the "Encrypt with Certificate" setting.
|
||||
- To upload new certificates that can be used for encryption, please refer to: :ref:`certifications-label`
|
||||
- To upload new certificates that can be used for encryption, please refer to: :ref:`certificates-label`
|
||||
- "Use asymmetric only encryption" if you have use SEB Clients with version before 2.2. For more details on this subject please see: `SEB Configuration <https://www.safeexambrowser.org/windows/win_usermanual_en.html#configuration>`_
|
||||
- Save and activate the connection configuration. The connection configuration will then be encrypted by either password or certificate on export.
|
||||
|
||||
|
|
|
@ -3,18 +3,26 @@
|
|||
Live Proctoring
|
||||
===============
|
||||
|
||||
Live proctoring is a new and yet experimental feature of SEB and SEB Server. The main goal of the live proctoring feature is to support the integration
|
||||
of an external meeting service like Jitsi Meet or Zoom for example, within a SEB and SEB Server setup for an exam.
|
||||
In this scenario a SEB client is able to join a meeting and send audio and video data to the meeting where a proctor can watch the students during
|
||||
an exam within this meeting(s). The role of SEB Server in this scenario is mainly to bind a particular meeting service and automatically create
|
||||
meeting rooms, instruct connected SEB clients to join a certain meeting room. SEB Server can also instruct SEB clients to participate in the meeting by
|
||||
allowing connected SEB clients to receive audio and video as well as enabling chat functionality.
|
||||
|
||||
.. note::
|
||||
This feature is still in a prototype state and not all functionality meight work as expected. Basically the meeting features
|
||||
are given or restricted by the meeting service that is used and the API and GUI that is given by that meeting service client
|
||||
|
||||
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 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>`_
|
||||
Currently supported meeting services are:
|
||||
- `Jitsi Meet <https://jitsi.org/jitsi-meet/>`_ with JWT token authentication enabled.
|
||||
- `Zoom meeting service <https://zoom.us/>`_ with an account plan that fits your need and supports the `Zoom API and Client SDKs <https://marketplace.zoom.us/docs/sdk/native-sdks/developer-accounts>`_.
|
||||
|
||||
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.
|
||||
|
||||
To bind and setup a live proctoring service in SEB Server 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
|
||||
|
@ -36,4 +44,45 @@ These settings are directly used by a SEB client that supports the proctoring fe
|
|||
:align: center
|
||||
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/proctoringSEBSettings.png
|
||||
|
||||
Since SEB Server version 1.2 there is also an Zoom service section that let you define the default SEB settings for a Zoom proctoring setup.
|
||||
Please be aware that not all of the settings are functioning yet. Please refer to the the settings tooltip to get a actual description of
|
||||
a particular SEB feature setting
|
||||
|
||||
**Jitsi Meet***
|
||||
|
||||
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>`_
|
||||
|
||||
.. note::
|
||||
The Jitsi Meet integration works only with JWT authentication. Please refer to the above documentation for how to setup JWT authentication.
|
||||
|
||||
**Zoom**
|
||||
|
||||
To integrate Zoom meetings as a live proctoring service within SEB Server you need to have an appropriate Zoom account with API and SDK access.
|
||||
`Zoom API and Client SDKs <https://marketplace.zoom.us/docs/sdk/native-sdks/developer-accounts>`_.
|
||||
Then you need to setup the Zoom account to run with JWT apps as described:
|
||||
|
||||
- Login into your Zoom account and use "App Marketplace" to setup an API app account
|
||||
|
||||
.. image:: images/exam/zoom1.png
|
||||
:align: center
|
||||
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/zoom1.png
|
||||
|
||||
- Within the Zoom Marketplace use "Develop" and select "Build App".
|
||||
|
||||
.. image:: images/exam/zoom2.png
|
||||
:align: center
|
||||
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/zoom2.png
|
||||
|
||||
- Choose either JWT or SDK or both if needed for exams with different SEB clients
|
||||
|
||||
.. image:: images/exam/zoom3.png
|
||||
:align: center
|
||||
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/zoom3.png
|
||||
|
||||
- Follow the instructions to create the API account and use the "App Key" and "App Secret" or SDK Key and SDK Secret within the setup in SEB Server
|
||||
|
||||
.. image:: images/exam/zoom4.png
|
||||
:align: center
|
||||
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/zoom4.png
|
||||
|
||||
|
||||
|
|
BIN
docs/images/exam/zoom1.png
Normal file
BIN
docs/images/exam/zoom1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 53 KiB |
BIN
docs/images/exam/zoom2.png
Normal file
BIN
docs/images/exam/zoom2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 192 KiB |
BIN
docs/images/exam/zoom3.png
Normal file
BIN
docs/images/exam/zoom3.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 102 KiB |
BIN
docs/images/exam/zoom4.png
Normal file
BIN
docs/images/exam/zoom4.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 44 KiB |
|
@ -83,24 +83,25 @@ In the detail view you are also able to use the instructions "Quit SEB Client" a
|
|||
Live Proctoring
|
||||
---------------
|
||||
|
||||
.. note::
|
||||
This feature is still in a prototype state and not all functionality meight work as expected. Basically the meeting features
|
||||
are given or restricted by the meeting service that is used and the API and GUI that is given by that meeting service client
|
||||
|
||||
|
||||
**Collecting Rooms**
|
||||
|
||||
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 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.
|
||||
One proctor can then open such a collecting room by left-clicking on the room action.
|
||||
SEB Server will then open a proctoring window and 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 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.
|
||||
- **Start Video Broadcast** Will enforce the SEB clients within the particular room to enable receive audio and video and proctor is shown to the students that are in the meeting and can speak to them as well.
|
||||
- **Enable Chat** Will enforce the SEB clients within the particular room to enable the chat feature and a proctor is able to chat with all students in the meeting.
|
||||
|
||||
.. image:: images/monitoring/proctoringWindow.png
|
||||
:align: center
|
||||
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/proctoringWindow.png
|
||||
A proctor is also able to view the names of all participants of a room by right-clicking on the specified room action.
|
||||
SEB server will then open a dialog with a list of all participants. Double-clicking on a particular participant will automatically
|
||||
load the detailed monitoring view of that participant.
|
||||
|
||||
**Town-hall Feature**
|
||||
|
||||
|
@ -121,6 +122,22 @@ 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
|
||||
|
||||
**Boradcast Features**
|
||||
|
||||
Within a live proctoring window a proctor can use the enabled features of the integrated meeting service. And is able to communicate with the SEB clients by using one
|
||||
of the following features if available for the service:
|
||||
|
||||
- **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.
|
||||
- **Start Video Broadcast** Will enforce the SEB clients within the particular room to enable receive audio and video and proctor is shown to the students that are in the meeting and can speak to them as well.
|
||||
- **Enable Chat** Will enforce the SEB clients within the particular room to enable the chat feature and a proctor is able to chat with all students in the meeting.
|
||||
|
||||
While a broadcast feature is enabled by a proctor, the SEB Server sends an instruction to each SEB client that is within the same meeting to display the meeting client.
|
||||
A Student as well as a proctor is then able to use all the features of the meeting client of the integrated meeting service.
|
||||
|
||||
.. image:: images/monitoring/proctoringWindow.png
|
||||
:align: center
|
||||
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/proctoringWindow.png
|
||||
|
||||
|
||||
All SEB Client Logs
|
||||
-------------------
|
||||
|
@ -152,4 +169,12 @@ To delete all currently filtered client logs, please use the "Delete Logs" actio
|
|||
.. note::
|
||||
On deletion, all available logs will permanantly be deleted from the persistent storage. So please make sure you want to delete all
|
||||
logs that are currently displayed in the list before deleting.
|
||||
|
||||
|
||||
**Known Issues**
|
||||
|
||||
- Within the Zoom service it often happens that a participant appear twice in a room or meeting. This is probably caused by SEB clients rejoining the meetings while rooms or feature settings are changed.
|
||||
- In Zoom it is not possible to fully control a participant microphone. Therefore it may happen that participant can hear each other even if no proctor is in the meeting.
|
||||
- Within Jitsi Meet service when a proctor leaves the room it currently happens that a random participant became host/moderator since it is not possible in Jitsi Meet to have a meeting without host. We try to mitigate the problem with the `moderator plugin <https://github.com/nvonahsen/jitsi-token-moderation-plugin>`_ or `Jitsi Meet SaS <https://jaas.8x8.vc/#/>`_
|
||||
- In both services while broadcasting, it is not guaranteed that a student always see the proctor. Usually the meeting service shows or pins the participant that is currently speaking automatically.
|
||||
|
Loading…
Add table
Reference in a new issue