Content rendering fixes

This commit is contained in:
John Mulhausen 2016-09-30 01:51:56 -07:00
parent 82d33c504a
commit 066b78bf86
105 changed files with 633 additions and 589 deletions

201
LICENSE Normal file
View File

@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2016 Docker, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View File

@ -215,9 +215,11 @@ ng\:form {
<script language="javascript"> <script language="javascript">
var x = document.links.length; var x = document.links.length;
for (i = 0; i < x; i++) { for (i = 0; i < x; i++) {
var munged = false;
var thisHREF = document.links[i].href; var thisHREF = document.links[i].href;
if (thisHREF.indexOf(window.location.hostname) > -1 && document.links[i].className.indexOf("nomunge")<0) if (thisHREF.indexOf(window.location.hostname) > -1 && document.links[i].className.indexOf("nomunge")<0)
{ {
munged = true;
thisHREF = thisHREF.replace(".md","/").replace("/index/","/"); thisHREF = thisHREF.replace(".md","/").replace("/index/","/");
document.links[i].setAttribute('href', thisHREF); document.links[i].setAttribute('href', thisHREF);
} }

View File

@ -14,9 +14,9 @@ title: Compose File Reference
# Compose file reference # Compose file reference
The Compose file is a [YAML](http://yaml.org/) file defining The Compose file is a [YAML](http://yaml.org/) file defining
[services](#service-configuration-reference), [services](compose-file.md#service-configuration-reference),
[networks](#network-configuration-reference) and [networks](compose-file.md#network-configuration-reference) and
[volumes](#volume-configuration-reference). [volumes](compose-file.md#volume-configuration-reference).
The default path for a Compose file is `./docker-compose.yml`. The default path for a Compose file is `./docker-compose.yml`.
A service definition contains configuration which will be applied to each A service definition contains configuration which will be applied to each
@ -29,7 +29,7 @@ As with `docker run`, options specified in the Dockerfile (e.g., `CMD`,
specify them again in `docker-compose.yml`. specify them again in `docker-compose.yml`.
You can use environment variables in configuration values with a Bash-like You can use environment variables in configuration values with a Bash-like
`${VARIABLE}` syntax - see [variable substitution](#variable-substitution) for `${VARIABLE}` syntax - see [variable substitution](compose-file.md#variable-substitution) for
full details. full details.
@ -37,7 +37,7 @@ full details.
> **Note:** There are two versions of the Compose file format version 1 (the > **Note:** There are two versions of the Compose file format version 1 (the
> legacy format, which does not support volumes or networks) and version 2 (the > legacy format, which does not support volumes or networks) and version 2 (the
> most up-to-date). For more information, see the [Versioning](#versioning) > most up-to-date). For more information, see the [Versioning](compose-file.md#versioning)
> section. > section.
This section contains a list of all configuration options supported by a service This section contains a list of all configuration options supported by a service
@ -48,8 +48,8 @@ definition.
Configuration options that are applied at build time. Configuration options that are applied at build time.
`build` can be specified either as a string containing a path to the build `build` can be specified either as a string containing a path to the build
context, or an object with the path specified under [context](#context) and context, or an object with the path specified under [context](compose-file.md#context) and
optionally [dockerfile](#dockerfile) and [args](#args). optionally [dockerfile](compose-file.md#dockerfile) and [args](compose-file.md#args).
build: ./dir build: ./dir
@ -67,7 +67,7 @@ with the `webapp` and optional `tag` specified in `image`:
This will result in an image named `webapp` and tagged `tag`, built from `./dir`. This will result in an image named `webapp` and tagged `tag`, built from `./dir`.
> **Note**: In the [version 1 file format](#version-1), `build` is different in > **Note**: In the [version 1 file format](compose-file.md#version-1), `build` is different in
> two ways: > two ways:
> >
> - Only the string form (`build: .`) is allowed - not the object form. > - Only the string form (`build: .`) is allowed - not the object form.
@ -76,8 +76,8 @@ This will result in an image named `webapp` and tagged `tag`, built from `./dir`
#### context #### context
> [Version 2 file format](#version-2) only. In version 1, just use > [Version 2 file format](compose-file.md#version-2) only. In version 1, just use
> [build](#build). > [build](compose-file.md#build).
Either a path to a directory containing a Dockerfile, or a url to a git repository. Either a path to a directory containing a Dockerfile, or a url to a git repository.
@ -101,7 +101,7 @@ specified.
context: . context: .
dockerfile: Dockerfile-alternate dockerfile: Dockerfile-alternate
> **Note**: In the [version 1 file format](#version-1), `dockerfile` is > **Note**: In the [version 1 file format](compose-file.md#version-1), `dockerfile` is
> different in two ways: > different in two ways:
* It appears alongside `build`, not as a sub-option: * It appears alongside `build`, not as a sub-option:
@ -113,7 +113,7 @@ specified.
#### args #### args
> [Version 2 file format](#version-2) only. > [Version 2 file format](compose-file.md#version-2) only.
Add build arguments, which are environment variables accessible only during the Add build arguments, which are environment variables accessible only during the
build process. build process.
@ -247,7 +247,7 @@ Custom DNS search domains. Can be a single value or a list.
### tmpfs ### tmpfs
> [Version 2 file format](#version-2) only. > [Version 2 file format](compose-file.md#version-2) only.
Mount a temporary file system inside the container. Can be a single value or a list. Mount a temporary file system inside the container. Can be a single value or a list.
@ -295,9 +295,9 @@ beginning with `#` (i.e. comments) are ignored, as are blank lines.
# Set Rails/Rack environment # Set Rails/Rack environment
RACK_ENV=development RACK_ENV=development
> **Note:** If your service specifies a [build](#build) option, variables > **Note:** If your service specifies a [build](compose-file.md#build) option, variables
> defined in environment files will _not_ be automatically visible during the > defined in environment files will _not_ be automatically visible during the
> build. Use the [args](#args) sub-option of `build` to define build-time > build. Use the [args](compose-file.md#args) sub-option of `build` to define build-time
> environment variables. > environment variables.
### environment ### environment
@ -319,9 +319,9 @@ machine Compose is running on, which can be helpful for secret or host-specific
- SHOW=true - SHOW=true
- SESSION_SECRET - SESSION_SECRET
> **Note:** If your service specifies a [build](#build) option, variables > **Note:** If your service specifies a [build](compose-file.md#build) option, variables
> defined in `environment` will _not_ be automatically visible during the > defined in `environment` will _not_ be automatically visible during the
> build. Use the [args](#args) sub-option of `build` to define build-time > build. Use the [args](compose-file.md#args) sub-option of `build` to define build-time
> environment variables. > environment variables.
### expose ### expose
@ -374,7 +374,7 @@ container name and the link alias (`CONTAINER:ALIAS`).
- project_db_1:mysql - project_db_1:mysql
- project_db_1:postgresql - project_db_1:postgresql
> **Note:** If you're using the [version 2 file format](#version-2), the > **Note:** If you're using the [version 2 file format](compose-file.md#version-2), the
> externally-created containers must be connected to at least one of the same > externally-created containers must be connected to at least one of the same
> networks as the service which is linking to them. > networks as the service which is linking to them.
@ -403,10 +403,10 @@ a partial image ID.
image: a4bc65fd image: a4bc65fd
If the image does not exist, Compose attempts to pull it, unless you have also If the image does not exist, Compose attempts to pull it, unless you have also
specified [build](#build), in which case it builds it using the specified specified [build](compose-file.md#build), in which case it builds it using the specified
options and tags it with the specified tag. options and tags it with the specified tag.
> **Note**: In the [version 1 file format](#version-1), using `build` together > **Note**: In the [version 1 file format](compose-file.md#version-1), using `build` together
> with `image` is not allowed. Attempting to do so results in an error. > with `image` is not allowed. Attempting to do so results in an error.
### labels ### labels
@ -440,16 +440,16 @@ Containers for the linked service will be reachable at a hostname identical to
the alias, or the service name if no alias was specified. the alias, or the service name if no alias was specified.
Links also express dependency between services in the same way as Links also express dependency between services in the same way as
[depends_on](#depends-on), so they determine the order of service startup. [depends_on](compose-file.md#depends-on), so they determine the order of service startup.
> **Note:** If you define both links and [networks](#networks), services with > **Note:** If you define both links and [networks](compose-file.md#networks), services with
> links between them must share at least one network in common in order to > links between them must share at least one network in common in order to
> communicate. > communicate.
### logging ### logging
> [Version 2 file format](#version-2) only. In version 1, use > [Version 2 file format](compose-file.md#version-2) only. In version 1, use
> [log_driver](#log_driver) and [log_opt](#log_opt). > [log_driver](compose-file.md#log_driver) and [log_opt](compose-file.md#log_opt).
Logging configuration for the service. Logging configuration for the service.
@ -482,8 +482,8 @@ Logging options are key-value pairs. An example of `syslog` options:
### log_driver ### log_driver
> [Version 1 file format](#version-1) only. In version 2, use > [Version 1 file format](compose-file.md#version-1) only. In version 2, use
> [logging](#logging). > [logging](compose-file.md#logging).
Specify a log driver. The default is `json-file`. Specify a log driver. The default is `json-file`.
@ -491,8 +491,8 @@ Specify a log driver. The default is `json-file`.
### log_opt ### log_opt
> [Version 1 file format](#version-1) only. In version 2, use > [Version 1 file format](compose-file.md#version-1) only. In version 2, use
> [logging](#logging). > [logging](compose-file.md#logging).
Specify logging options as key-value pairs. An example of `syslog` options: Specify logging options as key-value pairs. An example of `syslog` options:
@ -501,8 +501,8 @@ Specify logging options as key-value pairs. An example of `syslog` options:
### net ### net
> [Version 1 file format](#version-1) only. In version 2, use > [Version 1 file format](compose-file.md#version-1) only. In version 2, use
> [network_mode](#network_mode). > [network_mode](compose-file.md#network_mode).
Network mode. Use the same values as the docker client `--net` parameter. Network mode. Use the same values as the docker client `--net` parameter.
The `container:...` form can take a service name instead of a container name or The `container:...` form can take a service name instead of a container name or
@ -515,7 +515,7 @@ id.
### network_mode ### network_mode
> [Version 2 file format](#version-2) only. In version 1, use [net](#net). > [Version 2 file format](compose-file.md#version-2) only. In version 1, use [net](compose-file.md#net).
Network mode. Use the same values as the docker client `--net` parameter, plus Network mode. Use the same values as the docker client `--net` parameter, plus
the special form `service:[service name]`. the special form `service:[service name]`.
@ -528,10 +528,10 @@ the special form `service:[service name]`.
### networks ### networks
> [Version 2 file format](#version-2) only. In version 1, use [net](#net). > [Version 2 file format](compose-file.md#version-2) only. In version 1, use [net](compose-file.md#net).
Networks to join, referencing entries under the Networks to join, referencing entries under the
[top-level `networks` key](#network-configuration-reference). [top-level `networks` key](compose-file.md#network-configuration-reference).
services: services:
some-service: some-service:
@ -593,7 +593,7 @@ In the example below, three services are provided (`web`, `worker`, and `db`), a
Specify a static IP address for containers for this service when joining the network. Specify a static IP address for containers for this service when joining the network.
The corresponding network configuration in the [top-level networks section](#network-configuration-reference) must have an `ipam` block with subnet and gateway configurations covering each static address. If IPv6 addressing is desired, the `com.docker.network.enable_ipv6` driver option must be set to `true`. The corresponding network configuration in the [top-level networks section](compose-file.md#network-configuration-reference) must have an `ipam` block with subnet and gateway configurations covering each static address. If IPv6 addressing is desired, the `com.docker.network.enable_ipv6` driver option must be set to `true`.
An example: An example:
@ -681,9 +681,9 @@ limit as an integer or soft/hard limits as a mapping.
Mount paths or named volumes, optionally specifying a path on the host machine Mount paths or named volumes, optionally specifying a path on the host machine
(`HOST:CONTAINER`), or an access mode (`HOST:CONTAINER:ro`). (`HOST:CONTAINER`), or an access mode (`HOST:CONTAINER:ro`).
For [version 2 files](#version-2), named volumes need to be specified with the For [version 2 files](compose-file.md#version-2), named volumes need to be specified with the
[top-level `volumes` key](#volume-configuration-reference). [top-level `volumes` key](compose-file.md#volume-configuration-reference).
When using [version 1](#version-1), the Docker Engine will create the named When using [version 1](compose-file.md#version-1), the Docker Engine will create the named
volume automatically if it doesn't exist. volume automatically if it doesn't exist.
You can mount a relative path on the host, which will expand relative to You can mount a relative path on the host, which will expand relative to
@ -710,10 +710,10 @@ If you do not use a host path, you may specify a `volume_driver`.
volume_driver: mydriver volume_driver: mydriver
Note that for [version 2 files](#version-2), this driver Note that for [version 2 files](compose-file.md#version-2), this driver
will not apply to named volumes (you should use the `driver` option when will not apply to named volumes (you should use the `driver` option when
[declaring the volume](#volume-configuration-reference) instead). [declaring the volume](compose-file.md#volume-configuration-reference) instead).
For [version 1](#version-1), both named volumes and container volumes will For [version 1](compose-file.md#version-1), both named volumes and container volumes will
use the specified driver. use the specified driver.
> Note: No path expansion will be done if you have also specified a > Note: No path expansion will be done if you have also specified a
@ -736,7 +736,7 @@ then read-write will be used.
- container:container_name:rw - container:container_name:rw
> **Note:** The `container:...` formats are only supported in the > **Note:** The `container:...` formats are only supported in the
> [version 2 file format](#version-2). In [version 1](#version-1), you can use > [version 2 file format](compose-file.md#version-2). In [version 1](compose-file.md#version-1), you can use
> container names without marking them as such: > container names without marking them as such:
> >
> - service_name > - service_name
@ -937,7 +937,7 @@ There are two versions of the Compose file format:
- Version 2, the recommended format. This is specified with a `version: '2'` entry - Version 2, the recommended format. This is specified with a `version: '2'` entry
at the root of the YAML. at the root of the YAML.
To move your project from version 1 to 2, see the [Upgrading](#upgrading) To move your project from version 1 to 2, see the [Upgrading](compose-file.md#upgrading)
section. section.
> **Note:** If you're using > **Note:** If you're using
@ -957,15 +957,15 @@ These differences are explained below.
### Version 1 ### Version 1
Compose files that do not declare a version are considered "version 1". In Compose files that do not declare a version are considered "version 1". In
those files, all the [services](#service-configuration-reference) are declared those files, all the [services](compose-file.md#service-configuration-reference) are declared
at the root of the document. at the root of the document.
Version 1 is supported by **Compose up to 1.6.x**. It will be deprecated in a Version 1 is supported by **Compose up to 1.6.x**. It will be deprecated in a
future Compose release. future Compose release.
Version 1 files cannot declare named Version 1 files cannot declare named
[volumes](#volume-configuration-reference), [networks](networking.md) or [volumes](compose-file.md#volume-configuration-reference), [networks](networking.md) or
[build arguments](#args). [build arguments](compose-file.md#args).
Example: Example:
@ -984,14 +984,14 @@ Example:
### Version 2 ### Version 2
Compose files using the version 2 syntax must indicate the version number at Compose files using the version 2 syntax must indicate the version number at
the root of the document. All [services](#service-configuration-reference) the root of the document. All [services](compose-file.md#service-configuration-reference)
must be declared under the `services` key. must be declared under the `services` key.
Version 2 files are supported by **Compose 1.6.0+** and require a Docker Engine Version 2 files are supported by **Compose 1.6.0+** and require a Docker Engine
of version **1.10.0+**. of version **1.10.0+**.
Named [volumes](#volume-configuration-reference) can be declared under the Named [volumes](compose-file.md#volume-configuration-reference) can be declared under the
`volumes` key, and [networks](#network-configuration-reference) can be declared `volumes` key, and [networks](compose-file.md#network-configuration-reference) can be declared
under the `networks` key. under the `networks` key.
Simple example: Simple example:
@ -1082,7 +1082,7 @@ It's more complicated if you're using particular configuration features:
your service's containers to an your service's containers to an
[external network](networking.md#using-a-pre-existing-network). [external network](networking.md#using-a-pre-existing-network).
- `net`: This is now replaced by [network_mode](#network_mode): - `net`: This is now replaced by [network_mode](compose-file.md#network_mode):
net: host -> network_mode: host net: host -> network_mode: host
net: bridge -> network_mode: bridge net: bridge -> network_mode: bridge

View File

@ -15,8 +15,8 @@ title: Extending Services in Compose
Compose supports two methods of sharing common configuration: Compose supports two methods of sharing common configuration:
1. Extending an entire Compose file by 1. Extending an entire Compose file by
[using multiple Compose files](#multiple-compose-files) [using multiple Compose files](extends.md#multiple-compose-files)
2. Extending individual services with [the `extends` field](#extending-services) 2. Extending individual services with [the `extends` field](extends.md#extending-services)
## Multiple Compose files ## Multiple Compose files
@ -34,7 +34,7 @@ services.
If a service is defined in both files Compose merges the configurations using If a service is defined in both files Compose merges the configurations using
the rules described in [Adding and overriding the rules described in [Adding and overriding
configuration](#adding-and-overriding-configuration). configuration](extends.md#adding-and-overriding-configuration).
To use multiple override files, or an override file with a different name, you To use multiple override files, or an override file with a different name, you
can use the `-f` option to specify the list of files. Compose merges files in can use the `-f` option to specify the list of files. Compose merges files in

View File

@ -41,7 +41,7 @@ which the release page specifies, in your terminal.
curl -L https://github.com/docker/compose/releases/download/1.8.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose curl -L https://github.com/docker/compose/releases/download/1.8.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
If you have problems installing with `curl`, see If you have problems installing with `curl`, see
[Alternative Install Options](#alternative-install-options). [Alternative Install Options](install.md#alternative-install-options).
5. Apply executable permissions to the binary: 5. Apply executable permissions to the binary:

View File

@ -15,11 +15,11 @@ Compose is a tool for defining and running multi-container Docker applications.
With Compose, you use a Compose file to configure your application's services. With Compose, you use a Compose file to configure your application's services.
Then, using a single command, you create and start all the services Then, using a single command, you create and start all the services
from your configuration. To learn more about all the features of Compose from your configuration. To learn more about all the features of Compose
see [the list of features](#features). see [the list of features](overview.md#features).
Compose is great for development, testing, and staging environments, as well as Compose is great for development, testing, and staging environments, as well as
CI workflows. You can learn more about each case in CI workflows. You can learn more about each case in
[Common Use Cases](#common-use-cases). [Common Use Cases](overview.md#common-use-cases).
Using Compose is basically a three-step process. Using Compose is basically a three-step process.
@ -75,10 +75,10 @@ Compose has commands for managing the whole lifecycle of your application:
The features of Compose that make it effective are: The features of Compose that make it effective are:
* [Multiple isolated environments on a single host](#Multiple-isolated-environments-on-a-single-host) * [Multiple isolated environments on a single host](overview.md#Multiple-isolated-environments-on-a-single-host)
* [Preserve volume data when containers are created](#preserve-volume-data-when-containers-are-created) * [Preserve volume data when containers are created](overview.md#preserve-volume-data-when-containers-are-created)
* [Only recreate containers that have changed](#only-recreate-containers-that-have-changed) * [Only recreate containers that have changed](overview.md#only-recreate-containers-that-have-changed)
* [Variables and moving a composition between environments](#variables-and-moving-a-composition-between-environments) * [Variables and moving a composition between environments](overview.md#variables-and-moving-a-composition-between-environments)
### Multiple isolated environments on a single host ### Multiple isolated environments on a single host

View File

@ -23,7 +23,7 @@ format](compose-file.md#versioning) you are using:
2. If you're using version 2, your app should work with no changes: 2. If you're using version 2, your app should work with no changes:
- subject to the [limitations](#limitations) described below, - subject to the [limitations](swarm.md#limitations) described below,
- as long as the Swarm cluster is configured to use the [overlay driver](https://docs.docker.com/engine/userguide/networking/dockernetworks/#an-overlay-network), - as long as the Swarm cluster is configured to use the [overlay driver](https://docs.docker.com/engine/userguide/networking/dockernetworks/#an-overlay-network),
or a custom driver which supports multi-host networking. or a custom driver which supports multi-host networking.
@ -60,7 +60,7 @@ and reference it from `docker-compose.yml`:
### Multiple dependencies ### Multiple dependencies
If a service has multiple dependencies of the type which force co-scheduling If a service has multiple dependencies of the type which force co-scheduling
(see [Automatic scheduling](#automatic-scheduling) below), it's possible that (see [Automatic scheduling](swarm.md#automatic-scheduling) below), it's possible that
Swarm will schedule the dependencies on different nodes, making the dependent Swarm will schedule the dependencies on different nodes, making the dependent
service impossible to schedule. For example, here `foo` needs to be co-scheduled service impossible to schedule. For example, here `foo` needs to be co-scheduled
with `bar` and `baz`: with `bar` and `baz`:
@ -80,7 +80,7 @@ The problem is that Swarm might first schedule `bar` and `baz` on different
nodes (since they're not dependent on one another), making it impossible to nodes (since they're not dependent on one another), making it impossible to
pick an appropriate node for `foo`. pick an appropriate node for `foo`.
To work around this, use [manual scheduling](#manual-scheduling) to ensure that To work around this, use [manual scheduling](swarm.md#manual-scheduling) to ensure that
all three services end up on the same node: all three services end up on the same node:
version: "2" version: "2"

View File

@ -22,9 +22,9 @@ supported version of Docker Engine.
CS Docker Engine can be installed on the following operating systems: CS Docker Engine can be installed on the following operating systems:
* [CentOS 7.1/7.2 & RHEL 7.0/7.1/7.2 (YUM-based systems)](#install-on-centos-7-1-7-2-rhel-7-0-7-1-7-2-yum-based-systems) * [CentOS 7.1/7.2 & RHEL 7.0/7.1/7.2 (YUM-based systems)](install.md#install-on-centos-7-1-7-2-rhel-7-0-7-1-7-2-yum-based-systems)
* [Ubuntu 14.04 LTS](#install-on-ubuntu-14-04-lts) * [Ubuntu 14.04 LTS](install.md#install-on-ubuntu-14-04-lts)
* [SUSE Linux Enterprise 12](#install-on-suse-linux-enterprise-12-3) * [SUSE Linux Enterprise 12](install.md#install-on-suse-linux-enterprise-12-3)
## Install on CentOS 7.1/7.2 & RHEL 7.0/7.1/7.2 (YUM-based systems) ## Install on CentOS 7.1/7.2 & RHEL 7.0/7.1/7.2 (YUM-based systems)

View File

@ -19,9 +19,9 @@ This article explains how to upgrade your CS Docker Engine.
The upgrade process depends on the version that is currently installed and the The upgrade process depends on the version that is currently installed and the
version that you want to upgrade to: version that you want to upgrade to:
* [Upgrade from the same minor version](#upgrade-from-the-same-minor-version) * [Upgrade from the same minor version](upgrade.md#upgrade-from-the-same-minor-version)
* [Upgrade from the same major version](#upgrade-from-the-same-major-version) * [Upgrade from the same major version](upgrade.md#upgrade-from-the-same-major-version)
* [Upgrade from a legacy version](#upgrade-from-a-legacy-version) * [Upgrade from a legacy version](upgrade.md#upgrade-from-a-legacy-version)
Before starting the upgrade, make sure you stop all containers running on the Before starting the upgrade, make sure you stop all containers running on the
host. This ensures your containers have time for cleaning up before exiting, host. This ensures your containers have time for cleaning up before exiting,

View File

@ -18,7 +18,7 @@ the tags on that service. Docker Cloud shows an error if no nodes match all of
the service's deployment tags. A node might have extra tags that are not the service's deployment tags. A node might have extra tags that are not
specified on the service, but these do not prevent the service from deploying. specified on the service, but these do not prevent the service from deploying.
You can specify multiple tags on services, on individual nodes, and on node clusters. All nodes that are members of a node cluster inherit the tags specified on the cluster. See [Automatic deployment tags](#automatic-deployment-tags) to learn more. You can specify multiple tags on services, on individual nodes, and on node clusters. All nodes that are members of a node cluster inherit the tags specified on the cluster. See [Automatic deployment tags](deploy-tags.md#automatic-deployment-tags) to learn more.
#### Deployment tags example #### Deployment tags example
@ -67,7 +67,7 @@ of its member nodes.
![](images/nodecluster-wizard-tags.png) ![](images/nodecluster-wizard-tags.png)
When the node cluster scales up, new nodes automatically inherit the When the node cluster scales up, new nodes automatically inherit the
node cluster's tags, including the [Automatic deployment tags](#automatic-deployment-tags) described above. node cluster's tags, including the [Automatic deployment tags](deploy-tags.md#automatic-deployment-tags) described above.
You can see a node cluster's tags on the left side of the cluster's detail page. You can see a node cluster's tags on the left side of the cluster's detail page.

View File

@ -52,9 +52,9 @@ Some services require coordination between different containers to ensure that
the service functions correctly. Many databases, such as MySQL for example, the service functions correctly. Many databases, such as MySQL for example,
require that the containers know about each other at startup time so that require that the containers know about each other at startup time so that
traffic can be routed to them appropriately. When this is the case, you should traffic can be routed to them appropriately. When this is the case, you should
use [sequential scaling](#sequential-deployment-and-scaling). use [sequential scaling](service-scaling.md#sequential-deployment-and-scaling).
To allow peer-aware container startup, you can enable sequential scaling mode. See [Sequential Scaling](#sequential-deployment-and-scaling) for more information. To allow peer-aware container startup, you can enable sequential scaling mode. See [Sequential Scaling](service-scaling.md#sequential-deployment-and-scaling) for more information.
## Setting the initial number of containers ## Setting the initial number of containers

View File

@ -67,7 +67,7 @@ repository service where the image's source code is stored.
6. Choose where to run your build processes. 6. Choose where to run your build processes.
You can either run the process on your own infrastructure and optionally You can either run the process on your own infrastructure and optionally
[set up specific nodes to build on](#set-up-builder-nodes), or use the [set up specific nodes to build on](automated-build.md#set-up-builder-nodes), or use the
hosted build service offered on Docker Cloud's infrastructure. If you use hosted build service offered on Docker Cloud's infrastructure. If you use
Docker's infrastructure, select a builder size to run the build process on. Docker's infrastructure, select a builder size to run the build process on.
This hosted build service is free while it is in Beta. This hosted build service is free while it is in Beta.
@ -88,14 +88,14 @@ repository service where the image's source code is stored.
You can enter a name, or use a regex to match which source branch or tag You can enter a name, or use a regex to match which source branch or tag
names to build. To learn more, see names to build. To learn more, see
[regexes](#regexes-and-automated-builds). [regexes](automated-build.md#regexes-and-automated-builds).
* Specify the **Dockerfile location** as a path relative to the root of the source code repository. (If the Dockerfile is at the repository root, leave this path set to `/`.) * Specify the **Dockerfile location** as a path relative to the root of the source code repository. (If the Dockerfile is at the repository root, leave this path set to `/`.)
* Enter the tag to apply to Docker images built from this source. * Enter the tag to apply to Docker images built from this source.
If you configured a regex to select the source, you can reference the If you configured a regex to select the source, you can reference the
capture groups and use its result as part of the tag. To learn more, see capture groups and use its result as part of the tag. To learn more, see
[regexes](#regexes-and-automated-builds). [regexes](automated-build.md#regexes-and-automated-builds).
9. For each branch or tag, enable or disable the **Autobuild** toggle. 9. For each branch or tag, enable or disable the **Autobuild** toggle.
@ -186,13 +186,13 @@ and you'll see an error in your build timeline.
To work around this, you can set up your automated build using the `SSH_PRIVATE` environment variable to override the deployment key and grant Docker Cloud's build system access to the repositories. To work around this, you can set up your automated build using the `SSH_PRIVATE` environment variable to override the deployment key and grant Docker Cloud's build system access to the repositories.
> **Note**: If you are using autobuild for teams, use [the process below](#service-users-for-team-autobuilds) instead, and configure a service user for your source code provider. You can also do this for an individual account to limit Docker Cloud's access to your source repositories. > **Note**: If you are using autobuild for teams, use [the process below](automated-build.md#service-users-for-team-autobuilds) instead, and configure a service user for your source code provider. You can also do this for an individual account to limit Docker Cloud's access to your source repositories.
1. Generate a SSH keypair that you will use for builds only, and add the public key to your source code provider account. 1. Generate a SSH keypair that you will use for builds only, and add the public key to your source code provider account.
This step is optional, but allows you to revoke the build-only keypair without removing other access. <!-- (TODO: Link to instructions for GH & BB ) --> This step is optional, but allows you to revoke the build-only keypair without removing other access. <!-- (TODO: Link to instructions for GH & BB ) -->
2. Copy the private half of the keypair to your clipboard. 2. Copy the private half of the keypair to your clipboard.
3. In Docker Cloud, navigate to the build page for the repository that has linked private submodules. (If necessary, follow the steps [here](#configure-automated-build-settings) to configure the automated build.) 3. In Docker Cloud, navigate to the build page for the repository that has linked private submodules. (If necessary, follow the steps [here](automated-build.md#configure-automated-build-settings) to configure the automated build.)
4. At the bottom of the screen, click the plus sign ( **+** ) next to **Environment Variables**. 4. At the bottom of the screen, click the plus sign ( **+** ) next to **Environment Variables**.
5. Enter `SSH_PRIVATE` as the name for the new environment variable. 5. Enter `SSH_PRIVATE` as the name for the new environment variable.
6. Paste the private half of the keypair into the **Value** field. 6. Paste the private half of the keypair into the **Value** field.
@ -254,7 +254,7 @@ variable to automated builds associated with the account.
> **Note**: You may need to log out of your individual account on the source code provider to create the link to the service account. > **Note**: You may need to log out of your individual account on the source code provider to create the link to the service account.
6. Optionally, use the SSH keys you generated to set up any builds with private submodules, using the service account and [the instructions above](#build-repositories-with-linked-private-submodules). 6. Optionally, use the SSH keys you generated to set up any builds with private submodules, using the service account and [the instructions above](automated-build.md#build-repositories-with-linked-private-submodules).
## What's Next? ## What's Next?

View File

@ -40,7 +40,7 @@ need to link your source code provider.
options to grant Docker Cloud access to them from this screen. You can also options to grant Docker Cloud access to them from this screen. You can also
individually edit an organization's Third-party access settings to grant or individually edit an organization's Third-party access settings to grant or
revoke Docker Cloud's access. See [Grant access to a GitHub revoke Docker Cloud's access. See [Grant access to a GitHub
organization](#grant-access-to-a-github-organization) to learn more. organization](link-source.md#grant-access-to-a-github-organization) to learn more.
5. Click **Authorize application** to save the link. 5. Click **Authorize application** to save the link.

View File

@ -17,9 +17,9 @@ title: Deploy the app as a Docker Cloud service
In this step you will deploy the app as a Docker Cloud Service. Remember that a service is a group of containers of the same **image:tag**. In this step you will deploy the app as a Docker Cloud Service. Remember that a service is a group of containers of the same **image:tag**.
What you'll do in this step is slightly different if you have Docker Engine installed locally or not. What you'll do in this step is slightly different if you have Docker Engine installed locally or not.
If you have Docker Engine installed locally, start at [Deploy app with Docker Engine installed locally](#deploy-app-with-docker-engine-installed-locally). If you have Docker Engine installed locally, start at [Deploy app with Docker Engine installed locally](5_deploy_the_app_as_a_service.md#deploy-app-with-docker-engine-installed-locally).
If you do not have Docker Engine installed locally, start at [Deploy app without Docker Engine installed locally](#deploy-app-without-docker-engine-installed-locally). If you do not have Docker Engine installed locally, start at [Deploy app without Docker Engine installed locally](5_deploy_the_app_as_a_service.md#deploy-app-without-docker-engine-installed-locally).
> **Note**: If you don't have Docker Engine installed locally, skip to > **Note**: If you don't have Docker Engine installed locally, skip to
@ -36,7 +36,7 @@ or
```bash ```bash
$ docker-cloud service run -p 80 --name web $DOCKER_ID_USER/quickstart-go $ docker-cloud service run -p 80 --name web $DOCKER_ID_USER/quickstart-go
``` ```
Skip the next section and read about [The run command](#the-run-command). Skip the next section and read about [The run command](5_deploy_the_app_as_a_service.md#the-run-command).
## Deploy app without Docker Engine installed locally ## Deploy app without Docker Engine installed locally
@ -53,7 +53,7 @@ $ docker-cloud service run -p 80 --name web dockercloud/quickstart-python
```bash ```bash
$ docker-cloud service run -p 80 --name web dockercloud/quickstart-go $ docker-cloud service run -p 80 --name web dockercloud/quickstart-go
``` ```
Go to the next section to read about [The run command](#the-run-command). Go to the next section to read about [The run command](5_deploy_the_app_as_a_service.md#the-run-command).
## The run command ## The run command

View File

@ -16,7 +16,7 @@ title: Use the Docker Cloud Agent
Docker Cloud allows you to use any Linux host ("bring your own host") as a node which you can then use to deploy containers. To do this, you install the **Docker Cloud Agent** on your Linux host so that Docker Cloud can remotely manage it. Docker Cloud allows you to use any Linux host ("bring your own host") as a node which you can then use to deploy containers. To do this, you install the **Docker Cloud Agent** on your Linux host so that Docker Cloud can remotely manage it.
The **Docker Cloud Agent** installs its own Docker binary, and automatically removes any prior installation of the Docker Engine packages. See the [Known Limitations](#known-limitations) section for more information. The **Docker Cloud Agent** installs its own Docker binary, and automatically removes any prior installation of the Docker Engine packages. See the [Known Limitations](byoh.md#known-limitations) section for more information.
You can still run `docker` CLI commands on a host that is running the Docker Cloud Agent. If you do this, you might see the Docker Cloud system containers that start with `dockercloud/`. You can still run `docker` CLI commands on a host that is running the Docker Cloud Agent. If you do this, you might see the Docker Cloud system containers that start with `dockercloud/`.

View File

@ -15,7 +15,7 @@ title: Link to Amazon Web Services hosts
You can create a role with AWS IAM (Identity and Access Management) so that Docker Cloud can provision and manage **node clusters** and **nodes** on your behalf. You can create a role with AWS IAM (Identity and Access Management) so that Docker Cloud can provision and manage **node clusters** and **nodes** on your behalf.
Previously, we recommended that you create a service user that Docker Cloud would use to access your AWS account. If you previously used this method, you can [create a new role](#acreate-a-dockercloud-role-role), attach the policy you created previously, unlink your AWS credentials and relink them using the new ARN method. You can then delete the `dockercloud-user`. Previously, we recommended that you create a service user that Docker Cloud would use to access your AWS account. If you previously used this method, you can [create a new role](link-aws.md#acreate-a-dockercloud-role-role), attach the policy you created previously, unlink your AWS credentials and relink them using the new ARN method. You can then delete the `dockercloud-user`.
## Create a dockercloud-policy ## Create a dockercloud-policy
@ -40,7 +40,7 @@ Create an access control policy that will grant specific privileges to Docker Cl
] ]
} }
``` ```
To limit the user to a specific region, use the [policy below](#limit-dockercloud-user-to-a-specific-ec2-region) instead. To limit the user to a specific region, use the [policy below](link-aws.md#limit-dockercloud-user-to-a-specific-ec2-region) instead.
`ec2:*` allows the user to perform any operation in EC2. `ec2:*` allows the user to perform any operation in EC2.

View File

@ -18,7 +18,7 @@ to deploy **nodes** using Docker Cloud's
Dashboard, API, or CLI. Docker Cloud uses your SoftLayer username and API key to interact with SoftLayer on your behalf to create and manage your **nodes** (virtual servers). Dashboard, API, or CLI. Docker Cloud uses your SoftLayer username and API key to interact with SoftLayer on your behalf to create and manage your **nodes** (virtual servers).
Although any SoftLayer account with the right privileges will work, we Although any SoftLayer account with the right privileges will work, we
recommend creating a new **dockercloud-user** user. If you have already created a service user, or do not wish to do so, continue to [Add SoftLayer Account Credentials](#add-softlayer-account-credentials) recommend creating a new **dockercloud-user** user. If you have already created a service user, or do not wish to do so, continue to [Add SoftLayer Account Credentials](link-softlayer.md#add-softlayer-account-credentials)
### Create dockercloud-user in SoftLayer ### Create dockercloud-user in SoftLayer

View File

@ -18,7 +18,7 @@ You can use add a public SSH key to the *authorized_keys* file in each of your n
## Create pair of keys ## Create pair of keys
First, generate a keypair using `ssh-keygen -t rsa`. If you have an existing keypair you prefer to use, you can skip this step, copy the public key to your clipboard and continue on to [create the authorizedkeys stack](#create-a-stack-in-docker-cloud). First, generate a keypair using `ssh-keygen -t rsa`. If you have an existing keypair you prefer to use, you can skip this step, copy the public key to your clipboard and continue on to [create the authorizedkeys stack](ssh-into-a-node.md#create-a-stack-in-docker-cloud).
``` ```
$ ssh-keygen -t rsa $ ssh-keygen -t rsa

View File

@ -73,10 +73,10 @@ The UI refreshes. Log in from the Docker ID you specified as the first Owner, an
Once you've created an organization: Once you've created an organization:
* Add users to [the Owners team](#configure-the-owners-team) to help you manage the organization * Add users to [the Owners team](orgs.md#configure-the-owners-team) to help you manage the organization
* [Create teams](#create-teams) * [Create teams](orgs.md#create-teams)
* [Set team permissions](#set-team-permissions) * [Set team permissions](orgs.md#set-team-permissions)
* Set up [linked providers](#link-a-service-provider-to-an-organization), and [manage resources](#manage-resources-for-an-organization) for the organization * Set up [linked providers](orgs.md#link-a-service-provider-to-an-organization), and [manage resources](orgs.md#manage-resources-for-an-organization) for the organization
## Configure the Owners team ## Configure the Owners team

View File

@ -16,7 +16,6 @@ title: Docker for Mac vs. Docker Toolbox
If you already have an installation of Docker Toolbox, please read these topics first to learn how Docker for Mac and Docker Toolbox differ, and how they can coexist. If you already have an installation of Docker Toolbox, please read these topics first to learn how Docker for Mac and Docker Toolbox differ, and how they can coexist.
<a name="toolbox-env"></a>
## The Docker Toolbox environment ## The Docker Toolbox environment
Docker Toolbox installs `docker`, `docker-compose` and `docker-machine` in `/usr/local/bin` on your Mac. It also installs VirtualBox. At installation time, Toolbox uses `docker-machine` to provision a VirtualBox VM called `default`, running the `boot2docker` Linux distribution, with [Docker Engine](https://docs.docker.com/engine/) with certificates located on your Mac at `$HOME/.docker/machine/machines/default`. Docker Toolbox installs `docker`, `docker-compose` and `docker-machine` in `/usr/local/bin` on your Mac. It also installs VirtualBox. At installation time, Toolbox uses `docker-machine` to provision a VirtualBox VM called `default`, running the `boot2docker` Linux distribution, with [Docker Engine](https://docs.docker.com/engine/) with certificates located on your Mac at `$HOME/.docker/machine/machines/default`.
@ -27,7 +26,7 @@ This setup is shown in the following diagram.
![Docker Toolbox Install](images/toolbox-install.png) ![Docker Toolbox Install](images/toolbox-install.png)
<a name="docker-mac-env"></a>
## The Docker for Mac environment ## The Docker for Mac environment
Docker for Mac is a Mac native application, that you install in `/Applications`. At installation time, it creates symlinks in `/usr/local/bin` for `docker` and `docker-compose`, to the version of the commands inside the Mac application bundle, in `/Applications/Docker.app/Contents/Resources/bin`. Docker for Mac is a Mac native application, that you install in `/Applications`. At installation time, it creates symlinks in `/usr/local/bin` for `docker` and `docker-compose`, to the version of the commands inside the Mac application bundle, in `/Applications/Docker.app/Contents/Resources/bin`.
@ -48,9 +47,9 @@ This setup is shown in the following diagram.
With Docker for Mac, you get only one VM, and you don't manage it. It is managed by the Docker for Mac application, which includes autoupdate to update the client and server versions of Docker. With Docker for Mac, you get only one VM, and you don't manage it. It is managed by the Docker for Mac application, which includes autoupdate to update the client and server versions of Docker.
If you need several VMs and want to manage the version of the Docker client or server you are using, you can continue to use `docker-machine`, on the same machine, as described in [Docker Toolbox and Docker for Mac coexistence](#docker-toolbox-and-docker-for-mac-coexistence). If you need several VMs and want to manage the version of the Docker client or server you are using, you can continue to use `docker-machine`, on the same machine, as described in [Docker Toolbox and Docker for Mac coexistence](docker-toolbox.md#docker-toolbox-and-docker-for-mac-coexistence).
<a name="docker-mac-setup"></a>
## Setting up to run Docker for Mac ## Setting up to run Docker for Mac
1. Check whether Toolbox DOCKER environment variables are set: 1. Check whether Toolbox DOCKER environment variables are set:
@ -82,7 +81,7 @@ If you need several VMs and want to manage the version of the Docker client or s
> **Warning**: If you install Docker for Mac on a machine where Docker Toolbox is installed, it will replace the `docker` and `docker-compose` command lines in `/usr/local/bin` with symlinks to its own versions. > **Warning**: If you install Docker for Mac on a machine where Docker Toolbox is installed, it will replace the `docker` and `docker-compose` command lines in `/usr/local/bin` with symlinks to its own versions.
<a name="coexist"></a>
## Docker Toolbox and Docker for Mac coexistence ## Docker Toolbox and Docker for Mac coexistence
You can use Docker for Mac and Docker Toolbox together on the same machine. When you want to use Docker for Mac, make sure all DOCKER environment variables are unset. You can do this in bash with `unset ${!DOCKER_*}`. When you want to use one of the VirtualBox VMs you have set with `docker-machine`, just run a `eval $(docker-machine env default)` (or the name of the machine you want to target). This will switch the current command shell to talk to the specified Toolbox machine. You can use Docker for Mac and Docker Toolbox together on the same machine. When you want to use Docker for Mac, make sure all DOCKER environment variables are unset. You can do this in bash with `unset ${!DOCKER_*}`. When you want to use one of the VirtualBox VMs you have set with `docker-machine`, just run a `eval $(docker-machine env default)` (or the name of the machine you want to target). This will switch the current command shell to talk to the specified Toolbox machine.
@ -91,12 +90,12 @@ This setup is represented in the following diagram.
![Docker Toolbox and Docker for Mac coexistence](images/docker-for-mac-and-toolbox.png) ![Docker Toolbox and Docker for Mac coexistence](images/docker-for-mac-and-toolbox.png)
<a name="dvm"></a>
## Using different versions of Docker tools ## Using different versions of Docker tools
The coexistence setup works as is as long as your VirtualBox VMs provisioned with `docker-machine` run the same version of Docker Engine as Docker for Mac. If you need to use VMs running older versions of Docker Engine, you can use a tool like <a href="https://github.com/getcarina/dvm" target="_blank">Docker Version Manager</a> to manage several versions of docker client. The coexistence setup works as is as long as your VirtualBox VMs provisioned with `docker-machine` run the same version of Docker Engine as Docker for Mac. If you need to use VMs running older versions of Docker Engine, you can use a tool like <a href="https://github.com/getcarina/dvm" target="_blank">Docker Version Manager</a> to manage several versions of docker client.
<a name="check-versions"></a>
### Checking component versions ### Checking component versions
Ideally, the Docker CLI client and Docker Engine should be the same version. Mismatches between client and server, and among host machines you might have created with Docker Machine can cause problems (client can't talk to the server or host machines). Ideally, the Docker CLI client and Docker Engine should be the same version. Mismatches between client and server, and among host machines you might have created with Docker Machine can cause problems (client can't talk to the server or host machines).
@ -131,14 +130,3 @@ and want to uninstall it. For details on how to perform a clean uninstall of
Toolbox on the Mac, see [How to uninstall Toolbox on the Mac, see [How to uninstall
Toolbox](/toolbox/toolbox_install_mac.md#how-to-uninstall-toolbox) in the Toolbox](/toolbox/toolbox_install_mac.md#how-to-uninstall-toolbox) in the
Toolbox Mac topics. Toolbox Mac topics.
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -26,13 +26,3 @@ For now, if you want get started experimenting with the Beta apps and Docker Com
See also [learn by example](/engine/tutorials/index.md) tutorials on building images, runnning containers, networking, managing data, and storing images on Docker Hub. See also [learn by example](/engine/tutorials/index.md) tutorials on building images, runnning containers, networking, managing data, and storing images on Docker Hub.
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -109,7 +109,7 @@ For a full explanation and examples, see [I want to connect to a container from
Note that you need a Mac that supports hardware virtualization, which is most non ancient ones; i.e., use OS X `10.10.3+` or `10.11` (OS X Yosemite or OS X El Capitan). See also "What to know before you install" in [Getting Started](index.md). Note that you need a Mac that supports hardware virtualization, which is most non ancient ones; i.e., use OS X `10.10.3+` or `10.11` (OS X Yosemite or OS X El Capitan). See also "What to know before you install" in [Getting Started](index.md).
<a name="faq-toolbox"></a>
### Do I need to uninstall Docker Toolbox to use Docker for Mac? ### Do I need to uninstall Docker Toolbox to use Docker for Mac?
No, you can use these side by side. Docker Toolbox leverages a Docker daemon installed using `docker-machine` in a machine called `default`. Running `eval $(docker-machine env default)` in a shell sets DOCKER environment variables locally to connect to the default machine using Engine from Toolbox. To check whether Toolbox DOCKER environment variables are set, run `env | grep DOCKER`. No, you can use these side by side. Docker Toolbox leverages a Docker daemon installed using `docker-machine` in a machine called `default`. Running `eval $(docker-machine env default)` in a shell sets DOCKER environment variables locally to connect to the default machine using Engine from Toolbox. To check whether Toolbox DOCKER environment variables are set, run `env | grep DOCKER`.
@ -142,14 +142,3 @@ consume any resources unless Docker.app connects to it, so it's safe to ignore.
### Can I pass through a USB device to a container? ### Can I pass through a USB device to a container?
Unfortunately it is not possible to pass through a USB device (or a serial port) to a container. For use cases requiring this, we recommend the use of [Docker Toolbox](/toolbox/overview.md). Unfortunately it is not possible to pass through a USB device (or a serial port) to a container. For use cases requiring this, we recommend the use of [Docker Toolbox](/toolbox/overview.md).
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -24,7 +24,6 @@ Please read through these topics on how to get started. To **give us feedback**
>**Already have Docker for Mac?** If you already have Docker for Mac installed, and are ready to get started, skip over to the [Getting Started with Docker](/engine/getstarted/index.md) tutorial. >**Already have Docker for Mac?** If you already have Docker for Mac installed, and are ready to get started, skip over to the [Getting Started with Docker](/engine/getstarted/index.md) tutorial.
<a name="download"></a>
## Download Docker for Mac ## Download Docker for Mac
If you have not already done so, please install Docker for Mac. You can download installers from the stable or beta channel. If you have not already done so, please install Docker for Mac. You can download installers from the stable or beta channel.
@ -44,24 +43,24 @@ For more about stable and beta channels, see the [FAQs](faqs.md#stable-and-beta-
<tr valign="top"> <tr valign="top">
<td width="50%"> <td width="50%">
<a class="button darkblue-btn" href="https://download.docker.com/mac/stable/Docker.dmg">Get Docker for Mac (stable)</a><br><br> <a class="button darkblue-btn" href="https://download.docker.com/mac/stable/Docker.dmg">Get Docker for Mac (stable)</a><br><br>
<a href="https://download.docker.com/mac/stable/Docker.dmg.sha256sum"><font color="#BDBDBD" size="-1">Download checksum: <font color="#BDBDBD">Docker.dmg SHA256</font></a></font> <a href="https://download.docker.com/mac/stable/Docker.dmg.sha256sum"><font color="#BDBDBD" size="-1">Download checksum: Docker.dmg SHA256</font></a>
</td> </td>
<td width="50%"> <td width="50%">
<a class="button darkblue-btn" href="https://download.docker.com/mac/beta/Docker.dmg">Get Docker for Mac (beta)</a><br><br> <a class="button darkblue-btn" href="https://download.docker.com/mac/beta/Docker.dmg">Get Docker for Mac (beta)</a><br><br>
<a href="https://download.docker.com/mac/beta/Docker.dmg.sha256sum"><font color="#BDBDBD" size="-1">Download checksum: <font color="#BDBDBD">Docker.dmg SHA256</font></a></font> <a href="https://download.docker.com/mac/beta/Docker.dmg.sha256sum"><font color="#BDBDBD" size="-1">Download checksum: Docker.dmg SHA256</font></a>
</td> </td>
</tr> </tr>
</table> </table>
>**Important Notes**: >**Important Notes**:
> >
>* Docker for Mac requires OS X 10.10.3 Yosemite or newer running on a 2010 or newer Mac, with Intel's hardware support for MMU virtualization. Please see [What to know before you install](#what-to-know-before-you-install) for a full list of prerequisites. >* Docker for Mac requires OS X 10.10.3 Yosemite or newer running on a 2010 or newer Mac, with Intel's hardware support for MMU virtualization. Please see [What to know before you install](index.md#what-to-know-before-you-install) for a full list of prerequisites.
> >
>* <font color="#CC3366">You can switch between beta and stable versions, but _you must have only one app installed at a time_.</font> Also, you will need to save images and export containers you want to keep before uninstalling the current version before installing another. For more about this, see the [FAQs about beta and stable channels](faqs.md#stable-and-beta-channels). >* <font color="#CC3366">You can switch between beta and stable versions, but _you must have only one app installed at a time_.</font> Also, you will need to save images and export containers you want to keep before uninstalling the current version before installing another. For more about this, see the [FAQs about beta and stable channels](faqs.md#stable-and-beta-channels).
<a name="preqs"></a>
## What to know before you install ## What to know before you install
* **README FIRST for Docker Toolbox and Docker Machine users**: If you are already running Docker on your machine, first read [Docker for Mac vs. Docker Toolbox](docker-toolbox.md) to understand the impact of this installation on your existing setup, how to set your environment for Docker for Mac, and how the two products can coexist. * **README FIRST for Docker Toolbox and Docker Machine users**: If you are already running Docker on your machine, first read [Docker for Mac vs. Docker Toolbox](docker-toolbox.md) to understand the impact of this installation on your existing setup, how to set your environment for Docker for Mac, and how the two products can coexist.
* **Relationship to Docker Machine**: Installing Docker for Mac does not affect machines you created with Docker Machine. You'll get the option to copy containers and images from your local `default` machine (if one exists) to the new Docker for Mac <a href="https://github.com/docker/HyperKit/" target="_blank">HyperKit</a> VM. * **Relationship to Docker Machine**: Installing Docker for Mac does not affect machines you created with Docker Machine. You'll get the option to copy containers and images from your local `default` machine (if one exists) to the new Docker for Mac <a href="https://github.com/docker/HyperKit/" target="_blank">HyperKit</a> VM.
@ -80,7 +79,6 @@ For more about stable and beta channels, see the [FAQs](faqs.md#stable-and-beta-
* **What the install includes**: The installation provides [Docker Engine](https://docs.docker.com/engine/userguide/intro/), Docker CLI client, [Docker Compose](https://docs.docker.com/compose/overview/), and [Docker Machine](https://docs.docker.com/machine/overview/). * **What the install includes**: The installation provides [Docker Engine](https://docs.docker.com/engine/userguide/intro/), Docker CLI client, [Docker Compose](https://docs.docker.com/compose/overview/), and [Docker Machine](https://docs.docker.com/machine/overview/).
<a name="run"></a>
## Step 1. Install and Run Docker for Mac ## Step 1. Install and Run Docker for Mac
1. Double-click `Docker.dmg` to open the installer, then drag Moby the whale to the Applications folder. 1. Double-click `Docker.dmg` to open the installer, then drag Moby the whale to the Applications folder.
@ -109,7 +107,6 @@ For more about stable and beta channels, see the [FAQs](faqs.md#stable-and-beta-
Congratulations! You are up and running with Docker for Mac. Congratulations! You are up and running with Docker for Mac.
<a name="check-versions"></a>
## Step 2. Check versions of Docker Engine, Compose, and Machine ## Step 2. Check versions of Docker Engine, Compose, and Machine
Run these commands to test if your versions of `docker`, `docker-compose`, and `docker-machine` are up-to-date and compatible with `Docker.app`. Run these commands to test if your versions of `docker`, `docker-compose`, and `docker-machine` are up-to-date and compatible with `Docker.app`.
@ -127,7 +124,6 @@ Run these commands to test if your versions of `docker`, `docker-compose`, and `
>**Note**: The above is an example. Your output will differ if you are running different (e.g., newer) versions. >**Note**: The above is an example. Your output will differ if you are running different (e.g., newer) versions.
<a name="explore"></a>
## Step 3. Explore the application and run examples ## Step 3. Explore the application and run examples
1. Open a command-line terminal, and run some Docker commands to verify that Docker is working as expected. 1. Open a command-line terminal, and run some Docker commands to verify that Docker is working as expected.
@ -240,7 +236,6 @@ Docker uninstalled successfully. You can move the Docker application to the tras
You might want to use the command-line uninstall if, for example, you find that the app is non-functional, and you cannot uninstall it from the menu. You might want to use the command-line uninstall if, for example, you find that the app is non-functional, and you cannot uninstall it from the menu.
<a name="bash-completion"></a>
## Installing bash completion ## Installing bash completion
If you are using [bash completion](https://www.debian-administration.org/article/316/An_introduction_to_bash_completion_part_1), such as [homebrew bash-completion on Mac](http://davidalger.com/development/bash-completion-on-os-x-with-brew/), bash completion scripts for If you are using [bash completion](https://www.debian-administration.org/article/316/An_introduction_to_bash_completion_part_1), such as [homebrew bash-completion on Mac](http://davidalger.com/development/bash-completion-on-os-x-with-brew/), bash completion scripts for
@ -278,15 +273,3 @@ ln -s /Applications/Docker.app/Contents/Resources/etc/docker-compose.bash-comple
* Check out the <a href="https://blog.docker.com/2016/06/docker-mac-windows-public-beta/">blog posts</a> on Docker for Mac and Docker for Windows public betas, and <a href="https://blog.docker.com/2016/03/docker-for-mac-windows-beta/">earlier posts</a> on the intial private beta. * Check out the <a href="https://blog.docker.com/2016/06/docker-mac-windows-public-beta/">blog posts</a> on Docker for Mac and Docker for Windows public betas, and <a href="https://blog.docker.com/2016/03/docker-for-mac-windows-beta/">earlier posts</a> on the intial private beta.
* Please give feedback on your experience with the app and report bugs and problems by logging into our [Docker for Mac forum](https://forums.docker.com/c/docker-for-mac). * Please give feedback on your experience with the app and report bugs and problems by logging into our [Docker for Mac forum](https://forums.docker.com/c/docker-for-mac).
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -35,13 +35,3 @@ Running containers pre-configured with `qemu` has the advantage that you can use
Alternatively, you can bind mount in the `qemu` static binaries to any cross-architecture package, such as the semi-official ones using a script like this one https://github.com/justincormack/cross-docker. (See the README at the given link for details on how to use the script.) Alternatively, you can bind mount in the `qemu` static binaries to any cross-architecture package, such as the semi-official ones using a script like this one https://github.com/justincormack/cross-docker. (See the README at the given link for details on how to use the script.)
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -108,13 +108,3 @@ See the [run commmand](/engine/reference/commandline/run.md) for more details on
We understand that these workarounds are not ideal, but there are several problems. In particular, there is a bug in OSX that is only fixed in 10.12 and is not being backported as far as we can tell, which means that we could not support this in all supported OSX versions. In addition, this network setup would require root access which we are trying to avoid entirely in Docker for Mac (we currently have a very small root helper that we are trying to remove). We understand that these workarounds are not ideal, but there are several problems. In particular, there is a bug in OSX that is only fixed in 10.12 and is not being backported as far as we can tell, which means that we could not support this in all supported OSX versions. In addition, this network setup would require root access which we are trying to avoid entirely in Docker for Mac (we currently have a very small root helper that we are trying to remove).
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -22,13 +22,3 @@ Docker Desktop Editions distribute some components that are licensed under the G
The sources for `qemu-img` can be obtained [here](http://wiki.qemu-project.org/download/qemu-2.4.1.tar.bz2). The sources for `qemu-img` can be obtained [here](http://wiki.qemu-project.org/download/qemu-2.4.1.tar.bz2).
The sources for the `gettext` and `glib` libraries that `qemu-img` requires were obtained from [Homebrew](https://brew.sh) and may be retrieved using `brew install --build-from-source gettext glib`. The sources for the `gettext` and `glib` libraries that `qemu-img` requires were obtained from [Homebrew](https://brew.sh) and may be retrieved using `brew install --build-from-source gettext glib`.
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -20,16 +20,16 @@ user experience for bind mounting OS X file system trees into Docker
containers. To this end, `osxfs` features a number of unique containers. To this end, `osxfs` features a number of unique
capabilities as well as differences from a classical Linux file system. capabilities as well as differences from a classical Linux file system.
- [Case sensitivity](#case-sensitivity) - [Case sensitivity](osxfs.md#case-sensitivity)
- [Access control](#access-control) - [Access control](osxfs.md#access-control)
- [Namespaces](#namespaces) - [Namespaces](osxfs.md#namespaces)
- [Ownership](#ownership) - [Ownership](osxfs.md#ownership)
- [File system events](#file-system-events) - [File system events](osxfs.md#file-system-events)
- [Mounts](#mounts) - [Mounts](osxfs.md#mounts)
- [Symlinks](#symlinks) - [Symlinks](osxfs.md#symlinks)
- [File types](#file-types) - [File types](osxfs.md#file-types)
- [Extended attributes](#extended-attributes) - [Extended attributes](osxfs.md#extended-attributes)
- [Technology](#technology) - [Technology](osxfs.md#technology)
### Case sensitivity ### Case sensitivity
@ -44,7 +44,7 @@ case-sensitivity or reformat your OS root partition with HFS+ with
case-sensitivity. We do not recommend reformatting your root partition case-sensitivity. We do not recommend reformatting your root partition
as some Mac software dubiously relies on case-insensitivity to function. as some Mac software dubiously relies on case-insensitivity to function.
<a name="osxfs-access"></a>
### Access control ### Access control
`osxfs`, and therefore Docker, can access only those file system `osxfs`, and therefore Docker, can access only those file system
@ -114,13 +114,13 @@ The following are **unsupported file system events**:
* Open * Open
* Access * Access
* Close events * Close events
* Unmount events (see <a href="#osxfs-mounts">Mounts</a>) * Unmount events (see <a href="osxfs.md#mounts">Mounts</a>)
Some events may be delivered multiple times. Events are not delivered for bind mounts from symlinks (notably `/tmp` will not deliver inotify events but Some events may be delivered multiple times. Events are not delivered for bind mounts from symlinks (notably `/tmp` will not deliver inotify events but
`/private/tmp` will). These limitations do not apply to events between `/private/tmp` will). These limitations do not apply to events between
containers, only to those events originating in OS X. containers, only to those events originating in OS X.
<a name="osxfs-mounts"></a>
### Mounts ### Mounts
The OS X mount structure is not visible in the shared volume, but volume The OS X mount structure is not visible in the shared volume, but volume
@ -152,14 +152,3 @@ Extended attributes are not yet supported.
`osxfs` does not use OSXFUSE. `osxfs` does not run under, inside, or `osxfs` does not use OSXFUSE. `osxfs` does not run under, inside, or
between OS X userspace processes and the OS X kernel. between OS X userspace processes and the OS X kernel.
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -20,8 +20,8 @@ For system requirements, please see the Getting Started topic on [What to know b
Release notes for _stable_ and _beta_ releases are listed below. You can learn about both kinds of releases, and download stable and beta product installers at [Download Docker for Mac](index.md#download-docker-for-mac). Release notes for _stable_ and _beta_ releases are listed below. You can learn about both kinds of releases, and download stable and beta product installers at [Download Docker for Mac](index.md#download-docker-for-mac).
* [Stable Release Notes](#stable-release-notes) * [Stable Release Notes](release-notes.md#stable-release-notes)
* [Beta Release Notes](#beta-release-notes) * [Beta Release Notes](release-notes.md#beta-release-notes)
## Stable Release Notes ## Stable Release Notes
@ -1145,14 +1145,3 @@ lead to `Docker.app` not starting on reboot
<td class="tg-vn4c">Fixed permissions on `usr/local` symbolic links</td> <td class="tg-vn4c">Fixed permissions on `usr/local` symbolic links</td>
</tr> </tr>
</table> </table>
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -105,7 +105,7 @@ You may get the following error when you try to start a container created with p
Error response from daemon: Unknown runtime specified default Error response from daemon: Unknown runtime specified default
You can fix this by either [recreating](#recreate-your-containers) or [updating](#update-your-containers) your containers. You can fix this by either [recreating](troubleshoot.md#recreate-your-containers) or [updating](troubleshoot.md#update-your-containers) your containers.
If you get the error message shown above, we recommend recreating them. If you get the error message shown above, we recommend recreating them.
@ -242,7 +242,7 @@ environments, see [Docker for Mac vs. Docker Toolbox](docker-toolbox.md).
decide whether to shut the other process down, or to use a different port in decide whether to shut the other process down, or to use a different port in
your docker app. your docker app.
See also [Known Issues](#known-issues) on this page, and the [FAQs](faqs.md) topic. See also [Known Issues](troubleshoot.md#known-issues) on this page, and the [FAQs](faqs.md) topic.
<a name="issues"></a> <a name="issues"></a>
## Known issues ## Known issues
@ -251,7 +251,7 @@ See also [Known Issues](#known-issues) on this page, and the [FAQs](faqs.md) top
timeout when you run `docker` commands that need access to external network timeout when you run `docker` commands that need access to external network
servers. The aforementioned releases include a workaround for this because servers. The aforementioned releases include a workaround for this because
Docker for Mac does not yet support IPv6. See "IPv6 workaround to auto-filter DNS addresses" in Docker for Mac does not yet support IPv6. See "IPv6 workaround to auto-filter DNS addresses" in
[Workarounds for common problems](#workarounds-for-common-problems). [Workarounds for common problems](troubleshoot.md#workarounds-for-common-problems).
* You might encounter errors when using `docker-compose up` with Docker for Mac (`ValueError: Extra Data`). We've identified this is likely related to data and/or events being passed all at once rather than one by one, so sometimes the data comes back as 2+ objects concatenated and causes an error. * You might encounter errors when using `docker-compose up` with Docker for Mac (`ValueError: Extra Data`). We've identified this is likely related to data and/or events being passed all at once rather than one by one, so sometimes the data comes back as 2+ objects concatenated and causes an error.

View File

@ -26,13 +26,3 @@ For now, if you want get started experimenting with the Beta apps and Docker Com
See also [learn by example](/engine/tutorials/index.md) tutorials on building images, runnning containers, networking, managing data, and storing images on Docker Hub. See also [learn by example](/engine/tutorials/index.md) tutorials on building images, runnning containers, networking, managing data, and storing images on Docker Hub.
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -141,13 +141,3 @@ details on how to perform a clean uninstall of Toolbox on Windows, see [How to
uninstall Toolbox](/toolbox/toolbox_install_windows.md#how-to-uninstall-toolbox) uninstall Toolbox](/toolbox/toolbox_install_windows.md#how-to-uninstall-toolbox)
in the Toolbox Windows topics. in the Toolbox Windows topics.
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -42,18 +42,18 @@ If you have not already done so, please install Docker for Windows. You can down
<tr valign="top"> <tr valign="top">
<td width="50%"> <td width="50%">
<a class="button darkblue-btn" href="https://download.docker.com/win/stable/InstallDocker.msi">Get Docker for Windows (stable)</a><br><br> <a class="button darkblue-btn" href="https://download.docker.com/win/stable/InstallDocker.msi">Get Docker for Windows (stable)</a><br><br>
<a href="https://download.docker.com/win/stable/InstallDocker.msi.sha256sum"><font color="#BDBDBD" size="-1">Download checksum: <font color="#BDBDBD">InstallDocker.msi SHA256</font></a></font> <a href="https://download.docker.com/win/stable/InstallDocker.msi.sha256sum"><font color="#BDBDBD" size="-1">Download checksum: InstallDocker.msi SHA256</font></a>
</td> </td>
<td width="50%"> <td width="50%">
<a class="button darkblue-btn" href="https://download.docker.com/win/beta/InstallDocker.msi">Get Docker for Windows (beta)</a><br><br> <a class="button darkblue-btn" href="https://download.docker.com/win/beta/InstallDocker.msi">Get Docker for Windows (beta)</a><br><br>
<a href="https://download.docker.com/win/beta/InstallDocker.msi.sha256sum"><font color="#BDBDBD" size="-1">Download checksum: <font color="#BDBDBD">InstallDocker.msi SHA256</font></a></font> <a href="https://download.docker.com/win/beta/InstallDocker.msi.sha256sum"><font color="#BDBDBD" size="-1">Download checksum: InstallDocker.msi SHA256</font></a>
</td> </td>
</tr> </tr>
</table> </table>
>**Important Notes**: >**Important Notes**:
> >
>* Docker for Windows requires 64bit Windows 10 Pro, Enterprise and Education (1511 November update, Build 10586 or later) and Microsoft Hyper-V. Please see [What to know before you install](#what-to-know-before-you-install) for a full list of prerequisites. >* Docker for Windows requires 64bit Windows 10 Pro, Enterprise and Education (1511 November update, Build 10586 or later) and Microsoft Hyper-V. Please see [What to know before you install](index.md#what-to-know-before-you-install) for a full list of prerequisites.
> >
>* <font color="#CC3366">You can switch between beta and stable versions, but _you must have only one app installed at a time_.</font> Also, you will need to save images and export containers you want to keep before uninstalling the current version before installing another. For more about this, see the [FAQs about beta and stable channels](faqs.md#questions-about-stable-and-beta-channels). >* <font color="#CC3366">You can switch between beta and stable versions, but _you must have only one app installed at a time_.</font> Also, you will need to save images and export containers you want to keep before uninstalling the current version before installing another. For more about this, see the [FAQs about beta and stable channels](faqs.md#questions-about-stable-and-beta-channels).
@ -270,7 +270,7 @@ To get a popup menu with application options, right-click the whale:
The **Settings** dialogs provide options to allow Docker auto-start, automatically check for updates, share local drives with Docker containers, enable VPN compatibilty, manage CPUs and memory Docker uses, restart Docker, or perform a factory reset. The **Settings** dialogs provide options to allow Docker auto-start, automatically check for updates, share local drives with Docker containers, enable VPN compatibilty, manage CPUs and memory Docker uses, restart Docker, or perform a factory reset.
**Beta 26** includes an option to switch between Windows and Linux conatiners. See [Switch between Windows and Linux containers (Beta 26)](#switch-between-windows-and-linux-containers-beta-26). This is not yet available on stable builds. **Beta 26** includes an option to switch between Windows and Linux conatiners. See [Switch between Windows and Linux containers (Beta 26)](index.md#switch-between-windows-and-linux-containers-beta-26). This is not yet available on stable builds.
![Beta 26 popup with switch for Windows or Linux containers](images/config-popup-menu-win-switch-containers.png) ![Beta 26 popup with switch for Windows or Linux containers](images/config-popup-menu-win-switch-containers.png)
@ -415,14 +415,3 @@ If you want to go back to using Docker Toolbox, you have to disable the Hyper-V
* Check out the <a href="https://blog.docker.com/2016/06/docker-mac-windows-public-beta/">blog posts</a> on Docker for Mac and Docker for Windows public betas, and <a href="https://blog.docker.com/2016/03/docker-for-mac-windows-beta/">earlier posts</a> on the intial private beta. * Check out the <a href="https://blog.docker.com/2016/06/docker-mac-windows-public-beta/">blog posts</a> on Docker for Mac and Docker for Windows public betas, and <a href="https://blog.docker.com/2016/03/docker-for-mac-windows-beta/">earlier posts</a> on the intial private beta.
* Please give feedback on your experience with the app and report bugs and problems by logging into our [Docker for Windows forum](https://forums.docker.com/c/docker-for-windows). * Please give feedback on your experience with the app and report bugs and problems by logging into our [Docker for Windows forum](https://forums.docker.com/c/docker-for-windows).
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -16,13 +16,3 @@ Docker Desktop Editions are built using open source software software. For detai
Docker Desktop Editions distribute some components that are licensed under the GNU General Public License. You can download the source for these components [here](https://download.docker.com/opensource/License.tar.gz). Docker Desktop Editions distribute some components that are licensed under the GNU General Public License. You can download the source for these components [here](https://download.docker.com/opensource/License.tar.gz).
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -20,9 +20,9 @@ For system requirements, please see the Getting Started topic on [What to know b
Release notes for _stable_ and _beta_ releases are listed below. You can learn about both kinds of releases, and download stable and beta product installers at [Download Docker for Windows](index.md#download-docker-for-windows). Release notes for _stable_ and _beta_ releases are listed below. You can learn about both kinds of releases, and download stable and beta product installers at [Download Docker for Windows](index.md#download-docker-for-windows).
* [Stable Release Notes](#stable-release-notes) * [Stable Release Notes](release-notes.md#stable-release-notes)
* [Beta Release Notes](#beta-release-notes) * [Beta Release Notes](release-notes.md#beta-release-notes)
* [Alpha Release Notes](#alpha-release-notes) * [Alpha Release Notes](release-notes.md#alpha-release-notes)
## Stable Release Notes ## Stable Release Notes

View File

@ -106,7 +106,7 @@ You may get the following error when you try to start a container created with p
Error response from daemon: Unknown runtime specified default Error response from daemon: Unknown runtime specified default
You can fix this by either [recreating](#recreate-your-containers) or [updating](#update-your-containers) your containers. You can fix this by either [recreating](troubleshoot.md#recreate-your-containers) or [updating](troubleshoot.md#update-your-containers) your containers.
If you get the error message shown above, we recommend recreating them. If you get the error message shown above, we recommend recreating them.
@ -286,14 +286,3 @@ relates to Docker: [Docker fails to start on Windows
For a temporary workaround, uninstall the Comodo Firewall, or explore other For a temporary workaround, uninstall the Comodo Firewall, or explore other
workarounds suggested on the forum. workarounds suggested on the forum.
<hr style="color:#99CC99" />
<ul class="media">
<div class="media_content">
<div data-mh="mh_docker_projects">
<h6> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback"><img src="../../images/chat.png" alt="chat icon"></a> <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">Help improve the documentation</a></h3>
<p>
Email us at <a href="mailto:feedback@docker.com?subject=Docker%20Feedback">feedback@docker.com</a>
</p>
</div>
</div>

View File

@ -13,7 +13,7 @@ title: Automated Builds with Bitbucket
# Automated Builds with Bitbucket # Automated Builds with Bitbucket
If you've previously linked Docker Hub to your Bitbucket account, If you've previously linked Docker Hub to your Bitbucket account,
you'll be able to skip to [Creating an Automated Build](#creating-an-automated-build). you'll be able to skip to [Creating an Automated Build](bitbucket.md#creating-an-automated-build).
## Linking to your Bitbucket account ## Linking to your Bitbucket account

View File

@ -13,7 +13,7 @@ title: Automated Builds from GitHub
# Automated Builds from GitHub # Automated Builds from GitHub
If you've previously linked Docker Hub to your GitHub account, If you've previously linked Docker Hub to your GitHub account,
you'll be able to skip to [Creating an Automated Build](#creating-an-automated-build). you'll be able to skip to [Creating an Automated Build](github.md#creating-an-automated-build).
## Linking Docker Hub to a GitHub account ## Linking Docker Hub to a GitHub account
@ -62,7 +62,7 @@ You will be able to review and revoke Docker Hub's access by visiting the
If you selected to link your GitHub account with only a "Limited Access" link, then If you selected to link your GitHub account with only a "Limited Access" link, then
after creating your automated build, you will need to either manually trigger a after creating your automated build, you will need to either manually trigger a
Docker Hub build using the "Start a Build" button, or add the GitHub webhook Docker Hub build using the "Start a Build" button, or add the GitHub webhook
manually, as described in [GitHub Service Hooks](#github-service-hooks). manually, as described in [GitHub Service Hooks](github.md#github-service-hooks).
## Changing the GitHub user link ## Changing the GitHub user link

View File

@ -23,18 +23,18 @@ SSL Certificate (as a standard x509 key pair).
In order to run, the Trusted Registry requires encrypted communications through HTTPS/SSL between (a) the Trusted Registry and your Docker Engine(s), and (b) between your web browser and the Trusted Registry admin server. There are a few options for setting this up: In order to run, the Trusted Registry requires encrypted communications through HTTPS/SSL between (a) the Trusted Registry and your Docker Engine(s), and (b) between your web browser and the Trusted Registry admin server. There are a few options for setting this up:
1. You can use the self-signed certificate Docker Trusted Registry generates by default. 1. You can use the self-signed certificate Docker Trusted Registry generates by default.
2. You can generate your own certificates using a public service or your enterprise's infrastructure. See the [Generating SSL certificates](#generating-ssl-certificates) section for the options available. 2. You can generate your own certificates using a public service or your enterprise's infrastructure. See the [Generating SSL certificates](config-security.md#generating-ssl-certificates) section for the options available.
If you are generating your own certificates, you can install them by following the instructions for If you are generating your own certificates, you can install them by following the instructions for
[Adding your own registry certificates to Docker Trusted Registry](#adding-your-own-registry-certificates-to-dtr). [Adding your own registry certificates to Docker Trusted Registry](config-security.md#adding-your-own-registry-certificates-to-dtr).
However, if you choose to use the Trusted Registry-generated certificates, or However, if you choose to use the Trusted Registry-generated certificates, or
the certificates you generate yourself are not trusted by your client Docker the certificates you generate yourself are not trusted by your client Docker
hosts, you will need to do one of the following: hosts, you will need to do one of the following:
* [Install](#installing-registry-certificates-on-client-docker-daemons) a registry certificate on all of your client Docker daemons, or * [Install](config-security.md#installing-registry-certificates-on-client-docker-daemons) a registry certificate on all of your client Docker daemons, or
* Set your [client Docker daemons](#if-you-can-t-install-the-certificates) to run with an unconfirmed connection to the registry. * Set your [client Docker daemons](config-security.md#if-you-can-t-install-the-certificates) to run with an unconfirmed connection to the registry.
### Generate SSL certificates ### Generate SSL certificates

View File

@ -292,7 +292,7 @@ Trusted Registry. See below for specifics.
* New, more granular, [roles for users](../user-management/index.md). Docker Trusted Registry users can now be assigned different levels of access * New, more granular, [roles for users](../user-management/index.md). Docker Trusted Registry users can now be assigned different levels of access
(admin, r/w, r/o) to the repositories. **Important:** Existing Docker Trusted (admin, r/w, r/o) to the repositories. **Important:** Existing Docker Trusted
Registry users should make sure to see the note [below](#dhe-1-0-upgrade-warning) regarding migrating users before upgrading. Registry users should make sure to see the note [below](prior-release-notes.md#dhe-1-0-upgrade-warning) regarding migrating users before upgrading.
* A new storage status indicator for storage space. The dashboard now shows used and available storage space for supported storage drivers. * A new storage status indicator for storage space. The dashboard now shows used and available storage space for supported storage drivers.
* A new diagnostics tool gathers and bundles Docker Trusted Registry logs, system information, container * A new diagnostics tool gathers and bundles Docker Trusted Registry logs, system information, container
information, and other configuration settings for use by Docker support or as a information, and other configuration settings for use by Docker support or as a

View File

@ -314,7 +314,7 @@ container, we need to:
- Create a symlink from `/var/run/netns/<somename>` to `/proc/<thepid>/ns/net` - Create a symlink from `/var/run/netns/<somename>` to `/proc/<thepid>/ns/net`
- Execute `ip netns exec <somename> ....` - Execute `ip netns exec <somename> ....`
Please review [Enumerating Cgroups](#enumerating-cgroups) to learn how to find Please review [Enumerating Cgroups](runmetrics.md#enumerating-cgroups) to learn how to find
the cgroup of a process running in the container of which you want to the cgroup of a process running in the container of which you want to
measure network usage. From there, you can examine the pseudo-file named measure network usage. From there, you can examine the pseudo-file named
`tasks`, which contains the PIDs that are in the `tasks`, which contains the PIDs that are in the

View File

@ -73,7 +73,7 @@ Alternatively, find out where the service file is located:
EnvironmentFile=-/etc/sysconfig/docker EnvironmentFile=-/etc/sysconfig/docker
You can customize the Docker daemon options using override files as explained in the You can customize the Docker daemon options using override files as explained in the
[HTTP Proxy example](#http-proxy) below. The files located in `/usr/lib/systemd/system` [HTTP Proxy example](systemd.md#http-proxy) below. The files located in `/usr/lib/systemd/system`
or `/lib/systemd/system` contain the default options and should not be edited. or `/lib/systemd/system` contain the default options and should not be edited.
### Runtime directory and storage driver ### Runtime directory and storage driver

View File

@ -17,8 +17,8 @@ title: Managed plugin system
This document describes the plugin system available today in the **experimental This document describes the plugin system available today in the **experimental
build** of Docker 1.12: build** of Docker 1.12:
* [How to operate an existing plugin](#how-to-operate-a-plugin) * [How to operate an existing plugin](index.md#how-to-operate-a-plugin)
* [How to develop a plugin](#how-to-develop-a-plugin) * [How to develop a plugin](index.md#how-to-develop-a-plugin)
Unlike the legacy plugin system, you now manage plugins using Docker Engine: Unlike the legacy plugin system, you now manage plugins using Docker Engine:

View File

@ -26,7 +26,7 @@ If you just want to learn about or use Docker plugins, look
A plugin is a process running on the same or a different host as the docker daemon, A plugin is a process running on the same or a different host as the docker daemon,
which registers itself by placing a file on the same docker host in one of the plugin which registers itself by placing a file on the same docker host in one of the plugin
directories described in [Plugin discovery](#plugin-discovery). directories described in [Plugin discovery](plugin_api.md#plugin-discovery).
Plugins have human-readable names, which are short, lowercase strings. For Plugins have human-readable names, which are short, lowercase strings. For
example, `flocker` or `weave`. example, `flocker` or `weave`.

View File

@ -16,9 +16,9 @@ title: Install Docker and run hello-world
# Install Docker # Install Docker
- [Step 1: Get Docker](#step-1-get-docker) - [Step 1: Get Docker](step_one.md#step-1-get-docker)
- [Step 2: Install Docker](#step-2-install-docker) - [Step 2: Install Docker](step_one.md#step-2-install-docker)
- [Step 3: Verify your installation](#step-3-verify-your-installation) - [Step 3: Verify your installation](step_one.md#step-3-verify-your-installation)
## Step 1: Get Docker ## Step 1: Get Docker

View File

@ -245,7 +245,7 @@ daemon:
$ killall docker $ killall docker
Then follow the [regular installation steps](#get-the-linux-binaries). Then follow the [regular installation steps](binaries.md#get-the-linux-binaries).
## Next steps ## Next steps

View File

@ -42,8 +42,8 @@ packages.
## Install Docker Engine ## Install Docker Engine
There are two ways to install Docker Engine. You can [install using the `yum` There are two ways to install Docker Engine. You can [install using the `yum`
package manager](#install-with-yum). Or you can use `curl` with the [`get.docker.com` package manager](centos.md#install-with-yum). Or you can use `curl` with the [`get.docker.com`
site](#install-with-the-script). This second method runs an installation script site](centos.md#install-with-the-script). This second method runs an installation script
which also installs via the `yum` package manager. which also installs via the `yum` package manager.
### Install with yum ### Install with yum

View File

@ -15,9 +15,9 @@ title: Installation on Debian
Docker is supported on the following versions of Debian: Docker is supported on the following versions of Debian:
- [*Debian testing stretch (64-bit)*](#debian-wheezy-stable-7-x-64-bit) - [*Debian testing stretch (64-bit)*](debian.md#debian-wheezy-stable-7-x-64-bit)
- [*Debian 8.0 Jessie (64-bit)*](#debian-jessie-80-64-bit) - [*Debian 8.0 Jessie (64-bit)*](debian.md#debian-jessie-80-64-bit)
- [*Debian 7.7 Wheezy (64-bit)*](#debian-wheezy-stable-7-x-64-bit) (backports required) - [*Debian 7.7 Wheezy (64-bit)*](debian.md#debian-wheezy-stable-7-x-64-bit) (backports required)
>**Note**: If you previously installed Docker using `APT`, make sure you update >**Note**: If you previously installed Docker using `APT`, make sure you update
your `APT` sources to the new `APT` repository. your `APT` sources to the new `APT` repository.

View File

@ -40,8 +40,8 @@ packages.
## Install Docker Engine ## Install Docker Engine
There are two ways to install Docker Engine. You can [install using the `dnf` There are two ways to install Docker Engine. You can [install using the `dnf`
package manager](#install-with-dnf). Or you can use `curl` [with the `get.docker.com` package manager](fedora.md#install-with-dnf). Or you can use `curl` [with the `get.docker.com`
site](#install-with-the-script). This second method runs an installation script site](fedora.md#install-with-the-script). This second method runs an installation script
which also installs via the `dnf` package manager. which also installs via the `dnf` package manager.
### Install with DNF ### Install with DNF

View File

@ -87,9 +87,9 @@ btrfs storage engine on both Oracle Linux 6 and 7.
This section contains optional procedures for configuring your Oracle Linux to work This section contains optional procedures for configuring your Oracle Linux to work
better with Docker. better with Docker.
* [Create a docker group](#create-a-docker-group) * [Create a docker group](oracle.md#create-a-docker-group)
* [Configure Docker to start on boot](#configure-docker-to-start-on-boot) * [Configure Docker to start on boot](oracle.md#configure-docker-to-start-on-boot)
* [Use the btrfs storage engine](#use-the-btrfs-storage-engine) * [Use the btrfs storage engine](oracle.md#use-the-btrfs-storage-engine)
### Create a Docker group ### Create a Docker group

View File

@ -38,8 +38,8 @@ packages.
## Install Docker Engine ## Install Docker Engine
There are two ways to install Docker Engine. You can [install using the `yum` There are two ways to install Docker Engine. You can [install using the `yum`
package manager](#install-with-yum). Or you can use `curl` with the [`get.docker.com` package manager](rhel.md#install-with-yum). Or you can use `curl` with the [`get.docker.com`
site](#install-with-the-script). This second method runs an installation script site](rhel.md#install-with-the-script). This second method runs an installation script
which also installs via the `yum` package manager. which also installs via the `yum` package manager.
### Install with yum ### Install with yum

View File

@ -239,11 +239,11 @@ install Docker using the following:
This section contains optional procedures for configuring your Ubuntu to work This section contains optional procedures for configuring your Ubuntu to work
better with Docker. better with Docker.
* [Create a docker group](#create-a-docker-group) * [Create a docker group](ubuntulinux.md#create-a-docker-group)
* [Adjust memory and swap accounting](#adjust-memory-and-swap-accounting) * [Adjust memory and swap accounting](ubuntulinux.md#adjust-memory-and-swap-accounting)
* [Enable UFW forwarding](#enable-ufw-forwarding) * [Enable UFW forwarding](ubuntulinux.md#enable-ufw-forwarding)
* [Configure a DNS server for use by Docker](#configure-a-dns-server-for-use-by-docker) * [Configure a DNS server for use by Docker](ubuntulinux.md#configure-a-dns-server-for-use-by-docker)
* [Configure Docker to start on boot](#configure-docker-to-start-on-boot) * [Configure Docker to start on boot](ubuntulinux.md#configure-docker-to-start-on-boot)
### Create a Docker group ### Create a Docker group

View File

@ -14,8 +14,8 @@ title: Installation on Mac OS X
You have two options for installing Docker on Mac: You have two options for installing Docker on Mac:
- [Docker for Mac](#docker-for-mac) - [Docker for Mac](mac.md#docker-for-mac)
- [Docker Toolbox](#docker-toolbox) - [Docker Toolbox](mac.md#docker-toolbox)
## Docker for Mac ## Docker for Mac

View File

@ -13,8 +13,8 @@ title: Installation on Windows
You have two options for installing Docker on Windows: You have two options for installing Docker on Windows:
- [Docker for Windows](#docker-for-windows) - [Docker for Windows](windows.md#docker-for-windows)
- [Docker Toolbox](#docker-toolbox) - [Docker Toolbox](windows.md#docker-toolbox)
## Docker for Windows ## Docker for Windows

View File

@ -729,7 +729,7 @@ Start the container `id`
> **Note**: > **Note**:
> For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body. > For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body.
> See [create a container](#create-a-container) for details. > See [create a container](docker_remote_api_v1.18.md#create-a-container) for details.
**Example request**: **Example request**:
@ -928,7 +928,7 @@ Attach to the container `id`
When using the TTY setting is enabled in When using the TTY setting is enabled in
[`POST /containers/create` [`POST /containers/create`
](#create-a-container), ](docker_remote_api_v1.18.md#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`. the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`. `stdout` and `stderr`.
@ -1785,7 +1785,7 @@ If `name` is a specific name and tag (e.g. ubuntu:latest), then only that image
image (and its parents) are returned, but with the exclusion of the image (and its parents) are returned, but with the exclusion of the
'repositories' file in the tarball, as there were no image names referenced. 'repositories' file in the tarball, as there were no image names referenced.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.18.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -1814,7 +1814,7 @@ For each value of the `names` parameter: if it is a specific name and tag (e.g.
an image ID, similarly only that image (and its parents) are returned and there an image ID, similarly only that image (and its parents) are returned and there
would be no names referenced in the 'repositories' file for this image ID. would be no names referenced in the 'repositories' file for this image ID.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.18.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -1837,7 +1837,7 @@ See the [image tarball format](#image-tarball-format) for more details.
`POST /images/load` `POST /images/load`
Load a set of images and tags into a Docker repository. Load a set of images and tags into a Docker repository.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.18.md#image-tarball-format) for more details.
**Example request** **Example request**

View File

@ -766,7 +766,7 @@ Start the container `id`
> **Note**: > **Note**:
> For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body. > For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body.
> See [create a container](#create-a-container) for details. > See [create a container](docker_remote_api_v1.19.md#create-a-container) for details.
**Example request**: **Example request**:
@ -965,7 +965,7 @@ Attach to the container `id`
When using the TTY setting is enabled in When using the TTY setting is enabled in
[`POST /containers/create` [`POST /containers/create`
](#create-a-container), ](docker_remote_api_v1.19.md#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`. the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`. `stdout` and `stderr`.
@ -1863,7 +1863,7 @@ If `name` is a specific name and tag (e.g. ubuntu:latest), then only that image
image (and its parents) are returned, but with the exclusion of the image (and its parents) are returned, but with the exclusion of the
'repositories' file in the tarball, as there were no image names referenced. 'repositories' file in the tarball, as there were no image names referenced.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.19.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -1892,7 +1892,7 @@ For each value of the `names` parameter: if it is a specific name and tag (e.g.
an image ID, similarly only that image (and its parents) are returned and there an image ID, similarly only that image (and its parents) are returned and there
would be no names referenced in the 'repositories' file for this image ID. would be no names referenced in the 'repositories' file for this image ID.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.19.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -1915,7 +1915,7 @@ See the [image tarball format](#image-tarball-format) for more details.
`POST /images/load` `POST /images/load`
Load a set of images and tags into a Docker repository. Load a set of images and tags into a Docker repository.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.19.md#image-tarball-format) for more details.
**Example request** **Example request**

View File

@ -775,7 +775,7 @@ Start the container `id`
> **Note**: > **Note**:
> For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body. > For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body.
> See [create a container](#create-a-container) for details. > See [create a container](docker_remote_api_v1.20.md#create-a-container) for details.
**Example request**: **Example request**:
@ -974,7 +974,7 @@ Attach to the container `id`
When using the TTY setting is enabled in When using the TTY setting is enabled in
[`POST /containers/create` [`POST /containers/create`
](#create-a-container), ](docker_remote_api_v1.20.md#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`. the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`. `stdout` and `stderr`.
@ -2016,7 +2016,7 @@ If `name` is a specific name and tag (e.g. ubuntu:latest), then only that image
image (and its parents) are returned, but with the exclusion of the image (and its parents) are returned, but with the exclusion of the
'repositories' file in the tarball, as there were no image names referenced. 'repositories' file in the tarball, as there were no image names referenced.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.20.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2045,7 +2045,7 @@ For each value of the `names` parameter: if it is a specific name and tag (e.g.
an image ID, similarly only that image (and its parents) are returned and there an image ID, similarly only that image (and its parents) are returned and there
would be no names referenced in the 'repositories' file for this image ID. would be no names referenced in the 'repositories' file for this image ID.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.20.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2068,7 +2068,7 @@ See the [image tarball format](#image-tarball-format) for more details.
`POST /images/load` `POST /images/load`
Load a set of images and tags into a Docker repository. Load a set of images and tags into a Docker repository.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.20.md#image-tarball-format) for more details.
**Example request** **Example request**

View File

@ -856,7 +856,7 @@ Start the container `id`
> **Note**: > **Note**:
> For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body. > For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body.
> See [create a container](#create-a-container) for details. > See [create a container](docker_remote_api_v1.21.md#create-a-container) for details.
**Example request**: **Example request**:
@ -1055,7 +1055,7 @@ Attach to the container `id`
When using the TTY setting is enabled in When using the TTY setting is enabled in
[`POST /containers/create` [`POST /containers/create`
](#create-a-container), ](docker_remote_api_v1.21.md#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`. the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`. `stdout` and `stderr`.
@ -2170,7 +2170,7 @@ If `name` is a specific name and tag (e.g. ubuntu:latest), then only that image
image (and its parents) are returned, but with the exclusion of the image (and its parents) are returned, but with the exclusion of the
'repositories' file in the tarball, as there were no image names referenced. 'repositories' file in the tarball, as there were no image names referenced.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.21.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2199,7 +2199,7 @@ For each value of the `names` parameter: if it is a specific name and tag (e.g.
an image ID, similarly only that image (and its parents) are returned and there an image ID, similarly only that image (and its parents) are returned and there
would be no names referenced in the 'repositories' file for this image ID. would be no names referenced in the 'repositories' file for this image ID.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.21.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2222,7 +2222,7 @@ See the [image tarball format](#image-tarball-format) for more details.
`POST /images/load` `POST /images/load`
Load a set of images and tags into a Docker repository. Load a set of images and tags into a Docker repository.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.21.md#image-tarball-format) for more details.
**Example request** **Example request**

View File

@ -981,7 +981,7 @@ Start the container `id`
> **Note**: > **Note**:
> For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body. > For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body.
> See [create a container](#create-a-container) for details. > See [create a container](docker_remote_api_v1.22.md#create-a-container) for details.
**Example request**: **Example request**:
@ -1230,7 +1230,7 @@ Attach to the container `id`
When using the TTY setting is enabled in When using the TTY setting is enabled in
[`POST /containers/create` [`POST /containers/create`
](#create-a-container), ](docker_remote_api_v1.22.md#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`. the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`. `stdout` and `stderr`.
@ -2560,7 +2560,7 @@ If `name` is a specific name and tag (e.g. ubuntu:latest), then only that image
image (and its parents) are returned, but with the exclusion of the image (and its parents) are returned, but with the exclusion of the
'repositories' file in the tarball, as there were no image names referenced. 'repositories' file in the tarball, as there were no image names referenced.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.22.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2589,7 +2589,7 @@ For each value of the `names` parameter: if it is a specific name and tag (e.g.
an image ID, similarly only that image (and its parents) are returned and there an image ID, similarly only that image (and its parents) are returned and there
would be no names referenced in the 'repositories' file for this image ID. would be no names referenced in the 'repositories' file for this image ID.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.22.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2612,7 +2612,7 @@ See the [image tarball format](#image-tarball-format) for more details.
`POST /images/load` `POST /images/load`
Load a set of images and tags into a Docker repository. Load a set of images and tags into a Docker repository.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.22.md#image-tarball-format) for more details.
**Example request** **Example request**

View File

@ -1010,7 +1010,7 @@ Start the container `id`
> **Note**: > **Note**:
> For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body. > For backwards compatibility, this endpoint accepts a `HostConfig` as JSON-encoded request body.
> See [create a container](#create-a-container) for details. > See [create a container](docker_remote_api_v1.23.md#create-a-container) for details.
**Example request**: **Example request**:
@ -1263,7 +1263,7 @@ Attach to the container `id`
When using the TTY setting is enabled in When using the TTY setting is enabled in
[`POST /containers/create` [`POST /containers/create`
](#create-a-container), ](docker_remote_api_v1.23.md#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`. the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`. `stdout` and `stderr`.
@ -2608,7 +2608,7 @@ If `name` is a specific name and tag (e.g. ubuntu:latest), then only that image
image (and its parents) are returned, but with the exclusion of the image (and its parents) are returned, but with the exclusion of the
'repositories' file in the tarball, as there were no image names referenced. 'repositories' file in the tarball, as there were no image names referenced.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.23.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2637,7 +2637,7 @@ For each value of the `names` parameter: if it is a specific name and tag (e.g.
an image ID, similarly only that image (and its parents) are returned and there an image ID, similarly only that image (and its parents) are returned and there
would be no names referenced in the 'repositories' file for this image ID. would be no names referenced in the 'repositories' file for this image ID.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.23.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2660,7 +2660,7 @@ See the [image tarball format](#image-tarball-format) for more details.
`POST /images/load` `POST /images/load`
Load a set of images and tags into a Docker repository. Load a set of images and tags into a Docker repository.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.23.md#image-tarball-format) for more details.
**Example request** **Example request**

View File

@ -1292,7 +1292,7 @@ Attach to the container `id`
When using the TTY setting is enabled in When using the TTY setting is enabled in
[`POST /containers/create` [`POST /containers/create`
](#create-a-container), ](docker_remote_api_v1.24.md#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`. the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`. `stdout` and `stderr`.
@ -2622,7 +2622,7 @@ If `name` is a specific name and tag (e.g. ubuntu:latest), then only that image
image (and its parents) are returned, but with the exclusion of the image (and its parents) are returned, but with the exclusion of the
'repositories' file in the tarball, as there were no image names referenced. 'repositories' file in the tarball, as there were no image names referenced.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.24.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2651,7 +2651,7 @@ For each value of the `names` parameter: if it is a specific name and tag (e.g.
an image ID, similarly only that image (and its parents) are returned and there an image ID, similarly only that image (and its parents) are returned and there
would be no names referenced in the 'repositories' file for this image ID. would be no names referenced in the 'repositories' file for this image ID.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.24.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2674,7 +2674,7 @@ See the [image tarball format](#image-tarball-format) for more details.
`POST /images/load` `POST /images/load`
Load a set of images and tags into a Docker repository. Load a set of images and tags into a Docker repository.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.24.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2997,7 +2997,7 @@ Create a volume
**JSON fields in response**: **JSON fields in response**:
Refer to the [inspect a volume](#inspect-a-volume) section or details about the Refer to the [inspect a volume](docker_remote_api_v1.24.md#inspect-a-volume) section or details about the
JSON fields returned in the response. JSON fields returned in the response.
### Inspect a volume ### Inspect a volume
@ -3536,7 +3536,7 @@ Content-Type: application/json
`POST /plugins/pull?name=<plugin name>` `POST /plugins/pull?name=<plugin name>`
Pulls and installs a plugin. After the plugin is installed, it can be enabled Pulls and installs a plugin. After the plugin is installed, it can be enabled
using the [`POST /plugins/(plugin name)/enable` endpoint](#enable-a-plugin). using the [`POST /plugins/(plugin name)/enable` endpoint](docker_remote_api_v1.24.md#enable-a-plugin).
**Example request**: **Example request**:
@ -3547,7 +3547,7 @@ POST /plugins/pull?name=tiborvass/no-remove:latest HTTP/1.1
The `:latest` tag is optional, and is used as default if omitted. When using The `:latest` tag is optional, and is used as default if omitted. When using
this endpoint to pull a plugin from the registry, the `X-Registry-Auth` header this endpoint to pull a plugin from the registry, the `X-Registry-Auth` header
can be used to include a base64-encoded AuthConfig object. Refer to the [create can be used to include a base64-encoded AuthConfig object. Refer to the [create
an image](#create-an-image) section for more details. an image](docker_remote_api_v1.24.md#create-an-image) section for more details.
**Example response**: **Example response**:
@ -3827,7 +3827,7 @@ POST /plugins/tiborvass/no-remove:latest HTTP/1.1
The `:latest` tag is optional, and is used as default if omitted. When using The `:latest` tag is optional, and is used as default if omitted. When using
this endpoint to push a plugin to the registry, the `X-Registry-Auth` header this endpoint to push a plugin to the registry, the `X-Registry-Auth` header
can be used to include a base64-encoded AuthConfig object. Refer to the [create can be used to include a base64-encoded AuthConfig object. Refer to the [create
an image](#create-an-image) section for more details. an image](docker_remote_api_v1.24.md#create-an-image) section for more details.
**Example response**: **Example response**:
@ -4489,7 +4489,7 @@ List services
Create a service. When using this endpoint to create a service using a private Create a service. When using this endpoint to create a service using a private
repository from the registry, the `X-Registry-Auth` header must be used to repository from the registry, the `X-Registry-Auth` header must be used to
include a base64-encoded AuthConfig object. Refer to the [create an include a base64-encoded AuthConfig object. Refer to the [create an
image](#create-an-image) section for more details. image](docker_remote_api_v1.24.md#create-an-image) section for more details.
**Example request**: **Example request**:
@ -4651,7 +4651,7 @@ image](#create-an-image) section for more details.
- **Content-type** Set to `"application/json"`. - **Content-type** Set to `"application/json"`.
- **X-Registry-Auth** base64-encoded AuthConfig object, containing either - **X-Registry-Auth** base64-encoded AuthConfig object, containing either
login information, or a token. Refer to the [create an image](#create-an-image) login information, or a token. Refer to the [create an image](docker_remote_api_v1.24.md#create-an-image)
section for more details. section for more details.
@ -4773,7 +4773,7 @@ Update a service. When using this endpoint to create a service using a
private repository from the registry, the `X-Registry-Auth` header can be used private repository from the registry, the `X-Registry-Auth` header can be used
to update the authentication information for that is stored for the service. to update the authentication information for that is stored for the service.
The header contains a base64-encoded AuthConfig object. Refer to the [create an The header contains a base64-encoded AuthConfig object. Refer to the [create an
image](#create-an-image) section for more details. image](docker_remote_api_v1.24.md#create-an-image) section for more details.
**Example request**: **Example request**:
@ -4889,7 +4889,7 @@ image](#create-an-image) section for more details.
- **Content-type** Set to `"application/json"`. - **Content-type** Set to `"application/json"`.
- **X-Registry-Auth** base64-encoded AuthConfig object, containing either - **X-Registry-Auth** base64-encoded AuthConfig object, containing either
login information, or a token. Refer to the [create an image](#create-an-image) login information, or a token. Refer to the [create an image](docker_remote_api_v1.24.md#create-an-image)
section for more details. section for more details.
**Status codes**: **Status codes**:

View File

@ -1299,7 +1299,7 @@ Attach to the container `id`
When using the TTY setting is enabled in When using the TTY setting is enabled in
[`POST /containers/create` [`POST /containers/create`
](#create-a-container), ](docker_remote_api_v1.25.md#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`. the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`. `stdout` and `stderr`.
@ -2638,7 +2638,7 @@ If `name` is a specific name and tag (e.g. ubuntu:latest), then only that image
image (and its parents) are returned, but with the exclusion of the image (and its parents) are returned, but with the exclusion of the
'repositories' file in the tarball, as there were no image names referenced. 'repositories' file in the tarball, as there were no image names referenced.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.25.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2667,7 +2667,7 @@ For each value of the `names` parameter: if it is a specific name and tag (e.g.
an image ID, similarly only that image (and its parents) are returned and there an image ID, similarly only that image (and its parents) are returned and there
would be no names referenced in the 'repositories' file for this image ID. would be no names referenced in the 'repositories' file for this image ID.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.25.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -2690,7 +2690,7 @@ See the [image tarball format](#image-tarball-format) for more details.
`POST /images/load` `POST /images/load`
Load a set of images and tags into a Docker repository. Load a set of images and tags into a Docker repository.
See the [image tarball format](#image-tarball-format) for more details. See the [image tarball format](docker_remote_api_v1.25.md#image-tarball-format) for more details.
**Example request** **Example request**
@ -3016,7 +3016,7 @@ Create a volume
**JSON fields in response**: **JSON fields in response**:
Refer to the [inspect a volume](#inspect-a-volume) section or details about the Refer to the [inspect a volume](docker_remote_api_v1.25.md#inspect-a-volume) section or details about the
JSON fields returned in the response. JSON fields returned in the response.
### Inspect a volume ### Inspect a volume
@ -3555,7 +3555,7 @@ Content-Type: application/json
`POST /plugins/pull?name=<plugin name>` `POST /plugins/pull?name=<plugin name>`
Pulls and installs a plugin. After the plugin is installed, it can be enabled Pulls and installs a plugin. After the plugin is installed, it can be enabled
using the [`POST /plugins/(plugin name)/enable` endpoint](#enable-a-plugin). using the [`POST /plugins/(plugin name)/enable` endpoint](docker_remote_api_v1.25.md#enable-a-plugin).
**Example request**: **Example request**:
@ -3566,7 +3566,7 @@ POST /plugins/pull?name=tiborvass/no-remove:latest HTTP/1.1
The `:latest` tag is optional, and is used as default if omitted. When using The `:latest` tag is optional, and is used as default if omitted. When using
this endpoint to pull a plugin from the registry, the `X-Registry-Auth` header this endpoint to pull a plugin from the registry, the `X-Registry-Auth` header
can be used to include a base64-encoded AuthConfig object. Refer to the [create can be used to include a base64-encoded AuthConfig object. Refer to the [create
an image](#create-an-image) section for more details. an image](docker_remote_api_v1.25.md#create-an-image) section for more details.
**Example response**: **Example response**:
@ -3863,7 +3863,7 @@ POST /plugins/tiborvass/no-remove:latest HTTP/1.1
The `:latest` tag is optional, and is used as default if omitted. When using The `:latest` tag is optional, and is used as default if omitted. When using
this endpoint to push a plugin to the registry, the `X-Registry-Auth` header this endpoint to push a plugin to the registry, the `X-Registry-Auth` header
can be used to include a base64-encoded AuthConfig object. Refer to the [create can be used to include a base64-encoded AuthConfig object. Refer to the [create
an image](#create-an-image) section for more details. an image](docker_remote_api_v1.25.md#create-an-image) section for more details.
**Example response**: **Example response**:
@ -4525,7 +4525,7 @@ List services
Create a service. When using this endpoint to create a service using a private Create a service. When using this endpoint to create a service using a private
repository from the registry, the `X-Registry-Auth` header must be used to repository from the registry, the `X-Registry-Auth` header must be used to
include a base64-encoded AuthConfig object. Refer to the [create an include a base64-encoded AuthConfig object. Refer to the [create an
image](#create-an-image) section for more details. image](docker_remote_api_v1.25.md#create-an-image) section for more details.
**Example request**: **Example request**:
@ -4687,7 +4687,7 @@ image](#create-an-image) section for more details.
- **Content-type** Set to `"application/json"`. - **Content-type** Set to `"application/json"`.
- **X-Registry-Auth** base64-encoded AuthConfig object, containing either - **X-Registry-Auth** base64-encoded AuthConfig object, containing either
login information, or a token. Refer to the [create an image](#create-an-image) login information, or a token. Refer to the [create an image](docker_remote_api_v1.25.md#create-an-image)
section for more details. section for more details.
@ -4809,7 +4809,7 @@ Update a service. When using this endpoint to create a service using a
private repository from the registry, the `X-Registry-Auth` header can be used private repository from the registry, the `X-Registry-Auth` header can be used
to update the authentication information for that is stored for the service. to update the authentication information for that is stored for the service.
The header contains a base64-encoded AuthConfig object. Refer to the [create an The header contains a base64-encoded AuthConfig object. Refer to the [create an
image](#create-an-image) section for more details. image](docker_remote_api_v1.25.md#create-an-image) section for more details.
**Example request**: **Example request**:
@ -4925,7 +4925,7 @@ image](#create-an-image) section for more details.
- **Content-type** Set to `"application/json"`. - **Content-type** Set to `"application/json"`.
- **X-Registry-Auth** base64-encoded AuthConfig object, containing either - **X-Registry-Auth** base64-encoded AuthConfig object, containing either
login information, or a token. Refer to the [create an image](#create-an-image) login information, or a token. Refer to the [create an image](docker_remote_api_v1.25.md#create-an-image)
section for more details. section for more details.
**Status codes**: **Status codes**:

View File

@ -51,7 +51,7 @@ To use a file in the build context, the `Dockerfile` refers to the file specifie
in an instruction, for example, a `COPY` instruction. To increase the build's in an instruction, for example, a `COPY` instruction. To increase the build's
performance, exclude files and directories by adding a `.dockerignore` file to performance, exclude files and directories by adding a `.dockerignore` file to
the context directory. For information about how to [create a `.dockerignore` the context directory. For information about how to [create a `.dockerignore`
file](#dockerignore-file) see the documentation on this page. file](builder.md#dockerignore-file) see the documentation on this page.
Traditionally, the `Dockerfile` is called `Dockerfile` and located in the root Traditionally, the `Dockerfile` is called `Dockerfile` and located in the root
of the context. You use the `-f` flag with `docker build` to point to a Dockerfile of the context. You use the `-f` flag with `docker build` to point to a Dockerfile
@ -299,7 +299,7 @@ Results in:
## Environment replacement ## Environment replacement
Environment variables (declared with [the `ENV` statement](#env)) can also be Environment variables (declared with [the `ENV` statement](builder.md#env)) can also be
used in certain instructions as variables to be interpreted by the used in certain instructions as variables to be interpreted by the
`Dockerfile`. Escapes are also handled for including variable-like syntax `Dockerfile`. Escapes are also handled for including variable-like syntax
into a statement literally. into a statement literally.
@ -565,7 +565,7 @@ See the [`Dockerfile` Best Practices
guide](../userguide/eng-image/dockerfile_best-practices.md#build-cache) for more information. guide](../userguide/eng-image/dockerfile_best-practices.md#build-cache) for more information.
The cache for `RUN` instructions can be invalidated by `ADD` instructions. See The cache for `RUN` instructions can be invalidated by `ADD` instructions. See
[below](#add) for details. [below](builder.md#add) for details.
### Known issues (RUN) ### Known issues (RUN)
@ -634,7 +634,7 @@ must be individually expressed as strings in the array:
If you would like your container to run the same executable every time, then If you would like your container to run the same executable every time, then
you should consider using `ENTRYPOINT` in combination with `CMD`. See you should consider using `ENTRYPOINT` in combination with `CMD`. See
[*ENTRYPOINT*](#entrypoint). [*ENTRYPOINT*](builder.md#entrypoint).
If the user specifies arguments to `docker run` then they will override the If the user specifies arguments to `docker run` then they will override the
default specified in `CMD`. default specified in `CMD`.
@ -712,7 +712,7 @@ feature](../userguide/networking/index.md)).
The `ENV` instruction sets the environment variable `<key>` to the value The `ENV` instruction sets the environment variable `<key>` to the value
`<value>`. This value will be in the environment of all "descendant" `<value>`. This value will be in the environment of all "descendant"
`Dockerfile` commands and can be [replaced inline](#environment-replacement) in `Dockerfile` commands and can be [replaced inline](builder.md#environment-replacement) in
many as well. many as well.
The `ENV` instruction has two forms. The first form, `ENV <key> <value>`, The `ENV` instruction has two forms. The first form, `ENV <key> <value>`,
@ -1349,7 +1349,7 @@ its value would be `v1.0.0` as it is the default set in line 3 by the `ENV` inst
The variable expansion technique in this example allows you to pass arguments The variable expansion technique in this example allows you to pass arguments
from the command line and persist them in the final image by leveraging the from the command line and persist them in the final image by leveraging the
`ENV` instruction. Variable expansion is only supported for [a limited set of `ENV` instruction. Variable expansion is only supported for [a limited set of
Dockerfile instructions.](#environment-replacement) Dockerfile instructions.](builder.md#environment-replacement)
Docker has a set of predefined `ARG` variables that you can use without a Docker has a set of predefined `ARG` variables that you can use without a
corresponding `ARG` instruction in the Dockerfile. corresponding `ARG` instruction in the Dockerfile.

View File

@ -237,7 +237,7 @@ snapshots. For each devicemapper graph location typically
`/var/lib/docker/devicemapper` a thin pool is created based on two block `/var/lib/docker/devicemapper` a thin pool is created based on two block
devices, one for data and one for metadata. By default, these block devices devices, one for data and one for metadata. By default, these block devices
are created automatically by using loopback mounts of automatically created are created automatically by using loopback mounts of automatically created
sparse files. Refer to [Storage driver options](#storage-driver-options) below sparse files. Refer to [Storage driver options](dockerd.md#storage-driver-options) below
for a way how to customize this setup. for a way how to customize this setup.
[~jpetazzo/Resizing Docker containers with the Device Mapper plugin](http://jpetazzo.github.io/2014/01/29/docker-device-mapper-resize/) [~jpetazzo/Resizing Docker containers with the Device Mapper plugin](http://jpetazzo.github.io/2014/01/29/docker-device-mapper-resize/)
article explains how to tune your existing setup without the use of options. article explains how to tune your existing setup without the use of options.
@ -249,7 +249,7 @@ does not share executable memory between devices. Use
The `zfs` driver is probably not as fast as `btrfs` but has a longer track record The `zfs` driver is probably not as fast as `btrfs` but has a longer track record
on stability. Thanks to `Single Copy ARC` shared blocks between clones will be on stability. Thanks to `Single Copy ARC` shared blocks between clones will be
cached only once. Use `dockerd -s zfs`. To select a different zfs filesystem cached only once. Use `dockerd -s zfs`. To select a different zfs filesystem
set `zfs.fsname` option as described in [Storage driver options](#storage-driver-options). set `zfs.fsname` option as described in [Storage driver options](dockerd.md#storage-driver-options).
The `overlay` is a very fast union filesystem. It is now merged in the main The `overlay` is a very fast union filesystem. It is now merged in the main
Linux kernel as of [3.18.0](https://lkml.org/lkml/2014/10/26/137). `overlay` Linux kernel as of [3.18.0](https://lkml.org/lkml/2014/10/26/137). `overlay`
@ -995,7 +995,7 @@ following algorithm to create the mapping ranges:
If you enable user namespaces on the daemon, all containers are started If you enable user namespaces on the daemon, all containers are started
with user namespaces enabled. In some situations you might want to disable with user namespaces enabled. In some situations you might want to disable
this feature for a container, for example, to start a privileged container (see this feature for a container, for example, to start a privileged container (see
[user namespace known restrictions](#user-namespace-known-restrictions)). [user namespace known restrictions](dockerd.md#user-namespace-known-restrictions)).
To enable those advanced features for a specific container use `--userns=host` To enable those advanced features for a specific container use `--userns=host`
in the `run/exec/create` command. in the `run/exec/create` command.
This option will completely disable user namespace mapping for the container's user. This option will completely disable user namespace mapping for the container's user.
@ -1245,7 +1245,7 @@ previously configured cluster configurations.
This section describes how to run multiple Docker daemons on a single host. To This section describes how to run multiple Docker daemons on a single host. To
run multiple daemons, you must configure each daemon so that it does not run multiple daemons, you must configure each daemon so that it does not
conflict with other daemons on the same host. You can set these options either conflict with other daemons on the same host. You can set these options either
by providing them as flags, or by using a [daemon configuration file](#daemon-configuration-file). by providing them as flags, or by using a [daemon configuration file](dockerd.md#daemon-configuration-file).
The following daemon options must be configured for each daemon: The following daemon options must be configured for each daemon:

View File

@ -26,7 +26,7 @@ Options:
-q, --quiet Only display IDs -q, --quiet Only display IDs
``` ```
Lists all the nodes that the Docker Swarm manager knows about. You can filter using the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section for more information about available filter options. Lists all the nodes that the Docker Swarm manager knows about. You can filter using the `-f` or `--filter` flag. Refer to the [filtering](node_ls.md#filtering) section for more information about available filter options.
Example output: Example output:

View File

@ -27,7 +27,7 @@ Options:
--no-resolve Do not map IDs to Names --no-resolve Do not map IDs to Names
``` ```
Lists all the tasks on a Node that Docker knows about. You can filter using the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section for more information about available filter options. Lists all the tasks on a Node that Docker knows about. You can filter using the `-f` or `--filter` flag. Refer to the [filtering](node_ps.md#filtering) section for more information about available filter options.
Example output: Example output:
@ -47,10 +47,10 @@ than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "b
The currently supported filters are: The currently supported filters are:
* [name](#name) * [name](node_ps.md#name)
* [id](#id) * [id](node_ps.md#id)
* [label](#label) * [label](node_ps.md#label)
* [desired-state](#desired-state) * [desired-state](node_ps.md#desired-state)
#### name #### name

View File

@ -47,9 +47,9 @@ than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "b
The currently supported filters are: The currently supported filters are:
* [id](#id) * [id](service_ls.md#id)
* [label](#label) * [label](service_ls.md#label)
* [name](#name) * [name](service_ls.md#name)
#### ID #### ID

View File

@ -62,9 +62,9 @@ Multiple filter flags are combined as an `OR` filter. For example,
The currently supported filters are: The currently supported filters are:
* [id](#id) * [id](service_ps.md#id)
* [name](#name) * [name](service_ps.md#name)
* [desired-state](#desired-state) * [desired-state](service_ps.md#desired-state)
#### ID #### ID

View File

@ -35,9 +35,9 @@ Multiple filter flags are combined as an `OR` filter. For example,
The currently supported filters are: The currently supported filters are:
* [id](#id) * [id](stack_tasks.md#id)
* [name](#name) * [name](stack_tasks.md#name)
* [desired-state](#desired-state) * [desired-state](stack_tasks.md#desired-state)
## Related information ## Related information

View File

@ -27,7 +27,7 @@ Options:
-q, --quiet Only display volume names -q, --quiet Only display volume names
``` ```
Lists all the volumes Docker knows about. You can filter using the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section for more information about available filter options. Lists all the volumes Docker knows about. You can filter using the `-f` or `--filter` flag. Refer to the [filtering](volume_ls.md#filtering) section for more information about available filter options.
Example output: Example output:

View File

@ -15,7 +15,7 @@ A list of terms used around the Docker project.
## aufs ## aufs
aufs (advanced multi layered unification filesystem) is a Linux [filesystem](#filesystem) that aufs (advanced multi layered unification filesystem) is a Linux [filesystem](glossary.md#filesystem) that
Docker supports as a storage backend. It implements the Docker supports as a storage backend. It implements the
[union mount](http://en.wikipedia.org/wiki/Union_mount) for Linux file systems. [union mount](http://en.wikipedia.org/wiki/Union_mount) for Linux file systems.
@ -26,17 +26,17 @@ An image that has no parent is a **base image**.
## boot2docker ## boot2docker
[boot2docker](http://boot2docker.io/) is a lightweight Linux distribution made [boot2docker](http://boot2docker.io/) is a lightweight Linux distribution made
specifically to run Docker containers. The boot2docker management tool for Mac and Windows was deprecated and replaced by [`docker-machine`](#machine) which you can install with the Docker Toolbox. specifically to run Docker containers. The boot2docker management tool for Mac and Windows was deprecated and replaced by [`docker-machine`](glossary.md#machine) which you can install with the Docker Toolbox.
## btrfs ## btrfs
btrfs (B-tree file system) is a Linux [filesystem](#filesystem) that Docker btrfs (B-tree file system) is a Linux [filesystem](glossary.md#filesystem) that Docker
supports as a storage backend. It is a [copy-on-write](http://en.wikipedia.org/wiki/Copy-on-write) supports as a storage backend. It is a [copy-on-write](http://en.wikipedia.org/wiki/Copy-on-write)
filesystem. filesystem.
## build ## build
build is the process of building Docker images using a [Dockerfile](#dockerfile). build is the process of building Docker images using a [Dockerfile](glossary.md#dockerfile).
The build uses a Dockerfile and a "context". The context is the set of files in the The build uses a Dockerfile and a "context". The context is the set of files in the
directory in which the image is built. directory in which the image is built.
@ -60,7 +60,7 @@ be done to get it running.
## container ## container
A container is a runtime instance of a [docker image](#image). A container is a runtime instance of a [docker image](glossary.md#image).
A Docker container consists of A Docker container consists of
@ -119,7 +119,7 @@ Examples :
## image ## image
Docker images are the basis of [containers](#container). An Image is an Docker images are the basis of [containers](glossary.md#container). An Image is an
ordered collection of root filesystem changes and the corresponding ordered collection of root filesystem changes and the corresponding
execution parameters for use within a container runtime. An image typically execution parameters for use within a container runtime. An image typically
contains a union of layered filesystems stacked on top of each other. An image contains a union of layered filesystems stacked on top of each other. An image
@ -170,23 +170,23 @@ for docker containers in a cluster.
## overlay storage driver ## overlay storage driver
OverlayFS is a [filesystem](#filesystem) service for Linux which implements a OverlayFS is a [filesystem](glossary.md#filesystem) service for Linux which implements a
[union mount](http://en.wikipedia.org/wiki/Union_mount) for other file systems. [union mount](http://en.wikipedia.org/wiki/Union_mount) for other file systems.
It is supported by the Docker daemon as a storage driver. It is supported by the Docker daemon as a storage driver.
## registry ## registry
A Registry is a hosted service containing [repositories](#repository) of [images](#image) A Registry is a hosted service containing [repositories](glossary.md#repository) of [images](glossary.md#image)
which responds to the Registry API. which responds to the Registry API.
The default registry can be accessed using a browser at [Docker Hub](#docker-hub) The default registry can be accessed using a browser at [Docker Hub](glossary.md#docker-hub)
or using the `docker search` command. or using the `docker search` command.
## repository ## repository
A repository is a set of Docker images. A repository can be shared by pushing it A repository is a set of Docker images. A repository can be shared by pushing it
to a [registry](#registry) server. The different images in the repository can be to a [registry](glossary.md#registry) server. The different images in the repository can be
labeled using [tags](#tag). labeled using [tags](glossary.md#tag).
Here is an example of the shared [nginx repository](https://hub.docker.com/_/nginx/) Here is an example of the shared [nginx repository](https://hub.docker.com/_/nginx/)
and its [tags](https://hub.docker.com/r/library/nginx/tags/) and its [tags](https://hub.docker.com/r/library/nginx/tags/)
@ -220,11 +220,11 @@ automatically distributes requests to the service VIP among the active tasks.
## swarm ## swarm
A [swarm](../swarm/index.md) is a cluster of one or more Docker Engines running in [swarm mode](#swarm-mode). A [swarm](../swarm/index.md) is a cluster of one or more Docker Engines running in [swarm mode](glossary.md#swarm-mode).
## Swarm ## Swarm
Do not confuse [Docker Swarm](https://github.com/docker/swarm) with the [swarm mode](#swarm-mode) features in Docker Engine. Do not confuse [Docker Swarm](https://github.com/docker/swarm) with the [swarm mode](glossary.md#swarm-mode) features in Docker Engine.
Docker Swarm is the name of a standalone native clustering tool for Docker. Docker Swarm is the name of a standalone native clustering tool for Docker.
Docker Swarm pools together several Docker hosts and exposes them as a single Docker Swarm pools together several Docker hosts and exposes them as a single
@ -241,7 +241,7 @@ join nodes to a swarm, the Docker Engine runs in swarm mode.
## tag ## tag
A tag is a label applied to a Docker image in a [repository](#repository). A tag is a label applied to a Docker image in a [repository](glossary.md#repository).
tags are how various images in a repository are distinguished from each other. tags are how various images in a repository are distinguished from each other.
*Note : This label is not related to the key=value labels set for docker daemon* *Note : This label is not related to the key=value labels set for docker daemon*

View File

@ -58,18 +58,18 @@ types*](commandline/cli.md#option-types).
Only the operator (the person executing `docker run`) can set the Only the operator (the person executing `docker run`) can set the
following options. following options.
- [Detached vs foreground](#detached-vs-foreground) - [Detached vs foreground](run.md#detached-vs-foreground)
- [Detached (-d)](#detached-d) - [Detached (-d)](run.md#detached-d)
- [Foreground](#foreground) - [Foreground](run.md#foreground)
- [Container identification](#container-identification) - [Container identification](run.md#container-identification)
- [Name (--name)](#name-name) - [Name (--name)](run.md#name-name)
- [PID equivalent](#pid-equivalent) - [PID equivalent](run.md#pid-equivalent)
- [IPC settings (--ipc)](#ipc-settings-ipc) - [IPC settings (--ipc)](run.md#ipc-settings-ipc)
- [Network settings](#network-settings) - [Network settings](run.md#network-settings)
- [Restart policies (--restart)](#restart-policies-restart) - [Restart policies (--restart)](run.md#restart-policies-restart)
- [Clean up (--rm)](#clean-up-rm) - [Clean up (--rm)](run.md#clean-up-rm)
- [Runtime constraints on resources](#runtime-constraints-on-resources) - [Runtime constraints on resources](run.md#runtime-constraints-on-resources)
- [Runtime privilege and Linux capabilities](#runtime-privilege-and-linux-capabilities) - [Runtime privilege and Linux capabilities](run.md#runtime-privilege-and-linux-capabilities)
## Detached vs foreground ## Detached vs foreground
@ -548,7 +548,7 @@ Or, to get the last time the container was (re)started;
Combining `--restart` (restart policy) with the `--rm` (clean up) flag results Combining `--restart` (restart policy) with the `--rm` (clean up) flag results
in an error. On container restart, attached clients are disconnected. See the in an error. On container restart, attached clients are disconnected. See the
examples on using the [`--rm` (clean up)](#clean-up-rm) flag later in this page. examples on using the [`--rm` (clean up)](run.md#clean-up-rm) flag later in this page.
### Examples ### Examples
@ -1253,15 +1253,15 @@ Four of the Dockerfile commands cannot be overridden at runtime: `FROM`,
in `docker run`. We'll go through what the developer might have set in each in `docker run`. We'll go through what the developer might have set in each
Dockerfile instruction and how the operator can override that setting. Dockerfile instruction and how the operator can override that setting.
- [CMD (Default Command or Options)](#cmd-default-command-or-options) - [CMD (Default Command or Options)](run.md#cmd-default-command-or-options)
- [ENTRYPOINT (Default Command to Execute at Runtime)]( - [ENTRYPOINT (Default Command to Execute at Runtime)](
#entrypoint-default-command-to-execute-at-runtime) #entrypoint-default-command-to-execute-at-runtime)
- [EXPOSE (Incoming Ports)](#expose-incoming-ports) - [EXPOSE (Incoming Ports)](run.md#expose-incoming-ports)
- [ENV (Environment Variables)](#env-environment-variables) - [ENV (Environment Variables)](run.md#env-environment-variables)
- [HEALTHCHECK](#healthcheck) - [HEALTHCHECK](run.md#healthcheck)
- [VOLUME (Shared Filesystems)](#volume-shared-filesystems) - [VOLUME (Shared Filesystems)](run.md#volume-shared-filesystems)
- [USER](#user) - [USER](run.md#user)
- [WORKDIR](#workdir) - [WORKDIR](run.md#workdir)
### CMD (default command or options) ### CMD (default command or options)

View File

@ -102,7 +102,7 @@ to rotate the snapshot key specifically, and you want the server to manage it (`
stands for "remote"). stands for "remote").
When adding a delegation, your must acquire When adding a delegation, your must acquire
[the PEM-encoded x509 certificate with the public key](#generating-delegation-keys) [the PEM-encoded x509 certificate with the public key](trust_delegation.md#generating-delegation-keys)
of the collaborator you wish to delegate to. of the collaborator you wish to delegate to.
Assuming you have the certificate `delegation.crt`, you can add a delegation Assuming you have the certificate `delegation.crt`, you can add a delegation

View File

@ -21,15 +21,15 @@ maintain the swarm.
This article covers the following swarm administration tasks: This article covers the following swarm administration tasks:
* [Using a static IP for manager node advertise address](#use-a-static-ip-for-manager-node-advertise-address) * [Using a static IP for manager node advertise address](admin_guide.md#use-a-static-ip-for-manager-node-advertise-address)
* [Adding manager nodes for fault tolerance](#add-manager-nodes-for-fault-tolerance) * [Adding manager nodes for fault tolerance](admin_guide.md#add-manager-nodes-for-fault-tolerance)
* [Distributing manager nodes](#distribute-manager-nodes) * [Distributing manager nodes](admin_guide.md#distribute-manager-nodes)
* [Running manager-only nodes](#run-manager-only-nodes) * [Running manager-only nodes](admin_guide.md#run-manager-only-nodes)
* [Backing up the swarm state](#back-up-the-swarm-state) * [Backing up the swarm state](admin_guide.md#back-up-the-swarm-state)
* [Monitoring the swarm health](#monitor-swarm-health) * [Monitoring the swarm health](admin_guide.md#monitor-swarm-health)
* [Troubleshooting a manager node](#troubleshoot-a-manager-node) * [Troubleshooting a manager node](admin_guide.md#troubleshoot-a-manager-node)
* [Forcefully removing a node](#force-remove-a-node) * [Forcefully removing a node](admin_guide.md#force-remove-a-node)
* [Recovering from disaster](#recover-from-disaster) * [Recovering from disaster](admin_guide.md#recover-from-disaster)
Refer to [How nodes work](how-swarm-mode-works/nodes.md) Refer to [How nodes work](how-swarm-mode-works/nodes.md)
for a brief overview of Docker Swarm mode and the difference between manager and for a brief overview of Docker Swarm mode and the difference between manager and
@ -91,7 +91,7 @@ guaranteed if you encounter more than two network partitions.
For example, in a swarm with *5 nodes*, if you lose *3 nodes*, you don't have a For example, in a swarm with *5 nodes*, if you lose *3 nodes*, you don't have a
quorum. Therefore you can't add or remove nodes until you recover one of the quorum. Therefore you can't add or remove nodes until you recover one of the
unavailable manager nodes or recover the swarm with disaster recovery unavailable manager nodes or recover the swarm with disaster recovery
commands. See [Recover from disaster](#recover-from-disaster). commands. See [Recover from disaster](admin_guide.md#recover-from-disaster).
While it is possible to scale a swarm down to a single manager node, it is While it is possible to scale a swarm down to a single manager node, it is
impossible to demote the last manager node. This ensures you maintain access to impossible to demote the last manager node. This ensures you maintain access to
@ -154,7 +154,7 @@ directory:
``` ```
Back up the `raft` data directory often so that you can use it in case of Back up the `raft` data directory often so that you can use it in case of
[disaster recovery](#recover-from-disaster). Then you can take the `raft` [disaster recovery](admin_guide.md#recover-from-disaster). Then you can take the `raft`
directory of one of the manager nodes to restore to a new swarm. directory of one of the manager nodes to restore to a new swarm.
## Monitor swarm health ## Monitor swarm health

View File

@ -19,8 +19,8 @@ cluster of one or more Docker Engines called a swarm. A swarm consists
of one or more nodes: physical or virtual machines running Docker of one or more nodes: physical or virtual machines running Docker
Engine 1.12 or later in swarm mode. Engine 1.12 or later in swarm mode.
There are two types of nodes: [**managers**](#manager-nodes) and There are two types of nodes: [**managers**](nodes.md#manager-nodes) and
[**workers**](#worker-nodes). [**workers**](nodes.md#worker-nodes).
![Swarm mode cluster](../images/swarm-diagram.png) ![Swarm mode cluster](../images/swarm-diagram.png)

View File

@ -23,7 +23,7 @@ running in **swarm mode**. You enable swarm mode for the Engine by either
initializing a swarm or joining an existing swarm. initializing a swarm or joining an existing swarm.
A **swarm** is a cluster of Docker Engines where you deploy A **swarm** is a cluster of Docker Engines where you deploy
[services](#Services-and-tasks). The Docker Engine CLI includes the commands for [services](key-concepts.md#Services-and-tasks). The Docker Engine CLI includes the commands for
swarm management, such as adding and removing nodes. The CLI also includes the swarm management, such as adding and removing nodes. The CLI also includes the
commands you need to deploy services to the swarm and manage service commands you need to deploy services to the swarm and manage service
orchestration. orchestration.
@ -37,7 +37,7 @@ A **node** is an instance of the Docker Engine participating in the swarm.
To deploy your application to a swarm, you submit a service definition to a To deploy your application to a swarm, you submit a service definition to a
**manager node**. The manager node dispatches units of work called **manager node**. The manager node dispatches units of work called
[tasks](#Services-and-tasks) to worker nodes. [tasks](key-concepts.md#Services-and-tasks) to worker nodes.
Manager nodes also perform the orchestration and cluster management functions Manager nodes also perform the orchestration and cluster management functions
required to maintain the desired state of the swarm. Manager nodes elect a single leader to conduct orchestration tasks. required to maintain the desired state of the swarm. Manager nodes elect a single leader to conduct orchestration tasks.

View File

@ -14,10 +14,10 @@ title: Manage nodes in a swarm
As part of the swarm management lifecycle, you may need to view or update a node as follows: As part of the swarm management lifecycle, you may need to view or update a node as follows:
* [list nodes in the swarm](#list-nodes) * [list nodes in the swarm](manage-nodes.md#list-nodes)
* [inspect an individual node](#inspect-an-individual-node) * [inspect an individual node](manage-nodes.md#inspect-an-individual-node)
* [update a node](#update-a-node) * [update a node](manage-nodes.md#update-a-node)
* [leave the swarm](#leave-the-swarm) * [leave the swarm](manage-nodes.md#leave-the-swarm)
## List nodes ## List nodes
@ -95,9 +95,9 @@ Engine Version: 1.12.0-dev
You can modify node attributes as follows: You can modify node attributes as follows:
* [change node availability](#change-node-availability) * [change node availability](manage-nodes.md#change-node-availability)
* [add or remove label metadata](#add-or-remove-label-metadata) * [add or remove label metadata](manage-nodes.md#add-or-remove-label-metadata)
* [change a node role](#promote-or-demote-a-node) * [change a node role](manage-nodes.md#promote-or-demote-a-node)
### Change node availability ### Change node availability
@ -117,7 +117,7 @@ $ docker node update --availability drain node-1
node-1 node-1
``` ```
See [list nodes](#list-nodes) for descriptions of the different availability See [list nodes](manage-nodes.md#list-nodes) for descriptions of the different availability
options. options.
### Add or remove label metadata ### Add or remove label metadata

View File

@ -60,7 +60,7 @@ anixjtol6wdf my_web 1/1 nginx
``` ```
To make the web server accessible from outside the swarm, you need to To make the web server accessible from outside the swarm, you need to
[publish the port](#publish-ports-externally-to-the-swarm) where the swarm [publish the port](services.md#publish-ports-externally-to-the-swarm) where the swarm
listens for web requests. listens for web requests.
You can include a command to run inside containers after the image: You can include a command to run inside containers after the image:

View File

@ -33,10 +33,10 @@ If you are brand new to Docker, see [About Docker Engine](../../index.md).
To run this tutorial, you need the following: To run this tutorial, you need the following:
* [three networked host machines](#three-networked-host-machines) * [three networked host machines](index.md#three-networked-host-machines)
* [Docker Engine 1.12 or later installed](#docker-engine-1-12-or-newer) * [Docker Engine 1.12 or later installed](index.md#docker-engine-1-12-or-newer)
* [the IP address of the manager machine](#the-ip-address-of-the-manager-machine) * [the IP address of the manager machine](index.md#the-ip-address-of-the-manager-machine)
* [open ports between the hosts](#open-ports-between-the-hosts) * [open ports between the hosts](index.md#open-ports-between-the-hosts)
### Three networked host machines ### Three networked host machines
@ -59,9 +59,9 @@ Install Docker Engine and verify that the Docker Engine daemon is running on
each of the machines. You can get the latest version of Docker Engine as each of the machines. You can get the latest version of Docker Engine as
follows: follows:
* [install Docker Engine on Linux machines](#install-docker-engine-on-linux-machines) * [install Docker Engine on Linux machines](index.md#install-docker-engine-on-linux-machines)
* [use Docker for Mac or Docker for Windows](#use-docker-for-mac-or-docker-for-windows) * [use Docker for Mac or Docker for Windows](index.md#use-docker-for-mac-or-docker-for-windows)
#### Install Docker Engine on Linux machines #### Install Docker Engine on Linux machines

View File

@ -34,7 +34,7 @@ containers that bypasses the [*Union File System*](../reference/glossary.md#unio
- Volumes are initialized when a container is created. If the container's - Volumes are initialized when a container is created. If the container's
base image contains data at the specified mount point, that existing data is base image contains data at the specified mount point, that existing data is
copied into the new volume upon volume initialization. (Note that this does copied into the new volume upon volume initialization. (Note that this does
not apply when [mounting a host directory](#mount-a-host-directory-as-a-data-volume).) not apply when [mounting a host directory](dockervolumes.md#mount-a-host-directory-as-a-data-volume).)
- Data volumes can be shared and reused among containers. - Data volumes can be shared and reused among containers.
- Changes to a data volume are made directly. - Changes to a data volume are made directly.
- Changes to a data volume will not be included when you update an image. - Changes to a data volume will not be included when you update an image.

View File

@ -126,7 +126,7 @@ Apache web server and your web application installed. You can build or update
images from scratch or download and use images created by others. An image may be images from scratch or download and use images created by others. An image may be
based on, or may extend, one or more other images. A docker image is described in based on, or may extend, one or more other images. A docker image is described in
text file called a _Dockerfile_, which has a simple, well-defined syntax. For more text file called a _Dockerfile_, which has a simple, well-defined syntax. For more
details about images, see [How does a Docker image work?](#how-does-a-docker-image-work). details about images, see [How does a Docker image work?](understanding-docker.md#how-does-a-docker-image-work).
Docker images are the **build** component of Docker. Docker images are the **build** component of Docker.
@ -137,7 +137,7 @@ a container, you can provide configuration metadata such as networking informati
or environment variables. Each container is an isolated and secure application or environment variables. Each container is an isolated and secure application
platform, but can be given access to resources running in a different host or platform, but can be given access to resources running in a different host or
container, as well as persistent storage or databases. For more details about container, as well as persistent storage or databases. For more details about
containers, see [How does a container work?](#how-does-a-container-work). containers, see [How does a container work?](understanding-docker.md#how-does-a-container-work).
Docker containers are the **run** component of Docker. Docker containers are the **run** component of Docker.
@ -145,7 +145,7 @@ Docker containers are the **run** component of Docker.
A docker registry is a library of images. A registry can be public or private, A docker registry is a library of images. A registry can be public or private,
and can be on the same server as the Docker daemon or Docker client, or on a and can be on the same server as the Docker daemon or Docker client, or on a
totally separate server. For more details about registries, see totally separate server. For more details about registries, see
[How does a Docker registry work?](#how-does-a-docker-registry-work) [How does a Docker registry work?](understanding-docker.md#how-does-a-docker-registry-work)
Docker registries are the **distribution** component of Docker. Docker registries are the **distribution** component of Docker.

View File

@ -300,7 +300,7 @@ linked `web` container will be able to talk to the `db` container.
### Important notes on Docker environment variables ### Important notes on Docker environment variables
Unlike host entries in the [`/etc/hosts` file](#updating-the-etchosts-file), Unlike host entries in the [`/etc/hosts` file](dockerlinks.md#updating-the-etchosts-file),
IP addresses stored in the environment variables are not automatically updated IP addresses stored in the environment variables are not automatically updated
if the source container is restarted. We recommend using the host entries in if the source container is restarted. We recommend using the host entries in
`/etc/hosts` to resolve the IP address of linked containers. `/etc/hosts` to resolve the IP address of linked containers.

View File

@ -16,11 +16,11 @@ network. Docker Engine supports multi-host networking out-of-the-box through the
`overlay` network driver. Unlike `bridge` networks, overlay networks require `overlay` network driver. Unlike `bridge` networks, overlay networks require
some pre-existing conditions before you can create one: some pre-existing conditions before you can create one:
* [Docker Engine running in swarm mode](#overlay-networking-and-swarm-mode) * [Docker Engine running in swarm mode](get-started-overlay.md#overlay-networking-and-swarm-mode)
OR OR
* [A cluster of hosts using a key value store](#overlay-networking-with-an-external-key-value-store) * [A cluster of hosts using a key value store](get-started-overlay.md#overlay-networking-with-an-external-key-value-store)
## Overlay networking and swarm mode ## Overlay networking and swarm mode

View File

@ -43,7 +43,7 @@ giving you a quick over-view of the state of your Docker daemon.
You can click on any container to view its logs (the output of the main container You can click on any container to view its logs (the output of the main container
process), restart, stop or exec `sh` in that container. See [Working with a process), restart, stop or exec `sh` in that container. See [Working with a
container](#working-with-a-container) for more details. container](userguide.md#working-with-a-container) for more details.
## Creating a new container ## Creating a new container

View File

@ -28,7 +28,7 @@ Hyper-V](https://msdn.microsoft.com/en-us/virtualization/hyperv_on_windows/quick
> If you would like to use NAT, create an internal network, and use > If you would like to use NAT, create an internal network, and use
> [Internet Connection Sharing](http://www.packet6.com/allowing-windows-8-1-hyper-v-vm-to-work-with-wifi/). > [Internet Connection Sharing](http://www.packet6.com/allowing-windows-8-1-hyper-v-vm-to-work-with-wifi/).
> >
> * This reference page includes an [example](#example) that shows how to use an elelvated (Administrator-level) PowerShell and how to create and use an external network switch. > * This reference page includes an [example](hyper-v.md#example) that shows how to use an elelvated (Administrator-level) PowerShell and how to create and use an external network switch.
## Usage ## Usage

View File

@ -122,9 +122,9 @@ The examples here show how to create and start a machine, run Docker commands, a
it `default` as shown in the example. If you already have a "default" machine, it `default` as shown in the example. If you already have a "default" machine,
choose another name for this new machine. choose another name for this new machine.
* If you are using Toolbox on Mac, Toolbox on older Windows systems without Hyper-V, or Docker for Mac, use `virtualbox` as the driver, as shown in this example. (The Docker Machine VirtualBox driver reference is [here](drivers/virtualbox.md).) (See [prerequisites](#prerequisite-information) above to learn more.) * If you are using Toolbox on Mac, Toolbox on older Windows systems without Hyper-V, or Docker for Mac, use `virtualbox` as the driver, as shown in this example. (The Docker Machine VirtualBox driver reference is [here](drivers/virtualbox.md).) (See [prerequisites](get-started.md#prerequisite-information) above to learn more.)
* On Docker for Windows systems that support Hyper-V, use the `hyperv` driver as shown in the [Docker Machine Microsoft Hyper-V driver reference](drivers/hyper-v.md). (See [prerequisites](#prerequisite-information) above to learn more.) * On Docker for Windows systems that support Hyper-V, use the `hyperv` driver as shown in the [Docker Machine Microsoft Hyper-V driver reference](drivers/hyper-v.md). (See [prerequisites](get-started.md#prerequisite-information) above to learn more.)
$ docker-machine create --driver virtualbox default $ docker-machine create --driver virtualbox default
Running pre-create checks... Running pre-create checks...

View File

@ -22,7 +22,7 @@ but the path to a different configuration file can be specified using the
## Overview of the file ## Overview of the file
In addition to the configuration file format, please see the optional password In addition to the configuration file format, please see the optional password
[environment variables](#environment-variables-optional) that the Notary client [environment variables](client-config.md#environment-variables-optional) that the Notary client
can take for ease of use. can take for ease of use.
Here is a full client configuration file example; please click on the top level Here is a full client configuration file example; please click on the top level
@ -30,14 +30,14 @@ JSON keys to learn more about the configuration section corresponding to that ke
<pre><code class="language-json">{ <pre><code class="language-json">{
<a href="#trust_dir-section-optional">"trust_dir"</a> : "~/.docker/trust", <a href="client-config.md#trust_dir-section-optional">"trust_dir"</a> : "~/.docker/trust",
<a href="#remote_server-section-optional">"remote_server"</a>: { <a href="client-config.md#remote_server-section-optional">"remote_server"</a>: {
"url": "https://my-notary-server.my-private-registry.com", "url": "https://my-notary-server.my-private-registry.com",
"root-ca": "./fixtures/root-ca.crt", "root-ca": "./fixtures/root-ca.crt",
"tls_client_cert": "./fixtures/secure.example.com.crt", "tls_client_cert": "./fixtures/secure.example.com.crt",
"tls_client_key": "./fixtures/secure.example.com.crt" "tls_client_key": "./fixtures/secure.example.com.crt"
} }
<a href="#trust_pinning-section-optional">"trust_pinning"</a>: { <a href="client-config.md#trust_pinning-section-optional">"trust_pinning"</a>: {
"certs": { "certs": {
"docker.com/notary": ["49cf5c6404a35fa41d5a5aa2ce539dfee0d7a2176d0da488914a38603b1f4292"] "docker.com/notary": ["49cf5c6404a35fa41d5a5aa2ce539dfee0d7a2176d0da488914a38603b1f4292"]
} }

View File

@ -26,12 +26,12 @@ Here is a full server configuration file example; please click on the top level
learn more about the configuration section corresponding to that key: learn more about the configuration section corresponding to that key:
<pre><code class="language-json">{ <pre><code class="language-json">{
<a href="#server-section-required">"server"</a>: { <a href="server-config.md#server-section-required">"server"</a>: {
"http_addr": ":4443", "http_addr": ":4443",
"tls_key_file": "./fixtures/notary-server.key", "tls_key_file": "./fixtures/notary-server.key",
"tls_cert_file": "./fixtures/notary-server.crt" "tls_cert_file": "./fixtures/notary-server.crt"
}, },
<a href="#trust-service-section-required">"trust_service"</a>: { <a href="server-config.md#trust-service-section-required">"trust_service"</a>: {
"type": "remote", "type": "remote",
"hostname": "notarysigner", "hostname": "notarysigner",
"port": "7899", "port": "7899",
@ -40,11 +40,11 @@ learn more about the configuration section corresponding to that key:
"tls_client_cert": "./fixtures/notary-server.crt", "tls_client_cert": "./fixtures/notary-server.crt",
"tls_client_key": "./fixtures/notary-server.key" "tls_client_key": "./fixtures/notary-server.key"
}, },
<a href="#storage-section-required">"storage"</a>: { <a href="server-config.md#storage-section-required">"storage"</a>: {
"backend": "mysql", "backend": "mysql",
"db_url": "user:pass@tcp(notarymysql:3306)/databasename?parseTime=true" "db_url": "user:pass@tcp(notarymysql:3306)/databasename?parseTime=true"
}, },
<a href="#auth-section-optional">"auth"</a>: { <a href="server-config.md#auth-section-optional">"auth"</a>: {
"type": "token", "type": "token",
"options": { "options": {
"realm": "https://auth.docker.io/token", "realm": "https://auth.docker.io/token",
@ -62,13 +62,13 @@ learn more about the configuration section corresponding to that key:
"release_stage": "production" "release_stage": "production"
} }
}, },
<a href="#caching-section-optional">"caching"</a>: { <a href="server-config.md#caching-section-optional">"caching"</a>: {
"max_age": { "max_age": {
"current_metadata": 300, "current_metadata": 300,
"consistent_metadata": 31536000, "consistent_metadata": 31536000,
} }
}, },
<a href="#repositories-section-optional">"repositories"</a>: { <a href="server-config.md#repositories-section-optional">"repositories"</a>: {
"gun_prefixes": ["docker.io/", "my-own-registry.com/"] "gun_prefixes": ["docker.io/", "my-own-registry.com/"]
} }
} }

View File

@ -16,7 +16,7 @@ want to specify custom options.
## Overview ## Overview
Notary signer [requires environment variables](#environment-variables-required-if-using-mysql) Notary signer [requires environment variables](signer-config.md#environment-variables-required-if-using-mysql)
to encrypt private keys at rest. It also requires a configuration file, the path to which is to encrypt private keys at rest. It also requires a configuration file, the path to which is
specified on the command line using the `-config` flag. specified on the command line using the `-config` flag.
@ -24,7 +24,7 @@ Here is a full signer configuration file example; please click on the top level
learn more about the configuration section corresponding to that key: learn more about the configuration section corresponding to that key:
<pre><code class="language-json">{ <pre><code class="language-json">{
<a href="#server-section-required">"server"</a>: { <a href="signer-config.md#server-section-required">"server"</a>: {
"http_addr": ":4444", "http_addr": ":4444",
"grpc_addr": ":7899", "grpc_addr": ":7899",
"tls_cert_file": "./fixtures/notary-signer.crt", "tls_cert_file": "./fixtures/notary-signer.crt",
@ -34,7 +34,7 @@ learn more about the configuration section corresponding to that key:
<a href="../common-configs/#logging-section-optional">"logging"</a>: { <a href="../common-configs/#logging-section-optional">"logging"</a>: {
"level": 2 "level": 2
}, },
<a href="#storage-section-required">"storage"</a>: { <a href="signer-config.md#storage-section-required">"storage"</a>: {
"backend": "mysql", "backend": "mysql",
"db_url": "user:pass@tcp(notarymysql:3306)/databasename?parseTime=true", "db_url": "user:pass@tcp(notarymysql:3306)/databasename?parseTime=true",
"default_alias": "passwordalias1" "default_alias": "passwordalias1"
@ -173,7 +173,7 @@ Example:
private keys will be encrypted using this password, which private keys will be encrypted using this password, which
must also be provided as the environment variable must also be provided as the environment variable
<code>NOTARY_SIGNER_&lt;DEFAULT_ALIAS_VALUE&gt;</code>. <code>NOTARY_SIGNER_&lt;DEFAULT_ALIAS_VALUE&gt;</code>.
Please see the <a href="#environment-variables-required-if-using-mysql">environment variable</a> Please see the <a href="signer-config.md#environment-variables-required-if-using-mysql">environment variable</a>
section for more information.</td> section for more information.</td>
</tr> </tr>
</table> </table>

View File

@ -63,7 +63,7 @@ the IP address of your Docker host.
Both the Notary server and the Notary signer take Both the Notary server and the Notary signer take
[JSON configuration files](reference/index.md). Pre-built images, such as [JSON configuration files](reference/index.md). Pre-built images, such as
the [development images above](#run-a-service-for-testing-or-development) the [development images above](running_a_service.md#run-a-service-for-testing-or-development)
provide these configuration files for you with some sane defaults. provide these configuration files for you with some sane defaults.
However, for running in production, or if you just want to change those defaults However, for running in production, or if you just want to change those defaults

View File

@ -14,12 +14,12 @@ title: FAQ for contributors
This section contains some frequently asked questions and tips for This section contains some frequently asked questions and tips for
troubleshooting problems in your code contribution. troubleshooting problems in your code contribution.
- [How do I set my signature?](#how-do-i-set-my-signature:cb7f612e17aad7eb26c06709ef92a867) - [How do I set my signature?](FAQ.md#how-do-i-set-my-signature:cb7f612e17aad7eb26c06709ef92a867)
- [How do I track changes from the docker repo upstream?](#how-do-i-track-changes-from-the-docker-repo-upstream:cb7f612e17aad7eb26c06709ef92a867) - [How do I track changes from the docker repo upstream?](FAQ.md#how-do-i-track-changes-from-the-docker-repo-upstream:cb7f612e17aad7eb26c06709ef92a867)
- [How do I format my Go code?](#how-do-i-format-my-go-code:cb7f612e17aad7eb26c06709ef92a867) - [How do I format my Go code?](FAQ.md#how-do-i-format-my-go-code:cb7f612e17aad7eb26c06709ef92a867)
- [What is the pre-pull request checklist?](#what-is-the-pre-pull-request-checklist:cb7f612e17aad7eb26c06709ef92a867) - [What is the pre-pull request checklist?](FAQ.md#what-is-the-pre-pull-request-checklist:cb7f612e17aad7eb26c06709ef92a867)
- [How should I comment my code?](#how-should-i-comment-my-code:cb7f612e17aad7eb26c06709ef92a867) - [How should I comment my code?](FAQ.md#how-should-i-comment-my-code:cb7f612e17aad7eb26c06709ef92a867)
- [How do I rebase my feature branch?](#how-do-i-rebase-my-feature-branch:cb7f612e17aad7eb26c06709ef92a867) - [How do I rebase my feature branch?](FAQ.md#how-do-i-rebase-my-feature-branch:cb7f612e17aad7eb26c06709ef92a867)
## How do I set my signature {#how-do-i-set-my-signature} ## How do I set my signature {#how-do-i-set-my-signature}

View File

@ -78,7 +78,7 @@ pull request</a>.
![Sign commits and issues](images/bonus.png) ![Sign commits and issues](images/bonus.png)
We have also have checklist that describes [what each pull request We have also have checklist that describes [what each pull request
needs](#what-is-the-pre-pull-request-checklist). needs](code.md#what-is-the-pre-pull-request-checklist).
7. <a href="http://docs.docker.com/project/review-pr/" 7. <a href="http://docs.docker.com/project/review-pr/"

View File

@ -133,7 +133,7 @@ for titles](http://www.quickanddirtytips.com/education/grammar/capitalizing-titl
We prefer one space after a period at the end of a sentence, not two. We prefer one space after a period at the end of a sentence, not two.
See [lists](#lists) below for how to punctuate list items. See [lists](doc-style.md#lists) below for how to punctuate list items.
### Abbreviations and acronyms ### Abbreviations and acronyms
@ -257,7 +257,7 @@ In order to write clear, useful commit messages, please follow these
For accessibility and usability reasons, avoid using phrases such as "click For accessibility and usability reasons, avoid using phrases such as "click
here" for link text. Recast your sentence so that the link text describes the here" for link text. Recast your sentence so that the link text describes the
content of the link, as we did in the content of the link, as we did in the
["Commit messages" section](#commit-messages) above. ["Commit messages" section](doc-style.md#commit-messages) above.
You can use relative links (../linkeditem) to link to other pages in Docker's You can use relative links (../linkeditem) to link to other pages in Docker's
documentation. documentation.

View File

@ -131,7 +131,7 @@ by entering the following command into the webchat command line bar:
Your nickname is now registered to chat on freenode.net. Your nickname is now registered to chat on freenode.net.
[Jump ahead to tips to join a docker channel and start chatting](#tips) [Jump ahead to tips to join a docker channel and start chatting](get-help.md#tips)
## IRCCloud ## IRCCloud
@ -151,7 +151,7 @@ form. People who have already registered with IRCCloud can select the "sign in
here" link. Additionally, people who are already registered with IRCCloud may here" link. Additionally, people who are already registered with IRCCloud may
have a cookie stored on their web browser that enables a quick start "let's go" have a cookie stored on their web browser that enables a quick start "let's go"
link to be shown instead of the above form. In this case just select the link to be shown instead of the above form. In this case just select the
"let's go" link and [jump ahead to start chatting](#start-chatting) "let's go" link and [jump ahead to start chatting](get-help.md#start-chatting)
3. After entering your email address in the form, check your email for an invite 3. After entering your email address in the form, check your email for an invite
from IRCCloud and follow the instructions provided in the email. from IRCCloud and follow the instructions provided in the email.

View File

@ -341,7 +341,7 @@ Refer to `loglevel` to configure the level of messages printed.
## loglevel ## loglevel
> **DEPRECATED:** Please use [log](#log) instead. > **DEPRECATED:** Please use [log](configuration.md#log) instead.
loglevel: debug loglevel: debug
@ -1251,7 +1251,7 @@ Declare parameters for constructing the redis connections. Registry instances
may use the Redis instance for several applications. The current purpose is may use the Redis instance for several applications. The current purpose is
caching information about immutable blobs. Most of the options below control caching information about immutable blobs. Most of the options below control
how the registry connects to redis. You can control the pool's behavior how the registry connects to redis. You can control the pool's behavior
with the [pool](#pool) subsection. with the [pool](configuration.md#pool) subsection.
It's advisable to configure Redis itself with the **allkeys-lru** eviction policy It's advisable to configure Redis itself with the **allkeys-lru** eviction policy
as the registry does not set an expire value on keys. as the registry does not set an expire value on keys.

View File

@ -154,7 +154,7 @@ Except for registries running on secure local networks, registries should always
The simplest way to achieve access restriction is through basic authentication (this is very similar to other web servers' basic authentication mechanism). The simplest way to achieve access restriction is through basic authentication (this is very similar to other web servers' basic authentication mechanism).
> **Warning**: You **cannot** use authentication with an insecure registry. You have to [configure TLS first](#running-a-domain-registry) for this to work. > **Warning**: You **cannot** use authentication with an insecure registry. You have to [configure TLS first](deploying.md#running-a-domain-registry) for this to work.
First create a password file with one entry for the user "testuser", with password "testpassword": First create a password file with one entry for the user "testuser", with password "testpassword":

View File

@ -11,7 +11,7 @@ This page contains definitions for distribution related terms.
<dd> <dd>
<blockquote>A blob is any kind of content that is stored by a Registry under a content-addressable identifier (a "digest").</blockquote> <blockquote>A blob is any kind of content that is stored by a Registry under a content-addressable identifier (a "digest").</blockquote>
<p> <p>
<a href="#layer">Layers</a> are a good example of "blobs". <a href="glossary.md#layer">Layers</a> are a good example of "blobs".
</p> </p>
</dd> </dd>
@ -19,9 +19,9 @@ This page contains definitions for distribution related terms.
<dd> <dd>
<blockquote>An image is a named set of immutable data from which a Docker container can be created.</blockquote> <blockquote>An image is a named set of immutable data from which a Docker container can be created.</blockquote>
<p> <p>
An image is represented by a json file called a <a href="#manifest">manifest</a>, and is conceptually a set of <a hred="#layer">layers</a>. An image is represented by a json file called a <a href="glossary.md#manifest">manifest</a>, and is conceptually a set of <a hred="glossary.md#layer">layers</a>.
Image names indicate the location where they can be pulled from and pushed to, as they usually start with a <a href="#registry">registry</a> domain name and port. Image names indicate the location where they can be pulled from and pushed to, as they usually start with a <a href="glossary.md#registry">registry</a> domain name and port.
</p> </p>
</dd> </dd>
@ -30,7 +30,7 @@ This page contains definitions for distribution related terms.
<dd> <dd>
<blockquote>A layer is a tar archive bundling partial content from a filesystem.</blockquote> <blockquote>A layer is a tar archive bundling partial content from a filesystem.</blockquote>
<p> <p>
Layers from an <a href="#image">image</a> are usually extracted in order on top of each other to make up a root filesystem from which containers run out. Layers from an <a href="glossary.md#image">image</a> are usually extracted in order on top of each other to make up a root filesystem from which containers run out.
</p> </p>
</dd> </dd>
@ -45,7 +45,7 @@ This page contains definitions for distribution related terms.
</dd> </dd>
<dt id="registry"><h4>Registry</h4></dt> <dt id="registry"><h4>Registry</h4></dt>
<dd><blockquote>A registry is a service that let you store and deliver <a href="#images">images</a>.</blockquote> <dd><blockquote>A registry is a service that let you store and deliver <a href="glossary.md#images">images</a>.</blockquote>
</dd> </dd>
<dt id="registry"><h4>Repository</h4></dt> <dt id="registry"><h4>Repository</h4></dt>
@ -57,7 +57,7 @@ This page contains definitions for distribution related terms.
<dd><blockquote>A scope is the portion of a namespace onto which a given authorization token is granted.</blockquote></dd> <dd><blockquote>A scope is the portion of a namespace onto which a given authorization token is granted.</blockquote></dd>
<dt id="tag"><h4>Tag</h4></dt> <dt id="tag"><h4>Tag</h4></dt>
<dd><blockquote>A tag is conceptually a "version" of a <a href="#image">named image</a>.</blockquote> <dd><blockquote>A tag is conceptually a "version" of a <a href="glossary.md#image">named image</a>.</blockquote>
<p> <p>
Example: `docker pull myimage:latest` instructs docker to pull the image "myimage" in version "latest". Example: `docker pull myimage:latest` instructs docker to pull the image "myimage" in version "latest".
</p> </p>

View File

@ -15,7 +15,7 @@ The Registry supports sending webhook notifications in response to events
happening within the registry. Notifications are sent in response to manifest happening within the registry. Notifications are sent in response to manifest
pushes and pulls and layer pushes and pulls. These actions are serialized into pushes and pulls and layer pushes and pulls. These actions are serialized into
events. The events are queued into a registry-internal broadcast system which events. The events are queued into a registry-internal broadcast system which
queues and dispatches events to [_Endpoints_](#endpoints). queues and dispatches events to [_Endpoints_](notifications.md#endpoints).
![](images/notifications.png) ![](images/notifications.png)

View File

@ -258,7 +258,7 @@ All endpoints should support aggressive http caching, compression and range
headers, where appropriate. The new API attempts to leverage HTTP semantics headers, where appropriate. The new API attempts to leverage HTTP semantics
where possible but may break from standards to implement targeted features. where possible but may break from standards to implement targeted features.
For detail on individual endpoints, please see the [_Detail_](#detail) For detail on individual endpoints, please see the [_Detail_](api.md#detail)
section. section.
### Errors ### Errors
@ -288,7 +288,7 @@ error codes as `UNKNOWN`, allowing future error codes to be added without
breaking API compatibility. For the purposes of the specification error codes breaking API compatibility. For the purposes of the specification error codes
will only be added and never removed. will only be added and never removed.
For a complete account of all error codes, please see the [_Errors_](#errors-2) For a complete account of all error codes, please see the [_Errors_](api.md#errors-2)
section. section.
### API Version Check ### API Version Check
@ -622,7 +622,7 @@ Content-Type: application/octet-stream
``` ```
The "digest" parameter must be included with the PUT request. Please see the The "digest" parameter must be included with the PUT request. Please see the
[_Completed Upload_](#completed-upload) section for details on the parameters [_Completed Upload_](api.md#completed-upload) section for details on the parameters
and expected responses. and expected responses.
##### Chunked Upload ##### Chunked Upload
@ -848,7 +848,7 @@ in [manifest-v2-1.md](manifest-v2-1.md) and [manifest-v2-2.md](manifest-v2-2.md)
If there is a problem with pushing the manifest, a relevant 4xx response will If there is a problem with pushing the manifest, a relevant 4xx response will
be returned with a JSON error message. Please see the be returned with a JSON error message. Please see the
[_PUT Manifest_](#put-manifest) section for details on possible error codes that [_PUT Manifest_](api.md#put-manifest) section for details on possible error codes that
may be returned. may be returned.
If one or more layers are unknown to the registry, `BLOB_UNKNOWN` errors are If one or more layers are unknown to the registry, `BLOB_UNKNOWN` errors are
@ -912,7 +912,7 @@ explicitly requested. In this case the `Link` header will be returned along
with the results, and subsequent results can be obtained by following the link with the results, and subsequent results can be obtained by following the link
as if pagination had been initially requested. as if pagination had been initially requested.
For details of the `Link` header, please see the [_Pagination_](#pagination) For details of the `Link` header, please see the [_Pagination_](api.md#pagination)
section. section.
#### Pagination #### Pagination
@ -5482,8 +5482,3 @@ The following headers will be returned with the response:
|----|-----------| |----|-----------|
|`Content-Length`|Length of the JSON response body.| |`Content-Length`|Length of the JSON response body.|
|`Link`|RFC5988 compliant rel='next' with URL to next result set, if available| |`Link`|RFC5988 compliant rel='next' with URL to next result set, if available|

View File

@ -21,15 +21,15 @@ CA's certificate as well as their own key-pair signed by the CA.
You will complete the following steps in this procedure: You will complete the following steps in this procedure:
- [Step 1: Set up the prerequisites](#step-1-set-up-the-prerequisites) - [Step 1: Set up the prerequisites](configure-tls.md#step-1-set-up-the-prerequisites)
- [Step 2: Create a Certificate Authority (CA) server](#step-2-create-a-certificate-authority-ca-server) - [Step 2: Create a Certificate Authority (CA) server](configure-tls.md#step-2-create-a-certificate-authority-ca-server)
- [Step 3: Create and sign keys](#step-3-create-and-sign-keys) - [Step 3: Create and sign keys](configure-tls.md#step-3-create-and-sign-keys)
- [Step 4: Install the keys](#step-4-install-the-keys) - [Step 4: Install the keys](configure-tls.md#step-4-install-the-keys)
- [Step 5: Configure the Engine daemon for TLS](#step-5-configure-the-engine-daemon-for-tls) - [Step 5: Configure the Engine daemon for TLS](configure-tls.md#step-5-configure-the-engine-daemon-for-tls)
- [Step 6: Create a Swarm cluster](#step-6-create-a-swarm-cluster) - [Step 6: Create a Swarm cluster](configure-tls.md#step-6-create-a-swarm-cluster)
- [Step 7: Create the Swarm Manager using TLS](#step-7-create-the-swarm-manager-using-tls) - [Step 7: Create the Swarm Manager using TLS](configure-tls.md#step-7-create-the-swarm-manager-using-tls)
- [Step 8: Test the Swarm manager configuration](#step-8-test-the-swarm-manager-configuration) - [Step 8: Test the Swarm manager configuration](configure-tls.md#step-8-test-the-swarm-manager-configuration)
- [Step 9: Configure the Engine CLI to use TLS](#step-9-configure-the-engine-cli-to-use-tls) - [Step 9: Configure the Engine CLI to use TLS](configure-tls.md#step-9-configure-the-engine-cli-to-use-tls)
### Before you begin ### Before you begin
The article includes steps to create your own CA using OpenSSL. This is similar The article includes steps to create your own CA using OpenSSL. This is similar

View File

@ -15,15 +15,15 @@ This page teaches you to deploy a high-availability Docker Swarm cluster.
Although the example installation uses the Amazon Web Services (AWS) platform, Although the example installation uses the Amazon Web Services (AWS) platform,
you can deploy an equivalent Docker Swarm cluster on many other platforms. In this example, you do the following: you can deploy an equivalent Docker Swarm cluster on many other platforms. In this example, you do the following:
- [Verify you have the prerequisites](#prerequisites) - [Verify you have the prerequisites](install-manual.md#prerequisites)
- [Establish basic network security](#step-1-add-network-security-rules) - [Establish basic network security](install-manual.md#step-1-add-network-security-rules)
- [Create your nodes](#step-2-create-your-instances) - [Create your nodes](install-manual.md#step-2-create-your-instances)
- [Install Engine on each node](#step-3-install-engine-on-each-node) - [Install Engine on each node](install-manual.md#step-3-install-engine-on-each-node)
- [Configure a discovery backend](#step-4-set-up-a-discovery-backend) - [Configure a discovery backend](install-manual.md#step-4-set-up-a-discovery-backend)
- [Create Swarm cluster](#step-5-create-swarm-cluster) - [Create Swarm cluster](install-manual.md#step-5-create-swarm-cluster)
- [Communicate with the Swarm](#step-6-communicate-with-the-swarm) - [Communicate with the Swarm](install-manual.md#step-6-communicate-with-the-swarm)
- [Test the high-availability Swarm managers](#step-7-test-swarm-failover) - [Test the high-availability Swarm managers](install-manual.md#step-7-test-swarm-failover)
- [Additional Resources](#additional-resources) - [Additional Resources](install-manual.md#additional-resources)
For a gentler introduction to Swarm, try the [Evaluate Swarm in a sandbox](install-w-machine.md) page. For a gentler introduction to Swarm, try the [Evaluate Swarm in a sandbox](install-w-machine.md) page.

Some files were not shown because too many files have changed in this diff Show More