From ae0ef08f9be33298ba7ba340f32c9ebbfa02d890 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?O=CC=81scar=20M=2E=20Lage?= Date: Thu, 5 Dec 2024 14:14:20 +0100 Subject: [PATCH] Imp: README --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 971902a..142f486 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,11 @@ $ cp env.sample .env ```ini # Docker DOCKER_ENV=production -PROJECT_NAME=heating-monitor -FIXME +BASE_URL=https://wrap.sh +SERVER_PORT=8080 +UPLOAD_DIR=uploads +TOP_N_COMMANDS=10 +MASTODON_INSTANCE_FOR_SHARING=mastodon.social ``` ## Docker @@ -26,13 +29,14 @@ This project can be easily run on Docker: $ make build $ make rebuild $ make start +$ make stop ``` The `Makefile` has been configured to facilitate the build and execution of Docker with the `--build-arg` argument, which passes the `DOCKER_ENV` environment variable to determine the environment. This variable is read from the .env file: `--build-arg DOCKER_ENV=${DOCKER_ENV}`: This variable is used to determine the execution environment (`local` or `production`), affecting both the binary build process and the container's behavior. -If `DOCKER_ENV` is set to `production` it should execute the binary, whereas if set to `local` it will run with air to enable reloads during development, among other things. +If `DOCKER_ENV` is set to `production` it should execute the binary, whereas if set to `local` it will install and run with `air` to enable reloads during development, among other things. ## Comands