root

Mattermost Moodle Notification Plugin

A Mattermost notification plugin for Moodle. It helps mattermost users to recieve notification from moodle. This plugin is a required companion of the Mattermost Message Processor plugin.

Installation

1. You can get the latest version on the releases page.
2. Upload this file in the Mattermost System Console > Plugins > Management page to install the plugin. To learn more about how to upload a plugin, see the documentation.
3. After installing the plugin, you should go to the plugin's settings in System Console and set the Webhook Secret (more about this below).

System Console Settings

• Secret: Setting a webhook secret allows you to ensure that POST requests sent to the payload URL are from Moodle, and is used with every request that is made from Moodle to Mattermost.

Building the plugin

• Make sure you have following components installed:

  • Go - v1.16 - Getting Started

    Note: If you have installed Go to a custom location, make sure the $GOROOT variable is set properly. Refer Installing to a custom location.

  • NodeJS - v14.17 and NPM - Downloading and installing Node.js and npm.
  • Make

• Note that this project uses Go modules. Be sure to locate the project outside of $GOPATH. To learn more about plugins, see plugin documentation.

• Build your plugin:

  make dist
  

• This will produce a single plugin file (with support for multiple architectures) for upload to your Mattermost server:

  dist/com.mattermost.moodle-notification-x.y.z.tar.gz
  

Development

To avoid having to manually install your plugin, build and deploy your plugin using one of the following options.

Deploying with Local Mode

If your Mattermost server is running locally, you can enable local mode to streamline deploying your plugin. Edit your server configuration as follows:

{
    "ServiceSettings": {
        ...
        "EnableLocalMode": true,
        "LocalModeSocketLocation": "/var/tmp/mattermost_local.socket"
    }
}

and then deploy your plugin:

make deploy

You may also customize the Unix socket path:

export MM_LOCALSOCKETPATH=/var/tmp/alternate_local.socket
make deploy

If developing a plugin with a webapp, watch for changes and deploy those automatically:

export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
export MM_ADMIN_TOKEN=j44acwd8obn78cdcx7koid4jkr
make watch

Deploying with credentials

Alternatively, you can authenticate with the server's API with credentials:

export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
export MM_ADMIN_USERNAME=admin
export MM_ADMIN_PASSWORD=password
make deploy

or with a personal access token:

export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
export MM_ADMIN_TOKEN=j44acwd8obn78cdcx7koid4jkr
make deploy

Made with ♥ by Brightscout