Skip to content
Valkey Admin

Docker Deployment

Run Valkey Admin using Docker or Docker Compose for a zero-install web deployment.

Docker Images

Section titled “Docker Images”

Valkey Admin images are published to the following registries:

Registry Image
GitHub Container Registry ghcr.io/valkey-io/valkey-admin
Docker Hub valkey/valkey-admin
Amazon ECR Public Gallery public.ecr.aws/valkey/valkey-admin
Terminal window
docker pull valkey/valkey-admin:latest

Docker Compose

Section titled “Docker Compose”

Create a docker-compose.yml:

services:
  valkey-admin:
    image: valkey/valkey-admin:latest
    ports:
      - "8080:8080"
    environment:
      DEPLOYMENT_MODE: Web
    restart: unless-stopped

Start the service:

Terminal window
docker compose up -d

Open http://localhost:8080 and add a connection to your Valkey instance through the UI.

With Pre-configured Connection

Section titled “With Pre-configured Connection”

To auto-start metrics collection on startup, provide connection details as environment variables. This works for both cluster and standalone Valkey instances — Valkey Admin detects the topology automatically:

services:
  valkey-admin:
    image: valkey/valkey-admin:latest
    ports:
      - "8080:8080"
    environment:
      DEPLOYMENT_MODE: Web
      VALKEY_HOST: my-valkey-host.example.com
      VALKEY_PORT: 6379
      VALKEY_TLS: "true"
      VALKEY_AUTH_TYPE: password
      VALKEY_USERNAME: myuser
      VALKEY_PASSWORD: mypassword
    restart: unless-stopped

For cluster connections, Valkey Admin discovers all primary nodes and spawns metrics servers for each. For standalone connections, a single metrics server is started for that node.

Environment Variable Reference

Section titled “Environment Variable Reference”
Variable Default Description
KEY_VALUE_SIZE_LIMIT_BYTES 2048 Maximum value size (bytes) the Key Browser will render. Values larger than this show a size warning instead of their contents.

See the Server Configuration page for all available environment variables.

Custom Metrics Configuration

Section titled “Custom Metrics Configuration”

To override the default metrics collection and retention settings, mount a custom config.yml:

services:
  valkey-admin:
    image: valkey/valkey-admin:latest
    ports:
      - "8080:8080"
    environment:
      DEPLOYMENT_MODE: Web
      CONFIG_PATH: /app/custom-config.yml
    volumes:
      - ./my-config.yml:/app/custom-config.yml:ro
    restart: unless-stopped

See the Metrics Configuration page for available options.

Resource Sizing

Section titled “Resource Sizing”

In Docker (Web) mode, Valkey Admin spawns a metrics server process per primary node. See Resource Sizing for formulas, recommendations, and retention guidance.

Configuration Reference

Section titled “Configuration Reference”

See the Configuration section for all available environment variables.

Next Steps

Section titled “Next Steps”