diff --git a/README.md b/README.md index 8bcad82564..44025486a0 100644 --- a/README.md +++ b/README.md @@ -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