Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 3.01 KB

README.md

File metadata and controls

47 lines (34 loc) · 3.01 KB
Raw

Mattermost Autotranslation Plugin (Beta)

Build Status Code Coverage Release HW

Maintainer: @saturninoabril

Autotranslation plugin for Mattermost.

Message autotranslation is powered by Amazon Translate which is a text translation service that uses advanced machine learning technologies to provide high-quality translation on demand. Amazon Translate can translate text between the languages listed in its website.

Feature

  • Translate option available at dropdown menu of each regular post.
  • Slash commands to change user settings using /autotranslate slash command
    • Check user info by issuing /autotranslate info to see current user setting
    • Turn on/off translation by issuing /autotranslate [on|off]
    • Change source language translation by initiating /autotranslate source [language code]
    • Change target language translation by initiating /autotranslate target [language code]
  • Supported Languages and its codes can be found at Amazon Translate website.

Installation

Requires Mattermost 5.22 or higher

  1. Install the plugin
    1. Download the latest version of the plugin from the GitHub releases page
    2. In Mattermost, go to the System Console -> Plugins -> Management
    3. Upload the plugin
  2. Spin up Amazon Translate https://aws.amazon.com/translate/
  3. In Mattermost, go to System Console -> Plugins -> Autotranslate * Fill in the AWS Access Key ID, Secret Access Key and Region
  4. Enable the plugin
    • Go to System Console -> Plugins -> Management and click "Enable" underneath the Autotranslate plugin
  5. Test it out
    • In Mattermost, run the slash command /autotranslate on and see if Translate option becomes available at dropdown menu of a post.

Developing

This plugin contains both a server and web app portion.

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

Use make check-style to check the style.

Use make localdeploy to deploy the plugin to your local server. You will need to restart the server to get the changes.