diff --git a/arango/client.py b/arango/client.py index 12f2bf1..b56755b 100644 --- a/arango/client.py +++ b/arango/client.py @@ -79,10 +79,12 @@ class ArangoClient: :type deserializer: callable :param verify_override: Override TLS certificate verification. This will override the verify method of the underlying HTTP client. - None: Do not change the verification behavior of the underlying HTTP client. - True: Verify TLS certificate using the system CA certificates. - False: Do not verify TLS certificate. - str: Path to a custom CA bundle file or directory. + + - `None`: Do not change the verification behavior of the + underlying HTTP client. + - `True`: Verify TLS certificate using the system CA certificates. + - `False`: Do not verify TLS certificate. + - `str`: Path to a custom CA bundle file or directory. :type verify_override: Union[bool, str, None] :param request_timeout: This is the default request timeout (in seconds) for http requests issued by the client if the parameter http_client is diff --git a/docs/certificates.rst b/docs/certificates.rst index 6440df2..e6ffedb 100644 --- a/docs/certificates.rst +++ b/docs/certificates.rst @@ -17,8 +17,7 @@ your HTTP client as described in the :ref:`HTTPClients` section. The ``ArangoClient`` class provides an option to override the verification behavior, no matter what has been defined in the underlying HTTP session. -You can use this option to disable verification or provide a custom CA bundle without -defining a custom HTTP Client. +You can use this option to disable verification. .. code-block:: python @@ -34,3 +33,18 @@ application: import requests requests.packages.urllib3.disable_warnings() + +You can also provide a custom CA bundle without defining a custom HTTP Client: + +.. code-block:: python + + client = ArangoClient(hosts="https://localhost:8529", verify_override="path/to/certfile") + +If `verify_override` is set to a path to a directory, the directory must have been processed using the `c_rehash` utility +supplied with OpenSSL. For more information, see the `requests documentation `_. + +Setting `verify_override` to `True` will use the system's default CA bundle. + +.. code-block:: python + + client = ArangoClient(hosts="https://localhost:8529", verify_override=True)