diff --git a/_data/toc.yaml b/_data/toc.yaml index 9d20722634..e01e8518b1 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -4,7 +4,7 @@ horizontalnav: path: / node: guides - title: Product manuals - path: /install/ + path: /engine/ node: manuals - title: Reference path: /reference/ @@ -1023,22 +1023,24 @@ samples: manuals: - sectiontitle: Docker Engine section: - - path: /install/ + - path: /engine/ title: Overview - - sectiontitle: Linux + - path: /engine/install/ + title: Install + - sectiontitle: Installation per distro section: - - path: /install/linux/docker-ce/centos/ - title: CentOS - - path: /install/linux/docker-ce/debian/ - title: Debian - - path: /install/linux/docker-ce/fedora/ - title: Fedora - - path: /install/linux/docker-ce/ubuntu/ - title: Ubuntu - - path: /install/linux/docker-ce/binaries/ - title: Binaries - - path: /install/linux/linux-postinstall/ - title: Optional Linux post-installation steps + - path: /engine/install/centos/ + title: Install on CentOS + - path: /engine/install/debian/ + title: Install on Debian + - path: /engine/install/fedora/ + title: Install on Fedora + - path: /engine/install/ubuntu/ + title: Install on Ubuntu + - path: /engine/install/binaries/ + title: Install binaries + - path: /engine/install/linux-postinstall/ + title: Optional post-installation steps - path: /engine/release-notes/ title: Release notes - sectiontitle: Previous versions @@ -1077,6 +1079,9 @@ manuals: title: Engine 17.03 release notes - path: /engine/release-notes/prior-releases/ title: Engine 1.13 and earlier + - path: /engine/deprecated/ + title: Deprecated features + - path: /app/working-with-app/ title: Docker App - path: /buildx/working-with-buildx/ diff --git a/_includes/ee-linux-install-reuse.md b/_includes/ee-linux-install-reuse.md index 695657c700..20224c7ff3 100644 --- a/_includes/ee-linux-install-reuse.md +++ b/_includes/ee-linux-install-reuse.md @@ -23,7 +23,7 @@ on {{ linux-dist-long }}: Docker Engine - Community is _not_ supported on {{ linux-dist-long }}. {% endif %} {% if linux-dist == "centos" %} -For Docker Community Edition on {{ linux-dist-cap }}, see [Get Docker Engine - Community for CentOS](/install/linux/docker-ce/centos.md). +For Docker Community Edition on {{ linux-dist-cap }}, see [Get Docker Engine - Community for CentOS](/engine/install/centos.md). {% endif %} {% elsif section == "find-ee-repo-url" %} @@ -280,7 +280,7 @@ You only need to set up the repository once, after which you can install Docker ``` Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See - [Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow + [Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow non-privileged users to run Docker commands. @@ -351,7 +351,7 @@ To manually install Docker Enterprise, download the `.{{ package-format | downca ``` Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See - [Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow + [Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow non-privileged users to run Docker commands. @@ -394,7 +394,7 @@ To manually install Docker Enterprise, download the `.{{ package-format | downca ``` Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See - [Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow + [Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow non-privileged users to run Docker commands. @@ -444,7 +444,7 @@ To manually install Docker Enterprise, download the `.{{ package-format | downca ``` Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See - [Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow + [Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow non-privileged users to run Docker commands. {% endif %} @@ -485,7 +485,7 @@ You must delete any edited configuration files manually. {% elsif section == "linux-install-nextsteps" %} -- Continue to [Post-installation steps for Linux](/install/linux/linux-postinstall.md){: target="_blank" class="_" } +- Continue to [Post-installation steps for Linux](/engine/install/linux-postinstall.md){: target="_blank" class="_" } - Continue with user guides on [Universal Control Plane (UCP)](/ee/ucp/){: target="_blank" class="_" } and [Docker Trusted Registry (DTR)](/ee/dtr/){: target="_blank" class="_" } diff --git a/compose/aspnet-mssql-compose.md b/compose/aspnet-mssql-compose.md index 26b55bcf82..43f8161338 100644 --- a/compose/aspnet-mssql-compose.md +++ b/compose/aspnet-mssql-compose.md @@ -9,7 +9,7 @@ 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](/install/index.md) +You just need to have [Docker Engine](/get-docker.md) and [Docker Compose](/compose/install.md) installed on your platform of choice: Linux, Mac or Windows. diff --git a/compose/gettingstarted.md b/compose/gettingstarted.md index 1fc0221ec2..2647713187 100644 --- a/compose/gettingstarted.md +++ b/compose/gettingstarted.md @@ -11,7 +11,7 @@ understandable even if you're not familiar with it. ## Prerequisites -Make sure you have already installed both [Docker Engine](/install/index.md) +Make sure you have already installed both [Docker Engine](/get-docker.md) and [Docker Compose](install.md). You don't need to install Python or Redis, as both are provided by Docker images. diff --git a/compose/install.md b/compose/install.md index 019b95b6b2..56e65bbac7 100644 --- a/compose/install.md +++ b/compose/install.md @@ -16,12 +16,12 @@ have Docker Engine installed either locally or remote, depending on your setup. included as part of those desktop installs. - On Linux systems, first install the -[Docker](/install/index.md#server){: target="_blank" class="_"} +[Docker Engine](/engine/install/index.md#server){: target="_blank" class="_"} for your OS as described on the Get Docker page, then come back here for instructions on installing Compose on Linux systems. -- To run Compose as a non-root user, see [Manage Docker as a non-root user](/install/linux/linux-postinstall.md). +- To run Compose as a non-root user, see [Manage Docker as a non-root user](/engine/install/linux-postinstall.md). ## Install Compose diff --git a/config/containers/resource_constraints.md b/config/containers/resource_constraints.md index 7199dfbc43..07658e4034 100644 --- a/config/containers/resource_constraints.md +++ b/config/containers/resource_constraints.md @@ -24,7 +24,7 @@ WARNING: No swap limit support ``` Consult your operating system's documentation for enabling them. -[Learn more](/install/linux/linux-postinstall.md#your-kernel-does-not-support-cgroup-swap-limit-capabilities). +[Learn more](/engine/install/linux-postinstall.md#your-kernel-does-not-support-cgroup-swap-limit-capabilities). ## Memory diff --git a/config/daemon/index.md b/config/daemon/index.md index be0df42906..cafe88281b 100644 --- a/config/daemon/index.md +++ b/config/daemon/index.md @@ -34,9 +34,9 @@ not manually by a user. This makes it easier to automatically start Docker when the machine reboots. The command to start Docker depends on your operating system. Check the correct -page under [Install Docker](/install/index.md). To configure Docker +page under [Install Docker](/engine/install/index.md). To configure Docker to start automatically at system boot, see -[Configure Docker to start on boot](/install/linux/linux-postinstall.md#configure-docker-to-start-on-boot). +[Configure Docker to start on boot](/engine/install/linux-postinstall.md#configure-docker-to-start-on-boot). ## Start the daemon manually diff --git a/config/daemon/systemd.md b/config/daemon/systemd.md index 57f0469688..a6fe65ad60 100644 --- a/config/daemon/systemd.md +++ b/config/daemon/systemd.md @@ -34,7 +34,7 @@ do not have `systemctl`, use the `service` command. ### Start automatically at system boot If you want Docker to start at boot, see -[Configure Docker to start on boot](/install/linux/linux-postinstall.md#configure-docker-to-start-on-boot). +[Configure Docker to start on boot](/engine/install/linux-postinstall.md#configure-docker-to-start-on-boot). ## Custom Docker daemon options @@ -155,7 +155,7 @@ you need to add this configuration in the Docker systemd service file. ## Configure where the Docker daemon listens for connections See -[Configure where the Docker daemon listens for connections](/install/linux/linux-postinstall.md#control-where-the-docker-daemon-listens-for-connections). +[Configure where the Docker daemon listens for connections](/engine/install/linux-postinstall.md#control-where-the-docker-daemon-listens-for-connections). ## Manually create the systemd unit files diff --git a/datacenter/ucp/1.1/installation/system-requirements.md b/datacenter/ucp/1.1/installation/system-requirements.md index a68e71c053..4f361ef190 100644 --- a/datacenter/ucp/1.1/installation/system-requirements.md +++ b/datacenter/ucp/1.1/installation/system-requirements.md @@ -17,7 +17,7 @@ all nodes must have: * Linux kernel version 3.10 or higher * CS Docker Engine version 1.10 or higher. Learn about the -[operating systems supported by CS Docker Engine](/install/). +[operating systems supported by CS Docker Engine](/ee/supported-platforms.md). * 2.00 GB of RAM * 3.00 GB of available disk space * A static IP address diff --git a/datacenter/ucp/2.2/guides/admin/install/index.md b/datacenter/ucp/2.2/guides/admin/install/index.md index c934eca102..ebfa1c5b7e 100644 --- a/datacenter/ucp/2.2/guides/admin/install/index.md +++ b/datacenter/ucp/2.2/guides/admin/install/index.md @@ -20,7 +20,7 @@ UCP is a containerized application that requires the commercially supported Docker Engine to run. Install Docker Enterprise on each host that you plan to manage with UCP. -View the [supported platforms](/install/index.md#supported-platforms) +View the [supported platforms](/ee/supported-platforms.md) and click on your platform to get platform-specific instructions for installing Docker Enterprise. diff --git a/datacenter/ucp/2.2/guides/admin/install/system-requirements.md b/datacenter/ucp/2.2/guides/admin/install/system-requirements.md index 4a46bf5028..7d7c976ec3 100644 --- a/datacenter/ucp/2.2/guides/admin/install/system-requirements.md +++ b/datacenter/ucp/2.2/guides/admin/install/system-requirements.md @@ -11,7 +11,7 @@ Before installing, be sure your infrastructure has these requirements. You can install UCP on-premises or on a cloud provider. Common requirements: -* [Docker Enterprise Edition](/install/index.md) version 17.06 or higher +* [Docker Enterprise Edition](/ee/supported-platforms.md) version 17.06 or higher * Linux kernel version 3.10 or higher * A static IP address diff --git a/datacenter/ucp/3.0/guides/admin/install/index.md b/datacenter/ucp/3.0/guides/admin/install/index.md index 1e280c4e0b..d03d1f9a21 100644 --- a/datacenter/ucp/3.0/guides/admin/install/index.md +++ b/datacenter/ucp/3.0/guides/admin/install/index.md @@ -20,7 +20,7 @@ UCP is a containerized application that requires the commercially supported Docker Engine to run. Install Docker EE on each host that you plan to manage with UCP. -View the [supported platforms](/install/index.md#supported-platforms) +View the [supported platforms](/ee/supported-platforms.md) and click on your platform to get platform-specific instructions for installing Docker EE. diff --git a/datacenter/ucp/3.0/guides/admin/install/system-requirements.md b/datacenter/ucp/3.0/guides/admin/install/system-requirements.md index fb0e421457..be8ddd7594 100644 --- a/datacenter/ucp/3.0/guides/admin/install/system-requirements.md +++ b/datacenter/ucp/3.0/guides/admin/install/system-requirements.md @@ -11,7 +11,7 @@ Before installing, be sure your infrastructure has these requirements. You can install UCP on-premises or on a cloud provider. Common requirements: -* [Docker Enterprise Edition](/install/index.md) version 17.06 or higher +* [Docker Enterprise Edition](/ee/supported-platforms.md) version 17.06 or higher * Linux kernel version 3.10 or higher * A static IP address diff --git a/docker-for-mac/install.md b/docker-for-mac/install.md index f2d8dfbf02..5c8a2c58b7 100644 --- a/docker-for-mac/install.md +++ b/docker-for-mac/install.md @@ -48,8 +48,8 @@ Your Mac must meet the following requirements to successfully install Docker Des ## What's included in the installer The Docker Desktop installation includes - [Docker Engine](/install/), Docker CLI client, - [Docker Compose](/compose/), [Notary](/notary/getting_started/), [Kubernetes](https://github.com/kubernetes/kubernetes/), and [Credential Helper](https://github.com/docker/docker-credential-helpers/). + [Docker Engine](/engine/index.md), Docker CLI client, + [Docker Compose](/compose/index.md), [Notary](/notary/getting_started/), [Kubernetes](https://github.com/kubernetes/kubernetes/), and [Credential Helper](https://github.com/docker/docker-credential-helpers/). ## Install and run Docker Desktop on Mac diff --git a/docker-for-windows/install.md b/docker-for-windows/install.md index 49dedd5c10..cb24abc240 100644 --- a/docker-for-windows/install.md +++ b/docker-for-windows/install.md @@ -39,7 +39,11 @@ used side-by-side with Docker Desktop. However, you can still use ### What's included in the installer -The Docker Desktop installation includes [Docker Engine](/install/), Docker CLI client, [Docker Compose](/compose/overview.md), [Notary](/notary/getting_started/), [Kubernetes](https://github.com/kubernetes/kubernetes/), and [Credential Helper](https://github.com/docker/docker-credential-helpers/). +The Docker Desktop installation includes [Docker Engine](/engine/index.md), +Docker CLI client, [Docker Compose](/compose/index.md), +[Notary](/notary/getting_started.md), +[Kubernetes](https://github.com/kubernetes/kubernetes/), +and [Credential Helper](https://github.com/docker/docker-credential-helpers/). Containers and images created with Docker Desktop are shared between all user accounts on machines where it is installed. This is because all Windows diff --git a/ee/docker-ee/centos.md b/ee/docker-ee/centos.md index 905d75af78..c09c2ce367 100644 --- a/ee/docker-ee/centos.md +++ b/ee/docker-ee/centos.md @@ -28,7 +28,8 @@ on {{ linux-dist-long }}: Shared between centOS.md, rhel.md, oracle.md ---> -For Docker Community Edition on {{ linux-dist-cap }}, see [Get Docker Engine - Community for CentOS](/install/linux/docker-ce/centos.md). +For Docker Community Edition on {{ linux-dist-cap }}, see +[Install Docker Engine on CentOS](/engine/install/centos.md). ## Prerequisites @@ -219,7 +220,7 @@ Shared between centOS.md, oracle.md ``` Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See - [Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow + [Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow non-privileged users to run Docker commands. -#### Install Docker Engine - Community +#### Install Docker Engine > **Note**: This procedure works for Debian on `x86_64` / `amd64`, Debian ARM, > or Raspbian. -1. Update the `apt` package index. +1. Update the `apt` package index, and install the _latest version_ of Docker + Engine and containerd, or go to the next step to install a specific version: ```bash $ sudo apt-get update - ``` - -2. Install the _latest version_ of Docker Engine - Community and containerd, or go to the next step to install a specific version: - - ```bash $ sudo apt-get install docker-ce docker-ce-cli containerd.io ``` @@ -183,7 +176,8 @@ from the repository. > `apt-get update` command always installs the highest possible version, > which may not be appropriate for your stability needs. -3. To install a _specific version_ of Docker Engine - Community, list the available versions in the repo, then select and install: +2. To install a _specific version_ of Docker Engine, list the available versions + in the repo, then select and install: a. List the versions available in your repo: @@ -204,7 +198,7 @@ from the repository. $ sudo apt-get install docker-ce= docker-ce-cli= containerd.io ``` -4. Verify that Docker Engine - Community is installed correctly by running the `hello-world` +3. Verify that Docker Engine is installed correctly by running the `hello-world` image. ```bash @@ -214,34 +208,33 @@ from the repository. This command downloads a test image and runs it in a container. When the container runs, it prints an informational message and exits. -Docker Engine - Community is installed and running. The `docker` group is created but no users +Docker Engine is installed and running. The `docker` group is created but no users are added to it. You need to use `sudo` to run Docker commands. -Continue to [Linux postinstall](/install/linux/linux-postinstall.md) to allow -non-privileged users to run Docker commands and for other optional configuration -steps. +Continue to [Linux postinstall](linux-postinstall.md) to allow non-privileged +users to run Docker commands and for other optional configuration steps. -#### Upgrade Docker Engine - Community +#### Upgrade Docker Engine -To upgrade Docker Engine - Community, first run `sudo apt-get update`, then follow the -[installation instructions](#install-docker-ce), choosing the new version you want -to install. +To upgrade Docker Engine, first run `sudo apt-get update`, then follow the +[installation instructions](#install-using-the-repository), choosing the new +version you want to install. ### Install from a package -If you cannot use Docker's repository to install Docker Engine - Community, you can download the +If you cannot use Docker's repository to install Docker Engine, you can download the `.deb` file for your release and install it manually. You need to download a new file each time you want to upgrade Docker. 1. Go to [`{{ download-url-base }}/dists/`]({{ download-url-base }}/dists/){: target="_blank" class="_" }, - choose your Debian version, browse to `pool/stable/`, choose `amd64`, - `armhf`, or `arm64` and download the `.deb` file for the Docker Engine - Community version + choose your Debian version, then browse to `pool/stable/`, choose `amd64`, + `armhf`, or `arm64` and download the `.deb` file for the Docker version you want to install. - > **Note**: To install a **nightly** package, change the word - > `stable` in the URL to `nightly`. - > [Learn about **nightly** and **test** channels](/install/index.md). + > **Note**: To install a **nightly** or **test** (pre-release) package, + > change the word `stable` in the above URL to `nightly` or `test`. + > [Learn about **nightly** and **test** channels](index.md). -2. Install Docker Engine - Community, changing the path below to the path where you downloaded +2. Install Docker Engine, changing the path below to the path where you downloaded the Docker package. ```bash @@ -250,7 +243,7 @@ a new file each time you want to upgrade Docker. The Docker daemon starts automatically. -3. Verify that Docker Engine - Community is installed correctly by running the `hello-world` +3. Verify that Docker Engine is installed correctly by running the `hello-world` image. ```bash @@ -260,25 +253,25 @@ a new file each time you want to upgrade Docker. This command downloads a test image and runs it in a container. When the container runs, it prints an informational message and exits. -Docker Engine - Community is installed and running. The `docker` group is created but no users +Docker Engine is installed and running. The `docker` group is created but no users are added to it. You need to use `sudo` to run Docker commands. -Continue to [Post-installation steps for Linux](/install/linux/linux-postinstall.md) -to allow non-privileged users to run Docker commands and for other optional -configuration steps. +Continue to [Post-installation steps for Linux](linux-postinstall.md) to allow +non-privileged users to run Docker commands and for other optional configuration +steps. -#### Upgrade Docker Engine - Community +#### Upgrade Docker Engine -To upgrade Docker Engine - Community, download the newer package file and repeat the +To upgrade Docker Engine, download the newer package file and repeat the [installation procedure](#install-from-a-package), pointing to the new file. {% include install-script.md %} -## Uninstall Docker Engine - Community +## Uninstall Docker Engine -1. Uninstall the Docker Engine - Community package: +1. Uninstall the Docker Engine, CLI, and Containerd packages: ```bash - $ sudo apt-get purge docker-ce + $ sudo apt-get purge docker-ce docker-ce-cli containerd.io ``` 2. Images, containers, volumes, or customized configuration files on your host @@ -293,5 +286,5 @@ You must delete any edited configuration files manually. ## Next steps -- Continue to [Post-installation steps for Linux](/install/linux/linux-postinstall.md). +- Continue to [Post-installation steps for Linux](linux-postinstall.md). - Review the topics in [Develop with Docker](/develop/index.md) to learn how to build new applications using Docker. diff --git a/install/linux/docker-ce/fedora.md b/engine/install/fedora.md similarity index 70% rename from install/linux/docker-ce/fedora.md rename to engine/install/fedora.md index 85e39f2c41..dfd08bdb8b 100644 --- a/install/linux/docker-ce/fedora.md +++ b/engine/install/fedora.md @@ -1,27 +1,27 @@ --- -description: Instructions for installing Docker Engine - Community on Fedora +description: Instructions for installing Docker Engine on Fedora keywords: requirements, apt, installation, fedora, rpm, install, uninstall, upgrade, update redirect_from: - /engine/installation/fedora/ - /engine/installation/linux/fedora/ - /engine/installation/linux/docker-ce/fedora/ -title: Get Docker Engine - Community for Fedora +- /install/linux/docker-ce/fedora/ +title: Install Docker Engine on Fedora toc_max: 4 --- -To get started with Docker Engine - Community on Fedora, make sure you +To get started with Docker Engine on Fedora, make sure you [meet the prerequisites](#prerequisites), then -[install Docker](#install-docker-ce). +[install Docker](#installation-methods). ## Prerequisites - ### OS requirements -To install Docker, you need the 64-bit version of one of these Fedora versions: +To install Docker Engine, you need the 64-bit version of one of these Fedora versions: -- 30 -- 31 +- Fedora 30 +- Fedora 31 ### Uninstall old versions @@ -44,11 +44,11 @@ $ sudo dnf remove docker \ It's OK if `dnf` reports that none of these packages are installed. The contents of `/var/lib/docker/`, including images, containers, volumes, and -networks, are preserved. The Docker Engine - Community package is now called `docker-ce`. +networks, are preserved. The Docker Engine package is now called `docker-ce`. -## Install Docker Engine - Community +## Installation methods -You can install Docker Engine - Community in different ways, depending on your needs: +You can install Docker Engine in different ways, depending on your needs: - Most users [set up Docker's repositories](#install-using-the-repository) and install @@ -65,7 +65,7 @@ You can install Docker Engine - Community in different ways, depending on your n ### Install using the repository -Before you install Docker Engine - Community for the first time on a new host machine, you need +Before you install Docker Engine for the first time on a new host machine, you need to set up the Docker repository. Afterward, you can install and update Docker from the repository. @@ -73,20 +73,18 @@ from the repository. {% assign download-url-base = "https://download.docker.com/linux/fedora" %} -1. Install the `dnf-plugins-core` package which provides the commands to manage - your DNF repositories from the command line. +Install the `dnf-plugins-core` package (which provides the commands to manage +your DNF repositories) and set up the **stable** repository. - ```bash - $ sudo dnf -y install dnf-plugins-core - ``` +```bash +$ sudo dnf -y install dnf-plugins-core -2. Use the following command to set up the **stable** repository. +$ sudo dnf -y install dnf-plugins-core - ```bash - $ sudo dnf config-manager \ - --add-repo \ - {{ download-url-base }}/docker-ce.repo - ``` +$ sudo dnf config-manager \ + --add-repo \ + {{ download-url-base }}/docker-ce.repo +``` > **Optional**: Enable the **nightly** or **test** repositories. > @@ -113,11 +111,11 @@ from the repository. > $ sudo dnf config-manager --set-disabled docker-ce-nightly > ``` > -> [Learn about **nightly** and **test** channels](/install/index.md). +> [Learn about **nightly** and **test** channels](index.md). -#### Install Docker Engine - Community +#### Install Docker Engine -1. Install the _latest version_ of Docker Engine - Community and containerd, or go to the next step to install a specific version: +1. Install the _latest version_ of Docker Engine and containerd, or go to the next step to install a specific version: ```bash $ sudo dnf install docker-ce docker-ce-cli containerd.io @@ -135,7 +133,7 @@ from the repository. Docker is installed but not started. The `docker` group is created, but no users are added to the group. -2. To install a _specific version_ of Docker Engine - Community, list the available versions +2. To install a _specific version_ of Docker Engine, list the available versions in the repo, then select and install: a. List and sort the versions available in your repo. This example sorts @@ -179,7 +177,7 @@ from the repository. $ sudo systemctl start docker ``` -5. Verify that Docker Engine - Community is installed correctly by running the `hello-world` +5. Verify that Docker Engine is installed correctly by running the `hello-world` image. ```bash @@ -189,44 +187,47 @@ from the repository. This command downloads a test image and runs it in a container. When the container runs, it prints an informational message and exits. -Docker Engine - Community is installed and running. You need to use `sudo` to run Docker -commands. Continue to [Linux postinstall](/install/linux/linux-postinstall.md) to allow +Docker Engine is installed and running. You need to use `sudo` to run Docker +commands. Continue to [Linux postinstall](linux-postinstall.md) to allow non-privileged users to run Docker commands and for other optional configuration steps. -#### Upgrade Docker Engine - Community +#### Upgrade Docker Engine -To upgrade Docker Engine - Community, follow the [installation instructions](#install-docker-ce), +To upgrade Docker Engine, follow the [installation instructions](#install-using-the-repository), choosing the new version you want to install. ### Install from a package If you cannot use Docker's repository to install Docker, you can download the `.rpm` file for your release and install it manually. You need to download -a new file each time you want to upgrade Docker Engine - Community. +a new file each time you want to upgrade Docker Engine. -1. Go to [{{ download-url-base }}/]({{ download-url-base }}/) and choose your - version of Fedora. Go to `x86_64/stable/Packages/` +1. Go to [{{ download-url-base }}/]({{ download-url-base }}/){: target="_blank" class="_" } + and choose your version of Fedora. Then browse to `x86_64/stable/Packages/` and download the `.rpm` file for the Docker version you want to install. - > **Note**: To install a **nightly** or **test** (pre-release) package, + > **Note**: To install a **nightly** or **test** (pre-release) package, > change the word `stable` in the above URL to `nightly` or `test`. - > [Learn about **nightly** and **test** channels](/install/index.md). + > [Learn about **nightly** and **test** channels](index.md). -2. Install Docker Engine - Community, changing the path below to the path where you downloaded +2. Install Docker Engine, changing the path below to the path where you downloaded the Docker package. ```bash $ sudo dnf -y install /path/to/package.rpm ``` + Docker is installed but not started. The `docker` group is created, but no + users are added to the group. + 3. Start Docker. ```bash $ sudo systemctl start docker ``` -4. Verify that Docker Engine - Community is installed correctly by running the `hello-world` +4. Verify that Docker Engine is installed correctly by running the `hello-world` image. ```bash @@ -236,25 +237,25 @@ a new file each time you want to upgrade Docker Engine - Community. This command downloads a test image and runs it in a container. When the container runs, it prints an informational message and exits. -Docker Engine - Community is installed and running. You need to use `sudo` to run Docker commands. -Continue to [Post-installation steps for Linux](/install/linux/linux-postinstall.md) to allow +Docker Engine is installed and running. You need to use `sudo` to run Docker commands. +Continue to [Post-installation steps for Linux](linux-postinstall.md) to allow non-privileged users to run Docker commands and for other optional configuration steps. -#### Upgrade Docker Engine - Community +#### Upgrade Docker Engine -To upgrade Docker Engine - Community, download the newer package file and repeat the +To upgrade Docker Engine, download the newer package file and repeat the [installation procedure](#install-from-a-package), using `dnf -y upgrade` instead of `dnf -y install`, and pointing to the new file. {% include install-script.md %} -## Uninstall Docker Engine - Community +## Uninstall Docker Engine -1. Uninstall the Docker package: +1. Uninstall the Docker Engine, CLI, and Containerd packages: ```bash - $ sudo dnf remove docker-ce + $ sudo dnf remove docker-ce docker-ce-cli containerd.io ``` 2. Images, containers, volumes, or customized configuration files on your host @@ -269,5 +270,5 @@ You must delete any edited configuration files manually. ## Next steps -- Continue to [Post-installation steps for Linux](/install/linux/linux-postinstall.md). +- Continue to [Post-installation steps for Linux](linux-postinstall.md). - Review the topics in [Develop with Docker](/develop/index.md) to learn how to build new applications using Docker. diff --git a/install/index.md b/engine/install/index.md similarity index 61% rename from install/index.md rename to engine/install/index.md index ef26f16de3..0243fd2f55 100644 --- a/install/index.md +++ b/engine/install/index.md @@ -1,10 +1,8 @@ --- -title: Docker Engine overview +title: Install Docker Engine description: Lists the installation methods -keywords: docker, installation, install, Docker Engine - Community, Docker Engine - Enterprise, docker editions, stable, edge +keywords: docker, installation, install, Docker Engine, Docker Engine, docker editions, stable, edge redirect_from: -- /install/overview/ -- /installation/ - /engine/installation/linux/ - /engine/installation/linux/frugalware/ - /engine/installation/frugalware/ @@ -16,8 +14,6 @@ redirect_from: - /engine/installation/linux/docker-ee/ - /engine/installation/ - /en/latest/installation/ -- /linux/ -- /edge/ toc_max: 2 --- @@ -44,31 +40,28 @@ For more information, see [Release channels](#release-channels). ## Supported platforms -Docker Engine is available on a variety of Linux platforms, [Mac](/docker-for-mac/install/) -and [Windows](/docker-for-windows/install/) through Docker Desktop, Windows +Docker Engine is available on a variety of Linux platforms, [Mac](/docker-for-mac/install.md) +and [Windows](/docker-for-windows/install.md) through Docker Desktop, Windows Server, and as a static binary installation. Find your preferred operating system below. #### Desktop -{% assign green-check = '![yes](/install/images/green-check.svg){: style="height: 14px; margin: 0 auto"}' %} +{% assign yes = '![yes](/install/images/green-check.svg){: style="height: 14px; margin: 0 auto"}' %} -| Platform | x86_64 | -|:----------------------------------------------------------------------------|:-----------------:| -| [Docker Desktop for Mac (macOS)](/docker-for-mac/install/) | {{ green-check }} | -| [Docker Desktop for Windows (Microsoft Windows 10)](/docker-for-windows/install/) | {{ green-check }} | +| Platform | x86_64 / amd64 | +|:-------------------------------------------------------------|:-------------------------------------------:| +| [Docker Desktop for Mac (macOS)](/docker-for-mac/install.md) | [{{ yes }}](/docker-for-mac/install.md) | +| [Docker Desktop for Windows](/docker-for-windows/install.md) | [{{ yes }}](/docker-for-windows/install.md) | #### Server -{% assign green-check = '![yes](/install/images/green-check.svg){: style="height: 14px; margin: 0 auto"}' %} -{% assign install-prefix-ce = '/install/linux/docker-ce' %} - -| Platform | x86_64 / amd64 | ARM | ARM64 / AARCH64 | IBM Power (ppc64le) | IBM Z (s390x) | -|:--------------------------------------------|:-------------------------------------------------------|:-------------------------------------------------------|:-------------------------------------------------------|:-------------------------------------------------------|:-------------------------------------------------------| -| [CentOS]({{ install-prefix-ce }}/centos/) | [{{ green-check }}]({{ install-prefix-ce }}/centos/) | | [{{ green-check }}]({{ install-prefix-ce }}/centos/) | | | -| [Debian]({{ install-prefix-ce }}/debian/) | [{{ green-check }}]({{ install-prefix-ce }}/debian/) | [{{ green-check }}]({{ install-prefix-ce }}/debian/) | [{{ green-check }}]({{ install-prefix-ce }}/debian/) | | | -| [Fedora]({{ install-prefix-ce }}/fedora/) | [{{ green-check }}]({{ install-prefix-ce }}/fedora/) | | [{{ green-check }}]({{ install-prefix-ce }}/fedora/) | | | -| [Ubuntu]({{ install-prefix-ce }}/ubuntu/) | [{{ green-check }}]({{ install-prefix-ce }}/ubuntu/) | [{{ green-check }}]({{ install-prefix-ce }}/ubuntu/) | [{{ green-check }}]({{ install-prefix-ce }}/ubuntu/) | [{{ green-check }}]({{ install-prefix-ce }}/ubuntu/) | [{{ green-check }}]({{ install-prefix-ce }}/ubuntu/) | +| Platform | x86_64 / amd64 | ARM | ARM64 / AARCH64 | IBM Power (ppc64le) | IBM Z (s390x) | +|:----------------------|:-----------------------|:-------------------------|:-----------------------|:-----------------------|:-----------------------| +| [CentOS](centos.md) | [{{ yes }}](centos.md) | | [{{ yes }}](centos.md) | | | +| [Debian](debian.md) | [{{ yes }}](debian.md) | [{{ yes }}](debian.md) | [{{ yes }}](debian.md) | | | +| [Fedora](fedora.md) | [{{ yes }}](fedora.md) | | [{{ yes }}](fedora.md) | | | +| [Ubuntu](ubuntu.md) | [{{ yes }}](ubuntu.md) | [{{ yes }}](ubuntu.md) | [{{ yes }}](ubuntu.md) | [{{ yes }}](ubuntu.md) | [{{ yes }}](ubuntu.md) | ## Release channels @@ -118,8 +111,8 @@ The release channel for these builds is called `nightly`. ## Support -Docker Engine releases of a year-month branch are supported with patches as needed for 7 months after the first year-month general availability -release. +Docker Engine releases of a year-month branch are supported with patches as +needed for one month after the the next year-month general availability release. This means bug reports and backports to release branches are assessed until the end-of-life date. @@ -161,4 +154,4 @@ for it. ## Get started After setting up Docker, you can learn the basics with -[Getting started with Docker](/get-started/). +[Getting started with Docker](/get-started/index.md). diff --git a/install/linux/linux-postinstall.md b/engine/install/linux-postinstall.md similarity index 99% rename from install/linux/linux-postinstall.md rename to engine/install/linux-postinstall.md index 92a7f0257c..a30d0a50d2 100644 --- a/install/linux/linux-postinstall.md +++ b/engine/install/linux-postinstall.md @@ -5,6 +5,7 @@ title: Post-installation steps for Linux redirect_from: - /engine/installation/linux/docker-ee/linux-postinstall/ - /engine/installation/linux/linux-postinstall/ +- /install/linux/linux-postinstall/ --- This section contains optional procedures for configuring Linux hosts to work diff --git a/install/linux/docker-ce/ubuntu.md b/engine/install/ubuntu.md similarity index 68% rename from install/linux/docker-ce/ubuntu.md rename to engine/install/ubuntu.md index d55a0798a8..75192d0095 100644 --- a/install/linux/docker-ce/ubuntu.md +++ b/engine/install/ubuntu.md @@ -1,27 +1,28 @@ --- -description: Instructions for installing Docker Engine - Community on Ubuntu +description: Instructions for installing Docker Engine on Ubuntu keywords: requirements, apt, installation, ubuntu, install, uninstall, upgrade, update redirect_from: - /engine/installation/ubuntulinux/ - /installation/ubuntulinux/ +- /engine/installation/linux/ubuntu/ - /engine/installation/linux/ubuntulinux/ - /engine/installation/linux/docker-ce/ubuntu/ - /install/linux/ubuntu/ -- /engine/installation/linux/ubuntu/ -title: Get Docker Engine - Community for Ubuntu +- /install/linux/docker-ce/debian/ +title: Install Docker Engine on Ubuntu toc_max: 4 --- -To get started with Docker Engine - Community on Ubuntu, make sure you +To get started with Docker Engine on Ubuntu, make sure you [meet the prerequisites](#prerequisites), then -[install Docker](#install-docker-engine---community-1). +[install Docker](#installation-methods). ## Prerequisites ### Docker EE customers To install Docker Enterprise Edition (Docker EE), go to -[Get Docker EE for Ubuntu](/install/linux/docker-ee/ubuntu.md) +[Get Docker EE for Ubuntu](/ee/docker-ee/ubuntu.md) **instead of this topic**. To learn more about Docker EE, see @@ -29,14 +30,14 @@ To learn more about Docker EE, see ### OS requirements -To install Docker Engine - Community, you need the 64-bit version of one of these Ubuntu +To install Docker Engine, you need the 64-bit version of one of these Ubuntu versions: - Eoan 19.10 - Bionic 18.04 (LTS) - Xenial 16.04 (LTS) -Docker Engine - Community is supported on `x86_64` (or `amd64`), `armhf`, `arm64`, `s390x` +Docker Engine is supported on `x86_64` (or `amd64`), `armhf`, `arm64`, `s390x` (IBM Z), and `ppc64le` (IBM Power) architectures. ### Uninstall old versions @@ -51,22 +52,19 @@ $ sudo apt-get remove docker docker-engine docker.io containerd runc It's OK if `apt-get` reports that none of these packages are installed. The contents of `/var/lib/docker/`, including images, containers, volumes, and -networks, are preserved. The Docker Engine - Community package is now called `docker-ce`. +networks, are preserved. The Docker Engine package is now called `docker-ce`. ### Supported storage drivers -Docker Engine - Community on Ubuntu supports `overlay2`, `aufs` and `btrfs` storage drivers. -> **Note**: In Docker Engine - Enterprise, `btrfs` is only supported on SLES. See the documentation on -> [btrfs](/engine/userguide/storagedriver/btrfs-driver.md) for more details. +Docker Engine on Ubuntu supports `overlay2`, `aufs` and `btrfs` storage drivers. -For new installations on version 4 and higher of the Linux kernel, `overlay2` -is supported and preferred over `aufs`. Docker Engine - Community uses the `overlay2` -storage driver by default. If you need to use `aufs` instead, you need to -configure it manually. See [aufs](/engine/userguide/storagedriver/aufs-driver.md) +Docker Engine uses the `overlay2` storage driver by default. If you need to use +`aufs` instead, you need to configure it manually. +See [use the AUFS storage driver](/storage/storagedriver/aufs-driver.md) -## Install Docker Engine - Community +## Installation methods -You can install Docker Engine - Community in different ways, depending on your needs: +You can install Docker Engine in different ways, depending on your needs: - Most users [set up Docker's repositories](#install-using-the-repository) and install @@ -83,7 +81,7 @@ You can install Docker Engine - Community in different ways, depending on your n ### Install using the repository -Before you install Docker Engine - Community for the first time on a new host machine, you need +Before you install Docker Engine for the first time on a new host machine, you need to set up the Docker repository. Afterward, you can install and update Docker from the repository. @@ -91,15 +89,12 @@ from the repository. {% assign download-url-base = "https://download.docker.com/linux/ubuntu" %} -1. Update the `apt` package index: +1. Update the `apt` package index and install packages to allow `apt` to use a + repository over HTTPS: ```bash $ sudo apt-get update - ``` -2. Install packages to allow `apt` to use a repository over HTTPS: - - ```bash $ sudo apt-get install \ apt-transport-https \ ca-certificates \ @@ -108,7 +103,7 @@ from the repository. software-properties-common ``` -3. Add Docker's official GPG key: +2. Add Docker's official GPG key: ```bash $ curl -fsSL {{ download-url-base }}/gpg | sudo apt-key add - @@ -120,16 +115,16 @@ from the repository. ```bash $ sudo apt-key fingerprint 0EBFCD88 - + pub rsa4096 2017-02-22 [SCEA] 9DC8 5822 9FC7 DD38 854A E2D8 8D81 803C 0EBF CD88 uid [ unknown] Docker Release (CE deb) sub rsa4096 2017-02-22 [S] ``` -4. Use the following command to set up the **stable** repository. To add the +3. Use the following command to set up the **stable** repository. To add the **nightly** or **test** repository, add the word `nightly` or `test` (or both) - after the word `stable` in the commands below. [Learn about **nightly** and **test** channels](/install/index.md). + after the word `stable` in the commands below. [Learn about **nightly** and **test** channels](index.md). > **Note**: The `lsb_release -cs` sub-command below returns the name of your > Ubuntu distribution, such as `xenial`. Sometimes, in a distribution @@ -138,7 +133,6 @@ from the repository. > `Linux Mint Tessa`, you could use `bionic`. Docker does not offer any guarantees on untested > and unsupported Ubuntu distributions. -