Skip to content

Updated readme #58

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Updated readme #58

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
47c783b
[README] instance_path is not configurable
daladim Dec 20, 2021
554d076
[README] Where to find the secret
daladim Dec 20, 2021
79e8d85
[README] Room ID
daladim Dec 20, 2021
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
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,19 @@ Go to the desired repository's webhooks settings, in Gitlab, under **Your repo**
Configure the **URL** as follows:

```sh
https://${server_name}/${plugin_base_path}/${instance_id}/${instance_path}?room=${room_id}
https://${server_name}/${plugin_base_path}/${instance_id}/webhooks?room=${room_id}
```

Where

- `${server_name}` is an ip address or domain name where your Maubot instance is reachable
- `${base_path}` is the base path for plugin endpoint as configured under `server.plugin_base_path` in `config.yaml`
- `${instance_id}` is the identifier you previously defined while setting up the plugin instance, here `my_gitlab_bot`
- `${instance_path}` is the `path` defined in **Maubot Manager** > **Instances** > `my_gitlab_bot` > `path`
- `${room_id}` is the Matrix room identifier as defined in its URL, or under **Room Settings** > **Advanced** > **Internal room identifier**
- `${room_id}` is the Matrix room identifier as defined in its URL (or, if you're using the Element client) under **Room Settings** > **Advanced** > **Internal room identifier**. Make sure to use a room where the Gitlab bot is invited, otherwise the webhook will fail with an HTTP 403 error.

Which gives for example, with the default configuration: <https://maubot.example.org/_matrix/maubot/plugin/my_gitlab_bot/webhooks?room=!XXXXXXXXXXXX>.

Then configure the `secret` token as previously defined.
As `secret`, set the token shown in Maubot's **Instances** > **my_gitlab_bot** > **secret:**

Afterwhile, configure the desired permissions, [enable SSL verification if needed](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#ssl-verification) and create the webhook.

Expand Down