Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 2.83 KB

README.md

File metadata and controls

60 lines (35 loc) · 2.83 KB
Raw

moodle-cardano-connect

It is a small but useful tool that allows students to login into Moodle Learning Management System via a Cardano wallet (such as Nami, Eternl, Flint, etc).

Users do not need to access Moodle with credentials, because they are authenticated through the browser wallet plugin.

Demo video

Watch the video Watch the video

Config instruction

  1. You have to install the plugin https://github.com/eLearningDAO/moodle-auth_userkey-plus (that is a modification of https://moodle.org/plugins/auth_userkey) in your Moodle Deployment and enable it according to the documentations
  2. In the plugin settings, set the Mapping field to ID number and Create user? to Yes
  3. Edit ./src/App.tsx and set the IP/Host of the target moodle server var MOODLEURL = 'http://x.x.x.x/' and also update the Moodle Webservice Token var MOODLEAPITOKEN = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'. For easy finding, you can search @CONFIG in ./src/App.tsx
  4. On Moodle as admin, open the course you want to allow for direct access (via Cardano wallet), click participants, select enrolment methods and enable self-enrolment

Building info

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information

About the authentication process

The user wallet address is encrypted and used as the user's unique ID in Moodle. This data can be shared safely because it prevents revealing the cardano user behind the moodle learner.

For example, an address like this addr1x8dgthgc5tgk9v70jzaesgsexs92yhqfq39gy5vnzyuvssw6shw33gk3v2euly9mnq3pjdq25fwqjpz2sfgexyfcepqsn3r7pu generates the moodle user ID like this 4dece4f7431e625b36ce27a4a09727a2 (collisions are extremely rare and isolated per moodle server instance).

Thanks to

https://github.com/txpipe/wallet-connect-starter-kit for the fundamental work on the Cardano wallet connection.