README.md 1.13 KB
Newer Older
Benjamin Pill's avatar
Benjamin Pill committed
1
# Mattermost New Channel Notify Plugin
Benjamin Pill's avatar
Benjamin Pill committed
2 3 4

A plugin for Mattermost to notify all users about newly created channels.

Benjamin Pill's avatar
Benjamin Pill committed
5 6
![screenshot](https://i.imgur.com/SII7ZEi.png)

Benjamin Pill's avatar
Benjamin Pill committed
7 8 9 10
## Installation

__Requires Mattermost 5.10 or higher.__

11
Download the [latest release here](https://gitlab.com/thepill/mattermost-plugin-newchannelnotify/uploads/19c494d648d735746698c6cd73f71c2b/mattermost-plugin-newchannelnotify-0.9.3.tar.gz) (SHA256: `ca281d4751c32d415e7a6ba6c69e47fa5f3efa4619eb72bc0772b76465a55a05`)
Benjamin Pill's avatar
Benjamin Pill committed
12

Benjamin Pill's avatar
Benjamin Pill committed
13 14
In production, deploy and upload your plugin via the [System Console](https://about.mattermost.com/default-plugin-uploads).

Jason Blais's avatar
Jason Blais committed
15
Optionally, change `settings` under the plugins settings menu in System Console:
Benjamin Pill's avatar
Benjamin Pill committed
16 17 18
- Bot Name
- Channel to Post
- Include private channels
Benjamin Pill's avatar
Benjamin Pill committed
19
- Mention
20
- IncludeChannelPurpose
Benjamin Pill's avatar
Benjamin Pill committed
21 22 23 24 25 26 27 28 29 30 31 32

## Developing 

Use `make dist` to build distributions of the plugin that you can upload to a Mattermost server.

Use `make deploy` to deploy the plugin to your local server. Before running `make deploy` you need to set a few environment variables:

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