finallycoffee/matrix-docker-ansible-deploy
finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix some minor Markdown rendering issues

Browse Source
This commit is contained in:
Slavi Pantaleev 2020-01-14 15:55:56 +02:00
parent 219663f02e
commit 0ffe821cfb
1 changed files with 37 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/configuring-playbook-bridge-appservice-webhooks.md
View File

@ -7,6 +7,7 @@ Setup Instructions:
loosely based on [this](https://github.com/turt2live/matrix-appservice-webhooks/blob/master/README.md) 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.<domain-name>/vars.yml`: 1. All you basically need is to adjust your `inventory/host_vars/matrix.<domain-name>/vars.yml`:
```yaml ```yaml
matrix_appservice_webhooks_enabled: true matrix_appservice_webhooks_enabled: true
matrix_appservice_webhooks_api_secret: '<your_secret>' matrix_appservice_webhooks_api_secret: '<your_secret>'
@ -14,8 +15,8 @@ loosely based on [this](https://github.com/turt2live/matrix-appservice-webhooks/
2. In case you want to change the verbosity of logging via `journalctl -fu matrix-appservice-webhooks.service` 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.<domain-name>/vars.yml` as well. you can adjust this in `inventory/host_vars/matrix.<domain-name>/vars.yml` as well.
<br>
*Note*: default value is: `info` and availabe log levels are : `info, verbose` *Note*: default value is: `info` and availabe log levels are : `info`, `verbose`
```yaml ```yaml
matrix_appservice_webhooks_log_level: '<log_level>' matrix_appservice_webhooks_log_level: '<log_level>'
@ -24,11 +25,9 @@ you can adjust this in `inventory/host_vars/matrix.<domain-name>/vars.yml` as we
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. 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: 4. Invite the bridge bot user to your room:
- either with:
``` - either with `/invite @_webhook:<domain.name>` (*Note*: Make sure you have administration permissions in your room)
/invite @_webhook:<domain.name>
```
*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) - 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. 5. Send a message to the bridge bot in order to receive a private message including the webhook link.
@ -37,7 +36,7 @@ you can adjust this in `inventory/host_vars/matrix.<domain-name>/vars.yml` as we
``` ```
6. The JSON body for posting messages will have to look like this: 6. The JSON body for posting messages will have to look like this:
``` ```json
{ {
"text": "Hello world!", "text": "Hello world!",
"format": "plain", "format": "plain",
@ -45,7 +44,9 @@ you can adjust this in `inventory/host_vars/matrix.<domain-name>/vars.yml` as we
"avatarUrl": "http://i.imgur.com/IDOBtEJ.png" "avatarUrl": "http://i.imgur.com/IDOBtEJ.png"
} }
``` ```
- You can test this via curl like so:
You can test this via curl like so:
``` ```
curl --header "Content-Type: application/json" \ curl --header "Content-Type: application/json" \
--data '{ --data '{