Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
MerliX committed Dec 1, 2016
1 parent 9d786f2 commit 7da7df0
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@
## Requirements
1. Examus plugin was tested with Moodle 3.1 version
2. Examus proctoring needs OAuth2 server plugin installed. You can install it from https://github.com/examus/moodle-local_oauth/releases
3. To install plugin, download zip archive, go into your Moodle admin section, navigate to `AdministrationPluginsInstall plugins`, put downloaded zip in box and press `Install` button.
3. To install plugin, download zip archive, go into your Moodle admin section, navigate to `AdministrationPluginsInstall plugins`, put downloaded zip in box and press `Install` button.

If you have Oauth2 server installed from another source, **please make sure it allows HTTPS url as Redirect URL**

## Installation
1. Download zip from https://github.com/examus/moodle-availability_examus/releases/, open `Administration→Plugins→Install plugins`, put zip there
2. Go to `Administration→WebServices→Manage Tokens`, Add token for service Examus for Admin User. Examus will use this token for integration.
3. Go to `Administration→Server→OAuth provider settings`, press `Add new client`.
4. You can use any Client identifier, for example 'Examus'. To get 'Redirect URL', please contact us. After saving new client, Examus proctoring service will use your `Client identifier` and generated `Client secret Key` to authenticate your users
1. Download zip from https://github.com/examus/moodle-availability_examus/releases/, open `Administration → Plugins → Install plugins`, drag and drop the downloaded zip there
2. Go to `Administration → WebServices → Manage Tokens`
3. Add token for service `Examus` for `Admin User` (or any other user, `webservice`, for example).
4. Send token to Examus. We will use this token for integration. Also we need your Oauth2 `Client identifier` and `Client secret`
5. Go to `Administration → Server → OAuth provider settings`, click `Add new client`.
5. You can use any `Client identifier`, for example 'Examus'. Please contact us to get yout 'Redirect URL'. After saving new client, Examus proctoring service will use your `Client identifier` and generated `Client secret Key` to authenticate your users.

## Usage
1. In course editing mode, `Edit settings` for module, scroll down to `Restrict access`
2. Choose `Add restrictions... → Examus` to enable proctoring for this module. Please, specify duration of proctoring session. If you already have time restriction for module ('Quiz'), proctoring session duration must match time restriction setting.
2. Choose `Add restrictions... → Examus` to enable proctoring for this module. Please, specify duration of proctoring session. If you already have time restriction for module ('Quiz'), proctoring session duration must be equal to time restriction setting.

0 comments on commit 7da7df0

Please sign in to comment.