summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2016-10-05 11:15:29 -0700
committerJoffrey F <joffrey@docker.com>2016-10-05 11:19:23 -0700
commitb22e390e568280274f702738abc0976caf3c5801 (patch)
treea3f6e6e0013798abf337692510bd69b086d97870
parentb65de73afea947cb65cc79c58acf414604ea6b16 (diff)
parent230d8c7efe21fd2480ab8cd3a2182773149086a0 (diff)
downloaddocker-py-b22e390e568280274f702738abc0976caf3c5801.tar.gz
Merge branch 'TomasTomecek-improve-version-mismatcj'
-rw-r--r--docs/api.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
index 579057a..affbaac 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -18,6 +18,7 @@ is hosted.
* tls (bool or [TLSConfig](tls.md#TLSConfig)): Equivalent CLI options: `docker --tls ...`
* user_agent (str): Set a custom user agent for requests to the server.
+
****
## attach
@@ -1203,3 +1204,26 @@ TODO:
* load_image
-->
+
+****
+
+## Version mismatch
+
+You may encounter an error like this:
+
+```text
+client is newer than server (client API version: 1.24, server API version: 1.23)
+```
+
+To fix this, you have to either supply the exact version your server supports
+when instantiating the `Client`:
+
+```python
+client = docker.Client(version="1.23")
+```
+
+or let the client automatically detect the newest version server supports:
+
+```python
+client = docker.Client(version="auto")
+```