From 5c7ffff317604421c2ed7207c81ec4d1256bba41 Mon Sep 17 00:00:00 2001 From: librelois <c@elo.tf> Date: Sat, 12 Jun 2021 15:41:24 +0200 Subject: [PATCH] doc(README): add default value for each config param --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9364914..608eadb 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,11 @@ Use docker image `duniter/gitbot:master`. The configuration is done entirely by environment variables: -| Environment variable | description | -|------------------------|--------------------------------------------------------------------------| -| `GITBOT_XMPP_JID` | Gitbot xmpp account full JID (user@host) | -| `GITBOT_XMPP_PASSWORD` | Gitbot xmpp account password | -| `GITBOT_XMPP_MUC` | Full jib of target xmpp room (room@host) | -| `GITBOT_IP` | IP address on which the gitbot server is listening (to receive webwook) | -| `GITBOT_PORT` | port number on which the gitbot server is listening (to receive webwook) | -| `GITLAB_TOKEN` | The secret token that gitlab must use for the webhook | +| Environment variable | Default value | description | +|------------------------|---------------|--------------------------------------------------------------------------| +| `GITBOT_XMPP_JID` | Mandatory | Gitbot xmpp account full JID (user@host) | +| `GITBOT_XMPP_PASSWORD` | Mandatory | Gitbot xmpp account password | +| `GITBOT_XMPP_MUC` | Mandatory | Full jib of target xmpp room (room@host) | +| `GITBOT_IP` | `0.0.0.0` | IP address on which the gitbot server is listening (to receive webwook) | +| `GITBOT_PORT` | `8080` | port number on which the gitbot server is listening (to receive webwook) | +| `GITLAB_TOKEN` | Mandatory | The secret token that gitlab must use for the webhook | -- GitLab