🐋 Docker

Docker Run

You can run Voux directly with Docker using a single command:

Terminal

docker run -d \
  --name voux \
  -p 8787:8787 \
  -e ADMIN_USERNAME=admin \
  -e ADMIN_PASSWORD=change-this-password \
  # -e PUBLIC_BASE_URL=https://your-domain.com \
  # -e TRUST_PROXY=1 \
  -v $(pwd)/data:/app/data \
  ghcr.io/quintixlabs/voux/voux:latest

Read this first

You must set ADMIN_USERNAME and ADMIN_PASSWORD to your own values. Do not leave the example credentials!

If you run Voux on a public domain, set PUBLIC_BASE_URL to your full URL (for example, https://your-domain.com)

If Voux is behind a reverse proxy or tunnel (for example Nginx, Caddy, Cloudflare Tunnel, etc.), also set: TRUST_PROXY=1

Docker Compose

If you prefer Docker Compose, this is the simpler and recommended option for long running setups.

Create a docker-compose.yml file:

docker-compose.yml

services:
  voux:
    image: ghcr.io/quintixlabs/voux/voux:latest
    container_name: voux # remove this if u wanna run more than 1 container
    ports:
      - "8787:8787"
    environment:
      - ADMIN_USERNAME=admin
      - ADMIN_PASSWORD=change-this-password
      # - PUBLIC_BASE_URL=https://your-domain.com
      # - TRUST_PROXY: "1"
    volumes:
      - ./data:/app/data