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 = 4
[elsewhere]
url = http://else.whe.re:8080
private_token = helper: path/to/helper.sh
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 |
---|---|---|
|
|
Verify the SSL certificate. Set to |
|
Integer |
Number of seconds to wait for an answer before failing. |
|
|
The API version to use to make queries. Only |
|
Integer between 1 and 100 |
The number of items to return in listing queries. GitLab limits the value at 100. |
|
|
A string defining a custom user agent to use when |
You must define the url
in each GitLab server section.
Warning
If the GitLab server you are using redirects requests from http to https,
make sure to use the https://
protocol in the url
definition.
Only one of private_token
, oauth_token
or job_token
should be
defined. If neither are defined an anonymous request will be sent to the Gitlab
server, with very limited permissions.
We recommend that you use Credential helpers to securely store your tokens.
Option |
Description |
---|---|
|
URL for the GitLab server |
|
Your user token. Login/password is not supported. Refer to the official documentation to learn how to obtain a token. |
|
An Oauth token for authentication. The Gitlab server must be configured to support this authentication method. |
|
Your job token. See the official documentation to learn how to obtain a token. |
|
GitLab API version to use. Only |
|
Username for optional HTTP authentication |
|
Password for optional HTTP authentication |