Changelog

All notable changes to the Rocket.Chat local plugin are documented in this file.
Releases use Moodle-style names (e.g. v5.1-r3); see the Git tags for the full history.

v5.1-r3

Requires Moodle 5.1 (2025041400).

Changed

• Security: the local_rocketchat_* web service functions (course/role/event based sync toggles and
  the manual sync trigger) now validate the system context and require the local/rocketchat:manage
  capability. Previously any logged-in user could call them via AJAX.

Fixed

• The scheduled "Sync students" task crashed on every run after the first one (wrong class name), so
  the periodic sync never actually ran.


• A sync with an unreachable Rocket.Chat server is now recorded as a sync error on the course instead
  of crashing the whole sync task.


• Toggling the course, role or event based sync no longer fails on PHP 8 when the helper record is
  created for the first time (accidental variable variables).


• User, channel and subscription sync are now null-safe on failed API responses: transport errors are
  recorded as sync errors ("no response from server") instead of aborting with a crash.


• Enrolment suspensions are propagated again: the user activity update called users.update with an
  invalid user id and never took effect.


• Adding or removing a group member whose channel or user does not exist on Rocket.Chat no longer
  raises a type error during event based sync.


• The link account form no longer accepts credentials unverified when the Rocket.Chat server returns
  no parseable response; it now shows a validation error.


• Three web service functions returned an external_value object instead of the confirmation string,
  failing the return value validation of the web service layer.

Developer

• Extensive PHPUnit coverage for the API client, sync, channels, users, subscriptions, event observers,
  external functions, link account form, navigation hook and privacy provider. All Rocket.Chat traffic is
  simulated through \curl::mock_response(), so the suite runs without a Rocket.Chat instance.


• Test metadata uses PHPUnit attributes (#[CoversClass], #[DataProvider]) instead of the deprecated
  doc-comment annotations (removed in PHPUnit 12).


• CI uploads PHPUnit coverage to Codecov (badge in the README).


• The web service functions are built on the core_external classes instead of the deprecated
  externallib.php includes.

Earlier releases

• v5.1-r1 / v5.1-r2 (2026-01-18) - Moodle 5.1 support; Bootstrap 5 markup and improved settings tables.


• v4.0 - v4.5 (2022-2026) - Moodle 4.x support.


• v3.9 - v3.11 (2021-2022) - initial public releases.

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 public/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.

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.

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.

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.

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.

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.

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.

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.

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.

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 avaiable)


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/desubscription 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 install 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. I also added a bit of code to Rocket.Chat to make
integration a little easier. This unfortunately will require a custom build of the Rocket.Chat source code.

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.

Todo

• Add an block that can be added within a course to access after the channels in a popup.
  
  
  
  • This block should also allow the creation of private chats with other users from the course.
  
  
  
  


• Handle deletion/suspension:
  
  
  
  • of users in Moodle: Right now the sync only pushes students to Rocket.Chat. It does not remove them.
  
  
  • of groups in Moodle: Right now the channels will not be removed on the Rocket.Chat server. Maybe we don't want that?!
  
  
  
  


• Improve error reporting:
  
  
  
  • on sync failure
  
  
  • for suspensions
  
  
  
  

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 avaiable)


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/desubscription 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 install 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. I also added a bit of code to Rocket.Chat to make
integration a little easier. This unfortunately will require a custom build of the Rocket.Chat source code.

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.

Todo

• Add an block that can be added within a course to access after the channels in a popup.
  
  
  
  • This block should also allow the creation of private chats with other users from the course.
  
  
  
  


• Handle deletion/suspension:
  
  
  
  • of users in Moodle: Right now the sync only pushes students to Rocket.Chat. It does not remove them.
  
  
  • of groups in Moodle: Right now the channels will not be removed on the Rocket.Chat server. Maybe we don't want that?!
  
  
  
  


• Improve error reporting:
  
  
  
  • on sync failure
  
  
  • for suspensions
  
  
  
  

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 avaiable)


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/desubscription 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 install 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. I also added a bit of code to Rocket.Chat to make
integration a little easier. This unfortunately will require a custom build of the Rocket.Chat source code.

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.

Todo

• Add an block that can be added within a course to access after the channels in a popup.
  
  
  
  • This block should also allow the creation of private chats with other users from the course.
  
  
  
  


• Handle deletion/suspension:
  
  
  
  • of users in Moodle: Right now the sync only pushes students to Rocket.Chat. It does not remove them.
  
  
  • of groups in Moodle: Right now the channels will not be removed on the Rocket.Chat server. Maybe we don't want that?!
  
  
  
  


• Improve error reporting:
  
  
  
  • on sync failure
  
  
  • for suspensions
  
  
  
  

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 avaiable)


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/desubscription 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 install 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. I also added a bit of code to Rocket.Chat to make
integration a little easier. This unfortunately will require a custom build of the Rocket.Chat source code.

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.

Todo

• Add an block that can be added within a course to access after the channels in a popup.
  
  
  
  • This block should also allow the creation of private chats with other users from the course.
  
  
  
  


• Handle deletion/suspension:
  
  
  
  • of users in Moodle: Right now the sync only pushes students to Rocket.Chat. It does not remove them.
  
  
  • of groups in Moodle: Right now the channels will not be removed on the Rocket.Chat server. Maybe we don't want that?!
  
  
  
  


• Improve error reporting:
  
  
  
  • on sync failure
  
  
  • for suspensions