Skip to content

Commit 6d620a3

Browse files
hkrutzerHans Krutzer
andauthored
Improve SSL docs (#756)
Co-authored-by: Hans Krutzer <git@mails.pixelspaceships.com>
1 parent f20274a commit 6d620a3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

lib/postgrex.ex

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,10 @@ defmodule Postgrex do
119119
* `:idle_interval` - Ping connections after a period of inactivity in milliseconds.
120120
Defaults to 1000ms;
121121
122-
* `:ssl` - Enables SSL. Setting it to `true` enables SSL without server certificate verification,
123-
which emits a warning. Instead, prefer to set it to a keyword list, with either
124-
`:cacerts` or `:cacertfile` set to a CA trust store, to enable server certificate
125-
verification. Defaults to `false`;
122+
* `:ssl` - Enables SSL. Set to:
123+
- false (default): no SSL.
124+
- true: enable SSL with secure defaults, including peer certificate verification and hostname checking.
125+
- keyword list of `t::ssl.tls_client_option()/0` values: enable SSL and merge your options on top of secure defaults.
126126
127127
* `:socket_options` - Options to be given to the underlying socket
128128
(applies to both TCP and UNIX sockets);

0 commit comments

Comments
 (0)