Merge pull request #1032 from nejch/docs/requests-ca-bundle

max-wittig · web-flow · commit fbcc8204a7f6 · 2020-02-26T10:24:49.000+01:00
docs: add reference to REQUESTS_CA_BUNDLE usage
diff --git a/README.rst b/README.rst
@@ -31,7 +31,7 @@ Requirements
 
 python-gitlab depends on:
 
-* `python-requests <http://docs.python-requests.org/en/latest/>`_
+* `python-requests <https://2.python-requests.org/en/latest/>`_
 
 Install with pip
 ----------------
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -307,7 +307,19 @@ python-gitlab:
    gl = gitlab.gitlab(url, token, api_version=4, session=session)
 
 Reference:
-http://docs.python-requests.org/en/master/user/advanced/#proxies
+https://2.python-requests.org/en/master/user/advanced/#proxies
+
+SSL certificate verification
+----------------------------
+
+python-gitlab relies on the CA certificate bundle in the `certifi` package
+that comes with the requests library.
+
+If you need python-gitlab to use your system CA store instead, you can provide
+the path to the CA bundle in the `REQUESTS_CA_BUNDLE` environment variable.
+
+Reference:
+https://2.python-requests.org/en/master/user/advanced/#ssl-cert-verification
 
 Client side certificate
 -----------------------
@@ -324,7 +336,7 @@ The following sample illustrates how to use a client-side certificate:
    gl = gitlab.gitlab(url, token, api_version=4, session=session)
 
 Reference:
-http://docs.python-requests.org/en/master/user/advanced/#client-side-certificates
+https://2.python-requests.org/en/master/user/advanced/#client-side-certificates
 
 Rate limits
 -----------
