Install latest/stable of vmauth

Ubuntu 16.04 or later?

Make sure snap support is enabled in your Desktop store.


Install using the command line

sudo snap install vmauth

Don't have snapd? Get set up for snaps.

Channel Version Published

vmauth is a simple auth proxy, router and load balancer for VictoriaMetrics

It reads auth credentials from Authorization http header (Basic Auth, Bearer token and InfluxDB authorization is supported), matches them against configs pointed by -auth.config command-line flag and proxies incoming HTTP requests to the configured per-user url_prefix on successful match. The -auth.config can point to either local file or to http url.

Quick start

Just download vmutils-* archive from releases page, unpack it and pass the following flag to vmauth binary in order to start authorizing and routing requests:

/path/to/vmauth -auth.config=/path/to/auth/config.yml

After that vmauth starts accepting HTTP requests on port 8427 and routing them according to the provided -auth.config. The port can be modified via -httpListenAddr command-line flag.

The auth config can be reloaded via the following ways:

  • By passing SIGHUP signal to vmauth.
  • By querying /-/reload http endpoint. This endpoint can be protected with -reloadAuthKey command-line flag. See security docs for more details.
  • By specifying -configCheckInterval command-line flag to the interval between config re-reads. For example, -configCheckInterval=5s will re-read the config and apply new changes every 5 seconds.

See how vmauth used in docker-compose env at https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/deployment/docker/README.md#victoriametrics-cluster.

Pass -help to vmauth in order to see all the supported command-line flags with their descriptions.

Feel free contacting us if you need customized auth proxy for VictoriaMetrics with the support of LDAP, SSO, RBAC, SAML, accounting and rate limiting such as https://docs.victoriametrics.com/vmgateway.html .

Details for vmauth

License
  • Apache-2.0

Last updated
  • 9 December 2024 - latest/stable
  • 9 December 2024 - latest/edge

Websites

Contact

Source code

Report a bug

Report a Snap Store violation

Share this snap

Generate an embeddable card to be shared on external websites.


Install vmauth on your Linux distribution

Choose your Linux distribution to get detailed installation instructions. If yours is not shown, get more details on the installing snapd documentation.


Where people are using vmauth