From 930e3774afeb7d1063f21b5add1d072af410a8b9 Mon Sep 17 00:00:00 2001 From: viewit Date: Sat, 13 Jun 2026 00:01:07 +0200 Subject: [PATCH] docs: Portainer-Deployment-Anleitung + docker-compose.portainer.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Named-Volume-Compose ohne ENV-Pflichtfelder — Bridge startet im Offline-Modus, User trägt Drucker-IP in der UI ein. --- README.de.md | 14 ++++++++++++++ README.md | 14 ++++++++++++++ docker-compose.portainer.yml | 29 +++++++++++++++++++++++++++++ 3 files changed, 57 insertions(+) create mode 100644 docker-compose.portainer.yml diff --git a/README.de.md b/README.de.md index 2d33da4..a6d9b27 100644 --- a/README.de.md +++ b/README.de.md @@ -105,6 +105,20 @@ Drucker → Verbindungstyp **Moonraker** → Host: `http://BRIDGE-IP:7125` --- +## 🐳 Portainer + +[`docker-compose.portainer.yml`](docker-compose.portainer.yml) in +**Portainer → Stacks → Add stack → Web editor** einfügen und auf *Deploy* klicken. + +Keine Konfiguration nötig — die Bridge startet im Offline-Modus. +**`http://HOST-IP:7125`** öffnen, den **Drucker-Tab** aufrufen und **+ Drucker hinzufügen** klicken. +Nur die Drucker-IP eingeben — Zugangsdaten werden automatisch geholt und gespeichert. + +Alle Daten (Konfiguration, GCode-Store, Datenbank) liegen in Named Docker Volumes +(`kx-bridge-config`, `kx-bridge-data`), die Portainer verwaltet. + +--- + ## 📺 Video-Tutorial [![KX-Bridge Setup & Usage](https://img.youtube.com/vi/1Ql4wfH27fM/hqdefault.jpg)](https://www.youtube.com/watch?v=1Ql4wfH27fM) diff --git a/README.md b/README.md index ac77fc0..b11bd71 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,20 @@ Printer → Connection type **Moonraker** → Host: `http://BRIDGE-IP:7125` --- +## 🐳 Portainer + +Paste [`docker-compose.portainer.yml`](docker-compose.portainer.yml) into +**Portainer → Stacks → Add stack → Web editor** and click *Deploy*. + +No configuration needed upfront — the bridge starts in offline mode. +Open **`http://HOST-IP:7125`**, go to the **Printers** tab and click **+ Add printer**. +Enter the printer's IP address — credentials are fetched and saved automatically. + +All data (config, GCode store, database) is stored in named Docker volumes +(`kx-bridge-config`, `kx-bridge-data`) managed by Portainer. + +--- + ## 📺 Video Tutorial [![KX-Bridge Setup & Usage](https://img.youtube.com/vi/1Ql4wfH27fM/hqdefault.jpg)](https://www.youtube.com/watch?v=1Ql4wfH27fM) diff --git a/docker-compose.portainer.yml b/docker-compose.portainer.yml new file mode 100644 index 0000000..43a8db1 --- /dev/null +++ b/docker-compose.portainer.yml @@ -0,0 +1,29 @@ +# KX-Bridge — Portainer Stack +# +# Paste this into Portainer → Stacks → Add stack → Web editor +# +# No configuration needed upfront — just deploy, open http://HOST-IP:7125 +# and add your printer via the UI (IP only, credentials are fetched automatically). +# +# All data (config, GCode store, database) is stored in named Docker volumes +# managed by Portainer. + +services: + kx-bridge: + image: gitea.it-drui.de/viewit/kx-bridge:latest + volumes: + - kx-bridge-config:/app/config + - kx-bridge-data:/app/data + ports: + # Port 7125 = first printer. Add 7126, 7127, … for each additional printer. + - "7125:7125" + restart: unless-stopped + logging: + driver: json-file + options: + max-size: "10m" + max-file: "3" + +volumes: + kx-bridge-config: + kx-bridge-data: