From 25ff811d78a2e2e06ef6944b4c1079847c9cf054 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Mon, 13 Nov 2023 09:12:55 +0100 Subject: [PATCH] docs/vmauth.md: add missing dashes in front of command-line flags at the `Backend TLS setup` section Dashes must be consistently used in front of command-line flags across the documentation. This is a follow up for 61594d2bd85cf7bb66f24f36d28cff47db55ee5b --- app/vmauth/README.md | 6 +++--- docs/vmauth.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/app/vmauth/README.md b/app/vmauth/README.md index 96e656ba2..e6befcc85 100644 --- a/app/vmauth/README.md +++ b/app/vmauth/README.md @@ -106,7 +106,7 @@ The following [metrics](#monitoring) related to concurrency limits are exposed b By default `vmauth` uses system settings when performing requests to HTTPS backends specified via `url_prefix` option in the [`-auth.config`](https://docs.victoriametrics.com/vmauth.html#auth-config). These settings can be overridden with the following command-line flags: -- `backend.tlsInsecureSkipVerify` allows skipping TLS verification when connecting to HTTPS backends. +- `-backend.tlsInsecureSkipVerify` allows skipping TLS verification when connecting to HTTPS backends. This global setting can be overridden at per-user level inside [`-auth.config`](https://docs.victoriametrics.com/vmauth.html#auth-config) via `tls_insecure_skip_verify` option. For example: @@ -116,8 +116,8 @@ in the [`-auth.config`](https://docs.victoriametrics.com/vmauth.html#auth-config tls_insecure_skip_verify: true ``` -- `backend.tlsCAFile` allows specifying the path to TLS Root CA, which will be used for TLS verification when connecting to HTTPS backends. - The `backend.tlsCAFile` may point either to local file or to `http` / `https` url. +- `-backend.tlsCAFile` allows specifying the path to TLS Root CA, which will be used for TLS verification when connecting to HTTPS backends. + The `-backend.tlsCAFile` may point either to local file or to `http` / `https` url. This global setting can be overridden at per-user level inside [`-auth.config`](https://docs.victoriametrics.com/vmauth.html#auth-config) via `tls_ca_file` option. For example: diff --git a/docs/vmauth.md b/docs/vmauth.md index a2ea73891..6375ed511 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -117,7 +117,7 @@ The following [metrics](#monitoring) related to concurrency limits are exposed b By default `vmauth` uses system settings when performing requests to HTTPS backends specified via `url_prefix` option in the [`-auth.config`](https://docs.victoriametrics.com/vmauth.html#auth-config). These settings can be overridden with the following command-line flags: -- `backend.tlsInsecureSkipVerify` allows skipping TLS verification when connecting to HTTPS backends. +- `-backend.tlsInsecureSkipVerify` allows skipping TLS verification when connecting to HTTPS backends. This global setting can be overridden at per-user level inside [`-auth.config`](https://docs.victoriametrics.com/vmauth.html#auth-config) via `tls_insecure_skip_verify` option. For example: @@ -127,8 +127,8 @@ in the [`-auth.config`](https://docs.victoriametrics.com/vmauth.html#auth-config tls_insecure_skip_verify: true ``` -- `backend.tlsCAFile` allows specifying the path to TLS Root CA, which will be used for TLS verification when connecting to HTTPS backends. - The `backend.tlsCAFile` may point either to local file or to `http` / `https` url. +- `-backend.tlsCAFile` allows specifying the path to TLS Root CA, which will be used for TLS verification when connecting to HTTPS backends. + The `-backend.tlsCAFile` may point either to local file or to `http` / `https` url. This global setting can be overridden at per-user level inside [`-auth.config`](https://docs.victoriametrics.com/vmauth.html#auth-config) via `tls_ca_file` option. For example: