aboutsummaryrefslogtreecommitdiff
path: root/https/README.md
diff options
context:
space:
mode:
authorJulien Pivotto <roidelapluie@inuits.eu>2020-04-25 13:42:45 +0200
committerGitHub <noreply@github.com>2020-04-25 13:42:45 +0200
commit091bed01b084d8972a8d11a8a1325ce12646660a (patch)
tree21de7bb9e5b3ced749f4b8464d6e5e4f7c6a4781 /https/README.md
parentfa4edd700ebc1b3614bcd953c215d3f2ab2e0b35 (diff)
downloadprometheus_node_collector-091bed01b084d8972a8d11a8a1325ce12646660a.tar.bz2
prometheus_node_collector-091bed01b084d8972a8d11a8a1325ce12646660a.tar.xz
prometheus_node_collector-091bed01b084d8972a8d11a8a1325ce12646660a.zip
Make TLS config consistent with Prometheus (#1685)
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
Diffstat (limited to 'https/README.md')
-rw-r--r--https/README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/https/README.md b/https/README.md
index d9cb564..946f2cf 100644
--- a/https/README.md
+++ b/https/README.md
@@ -9,16 +9,17 @@ If the config is kept within the https directory.
9The config file should be written in YAML format, and is reloaded on each connection to check for new certificates and/or authentication policy. 9The config file should be written in YAML format, and is reloaded on each connection to check for new certificates and/or authentication policy.
10 10
11## Sample Config 11## Sample Config
12
12``` 13```
13tlsConfig : 14tls_config:
14 # Certificate and key files for server to use to authenticate to client 15 # Certificate and key files for server to use to authenticate to client
15 tlsCertPath : <filename> 16 cert_file: <filename>
16 tlsKeyPath : <filename> 17 key_file: <filename>
17 18
18 # Server policy for client authentication. Maps to ClientAuth Policies 19 # Server policy for client authentication. Maps to ClientAuth Policies
19 # For more detail on clientAuth options: [ClientAuthType](https://golang.org/pkg/crypto/tls/#ClientAuthType) 20 # For more detail on clientAuth options: [ClientAuthType](https://golang.org/pkg/crypto/tls/#ClientAuthType)
20 [ clientAuth : <string> | default = "NoClientCert" ] 21 [ client_auth_type: <string> | default = "NoClientCert" ]
21 22
22 # CA certificate for client certificate authentication to the server 23 # CA certificate for client certificate authentication to the server
23 [ clientCAs : <filename> ] 24 [ client_ca_file: <filename> ]
24``` 25```