|
3 | 3 | </p>
|
4 | 4 | <h1 align="center">Verification of learning analytics data</h1>
|
5 | 5 |
|
6 |
| - |
7 | 6 | This repository contains services related to verification of learning analytics data, as well as privacy and consent management.
|
8 | 7 |
|
| 8 | +Learning Analytics Verification Service |
| 9 | +=========================================== |
| 10 | +The LA Verification Service is a las2peer Service which enables consent management and verification for LA data. |
| 11 | + |
| 12 | + |
| 13 | +Configuration |
| 14 | +------------------- |
| 15 | +In order to use the full functionality of the service, it has to be bootstrapped to a las2peer network that has the following services deployed: |
| 16 | +- [MoodleDataProxy](https://github.com/rwth-acis/moodle-data-proxy) that is connected to an instance of the Moodle Learning Management System (LMS) |
| 17 | +- [LearningLockerService](https://github.com/rwth-acis/learning-locker-service) connected to a Learning Record Store (LRS) |
| 18 | +- [MobSOSDataProcessingService](https://github.com/rwth-acis/mobsos-data-processing) to enable the transmission of xAPI-statements from Moodle to the LRS |
| 19 | +- [SocialBotManagerService](https://github.com/rwth-acis/las2peer-Social-Bot-Manager-Service) is required to enable the communication with a chatbot |
| 20 | + |
| 21 | +Build |
| 22 | +-------- |
| 23 | + |
| 24 | +Execute the following command on your shell: |
| 25 | + |
| 26 | +```shell |
| 27 | +ant jar |
| 28 | +``` |
| 29 | + |
| 30 | +Start |
| 31 | +-------- |
| 32 | + |
| 33 | +To start the la-verification-service, follow the [Starting-A-las2peer-Network tutorial](https://github.com/rwth-acis/las2peer-Template-Project/wiki/Starting-A-las2peer-Network) and bootstrap your service to a [mobsos-data-processing service](https://github.com/rwth-acis/mobsos-data-processing/tree/bachelor-thesis-philipp-roytburg). |
| 34 | + |
| 35 | +Initialization |
| 36 | +----------------------- |
| 37 | + |
| 38 | +Before the service can be properly used it needs to be initialized. |
| 39 | +During the initialization, the required smart contracts will be loaded, and messages for the bot communication, and pre-defined consentLevels will be read from property files. |
| 40 | +To initialize the service, send a POST request to the following path: |
| 41 | +``` |
| 42 | +POST <service-address>/verification/init |
| 43 | +``` |
| 44 | + |
| 45 | +How to run using Docker |
| 46 | +------------------- |
| 47 | + |
| 48 | +First build the image: |
| 49 | +```bash |
| 50 | +docker build . -t la-verification-service |
| 51 | +``` |
| 52 | + |
| 53 | +Then you can run the image like this: |
| 54 | + |
| 55 | +```bash |
| 56 | +docker run -p port:9011 la-verification-service |
| 57 | +``` |
| 58 | + |
| 59 | + |
| 60 | +### Node Launcher Variables |
| 61 | + |
| 62 | +Set [las2peer node launcher options](https://github.com/rwth-acis/las2peer-Template-Project/wiki/L2pNodeLauncher-Commands#at-start-up) with these variables. |
| 63 | + |
| 64 | +| Variable | Default | Description | |
| 65 | +|----------|---------|-------------| |
| 66 | +| LAS2PEER_BOOTSTRAP | unset | Set the --bootstrap option to bootstrap with existing nodes. The container will wait for any bootstrap node to be available before continuing. | |
| 67 | +| LAS2PEER_CONFIG_ENDPOINT | unset | Set variable to configure the endpoint from which to load blockchain configuration parameters. | |
| 68 | +| LAS2PEER_ETH_HOST | unset | Set variable to configure which Ethereum host to use to access the Ethereum blockchain. | |
0 commit comments