Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand app quick start guides #1106

Merged
merged 37 commits into from
Oct 7, 2022
Merged
Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
7324994
Update pre-existing guides
azigler Aug 23, 2022
a56b17d
Update refs
azigler Aug 24, 2022
0c986ea
Update refs
azigler Aug 24, 2022
80371ba
Remove refs
azigler Aug 24, 2022
01ff486
Merge branch 'master' into azigler-restructure-app-guides
mattermod Aug 24, 2022
1c60676
Improve internal doc links to quick start guides
azigler Aug 24, 2022
f18c650
Add Golang JWT guide
azigler Aug 24, 2022
efbafaa
Update app quick start serverless guide
azigler Aug 25, 2022
1e8ad8a
Merge branch 'master' into azigler-restructure-app-guides
mattermod Aug 25, 2022
fbcf2d2
Merge branch 'azigler-restructure-app-guides' of https://github.com/m…
azigler Aug 25, 2022
f83c2c6
Link to repository examples from guides
azigler Aug 26, 2022
60d7a5f
Remove webhook link for now
azigler Aug 26, 2022
84212f9
Tidy up serverless guide links
azigler Aug 26, 2022
60b6123
Try new ref
azigler Aug 26, 2022
5ecbc67
Fix refs
azigler Aug 26, 2022
cd313c0
Fix last ref
azigler Aug 26, 2022
23c76aa
Add language to JWT tutorial link
azigler Aug 26, 2022
4d18e35
Make language more consistent
azigler Aug 29, 2022
e7c9ddd
Merge branch 'master' into azigler-restructure-app-guides
azigler Aug 29, 2022
1014358
Use singular container word
azigler Aug 29, 2022
6810e11
Fix page weights and names
azigler Aug 30, 2022
3c2338f
Fix refs
azigler Aug 30, 2022
dd60347
Incorporate Michael's feedback
azigler Aug 31, 2022
fe0a618
Remove specificity for webhook payload
azigler Aug 31, 2022
bdfcae0
Clarify need for .docker.env file
azigler Sep 1, 2022
3cfc775
Update site/content/integrate/apps/quickstart/_index.md
azigler Sep 2, 2022
7760044
Merge branch 'master' into azigler-restructure-app-guides
azigler Sep 12, 2022
e5760fe
Merge branch 'master' into azigler-restructure-app-guides
azigler Sep 16, 2022
1acf0cf
Merge branch 'master' into azigler-restructure-app-guides
cwarnermm Sep 28, 2022
18451aa
Merge branch 'master' into azigler-restructure-app-guides
levb Sep 29, 2022
f7b4534
Apply suggestions from Alan's review
azigler Oct 6, 2022
017eb6c
Apply suggestions from Alan's review
azigler Oct 6, 2022
3e49312
Implement more suggestions from Alan
azigler Oct 6, 2022
cb45231
Merge branch 'master' into azigler-restructure-app-guides
azigler Oct 6, 2022
d0ed0d0
Merge branch 'master' into azigler-restructure-app-guides
mattermod Oct 6, 2022
9310637
Fix broken link
azigler Oct 6, 2022
0907ad5
Merge branch 'master' into azigler-restructure-app-guides
cwarnermm Oct 7, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 29 additions & 28 deletions site/content/integrate/apps/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,24 @@ description: "Apps are lightweight interactive add-ons to Mattermost."
weight: 30
---

Apps are lightweight, interactive add-ons to Mattermost which can be hosted as HTTP services, or as serverless functions on AWS Lambda, OpenFaaS, Kubernetes, etc. to run without dedicated infrastructure. Apps can:
Apps are lightweight, interactive add-ons to Mattermost. They are hosted as their own service, as opposed to plugins which run directly alongside the server process.

Apps can:

- Display interactive, dynamic modal forms and message actions.
- Be written in any language.
- Attach themselves to locations in the Mattermost user interface (e.g. channel bar buttons, post menu, channel menu, commands), and can add their custom slash commands with full autocomplete.
- Attach themselves to locations in the Mattermost user interface (e.g. channel bar buttons, post menu, channel menu, commands), and add their custom slash commands with full autocomplete.
- Receive webhooks from Mattermost, and third-parties, and use the Mattermost REST APIs to post messages, etc.
- Work on both Mobile and Desktop clients so developers can focus on the functionality of their apps.
- Be deployed using our serverless hosting infrastructure keeping data secure and supporting scalability by being stateless.
- Work on both Mobile and Desktop clients. This way, developers can focus on the features of their Apps without writing code for each specific platform.
- Include dynamic fields, code as an on-demand function, and interactive modals.
azigler marked this conversation as resolved.
Show resolved Hide resolved

