Mattermost Giphy Plugin
This plugin bring the magic of Giphy translate to Mattermost. For a stable production release, please download the latest version in the Releases tab and follow these instructions for install and configuration.
Table of Contents
Requirements
- For Giphy Plugin 1.0, Mattermost Server v5.14+ is required
- Giphy plugin requires configuring a Giphy API Key.
1. Users
The giphy plugin implements a /giphy command which can be used to look up and post images for phrases.
It uses the Giphy Translate API.
Usage:
/giphy <some search query>
- For instance, typing
/giphy Hello, strange world of giphy!will display,
This is presented only to the user who typed the message and is not posted to the channel, yet.
- To get a different image from Giphy, try "Shuffle",
- To post to the channel, press "Send",
At this point, the image appears in the channel, and all participants see it as a new message from the user.
2. System administrators
- Go to System Console > Plugins > Giphy, and enter your Giphy API Key, the desired MPAA rating (Y, G, PG, PG-13, R, Unrated, or NSFW), and the weirdness value (randomness) of GIF suggestions (0-10 values)
- Go to System Console > Plugins > Management and click Enable to enable the Giphy plugin.
3. Developers
- TODO
Use make dist to build distributions of the plugin that you can upload to a Mattermost server.
Use make all to run all checks and build.
Use make deploy to deploy the plugin to your local server.
For additional information on developing plugins, refer to our plugin developer documentation.
4. Frequently Asked Questions (FAQ)
How do I disable the plugin quickly in an emergency?
Disable the Giphy plugin any time from System Console > Plugins > Management.
5. Help
For Mattermost customers - please open a support case. For Questions, Suggestions and Help - please find us on our forum at https://forum.mattermost.org/c/plugins To Contribute to the project see https://www.mattermost.org/contribute-to-mattermost/