Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 3.48 KB

README.md

File metadata and controls

44 lines (35 loc) · 3.48 KB
Raw

Mattermost Google Calendar plugin

This plugin uses webhooks to post reminders from configured Google Calendar to your Mattermost channel.

Development status

Discontinued

Working Google Calendar plugin can be found at - https://github.com/mattermost/mattermost-plugin-google-calendar/tree/v0.2.0

Installation

Go to the GitHub releases tab and download the latest release for your server architecture. You can upload this file in the Mattermost system console to install the plugin.

We would need Google Oauth credentials before we can use the plugin. Below is the procedure on how to signup for Google Oauth credentials,

  1. Go to Google Cloud Dashboard and create a new project.
  2. After creating a project click on Go to APIs overview card from the dashboard which will take you to the API dashboard.
  3. Select Credentials from the left menu
  4. Now click on Create Credentials dropdown and select Oauth client ID option.
  5. While creating the Oauth credentials, enter the values of Authorized Javascript Origins as <Mattermost server URL> and the value of Authorised redirect URIs as <Mattermost server URL>/plugins/google-calendar/oauth/complete.
  6. After creating the Oauth client, copy the Client ID and secret.
  7. Upload the plugin to Mattermost and go to Google Calendar Plugin settings. Paste the client id and secret and select a user for the plugin to post event messages with.
  8. Enable the plugin and you should be able to see event reminder notifications.

Local setup

  1. Clone the repo and make sure mattermost server is up and running.
  2. Use ngrok or any other tunnel provider to expose the mattermost server port (8065) to Internet. The command to create a tunnel is ngrok http 8065.
  3. Above command provides a URL accessible from Internet. In plugin.go in line #91, replace p.API.GetConfig() with the URL.
  4. In the same method, in line #96, replace *config.ServiceSettings.SiteURL with config.
  5. Follow point 4 again in the lines line #202 and line #207.
  6. Login to Google Cloud Console and create a new project.
  7. Go to API library and make sure Google Calendar API is enabled.
  8. Go to API and Services and select Credentials tab from the left menu.
  9. Now click on Create Credentials dropdown and select Oauth client ID option.
  10. While creating the Oauth credentials, enter the values of Authorized Javascript Origins as http://localhost:8065 and the value of Authorised redirect URIs as http://localhost:8064/plugins/google-calendar/oauth/complete.
  11. After creating the Oauth client, copy the Client ID and secret.
  12. Upload the plugin to Mattermost and go to Google Calendar Plugin settings. Paste the client id and secret and select a user for the plugin to post event messages with.
  13. Enable the plugin and you should be able to see event reminder notifications.

TODO

  1. Better error handling
  2. Documentation
  3. Clean code?
  4. Remove completed events from the key value map.