mirror of
https://github.com/matrix-org/matrix-hookshot.git
synced 2025-03-10 21:19:13 +00:00
41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
# GitLab
|
|
|
|
## Configuration
|
|
|
|
GitLab configuration is fairly straight-forward:
|
|
|
|
```yaml
|
|
gitlab:
|
|
# (Optional) Configure this to enable GitLab support
|
|
#
|
|
instances:
|
|
gitlab.com:
|
|
url: https://gitlab.com
|
|
webhook:
|
|
secret: secrettoken
|
|
publicUrl: https://example.com/webhooks/
|
|
```
|
|
|
|
You need to list all the instances you plan to connect to in the `config.yml`. This is
|
|
used so that users can give a short name like `gitlab` or `matrix.org` when they want
|
|
to specify an instance.
|
|
|
|
You should generate a webhook `secret` (e.g. `pwgen -n 64 -s 1`) and then use this as your
|
|
"Secret token" when adding webhooks.
|
|
|
|
The `publicUrl` must be the URL where GitLab webhook events are received (i.e. the path to `/`
|
|
for your `webhooks` listener).
|
|
|
|
|
|
<section class="warning">
|
|
The GitLab hooks "test" button allows you to check that your webhooks are configured properly. The
|
|
merge request, issue and release notifications lack a <code>action</code> field in the body of the
|
|
request which means they <strong>won't show up in the room</strong>. You can check the logs to see
|
|
if the request made it through, however.
|
|
</section>
|
|
|
|
## Adding a repository
|
|
|
|
You can now follow the guide on [authenticating with GitLab](../usage/auth.md#gitlab), and then [bridging a room](../usage/room_configuration/gitlab_project.md#setting-up)
|
|
|