diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2017-11-10 09:39:17 +0100 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2017-11-10 09:39:17 +0100 |
| commit | 07328263c317d7ee78723fee8b66f48abffcfb36 (patch) | |
| tree | 1922a5ae37ed1903d1e02d35e725f6205081ac56 /docs/cli.rst | |
| parent | e9b158363e5b0ea451638b1c3a660f138a24521d (diff) | |
| download | gitlab-07328263c317d7ee78723fee8b66f48abffcfb36.tar.gz | |
Add support for oauth and anonymous auth in config/CLI
Diffstat (limited to 'docs/cli.rst')
| -rw-r--r-- | docs/cli.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/cli.rst b/docs/cli.rst index e4d3437..f75a46a 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -70,8 +70,11 @@ parameters. You can override the values in each GitLab server section. - Integer - Number of seconds to wait for an answer before failing. -You must define the ``url`` and ``private_token`` in each GitLab server -section. +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. .. list-table:: GitLab server options :header-rows: 1 @@ -83,6 +86,9 @@ section. * - ``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 ``3`` for now, but will switch to ``4`` eventually. |