axelsimon / moodle-mod_matrix

Moodle activity plugin to enable integration between Moodle and Matrix

matrix-moodle-plugin

This plugin provides a Moodle activity to enable integration between Moodle and Matrix. It adds:

• a new field for mxid for Moodle uers
• the ability to create a new Matrix room for a course, then invite all students of that course (or group within the course) to the room

Release

Update the plugin version in version.php:

-$plugin->version = 2020122800;
+$plugin->version = 2021070100;

Run

make archive

Share the compressed file mod_matrix.zip.

Setting up a local development environment

Install the pre-requisite tools:

• cmake (or make)
• composer (you'll need a version > 2, be warned the version in the Ubuntu repositories is much older)
• docker
• docker-compose-plugin to provide the docker compose command. See https://docs.docker.com/compose/install/
• php extensions:
  • php-curl
  • php-gd
  • php-intl
  • php-simplexml
  • php-zip

Rather than just make, you may want to directly install your operating system's development tools, for instance on Debian: apt install build-essential

On Fedora: dnf groupinstall "Development Tools"

Docker

Run

make docker-up

to start a local development environment.

💡 This command requires docker compose.

Moodle Command Line Installer

Run

docker ps

to obtain a list of the currently running containers. There should be a container with the name docker-moodle_php-1.

Run

docker exec -it docker-moodle_php-1 bash

to enter the container.

Run

cd /var/www/html

to change into the root of the Moodle installation (working directory is set to the root of the Moodle plugin).

Run

php admin/cli/install.php

to run the command line installer.

Basics

Configuration	Value
Language	en (default)
Data Directory Permissions	2777 (default)
Web Address	your local host, e.g., http://moodle.com.local
Data Directory	/var/www/moodledata (default)

Database

Configuration	Value
Database driver	mariadb
Database host	moodle_mariadb
Database name	moodle (default)
Tables prefix	mdl_ (default)
Database port	3306
Database user	root
Database password	root

Other

Configuration	Value
Full site name	Moodle Matrix Plugin Development
Short name	mmpd
Admin account user name	admin (default)
New admin user password	password
New admin user email address	your email address
Upgrade key	(default)

Moodle Administration

Navigate to http://127.0.0.1 to finish setting up the installation.

Log in with the credentials for the administrator account created created when running the command line installer.

Install the mod_matrix plugin

Navigate to http://127.0.0.1/admin/settings.php?section=modsettingmatrix and provide configuration values to finish the configuration of the plugin:

Configuration	Value
Homeserver URL
Access Token
Element Web URL
No-Reply Address

Add course

Navigate to Site Administration. Select the Courses tab. In the Courses section, select Add a new course.

Fill in some data for a course.

Configuration	Value
Course full name	Example Course
Course short name	Example

Click Save and Display.

In the Participants section, click Enrol users.

In the Enrol users overlay, select the previously created administrator and assign the Teacher role.

Click Enrol users.

Click Proceed to course content.

Edit course

In the course view, click Turn editing on. In the Announcements section, click on Add an activity or resource.

In the Add an activity or resource overlay, click on Matrix to add a new matrix.

Click Save and Display.

Disable Recycle Bin during Development

Navigate to Site Administration. Select the Plugins tab. Select Category: Admin Tools.

In the Recycle Bin section, deselect Enable course recycle bin and Enable category recycle bin.

Click Save changes.

Stop and clean up development environment

To stop the local development environment, run

make docker-down

To clean up, remove the .data and vendor directories

rm -rf .data/ vendor/

Changelog

Please have a look at CHANGELOG.md.

Contributing

Please have a look at CONTRIBUTING.md.