Moodle Rocket.Chat Sync Plugin

The Rocket.Chat plugin is an integration between Moodle that allows users to push students from Moodle into channels on Rocket.Chat. These channels correspond to their groups in Moodle.

Main features

1. Channel creation (private groups) for each Moodle group per course (Regex filter available)
2. User creation in Rocket.Chat based on role in Moodle (Filter available)
3. Subscribe all users based on group in course
4. Manual sync: Trigger manually by clicking the button on Course integration page
5. Background task sync: Activate pending sync checkbox on Course integration page
6. User activation/deactivation based on user_enrolment_updated Moodle event
7. User subscription/unsubscription based on user_group_enrolment_updated Moodle event

Installation

1. Copy this Rocket.Chat plugin to the local directory of your Moodle instance: git clone https://github.com/adpe/moodle-local_rocketchat.git local/rocketchat
2. Visit the notifications' page to complete the installation process

For more information, visit documentation for installing contributed modules and plugins.

Note - you need a running Rocket.Chat server that you can point the plugin to. If you aren't sure how to do this, checkout the documentation on Rocket.Chat.

Usage

Settings

A new Site Adminstration section has been added under Rocket.Chat. The Settings page allows administrators to enter the host, port, username and password for the Rocket.Chat connection. To get these settings you need to create a user on Rocket.Chat with whatever credentials you want and paste them into Moodle.

The regex block allows you to add group regex filters. When a sync between Moodle and Rocket.Chat happens, channels are created for each group that matches your regex expression. You can have multiple expressions on new lines. If you don't want any groups, don't add any regex expressions.

Integration

There are two tables that help control what data is pushed to Rocket.Chat.

1. Roles Included in Sync: Determines what user roles can be pushed to Rocket.Chat
2. Integrated Courses: allows setting of a course to sync in the background (task and cron based) or a manual sync that is executed immediately.