https://github.com/mattermost-community/mattermost-plugin-profanity-filter

A profanity filter plugin.
https://github.com/mattermost-community/mattermost-plugin-profanity-filter

hacktoberfest mattermost mattermost-plugin

Last synced: 6 months ago
JSON representation

A profanity filter plugin.

• Host: GitHub
• URL: https://github.com/mattermost-community/mattermost-plugin-profanity-filter
• Owner: mattermost-community
• License: apache-2.0
• Created: 2018-05-14T22:57:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-26T16:53:45.000Z (over 1 year ago)
• Last Synced: 2025-04-14T12:14:16.989Z (6 months ago)
• Topics: hacktoberfest, mattermost, mattermost-plugin
• Language: Go
• Homepage:
• Size: 18.9 MB
• Stars: 20
• Watchers: 31
• Forks: 27
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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](https://img.shields.io/circleci/project/github/mattermost/mattermost-plugin-profanity-filter/master.svg)](https://circleci.com/gh/mattermost/mattermost-plugin-profanity-filter)

[![Code Coverage](https://img.shields.io/codecov/c/github/mattermost/mattermost-plugin-profanity-filter/master.svg)](https://codecov.io/gh/mattermost/mattermost-plugin-profanity-filter)

[![Release](https://img.shields.io/github/v/release/mattermost/mattermost-plugin-profanity-filter)](https://github.com/mattermost/mattermost-plugin-profanity-filter/releases/latest)

[![HW](https://img.shields.io/github/issues/mattermost/mattermost-plugin-profanity-filter/Up%20For%20Grabs?color=dark%20green&label=Help%20Wanted)](https://github.com/mattermost/mattermost-plugin-profanity-filter/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Up+For+Grabs%22+label%3A%22Help+Wanted%22)

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+**

## Installation

1. Go to the [releases page of this Github repository](https://github.com/mattermost/mattermost-plugin-profanity-filter/releases) 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](https://docs.mattermost.com/administration/plugins.html#plugin-uploads).

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](./images/post-rejected.gif)

![Post censored by the plugin](./images/post-censored.gif)