From bacf26e75d1aa0eef45c2db4252db10ec930a6b5 Mon Sep 17 00:00:00 2001 From: felix Date: Tue, 18 Nov 2025 12:25:06 +0100 Subject: [PATCH] Update README.md --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4fa218d..bd0a6b2 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,28 @@ Backend for the organization portal application, based on the mu.semte.ch microservices stack. -## How to - ### Boot up the system in DEV environment - cd /path/to/mu-project - docker-compose -f docker-compose.yml -f docker-compose.dev.yml up + cd /path/to/app-organization-portal + docker compose -f docker-compose.yml -f docker-compose.dev.yml up -You can shut down using `docker-compose stop` and remove everything using `docker-compose rm`. +You can shut down using `docker compose stop` and remove everything using `docker compose rm`. + +#### Trick +If you think typing the full command takes too long every time, run this in your shell: + +``` +# Assumes you are in root of app-organization-portal +echo "COMPOSE_FILE=docker-compose.yml:docker-compose.dev.yml:docker-compose.override.yml" > .env +touch docker-compose.override.yml +``` +Now you can just run `docker compose up` and it will take the config files into account. +If you want to go a step further, and still think (like most of us) that `docker compose` is too long to type, you can alias it: +``` +echo "alias drc='docker compose'" >> ~/.bashrc +echo "alias drcl='docker compose logs -ft --tail=100'" >> ~/.bashrc +``` +Now everywhere `drc up -d` will work as shorthand for `docker compose up -d`. #### Setup consumers