From ffd96061e998a098a1974277ef3188fca055a25c Mon Sep 17 00:00:00 2001 From: He4eT Date: Thu, 29 May 2025 10:21:58 +0200 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 46d693f..cd42a44 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,33 @@ the internal structure of some sensors is simplified: ## Deployment -Coming soon. +### Environment Variables + +Before running the production server, +you need to configure environment variables. + +Start by copying the example file and editing it: + +```sh +cp ./.env.example ./.env +``` + +### Running with Docker Compose + +Once the environment variables are set up, +you can start the server using Docker Compose: + +```sh +docker compose up --build +``` + +By default, the server will be available at `http://0.0.0.0:1337/`. +The database and uploaded user files are stored in the `./data` directory. + +You can change this behavior by editing `docker-compose.yml` if needed. + +**Note**: Environment variables defined in `docker-compose.yml` +will **override** those in the `.env` file. ## Resources