Skip to content

Commit

Permalink
preparing for release 2.0 fixed image refs
Browse files Browse the repository at this point in the history
  • Loading branch information
anhefti committed Aug 29, 2024
1 parent 018e9f3 commit f4ac677
Show file tree
Hide file tree
Showing 21 changed files with 106 additions and 105 deletions.
2 changes: 1 addition & 1 deletion docs/certificates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ This are usually password protected certificates in different file-formats. SEB

.. image:: images/certificates/cert_list.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/certificates/cert_list.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/certificates/cert_list.png


Use Cases
Expand Down
8 changes: 4 additions & 4 deletions docs/config_template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ a specific template by name for example.

.. image:: images/config_templates/list.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/config_templates/list.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/config_templates/list.png

To create a new exam configuration template, use the "Add Configuration Template" action from the right action pane. You will see the creation form
with a name and description for the new template. At least a unique name is mandatory, and the description is optional.
Expand All @@ -32,7 +32,7 @@ SEB Server. The name of an attribute is composed of the internal attribute name

.. image:: images/config_templates/templateView.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/config_templates/templateView.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/config_templates/templateView.png

The type of the attribute defines the input field type and cannot be changed in any way. The view defines the tab on which the settings attribute is placed.
And the group defines the named group where a settings attribute belongs to.
Expand All @@ -59,15 +59,15 @@ use the "View Configuration Template" action from the right action pane.

.. image:: images/config_templates/templateAttribute.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/config_templates/templateAttribute.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/config_templates/templateAttribute.png

Back in the exam configuration template view you are able to create a new SEB exam configuration directly from this template by using the "Create Exam Configuration"
action from the right action pane. The application will present you a creation dialog within a pop-up where you can define a name and description for the
new SEB exam configuration. At least a unique name is mandatory.

.. image:: images/config_templates/createConfig.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/config_templates/createConfig.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/config_templates/createConfig.png

After defining a name and description for the new SEB exam configuration you can click on "OK" to do so, and the application will show you the new created
SEB exam configuration in the usual place.
6 changes: 3 additions & 3 deletions docs/connection_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ of the "Configuration" section on the menu on the left hand side.

.. image:: images/connection_config/list.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/connection_config/list.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/connection_config/list.png

The list shows the name, the date of creation and the status of the connection configurations in a column. With SEB Server administrator role
also an institution column is shown because a SEB Server administrator is able to see all connection configurations of all institutions.
Expand All @@ -46,7 +46,7 @@ or remove selection to hide all fallback related attributes.

.. image:: images/connection_config/new.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/connection_config/new.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/connection_config/new.png

Short description of all attributes of a connection configuration:

Expand Down Expand Up @@ -113,7 +113,7 @@ these exams with the multi selector. It is also possible to filter the list by t

.. image:: images/connection_config/examSelection.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/connection_config/examSelection.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/connection_config/examSelection.png



Expand Down
12 changes: 6 additions & 6 deletions docs/exam.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ indicators for monitoring as well as defining details of the SEB restriction if

.. image:: images/exam/examNotReady.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examNotReady.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examNotReady.png


At the beginning of the page - if there is no note - you see all the details of the exam.
Expand Down Expand Up @@ -70,7 +70,7 @@ the pop-up shows the description and the status of the selected configuration.

.. image:: images/exam/addExamConfig.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/addExamConfig.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/addExamConfig.png

There is also the possibility to encrypt the SEB exam configuration by a password. This is done before the SEB configuration is send to a connecting
SEB client. Since in the most cases the SEB client connections are over HTTPS / TSL there is already a good protection in place and an
Expand All @@ -85,7 +85,7 @@ The new action "Edit Encryption Password" can be used to open up the original ap

.. image:: images/exam/editEncryptionPassword.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/editEncryptionPassword.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/editEncryptionPassword.png

