summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorshin- <joffrey@dotcloud.com>2013-12-13 15:46:54 +0100
committershin- <joffrey@dotcloud.com>2013-12-13 15:46:54 +0100
commit64781888e06824f6beac5a6ccc4afd85109ecf30 (patch)
tree4e221b1ad636ec9cf0eeeeab1746b600d316bdee /README.md
parent9bbbb5d3b4a0fc32153eb878153986028ce84bbc (diff)
parent26f6f2bc4048c3900a3ae28a33723d1f47ef2c67 (diff)
downloaddocker-py-64781888e06824f6beac5a6ccc4afd85109ecf30.tar.gz
Merge branch 'privilege' of github.com:yukw777/docker-py into yukw777-privilege
Conflicts: README.md tests/test.py
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index c7f4c43..fa2d017 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ Identical to the `docker cp` command.
* <code>c.create_container(image, command=None, hostname=None, user=None,
detach=False, stdin_open=False, tty=False, mem_limit=0, ports=None, environment=None, dns=None, volumes=None, volumes_from=None,
- privileged=False, name=None)</code>
+ name=None)</code>
Creates a container that can then be `start`ed. Parameters are similar to those
for the `docker run` command except it doesn't support the attach options
(`-a`)
@@ -98,7 +98,7 @@ Restart a container. Similar to the `docker restart` command.
* `c.search(term)`
Identical to the `docker search` command.
-* `c.start(container, binds=None, port_bindings=None, lxc_conf=None)`
+* `c.start(container, binds=None, port_bindings=None, lxc_conf=None, privileged=False)`
Similar to the `docker start` command, but doesn't support attach options.
Use `docker logs` to recover `stdout`/`stderr`
`binds` Allows to bind a directory in the host to the container. See
@@ -106,6 +106,7 @@ Use `docker logs` to recover `stdout`/`stderr`
`port_bindings` Exposes container ports to the host. See "Port bindings" below
for more information.
`lxc_conf` allows to pass LXC configuration options using a dictionary.
+`privileged` starts the container in privileged mode.
* `c.stop(container, timeout=10)`
Stops a container. Similar to the `docker stop` command.
@@ -171,4 +172,4 @@ Volume mappings are then declared inside the `Client.start` method like this:
client.start(container_id, bindings={
'/mnt/vol2': '/home/user1/',
'/mnt/vol1': '/var/www'
- }) \ No newline at end of file
+ })