Getting started

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

🐳 Docker Installation

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

From Lumeex official image

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 build . -t lumeex \
&& sudo docker run -d \
  --name lmx \
  -v ./config:/app/config \
  -v ./output:/app/output \
  -p 3000:3000 \
  git.djeex.fr/djeex/lumeex:latest

You’re ready to go! The container is now running and ready for use.

Or use docker compose

  1. First, create a file named docker-compose.yaml in a directory of your choice:
services:
  lumeex:
    container_name: lmx
    image: git.djeex.fr/djeex/lumeex:latest
    volumes:
      - ./config:/app/config  # mount config directory
      - ./output:/app/output  # mount output directory
    ports:
      - "3000:3000"
  1. 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.

Stopping the container

To stop the container, you can use:

Docker run
sudo docker stop lmx
Docker compose
sudo docker compose stop

From Git repository

First, ensure Git is installed on your system.

  1. Clone the repository
git clone https://git.djeex.fr/Djeex/lumeex.git
  1. Navigate to the project docker/ 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 \
  lumeex
Docker compose
sudo docker compose -f ./docker/docker-compose.yaml up -d
  • Ports : Ports are used for preview your static site at https://localhost:3000 or https://yourserverip:3000. If port 3000 is already used, juste change 3000:3000 in your docker run command or docker/docker-compose.yaml file by your-custom-port:3000.

You’re ready to go! The container is now running and ready for use.

  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

You’re ready to go! The project is now installed and ready for use.

Table of Contents