Communication: Difference between revisions
From MoodleDocs
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
If the [[Experimental settings|Experimental setting]] Enable communication providers (enablecommunicationsubsystem) is checked, admins can offer [https://en.wikipedia.org/wiki/Matrix_(protocol) Matrix] rooms or custom links to existing rooms for teachers to use with learners in their courses. | If the [[Experimental settings|Experimental setting]] Enable communication providers (enablecommunicationsubsystem) is checked, admins can offer [https://en.wikipedia.org/wiki/Matrix_(protocol) Matrix] rooms or custom links to existing rooms for teachers to use with learners in their courses. | ||
{{MediaPlayer | url = https://youtu.be/kVQNFqvpbR8 | desc = Course communication}} | {{MediaPlayer | url = https://youtu.be/kVQNFqvpbR8 | desc = Course communication}} | ||
==Course settings== | ==Course settings== | ||
* Teachers can access course communication options from Course navigation > More > Communication if the admin has enabled the feature (see Site administration settings below.) | * Teachers can access course communication options from Course navigation > More > Communication if the admin has enabled the feature (see Site administration settings below.) | ||
| Line 10: | Line 8: | ||
* Each provider can have their own different individual settings. | * Each provider can have their own different individual settings. | ||
* Start by choosing the provider from the available list | * Start by choosing the provider from the available list | ||
[[File:course provider.png|alt=Course Image|thumb]] | |||
===Matrix=== | ===Matrix=== | ||
* If the admin has set up a Matrix server for the site, a Matrix room will automatically be created when a new course is created. Teachers can configure the room settings by ensuring Matrix is selected as the provider. | * If the admin has set up a Matrix server for the site, a Matrix room will automatically be created when a new course is created. Teachers can configure the room settings by ensuring Matrix is selected as the provider. | ||
* If desired they can give the room a name and a topic. If they don't give the room a name then the course name is used instead. | * If desired they can give the room a name and a topic. If they don't give the room a name then the course name is used instead. | ||
[[File:MatrixProvider.png|center|700px]] | [[File:MatrixProvider.png|center|700px]] | ||
*A teacher will automatically have the moderator capability in the Matrix room. | *A teacher will automatically have the moderator capability in the Matrix room. | ||
===Custom link=== | ===Custom link=== | ||
If there is no Matrix server on the site, teachers can add a link to a Matrix room of their own or to a room in another messaging service such as Telegram by selecting Custom link as the provider and adding the relevant URL. | If there is no Matrix server on the site, teachers can add a link to a Matrix room of their own or to a room in another messaging service such as Telegram by selecting Custom link as the provider and adding the relevant URL. | ||
[[File:CustomLink.png|center|700px]] | [[File:CustomLink.png|center|700px]] | ||
===Room / service access=== | ===Room / service access=== | ||
Once saved the room will be available from a 'sticky' icon, present on all pages at the bottom of the screen above the information icon. | Once saved the room will be available from a 'sticky' icon, present on all pages at the bottom of the screen above the information icon. | ||
[[File:CommIcon.png|center|700px]] | [[File:CommIcon.png|center|700px]] | ||
==Site administration settings== | ==Site administration settings== | ||
Communication Providers in Moodle LMS are currently experimental and must be enabled in the "experimental settings". To Enable communication providers: | Communication Providers in Moodle LMS are currently experimental and must be enabled in the "experimental settings". To Enable communication providers: | ||
*Navigate to ''Site administration > Development > Experimental > Experimental settings.'' | *Navigate to ''Site administration > Development > Experimental > Experimental settings.'' | ||
*Check the checkbox nable communication providers (enablecommunicationsubsystem) | *Check the checkbox nable communication providers (enablecommunicationsubsystem) | ||
*Click the Save changes button. | *Click the Save changes button. | ||
Once the communication providers experimental setting is enabled they can be configured. | Once the communication providers experimental setting is enabled they can be configured. | ||
* Admins will then have a new section, Communication, from ''Site administration > Plugins''. From the page Manage communication providers, administrators can configure the installed communication provider plugins server for the site if desired and disable/enable the option for teachers to add custom links to messaging rooms in their courses. | * Admins will then have a new section, Communication, from ''Site administration > Plugins''. From the page Manage communication providers, administrators can configure the installed communication provider plugins server for the site if desired and disable/enable the option for teachers to add custom links to messaging rooms in their courses. | ||
[[File:Manage communication providers.png|center]] | [[File:Manage communication providers.png|center]] | ||
The currently supported communications providers are: | The currently supported communications providers are: | ||
*Custom link - Allows communication providers only requiring a URL (like Google Meet) to be linked to a Moodle LMS course | *Custom link - Allows communication providers only requiring a URL (like Google Meet) to be linked to a Moodle LMS course | ||
*Matrix - Allows for pairing a Matrix Element room to a Moodle course, including user management. | *Matrix - Allows for pairing a Matrix Element room to a Moodle course, including user management. | ||
===Matrix=== | ===Matrix=== | ||
The Matrix communication provider allows Moodle LMS courses to have an associated room in a [https://element.io/ Matrix Element] instance, and can provide adding and removing of participants in a course to a Matrix Element room. | The Matrix communication provider allows Moodle LMS courses to have an associated room in a [https://element.io/ Matrix Element] instance, and can provide adding and removing of participants in a course to a Matrix Element room. | ||
Currently the integration supports the [https://github.com/matrix-org/synapse Synapse] Matrix homeserver. To configure your Moodle LMS instance to connect to a Synapse server you will need the URL of the homeserver, and an API Access token for a Synapse Admin user. You will also need the URL of an Element web server to use. | |||
[[File:HomeserverURL.png|center]] | [[File:HomeserverURL.png|center]] | ||
To configure your Moodle LMS instance to use the Matrix provider: | To configure your Moodle LMS instance to use the Matrix provider: | ||
*Enter the URL of your Synapse server in the Homeserver URL (matrixhomeserverurl) field | *Enter the URL of your Synapse server in the Homeserver URL (matrixhomeserverurl) field | ||
| Line 57: | Line 42: | ||
*Enter the URL of the Element web server in the Element web URL (matrixelementurl) field | *Enter the URL of the Element web server in the Element web URL (matrixelementurl) field | ||
*Click Save changes. | *Click Save changes. | ||
====Synapse API Access Token Generation==== | ====Synapse API Access Token Generation==== | ||
To generate an API Access Token for Moodle LMS, you need access to a terminal and an existing username and password for and administrator of your Synapse server instance. | To generate an API Access Token for Moodle LMS, you need access to a terminal and an existing username and password for and administrator of your Synapse server instance. | ||
To generate an access token | To generate an access token to be used with Moodle LMS, enter the following into a terminal: | ||
<pre> | <pre> | ||
curl -XPOST -d '{"type":"m.login.password", "user":"@admin:synapse", "password":"secretpass"}' "https://synapse:8008/_matrix/client/r0/login" | curl -XPOST -d '{"type":"m.login.password", "user":"@admin:synapse", "password":"secretpass"}' "https://synapse:8008/_matrix/client/r0/login" | ||
</pre> | </pre> | ||
*Where the username is: | |||
*Where | |||
<pre> | <pre> | ||
@<user name on home server>:<home server domain> | @<user name on home server>:<home server domain> | ||
</pre> | </pre> | ||
*Password is the admin user's regular password. | *Password is the admin user's regular password. | ||
The returned value will look something like: | The returned value will look something like: | ||
<pre> | <pre> | ||
{"user_id":"@admin:synapse","access_token":"syt_YWRtaW4_OQNsHwWoObhseRAWmUCs_2T29if","home_server":"synapse","device_id":"JPAIBCQCSB"} | {"user_id":"@admin:synapse","access_token":"syt_YWRtaW4_OQNsHwWoObhseRAWmUCs_2T29if","home_server":"synapse","device_id":"JPAIBCQCSB"} | ||
</pre> | </pre> | ||
The access_token field is the API token to use in the Moodle LMS Matrix communication provider settings. | The access_token field is the API token to use in the Moodle LMS Matrix communication provider settings. | ||
==Capabilities== | ==Capabilities== | ||
*[[Capabilities/communication/matrix:moderator| Matrix moderator]]. | *[[Capabilities/communication/matrix:moderator| Matrix moderator]]. | ||
*[[Capabilities/moodle/course:configurecoursecommunication| Configure course communication settings]]. | *[[Capabilities/moodle/course:configurecoursecommunication| Configure course communication settings]]. | ||
[[https://docs.moodle.org/es/Comunicación]] | |||
[[es | |||
Revision as of 10:19, 3 December 2023
If the Experimental setting Enable communication providers (enablecommunicationsubsystem) is checked, admins can offer Matrix rooms or custom links to existing rooms for teachers to use with learners in their courses.
Course settings
- Teachers can access course communication options from Course navigation > More > Communication if the admin has enabled the feature (see Site administration settings below.)
- The different communications integrations are known as "providers".
- Each provider can have their own different individual settings.
- Start by choosing the provider from the available list
Matrix
- If the admin has set up a Matrix server for the site, a Matrix room will automatically be created when a new course is created. Teachers can configure the room settings by ensuring Matrix is selected as the provider.
- If desired they can give the room a name and a topic. If they don't give the room a name then the course name is used instead.
- A teacher will automatically have the moderator capability in the Matrix room.
Custom link
If there is no Matrix server on the site, teachers can add a link to a Matrix room of their own or to a room in another messaging service such as Telegram by selecting Custom link as the provider and adding the relevant URL.
Room / service access
Once saved the room will be available from a 'sticky' icon, present on all pages at the bottom of the screen above the information icon.
Site administration settings
Communication Providers in Moodle LMS are currently experimental and must be enabled in the "experimental settings". To Enable communication providers:
- Navigate to Site administration > Development > Experimental > Experimental settings.
- Check the checkbox nable communication providers (enablecommunicationsubsystem)
- Click the Save changes button.
Once the communication providers experimental setting is enabled they can be configured.
- Admins will then have a new section, Communication, from Site administration > Plugins. From the page Manage communication providers, administrators can configure the installed communication provider plugins server for the site if desired and disable/enable the option for teachers to add custom links to messaging rooms in their courses.
The currently supported communications providers are:
- Custom link - Allows communication providers only requiring a URL (like Google Meet) to be linked to a Moodle LMS course
- Matrix - Allows for pairing a Matrix Element room to a Moodle course, including user management.
Matrix
The Matrix communication provider allows Moodle LMS courses to have an associated room in a Matrix Element instance, and can provide adding and removing of participants in a course to a Matrix Element room.
Currently the integration supports the Synapse Matrix homeserver. To configure your Moodle LMS instance to connect to a Synapse server you will need the URL of the homeserver, and an API Access token for a Synapse Admin user. You will also need the URL of an Element web server to use.
To configure your Moodle LMS instance to use the Matrix provider:
- Enter the URL of your Synapse server in the Homeserver URL (matrixhomeserverurl) field
- Enter the Synapse server API Access token in the Access token (matrixaccesstoken) field
- Enter the URL of the Element web server in the Element web URL (matrixelementurl) field
- Click Save changes.
Synapse API Access Token Generation
To generate an API Access Token for Moodle LMS, you need access to a terminal and an existing username and password for and administrator of your Synapse server instance.
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"
- Where the username is:
@<user name on home server>:<home server domain>
- Password is the admin user's regular password.
The returned value will look something like:
{"user_id":"@admin:synapse","access_token":"syt_YWRtaW4_OQNsHwWoObhseRAWmUCs_2T29if","home_server":"synapse","device_id":"JPAIBCQCSB"}
The access_token field is the API token to use in the Moodle LMS Matrix communication provider settings.
Capabilities
[[1]]
