diff --git a/README.md b/README.md index cd94bb9dcb40..571111fe6cd7 100644 --- a/README.md +++ b/README.md @@ -369,8 +369,7 @@ in Docker Hub. For example, run the following to access `v1.9`: All the images described below are automatically built using Docker Hub. To build the site manually, from scratch, including all utility and archive images, -see the [README in the publish-tools -branch](https://github.com/docker/docker.github.io/blob/publish-tools/README.md). +see the [README in the publish-tools branch](https://github.com/docker/docker.github.io/blob/publish-tools/README.md). - Some utility images are built from Dockerfiles in the `publish-tools` branch. See its [README](https://github.com/docker/docker.github.io/blob/publish-tools/README.md) diff --git a/_includes/content/moby.md b/_includes/content/moby.md index 541444fc7e1d..4763d51e90c3 100644 --- a/_includes/content/moby.md +++ b/_includes/content/moby.md @@ -11,6 +11,5 @@ relationship of Docker to Moby at [mobyproject.org](https://mobyproject.org/). The Moby project lives [here](https://github.com/moby/moby). -See [Contribute to the Moby -project](https://github.com/moby/moby/blob/master/CONTRIBUTING.md) to learn how -to help work on the codebase. +See [Contribute to the Moby project](https://github.com/moby/moby/blob/master/CONTRIBUTING.md) +to learn how to help work on the codebase. diff --git a/compose/aspnet-mssql-compose.md b/compose/aspnet-mssql-compose.md index 95c18b8a5ad4..26b55bcf820f 100644 --- a/compose/aspnet-mssql-compose.md +++ b/compose/aspnet-mssql-compose.md @@ -10,7 +10,7 @@ Compose to set up and run the sample ASP.NET Core application using the with the [SQL Server on Linux image](https://hub.docker.com/_/microsoft-mssql-server). You just need to have [Docker Engine](/install/index.md) -and [Docker Compose](/compose/install/) installed on your +and [Docker Compose](/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 @@ -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/#/shared-drives) and - [Docker Desktop for Mac](/docker-for-mac/#/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 @@ -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/#/advanced) and - [Docker Desktop for Windows](/docker-for-windows/#/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 diff --git a/compose/completion.md b/compose/completion.md index d05b66ee0eb5..23f42e66810d 100644 --- a/compose/completion.md +++ b/compose/completion.md @@ -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](./reference/index.md) -- [Compose file reference](compose-file.md) +- [Command line reference](/compose/reference/index.md) +- [Compose file reference](/compose/compose-file/index.md) diff --git a/compose/compose-file/compose-file-v1.md b/compose/compose-file/compose-file-v1.md index 76498567e963..e29a7838e2ce 100644 --- a/compose/compose-file/compose-file-v1.md +++ b/compose/compose-file/compose-file-v1.md @@ -396,7 +396,7 @@ options and tags it with the specified tag. ### labels -Add metadata to containers using [Docker labels](/engine/userguide/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. @@ -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](#networks) instead. +> [networks](/compose/networking.md) instead. ```yaml web: @@ -434,18 +434,18 @@ Containers for the linked service are reachable at a hostname identical to the alias, or the service name if no alias was specified. 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-v2.md#depends_on), so they determine the order of service startup. > **Note** > -> If you define both links and [networks](#networks), services with +> If you define both links and [networks](index.md#networks), services with > links between them must share at least one network in common in order to > communicate. ### log_driver -> [Version 1 file format](compose-versioning#version-1) only. In version 2 and up, use -> [logging](/compose/compose-file/index.md#logging). +> [Version 1 file format](compose-versioning.md#version-1) only. In version 2 and up, use +> [logging](index.md#logging). Specify a log driver. The default is `json-file`. @@ -455,8 +455,8 @@ log_driver: syslog ### log_opt -> [Version 1 file format](compose-versioning#version-1) only. In version 2 and up, use -> [logging](/compose/compose-file/index.md#logging). +> [Version 1 file format](compose-versioning.md#version-1) only. In version 2 and up, use +> [logging](index.md#logging). Specify logging options as key-value pairs. An example of `syslog` options: @@ -468,7 +468,7 @@ log_opt: ### net > [Version 1 file format](compose-versioning.md#version-1) only. In version 2 and up, use -> [network_mode](/compose/compose-file/index.md#networkmode) and [networks](/compose/compose-file/index.md#networks). +> [network_mode](index.md#network_mode) and [networks](index.md#networks). 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 @@ -561,9 +561,9 @@ ulimits: Mount paths or named volumes, optionally specifying a path on the host machine (`HOST:CONTAINER`), or an access mode (`HOST:CONTAINER:ro`). -For [version 2 files](compose-versioning#version-2), named volumes need to be specified with the +For [version 2 files](compose-versioning.md#version-2), named volumes need to be specified with the [top-level `volumes` key](compose-file-v2.md#volume-configuration-reference). -When using [version 1](compose-versioning#version-1), the Docker Engine creates the named +When using [version 1](compose-versioning.md#version-1), the Docker Engine creates the named volume automatically if it doesn't exist. You can mount a relative path on the host, which expands relative to @@ -595,16 +595,16 @@ volume_driver: mydriver ``` There are several things to note, depending on which -[Compose file version](compose-versioning#versioning) you're using: +[Compose file version](compose-versioning.md#versioning) you're using: -- For [version 1 files](compose-versioning#version-1), both named volumes and +- For [version 1 files](compose-versioning.md#version-1), both named volumes and container volumes use the specified driver. - No path expansion is done if you have also specified a `volume_driver`. 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](/engine/userguide/dockervolumes.md) and -[Volume Plugins](/engine/extend/plugins_volume.md) for more information. +See [Docker Volumes](/storage/volumes.md) and +[Volume Plugins](/engine/extend/plugins_volume/) for more information. ### volumes_from @@ -653,5 +653,5 @@ tty: true - [User guide](/compose/index.md) - [Installing Compose](/compose/install.md) - [Compose file versions and upgrading](compose-versioning.md) -- [Samples](/samples/) -- [Command line reference](/compose/reference/) +- [Samples](/samples/index.md) +- [Command line reference](/compose/reference/index.md) diff --git a/compose/compose-file/compose-file-v2.md b/compose/compose-file/compose-file-v2.md index 5ce2b3a3ed72..8748cc0f254f 100644 --- a/compose/compose-file/compose-file-v2.md +++ b/compose/compose-file/compose-file-v2.md @@ -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/#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 @@ -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](/engine/userguide/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 @@ -349,7 +349,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](/engine/userguide/eng-image/multistage-build.md) for +[multi-stage build docs](/develop/develop-images/multistage-build.md) for details. ```yaml @@ -740,7 +740,7 @@ external_links: > > If you're using the [version 2 or above file format](compose-versioning.md#version-2), > the externally-created containers must be connected to at least one of the same -> networks as the service that is linking to them. [Links](compose-file-v2#links) +> networks as the service that is linking to them. [Links](compose-file-v2.md#links) > are a legacy option. We recommend using [networks](#networks) instead. ### extra_hosts @@ -881,7 +881,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/#daemon-configuration-file). +> [`init-path` configuration option](/engine/reference/commandline/dockerd.md#daemon-configuration-file). ### isolation @@ -895,7 +895,7 @@ for details. ### labels -Add metadata to containers using [Docker labels](/engine/userguide/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. @@ -958,7 +958,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](/engine/admin/logging/overview.md)). +([documented here](/config/containers/logging/configure.md)). The default value is json-file. @@ -1311,7 +1311,7 @@ security_opt: Specify how long to wait when attempting to stop a container if it doesn't handle SIGTERM (or whatever stop signal has been specified with -[`stop_signal`](#stopsignal)), before sending SIGKILL. Specified +[`stop_signal`](#stop_signal)), before sending SIGKILL. Specified as a [duration](#specifying-durations). ```yaml @@ -1401,7 +1401,7 @@ userns_mode: "host" ``` Disables the user namespace for this service, if Docker daemon is configured with user namespaces. -See [dockerd](/engine/reference/commandline/dockerd.md#disable-user-namespace-for-a-container) for +See [dockerd](/engine/reference/commandline/dockerd/#disable-user-namespace-for-a-container) for more information. ### volumes @@ -1489,7 +1489,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](/engine/admin/volumes/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 @@ -1510,8 +1510,8 @@ volume_driver: mydriver > entry in the [top-level `volumes` option](#volume-configuration-reference). -See [Docker Volumes](/engine/userguide/dockervolumes.md) and -[Volume Plugins](/engine/extend/plugins_volume.md) for more information. +See [Docker Volumes](/storage/volumes.md) and +[Volume Plugins](/engine/extend/plugins_volume/) for more information. ### volumes_from @@ -1641,8 +1641,8 @@ easily retrieved and inspected using the docker command line or API. See the [docker volume](/engine/reference/commandline/volume_create.md) subcommand documentation for more information. -See [use volumes](/engine/admin/volumes/volumes.md) and [volume -plugins](/engine/extend/plugins_volume.md) for general information on volumes. +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 shared with another service as a volume so that it can be periodically backed @@ -1744,7 +1744,7 @@ volumes: > Added in [version 2.1](compose-versioning.md#version-21) file format. Add metadata to containers using -[Docker labels](/engine/userguide/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 @@ -1877,7 +1877,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](/engine/userguide/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 @@ -1986,5 +1986,5 @@ networks: - [User guide](/compose/index.md) - [Installing Compose](/compose/install.md) - [Compose file versions and upgrading](compose-versioning.md) -- [Samples](/samples/) -- [Command line reference](/compose/reference/) +- [Samples](/samples/index.md) +- [Command line reference](/compose/reference/index.md) diff --git a/compose/compose-file/compose-versioning.md b/compose/compose-file/compose-versioning.md index 724f50cf81da..fe02e255eab6 100644 --- a/compose/compose-file/compose-versioning.md +++ b/compose/compose-file/compose-versioning.md @@ -81,15 +81,15 @@ These differences are explained below. ### Version 1 Compose files that do not declare a version are considered "version 1". In those -files, all the [services](/compose/compose-file/index.md#service-configuration-reference) are +files, all the [services](index.md#service-configuration-reference) are declared at the root of the document. Version 1 is supported by **Compose up to 1.6.x**. It will be deprecated in a future Compose release. Version 1 files cannot declare named -[volumes](/compose/compose-file/index.md#volume-configuration-reference), [networks](/compose/compose-file/index.md#network-configuration-reference) or -[build arguments](/compose/compose-file/index.md#args). +[volumes](index.md#volume-configuration-reference), [networks](index.md#network-configuration-reference) or +[build arguments](index.md#args). Compose does not take advantage of [networking](/compose/networking.md) when you use version 1: every container is placed on the default `bridge` network and is @@ -125,7 +125,7 @@ under the `networks` key. By default, every container joins an application-wide default network, and is discoverable at a hostname that's the same as the service name. This means [links](compose-file-v2.md#links) are largely unnecessary. For more details, see -[Networking in Compose](compose-file-v2.md#networking.md). +[Networking in Compose](/compose/networking.md). > **Note**: When specifying the Compose file version to use, make sure to > specify both the _major_ and _minor_ numbers. If no minor version is given, @@ -214,7 +214,7 @@ supported by **Compose 1.9.0+**. Introduces the following additional parameters: -- [`link_local_ips`](compose-file-v2.md#linklocalips) +- [`link_local_ips`](compose-file-v2.md#link_local_ips) - [`isolation`](compose-file-v2.md#isolation) in build configurations and service definitions - `labels` for [volumes](compose-file-v2.md#volume-configuration-reference) and @@ -223,8 +223,8 @@ Introduces the following additional parameters: - [`userns_mode`](compose-file-v2.md#userns_mode) - [`healthcheck`](compose-file-v2.md#healthcheck) - [`sysctls`](compose-file-v2.md#sysctls) -- [`pids_limit`](compose-file-v2.md#pidslimit) -- [`oom_kill_disable`](compose-file-v2.md#oomkilldisable) +- [`pids_limit`](compose-file-v2.md#pids_limit) +- [`oom_kill_disable`](compose-file-v2.md#cpu-and-other-resources) - [`cpu_period`](compose-file-v2.md) ### Version 2.2 @@ -248,7 +248,7 @@ supported by **Compose 1.16.0+**. Introduces the following additional parameters: -- [`target`](compose-file-v2.md#target), [`extra_hosts`](compose-file-v2.md#extrahosts) and +- [`target`](compose-file-v2.md#target), [`extra_hosts`](compose-file-v2.md#extra_hosts-1) and [`shm_size`](compose-file-v2.md#shmsize) for [build configurations](compose-file-v2.md#build) - `start_period` for [`healthchecks`](compose-file-v2.md#healthcheck) - ["Long syntax" for volumes](compose-file-v2.md#long-syntax) @@ -270,7 +270,7 @@ Introduces the following additional parameters: ### Version 3 Designed to be cross-compatible between Compose and the Docker Engine's -[swarm mode](/engine/swarm/index.md), version 3 removes several options and adds +[swarm mode](/engine/swarm/), version 3 removes several options and adds several more. - Removed: `volume_driver`, `volumes_from`, `cpu_shares`, `cpu_quota`, @@ -278,7 +278,7 @@ several more. the [upgrading](#upgrading) guide for how to migrate away from these. (For more information on `extends`, see [Extending services](/compose/extends.md#extending-services).) -- Added: [deploy](/compose/compose-file/index.md#deploy) +- Added: [deploy](index.md#deploy) > **Note**: When specifying the Compose file version to use, make sure to > specify both the _major_ and _minor_ numbers. If no minor version is given, @@ -302,10 +302,10 @@ available with Docker Engine version **17.06.0+**, and higher. Introduces the following additional parameters: -- [build `labels`](/compose/compose-file/index.md#build) -- [`credential_spec`](/compose/compose-file/index.md#credentialspec) -- [`configs`](/compose/compose-file/index.md#configs) -- [deploy `endpoint_mode`](/compose/compose-file/index.md#endpointmode) +- [build `labels`](index.md#build) +- [`credential_spec`](index.md#credential_spec) +- [`configs`](index.md#configs) +- [deploy `endpoint_mode`](index.md#endpoint_mode) ### Version 3.4 @@ -314,10 +314,10 @@ only available with Docker Engine version **17.09.0** and higher. Introduces the following additional parameters: -- `target` and `network` in [build configurations](/compose/compose-file/index.md#build) -- `start_period` for [`healthchecks`](/compose/compose-file/index.md#healthcheck) -- `order` for [update configurations](/compose/compose-file/index.md#update_config) -- `name` for [volumes](/compose/compose-file/index.md#volume-configuration-reference) +- `target` and `network` in [build configurations](index.md#build) +- `start_period` for [`healthchecks`](index.md#healthcheck) +- `order` for [update configurations](index.md#update_config) +- `name` for [volumes](index.md#volume-configuration-reference) ### Version 3.5 @@ -360,7 +360,7 @@ several options have been removed: - `volume_driver`: Instead of setting the volume driver on the service, define a volume using the - [top-level `volumes` option](/compose/compose-file/index.md#volume-configuration-reference) + [top-level `volumes` option](index.md#volume-configuration-reference) and specify the driver there. version: "{{ site.compose_file_v3 }}" @@ -374,12 +374,12 @@ several options have been removed: driver: mydriver - `volumes_from`: To share a volume between services, define it using the - [top-level `volumes` option](/compose/compose-file/index.md#volume-configuration-reference) + [top-level `volumes` option](index.md#volume-configuration-reference) and reference it from each service that shares it using the - [service-level `volumes` option](/compose/compose-file/index.md#volumes-volumedriver). + [service-level `volumes` option](index.md#driver). - `cpu_shares`, `cpu_quota`, `cpuset`, `mem_limit`, `memswap_limit`: These - have been replaced by the [resources](/compose/compose-file/index.md#resources) key under + have been replaced by the [resources](index.md#resources) key under `deploy`. `deploy` configuration only takes effect when using `docker stack deploy`, and is ignored by `docker-compose`. @@ -413,7 +413,7 @@ It's more complicated if you're using particular configuration features: syslog-address: "tcp://192.168.0.42:123" - `links` with environment variables: As documented in the - [environment variables reference](link-env-deprecated.md), environment variables + [environment variables reference](/compose/link-env-deprecated.md), environment variables created by links have been deprecated for some time. In the new Docker network system, they have been removed. You should either connect directly to the @@ -432,11 +432,11 @@ It's more complicated if you're using particular configuration features: communicate, even if explicitly linked together. Either connect the external container to your app's - [default network](networking.md), or connect both the external container and + [default network](/compose/networking.md), or connect both the external container and your service's containers to an - [external network](networking.md#using-a-pre-existing-network). + [external network](/compose/networking.md#use-a-pre-existing-network). -- `net`: This is now replaced by [network_mode](compose-file-v1.md#network_mode): +- `net`: This is now replaced by [network_mode](index.md#network_mode): net: host -> network_mode: host net: bridge -> network_mode: bridge @@ -485,7 +485,7 @@ the following deploy keys are translated: - [resources](index.md#resources) limits and memory reservations - [replicas](index.md#replicas) -- [restart_policy](index.md#restartpolicy) `condition` and `max_attempts` +- [restart_policy](index.md#restart_policy) `condition` and `max_attempts` All other keys are ignored and produce a warning if present. You can review the configuration that will be used to deploy by using the `--compatibility` diff --git a/compose/compose-file/index.md b/compose/compose-file/index.md index 4a139226d55d..aa82d631e69c 100644 --- a/compose/compose-file/index.md +++ b/compose/compose-file/index.md @@ -26,8 +26,7 @@ how to upgrade, see **[About versions and upgrading](compose-versioning.md)**. Here is a sample Compose file from the voting app sample used in the [Docker for Beginners lab](https://github.com/docker/labs/tree/master/beginner/) -topic on [Deploying an app to a -Swarm](https://github.com/docker/labs/blob/master/beginner/chapters/votingapp.md): +topic on [Deploying an app to a Swarm](https://github.com/docker/labs/blob/master/beginner/chapters/votingapp.md):