note: development on this project has ceased, and instead will become a core part of mattermost-server

mattermost-plugin-remind

Developed during Mattermost Plugins Hackathon 2018

current status

• timezone aware
• reminders with messages can be set
  • only one pattern currently supported
    • /remind (me or @user or ~channel) "message" in X seconds

planned

• feature parity with mattermost-remind
• unit testing
• structure/packaging/style mimicking mattermost-plugin-zoom
• complete webapp functionality
• any additional requests

usage

See the full list of Usage Examples in the wiki

• /remind help
• /remind list
• /remind clear
• /remind version
• /remind [who] [what] [when]
  • /remind [who] [what] in [# (seconds|minutes|hours|days|weeks|months|years)]
  • /remind [who] [what] at [(noon|midnight|one..twelve|00:00am/pm|0000)] (every) [day|date]
  • /remind [who] [what] (on) [(Monday-Sunday|Month&Day|MM/DD/YYYY|MM/DD)] (at) [time]
  • /remind [who] [what] every (other) [Monday-Sunday|Month&Day|MM/DD] (at) [time]
• /remind [who] [when] [what]

requirements

• Mattermost
• Go
• Dep
• HTTPPie

setup

Mattermost config.json changes

Setup siteUrl (set to your url)

...
"SiteURL": "http://127.0.0.1",
...

Enable timezones (each user set timezone)

...
   "DisplaySettings": {
        "CustomUrlSchemes": [],
        "ExperimentalTimezone": true
    },
...

Enable plugin uploads

...
"PluginsSetting": {
  ...
  "EnableUploads": true,
  ...
}

Building

make

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

dist/io.github.mattermost-plugin-remind.tar.gz

There is a build target to automate deploying and enabling the plugin to your server, but it requires configuration and http to be installed:

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

In production, deploy and upload your plugin via the System Console.