Getting started

Lumeex is a Python project that can be installed on any operating system with Docker or Python support.

🐳 Docker Installation from Git repository

For conveniency, you can use Docker to run the project. Lumeex provides a pre-built image or let you build it from the Git project.

Before installing, ensure the following is available on your system

  1. Clone the repository
git clone https://git.djeex.fr/Djeex/lumeex.git
  1. Navigate to the project directory
cd lumeex/
  1. Run the container
Docker run
sudo docker build .. -t lumeex \
&& 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 \
  lumeex
Docker compose
sudo docker compose -f ./docker/docker-compose.yaml 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, and, after a first build, the preview of your gallery on http://localhost:3000.

✨ 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. For docker compose, open the existing .env file, 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
  1. (Optional) stopping the container (the files will persist in your config and output directory)
Docker run
sudo docker stop lmx
Docker compose
sudo docker compose -f ./docker/docker-compose.yaml stop

🐍 Python Installation

You can also choose to install the project directly on your device with Python. Before installing, ensure the following are available on your system

Installation

Follow these steps to set up your development environment:

  1. Clone the repository
git clone https://git.djeex.fr/Djeex/lumeex.git
  1. Navigate to the project directory
cd lumeex
  1. Create a virtual environment
python3 -m venv .venv
  1. Activate the virtual environment
source .venv/bin/activate
  1. Install project dependencies
pip install -r requirements.txt
  1. Launch the WebUI
Python3 -m src.py.webui.webui

You’re ready to go! The project is now installed and ready for use. You can reach the WebUI on http://localhost:5000. See CLI users section for further commands.

  • MacOS users : Sometimes port 5000 can be unreachable due to AirPlay. You can temporarly disable it in System Settings > General > AirDrop & Handoff > AirPlay Receiver
Table of Contents