Skip to content

Docker: recommend mounting the database directory as a named volume #1090

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
andig wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Docker: recommend mounting the database directory as a named volume #1090

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/content/docs/de/installation/docker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ Erstelle das Datenbank-Verzeichnis auf deinem Host-System.
In dieser Anleitung verwenden wir exemplarisch den Pfad `/home/user/.evcc/`.
Falls du die dateibasierte Konfiguration nutzt, verwende zusätzlich `/home/user/evcc.yaml`

:::tip[Das Verzeichnis einbinden, nicht die Datenbankdatei]
Binde immer das **Verzeichnis** `/root/.evcc` ein — niemals eine einzelne `evcc.db` Datei. evcc legt die SQLite Datenbank zusammen mit ihren Begleitdateien (`evcc.db-wal` und `evcc.db-shm`) in diesem Verzeichnis ab, und alle müssen gemeinsam erhalten bleiben.

Ein [Named Volume](https://docs.docker.com/engine/storage/volumes/) (`docker volume create evcc`, dann `evcc:/root/.evcc` einbinden) ist die robusteste Wahl: Es hält die Dateien zusammen und liegt auf dem nativen Dateisystem des Hosts, das die von SQLite benötigte Dateisperrung bereitstellt. Lege die Datenbank nicht auf einer Netzwerkfreigabe (NFS/SMB) ab und — bei Docker Desktop für macOS/Windows — nicht auf einem Bind Mount, da dies die SQLite-Sperrung beeinträchtigen kann.
:::

## Installation

In diesem Abschnitt werden drei Möglichkeiten zur Installation von evcc über Docker beschrieben.
Expand Down
6 changes: 6 additions & 0 deletions src/content/docs/en/installation/docker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ Create the database directory on your host system.
In this guide we use the path `/home/user/.evcc/` as an example.
If you're using file-based configuration, also use `/home/user/evcc.yaml`

:::tip[Mount the directory, not the database file]
Always mount the `/root/.evcc` **directory** — never a single `evcc.db` file. evcc keeps the SQLite database together with its sidecar files (`evcc.db-wal` and `evcc.db-shm`) in this directory, and all of them have to persist together.

A [named volume](https://docs.docker.com/engine/storage/volumes/) (`docker volume create evcc`, then mount `evcc:/root/.evcc`) is the most robust choice: it keeps the files together and lives on the host's native filesystem, which provides the file locking SQLite needs. Avoid placing the database on a network share (NFS/SMB) or — on Docker Desktop for macOS/Windows — on a bind mount, as these can break SQLite locking.
:::

## Installation

This section describes three ways to install evcc using Docker:
Expand Down