summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoffrey F <f.joffrey@gmail.com>2014-04-28 20:51:46 +0200
committerJoffrey F <f.joffrey@gmail.com>2014-04-28 20:51:46 +0200
commit9bb292bcbd3fa3ae68c4c4b07b6f21fd110f1c4c (patch)
treec6a889d9388b078b5563ecaadb00ae92d0367fcf /README.md
parent3ff1f1ed4bacac7651f61bfe2a9e2e73eeec3e30 (diff)
parente012d31752670a179916619bafd024e4360a83c1 (diff)
downloaddocker-py-9bb292bcbd3fa3ae68c4c4b07b6f21fd110f1c4c.tar.gz
Merge pull request #209 from tarnfeld/feature/build-context
Added ability to specify the full build context
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6d823e9..f725db9 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,8 @@ is hosted. `version` is the version of the API the client will use and
```python
c.build(path=None, tag=None, quiet=False, fileobj=None, nocache=False,
- rm=False, stream=False)
+ rm=False, stream=False, timeout=None,
+ custom_context=False, encoding=None):
```
Similar to the `docker build` command. Either `path` or `fileobj` needs
@@ -38,6 +39,11 @@ to be set. `path` can be a local path (to a directory containing a
Dockerfile) or a remote URL. `fileobj` must be a readable file-like
object to a Dockerfile.
+If you have a tar file for the docker build context (including a dockerfile)
+already, pass a readable file-like object to `fileobj` and also pass
+`custom_context=True`. If the stream is compressed also, set `encoding` to
+the correct value (e.g `gzip`).
+
```python
c.commit(container, repository=None, tag=None, message=None, author=None,
conf=None)