# ![VictoriaMetrics](<https://daemonless.io/images/logos/victoriametrics.svg>) VictoriaMetrics

[![Build Status](<https://img.shields.io/github/actions/workflow/status/daemonless/victoriametrics/build.yaml?style=flat-square&amp;label=Build&amp;color=green>)](<https://github.com/daemonless/victoriametrics/actions>) [![Last Commit](<https://img.shields.io/github/last-commit/daemonless/victoriametrics?style=flat-square&amp;label=Last+Commit&amp;color=blue>)](<https://github.com/daemonless/victoriametrics/commits>) [![OCI Pulls](<https://img.shields.io/docker/pulls/daemonless/victoriametrics?style=flat-square&amp;label=OCI+Pulls&amp;color=blue>)](<https://hub.docker.com/r/daemonless/victoriametrics>)

VictoriaMetrics is a fast, cost-effective, and scalable time-series database and monitoring solution. It is a drop-in replacement for Prometheus storage with low memory usage.

|  |  |
| --- | --- |
| **Port** | `8428` |
| **Registry** | [`ghcr.io/daemonless/victoriametrics`](<https://github.com/daemonless/victoriametrics/pkgs/container/victoriametrics>) |
| **Daemonless** | [daemonless/victoriametrics](<https://github.com/daemonless/victoriametrics>) |
| **Source** | [VictoriaMetrics/VictoriaMetrics](<https://github.com/VictoriaMetrics/VictoriaMetrics>) |
| **Website** | [victoriametrics.com](<https://victoriametrics.com/>) |

## Prerequisites

Before deploying, ensure your host environment is ready. See the [Quick Start Guide](<https://daemonless.io/guides/quick-start/index.md>) for host setup instructions, including the security model for host vs. container privileges.

## Deployment

**Customize Paths, UID &amp; Ports**

Install and manage **VictoriaMetrics** on FreeBSD with [fjord](<https://fjord.daemonless.io>):

```
fjord install victoriametrics
```

Or open the **App Store** in the fjord web UI and install **VictoriaMetrics** from the wizard. New to fjord? See the [Install Guide](<https://fjord.daemonless.io/install/>).

```
services:
  victoriametrics:
    image: "ghcr.io/daemonless/victoriametrics:latest"
    container_name: victoriametrics
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - RETENTION_PERIOD=1y  # How long to keep metrics (e.g. 30d, 6m, 1y)
      # - VM_EXTRA_ARGS=  # Extra command line flags passed to victoria-metrics
    volumes:
      - "/containers/victoriametrics:/config"
    ports:
      - "8428:8428"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always
```

Save as `compose.yaml`, then run `podman-compose up -d`.

> [!WARNING]
>
> Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

```
# .env

DIRECTOR_PROJECT=victoriametrics
PUID=1000
PGID=1000
TZ=UTC
RETENTION_PERIOD=1y
```

```
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  victoriametrics:
    name: victoriametrics
    options:
      - container: 'args:--pull'
      - expose: '8428:8428 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - RETENTION_PERIOD: !ENV '${RETENTION_PERIOD}'
    volumes:
      - victoriametrics: /config
volumes:
  victoriametrics:
    device: '/containers/victoriametrics'
```

```
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/victoriametrics:${tag}
```

Save the files above, then run `appjail-director up`.

> [!WARNING]
>
> **Experimental**
>
> Bastille's OCI support is experimental. It requires `buildah` and shares the host network stack (`inherit`). Mount volumes with `--volume HOST JAIL`; without it, image-declared volumes are stored under `${bastille_volumesdir}/${jail}`.

```
services:
  victoriametrics:
    name: victoriametrics
    image: "ghcr.io/daemonless/victoriametrics:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - RETENTION_PERIOD=1y
    volumes:
      - "/containers/victoriametrics:/config"
```

Save as `bastille-compose.yml`, then run `bastille up`.

Open `http://<server>:8428` from another machine (the server's own browser can't use a published port).

## Parameters

### Environment Variables

| Variable | Default | Description |
| --- | --- | --- |
| `PUID` | `1000` | User ID for the application process |
| `PGID` | `1000` | Group ID for the application process |
| `TZ` | `UTC` | Timezone for the container |
| `RETENTION_PERIOD` | `1y` | How long to keep metrics (e.g. 30d, 6m, 1y) |
| `VM_EXTRA_ARGS` | \`\` | Extra command line flags passed to victoria-metrics |

### Volumes

| Path | Description |
| --- | --- |
| `/config` | Time-series data (data/) and optional scrape config (prometheus.yml) |

### Ports

| Port | Protocol | Description |
| --- | --- | --- |
| `8428` | TCP | Web UI (vmui), PromQL API and metrics ingestion |

## Version Tags

Multi-arch manifests — resolve automatically to the right image for your platform.

| Tag | Description | Best For |
| :--- | :--- | :--- |
| `latest` / `pkg` | Installed from the FreeBSD quarterly package repository. | Most users — recommended. |
| `pkg-latest` | Installed from the FreeBSD latest package repository. | Alternative build. |

| Tag | Description | Best For |
| :--- | :--- | :--- |
| `latest-amd64` / `pkg-amd64` | Installed from the FreeBSD quarterly package repository. | Most users — recommended. |
| `pkg-latest-amd64` | Installed from the FreeBSD latest package repository. | Alternative build. |

| Tag | Description | Best For |
| :--- | :--- | :--- |
| `latest-aarch64` / `pkg-aarch64` | Installed from the FreeBSD quarterly package repository. | Most users — recommended. |
| `pkg-latest-aarch64` | Installed from the FreeBSD latest package repository. | Alternative build. |

> [!NOTE]
>
> **Implementation Details**
>
> - **Architectures:** amd64, aarch64
> - **User:** `bsd` (UID/GID set via [PUID/PGID](<https://daemonless.io/guides/permissions/index.md>)). Defaults to `1000:1000`.
> - **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD 15.1).

---

Need help? Join our [Slack](<https://victoriametrics.slack.com/>) community.
