diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2018-09-05 18:04:15 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2018-09-05 18:04:20 +0200 |
| commit | 042b706238810fa3b4fde92d298a709ebdb3a925 (patch) | |
| tree | 0c987b20012554227d3ae98af1992ff2e1b95ed2 | |
| parent | b02c30f8b1829e87e2cc28ae7fdf8bb458a4b1c7 (diff) | |
| download | gitlab-042b706238810fa3b4fde92d298a709ebdb3a925.tar.gz | |
[docs] add a warning about https://
http to https redirection cause problems. Make notes of this in the
docs.
| -rw-r--r-- | docs/api-usage.rst | 5 | ||||
| -rw-r--r-- | docs/cli.rst | 5 |
2 files changed, 10 insertions, 0 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst index c2d50c4..73d1377 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -43,6 +43,11 @@ You can also use configuration files to create ``gitlab.Gitlab`` objects: See the :ref:`cli_configuration` section for more information about configuration files. +.. 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. + Note on password authentication ------------------------------- diff --git a/docs/cli.rst b/docs/cli.rst index 95fa6f4..220f079 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -78,6 +78,11 @@ parameters. You can override the values in each GitLab server section. 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`` or ``oauth_token`` should be defined. If neither are defined an anonymous request will be sent to the Gitlab server, with very limited permissions. |