Kaydet (Commit) 3c48d2d7 authored tarafından Joffrey F's avatar Joffrey F

Merge branch 'vladfr-365-document-boot2docker'

This diff is collapsed.
# Using with Boot2docker
For usage with boot2docker, there is a helper function in the utils package named `kwargs_from_env`, it will pass any environment variables from Boot2docker to the Client.
First run boot2docker in your shell:
```bash
$ $(boot2docker shellinit)
Writing /Users/you/.boot2docker/certs/boot2docker-vm/ca.pem
Writing /Users/you/.boot2docker/certs/boot2docker-vm/cert.pem
Writing /Users/you/.boot2docker/certs/boot2docker-vm/key.pem
export DOCKER_HOST=tcp://192.168.59.103:2376
export DOCKER_CERT_PATH=/Users/you/.boot2docker/certs/boot2docker-vm
export DOCKER_TLS_VERIFY=1
```
You can then instantiate `docker.Client` like this:
```python
from docker.client import Client
from docker.utils import kwargs_from_env
client = Client(**kwargs_from_env())
print client.version()
```
# Contributing # Contributing
See the [Docker contributing guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md). See the [Docker contributing guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md).
The following is specific to docker-py. The following is specific to docker-py.
## Running the tests & Code Quality ## Running the tests & Code Quality
...@@ -14,7 +14,7 @@ $ tox ...@@ -14,7 +14,7 @@ $ tox
``` ```
## Building the docs ## Building the docs
Docs are built with [MkDocs](http://www.mkdocs.org/). For development, you can Docs are built with [MkDocs](http://www.mkdocs.org/). For development, you can
run the following in the project directory: run the following in the project directory:
``` ```
$ pip install -r docs-requirements.txt $ pip install -r docs-requirements.txt
...@@ -32,5 +32,5 @@ Before a new release, please go through the following checklist: ...@@ -32,5 +32,5 @@ Before a new release, please go through the following checklist:
## Vulnerability Reporting ## Vulnerability Reporting
For any security issues, please do NOT file an issue or pull request on github! For any security issues, please do NOT file an issue or pull request on github!
Please contact [security@docker.com](mailto:security@docker.com) or read [the Please contact [security@docker.com](mailto:security@docker.com) or read [the
Docker security page](https://www.docker.com/resources/security/). Docker security page](https://www.docker.com/resources/security/).
...@@ -12,5 +12,4 @@ Our latest stable is always available on PyPi. ...@@ -12,5 +12,4 @@ Our latest stable is always available on PyPi.
Full documentation is available in the `/docs/` directory. Full documentation is available in the `/docs/` directory.
## License ## License
Docker is licensed under the Apache License, Version 2.0. See LICENSE for full Docker is licensed under the Apache License, Version 2.0. See LICENSE for full license text
license text
...@@ -29,8 +29,8 @@ like such in both the `create_container()` and `start()` calls: ...@@ -29,8 +29,8 @@ like such in both the `create_container()` and `start()` calls:
```python ```python
container_id = c.create_container( container_id = c.create_container(
'busybox', 'busybox',
'ls', 'ls',
ports=[(1111, 'udp'), 2222] ports=[(1111, 'udp'), 2222]
) )
c.start(container_id, port_bindings={'1111/udp': 4567, 2222: None}) c.start(container_id, port_bindings={'1111/udp': 4567, 2222: None})
......
...@@ -28,7 +28,7 @@ https://docs.python.org/3.4/library/ssl.html#ssl.PROTOCOL_TLSv1) ...@@ -28,7 +28,7 @@ https://docs.python.org/3.4/library/ssl.html#ssl.PROTOCOL_TLSv1)
client = docker.Client(base_url='<https_url>', tls=True) client = docker.Client(base_url='<https_url>', tls=True)
``` ```
Equivalent CLI options: Equivalent CLI options:
```bash ```bash
docker --tls ... docker --tls ...
``` ```
...@@ -48,7 +48,7 @@ tls_config = docker.tls.TLSConfig(ca_cert='/path/to/ca.pem') ...@@ -48,7 +48,7 @@ tls_config = docker.tls.TLSConfig(ca_cert='/path/to/ca.pem')
client = docker.Client(base_url='<https_url>', tls=tls_config) client = docker.Client(base_url='<https_url>', tls=tls_config)
``` ```
Equivalent CLI options: Equivalent CLI options:
```bash ```bash
docker --tlsverify --tlscacert /path/to/ca.pem ...` docker --tlsverify --tlscacert /path/to/ca.pem ...`
......
# Using volumes # Using volumes
Volume declaration is done in two parts. First, you have to provide a list of Volume declaration is done in two parts. First, you have to provide
mountpoints to the `Client().create_container()` method. a list of mountpoints to the `Client().create_container()` method.
```python ```python
c.create_container('busybox', 'ls', volumes=['/mnt/vol1', '/mnt/vol2']) c.create_container('busybox', 'ls', volumes=['/mnt/vol1', '/mnt/vol2'])
......
...@@ -11,5 +11,6 @@ pages: ...@@ -11,5 +11,6 @@ pages:
- [volumes.md, Using Volumes] - [volumes.md, Using Volumes]
- [tls.md, Using TLS] - [tls.md, Using TLS]
- [host-devices.md, Host devices] - [host-devices.md, Host devices]
- [boot2docker.md, Using with boot2docker]
- [change_log.md, Change Log] - [change_log.md, Change Log]
- [contributing.md, Contributing] - [contributing.md, Contributing]
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment