VictoriaMetrics Server Deployment Overview¶

Prerequisites¶

The following conditions are required for the application to function correctly:

An operating system with Docker and Docker Compose installed.
Access to ports 80, 443 (for HTTPS), and 8427, 8428, 8427 (internal service ports).
Superuser privileges to manage directories in /root/.

FQDN of the final panel on hostkey.in domain¶

Parameter	Value
Prefix	`victoriametrics`
Domain	`hostkey.in`
Full Template	`victoriametrics{Server_ID_from_Invapi}.hostkey.in`

File and Directory Structure¶

All primary data and configurations are concentrated in the following directory:

/root/victoria-metrics-data/ — application root directory.
compose.yml — Docker Compose configuration file.
authconfig.yml — vmauth authentication configuration file.
/data/nginx/user_conf.d/ — Nginx proxy server configuration directory.

Application Installation Process¶

Deployment is performed by creating the necessary directories, generating configuration files (compose.yml and authconfig.yml), and launching containers via Docker Compose. The application is deployed in a Docker environment using current images from developer registries.

Docker Containers and Execution¶

The application consists of three interacting containers:

Service Name	Image	Ports	Volumes	Environment Variables	Restart Policy
`nginx`	`jonasal/nginx-certbot:latest`	`80:80`, `443:443`	`nginx_secrets:/etc/letsencrypt`, `/data/nginx/user_conf.d:/etc/nginx/user_conf.d`	`[email protected]`	`unless-stopped`
`victoriametrics`	`victoriametrics/victoria-metrics:latest`	`8428:8428`	`/root/victoria-metrics-data:/victoria-metrics-data`, `victoriametrics:/victoria-metrics`	—	`unless-stopped`
`vmauth`	`victoriametrics/vmauth`	`8427:8427`	`/root/victoria-metrics-data:/root/victoria-metrics-data`	Startup command with config path: `-auth.config=/root/victoria-metrics-data/authconfig.yml`	`unless-stopped`

Databases¶

VictoriaMetrics uses local data storage, which is mounted via a Docker volume named victoriametrics. Data is physically located inside the container and is saved in the /victoria-metrics directory.

Application Update Instructions¶

Updating is performed by running pull and restarting containers. To update, execute the following commands:

cd /root/victoria-metrics-data
docker compose pull
docker compose up -d

Permissions Settings¶

The following permissions are set for service operation:

The /root/victoria-metrics-data directory has owner root, group root, and access mode 0644.

Configuration Files and Data Location¶

File / Resource	Path
Docker Compose Configuration	`/root/victoria-metrics-data/compose.yml`
Authentication Configuration	`/root/victoria-metrics-data/authconfig.yml`
VictoriaMetrics Data (Volume)	`victoriametrics` (Docker Volume)

Available Connection Ports¶

80 — HTTP (for Certbot certificate acquisition).
443 — HTTPS (primary access via proxy).
8427 — vmauth authentication service port.
8428 — VictoriaMetrics database port.