Skip to content

SG-38301 Review the documentation regarding the SHOTGUN_API_CACERTS variable #373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
julien-lang merged 1 commit into from
Feb 27, 2025
Merged

SG-38301 Review the documentation regarding the SHOTGUN_API_CACERTS variable #373

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions docs/reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -936,8 +936,19 @@ Environment Variables
SHOTGUN_API_CACERTS
===================

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.

Use this variable to override the default Trusted Root Certification Authorities
Certificate Store bundled with this library.
By default, the library relies on `certifi <https://pypi.org/project/certifi/>`_
as its Root CA store.

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.

For an example about using ``SHOTGUN_API_CACERTS`` to fix a certificate issue,
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>`_
article.

SHOTGUN_API_RETRY_INTERVAL
==========================
Expand Down
Loading