From 1f54f60d466aaac1f1d3f57031899038750b6bf9 Mon Sep 17 00:00:00 2001 From: "Maurice L." Date: Fri, 27 Feb 2026 22:09:56 +0100 Subject: [PATCH] Updated README.md --- README.md | 29 +++++++++++++++++++++++++++++ docker-compose.yaml | 11 +++++++++++ 2 files changed, 40 insertions(+) create mode 100644 docker-compose.yaml diff --git a/README.md b/README.md index e3ec02c..6bdbc5c 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,35 @@ The app is fully open source, lightweight, and can run on small devices like Ras ## Installation +### Docker Compose (recommended) +1. Download docker-compose.yaml +````shell +$ curl -L https://git.miaurizius.de/MiauRizius/shap-planner-backend/raw/branch/main/docker-compose.yaml -o docker-compose.yaml +```` +or create it yourself and enter the following content +````yaml +services: + shap-planner: + image: git.miaurizius.de/miaurizius/shap-planner-backend:latest + container_name: shap-planner + restart: unless-stopped + ports: + - "8080:8080" + environment: + - SHAP_JWT_SECRET=SECURE_RANDOM_STRING # Must be at least 32 characters long + volumes: + - ./appdata:/appdata # To edit your configuration files +```` + +2. Start the container +````shell +$ docker compose up -d +```` + +3. Edit configuration as you like + +### Build from source + 1. Clone the repository: ```bash git clone https://git.miaurizius.de/MiauRizius/shap-planner-backend.git diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 0000000..8788c9c --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,11 @@ +services: + shap-planner: + image: git.miaurizius.de/miaurizius/shap-planner-backend:latest + container_name: shap-planner + restart: unless-stopped + ports: + - "8080:8080" + environment: + - SHAP_JWT_SECRET=SECURE_RANDOM_STRING # Must be at least 32 characters long + volumes: + - ./appdata:/appdata # To edit your configuration files \ No newline at end of file