https://github.com/mattermost/mattermost-marketplace
The stateless HTTP service backing the Mattermost marketplace.
https://github.com/mattermost/mattermost-marketplace
mattermost mattermost-plugin
Last synced: 5 months ago
JSON representation
The stateless HTTP service backing the Mattermost marketplace.
- Host: GitHub
- URL: https://github.com/mattermost/mattermost-marketplace
- Owner: mattermost
- License: apache-2.0
- Created: 2019-08-02T21:03:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-12T18:16:03.000Z (11 months ago)
- Last Synced: 2024-11-12T19:24:01.260Z (11 months ago)
- Topics: mattermost, mattermost-plugin
- Language: Go
- Homepage: http://integrations.mattermost.com
- Size: 23.7 MB
- Stars: 38
- Watchers: 36
- Forks: 24
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - mattermost-marketplace
README
# Plugin Marketplace
The Plugin Marketplace is a collection of plugins for use with [Mattermost](https://github.com/mattermost/mattermost-server). This repository houses the stateless HTTP service that is run at https://api.integrations.mattermost.com. It is meant to be queried by the Mattermost server to enable plugin discovery by System Admins.
Although Mattermost hosts the Marketplace as an AWS Lambda function backed by S3 and CloudFront, the core feature set is designed for use in any hosting environment, enabling private, self-hosted collections of plugins.
Read more about the [Plugin Marketplace Architecture](https://docs.google.com/document/d/1tVj0eNwMdIIGn8YoTs-cYz9NYvXjqx6bqWH-wa-yDLk/edit).
## Other Resources
This repository houses the open-source components of the Plugin Marketplace. Other resources are linked below:
- [Mattermost the server and user interface](https://github.com/mattermost/mattermost-server)
## Get Involved
- [Join the discussion on ~Plugin Marketplace](https://community.mattermost.com/core/channels/plugins-marketplace)
## Developing
### Environment Setup
1. Install [Go](https://golang.org/doc/install)
### Running
Simply run the following:
```
$ make run-server
```
### Testing
Running all tests:
```
$ make test
```
### Proxying upstream
The marketplace can be configured to proxy to an upstream marketplace, overlaying any locally defined plugins on top of the remote service. Invoke the server with the appropriate flag:
```
go run ./cmd/marketplace server --upstream https://api.integrations.mattermost.com
```
To compile this flag into the binary such as when building the lambda function, define the appropriate environment variable:
```
export BUILD_UPSTREAM_URL=https://api.integrations.mattermost.com
make build-lambda
```
### Add a new release of a plugin to the Marketplace
To add a new release for a plugins, run
```
go run ./cmd/generator/ add $REPOSITORY $VERSION [--official|--community]
```
e.g.
```
go run ./cmd/generator/ add mattermost-plugin-jitsi v2.0.0 --official
```
`generator add` supports additional flags. See `generator add --help` for more details.
Make sure to double check the `diff` of `plugins.json` to ensure the release get added correctly.
### Deploying as a Lambda Function
In addition to running as a standalone server, the Marketplace is also designed to run as a Lambda function, compiling the `plugins.json` database into the binary for immediate access without further configuration.
### Automatic Deployment
Changes merged to `master` are automatically deployed to https://api.staging.integrations.mattermost.com.
Changes merged to `production` are automatically deployed to https://api.integrations.mattermost.com.
When adding or updating the plugins database (or corresponding tooling), submit the changes directly to `production`, and then merge `production` immediately back to `master` to reduce unnecessary merge conflicts. All other changes should be committed directly to `master`. Changes pending release from `master` should be merged to `production` after qualification and in coordination with any supporting Mattermost server release.
### Manual Deployment
Simply run the following:
```
$ SLS_STAGE=staging make deploy-lambda
```
To iterate quickly after the Cloud Formation stack is up, simply run:
```
$ SLS_STAGE=staging make deploy-lambda-fast
```