docs: document DOCKER_API_VERSION for installer API mismatch

Help self-hosted users recover when the installer Docker CLI is newer
than the host Engine by documenting the DOCKER_API_VERSION workaround.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Chirag AggarwalandCursor committed 2026-07-30 15:28:06 +05:30
1 parent a928da68ac
commit 26075e06da
1 file changed
+17
+17
View File
@@ -29,6 +29,7 @@ Table of Contents:
- [Windows](#windows)
- [CMD](#cmd)
- [PowerShell](#powershell)
- [Docker API version mismatch](#docker-api-version-mismatch)
- [Upgrade from an Older Version](#upgrade-from-an-older-version)
- [One-Click Setups](#one-click-setups)
- [Getting Started](#getting-started)
@@ -104,6 +105,22 @@ docker run -it --rm `
Once the Docker installation is complete, go to http://localhost to access the Appwrite console from your browser. Please note that on non-Linux native hosts, the server might take a few minutes to start after completing the installation.
### Docker API version mismatch
If install or upgrade fails with an error like `client version 1.52 is too new. Maximum supported API version is 1.42`, the Docker CLI inside the Appwrite image is newer than your host Docker Engine. Pass `DOCKER_API_VERSION` set to the maximum API version from the error (or upgrade Docker on the host):
```bash
docker run -it --rm \
--env DOCKER_API_VERSION=1.42 \
--publish 20080:20080 \
--volume /var/run/docker.sock:/var/run/docker.sock \
--volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
--entrypoint="install" \
appwrite/appwrite:1.9.0
```
Use the same `--env DOCKER_API_VERSION=...` flag with `--entrypoint="upgrade"` when upgrading.
For advanced production and custom installation, check out our Docker [environment variables](https://appwrite.io/docs/environment-variables) docs. You can also use our public [docker-compose.yml](https://appwrite.io/install/compose) and [.env](https://appwrite.io/install/env) files to manually set up an environment.
### Upgrade from an Older Version