.. note::
If you need to use the same SEB exam configuration for different exams, you can just make a copy of a SEB exam configuration that is already used
Expand All @@ -101,7 +101,7 @@ the SEB restriction details with the generated Config-Key. See :ref:`sebRestrict

.. image:: images/exam/examConfig.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examConfig.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examConfig.png

To just generate the Config-Key for testing purposes or to manually apply it on an LMS/Assessment Tool without the automated SEB restriction feature you can
use the "Export Config-Key" action to generate the key. The Config-Key is presented by a pop-up and can be selected and copied to the clip-board.
Expand Down Expand Up @@ -170,7 +170,7 @@ section in the monitoring view.

.. image:: images/exam/archiveExamsFilter.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/archiveExamsFilter.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/archiveExamsFilter.png

This is also a good use-case if you want to remove an LMS/Assessment Tool and LMS/Assessment Tool Setup but still want to be able to access the exams data on the SEB Server.
In this case you can archive all exams from that LMS/Assessment Tool Setup before deactivating or deleting the respective LMS/Assessment Tool Setup.
Expand All @@ -196,7 +196,7 @@ If you have "Exam Administrator" privileges you are able to entirely delete an e

.. image:: images/exam/deleteExam.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/deleteExam.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/deleteExam.png

- Within the delete exam dialog you see a list of a dependencies that also will be deleted. Please check them carefully before deletion.
- Use the below action to either delete the exam or cancel the action and go back to the exam view.
Expand Down
12 changes: 6 additions & 6 deletions docs/exam_ask.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ for this feature.

.. image:: images/exam/examASK.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examASK.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examASK.png

Within this settings page you can enable or disable the feature any time also during a running exam. On the exam page you can see if the feature is enabled
when the shield-icon is not strike-through.
Expand All @@ -36,7 +36,7 @@ ASK for the same build.

.. image:: images/exam/examASKedit.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examASKedit.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examASKedit.png

In the following list you can see all APK that has been sent to the SEB Server by connected SEB clients. For a particular ASK you can also see
how many SEB Clients has been sent this ASK and has the same signature.
Expand All @@ -47,7 +47,7 @@ below. You can give a name for the grant and save the grant by using "OK" action

.. image:: images/exam/examASKgrant.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examASKgrant.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examASKgrant.png

You see all granted ASKs within the second list with the ASK hash and the name that was given on grant. All explicitly granted ASKs from that list are
considered trusted for the exam. And future SEB client connection that connects with one of the ASKs from this list are granted. All SEB clients that
Expand All @@ -65,19 +65,19 @@ SEB connections are marked red and with the tag "- ASK Grant Denied" after the s

.. image:: images/exam/examASKMonitoring1.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examASKMonitoring1.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examASKMonitoring1.png

In the detail view of a SEB client connection you can see this too and you are able to apply a grant for a denied APK afterwards by using the
"Grant App Signature Key" action from the right action pane. This will open a pop-up with the ASK hash and an input field for the name of the
grant.

.. image:: images/exam/examASKMonitoring2.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examASKMonitoring2.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examASKMonitoring2.png

.. image:: images/exam/examASKMonitoring3.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examASKMonitoring3.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examASKMonitoring3.png


After you have granted a unknown ASK, the grant is also applied to the respective SEB connection and to all following SEB connections that
Expand Down
12 changes: 6 additions & 6 deletions docs/exam_clientgroups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Client groups are located on an Exam setup page after the indicators at the end

.. image:: images/exam/examClientgroupAdd.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examClientgroupAdd.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examClientgroupAdd.png

To add a new SEB Client Group use the respective action from the right action pane. You will be presented with the SEB Client Group edit page
where you are able to give the new SEB Client Group a name and choose a type of the client group that you want to create.
Expand All @@ -45,7 +45,7 @@ the group type. With the additional, specific inputs, the SEB Client Group can b

.. image:: images/exam/examClientgroupIP.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examClientgroupIP.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examClientgroupIP.png

For the IP range group type you can give a valid IP range defined with a start IP address and an end IP address. This two inputs are mandatory
and must be valid IPv4 addresses. The range must be a valid range and will be inclusive on the IP match (range-start >= IP <= range-end).
Expand All @@ -54,15 +54,15 @@ For the SEB OS grouping type you have to choose the OS type from the given types

.. image:: images/exam/examClientgroupWin.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examClientgroupWin.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examClientgroupWin.png

If you have finished up your SEB Client Group definition you can save it with the "Save" action from the right action pane or cancel the modifications and
go back to the Exam page. You will see your created SEB Client Groups within its respective section on the Exam page and are able to edit them again, or delete
a certain SEB Client group from the list.

.. image:: images/exam/examClientgroups.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examClientgroups.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examClientgroups.png

Monitoring with SEB Client Groups
---------------------------------
Expand All @@ -73,7 +73,7 @@ depending on what group(s) a particular SEB applies to.

.. image:: images/exam/examClientgroupMonitoring1.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examClientgroupMonitoring1.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examClientgroupMonitoring1.png

With the "Client Group Filter" on the right action pane, you are able to show/hide individual groups. With this filtering you can adapt your monitoring view
for specialized monitoring view, to only see SEB client connection from one particular room for example or of one particular client OS.
Expand All @@ -86,4 +86,4 @@ for specialized monitoring view, to only see SEB client connection from one part

.. image:: images/exam/examClientgroupMonitoring2.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examClientgroupMonitoring2.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam/examClientgroupMonitoring2.png
14 changes: 7 additions & 7 deletions docs/exam_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ filter use the clear symbol right to the lens symbol. See :ref:`gui-label` for m

.. image:: images/exam_config/list.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam_config/list.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam_config/list.png

To view details of a specific exam configuration either double-click on a list entry or select a list entry and use the "View Exam Configuration"
action from the right action pane. In the detail view all general settings are shown and also a list of exams that uses this exam configuration.
Expand All @@ -46,7 +46,7 @@ is assigned to an exam, the status changes automatically to "In Use" and the SEB

.. image:: images/exam_config/view.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam_config/view.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam_config/view.png

An exam configuration has a general settings part (like other domain objects has within SEB Server) that defines the name, description and status
of the exam configuration that are used to maintain the exam configurations SEB Server internally. And an exam configuration has, separated from
Expand All @@ -64,7 +64,7 @@ while also publish them to exams that uses this exam configuration.

.. image:: images/exam_config/settings.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam_config/settings.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam_config/settings.png

.. note::
Changes in SEB settings must be published to be available on exports, exams, or other uses. Before publishing they are not
Expand Down Expand Up @@ -93,7 +93,7 @@ of the exam configuration. The key will be presented by a pop-up dialog where it

.. image:: images/exam_config/config_key.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam_config/config_key.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam_config/config_key.png


Batch Actions
Expand All @@ -110,7 +110,7 @@ For list multi-selection documentation see :ref:`List Multi-Selection <listmulti

.. image:: images/exam_config/batch-actions.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam_config/batch-actions.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam_config/batch-actions.png



Expand All @@ -121,7 +121,7 @@ With this batch action you are able to change the state of all selected exam con

.. image:: images/exam_config/batch-actions_statechange.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam_config/batch-actions_statechange.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam_config/batch-actions_statechange.png

Within the batch-action pop-up you can see how many exam configurations you have selected for the action. Now you are able to select the target state
to where you would like to change all selected exam configurations state to. Then you can apply the batch action with "Change State" or cancel the batch-action.
Expand All @@ -131,7 +131,7 @@ has been applied and how many has failed.

.. image:: images/exam_config/batch-actions_statechange_finished.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam_config/batch-actions_statechange_finished.png
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/dev-2.0/docs/images/exam_config/batch-actions_statechange_finished.png


**Reset To Template Settings**
Expand Down
Loading

0 comments on commit f4ac677

Please sign in to comment.