Skip to content

improve README #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
milesstoetzner merged 2 commits into from
Jul 23, 2025
Merged

improve README #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abdcd83
update docs
milesstoetzner Jul 5, 2025
96ed908
minor
milesstoetzner Jul 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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
```
4 changes: 2 additions & 2 deletions website/docs/docs/docs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
[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.
Loading