Skip to content

Commit d4572f8

Browse files
authored
Merge pull request #5 from teams-notifier/clarify-glmrapi
gitlab-mr-api: clarify env vars role and setup
2 parents 929fabf + 784c0a6 commit d4572f8

File tree

1 file changed

+7
-2
lines changed
  • content/docs/deployment/addons/gitlab-mr-api

1 file changed

+7
-2
lines changed

content/docs/deployment/addons/gitlab-mr-api/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,12 @@ In case of failure, now or afterward, you can Edit the webhook and you'll see al
6868
## Webhook declaration helper
6969

7070
{{% details title="Environment variables" %}}
71+
72+
To be placed in a `.env` file in the script's folder or `export`'ed
73+
7174
```bash
72-
# Gitlab token with Admin or Maintainer right
75+
# Your Gitlab personal access token with Admin or Maintainer right
76+
# Used to declare the webhook itself
7377
GITLAB_TOKEN=
7478

7579
# your gitlab url (opt. if gitlab.com)
@@ -78,7 +82,8 @@ GITLAB_TOKEN=
7882
# coma separated list of conversation tokens
7983
CONVERSATION_TOKEN=
8084

81-
# Gitlab secret matching one of the VALID_X_GITLAB_TOKEN
85+
# Gitlab secret matching one of the gitlab-mr-api's VALID_X_GITLAB_TOKEN
86+
# Mechanism used by Gitlab to validate received payloads
8287
GITLAB_SECRET=
8388

8489
# Full url of the accessible webhook https://gl-webhook.example.org/api/v1/gitlab-webhook

0 commit comments

Comments
 (0)