diff --git a/changelog.d/769.doc b/changelog.d/769.doc new file mode 100644 index 000000000..355d38cde --- /dev/null +++ b/changelog.d/769.doc @@ -0,0 +1 @@ +Add documentation for the setup widget. diff --git a/docs/link_channels.md b/docs/link_channels.md index 26a1ce545..ae3d2e09c 100644 --- a/docs/link_channels.md +++ b/docs/link_channels.md @@ -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, diff --git a/docs/setup-widget.png b/docs/setup-widget.png new file mode 100644 index 000000000..af473b82d Binary files /dev/null and b/docs/setup-widget.png differ