When you develop using the Apps Framework, your apps can:
When you develop using the Apps framework, your Apps can:

- Create slash commands
azigler marked this conversation as resolved.
Show resolved Hide resolved

![image](app-slash-command-zoomed-in.png)

- Post messages to channels
- Post messages to channels (and anything else possible with [Mattermost's API](https://api.mattermost.com/))
azigler marked this conversation as resolved.
Show resolved Hide resolved

![image](app-bot.png)

Expand All @@ -33,53 +34,53 @@ When you develop using the Apps Framework, your apps can:

Apps are now generally available and we always appreciate your feedback! Share constructive feedback in the [Mattermost Apps channel](https://community.mattermost.com/core/channels/mattermost-apps) on our Mattermost community instance.

Read the [JavaScript start guide]({{< ref "quickstart/quick-start-js" >}}) or [Go quick start guide]({{< ref "quickstart/quick-start-go" >}}) to learn how to write your first App.
We have quick start guides for [TypeScript]({{< ref "quickstart/quick-start-ts" >}}), [Go]({{< ref "quickstart/quick-start-go" >}}), and [Python]({{< ref "quickstart/quick-start-python" >}}) to learn how to write your first App.

## FAQ

### When would you build an app vs. a custom slash command vs. a webhook vs. a plugin?
### When would you build an App vs. a custom slash command vs. a webhook vs. a plugin?

That depends on your use case, as they each have benefits.

The built-in [incoming webhook]({{< ref "/integrate/webhooks/incoming" >}}) is great for simple use cases. It requires the incoming payload to contain a valid {{< newtabref href="https://pkg.go.dev/github.com/nhannv/mattermost-server/model#Post" title="Post" >}} JSON object, but some external systems don't allow customization of the fields included in the webhook payload. Compared to built-in webhooks, an App or plugin can be customized to receive an HTTP webhook posting from another system, and can process the incoming data then augment it or make an actionable message in a channel.
Each type of existing integration type is sort of a la carte, whereas the App framework is an all-in-one package that supports its own version of some of those out of the box. Meaning when you install an App, you don't need to go create a separate bot account, OAuth app, webhooks etc. Some pieces are reused, such as the bot account mechanism, but some pieces were remade and are not reused, such as webhooks.
azigler marked this conversation as resolved.
Show resolved Hide resolved

In the case of webhooks, the existing mechanism is only able to create posts, and only accepts an [incoming webhook]({{< ref "/integrate/webhooks/incoming" >}}) payload. It does not support other logic for handling arbitrary data structures from external systems.

A plugin should be used when you need to [directly alter the UI]({{< ref "integrate/plugins/components/webapp/best-practices" >}}) in Mattermost or you have a feature that requires low latency with the server (such as replacing characters in any message [before it is saved]({{< ref "integrate/plugins/components/server/reference#Hooks.MessageWillBePosted" >}})). Currently, plugins have several [UX hooks]({{< ref "integrate/plugins/components/server/reference#Hooks" >}}) that apps cannot access, however we plan to add/migrate more UX hooks into the Apps Framework over time. Please see the [plugin documentation]({{< ref "integrate/plugins" >}}) for more information.
A plugin should be used when you need to [directly alter the UI]({{< ref "integrate/plugins/components/webapp/best-practices" >}}) in Mattermost or you have a feature that requires low latency with the server (such as replacing characters in any message [before it is saved]({{< ref "integrate/plugins/components/server/reference#Hooks.MessageWillBePosted" >}})). It should be noted that plugins have several [UX hooks]({{< ref "integrate/plugins/components/server/reference#Hooks" >}}) that Apps cannot access. Please see the [plugin documentation]({{< ref "integrate/plugins" >}}) for more information.
azigler marked this conversation as resolved.
Show resolved Hide resolved

### What's the difference between the Apps framework and the plugin framework?

The Apps Framework provides a few differences from plugins, including:
The Apps framework provides a few differences from plugins, including:

- Interactive elements are easier to use and develop.
- Compatible with both Mobile and Desktop clients without any extra code.
- Interactive elements are easier to use and develop.
- Compatible with both Mobile and Desktop clients without any extra code.

### What language should I use to write apps?
### What language should I use to write Apps?

Any language you want. We currently have an [official driver for Go](https://pkg.go.dev/github.com/mattermost/mattermost-plugin-apps/apps), and we are planning to release other drivers in the future in conjunction with our community.
Any language you want. We currently have an [official driver for Go](https://pkg.go.dev/github.com/mattermost/mattermost-plugin-apps/apps).
azigler marked this conversation as resolved.
Show resolved Hide resolved

### How and where will my app be hosted?
### How and where will my App be hosted?

1. **[Mattermost Cloud](https://mattermost.com/mattermost-cloud/)** apps. Cloud
customers can use apps from Mattermost Marketplace. Marketplace apps are
1. **[Mattermost Cloud](https://mattermost.com/mattermost-cloud/)** Apps. Cloud
customers can use Apps from Mattermost Marketplace. Marketplace Apps are
deployed as AWS Lambda functions, and their usage is included in the service.
You can find more information about the Marketplace [here](https://mattermost.com/marketplace/). Example AWS Lambda apps can be
You can find more information about the Marketplace [here](https://mattermost.com/marketplace/). Example AWS Lambda Apps can be
found
[here](https://github.com/mattermost/mattermost-plugin-apps/tree/master/examples/js/aws_hello)
(JavaScript) and
[here](https://github.com/mattermost/mattermost-plugin-apps/tree/master/examples/go/hello-serverless)
(go).
2. **External** (HTTP) apps. Apps can be hosted as publicly (or privately) available HTTP
[here](https://github.com/mattermost/mattermost-app-examples/tree/master/golang/serverless)
azigler marked this conversation as resolved.
Show resolved Hide resolved
(Go).
2. **External** (HTTP) Apps. Apps can be hosted as publicly (or privately) available HTTP
services, the choice of hosting provider is yours. A self-managed Mattermost
customer would be able to install your app from a URL. External apps are not
customer would be able to install your App from a URL. External Apps are not
currently accepted in the Mattermost Marketplace.
3. **Customer-deployable** apps. An app can be packaged as a bundle, deployable
3. **Customer-deployable** Apps. An App can be packaged as a bundle, deployable
by the customer in their own hosting environment. Currently, [AWS
Lambda](https://aws.amazon.com/lambda/),
[OpenFaaS](https://www.openfaas.com/), and [Kubeless](https://kubeless.io/)
are supported, with plans for more serverless platforms, Kubernetes, and
docker compose. Customer-deployable apps are not yet distributed via the
docker compose. Customer-deployable Apps are not yet distributed via the
azigler marked this conversation as resolved.
Show resolved Hide resolved
Mattermost Marketplace.

### Can I write "internal" organization-specific apps?
### Can I write "internal" organization-specific Apps?

Yes. They can be packaged as "customer-deployable" bundles and then deployed on
the supported serverless platforms, or run as HTTP services on the
Expand Down
69 changes: 58 additions & 11 deletions site/content/integrate/apps/quickstart/_index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,65 @@
---
title: Quick start
description: Guides for quickly getting started building apps
title: Apps - Developer setup
azigler marked this conversation as resolved.
Show resolved Hide resolved
description: Developer setup and guides for quickly getting started building Apps
weight: 10
---

The Apps quick start guides get you started developing your App in a variety of languages.
To get started making Mattermost Apps, the first thing you need to do is set up your development environment via the [mattermost-app-examples repository](https://github.com/mattermost/mattermost-app-examples). Then you can follow language-specific guides to get started with the Apps framework, or just start tinkering on your own.

| Language | Guide |
|-------------------------|---------------------------------------------------------------------------------------------------|
| Golang | [Quick start guide (Go)]({{< ref "/integrate/apps/quickstart/quick-start-go" >}}) |
| Golang (Serverless) | [Quick start guide (serverless)]({{< ref "/integrate/apps/quickstart/quick-start-serverless" >}}) |
| JavaScript / TypeScript | [Quick start guide (NodeJS)]({{< ref "/integrate/apps/quickstart/quick-start-js" >}}) |
## Prerequisites

## Tests
You need the latest version of [Docker Desktop](https://docs.docker.com/desktop/) (Windows, Mac, or Linux desktop application) or [Docker Engine](https://docs.docker.com/engine/) (CLI) installed.

### Coming soon!
In the future this section will describe how to set up an environment for testing Apps.
## Set up your development environment

Clone and enter a local copy of the [mattermost-app-examples repository](https://github.com/mattermost/mattermost-app-examples) with the following command:
azigler marked this conversation as resolved.
Show resolved Hide resolved

```sh
git clone https://github.com/mattermost/mattermost-app-examples && cd mattermost-app-examples
azigler marked this conversation as resolved.
Show resolved Hide resolved
```

When you're developing your own App, you need an actual Mattermost Server to be running. The development environment accomplishes this by using a [`docker-compose.yml`](https://github.com/mattermost/mattermost-app-examples/blob/master/docker-compose.yml) with a network named `mattermost-apps-dev`. This Docker Compose file has just two containers: the Mattermost Server and a Postgres database.

The Mattermost image itself is preconfigured with settings for local App development but you can customize them. For example, the `MM_SERVICESETTINGS_SITEURL` environment variable is set to `http://mattermost:8065` on the Mattermost container, but you could change this to be any URL, like one from [ngrok](https://ngrok.com/) or [Gitpod](https://gitpod.io/).
azigler marked this conversation as resolved.
Show resolved Hide resolved

Because they exist on a pre-defined network, other `docker-compose.yml` configurations can connect their containers to this development environment by specifying the same `mattermost-apps-dev` Docker network. Then the Mattermost Server can be accessed at `http://mattermost:8065` by any other container on the `mattermost-apps-dev` network. Similarly, your own development Apps can then be accessed by Mattermost via their service name (e.g., `http://mattermost-apps-typescript-hello-world:4000`). You can learn more about Docker networks in the [official documentation](https://docs.docker.com/network/).
azigler marked this conversation as resolved.
Show resolved Hide resolved

You can also access Mattermost from outside the Docker network via [http://localhost:8065](http://localhost:8065). Similarly, the examples provided in the [mattermost-app-examples repository](https://github.com/mattermost/mattermost-app-examples) can be accessed at their designated ports on `localhost`. This is because the Docker Compose files have been configured to expose the appropriate ports locally.

To change the Mattermost Apps plugin or the Mattermost Server versions, you can edit [`docker-compose.yml`](https://github.com/mattermost/mattermost-app-examples/blob/master/docker-compose.yml).

Next, use the following command to bring your development environment online.

azigler marked this conversation as resolved.
Show resolved Hide resolved
```sh
docker compose up -d
azigler marked this conversation as resolved.
Show resolved Hide resolved
azigler marked this conversation as resolved.
Show resolved Hide resolved
```

Once Mattermost is online, you can access the server at [http://localhost:8065](http://localhost:8065) and create your superuser account.

To temporarily stop the container (and preserve your database), use the following command:

```sh
docker compose stop
azigler marked this conversation as resolved.
Show resolved Hide resolved
```

To stop and clean up the database (for a fresh start), use the following command:

```sh
docker compose down
azigler marked this conversation as resolved.
Show resolved Hide resolved
```

Now you're fully equipped with an environment to develop Mattermost Apps locally!

## Quick start guides

The following quick start guides can help you start developing a Mattermost App in different languages:

| Language | Guide |
| ---------- | ------------------------------------------------------------------------------------------------------ |
| Go | [Hello World in Go]({{< ref "/integrate/apps/quickstart/quick-start-go" >}}) |
| Go | [JWT in Go]({{< ref "/integrate/apps/quickstart/quick-start-jwt" >}}) |
| Go | [Serverless on AWS or OpenFaaS in Go]({{< ref "/integrate/apps/quickstart/quick-start-serverless" >}}) |
| TypeScript | [Hello World in TypeScript]({{< ref "/integrate/apps/quickstart/quick-start-ts" >}}) |
| Python | [Hello World in Python]({{< ref "/integrate/apps/quickstart/quick-start-python" >}}) |
azigler marked this conversation as resolved.
Show resolved Hide resolved

More guides from community members are encouraged! Check out the [open issue](https://github.com/mattermost/mattermost-plugin-apps/issues/351) and our [contributing guide]({{< ref "/contribute/getting-started" >}}) for more details.
azigler marked this conversation as resolved.
Show resolved Hide resolved
Loading