Demo Setup - green-ecolution/backend GitHub Wiki

Deployed demo instance

A demo instance is available at https://demo.green-ecolution.de. This demo instance allows you to play around with the application, including creating trees, clusters and watering schedules. Note that the auth and mqtt services are disabled. So a demo user is used and no real sensor data is received in the instance. Also, the instance DB is reset every day.

Run an instance locally

If you want to experiment with the system by running it locally, you can use Docker Compose. The necessary Docker Compose file can be found here: https://github.com/green-ecolution/green-ecolution-backend/blob/develop/.docker/docker-compose.yaml

By default, some features are disabled in the provided Docker Compose setup. To unlock additional functionality, you need to start external services. The following features are disabled by default but can be enabled by running the required external services:

Service	Purpose	Enabled by Default?	Required External Service
auth	User authentication and management	No	OIDC Provider (e.g., Keycloak)
mqtt	Receiving sensor data via MQTT	No	MQTT source providing data in the expected format
routing	Calculating watering plan routes	No	Vroom and a routing service (e.g., Valhalla, Open Route Service)
s3	Storing GPX navigation files	No	S3 compatible storage (e.g., AWS S3, Minio)

To enable one or more of these features, you can configure the appropriate environment variables in the Docker Compose file. Some sample configurations are commented out in the file. Please refer to the Configuration chapter for more details on how to configure the application.

Once the service has been launched with Docker Compose, the application can be accessed by typing http://localhost:8123

wget https://raw.githubusercontent.com/green-ecolution/green-ecolution-backend/refs/heads/develop/.docker/docker-compose.yaml
docker compose up