Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _data/advisories.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ texts:
toolbox: "**Legacy desktop solution.** Docker Toolbox is for older Mac and Windows systems that do not meet the requirements of [Docker Desktop for Mac](/docker-for-mac/) and [Docker Desktop for Windows](/docker-for-windows/). We recommend updating to the newer applications, if possible."
kitematic: "**Legacy desktop solution.** Kitematic is a legacy solution, bundled with [Docker Toolbox](/toolbox/overview/). We recommend updating to [Docker Desktop for Mac](/docker-for-mac/) or [Docker Desktop for Windows](/docker-for-windows/) if your system meets the requirements for one of those applications."
swarm: "See [Swarm mode overview](/engine/swarm/) for the orchestration features introduced in Docker Engine 1.12. Only refer to the Docker Swarm documents below for information on the standalone Swarm product."
swarm-standalone: "**You are viewing docs for legacy standalone Swarm.** These topics describe standalone Docker Swarm. In Docker 1.12 and higher, [Swarm mode](/engine/swarm/) is integrated with Docker Engine. Most users should use integrated Swarm mode — a good place to start is [Getting started with swarm mode](/engine/swarm/swarm-tutorial/), [Swarm mode CLI commands](/engine/swarm/index.md#swarm-mode-cli-commands), and the [Get started with Docker walkthrough](/get-started/)). Standalone Docker Swarm is not integrated into the Docker Engine API and CLI commands."
swarm-standalone: "**You are viewing docs for legacy standalone Swarm.** These topics describe standalone Docker Swarm. In Docker 1.12 and higher, [Swarm mode](/engine/swarm/) is integrated with Docker Engine. Most users should use integrated Swarm mode — a good place to start is [Getting started with swarm mode](/engine/swarm/swarm-tutorial/), [Swarm mode CLI commands](/engine/swarm/#swarm-mode-cli-commands), and the [Get started with Docker walkthrough](/get-started/)). Standalone Docker Swarm is not integrated into the Docker Engine API and CLI commands."
engine: "This site contains documentation for the v1.12 release candidate version of Docker Engine. For the Docker Engine v1.11 docs, see [https://docs.docker.com/v1.11/](https://docs.docker.com/v1.11/). Docker Desktop for Mac and Docker Desktop for Windows are currently in Beta."


