From abdcd839cd99bbacf40ef5fa073bd36c533de409 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miles=20St=C3=B6tzner?= Date: Sat, 5 Jul 2025 13:40:20 +0200 Subject: [PATCH 1/2] update docs --- README.md | 20 +++++++++++++++++++- website/docs/docs/docs.mdx | 4 ++-- 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 74f06f7..f94e06a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ The easiest way to deploy the Gropius system. > :warning: Files in this repository are not compatible with the legacy `docker-compose` cli. Use the newer integrated `docker compose` command instead. See [here](https://docs.docker.com/compose/install/) for install instructions. +## Repository + +To clone the repository use: + +```sh +git clone --recurse-submodules https://github.com/ccims/gropius.git +``` + ## Production To generate a valid configuration, run `./generate_env.sh`. @@ -33,10 +41,20 @@ This will provide - Sync MongoDB database on port 27017 - Login PostgreSQL database on port 5432 + ### GitHub sync To execute the github sync use: ```sh -docker compose -f docker-compose-dev.yaml up github +docker compose -f docker-compose-testing.yaml up github +``` + +## Volumes + +Data is persisted in volumes. +To stop Gropius *and remove the volumes* use: + +``` +docker compose -f docker-compose-testing.yaml down --volumes ``` diff --git a/website/docs/docs/docs.mdx b/website/docs/docs/docs.mdx index fc5b677..04d20a8 100644 --- a/website/docs/docs/docs.mdx +++ b/website/docs/docs/docs.mdx @@ -31,9 +31,9 @@ For a production setup, it is recommended to change default passwords and secret ```sh git clone --recursive https://github.com/ccims/gropius.git cd gropius -docker-compose -f docker-compose-dev.yaml up +docker-compose -f docker-compose-testing.yaml up ``` Alternatively, it is possible to execut services on its own using Gradle. [Modules](./modules) provides an overview of the used commands, requirements and runtime dependencies. -[docker-compose-dev.yaml](https://github.com/ccims/gropius/blob/main/docker-compose-dev.yaml) can be used as a reference for a working set of configuration properties for each service. \ No newline at end of file +[docker-compose-testing.yaml](https://github.com/ccims/gropius/blob/main/docker-compose-testing.yaml) can be used as a reference for a working set of configuration properties for each service. \ No newline at end of file From 96ed908c5d2ef9ffe48de274e497045886917cbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miles=20St=C3=B6tzner?= Date: Sat, 5 Jul 2025 13:42:34 +0200 Subject: [PATCH 2/2] minor --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f94e06a..6ba73d1 100644 --- a/README.md +++ b/README.md @@ -50,10 +50,10 @@ To execute the github sync use: docker compose -f docker-compose-testing.yaml up github ``` -## Volumes +### Volumes Data is persisted in volumes. -To stop Gropius *and remove the volumes* use: +To stop Gropius **and remove the volumes** use: ``` docker compose -f docker-compose-testing.yaml down --volumes