Pre requisite

Pre-requisite

Prepare the workstation before starting Idelium with Docker.

Required software

• Docker Engine or Docker Desktop with Docker Compose v2.
• Git.
• Bash.
• OpenSSL, used by demo mode to create development secrets.
• A browser that can open the local HTTPS endpoint.
• Node.js and npm, optional and only required when running Postman collections through the Newman runtime from the CLI host.
• Enough disk and memory to build and run MariaDB, Idelium API, and Idelium Web.

The Docker stack is validated against modern Docker Compose v2. The repository README contains the currently pinned image inputs and should be treated as the source of truth for exact build versions.

Required repositories

Clone the repositories as siblings:

git clone https://github.com/idelium/idelium-api.git
git clone https://github.com/idelium/idelium-web.git
git clone https://github.com/idelium/idelium-docker.git
cd idelium-docker

The local build modes use the adjacent idelium-api and idelium-web directories. Commit the intended revisions before producing release candidates or reproducible local images.

Network and ports

The frontend is exposed through HTTPS. By default the stack maps the frontend to host port 443. If that port is already in use, configure HTTPS_PORT in .env before startup.

The database and API are internal Docker services. They should not be exposed directly to the host for normal development or production operation.

Configuration files

Create a local environment file from the example:

cp .env.example .env

The .env file contains non-secret configuration and paths to secret files. Secret values belong in ignored files under secrets/ or in a deployment secret provider. Never place real passwords, API keys, Laravel application keys, or TLS private keys directly in tracked files.

TLS expectations

Demo mode creates a short-lived self-signed certificate and verifies it during the smoke test. The browser will still ask you to trust the local certificate manually.

Production and release modes require a trusted certificate and key in the directory selected by TLS_CERT_DIR. The certificate must cover the hostname in APP_URL.