https://github.com/cpanato/mattermost-plugin-broadcast-message
Broadcast a message to Mattermost users
https://github.com/cpanato/mattermost-plugin-broadcast-message
announcements broadcast mattermost mattermost-plugin
Last synced: 8 months ago
JSON representation
Broadcast a message to Mattermost users
- Host: GitHub
- URL: https://github.com/cpanato/mattermost-plugin-broadcast-message
- Owner: cpanato
- License: apache-2.0
- Created: 2020-08-21T11:44:06.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-10T16:54:48.000Z (about 4 years ago)
- Last Synced: 2025-02-01T06:51:14.924Z (8 months ago)
- Topics: announcements, broadcast, mattermost, mattermost-plugin
- Language: Go
- Homepage:
- Size: 1.52 MB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Broadcast messages
If you need to send a message to all users in a Mattermost Team to notify those users for something very important you can use this plugin.
It will send a DM message with your message to all users, and if the email notification is enabled the users will get the email as well.
Use cases:
- Notify the user when will have some maintanance in the Mattermost instance.
- Communicate an important message to all users.
## Installation
Upload your plugin and then go to the plugin settings to generate the internal Token.
## Usage
To use the plugin, only users with the role of `system administrators` can use that, for other users the command will be blocked.
You can use by typing `/broadcast-message ` or just `/broadcast-message`, if you post the second it will open an dialog to you fill the message.
## 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](https://docs.mattermost.com/administration/mmctl-cli-tool.html#local-mode) to streamline deploying your plugin. Edit your server configuration as follows:
```json
{
"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](https://docs.mattermost.com/developer/personal-access-tokens.html):
```
export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
export MM_ADMIN_TOKEN=j44acwd8obn78cdcx7koid4jkr
make deploy
```