Expand Down
12 changes: 6 additions & 6 deletions compose/aspnet-mssql-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Compose to set up and run the sample ASP.NET Core application using the
[.NET Core SDK image](https://hub.docker.com/_/microsoft-dotnet-core-sdk)
with the
[SQL Server on Linux image](https://hub.docker.com/_/microsoft-mssql-server).
You just need to have [Docker Engine](/get-docker.md)
and [Docker Compose](/compose/install.md) installed on your
You just need to have [Docker Engine](../get-docker.md)
and [Docker Compose](install.md) installed on your
platform of choice: Linux, Mac or Windows.

For this sample, we create a sample .NET Core Web Application using the
Expand All @@ -25,8 +25,8 @@ configure this app to use our SQL Server database, and then create a
1. Create a new directory for your application.

This directory is the context of your docker-compose project. For
[Docker Desktop for Windows](/docker-for-windows/index.md#file-sharing) and
[Docker Desktop for Mac](/docker-for-mac/index.md#file-sharing), you
[Docker Desktop for Windows](../docker-for-windows/index.md#file-sharing) and
[Docker Desktop for Mac](../docker-for-mac/index.md#file-sharing), you
need to set up file sharing for the volume that you need to map.

1. Within your directory, use the `dotnet:2.1-sdk` Docker image to generate a
Expand Down Expand Up @@ -173,8 +173,8 @@ configure this app to use our SQL Server database, and then create a

1. Make sure you allocate at least 2GB of memory to Docker Engine. Here is how
to do it on
[Docker Desktop for Mac](/docker-for-mac/index.md#advanced) and
[Docker Desktop for Windows](/docker-for-windows/index.md#advanced).
[Docker Desktop for Mac](../docker-for-mac/index.md#advanced) and
[Docker Desktop for Windows](../docker-for-windows/index.md#advanced).
This is necessary to run the SQL Server on Linux container.

1. Run the `docker-compose up` command. After a few seconds, you should be able
Expand Down
4 changes: 2 additions & 2 deletions compose/completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,5 +121,5 @@ Enjoy working with Compose faster and with fewer typos!
- [Get started with Django](django.md)
- [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md)
- [Command line reference](/compose/reference/index.md)
- [Compose file reference](/compose/compose-file/index.md)
- [Command line reference](reference/index.md)
- [Compose file reference](compose-file/index.md)
24 changes: 12 additions & 12 deletions compose/compose-file/compose-file-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ cap_drop:
```

> **Note**: These options are ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.

### command
Expand All @@ -111,7 +111,7 @@ command: bundle exec thin -p 3000
```

The command can also be a list, in a manner similar to
[dockerfile](/engine/reference/builder.md#cmd):
[dockerfile](../../engine/reference/builder.md#cmd):

```yaml
command: ["bundle", "exec", "thin", "-p", "3000"]
Expand Down Expand Up @@ -184,7 +184,7 @@ entrypoint: /code/entrypoint.sh
```

The entrypoint can also be a list, in a manner similar to
[dockerfile](/engine/reference/builder.md#entrypoint):
[dockerfile](../../engine/reference/builder.md#entrypoint):

```yaml
entrypoint: ["php", "-d", "memory_limit=-1", "vendor/bin/phpunit"]
Expand Down Expand Up @@ -332,7 +332,7 @@ indefinitely. Compose does not support circular references and `docker-compose`
returns an error if it encounters one.

For more on `extends`, see the
[the extends documentation](/compose/extends.md#extending-services).
[the extends documentation](../extends.md#extending-services).

### external_links

Expand Down Expand Up @@ -396,7 +396,7 @@ options and tags it with the specified tag.

### labels

Add metadata to containers using [Docker labels](/config/labels-custom-metadata.md). You can use either an array or a dictionary.
Add metadata to containers using [Docker labels](../../config/labels-custom-metadata.md). You can use either an array or a dictionary.

It's recommended that you use reverse-DNS notation to prevent your labels from conflicting with those used by other software.

Expand All @@ -420,7 +420,7 @@ Link to containers in another service. Either specify both the service name and
a link alias (`"SERVICE:ALIAS"`), or just the service name.

> Links are a legacy option. We recommend using
> [networks](/compose/networking.md) instead.
> [networks](../networking.md) instead.

```yaml
web:
Expand Down Expand Up @@ -603,7 +603,7 @@ There are several things to note, depending on which
For example, if you specify a mapping of `./foo:/data`, the `./foo` part
is passed straight to the volume driver without being expanded.

See [Docker Volumes](/storage/volumes.md) and
See [Docker Volumes](../../storage/volumes.md) and
[Volume Plugins](/engine/extend/plugins_volume/) for more information.

### volumes_from
Expand All @@ -621,7 +621,7 @@ volumes_from:
### cpu\_shares, cpu\_quota, cpuset, domainname, hostname, ipc, mac\_address, mem\_limit, memswap\_limit, mem\_swappiness, privileged, read\_only, restart, shm\_size, stdin\_open, tty, user, working\_dir

Each of these is a single value, analogous to its
[docker run](/engine/reference/run.md) counterpart.
[docker run](../../engine/reference/run.md) counterpart.

```yaml
cpu_shares: 73
Expand Down Expand Up @@ -650,8 +650,8 @@ tty: true

## Compose documentation

- [User guide](/compose/index.md)
- [Installing Compose](/compose/install.md)
- [User guide](../index.md)
- [Installing Compose](../install.md)
- [Compose file versions and upgrading](compose-versioning.md)
- [Samples](/samples/index.md)
- [Command line reference](/compose/reference/index.md)
- [Samples](../../samples/index.md)
- [Command line reference](../reference/index.md)
56 changes: 28 additions & 28 deletions compose/compose-file/compose-file-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ build:
> In your Dockerfile, if you specify `ARG` before the `FROM` instruction,
> `ARG` is not available in the build instructions under `FROM`.
> If you need an argument to be available in both places, also specify it under
> the `FROM` instruction. Refer to the [understand how ARGS and FROM interact](/engine/reference/builder.md#understand-how-arg-and-from-interact)
> the `FROM` instruction. Refer to the [understand how ARGS and FROM interact](../../engine/reference/builder.md#understand-how-arg-and-from-interact)
> section in the documentation for usage details.

You can omit the value when specifying a build argument, in which case its value
Expand Down Expand Up @@ -271,7 +271,7 @@ An entry with the ip address and hostname is created in `/etc/hosts` inside cont
Specify a build’s container isolation technology. On Linux, the only supported value
is `default`. On Windows, acceptable values are `default`, `process` and
`hyperv`. Refer to the
[Docker Engine docs](/engine/reference/commandline/run.md#specify-isolation-technology-for-container---isolation)
[Docker Engine docs](../../engine/reference/commandline/run.md#specify-isolation-technology-for-container---isolation)
for details.

If unspecified, Compose will use the `isolation` value found in the service's definition
Expand All @@ -281,7 +281,7 @@ to determine the value to use for builds.

> Added in [version 2.1](compose-versioning.md#version-21) file format

Add metadata to the resulting image using [Docker labels](/config/labels-custom-metadata.md).
Add metadata to the resulting image using [Docker labels](../../config/labels-custom-metadata.md).
You can use either an array or a dictionary.

It's recommended that you use reverse-DNS notation to prevent your labels from
Expand Down Expand Up @@ -357,7 +357,7 @@ build:
> Added in [version 2.3](compose-versioning.md#version-23) file format

Build the specified stage as defined inside the `Dockerfile`. See the
[multi-stage build docs](/develop/develop-images/multistage-build.md) for
[multi-stage build docs](../../develop/develop-images/multistage-build.md) for
details.

```yaml
Expand Down Expand Up @@ -397,7 +397,7 @@ command: bundle exec thin -p 3000
```

The command can also be a list, in a manner similar to
[dockerfile](/engine/reference/builder.md#cmd):
[dockerfile](../../engine/reference/builder.md#cmd):

```yaml
command: ["bundle", "exec", "thin", "-p", "3000"]
Expand Down Expand Up @@ -490,7 +490,7 @@ services:
>
> `depends_on` does not wait for `db` and `redis` to be "ready" before
> starting `web` - only until they have been started. If you need to wait
> for a service to be ready, see [Controlling startup order](/compose/startup-order.md)
> for a service to be ready, see [Controlling startup order](../startup-order.md)
> for more on this problem and strategies for solving it.

> Added in [version 2.1](compose-versioning.md#version-21) file format.
Expand Down Expand Up @@ -572,7 +572,7 @@ entrypoint: /code/entrypoint.sh
```

The entrypoint can also be a list, in a manner similar to
[dockerfile](/engine/reference/builder.md#entrypoint):
[dockerfile](../../engine/reference/builder.md#entrypoint):

```yaml
entrypoint: ["php", "-d", "memory_limit=-1", "vendor/bin/phpunit"]
Expand Down Expand Up @@ -728,7 +728,7 @@ indefinitely. Compose does not support circular references and `docker-compose`
returns an error if it encounters one.

For more on `extends`, see the
[the extends documentation](/compose/extends.md#extending-services).
[the extends documentation](../extends.md#extending-services).

### external_links

Expand Down Expand Up @@ -776,7 +776,7 @@ host system to be added. An example of where this is useful is when multiple
containers (running as different users) need to all read or write the same
file on the host system. That file can be owned by a group shared by all the
containers, and specified in `group_add`. See the
[Docker documentation](/engine/reference/run.md#additional-groups) for more
[Docker documentation](../../engine/reference/run.md#additional-groups) for more
details.

A full example:
Expand All @@ -800,7 +800,7 @@ used.

Configure a check that's run to determine whether or not containers for this
service are "healthy". See the docs for the
[HEALTHCHECK Dockerfile instruction](/engine/reference/builder.md#healthcheck)
[HEALTHCHECK Dockerfile instruction](../../engine/reference/builder.md#healthcheck)
for details on how healthchecks work.

```yaml
Expand Down Expand Up @@ -889,7 +889,7 @@ services:
> The default init binary that is used is [Tini](https://github.com/krallin/tini),
> and is installed in `/usr/libexec/docker-init` on the daemon host. You can
> configure the daemon to use a custom init binary through the
> [`init-path` configuration option](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
> [`init-path` configuration option](../../engine/reference/commandline/dockerd.md#daemon-configuration-file).

### isolation

Expand All @@ -898,12 +898,12 @@ services:
Specify a container’s isolation technology. On Linux, the only supported value
is `default`. On Windows, acceptable values are `default`, `process` and
`hyperv`. Refer to the
[Docker Engine docs](/engine/reference/commandline/run.md#specify-isolation-technology-for-container---isolation)
[Docker Engine docs](../../engine/reference/commandline/run.md#specify-isolation-technology-for-container---isolation)
for details.

### labels

Add metadata to containers using [Docker labels](/config/labels-custom-metadata.md). You can use either an array or a dictionary.
Add metadata to containers using [Docker labels](../../config/labels-custom-metadata.md). You can use either an array or a dictionary.

It's recommended that you use reverse-DNS notation to prevent your labels from conflicting with those used by other software.

Expand Down Expand Up @@ -942,7 +942,7 @@ the alias, or the service name if no alias was specified.

Links are not required to enable services to communicate - by default,
any service can reach any other service at that service’s name. (See also, the
[Links topic in Networking in Compose](/compose/networking.md#links).)
[Links topic in Networking in Compose](../networking.md#links).)

Links also express dependency between services in the same way as
[depends_on](#depends_on), so they determine the order of service startup.
Expand All @@ -966,7 +966,7 @@ logging:

The `driver` name specifies a logging driver for the service's
containers, as with the ``--log-driver`` option for docker run
([documented here](/config/containers/logging/configure.md)).
([documented here](../../config/containers/logging/configure.md)).

The default value is json-file.

Expand Down Expand Up @@ -1296,7 +1296,7 @@ web:
Specify the default number of containers to deploy for this service. Whenever
you run `docker-compose up`, Compose creates or removes containers to match
the specified number. This value can be overridden using the
[`--scale`](/compose/reference/up.md) flag.
[`--scale`](../reference/up.md) flag.

```yaml
web:
Expand Down Expand Up @@ -1497,7 +1497,7 @@ volumes:
> When creating bind mounts, using the long syntax requires the
> referenced folder to be created beforehand. Using the short syntax
> creates the folder on the fly if it doesn't exist.
> See the [bind mounts documentation](/storage/bind-mounts.md#differences-between--v-and---mount-behavior)
> See the [bind mounts documentation](../../storage/bind-mounts.md#differences-between--v-and---mount-behavior)
> for more information.

### volume\_driver
Expand All @@ -1518,7 +1518,7 @@ volume_driver: mydriver
> entry in the [top-level `volumes` option](#volume-configuration-reference).


See [Docker Volumes](/storage/volumes.md) and
See [Docker Volumes](../../storage/volumes.md) and
[Volume Plugins](/engine/extend/plugins_volume/) for more information.

### volumes_from
Expand Down Expand Up @@ -1568,7 +1568,7 @@ restart: unless-stopped
### cpu_count, cpu_percent, cpu\_shares, cpu\_period, cpu\_quota, cpus, cpuset, domainname, hostname, ipc, mac\_address, mem\_limit, memswap\_limit, mem\_swappiness, mem\_reservation, oom_kill_disable, oom_score_adj, privileged, read\_only, shm\_size, stdin\_open, tty, user, working\_dir

Each of these is a single value, analogous to its
[docker run](/engine/reference/run.md#runtime-constraints-on-resources) counterpart.
[docker run](../../engine/reference/run.md#runtime-constraints-on-resources) counterpart.

> Added in [version 2.2](compose-versioning.md#version-22) file format.
>
Expand Down Expand Up @@ -1646,10 +1646,10 @@ While it is possible to declare [volumes](#volumes) on the fly as part of the
service declaration, this section allows you to create named volumes that can be
reused across multiple services (without relying on `volumes_from`), and are
easily retrieved and inspected using the docker command line or API.
See the [docker volume](/engine/reference/commandline/volume_create.md)
See the [docker volume](../../engine/reference/commandline/volume_create.md)
subcommand documentation for more information.

See [use volumes](/storage/volumes.md) and [volume plugins](/engine/extend/plugins_volume/)
See [use volumes](../../storage/volumes.md) and [volume plugins](/engine/extend/plugins_volume/)
for general information on volumes.

Here's an example of a two-service setup where a database's data directory is
Expand Down Expand Up @@ -1752,7 +1752,7 @@ volumes:
> Added in [version 2.1](compose-versioning.md#version-21) file format.

Add metadata to containers using
[Docker labels](/config/labels-custom-metadata.md). You can use either
[Docker labels](../../config/labels-custom-metadata.md). You can use either
an array or a dictionary.

It's recommended that you use reverse-DNS notation to prevent your labels from
Expand Down Expand Up @@ -1801,7 +1801,7 @@ volumes:

The top-level `networks` key lets you specify networks to be created. For a full
explanation of Compose's use of Docker networking features, see the
[Networking guide](/compose/networking.md).
[Networking guide](../networking.md).

### driver

Expand Down Expand Up @@ -1885,7 +1885,7 @@ you can set this option to `true`.
> Added in [version 2.1](compose-versioning.md#version-21) file format.

Add metadata to containers using
[Docker labels](/config/labels-custom-metadata.md). You can use either
[Docker labels](../../config/labels-custom-metadata.md). You can use either
an array or a dictionary.

It's recommended that you use reverse-DNS notation to prevent your labels from
Expand Down Expand Up @@ -1991,8 +1991,8 @@ networks:

## Compose documentation

- [User guide](/compose/index.md)
- [Installing Compose](/compose/install.md)
- [User guide](../index.md)
- [Installing Compose](../install.md)
- [Compose file versions and upgrading](compose-versioning.md)
- [Samples](/samples/index.md)
- [Command line reference](/compose/reference/index.md)
- [Samples](../../samples/index.md)
- [Command line reference](../reference/index.md)
Loading