summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVille Skyttä <ville.skytta@iki.fi>2022-07-29 22:55:14 +0300
committerGitHub <noreply@github.com>2022-07-29 15:55:14 -0400
commit73421027be04c97fc6f50da0647ba47388ed60e5 (patch)
treea51208e8a548bfa0696773a1e7a84e99f1762daa
parent55f47299c45b0c12531a68e233ea98617b1f7928 (diff)
downloaddocker-py-73421027be04c97fc6f50da0647ba47388ed60e5.tar.gz
docs: clarify TLSConfig verify parameter (#2573)
Signed-off-by: Ville Skyttä <ville.skytta@iki.fi>
-rw-r--r--docker/tls.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/docker/tls.py b/docker/tls.py
index 882a50e..f4dffb2 100644
--- a/docker/tls.py
+++ b/docker/tls.py
@@ -12,8 +12,9 @@ class TLSConfig:
Args:
client_cert (tuple of str): Path to client cert, path to client key.
ca_cert (str): Path to CA cert file.
- verify (bool or str): This can be ``False`` or a path to a CA cert
- file.
+ verify (bool or str): This can be a bool or a path to a CA cert
+ file to verify against. If ``True``, verify using ca_cert;
+ if ``False`` or not specified, do not verify.
ssl_version (int): A valid `SSL version`_.
assert_hostname (bool): Verify the hostname of the server.