Skip to content

Commit 33a35d3

Browse files
committed
update gitlab-mr-api doc
1 parent 205a3a8 commit 33a35d3

File tree

1 file changed

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

1 file changed

+9
-2
lines changed

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,15 @@ Environment variables or `.env`:
2626

2727
* `PORT`: port to listen to (def: `3980`)
2828
* `ACTIVITY_API`: `activity-api` base URL (ex: `https://activity-api:3981/`)
29-
* `DATABASE_URL`: Database DSN in the form: `postgresql://{USER}:{PASSWORD}@{HOST}/{DATABASE}`
30-
* `VALID_X_GITLAB_TOKEN`: comma separated list of Gitlab's Secret token (sent as `X-Gitlab-Token` header), uuidv4 generated seems a good choice.
29+
* `DATABASE_URL`: Database DSN in the form: `postgresql://{USER}:{PASSWORD}@{HOST}/{DATABASE}?search_path=gitlab_mr_api`
30+
* `VALID_X_GITLAB_TOKEN`: comma separated list of Gitlab's Secret token (sent as `X-Gitlab-Token` header), UUIDv4 generated token is recommended.
31+
32+
### Notes on `db/schema.sql`
33+
34+
The dump uses a dedicated schema but expects `pgcrypto` in the *public* schema for `uuid_generate_v7`.
35+
If you plan to deploy the dump in another schema or if the extension has been deployed somewhere else, adapt the function definition and the dump accordingly.
36+
37+
To connect directly to the dedicated schema, you can use *search_path* argument of the DSN `?search_path=gitlab_mr_api`.
3138

3239
## Webhook config
3340

0 commit comments

Comments
 (0)