Skip to content

gitlab-mr-api: clarify env vars role and setup #5

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

Merged
merged 1 commit into from
Dec 11, 2024
Merged

gitlab-mr-api: clarify env vars role and setup #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions content/docs/deployment/addons/gitlab-mr-api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,12 @@ In case of failure, now or afterward, you can Edit the webhook and you'll see al
## Webhook declaration helper

{{% details title="Environment variables" %}}

To be placed in a `.env` file in the script's folder or `export`'ed

```bash
# Gitlab token with Admin or Maintainer right
# Your Gitlab personal access token with Admin or Maintainer right
# Used to declare the webhook itself
GITLAB_TOKEN=

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

# Gitlab secret matching one of the VALID_X_GITLAB_TOKEN
# Gitlab secret matching one of the gitlab-mr-api's VALID_X_GITLAB_TOKEN
# Mechanism used by Gitlab to validate received payloads
GITLAB_SECRET=

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