Skip to content

Latest commit

 

History

History
101 lines (64 loc) · 6.17 KB

README.md

File metadata and controls

101 lines (64 loc) · 6.17 KB
Raw

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 Jitsi Plugin (Beta)

Build Status Code Coverage Release HW

Maintainer: @mickmister Originally developed by: Sean Sackowitz.

Start and join voice calls, video calls and use screen sharing with your team members with a Jitsi plugin for Mattermost.

Clicking a video icon in a Mattermost channel posts a message that invites team members to join a Jitsi meetings call.

image

Features

  • Use a /jitsi command to start a new meeting. Optionally append a desired meeting topic after the command.
  • Embed Jitsi meetings as a floating window inside Mattermost for a seamless experience.
  • Click a video icon in channel header to start a new Jitsi meeting in the channel. Not yet supported on mobile.
  • Use a /jitsi settings command to configure user preferences, including
    • whether Jitsi meetings appear as a floating window inside Mattermost or in a separate window
    • how meeting names are generated

The plugin has been tested on Chrome, Firefox and the Mattermost Desktop Apps.

Installation

  1. In GitHub, go to the Releases directory to download the plugin file.
  2. In Mattermost, go to System Console > Plugins > Plugin Management.
  3. Select Choose File to upload the plugin file.

Configuration

Go to System Console > Plugins > Jitsi and set the following values:

  1. Enable Plugin: true.
  2. Jitsi Server URL: The URL for your Jitsi server. If you set the Jitsi Server URL to https://meet.jit.si, it uses the public server provided by Jitsi.
  3. Embed Jitsi video inside Mattermost: When true, Jitsi video is embedded as a floating window inside Mattermost. This feature is experimental.
  4. (Optional) If your Jitsi server uses JSON Web Tokens (JWT) for authentication, set:
  • Use JWT Authentication for Jitsi: true.
  • App ID and App Secret used for JWT authentication.
  • Meeting Link Expiry Time in minutes. Defaults to 30 minutes.
  1. Jitsi Meeting Names: Select how Jitsi meeting names are generated by default. The user can optionally override this setting for themselves via /jitsi settings.
  • Defaults to using random English words in title case, but you can also use a UUID as the meeting link, or the team and channel name where the Jitsi meeting is created. You can also allow the user to choose the meeting name each time by default.

You're all set! To test it, go to any Mattermost channel and click the video icon in the channel header to start a new Jitsi meeting.

Localization

Mattermost Jitsi Plugin supports localization in multiple languages:

  • English
  • French
  • German
  • Spanish
  • Hungarian

The plugin automatically displays languages based on the following:

  • For system messages, the locale set in System Console > General > Localization > Default Server Language is used.
  • For user messages, such as help text and error messages, the locale set set in Account Settings > Display > Language is used.

Manual builds

You can use Docker to compile the binaries yourself. Run ./docker-make shell script which builds a Docker image with necessary build dependencies and runs make all afterwards.

You can also use make targets like dist (./docker-make dist) from the Makefile.

Development

This plugin contains both a server and web app portion. Read our documentation about the Developer Workflow and Developer Setup for more information about developing and extending plugins.

Releasing new versions

The version of a plugin is determined at compile time, automatically populating a version field in the plugin manifest:

  • If the current commit matches a tag, the version will match after stripping any leading v, e.g. 1.3.1.
  • Otherwise, the version will combine the nearest tag with git rev-parse --short HEAD, e.g. 1.3.1+d06e53e1.
  • If there is no version tag, an empty version will be combined with the short hash, e.g. 0.0.0+76081421.

To disable this behaviour, manually populate and maintain the version field.

Server

Inside the /server directory, you will find the Go files that make up the server-side of the plugin. Within there, build the plugin like you would any other Go application.

Web App

Inside the /webapp directory, you will find the JS and React files that make up the client-side of the plugin. Within there, modify files and components as necessary. Test your syntax by running npm run build.

Contributing

We welcome contributions for bug reports, issues, feature requests, feature implementations, and pull requests. Feel free to file a new issue or join the Plugin: Jitsi channel on the Mattermost community server.

For a complete guide on contributing to the plugin, see the Contribution Guidelines.