From 042b706238810fa3b4fde92d298a709ebdb3a925 Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Wed, 5 Sep 2018 18:04:15 +0200 Subject: [docs] add a warning about https:// http to https redirection cause problems. Make notes of this in the docs. --- docs/api-usage.rst | 5 +++++ docs/cli.rst | 5 +++++ 2 files changed, 10 insertions(+) (limited to 'docs') 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. -- cgit v1.2.1