🚀 Getting started

Docker

This Docker image is published on the GitHub container registry - ghcr.io/codewec/dashlit.

Minimal configuration without password

services:
  app:
    container_name: dashlit-app
    image: ghcr.io/codewec/dashlit:latest
    restart: unless-stopped
    environment:
      ORIGIN: '${ORIGIN:-http://localhost:3000}' # please provide URL if different
    ports:
      - '3000:3000'
    volumes:
      - ./data:/app/data

Full configuration with password

services:
  app:
    container_name: dashlit-app
    image: ghcr.io/codewec/dashlit:latest
    environment:
      ORIGIN: '${ORIGIN:-http://localhost:3000}' # please provide URL if different
      NODE_ENV: '${NODE_ENV:-production}' # optional for production environment
      HOST_HEADER: '${HOST_HEADER:-HOST}' # optional for nginx reverse proxy
      ADDRESS_HEADER: '${ADDRESS_HEADER:-X-Real-IP}' # optional for nginx reverse proxy
      PROTOCOL_HEADER: '${PROTOCOL_HEADER:-X-Forwarded-Proto}' # optional for nginx reverse proxy
      PASSWORD: '${PASSWORD:-password}'
      SECRET_KEY: '${SECRET_KEY:-any-secret-string-for-jwt-auth}' # optional key for JWT authentication
    restart: unless-stopped
    ports:
      - '3000:3000'
    volumes:
      - ./data:/app/data