Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
Signed-off-by: erikbaranowski <39704712+erikbaranowski@users.noreply.github.com>
  • Loading branch information
erikbaranowski committed May 15, 2023
1 parent 1f6075e commit f52858a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions config/configtls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,18 @@ As a result, the following parameters are also required:

- `cert_file`: Path to the TLS cert to use for TLS required connections. Should
only be used if `insecure` is set to false.
- `cert_pem`: Alternative to `cert_file`. Provide the certificate contents as a string instead of a filepath.

- `key_file`: Path to the TLS key to use for TLS required connections. Should
only be used if `insecure` is set to false.
- `key_pem`: Alternative to `key_file`. Provide the key contents as a string instead of a filepath.

A certificate authority may also need to be defined:

- `ca_file`: Path to the CA cert. For a client this verifies the server
certificate. For a server this verifies client certificates. If empty uses
system root CA. Should only be used if `insecure` is set to false.
- `ca_pem`: Alternative to `ca_file`. Provide the CA cert contents as a string instead of a filepath.

Additionally you can configure TLS to be enabled but skip verifying the server's
certificate chain. This cannot be combined with `insecure` since `insecure`
Expand Down

0 comments on commit f52858a

Please sign in to comment.