Quick Start

Lumeex provides a pre-built container image directly available for Docker.

Before installing, ensure the following is available on your system

Docker

From your terminal, create a lumeex/ directory, then navigate to it:

mkdir lumeex
cd lumeex

Now you have two way to run the Lumeex container.

Use docker run

Docker run

sudo docker run -d \
  --name lmx \
  -v ./config:/app/config \
  -v ./output:/app/output \
  -p 3000:3000 \
  -p 5000:5000 \
  -e PREVIEW_PORT=3000 \
  -e WEBUI_PORT=5000 \
  git.djeex.fr/djeex/lumeex:latest

✨ Tip: The container exposes two services: the WebUI and the preview server. Both require a host port to be mapped. If a port is already in use on your system, you can remap it by updating both the -p (port mapping) and the corresponding -e (environment variable). For example, to run the preview server on port 4000 instead of the default 3000, use:-p 4000:3000 and -e PREVIEW_PORT=4000.

Or use docker compose

First, create a file named docker-compose.yaml with this config:

services:
  lumeex:
    container_name: lmx
    image: git.djeex.fr/djeex/lumeex:latest
    env_file:
      - .env
    environment:
      - PREVIEW_PORT=${PREVIEW_PORT:-3000} # port for preview server - set it in .env file
      - WEBUI_PORT=${WEBUI_PORT:-5000} # port for webui server - set it in .env file
    volumes:
      - ./config:/app/config  # mount config directory
      - ./output:/app/output  # mount output directory
    ports:
      - "${PREVIEW_PORT:-3000}:3000"
      - "${WEBUI_PORT:-5000}:5000"

✨ Tip: The container exposes two services: the WebUI and the preview server. Both require a host port to be mapped. If a port is already in use on your system, create an .env file in the same folder, then fill it with your custom port. For example, to run the preview server on port 4000 instead of the default 3000:

PREVIEW_PORT=4000
WEBUI_PORT=5000

Start the container from the same directory:

sudo docker compose up -d

You’re ready to go! The container is now running and ready for use. You can reach the WebUI on http://localhost:5000 (or your custom port), and, after a first build, the preview of your gallery on http://localhost:3000 (or your custom port).

Stopping the container

To stop the container, you can use:

Docker run

sudo docker stop lmx

Getting StartedAdvanced Installation