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

new readme

Browse source
This commit is contained in:
anhefti 2023-04-18 13:01:25 +02:00
parent b85f726461
commit 308bcdf2c1
2 changed files with 49 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

133
README.rst
View file

@ -19,14 +19,6 @@ Development:
:target: https://github.com/SafeExamBrowser/seb-server/tree/development
---------
**Note regarding to** `CVE-2021-44228 <https://nvd.nist.gov/vuln/detail/CVE-2021-44228>`_: SEB Server is **not affected** by the vulnerability. For more information please read `Log4J2 Vulnerability and Spring Boot <https://spring.io/blog/2021/12/10/log4j2-vulnerability-and-spring-boot>`_
However, to prevent security scanner to alert false-positives we decided to make a patch for the latest version of SEB Server (v1.2.6) including the Log4j 2.16.0 library. If you want to update please make sure your installation refer to version v1.2-stable, v1.2-latest or v1.2.6. Then simply make a update/rebuild of your seb-server docker image.
---------
About
-----
The Safe Exam Browser Server web application simplifies and centralizes the configuration of Safe Exam Browser clients for exams. It interacts with a learning management or exam system for setting up and conducting e-assessments with Safe Exam Browser. It also improves security by allowing to monitor connected Safe Exam Browser clients in real time during e-assessments.
@ -50,7 +42,7 @@ SEB Server is a modern webservice with a REST API and a GUI service on top of it
SEB Server provides a range of basic functionalities:
- Built-in institutional multitenancy
- Linking of multiple Learning Management Systems (LMS). Currently supported: `Open edX <https://open.edx.org/>`_
- Linking of multiple Learning Management Systems (LMS). Currently supported: `Open edX <https://open.edx.org/>`_, `Moodle <https://moodle.org/>`_, `Open Olat <https://www.openolat.com/>`_ , `Ans <https://ans.app/>`_
- Accessing the Course/Exam-API of a linked LMS to import a courses or exams for managing with SEB Server
- Creation and administration of SEB Client Configurations that can be used to startup a SEB and that contains SEB Server connection information for a SEB Client
- Creation and administration of SEB Exam Configurations that can be bound to an imported Exam to automatically configure a SEB Client that connects to an exam that is managed by SEB Server
@ -61,56 +53,56 @@ The image below shows a very simplified diagram that locates the SEB Server in a
Safe Exam Browser (SEB). The SEB Server communicates with the LMS for managing and prepare exams as well as with the SEB Client to ensure
a more automated and secure setup for high-stake exams.
.. image:: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/seb-sebserver-lms.png
.. image:: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/setup_1.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/seb-sebserver-lms.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/setup_1.png
SEB Server Version 1.4 is out
SEB Server Version 1.5 is out
-------------------------------
New features:
New Features:
- Add possibility to archive/deactivate exams
- Added "Monitoring/Finished Exams" to be able to view already finished or archived exams within the usual monitoring view
- Improve LMS connection handling and LMS data fetch cycle
- Exam Configuration: Batch actions to change "Status" and "Update from Template" on multiple configuration at once
- Add proctoring settings to exam template
- Import of certificate-encrypted SEB configuration as Exam Configuration in SEB Server
- Added last update date and last modifying user to Connection Configuration and Exam Configuration
- Deletion possibility for all entities or documents with detailed deletion report
- Show generated client credentials of a Client Configuration. Suitable for testing purposes
- Security: New Application Signature Key (ASK) integration within SEB Server exams and monitoring
- Security: Minimum SEB Client version tracking within SEB Server monitoring
- LMS Integration: Better Moodle integration with new `SEB Server Moodle Plugin <https://github.com/ethz-let/moodle-quizzaccess_sebserver>`_
- Exam Maintenance: Added new SEB grouping functionality for Exam (and Exam Template) and Monitoring to be able to view/manage SEB Clients within defined groups (IP range, SEB client OS, ...)
- Exam Maintenance: Batch actions for archive and delete exams
- Exam Maintenance: Added SEB log export for finished and archived exams
- Exam List: Filter for unavailable exams
- Exam Monitoring: Added force SEB Lock Screen feature to be able to send lock screen instruction to SEB client as well as release such from SEB Server
- User Account: Added "Change Password" function also in User Account edit page
Improvements:
- LMS Setup Lookup: Improved parallel data fetch of course and quit data from LMS and added notifications to the UI if background job is still fetching data from LMS in the background
- Zoom Proctoring: Adapted to new Zoom API's, SDK's and Apps
- Zoom Proctoring: Gallery view works now also in the proctoring web-client of the SEB Server
- Open Olat Integration: Added propagation of quit-link and quit-password for exam to Open Olat within the SEB restriction
- Monitoring: Improved performance for active monitoring
- Migration: Improved migration and added database table-char-set check
- SEB Settings: Added various new SEB Settings within the SEB Server database and Configuration Template (not yet in Exam Configuration UI)
- Added Tool-Tips also for list filters / various text and minor UI improvements
Bugfixes:
Bugfixes:
- Fixed to short default expiry time for SEB access token (1 hour --> 12 hour)
- Fixed Exam status update for running or finished exams when LMS dates changes
- Fixed Exam name and start-date filter
- Caching for SEB Exam Configuration on distributed setups
- Wrong SEB client missing ping logs generated by SEB Server
- Monitoring: Negative ping values
- Monitoring - Raise hand: Icon in SEB Server monitoring appears now also when SEB is connecting and not active yet
- Exam Configuration - List-Inputs: AutomaticallysSelect new added entry and select next entry after deleting previous entry
Changes:
- User Account: Improved description for change password form
- Monitoring: Search pop-up width to fit full navigation
- Exam Configuration: Rename option "Enable SEB with browser windows" to "Use SEB without browser window" and invert logic (same as in SEB Config Tool)
- Exam Proctoring Settings: Make pop-up larger to fit all settings
- Client Configuration - Fallback Password: Improved arrangement for better TAB handling
- Improve form validation in add indicator form
- Change order of actions in monitoring according to user-input
- Configuration Templates: Display actual configuration values in the template's attribute list
- Exam Configuration status change to "Archived" is possible for up-coming exams
- Fix handling of invalid SEB Server monitoring UI sessions
- Open Olat LMS Setup access deadlock (serialized token request for LMS Template)
- Fixed exam update background process to update sometimes exams from LMS where nothing changed on LMS side
- Zoom proctoring multiplied participants on room change
- SEB Restriction warning on Exam seems to be not present when restriction fails
- Certificate cannot be imported
- Configuration Template: Filtering column "View": Paging in attribute list shows only one page
- Exam Configuration export SEB Settings should export current settings
- Exam: Name and Date filter does not work correctly
- Export Exam Connection Configuration, special characters in exam name cut of file name
- Zoom proctoring gallery view seems not to work because of cross-origin settings
Docker-Image:
- Exact release version: docker pull anhefti/seb-server:v1.4.0 (sha256:a2510c4bd31fa99e553bc672087f1c0276f5541452490e5320a77767bb8c1849)
- Latest stable minor version with patches: docker pull anhefti/seb-server:v1.4-latest
TODO
SEB - SEB Server Compatibility
@ -119,6 +111,15 @@ SEB - SEB Server Compatibility
The table below shows available and upcoming SEB client versions that has SEB Server integration support and are compatible with particular
SEB Server version. There is an entry for each platform with a beta or testing release date and a official release date.
**SEB Server Version 1.5.X**
.. csv-table::
:header: "Platform / OS", "Beta/RC Version", "Release Version"
"SEB Client for iOS", "ASK: 3.3", "3.1 (ASK: 3.3)"
"SEB Client for Mac", "ASK: 3.3pre", "3.1 (Zoom: 3.2/ASK: 3.3)"
"SEB Client for Windows", "", ""
**SEB Server Version 1.4.X**
.. csv-table::
@ -128,42 +129,6 @@ SEB Server version. There is an entry for each platform with a beta or testing r
"SEB Client for Mac", "3.1/3.2 Preview", "3.1 (Zoom: 3.2)"
"SEB Client for Windows", "--", "Version 3.3.2 - 3.4.0"
**SEB Server Version 1.3.X**
.. csv-table::
:header: "Platform / OS", "Beta/RC Version", "Release Version"
"SEB Client for iOS", "3.1 Beta", "3.1 (Zoom: 3.2) "
"SEB Client for Mac", "3.1/3.2 Preview", "3.1 (Zoom: 3.2)"
"SEB Client for Windows", "--", "Version 3.3.2"
**SEB Server Version 1.2.X**
.. csv-table::
:header: "Platform / OS", "Beta/RC Version", "Release Version"
"SEB Client for iOS", "--", "Version 3.0.1 "
"SEB Client for Mac", "3.1 Preview", "Version 3.1"
"SEB Client for Windows", "--", "Version 3.2"
**SEB Server Version 1.1.X**
.. csv-table::
:header: "Platform / OS", "Beta/RC Version", "Release Version"
"SEB Client for iOS", "22. April 2020 - Version 2.1.50", "Q2 2021 - Version 2.5/3.0"
"SEB Client for Mac", "Q2 2021 - Version 3.1", "Q2 2021 - Version 3.1"
"SEB Client for Windows", "April 2021 - Version 3.2", "May 2021 - Version 3.2"
**SEB Server Version 1.0.X**
.. csv-table::
:header: "Platform / OS", "Beta/RC Version", "Release Version"
"SEB Client for iOS", "22. April 2020 - Version 2.1.50", "Q2 2021 - Version 2.5/3.0"
"SEB Client for Mac", "Q2 2021 - Version 3.1", "Q2 2021 - Version 3.1"
"SEB Client for Windows", "Q2 2020 - Version 3.1", "Q4 2020 - Version 3.1"
Install SEB Server
------------------
@ -178,5 +143,5 @@ For a complete SEB Server user guide please go to `SEB Server User Guide <https:
Project Background
------------------
The SEB Server is currently build and maintained by the `Swiss MOOC Service <https://www.swissmooc.ch/>`_ that is founded by leading Swiss universities EPFL, ETH, SUPSI, USI and HES-SO. The Swiss MOOC Service was financially supported from 2018-2020 by the `Swissuniversities´ P5 program <https://www.swissuniversities.ch/themen/digitalisierung/p-5-wissenschaftliche-information>`_.
The SEB Server is currently build and maintained by `ETH Zürich <https://ethz.ch/en.html>`_ and by the `Swiss MOOC Service <https://www.swissmooc.ch/>`_ that is founded by leading Swiss universities EPFL, ETH, SUPSI, USI and HES-SO. The Swiss MOOC Service was financially supported from 2018-2020 by the `Swissuniversities´ P5 program <https://www.swissuniversities.ch/themen/digitalisierung/p-5-wissenschaftliche-information>`_.

BIN
docs/images/setup_1.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 29 KiB