Matrix

Matrix

Matrix is a messaging platform that Moodle uses for its global chat system. If the admin has configured your site to use a Matrix server, the option to select Matrix as a provider will be available. Choosing Matrix will prompt you to enter in a room name and room topic. Some values are provider specific and will vary between providers:

Room name

Providing a room name is option. If no room name is entered the course name will be used.

Room topic

The room topic is also optional and effectively works as a description for the room. As explained above, Matrix has its own set of individual settings and room topic is one of them.

Room moderators

Room moderators will have elevated privileges in Matrix rooms. There is a hierarchy that is determined by the roles assigned in Moodle. In order of privilege, they are:

1. Admin
2. Managers, teachers, non-editing teachers
3. Students

Teachers, non-editing teachers and managers will automatically have the moderator capability in the Matrix room. This role (communication/matrix:moderator) can be changed in the Define role settings in Site administration.

Configuring Matrix

The Matrix communication provider allows Moodle LMS courses to have an associated room in a Matrix Element instance. It also provides user management by synchronising participants in a course with the associated Matrix Element room.

Currently, the integration supports the Synapse homeserver for setting up the provider service, and the Matrix Element messaging client for accessing the room. To configure your Moodle LMS instance with Matrix you will need the following:

• URL of the Synapse homeserver
• API access token for a Synapse admin user
• URL of an Element web server to use

To configure your Moodle LMS instance to use the Matrix provider:

1. Enter the URL of your Synapse server in the 'Homeserver URL' field (matrixhomeserverurl)
2. Enter the Synapse server API Access token in the 'Access token' field (matrixaccesstoken). See 'Synapse API access token generation' below.
3. Enter the URL of the Element web server in the 'Element web URL' field (matrixelementurl)
4. Click Save changes.

Synapse API access token generation

To generate an API access token for Moodle LMS, you need access to a terminal and use an existing username and password for the admin of your Synapse server instance.

• The username will need to be formatted as follows: @<username_on_homeserver>:<homeserver_domain>
• Password is the admin user's regular password.

To generate an access token to be used with Moodle LMS, enter the following into a terminal:

curl -XPOST -d '{"type":"m.login.password", "user":"@admin:synapse", "password":"secretpass"}' "https://synapse:8008/_matrix/client/r0/login"

The returned value will look something like this:

{"user_id":"@admin:synapse","access_token":"syt_YWRtaW4_OQNsHwWoObhseRAWmUCs_2T29if","home_server":"synapse","device_id":"JPAIBCQCSB"}

The access_token field is the API access token to use in the Moodle LMS Matrix communication provider settings.

Data flow between Moodle LMS and Matrix

• The current implementation uses the Moodle Course Communication settings to set the room name and room topic for the Matrix room. If those fields are empty, the course name is used as the room name and the room topic is kept empty.
• Matrix usernames are generated using Moodle usernames and are necessary for adding Matrix users to a room.
• Authentication to Matrix is handled from Moodle LMS.
• Users are only created in Matrix if they have not been created yet, or no mapping to that user is recorded with Moodle LMS.

The following diagram shows the flow of data between Moodle LMS and Matrix.

Capabilities

• Matrix moderator.