Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattermost-community/mattermost-plugin-jitsi
Jitsi plugin for Mattermost :electric_plug:
https://github.com/mattermost-community/mattermost-plugin-jitsi
hacktoberfest mattermost mattermost-plugin
Last synced: 7 days ago
JSON representation
Jitsi plugin for Mattermost :electric_plug:
- Host: GitHub
- URL: https://github.com/mattermost-community/mattermost-plugin-jitsi
- Owner: mattermost-community
- License: apache-2.0
- Created: 2018-03-21T20:22:18.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-17T08:58:33.000Z (29 days ago)
- Last Synced: 2025-01-01T09:03:00.680Z (14 days ago)
- Topics: hacktoberfest, mattermost, mattermost-plugin
- Language: Go
- Homepage:
- Size: 18.7 MB
- Stars: 204
- Watchers: 38
- Forks: 90
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- Awesome - Mattermost Plugin Jitsi - Jitsi plugin for Mattermost 🔌 (Communication and Collaboration Tools)
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 Jitsi Plugin (Beta)
[](https://circleci.com/gh/mattermost/mattermost-plugin-jitsi)
[](https://codecov.io/gh/mattermost/mattermost-plugin-jitsi)
[](https://github.com/mattermost/mattermost-plugin-jitsi/releases/latest)
[](https://github.com/mattermost/mattermost-plugin-jitsi/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Up+For+Grabs%22+label%3A%22Help+Wanted%22)
**Maintainer:** [@mickmister](https://github.com/mickmister)
**Originally developed by:** [Sean Sackowitz](https://github.com/seansackowitz).
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.
## 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](https://github.com/mattermost/mattermost-plugin-jitsi/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.
5. **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](./Makefile).
## Development
This plugin contains both a server and web app portion. Read our documentation about the [Developer Workflow](https://developers.mattermost.com/integrate/plugins/developer-workflow/) and [Developer Setup](https://developers.mattermost.com/integrate/plugins/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](plugin.json):
* 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](https://github.com/mattermost/mattermost-plugin-jitsi/issues/new/choose) or join the [Plugin: Jitsi channel](https://community.mattermost.com/core/channels/plugin-jitsi) on the Mattermost community server.
For a complete guide on contributing to the plugin, see the [Contribution Guidelines](CONTRIBUTING.md).