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

Add docs for setup widget #769

Merged
merged 3 commits into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions changelog.d/769.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add documentation for the setup widget.
27 changes: 27 additions & 0 deletions docs/link_channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,33 @@ The Real Time Messaging (RTM) API is the newer and recommended way to use the br
link --channel_id CHANNELID --room !the-matrix:room.id --slack_bot_token xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx
```

## Setup Widget

A user interface is provided in the form of a Matrix widget which can be used within a room to link and unlink channels.


![Screenshot of setup widget interface](setup-widget.png)

### Configuration

In order to use the setup widget, it must be enabled along with the provisioning API:

```yaml
provisioning:
enabled: true
widget: true
```

The widget will be hosted on the same port as the appservice by default, at the path `/_matrix/provision/v1/static`.

### Usage

Invite the bridge user to the Matrix room, then add the widget like this (where `example.com` is a public route to your bridge's provisioning API):

```
/addwidget https://example.com/_matrix/provision/v1/static/?roomId=$matrix_room_id&widgetId=$matrix_widget_id
```

## Webhooks

Linking rooms with webhooks is not the recommended way for most situations,
Expand Down
Binary file added docs/setup-widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading