-1. Create a systemd drop-in directory for the docker service:
+1. Create a systemd drop-in directory for the `docker` service:
- ```console
- $ sudo mkdir -p /etc/systemd/system/docker.service.d
- ```
+ ```console
+ $ sudo mkdir -p /etc/systemd/system/docker.service.d
+ ```
-2. Create a file named `/etc/systemd/system/docker.service.d/http-proxy.conf`
- that adds the `HTTP_PROXY` environment variable:
+2. Create a file named `/etc/systemd/system/docker.service.d/http-proxy.conf`
+ that adds the `HTTP_PROXY` environment variable:
- ```systemd
- [Service]
- Environment="HTTP_PROXY=http://proxy.example.com:80"
- ```
+ ```systemd
+ [Service]
+ Environment="HTTP_PROXY=http://proxy.example.com:80"
+ ```
- If you are behind an HTTPS proxy server, set the `HTTPS_PROXY` environment
- variable:
+ If you are behind an HTTPS proxy server, set the `HTTPS_PROXY` environment
+ variable:
- ```systemd
- [Service]
- Environment="HTTPS_PROXY=https://proxy.example.com:443"
- ```
-
- Multiple environment variables can be set; to set both a non-HTTPS and
- a HTTPs proxy;
+ ```systemd
+ [Service]
+ Environment="HTTPS_PROXY=https://proxy.example.com:443"
+ ```
- ```systemd
- [Service]
- Environment="HTTP_PROXY=http://proxy.example.com:80"
- Environment="HTTPS_PROXY=https://proxy.example.com:443"
- ```
-
- > **Note**
- >
- > Special characters in the proxy value, such as `#?!()[]{}`, must be double
- > escaped using `%%`. For example:
- >
- > ```
- > [Service]
- > Environment="HTTP_PROXY=http://domain%%5Cuser:complex%%23pass@proxy.example.com:8080/"
- > ```
-
-3. If you have internal Docker registries that you need to contact without
- proxying you can specify them via the `NO_PROXY` environment variable.
+ Multiple environment variables can be set; to set both a non-HTTPS and a
+ HTTPs proxy;
- The `NO_PROXY` variable specifies a string that contains comma-separated
- values for hosts that should be excluded from proxying. These are the
- options you can specify to exclude hosts:
- * IP address prefix (`1.2.3.4`)
- * Domain name, or a special DNS label (`*`)
- * A domain name matches that name and all subdomains. A domain name with
- a leading "." matches subdomains only. For example, given the domains
- `foo.example.com` and `example.com`:
- * `example.com` matches `example.com` and `foo.example.com`, and
- * `.example.com` matches only `foo.example.com`
- * A single asterisk (`*`) indicates that no proxying should be done
- * Literal port numbers are accepted by IP address prefixes (`1.2.3.4:80`)
- and domain names (`foo.example.com:80`)
-
- Config example:
+ ```systemd
+ [Service]
+ Environment="HTTP_PROXY=http://proxy.example.com:80"
+ Environment="HTTPS_PROXY=https://proxy.example.com:443"
+ ```
- ```systemd
- [Service]
- Environment="HTTP_PROXY=http://proxy.example.com:80"
- Environment="HTTPS_PROXY=https://proxy.example.com:443"
- Environment="NO_PROXY=localhost,127.0.0.1,docker-registry.example.com,.corp"
- ```
+ > **Note**
+ >
+ > Special characters in the proxy value, such as `#?!()[]{}`, must be double
+ > escaped using `%%`. For example:
+ >
+ > ```
+ > [Service]
+ > Environment="HTTP_PROXY=http://domain%%5Cuser:complex%%23pass@proxy.example.com:8080/"
+ > ```
-4. Flush changes and restart Docker
+3. If you have internal Docker registries that you need to contact without
+ proxying, you can specify them via the `NO_PROXY` environment variable.
- ```console
- $ sudo systemctl daemon-reload
- $ sudo systemctl restart docker
- ```
+ The `NO_PROXY` variable specifies a string that contains comma-separated
+ values for hosts that should be excluded from proxying. These are the options
+ you can specify to exclude hosts:
-5. Verify that the configuration has been loaded and matches the changes you
- made, for example:
+ - IP address prefix (`1.2.3.4`)
+ - Domain name, or a special DNS label (`*`)
+ - A domain name matches that name and all subdomains. A domain name with a
+ leading "." matches subdomains only. For example, given the domains
+ `foo.example.com` and `example.com`:
+ - `example.com` matches `example.com` and `foo.example.com`, and
+ - `.example.com` matches only `foo.example.com`
+ - A single asterisk (`*`) indicates that no proxying should be done
+ - Literal port numbers are accepted by IP address prefixes (`1.2.3.4:80`) and
+ domain names (`foo.example.com:80`)
- ```console
- $ sudo systemctl show --property=Environment docker
-
- Environment=HTTP_PROXY=http://proxy.example.com:80 HTTPS_PROXY=https://proxy.example.com:443 NO_PROXY=localhost,127.0.0.1,docker-registry.example.com,.corp
- ```
+ Config example:
+
+ ```systemd
+ [Service]
+ Environment="HTTP_PROXY=http://proxy.example.com:80"
+ Environment="HTTPS_PROXY=https://proxy.example.com:443"
+ Environment="NO_PROXY=localhost,127.0.0.1,docker-registry.example.com,.corp"
+ ```
+
+4. Flush changes and restart Docker
+
+ ```console
+ $ sudo systemctl daemon-reload
+ $ sudo systemctl restart docker
+ ```
+
+5. Verify that the configuration has been loaded and matches the changes you
+ made, for example:
+
+ ```console
+ $ sudo systemctl show --property=Environment docker
+
+ Environment=HTTP_PROXY=http://proxy.example.com:80 HTTPS_PROXY=https://proxy.example.com:443 NO_PROXY=localhost,127.0.0.1,docker-registry.example.com,.corp
+ ```
-1. Create a systemd drop-in directory for the docker service:
+1. Create a systemd drop-in directory for the `docker` service:
- ```console
- $ mkdir -p ~/.config/systemd/user/docker.service.d
- ```
+ ```console
+ $ mkdir -p ~/.config/systemd/user/docker.service.d
+ ```
-2. Create a file named `~/.config/systemd/user/docker.service.d/http-proxy.conf`
- that adds the `HTTP_PROXY` environment variable:
+2. Create a file named `~/.config/systemd/user/docker.service.d/http-proxy.conf`
+ that adds the `HTTP_PROXY` environment variable:
- ```systemd
- [Service]
- Environment="HTTP_PROXY=http://proxy.example.com:80"
- ```
+ ```systemd
+ [Service]
+ Environment="HTTP_PROXY=http://proxy.example.com:80"
+ ```
- If you are behind an HTTPS proxy server, set the `HTTPS_PROXY` environment
- variable:
+ If you are behind an HTTPS proxy server, set the `HTTPS_PROXY` environment
+ variable:
- ```systemd
- [Service]
- Environment="HTTPS_PROXY=https://proxy.example.com:443"
- ```
-
- Multiple environment variables can be set; to set both a non-HTTPS and
- a HTTPs proxy;
+ ```systemd
+ [Service]
+ Environment="HTTPS_PROXY=https://proxy.example.com:443"
+ ```
- ```systemd
- [Service]
- Environment="HTTP_PROXY=http://proxy.example.com:80"
- Environment="HTTPS_PROXY=https://proxy.example.com:443"
- ```
-
- > **Note**
- >
- > Special characters in the proxy value, such as `#?!()[]{}`, must be double
- > escaped using `%%`. For example:
- >
- > ```
- > [Service]
- > Environment="HTTP_PROXY=http://domain%%5Cuser:complex%%23pass@proxy.example.com:8080/"
- > ```
-
-3. If you have internal Docker registries that you need to contact without
- proxying, you can specify them via the `NO_PROXY` environment variable.
+ Multiple environment variables can be set; to set both a non-HTTPS and a
+ HTTPs proxy;
- The `NO_PROXY` variable specifies a string that contains comma-separated
- values for hosts that should be excluded from proxying. These are the
- options you can specify to exclude hosts:
- * IP address prefix (`1.2.3.4`)
- * Domain name, or a special DNS label (`*`)
- * A domain name matches that name and all subdomains. A domain name with
- a leading "." matches subdomains only. For example, given the domains
- `foo.example.com` and `example.com`:
- * `example.com` matches `example.com` and `foo.example.com`, and
- * `.example.com` matches only `foo.example.com`
- * A single asterisk (`*`) indicates that no proxying should be done
- * Literal port numbers are accepted by IP address prefixes (`1.2.3.4:80`)
- and domain names (`foo.example.com:80`)
-
- Config example:
+ ```systemd
+ [Service]
+ Environment="HTTP_PROXY=http://proxy.example.com:80"
+ Environment="HTTPS_PROXY=https://proxy.example.com:443"
+ ```
- ```systemd
- [Service]
- Environment="HTTP_PROXY=http://proxy.example.com:80"
- Environment="HTTPS_PROXY=https://proxy.example.com:443"
- Environment="NO_PROXY=localhost,127.0.0.1,docker-registry.example.com,.corp"
- ```
+ > **Note**
+ >
+ > Special characters in the proxy value, such as `#?!()[]{}`, must be double
+ > escaped using `%%`. For example:
+ >
+ > ```
+ > [Service]
+ > Environment="HTTP_PROXY=http://domain%%5Cuser:complex%%23pass@proxy.example.com:8080/"
+ > ```
-4. Flush changes and restart Docker
+3. If you have internal Docker registries that you need to contact without
+ proxying, you can specify them via the `NO_PROXY` environment variable.
- ```console
- $ systemctl --user daemon-reload
- $ systemctl --user restart docker
- ```
+ The `NO_PROXY` variable specifies a string that contains comma-separated
+ values for hosts that should be excluded from proxying. These are the options
+ you can specify to exclude hosts:
-5. Verify that the configuration has been loaded and matches the changes you
- made, for example:
+ - IP address prefix (`1.2.3.4`)
+ - Domain name, or a special DNS label (`*`)
+ - A domain name matches that name and all subdomains. A domain name with a
+ leading "." matches subdomains only. For example, given the domains
+ `foo.example.com` and `example.com`:
+ - `example.com` matches `example.com` and `foo.example.com`, and
+ - `.example.com` matches only `foo.example.com`
+ - A single asterisk (`*`) indicates that no proxying should be done
+ - Literal port numbers are accepted by IP address prefixes (`1.2.3.4:80`) and
+ domain names (`foo.example.com:80`)
- ```console
- $ systemctl --user show --property=Environment docker
+ Config example:
- Environment=HTTP_PROXY=http://proxy.example.com:80 HTTPS_PROXY=https://proxy.example.com:443 NO_PROXY=localhost,127.0.0.1,docker-registry.example.com,.corp
- ```
+ ```systemd
+ [Service]
+ Environment="HTTP_PROXY=http://proxy.example.com:80"
+ Environment="HTTPS_PROXY=https://proxy.example.com:443"
+ Environment="NO_PROXY=localhost,127.0.0.1,docker-registry.example.com,.corp"
+ ```
+
+4. Flush changes and restart Docker
+
+ ```console
+ $ systemctl --user daemon-reload
+ $ systemctl --user restart docker
+ ```
+
+5. Verify that the configuration has been loaded and matches the changes you
+ made, for example:
+
+ ```console
+ $ systemctl --user show --property=Environment docker
+
+ Environment=HTTP_PROXY=http://proxy.example.com:80 HTTPS_PROXY=https://proxy.example.com:443 NO_PROXY=localhost,127.0.0.1,docker-registry.example.com,.corp
+ ```
-
-
-## Configure where the Docker daemon listens for connections
-
-See
-[Configure where the Docker daemon listens for connections](../../engine/install/linux-postinstall.md#configure-where-the-docker-daemon-listens-for-connections).
-
-## Manually create the systemd unit files
-
-When installing the binary without a package, you may want
-to integrate Docker with systemd. For this, install the two unit files
-(`service` and `socket`) from [the github repository](https://github.com/moby/moby/tree/master/contrib/init/systemd)
-to `/etc/systemd/system`.
diff --git a/config/daemon/troubleshoot.md b/config/daemon/troubleshoot.md
new file mode 100644
index 0000000000..f66df28da0
--- /dev/null
+++ b/config/daemon/troubleshoot.md
@@ -0,0 +1,97 @@
+---
+title: Troubleshoot the Docker daemon
+description: Configuring and troubleshooting the Docker daemon
+keywords: docker, daemon, configuration, troubleshooting
+---
+
+This page describes how to troubleshoot and debug the daemon if you run into
+issues.
+
+You can turn on debugging on the daemon to learn about the runtime activity of
+the daemon and to aid in troubleshooting. If the daemon is unresponsive, you can
+also [force a full stack trace](logs.md#force-a-stack-trace-to-be-logged) of all
+threads to be added to the daemon log by sending the `SIGUSR` signal to the
+Docker daemon.
+
+## Troubleshoot conflicts between the `daemon.json` and startup scripts
+
+If you use a `daemon.json` file and also pass options to the `dockerd` command
+manually or using start-up scripts, and these options conflict, Docker fails to
+start with an error such as:
+
+```none
+unable to configure the Docker daemon with file /etc/docker/daemon.json:
+the following directives are specified both as a flag and in the configuration
+file: hosts: (from flag: [unix:///var/run/docker.sock], from file: [tcp://127.0.0.1:2376])
+```
+
+If you see an error similar to this one and you are starting the daemon manually
+with flags, you may need to adjust your flags or the `daemon.json` to remove the
+conflict.
+
+> **Note**: If you see this specific error, continue to the
+> [next section](#use-the-hosts-key-in-daemonjson-with-systemd) for a
+> workaround.
+
+If you are starting Docker using your operating system's init scripts, you may
+need to override the defaults in these scripts in ways that are specific to the
+operating system.
+
+### Use the hosts key in daemon.json with systemd
+
+One notable example of a configuration conflict that is difficult to
+troubleshoot is when you want to specify a different daemon address from the
+default. Docker listens on a socket by default. On Debian and Ubuntu systems
+using `systemd`, this means that a host flag `-H` is always used when starting
+`dockerd`. If you specify a `hosts` entry in the `daemon.json`, this causes a
+configuration conflict (as in the above message) and Docker fails to start.
+
+To work around this problem, create a new file
+`/etc/systemd/system/docker.service.d/docker.conf` with the following contents,
+to remove the `-H` argument that is used when starting the daemon by default.
+
+```none
+[Service]
+ExecStart=
+ExecStart=/usr/bin/dockerd
+```
+
+There are other times when you might need to configure `systemd` with Docker,
+such as [configuring a HTTP or HTTPS proxy](systemd.md#httphttps-proxy).
+
+> **Note**: If you override this option and then do not specify a `hosts` entry
+> in the `daemon.json` or a `-H` flag when starting Docker manually, Docker
+> fails to start.
+
+Run `sudo systemctl daemon-reload` before attempting to start Docker. If Docker
+starts successfully, it is now listening on the IP address specified in the
+`hosts` key of the `daemon.json` instead of a socket.
+
+
+> **Important**
+>
+> Setting `hosts` in the `daemon.json` is not supported on Docker
+> Desktop for Windows or Docker Desktop for Mac.
+{:.important}
+
+## Out of memory issues
+
+If your containers attempt to use more memory than the system has available, you
+may experience an Out of Memory (OOM) exception, and a container, or the Docker
+daemon, might be stopped by the kernel OOM killer. To prevent this from
+happening, ensure that your application runs on hosts with adequate memory and
+see
+[Understand the risks of running out of memory](../containers/resource_constraints.md#understand-the-risks-of-running-out-of-memory).
+
+## Check whether Docker is running
+
+The operating-system independent way to check whether Docker is running is to
+ask Docker, using the `docker info` command.
+
+You can also use operating system utilities, such as
+`sudo systemctl is-active docker` or `sudo status docker` or
+`sudo service docker status`, or checking the service status using Windows
+utilities.
+
+Finally, you can check in the process list for the `dockerd` process, using
+commands like `ps` or `top`.
diff --git a/desktop/release-notes.md b/desktop/release-notes.md
index f30ddb7fe2..b2c2071b2d 100644
--- a/desktop/release-notes.md
+++ b/desktop/release-notes.md
@@ -900,8 +900,8 @@ For frequently asked questions about Docker Desktop releases, see [FAQs](faqs/ge
### New
- IT Administrators can now install Docker Desktop remotely using the command line.
-- Add the Docker Software Bill of Materials (SBOM) CLI plugin. The new CLI plugin enables users to generate SBOMs for Docker images. For more information, see [Docker SBOM](../engine/sbom/index.md).
-- Use [cri-dockerd](https://github.com/Mirantis/cri-dockerd){: target="_blank" rel="noopener" class="_"} for new Kubernetes clusters instead of `dockershim`. The change is transparent from the user's point of view and Kubernetes containers run on the Docker Engine as before. `cri-dockerd` allows Kubernetes to manage Docker containers using the standard [Container Runtime Interface](https://github.com/kubernetes/cri-api#readme){: target="_blank" rel="noopener" class="_"}, the same interface used to control other container runtimes. For more information, see [The Future of Dockershim is cri-dockerd](https://www.mirantis.com/blog/the-future-of-dockershim-is-cri-dockerd/){: target="_blank" rel="noopener" class="_"}.
+- Add the Docker Software Bill of Materials (SBOM) CLI plugin. The new CLI plugin enables users to generate SBOMs for Docker images. For more information, see [Docker SBOM](../engine/sbom/index.md).
+- Use [cri-dockerd](https://github.com/Mirantis/cri-dockerd){: target="_blank" rel="noopener" class="_"} for new Kubernetes clusters instead of `dockershim`. The change is transparent from the user's point of view and Kubernetes containers run on the Docker Engine as before. `cri-dockerd` allows Kubernetes to manage Docker containers using the standard [Container Runtime Interface](https://github.com/kubernetes/cri-api#readme){: target="_blank" rel="noopener" class="_"}, the same interface used to control other container runtimes. For more information, see [The Future of Dockershim is cri-dockerd](https://www.mirantis.com/blog/the-future-of-dockershim-is-cri-dockerd/){: target="_blank" rel="noopener" class="_"}.
### Updates
diff --git a/desktop/troubleshoot/overview.md b/desktop/troubleshoot/overview.md
index acc246b690..6c1636d0cd 100644
--- a/desktop/troubleshoot/overview.md
+++ b/desktop/troubleshoot/overview.md
@@ -228,9 +228,9 @@ To read the Docker app log messages, type `docker` in the Console window search
You can use the Console Log Query to search logs, filter the results in various
ways, and create reports.
-### View the Docker Daemon logs
+### View the Docker daemon logs
-Refer to the [read the logs](../../config/daemon/index.md#read-the-logs) section
+Refer to the [Read the daemon logs](../../config/daemon/logs.md) section
to learn how to view the Docker Daemon logs.
@@ -247,9 +247,9 @@ $ journalctl --user --unit=docker-desktop
You can also find the logs for the internal components included in Docker
Desktop at `$HOME/.docker/desktop/log/`.
-### View the Docker Daemon logs
+### View the Docker daemon logs
-Refer to the [read the logs](../../config/daemon/index.md#read-the-logs) section
+Refer to the [Read the daemon logs](../../config/daemon/logs.md) section
to learn how to view the Docker Daemon logs.
diff --git a/engine/index.md b/engine/index.md
index 244409c7ec..bbff47d553 100644
--- a/engine/index.md
+++ b/engine/index.md
@@ -2,11 +2,11 @@
description: Engine
keywords: Engine
redirect_from:
-- /edge/
-- /engine/ce-ee-node-activate/
-- /engine/misc/
-- /linux/
-- /manuals/ # TODO remove this redirect after we've created a landing page for the product manuals section
+ - /edge/
+ - /engine/ce-ee-node-activate/
+ - /engine/misc/
+ - /linux/
+ - /manuals/ # TODO remove this redirect after we've created a landing page for the product manuals section
title: Docker Engine overview
---
@@ -14,50 +14,117 @@ Docker Engine is an open source containerization technology for building and
containerizing your applications. Docker Engine acts as a client-server
application with:
-* A server with a long-running daemon process [`dockerd`](/engine/reference/commandline/dockerd).
-* APIs which specify interfaces that programs can use to talk to and
- instruct the Docker daemon.
-* A command line interface (CLI) client [`docker`](/engine/reference/commandline/cli/).
+- A server with a long-running daemon process
+ [`dockerd`](/engine/reference/commandline/dockerd).
+- APIs which specify interfaces that programs can use to talk to and instruct
+ the Docker daemon.
+- A command line interface (CLI) client
+ [`docker`](/engine/reference/commandline/cli/).
The CLI uses [Docker APIs](api/index.md) to control or interact with the Docker
daemon through scripting or direct CLI commands. Many other Docker applications
use the underlying API and CLI. The daemon creates and manage Docker objects,
such as images, containers, networks, and volumes.
-For more details, see [Docker Architecture](../get-started/overview.md#docker-architecture).
+For more details, see
+[Docker Architecture](../get-started/overview.md#docker-architecture).
-## Docker user guide
-
-To learn about Docker in more detail and to answer questions about usage and
-implementation, check out the [overview page in "get started"](../get-started/overview.md).
-
-## Installation guides
-
-The [installation section](install/index.md) shows you how to install Docker
-on a variety of platforms.
-
-## Release notes
-
-A summary of the changes in each release in the current series can now be found
-on the separate [Release Notes page](release-notes/index.md)
-
-## Feature Deprecation Policy
-
-As changes are made to Docker there may be times when existing features
-need to be removed or replaced with newer features. Before an existing
-feature is removed it is labeled as "deprecated" within the documentation
-and remains in Docker for at least 3 stable releases unless specified
-explicitly otherwise. After that time it may be removed.
-
-Users are expected to take note of the list of deprecated features each
-release and plan their migration away from those features, and (if applicable)
-towards the replacement features as soon as possible.
-
-The complete list of deprecated features can be found on the
-[Deprecated Features page](deprecated.md).
+