From 3fff6e25f0019af90c60af32f19fada403f330e6 Mon Sep 17 00:00:00 2001 From: viewit Date: Thu, 4 Jun 2026 20:34:41 +0200 Subject: [PATCH] docs(readme): explicit warning that standalone binaries need anycubic_slicer.crt + .key next to the executable (from anycubic-certs.zip) --- README.de.md | 35 +++++++++++++++++++++++++++++++---- README.es.md | 34 ++++++++++++++++++++++++++++++---- README.md | 34 ++++++++++++++++++++++++++++++---- 3 files changed, 91 insertions(+), 12 deletions(-) diff --git a/README.de.md b/README.de.md index e6931e4..ea80161 100644 --- a/README.de.md +++ b/README.de.md @@ -67,17 +67,44 @@ docker compose up -d **Linux-Binary (kein Docker):** ```bash -chmod +x kx-bridge && ./kx-bridge +chmod +x kx-bridge-linux-amd64 && ./kx-bridge-linux-amd64 ``` **Windows-EXE (kein Docker):** ``` kx-bridge.exe ``` -> `config\` und `data\` werden neben der EXE angelegt — portabel. -> Bei Linux- und Windows-Binary liegen `config/` und `data/` (Einstellungen, SQLite, -> GCode-Store) jeweils neben dem Programm. Einfach den ganzen Ordner kopieren = umziehen. +> ⚠️ **TLS-Zertifikate für Standalone-Binary nötig** +> +> Die Bridge spricht per mTLS mit dem Drucker-MQTT und braucht zwei +> Zertifikat-Dateien **direkt neben dem Binary**: +> +> - `anycubic_slicer.crt` +> - `anycubic_slicer.key` +> +> Beide liegen im **`anycubic-certs.zip`** auf derselben Release-Seite. +> Lade die ZIP herunter und entpacke die beiden Dateien in dasselbe +> Verzeichnis wie `kx-bridge-linux-amd64` bzw. `kx-bridge.exe`. Ohne +> die Zertifikate siehst du `Verbindung fehlgeschlagen: TLS-Zertifikate +> fehlen …` (0.9.19.1+) oder `[Errno 2] No such file or directory` +> (ältere Builds). +> +> So muss es aussehen: +> ``` +> ~/kx-bridge/ +> ├── kx-bridge-linux-amd64 (oder kx-bridge.exe) +> ├── anycubic_slicer.crt ← aus anycubic-certs.zip +> ├── anycubic_slicer.key ← aus anycubic-certs.zip +> └── config/ (wird beim ersten Start angelegt) +> ``` +> +> Docker-User müssen das nicht machen — die Zertifikate sind im Image +> enthalten. + +> Bei Linux- und Windows-Binary liegen `config/` und `data/` (Einstellungen, +> SQLite, GCode-Store) jeweils neben dem Programm. Einfach den ganzen Ordner +> kopieren = umziehen. **Python direkt:** ```bash diff --git a/README.es.md b/README.es.md index 68c812f..0a4931c 100644 --- a/README.es.md +++ b/README.es.md @@ -66,17 +66,43 @@ docker compose up -d **Binario Linux (sin Docker):** ```bash -chmod +x kx-bridge && ./kx-bridge +chmod +x kx-bridge-linux-amd64 && ./kx-bridge-linux-amd64 ``` **EXE Windows (sin Docker):** ``` kx-bridge.exe ``` -> `config\` y `data\` se crean junto al EXE — instalación portátil. -> Con los binarios de Linux y Windows, `config/` y `data/` (configuración, SQLite, almacén de GCode) -> viven junto al programa. Copia toda la carpeta para mover la instalación. +> ⚠️ **Certificados TLS necesarios para el binario standalone** +> +> El bridge habla con el MQTT de la impresora vía mTLS y necesita dos +> ficheros de certificado **junto al binario**: +> +> - `anycubic_slicer.crt` +> - `anycubic_slicer.key` +> +> Ambos vienen en **`anycubic-certs.zip`** en la misma página de release. +> Descárgalo y extrae los dos ficheros en el mismo directorio que +> `kx-bridge-linux-amd64` o `kx-bridge.exe`. Sin ellos verás +> `Verbindung fehlgeschlagen: TLS-Zertifikate fehlen …` (0.9.19.1+) o +> `[Errno 2] No such file or directory` (versiones anteriores). +> +> Estructura correcta: +> ``` +> ~/kx-bridge/ +> ├── kx-bridge-linux-amd64 (o kx-bridge.exe) +> ├── anycubic_slicer.crt ← de anycubic-certs.zip +> ├── anycubic_slicer.key ← de anycubic-certs.zip +> └── config/ (se crea en el primer arranque) +> ``` +> +> Los usuarios de Docker no necesitan hacer esto — los certificados +> están incluidos en la imagen. + +> Con los binarios de Linux y Windows, `config/` y `data/` (configuración, +> SQLite, almacén de GCode) viven junto al programa. Copia toda la carpeta +> para mover la instalación. **Python directamente:** ```bash diff --git a/README.md b/README.md index 7bf3199..50b806d 100644 --- a/README.md +++ b/README.md @@ -66,17 +66,43 @@ docker compose up -d **Linux binary (no Docker):** ```bash -chmod +x kx-bridge && ./kx-bridge +chmod +x kx-bridge-linux-amd64 && ./kx-bridge-linux-amd64 ``` **Windows EXE (no Docker):** ``` kx-bridge.exe ``` -> `config\` and `data\` are created next to the EXE — portable. -> With the Linux and Windows binaries, `config/` and `data/` (settings, SQLite, GCode store) -> live next to the program. Copy the whole folder = move the installation. +> ⚠️ **TLS certificates required for the standalone binary** +> +> The bridge talks to the printer's MQTT over mTLS and needs two +> certificate files **right next to the binary**: +> +> - `anycubic_slicer.crt` +> - `anycubic_slicer.key` +> +> Both ship inside **`anycubic-certs.zip`** on the same release page. +> Download it and extract the two files into the same directory as +> `kx-bridge-linux-amd64` / `kx-bridge.exe`. Without them you'll see +> `Verbindung fehlgeschlagen: TLS-Zertifikate fehlen …` (0.9.19.1+) +> or `[Errno 2] No such file or directory` (older builds). +> +> Working layout: +> ``` +> ~/kx-bridge/ +> ├── kx-bridge-linux-amd64 (or kx-bridge.exe) +> ├── anycubic_slicer.crt ← from anycubic-certs.zip +> ├── anycubic_slicer.key ← from anycubic-certs.zip +> └── config/ (auto-created on first run) +> ``` +> +> Docker users don't need to do this — the certs are baked into the +> image. + +> With the Linux and Windows binaries, `config/` and `data/` (settings, +> SQLite, GCode store) live next to the program. Copy the whole folder +> = move the installation. **Python directly:** ```bash