Installation

Requirements

• Docker and Docker Compose (v2 or newer)
• A free port for the dashboard and the API

Deploy with Docker

The fastest way to try Keues:

docker run -d \
  --name keues \
  -p 8080:8080 \
  -v ./data:/app/data \
  -e KEUES_DASHBOARD_URL="http://localhost:8080" \
  gorerecord/keues:latest

Open http://localhost:8080 and the system is up and running.

The image is published on Docker Hub.

With docker-compose

services:
  keues:
    image: gorerecord/keues:latest
    container_name: keues
    ports:
      - "8080:8080"
    volumes:
      - ./data:/app/data
    environment:
      KEUES_DASHBOARD_URL: "http://localhost:8080"
      KEUES_EMAIL_PROVIDER: "smtp"
      KEUES_SMTP_HOST: ""
      KEUES_SMTP_PORT: "587"
      KEUES_SMTP_USER: ""
      KEUES_SMTP_PASSWORD: ""
      KEUES_SMTP_FROM: ""
      KEUES_SMTP_USE_TLS: "true"
    restart: unless-stopped

The ./data volume persists the database across container restarts.

Environment variables

Variable	Description
KEUES_DASHBOARD_URL	Public URL of the dashboard (used in emails and links).
KEUES_EMAIL_PROVIDER	(Optional) Email provider. Use smtp to send via SMTP.
KEUES_SMTP_HOST	(Optional) SMTP server host.
KEUES_SMTP_PORT	(Optional) SMTP server port (587 by default).
KEUES_SMTP_USER	(Optional) SMTP authentication user.
KEUES_SMTP_PASSWORD	(Optional) SMTP authentication password.
KEUES_SMTP_FROM	(Optional) Sender address for emails.
KEUES_SMTP_USE_TLS	(Optional) Enables TLS for the SMTP connection (true/false).

Deploy from source

1. Clone the repository:

   git clone https://github.com/HastaCs/Keues

2. Build and start the stack services (.NET API, React dashboard and SignalR).

A detailed guide for deploying from source is coming soon.

Next steps

Once installed, check the dashboard options guide to configure stations, queue types and kiosk flows.