diff --git a/docs/20_Checks/check_gitlab_tokens.md b/docs/20_Checks/check_gitlab_tokens.md index 9f1959ce035050e35f1f8dcd0d154c36760a0b16..818c705930ab4c777eb6b480293f48caa64c8ee5 100644 --- a/docs/20_Checks/check_gitlab_tokens.md +++ b/docs/20_Checks/check_gitlab_tokens.md @@ -52,6 +52,10 @@ GITLAB_TOKEN='glpat-1234567890' # REST_CLIENT='/some/where/rest-api-client.sh' ``` +Hint: + +If you need to skip the token check but the check was rolled out on a server then you can set `GITLAB_TOKEN=SKIP`. You can leave the other variables empty. + ## Syntax ```txt @@ -59,7 +63,7 @@ GITLAB_TOKEN='glpat-1234567890' ______________________________________________________________________ CHECK_GITLAB_TOKENS -v1.0 +v1.1 (c) Institute for Medical Education - University of Bern Licence: GNU GPL 3 @@ -89,8 +93,16 @@ OPTIONS: -c VALUE critical level (default: 10) -g FILE path to GITLAB_CONFIG; default: /etc/icinga2/gitlab.cfg - -r FILE path to REST client; default: ./../inc/rest-api-client.sh - It overrides the variable REST_CLIENT. + There you can set/ override: + + GITLAB_API='https://gitlab.example.com/api/v4' + GITLAB_CONFIG=<TOKEN> + REST_CLIENT="/opt/rest-api-client/rest-api-client.sh" + + -r FILE path to REST api client + default: /opt/rest-api-client/rest-api-client.sh + The parameter overrides the variable REST_CLIENT. + -s DAYS Number of days for max age of token; default: 395 PARAMETERS: @@ -110,7 +122,7 @@ EXAMPLES: ``` -## Example +## Output The execution of `check_gitlab_tokens` returns