From 0ffe821cfbcd87867a2c0161f1d12bc198208012 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 14 Jan 2020 15:55:56 +0200 Subject: [PATCH] Fix some minor Markdown rendering issues --- ...ing-playbook-bridge-appservice-webhooks.md | 73 ++++++++++--------- 1 file changed, 37 insertions(+), 36 deletions(-) diff --git a/docs/configuring-playbook-bridge-appservice-webhooks.md b/docs/configuring-playbook-bridge-appservice-webhooks.md index 2badcac2..1db6f452 100644 --- a/docs/configuring-playbook-bridge-appservice-webhooks.md +++ b/docs/configuring-playbook-bridge-appservice-webhooks.md @@ -7,52 +7,53 @@ Setup Instructions: loosely based on [this](https://github.com/turt2live/matrix-appservice-webhooks/blob/master/README.md) 1. All you basically need is to adjust your `inventory/host_vars/matrix./vars.yml`: - ```yaml - matrix_appservice_webhooks_enabled: true - matrix_appservice_webhooks_api_secret: '' - ``` + +```yaml +matrix_appservice_webhooks_enabled: true +matrix_appservice_webhooks_api_secret: '' +``` 2. In case you want to change the verbosity of logging via `journalctl -fu matrix-appservice-webhooks.service` you can adjust this in `inventory/host_vars/matrix./vars.yml` as well. -
-*Note*: default value is: `info` and availabe log levels are : `info, verbose` - ```yaml - matrix_appservice_webhooks_log_level: '' - ``` +*Note*: default value is: `info` and availabe log levels are : `info`, `verbose` + +```yaml +matrix_appservice_webhooks_log_level: '' +``` 3. If you've already installed Matrix services using the playbook before, you'll need to re-run it (`--tags=setup-all,start`). If not, proceed with [configuring other playbook services](configuring-playbook.md) and then with [Installing](installing.md). Get back to this guide once ready. 4. Invite the bridge bot user to your room: - - either with: - ``` - /invite @_webhook: - ``` - *Note*: Make sure you have administration permissions in your room + + - either with `/invite @_webhook:` (*Note*: Make sure you have administration permissions in your room) + - or simply add the bridge bot to a private channel (personal channels imply you being an administrator) 5. Send a message to the bridge bot in order to receive a private message including the webhook link. - ``` - !webhook - ``` +``` +!webhook +``` 6. The JSON body for posting messages will have to look like this: - ``` - { - "text": "Hello world!", - "format": "plain", - "displayName": "My Cool Webhook", - "avatarUrl": "http://i.imgur.com/IDOBtEJ.png" - } - ``` - - You can test this via curl like so: - ``` - curl --header "Content-Type: application/json" \ - --data '{ - "text": "Hello world!", - "format": "plain", - "displayName": "My Cool Webhook", - "avatarUrl": "http://i.imgur.com/IDOBtEJ.png" - }' \ - - ``` +```json +{ + "text": "Hello world!", + "format": "plain", + "displayName": "My Cool Webhook", + "avatarUrl": "http://i.imgur.com/IDOBtEJ.png" +} +``` + +You can test this via curl like so: + +``` +curl --header "Content-Type: application/json" \ +--data '{ +"text": "Hello world!", +"format": "plain", +"displayName": "My Cool Webhook", +"avatarUrl": "http://i.imgur.com/IDOBtEJ.png" +}' \ + +```