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-03-25 19:10:32 +01:00
parent 02e3a104bf
commit 79c741889d
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/overview.rst
View file

@ -4,16 +4,16 @@ Overview
Safe Exam Browser Server (SEB Server) is a web-service application to help setting up and maintain e-assessments with Safe Exam Browser Server (SEB Server) is a web-service application to help setting up and maintain e-assessments with
`Safe Exam Browser <https://safeexambrowser.org/>`_ (SEB) in a centralized manner. The SEB Server application can be used `Safe Exam Browser <https://safeexambrowser.org/>`_ (SEB) in a centralized manner. The SEB Server application can be used
by an institution or organization as a self-maintained, lightweight server application to organize and setup their e-assessments. by an institution or organization as a self-maintained, lightweight server application to organize and setup their e-assessments.
Furthermore SEB Server can be setup and run within a cloud infrastructure an be provides as centralized service from a general service provider. Furthermore SEB Server can be setup and run within a cloud infrastructure by general service provider.
For an organization or institution that want to provides safe e-assessments with `Safe Exam Browser <https://safeexambrowser.org/>`_, For an organization or institution that wants to provides safe e-assessments with `Safe Exam Browser <https://safeexambrowser.org/>`_,
SEB Server can help to organize this e-assessments more effectively, safely and in one place. SEB Server can help to organize this e-assessments more effectively, safely and in one place.
There is the possibility to use the a SEB Server with built-in multi-tenancy functionality by creating institutions that are separated SEB Server comes with a built-in multi-tenancy functionality that allows to create and maintain institutions that are separated
by each other. This is most convenient for smaller groups of organizations or institutions that want to have one self maintained by each other. This is most convenient for smaller groups of organizations or institutions that want to have one self maintained
SEB Server instance but need internal separation of institutions. SEB Server instance but need internal separation of institutions.
Since SEB Server is generally an administration tool, meaning generally used to do administration work and task to setup and maintain e-assessments, Since SEB Server is generally an administration tool, meaning used to do administration work and task to setup and maintain e-assessments,
there is yet just a built-in small user-account management where users can register itself and get needed privileges assigned by already registered there is yet just a built-in small user-account management where users can register itself and get needed privileges assigned by already registered
administrator users that has the privileges to maintain user accounts. Currently there is no possibility to register with a third administrator users that has the privileges to maintain user accounts. Currently there is no possibility to register with a third
party account and single sign on. party account and single sign on.
@ -21,14 +21,14 @@ party account and single sign on.
SEB Server is written in Java and uses Docker for installation and setup. For more information about the architecture and installation, SEB Server is written in Java and uses Docker for installation and setup. For more information about the architecture and installation,
please go to `SEB Server Installation Guide <https://seb-server-setup.readthedocs.io/en/latest/overview.html>`_ please go to `SEB Server Installation Guide <https://seb-server-setup.readthedocs.io/en/latest/overview.html>`_
We will have a quick overview of the functionality and the roles on SEB Server in the next chapter. Next chapter has a quick overview of the functionality and the roles on SEB Server.
.. _roles_and_usecases: .. _roles_and_usecases:
Roles and Use-Cases Roles and Use-Cases
----------------------- -----------------------
The SEB Server supports a simple role based privilege system where a role has defined read, modify and write privileges on certain domain entities. The SEB Server supports a simple role based privilege system where a role has read, modify and write privileges on certain domain entities.
The privileges for a role are defined and cannot be changed by a user. Roles can be combined within one user-account. The privileges for a role are defined and cannot be changed by a user. Roles can be combined within one user-account.
Privileges for domain objects are categorized in read, modify and write where write includes creation and deletion grants in addition to the more Privileges for domain objects are categorized in read, modify and write where write includes creation and deletion grants in addition to the more
@ -36,7 +36,7 @@ restrict modify right that only allows to modify already created entities. They
overall means for all entities, over all available institutions and institutional means only the entities that belongs to the own institution overall means for all entities, over all available institutions and institutional means only the entities that belongs to the own institution
and owner means the creator or assigned owner of an entity. and owner means the creator or assigned owner of an entity.
Currently there are four different roles. This reflect a good separation of concerns within the SEB Server application administration itself and the setup and There are four different roles. This reflect a good separation of concerns within the SEB Server application administration itself and the setup and
maintaining work that has to be done for e-assessments with SEB. maintaining work that has to be done for e-assessments with SEB.
below are the names and a short description of each role. below are the names and a short description of each role.
@ -44,7 +44,7 @@ below are the names and a short description of each role.
**SEB Server Administrator** **SEB Server Administrator**
This role is primarily to administer the SEB Server application, create new and maintain institutions and user-accounts. In addition to that a This role is primarily to administer the SEB Server application, create new and maintain available institutions and user-accounts. In addition to that a
SEB Server administrator also has overall read privileges for the most parts to be able to analyze problems and help others to solve them. SEB Server administrator also has overall read privileges for the most parts to be able to analyze problems and help others to solve them.
A typical use-case for a SEB Server administrator is to create a new institution and an institutional administrator for this institution. A typical use-case for a SEB Server administrator is to create a new institution and an institutional administrator for this institution.