Skip to content

Commit c06aff4

Browse files
authored
SG-38301 Review the documentation regarding the SHOTGUN_API_CACERTS variable (#373)
Align wording with tk-core
1 parent c0eec8f commit c06aff4

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/reference.rst

+13-2
Original file line numberDiff line numberDiff line change
@@ -936,8 +936,19 @@ Environment Variables
936936
SHOTGUN_API_CACERTS
937937
===================
938938

939-
Used to specify a path to an external SSL certificates file. This environment variable can be used in place of the ``ca_certs`` keyword argument to the :class:`~shotgun.Shotgun` constructor. In the case that both this environment variable is set and the keyword argument is provided, the value from the keyword argument will be used.
940-
939+
Use this variable to override the default Trusted Root Certification Authorities
940+
Certificate Store bundled with this library.
941+
By default, the library relies on `certifi <https://pypi.org/project/certifi/>`_
942+
as its Root CA store.
943+
944+
This environment variable can be used in place of the ``ca_certs`` keyword
945+
argument to the :class:`~shotgun.Shotgun` constructor.
946+
In the case that both this environment variable is set and the keyword argument
947+
is provided, the value from the keyword argument will be used.
948+
949+
For an example about using ``SHOTGUN_API_CACERTS`` to fix a certificate issue,
950+
see the `SSLHandshakeError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed <https://help.autodesk.com/view/SGDEV/ENU/?guid=SGD_qa_troubleshooting_qa_sslhandshakeerror_ssl_certificate_verify_failed_html>`_
951+
article.
941952

942953
SHOTGUN_API_RETRY_INTERVAL
943954
==========================

0 commit comments

Comments
 (0)