From 5984a48394c5aec63185f29cf79728e8824a3ef6 Mon Sep 17 00:00:00 2001 From: michidold Date: Sun, 2 Nov 2025 11:11:46 +0100 Subject: [PATCH 1/3] Add nonroot config, format on save --- docs/installation/docker.mdx | 95 +++++++++++++++++++----------------- 1 file changed, 49 insertions(+), 46 deletions(-) diff --git a/docs/installation/docker.mdx b/docs/installation/docker.mdx index fa93cec3fd..ed8a53056d 100644 --- a/docs/installation/docker.mdx +++ b/docs/installation/docker.mdx @@ -28,21 +28,21 @@ Du benötigst eine `evcc.yaml` Konfigurationsdatei für deine Komponenten (Zähl Es gibt mehrere Möglichkeiten, diese zu erstellen: 1. **Assistent auf anderem System:** Führe `evcc configure` vorher auf einem [Linux](./linux), [macOS](./macos) oder [Windows](./windows) System aus. - Verwende die damit erstellte `evcc.yaml` Datei für deine Docker Installation. + Verwende die damit erstellte `evcc.yaml` Datei für deine Docker Installation. 2. **Manuell:** Erstelle die `evcc.yaml` manuell. - Hier findest du eine Anleitung unter [evcc.yaml erstellen](./configuration). + Hier findest du eine Anleitung unter [evcc.yaml erstellen](./configuration). 3. **Assistent in Docker:** - Praktisch, wenn du Docker auf einem Linux System installiert hast. - Erstelle eine leere `evcc.yaml` Datei und führe den Konfigurationsassistenten direkt in Docker aus. - Folge den Fragen des Assistenten. - Am Ende wird die Konfiguration in die erstellte `evcc.yaml` Datei geschrieben. + Praktisch, wenn du Docker auf einem Linux System installiert hast. + Erstelle eine leere `evcc.yaml` Datei und führe den Konfigurationsassistenten direkt in Docker aus. + Folge den Fragen des Assistenten. + Am Ende wird die Konfiguration in die erstellte `evcc.yaml` Datei geschrieben. - ```sh - touch evcc.yaml - docker run -v $(pwd)/evcc.yaml:/app/evcc.yaml -it evcc/evcc:latest evcc configure - ``` + ```sh + touch evcc.yaml + docker run -v $(pwd)/evcc.yaml:/app/evcc.yaml -it evcc/evcc:latest evcc configure + ``` ### Volumes @@ -71,22 +71,22 @@ Hier sind die relevanten Angaben, die du eintragen musst: #### Volume Mounts {#volumes} -| Host Pfad | Container Pfad | Beschreibung | -|------------------------|-----------------|-----------------------------------| -| `/home/user/evcc.yaml` | `/etc/evcc.yaml`| Konfigurationsdatei | -| `/home/user/.evcc/` | `/root/.evcc` | Verzeichnis für interne Datenbank | +| Host Pfad | Container Pfad | Beschreibung | +| ---------------------- | ---------------- | --------------------------------- | +| `/home/user/evcc.yaml` | `/etc/evcc.yaml` | Konfigurationsdatei | +| `/home/user/.evcc/` | `/root/.evcc` | Verzeichnis für interne Datenbank | #### Ports {#ports} -| Host Port | Container Port | Beschreibung | Optional | -|-----------|----------------|-------------------------|----------| -| 7070 | 7070/tcp | Web UI, API | | -| 8887 | 8887/tcp | OCPP Server | Yes | -| 9522 | 9522/udp | SMA Sunny Home Manager | Yes | -| 7090 | 7090/udp | KEBA Chargers | Yes | -| 5353 | 5353/udp | mDNS | Yes | -| 4712 | 4712/tcp | EEBus | Yes | -| 8899 | 8899/udp | Modbus UDP | Yes | +| Host Port | Container Port | Beschreibung | Optional | +| --------- | -------------- | ---------------------- | -------- | +| 7070 | 7070/tcp | Web UI, API | | +| 8887 | 8887/tcp | OCPP Server | Yes | +| 9522 | 9522/udp | SMA Sunny Home Manager | Yes | +| 7090 | 7090/udp | KEBA Chargers | Yes | +| 5353 | 5353/udp | mDNS | Yes | +| 4712 | 4712/tcp | EEBus | Yes | +| 8899 | 8899/udp | Modbus UDP | Yes | Öffne die Docker UI deines Systems und erstelle einen neuen Container mit den obigen Angaben und starte ihn. @@ -124,27 +124,28 @@ evcc/evcc:latest - ```sh - sudo docker run -d --name evcc \ - -v /home/user/evcc.yaml:/etc/evcc.yaml \ - -v /home/user/.evcc:/root/.evcc \ - -p 7070:7070 \ - -p 8887:8887 \ - # highlight-start - -p 9522:9522/udp \ - -p 4712:4712 \ - --network host - -v /etc/machine-id:/etc/machine-id - # highlight-end - evcc/evcc:latest - ``` - - Setze den Netzwerkmodus auf `host`. - Der SMA Sunny Home Manager benötigt eine eindeutige Geräte-ID. - Unter Linux kannst du `machine-id` in den Container mounten. - Alternativ kannst du in der `evcc.yaml` auch eine ID im `plant` Parameter hinterlegen. - - --- +```sh +sudo docker run -d --name evcc \ +-v /home/user/evcc.yaml:/etc/evcc.yaml \ +-v /home/user/.evcc:/root/.evcc \ +-p 7070:7070 \ +-p 8887:8887 \ +# highlight-start +-p 9522:9522/udp \ +-p 4712:4712 \ +--network host +-v /etc/machine-id:/etc/machine-id +# highlight-end +evcc/evcc:latest +``` + +Setze den Netzwerkmodus auf `host`. +Der SMA Sunny Home Manager benötigt eine eindeutige Geräte-ID. +Unter Linux kannst du `machine-id` in den Container mounten. +Alternativ kannst du in der `evcc.yaml` auch eine ID im `plant` Parameter hinterlegen. + +--- + @@ -195,13 +196,15 @@ Entsprechend der passenden Komponenten-Konstellation kopiert man eine der folgen ```yaml -version: '3' +version: "3" services: evcc: command: - evcc container_name: evcc image: evcc/evcc:latest + # Optional: + #user: : ports: - 7070:7070/tcp - 8887:8887/tcp @@ -215,7 +218,7 @@ services: ```yaml -version: '3' +version: "3" services: evcc: command: From 4809b47fc8cdcb7a3cc2bc78a8262ec4136f8145 Mon Sep 17 00:00:00 2001 From: michidold Date: Sun, 2 Nov 2025 11:17:47 +0100 Subject: [PATCH 2/3] Add to second config --- docs/installation/docker.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/installation/docker.mdx b/docs/installation/docker.mdx index ed8a53056d..da68ab279c 100644 --- a/docs/installation/docker.mdx +++ b/docs/installation/docker.mdx @@ -225,6 +225,8 @@ services: - evcc container_name: evcc image: evcc/evcc:latest + # Optional: + #user: : ports: - 7070:7070/tcp - 8887:8887/tcp From 8d4feaf7337c79dc11b0260f6085485781857189 Mon Sep 17 00:00:00 2001 From: Michael Geers Date: Tue, 11 Nov 2025 12:39:36 +0100 Subject: [PATCH 3/3] update en --- docs/installation/docker.mdx | 8 +-- .../current/installation/docker.mdx | 52 ++++++++++--------- 2 files changed, 32 insertions(+), 28 deletions(-) diff --git a/docs/installation/docker.mdx b/docs/installation/docker.mdx index da68ab279c..64ba63ca43 100644 --- a/docs/installation/docker.mdx +++ b/docs/installation/docker.mdx @@ -203,8 +203,6 @@ services: - evcc container_name: evcc image: evcc/evcc:latest - # Optional: - #user: : ports: - 7070:7070/tcp - 8887:8887/tcp @@ -212,6 +210,8 @@ services: - /home/user/evcc.yaml:/etc/evcc.yaml - /home/user/.evcc:/root/.evcc restart: unless-stopped + # optional: + #user: : ``` @@ -225,8 +225,6 @@ services: - evcc container_name: evcc image: evcc/evcc:latest - # Optional: - #user: : ports: - 7070:7070/tcp - 8887:8887/tcp @@ -239,6 +237,8 @@ services: - /var/lib/dbus/machine-id:/var/lib/dbus/machine-id network_mode: host restart: unless-stopped + # optional: + #user: : ``` diff --git a/i18n/en/docusaurus-plugin-content-docs/current/installation/docker.mdx b/i18n/en/docusaurus-plugin-content-docs/current/installation/docker.mdx index 6efbd36883..cb081d9088 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/installation/docker.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/installation/docker.mdx @@ -28,21 +28,21 @@ You need an `evcc.yaml` configuration file for your components (meters, wallbox, There are several ways to create this: 1. **Assistant on another system:** Run `evcc configure` beforehand on a [Linux](./linux), [macOS](./macos) or [Windows](./windows) system. - Use the created `evcc.yaml` file for your Docker installation. + Use the created `evcc.yaml` file for your Docker installation. 2. **Manual:** Create the `evcc.yaml` manually. - You can find instructions under [Configuration](./configuration). + You can find instructions under [Configuration](./configuration). 3. **Assistant in Docker:** - Handy if you have Docker installed on a Linux system. - Create an empty `evcc.yaml` file and run the configuration assistant directly in Docker. - Follow the assistant's questions. - At the end, the configuration will be written to the created `evcc.yaml` file. + Handy if you have Docker installed on a Linux system. + Create an empty `evcc.yaml` file and run the configuration assistant directly in Docker. + Follow the assistant's questions. + At the end, the configuration will be written to the created `evcc.yaml` file. - ```sh - touch evcc.yaml - docker run -v $(pwd)/evcc.yaml:/app/evcc.yaml -it evcc/evcc:latest evcc configure - ``` + ```sh + touch evcc.yaml + docker run -v $(pwd)/evcc.yaml:/app/evcc.yaml -it evcc/evcc:latest evcc configure + ``` ### Volumes @@ -71,22 +71,22 @@ Here are the relevant details you need to enter: #### Volume Mounts {#volumes} -| Host Path | Container Path | Description | -|------------------------|------------------|--------------------------------| -| `/home/user/evcc.yaml` | `/etc/evcc.yaml` | Configuration file | -| `/home/user/.evcc/` | `/root/.evcc` | Directory for internal database| +| Host Path | Container Path | Description | +| ---------------------- | ---------------- | ------------------------------- | +| `/home/user/evcc.yaml` | `/etc/evcc.yaml` | Configuration file | +| `/home/user/.evcc/` | `/root/.evcc` | Directory for internal database | #### Ports {#ports} -| Host Port | Container Port | Description | Optional | -|-----------|----------------|-------------------------|----------| -| 7070 | 7070/tcp | Web UI, API | | -| 8887 | 8887/tcp | OCPP Server | Yes | -| 9522 | 9522/udp | SMA Sunny Home Manager | Yes | -| 7090 | 7090/udp | KEBA Chargers | Yes | -| 5353 | 5353/udp | mDNS | Yes | -| 4712 | 4712/tcp | EEBus | Yes | -| 8899 | 8899/udp | Modbus UDP | Yes | +| Host Port | Container Port | Description | Optional | +| --------- | -------------- | ---------------------- | -------- | +| 7070 | 7070/tcp | Web UI, API | | +| 8887 | 8887/tcp | OCPP Server | Yes | +| 9522 | 9522/udp | SMA Sunny Home Manager | Yes | +| 7090 | 7090/udp | KEBA Chargers | Yes | +| 5353 | 5353/udp | mDNS | Yes | +| 4712 | 4712/tcp | EEBus | Yes | +| 8899 | 8899/udp | Modbus UDP | Yes | Open your system's Docker UI and create a new container with the above settings and start it. @@ -145,6 +145,7 @@ On Linux, you can mount `machine-id` into the container. Alternatively, you can specify an ID in the `plant` parameter in `evcc.yaml`. --- + @@ -178,6 +179,8 @@ services: - /home/user/evcc.yaml:/etc/evcc.yaml - /home/user/.evcc:/root/.evcc restart: unless-stopped + # optional: + #user: : ``` @@ -202,6 +205,8 @@ services: - /var/lib/dbus/machine-id:/var/lib/dbus/machine-id network_mode: host restart: unless-stopped + # optional: + #user: : ``` @@ -212,7 +217,6 @@ The above example only uses basic ports. Please refer to the [Ports](#ports) section and add additional ports as needed. ::: - Start the container with: ```sh