Skip to content

Brightscout/mattermost-plugin-profanity-filter

 
 

Repository files navigation

Disclaimer

This repository is community supported and not maintained by Mattermost. Mattermost disclaims liability for integrations, including Third Party Integrations and Mattermost Integrations. Integrations may be modified or discontinued at any time.

Mattermost Profanity Filter Plugin (Beta)

Build Status Code Coverage Release HW

This plugin allows you to censor profanity on your Mattermost server. The plugin checks all messages for matches against the configured "Bad words list" before they are posted to any channel. The characters in any word matches are replaced with a series of "*"s.

Supported Mattermost Server Versions: 5.2+

Plugin Marketplace

  1. Go to Main Menu > Plugin Marketplace in Mattermost.
  2. Search for "Profanity Filter" or manually find the plugin from the list and click Install
  3. Once the plugin has downloaded and been installed, click Configure.

Manual Installation

  1. Go to the releases page of this Github repository and download the latest release for your Mattermost server.
  2. Upload this file in the Mattermost System Console under System Console > Plugins > Management to install the plugin. To learn more about how to upload a plugin, see the documentation.
  3. Activate the plugin at System Console > Plugins > Management.

Usage

You can edit the bad words list in System Console > Plugins > Profanity Filter > Bad words list. In this list, you can use Regular Expressions to match bad words. For example, bad[[:space:]]?word will match both badword and bad word.

Choose to either censor the bad words with a character or reject the post with a custom warning message:

Post rejected by the plugin

Post censored by the plugin

About

A profanity filter plugin.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 70.3%
  • Makefile 29.7%