8000 [docs] add a warning about https:// · python-gitlab/python-gitlab@042b706 · GitHub
[go: up one dir, main page]

Skip to content

Commit 042b706

Browse files
author
Gauvain Pocentek
committed
[docs] add a warning about https://
http to https redirection cause problems. Make notes of this in the docs.
1 parent b02c30f commit 042b706

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/api-usage.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ You can also use configuration files to create ``gitlab.Gitlab`` objects:
4343
See the :ref:`cli_configuration` section for more information about
4444
configuration files.
4545

46+
.. warning::
47+
48+
If the GitLab server you are using redirects requests from http to https,
49+
make sure to use the ``https://`` protocol in the URL definition.
50+
4651
Note on password authentication
4752
-------------------------------
4853

docs/cli.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,11 @@ parameters. You can override the values in each GitLab server section.
7878

7979
You must define the ``url`` in each GitLab server section.
8080

81+
.. warning::
82+
83+
If the GitLab server you are using redirects requests from http to https,
84+
make sure to use the ``https://`` protocol in the ``url`` definition.
85+
8186
Only one of ``private_token`` or ``oauth_token`` should be defined. If neither
8287
are defined an anonymous request will be sent to the Gitlab server, with very
8388
limited permissions.

0 commit comments

Comments
 (0)
0