From f1204772313dcb57d43238997451b04f3daf4d4a Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Tue, 13 Feb 2024 20:29:30 +0200 Subject: [PATCH] docs/vmauth.md: add `Config reload` chapter, which explains how to reload -auth.config at vmauth Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1194 --- docs/vmauth.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/vmauth.md b/docs/vmauth.md index d7abb818b..d8f3beba9 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -457,6 +457,17 @@ unauthorized_user: - "Server:" ``` +## Config reload + +`vmauth` supports dynamic reload of [`-auth.config`](#auth-config) via the following ways: + +- By sending `SIGHUP` signal to `vmauth` process: + ``` + kill -HUP `pidof vmauth` + ``` +- By querying `/-/reload` endpoint. It is recommended protecting it with `-reloadAuthKey`. See [security docs](#security) for details. +- By passing the interval for config check to `-configCheckInterval` command-line flag. + ## Concurrency limiting `vmauth` limits the number of concurrent requests it can proxy according to the following command-line flags: