Content¶
The configuration file uses the INI
format. It contains at least a
[global]
section, and a specific section for each GitLab server. For
example:
[global]
default = somewhere
ssl_verify = true
timeout = 5
[somewhere]
url = https://some.whe.re
private_token = vTbFeqJYCY3sibBP7BZM
api_version = 3
[elsewhere]
url = http://else.whe.re:8080
private_token = CkqsjqcQSFH5FQKDccu4
timeout = 1
The default
option of the [global]
section defines the GitLab server to
use if no server is explicitly specified with the --gitlab
CLI option.
The [global]
section also defines the values for the default connection
parameters. You can override the values in each GitLab server section.
Option | Possible values | Description |
---|---|---|
ssl_verify |
True , False , or a str |
Verify the SSL certificate. Set to False to disable verification,
though this will create warnings. Any other value is interpreted as path
to a CA_BUNDLE file or directory with certificates of trusted CAs. |
timeout |
Integer | Number of seconds to wait for an answer before failing. |
api_version |
3 ou 4 |
The API version to use to make queries. Requires python-gitlab >= 1.3.0. |
You must define the url
in each GitLab server section.
Only one of private_token
or oauth_token
should be defined. If neither
are defined an anonymous request will be sent to the Gitlab server, with very
limited permissions.
Option | Description |
---|---|
url |
URL for the GitLab server |
private_token |
Your user token. Login/password is not supported. Refer to the official documentation to learn how to obtain a token. |
oauth_token |
An Oauth token for authentication. The Gitlab server must be configured to support this authentication method. |
api_version |
GitLab API version to use (3 or 4 ). Defaults to 4 since
version 1.3.0. |
http_username |
Username for optional HTTP authentication |
http_password |
Password for optional HTTP authentication |