Engine install freshness (#18464)

* create includes and refresh engine install docs

* freshness cleanup

* simplify sentence

* remove includes and add consistent spelling for apt

* Implement feedback

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

---------

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
Stephanie Aurelio 2023-10-20 08:40:30 -07:00 committed by GitHub
parent f54b50a206
commit ae798c90b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 93 additions and 98 deletions

View File

@ -50,8 +50,8 @@ To install Docker Desktop successfully, you must:
Recommended approach to install Docker Desktop on Debian:
1. Set up Docker's Apt repository.
See [Install using the Apt repository, step 1](../../engine/install/debian.md#install-using-the-repository).
1. Set up Docker's `apt` repository.
See [Install using the `apt` repository, step 1](../../engine/install/debian.md#install-using-the-repository).
2. Download latest [DEB package](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.2-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64).

View File

@ -51,7 +51,7 @@ To install Docker Desktop successfully, you must:
Recommended approach to install Docker Desktop on Ubuntu:
1. Set up Docker's package repository.
See [Install using the Apt repository, step 1](../../engine/install/ubuntu.md#install-using-the-repository).
See [Install using the `apt` repository, step 1](../../engine/install/ubuntu.md#install-using-the-repository).
2. Download latest [DEB package](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.2-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64).

View File

@ -1,10 +1,10 @@
---
title: Install Docker Engine
description: Choose the best method for you to install Docker Engine. This client-server
description: Learn how to choose the best method for you to install Docker Engine. This client-server
application is available on Linux, Mac, Windows, and as a static binary.
keywords: install engine, docker engine install, install docker engine, docker engine
installation, engine install, docker ce installation, docker ce install, engine
installer, installing docker engine, docker server install
installer, installing docker engine, docker server install, docker desktop vs docker engine
aliases:
- /cs-engine/
- /cs-engine/1.12/
@ -53,9 +53,9 @@ your preferred operating system below.
| Platform | x86_64 / amd64 | arm64 (Apple Silicon) |
| :--------------------------------------------------------------------- | :---------------------------------------------------: | :-----------------------------------------------: |
| [Docker Desktop for Linux](../../desktop/install/linux-install.md) | [ ](../../desktop/install/linux-install.md) | |
| [Docker Desktop for Mac (macOS)](../../desktop/install/mac-install.md) | [ ](../../desktop/install/mac-install.md) | [ ](../../desktop/install/mac-install.md) |
| [Docker Desktop for Windows](../../desktop/install/windows-install.md) | [ ](../../desktop/install/windows-install.md) | |
| [Docker Desktop for Linux](../../desktop/install/linux-install.md) | [✅](../../desktop/install/linux-install.md) | |
| [Docker Desktop for Mac (macOS)](../../desktop/install/mac-install.md) | [✅](../../desktop/install/mac-install.md) | [✅](../../desktop/install/mac-install.md) |
| [Docker Desktop for Windows](../../desktop/install/windows-install.md) | [✅](../../desktop/install/windows-install.md) | |
### Server
@ -64,36 +64,36 @@ and architectures:
| Platform | x86_64 / amd64 | arm64 / aarch64 | arm (32-bit) | ppc64le | s390x |
| :--------------------------------------------- | :------------------ | :------------------ | :------------------------- | :---------------- | :---------------- |
| [CentOS](centos.md) | [ ](centos.md) | [ ](centos.md) | | [ ](centos.md) | |
| [Debian](debian.md) | [ ](debian.md) | [ ](debian.md) | [ ](debian.md) | [ ](debian.md) | |
| [Fedora](fedora.md) | [ ](fedora.md) | [ ](fedora.md) | | [ ](fedora.md) | |
| [Raspberry Pi OS (32-bit)](raspberry-pi-os.md) | | | [ ](raspberry-pi-os.md) | | |
| [RHEL](rhel.md) | | | | | [ ](rhel.md) |
| [SLES](sles.md) | | | | | [ ](sles.md) |
| [Ubuntu](ubuntu.md) | [ ](ubuntu.md) | [ ](ubuntu.md) | [ ](ubuntu.md) | [ ](ubuntu.md) | [ ](ubuntu.md) |
| [Binaries](binaries.md) | [ ](binaries.md) | [ ](binaries.md) | [ ](binaries.md) | | |
| [CentOS](centos.md) | [✅](centos.md) | [✅](centos.md) | | [✅](centos.md) | |
| [Debian](debian.md) | [✅](debian.md) | [✅](debian.md) | [✅](debian.md) | [✅](debian.md) | |
| [Fedora](fedora.md) | [✅](fedora.md) | [✅](fedora.md) | | [✅](fedora.md) | |
| [Raspberry Pi OS (32-bit)](raspberry-pi-os.md) | | | [✅](raspberry-pi-os.md) | | |
| [RHEL](rhel.md) | | | | | [✅](rhel.md) |
| [SLES](sles.md) | | | | | [✅](sles.md) |
| [Ubuntu](ubuntu.md) | [✅](ubuntu.md) | [✅](ubuntu.md) | [✅](ubuntu.md) | [✅](ubuntu.md) | [✅](ubuntu.md) |
| [Binaries](binaries.md) | [✅](binaries.md) | [✅](binaries.md) | [✅](binaries.md) | | |
### Other Linux distros
> **Note**
>
> While the instructions below may work, Docker doesn't test or verify
> While the following instructions may work, Docker doesn't test or verify
> installation on distro derivatives.
- Users of Debian derivatives such as "BunsenLabs Linux", "Kali Linux" or
- If you use Debian derivatives such as "BunsenLabs Linux", "Kali Linux" or
"LMDE" (Debian-based Mint) should follow the installation instructions for
[Debian](debian.md), substituting the version of their distro for the
[Debian](debian.md), substitute the version of your distro for the
corresponding Debian release. Refer to the documentation of your distro to find
which Debian release corresponds with your derivative version.
- Likewise, users of Ubuntu derivatives such as "Kubuntu", "Lubuntu" or "Xubuntu"
should follow the installation instructions for [Ubuntu](ubuntu.md),
substituting the version of their distro for the corresponding Ubuntu release.
- Likewise, if you use Ubuntu derivatives such as "Kubuntu", "Lubuntu" or "Xubuntu"
you should follow the installation instructions for [Ubuntu](ubuntu.md),
substituting the version of your distro for the corresponding Ubuntu release.
Refer to the documentation of your distro to find which Ubuntu release
corresponds with your derivative version.
- Some Linux distros provide a package of Docker Engine through their
package repositories. These packages are built and maintained by the Linux
distro's package maintainers and may have differences in configuration
or built from modified source code. Docker isn't involved in releasing these
or are built from modified source code. Docker isn't involved in releasing these
packages and you should report any bugs or issues involving these packages to
your Linux distro's issue tracker.
@ -104,8 +104,8 @@ These binaries are statically linked and you can use them on any Linux distro.
Docker Engine has two types of update channels, **stable** and **test**:
* The **Stable** channel gives you the latest versions released for general availability.
* The **Test** channel gives you pre-release versions that are ready for testing before
* The **stable** channel gives you the latest versions released for general availability.
* The **test** channel gives you pre-release versions that are ready for testing before
general availability.
Use the test channel with caution. Pre-release versions include experimental and

View File

@ -1,7 +1,6 @@
---
description: Instructions for installing Docker as a binary. Mostly meant for hackers
who want to try out Docker on a variety of environments.
keywords: binaries, installation, docker, documentation, linux
description: Learn how to install Docker as a binary. These instructions are most suitable for testing purposes.
keywords: binaries, installation, docker, documentation, linux, install docker engine
title: Install Docker Engine from binaries
aliases:
- /engine/installation/binaries/
@ -14,8 +13,7 @@ aliases:
>
> This page contains information on how to install Docker using binaries. These
> instructions are mostly suitable for testing purposes. We do not recommend
> installing Docker using binaries in production environments as they will not be
> updated automatically with security updates. The Linux binaries described on this
> installing Docker using binaries in production environments as they don't have automatic security updates. The Linux binaries described on this
> page are statically linked, which means that vulnerabilities in build-time
> dependencies are not automatically patched by security updates of your Linux
> distribution.
@ -81,7 +79,7 @@ either of the two. This helps improve security and blocks certain
types of exploits. Review the documentation for your Linux distribution for
instructions for enabling and configuring AppArmor or SELinux.
> Security Warning
> **Security warning**
>
> If either of the security mechanisms is enabled, do not disable it as a
> work-around to make Docker or its containers run. Instead, configure it
@ -208,7 +206,7 @@ To install client binaries, perform the following steps:
> The following section describes how to install the Docker daemon on Windows
> Server which allows you to run Windows containers only. When you install the
> Docker daemon on Windows Server, the daemon doesn't contain Docker components
> such as `buildx` and `compose`. If you are running Windows 10 or 11,
> such as `buildx` and `compose`. If you're running Windows 10 or 11,
> we recommend that you install [Docker Desktop](../../desktop/index.md) instead.
Binary packages on Windows include both `dockerd.exe` and `docker.exe`. On Windows,

View File

@ -33,12 +33,11 @@ CentOS versions:
- CentOS 9 (stream)
The `centos-extras` repository must be enabled. This repository is enabled by
default, but if you have disabled it, you need to
[re-enable it](https://wiki.centos.org/AdditionalResources/Repositories).
default. If you have disabled it, you need to re-enable it.
### Uninstall old versions
Older versions of Docker went by the names of `docker` or `docker-engine`.
Older versions of Docker went by `docker` or `docker-engine`.
Uninstall any such older versions before attempting to install a new version,
along with associated dependencies.
@ -67,8 +66,8 @@ You can install Docker Engine in different ways, depending on your needs:
from them, for ease of installation and upgrade tasks. This is the
recommended approach.
- You can download the RPM package and
[install it manually](#install-from-a-package) and manage
- You can download the RPM package,
[install it manually](#install-from-a-package), and manage
upgrades completely manually. This is useful in situations such as installing
Docker on air-gapped systems with no access to the internet.
@ -83,7 +82,6 @@ Docker from the repository.
#### Set up the repository
Install the `yum-utils` package (which provides the `yum-config-manager`
utility) and set up the repository.
@ -181,7 +179,7 @@ download a new file each time you want to upgrade Docker Engine.
and choose your version of CentOS. Then browse to `x86_64/stable/Packages/`
and download the `.rpm` file for the Docker version you want to install.
2. Install Docker Engine, changing the path below to the path where you downloaded
2. Install Docker Engine, changing the following path to the path where you downloaded
the Docker package.
```console

View File

@ -1,6 +1,7 @@
---
description: Instructions for installing Docker Engine on Debian
keywords: requirements, apt, installation, debian, install, uninstall, upgrade, update
description: Learn how to install Docker Engine on Debian. These instructions cover
the different installation methods, how to uninstall, and next steps.
keywords: requirements, apt, installation, debian, install, uninstall, install debian, docker engine, install docker engine, upgrade, update
title: Install Docker Engine on Debian
toc_max: 4
aliases:
@ -37,11 +38,10 @@ and ppc64le (ppc64el) architectures.
### Uninstall old versions
Before you can install Docker Engine, you must first make sure that any
conflicting packages are uninstalled.
Before you can install Docker Engine, you need to uninstall any conflicting packages.
Distro maintainers provide an unofficial distribution of Docker packages in
their repositories. You must uninstall these packages before you can install the
Distro maintainers provide unofficial distributions of Docker packages in
their repositories. You must uninstall these packages before you can install the
official version of Docker Engine.
The unofficial packages to uninstall are:
@ -78,20 +78,20 @@ You can install Docker Engine in different ways, depending on your needs:
the easiest and quickest way to get started.
- Set up and install Docker Engine from
[Docker's Apt repository](#install-using-the-repository).
[Docker's `apt` repository](#install-using-the-repository).
- [Install it manually](#install-from-a-package) and manage upgrades manually.
- Use a [convenience scripts](#install-using-the-convenience-script). Only
- Use a [convenience script](#install-using-the-convenience-script). Only
recommended for testing and development environments.
### Install using the Apt repository {#install-using-the-repository}
### Install using the `apt` repository {#install-using-the-repository}
Before you install Docker Engine for the first time on a new host machine, you
need to set up the Docker Apt repository. Afterward, you can install and update
need to set up the Docker `apt` repository. Afterward, you can install and update
Docker from the repository.
1. Set up Docker's Apt repository.
1. Set up Docker's `apt` repository.
```bash
# Add Docker's official GPG key:

View File

@ -1,6 +1,7 @@
---
description: Instructions for installing Docker Engine on Fedora
keywords: requirements, apt, installation, fedora, rpm, install, uninstall, upgrade,
description: Learn how to install Docker Engine on Fedora. These instructions cover
the different installation methods, how to uninstall, and next steps.
keywords: requirements, apt, installation, fedora, install fedora, install docker engine, rpm, install, uninstall, upgrade,
update
title: Install Docker Engine on Fedora
toc_max: 4
@ -28,7 +29,7 @@ Fedora versions:
### Uninstall old versions
Older versions of Docker went by the names of `docker` or `docker-engine`.
Older versions of Docker went by `docker` or `docker-engine`.
Uninstall any such older versions before attempting to install a new version,
along with associated dependencies.
@ -59,8 +60,8 @@ You can install Docker Engine in different ways, depending on your needs:
from them, for ease of installation and upgrade tasks. This is the
recommended approach.
- You can download the RPM package and
[install it manually](#install-from-a-package) and manage
- You can download the RPM package,
[install it manually](#install-from-a-package), and manage
upgrades completely manually. This is useful in situations such as installing
Docker on air-gapped systems with no access to the internet.
@ -75,7 +76,6 @@ Docker from the repository.
#### Set up the repository
Install the `dnf-plugins-core` package (which provides the commands to manage
your DNF repositories) and set up the repository.
@ -172,7 +172,7 @@ download a new file each time you want to upgrade Docker Engine.
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.
2. Install Docker Engine, changing the path below to the path where you downloaded
2. Install Docker Engine, changing the following path to the path where you downloaded
the Docker package.
```console

View File

@ -11,7 +11,7 @@ aliases:
- /install/linux/linux-postinstall/
---
These optional post-installation procedures shows you how to configure your
These optional post-installation procedures describe how to configure your
Linux host machine to work better with Docker.
## Manage Docker as a non-root user

View File

@ -1,6 +1,7 @@
---
description: Instructions for installing Docker Engine on a 32-bit Raspberry Pi OS system
keywords: requirements, apt, installation, Raspberry Pi OS, install, uninstall, upgrade,
description: Learn how to install Docker Engine on a 32-bit Raspberry Pi OS system. These instructions cover
the different installation methods, how to uninstall, and next steps.
keywords: requirements, apt, installation, install docker engine, Raspberry Pi OS, install, uninstall, upgrade,
update
title: Install Docker Engine on Raspberry Pi OS (32-bit)
toc_max: 4
@ -32,15 +33,14 @@ To get started with Docker Engine on Raspberry Pi OS, make sure you
### OS requirements
The following OS versions are supported:
To install Docker Engine, you need one of the following OS versions:
- 32-bit Raspberry Pi OS Bookworm 12 (stable)
- 32-bit Raspberry Pi OS Bullseye 11 (oldstable)
### Uninstall old versions
Before you can install Docker Engine, you must first make sure that any
conflicting packages are uninstalled.
Before you can install Docker Engine, you need to uninstall any conflicting packages.
Distro maintainers provide an unofficial distributions of Docker packages in
APT. You must uninstall these packages before you can install the official
@ -84,16 +84,16 @@ You can install Docker Engine in different ways, depending on your needs:
- [Install it manually](#install-from-a-package) and manage upgrades manually.
- Use a [convenience scripts](#install-using-the-convenience-script). Only
- Use a [convenience script](#install-using-the-convenience-script). Only
recommended for testing and development environments.
### Install using the apt repository {#install-using-the-repository}
### Install using the `apt` repository {#install-using-the-repository}
Before you install Docker Engine for the first time on a new host machine, you
need to set up the Docker Apt repository. Afterward, you can install and update
need to set up the Docker `apt` repository. Afterward, you can install and update
Docker from the repository.
1. Set up Docker's Apt repository.
1. Set up Docker's `apt` repository.
```bash
# Add Docker's official GPG key:
@ -103,7 +103,7 @@ Docker from the repository.
curl -fsSL {{% param "download-url-base" %}}/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
# Set up Docker's Apt repository:
# Set up Docker's APT repository:
echo \
"deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] {{% param "download-url-base" %}} \
"$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \

View File

@ -1,6 +1,7 @@
---
description: Instructions for installing Docker Engine on RHEL
keywords: requirements, apt, installation, rhel, rpm, install, uninstall, upgrade,
description: Learn how to install Docker Engine on RHEL. These instructions cover
the different installation methods, how to uninstall, and next steps.
keywords: requirements, apt, installation, rhel, rpm, install, install docker engine, uninstall, upgrade,
update, s390x, ibm-z
title: Install Docker Engine on RHEL
toc_max: 4
@ -39,7 +40,7 @@ RHEL versions:
### Uninstall old versions
Older versions of Docker went by the names of `docker` or `docker-engine`.
Older versions of Docker went by `docker` or `docker-engine`.
Uninstall any such older versions before attempting to install a new version,
along with associated dependencies. Also uninstall `Podman` and the associated
dependencies if installed already:
@ -71,8 +72,8 @@ You can install Docker Engine in different ways, depending on your needs:
from them, for ease of installation and upgrade tasks. This is the
recommended approach.
- You can download the RPM package and
[install it manually](#install-from-a-package) and manage
- You can download the RPM package,
[install it manually](#install-from-a-package), and manage
upgrades completely manually. This is useful in situations such as installing
Docker on air-gapped systems with no access to the internet.
@ -181,10 +182,10 @@ 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.
1. Go to [{{% param "download-url-base" %}}/]({{% param "download-url-base" %}}/)
and choose your version of RHEL. Then browse to `s390x/stable/Packages/`
and choose your version of RHEL. Then go to `s390x/stable/Packages/`
and download the `.rpm` file for the Docker version you want to install.
2. Install Docker Engine, changing the path below to the path where you downloaded
2. Install Docker Engine, changing the following path to the path where you downloaded
the Docker package.
```console

View File

@ -1,6 +1,7 @@
---
description: Instructions for installing Docker Engine on SLES
keywords: requirements, apt, installation, centos, rpm, sles, install, uninstall,
description: Learn how to install Docker Engine on SLES. These instructions cover
the different installation methods, how to uninstall, and next steps.
keywords: requirements, apt, installation, install docker engine, centos, rpm, sles, install, uninstall,
upgrade, update, s390x, ibm-z
title: Install Docker Engine on SLES
toc_max: 4
@ -42,11 +43,10 @@ SLES versions:
- SLES 15-SP3 on s390x (IBM Z)
- SLES 15-SP4 on s390x (IBM Z)
The [`SCC SUSE`](https://scc.suse.com/packages?name=SUSE%20Linux%20Enterprise%20Server&version=15.3&arch=s390x)
repositories must be enabled.
You must enable the [`SCC SUSE`](https://scc.suse.com/packages?name=SUSE%20Linux%20Enterprise%20Server&version=15.3&arch=s390x)
repositories.
The [OpenSUSE `SELinux` repository](https://download.opensuse.org/repositories/security)
must be enabled. This repository is not added by default, and you need to enable
You must enable the [OpenSUSE `SELinux` repository](https://download.opensuse.org/repositories/security). This repository is not added by default, and you need to enable
it for the version of SLES you are running. Run the following commands to add it:
For SLES 15-SP3:
@ -65,7 +65,7 @@ $ sudo zypper addrepo $opensuse_repo
### Uninstall old versions
Older versions of Docker went by the names of `docker` or `docker-engine`.
Older versions of Docker went by `docker` or `docker-engine`.
Uninstall any such older versions before attempting to install a new version,
along with associated dependencies.
@ -95,8 +95,8 @@ You can install Docker Engine in different ways, depending on your needs:
from them, for ease of installation and upgrade tasks. This is the
recommended approach.
- You can download the RPM package and
[install it manually](#install-from-a-package) and manage
- You can download the RPM package,
[install it manually](#install-from-a-package), and manage
upgrades completely manually. This is useful in situations such as installing
Docker on air-gapped systems with no access to the internet.
@ -111,7 +111,6 @@ Docker from the repository.
#### Set up the repository
Set up the repository.
```console
@ -205,7 +204,7 @@ download a new file each time you want to upgrade Docker Engine.
and choose your version of SLES. Then browse to `s390x/stable/Packages/`
and download the `.rpm` file for the Docker version you want to install.
2. Install Docker Engine, changing the path below to the path where you downloaded
2. Install Docker Engine, changing the following path to the path where you downloaded
the Docker package.
```console

View File

@ -1,7 +1,7 @@
---
title: Troubleshoot Docker Engine installation
description: Diagnose and resolve error messages related to the Docker Engine installation
keywords: Docker Engine, troubleshooting, error, Linux
description: Learn how to diagnose and resolve error messages related to the Docker Engine installation.
keywords: Docker Engine, troubleshooting, error, Linux, install Docker Engine
---
This page contains instructions for troubleshooting and diagnosing the Docker
@ -119,7 +119,7 @@ public nameservers aren't adequate. You have two choices:
- Specify DNS servers for Docker to use.
- Turn off `dnsmasq`.
Turning off `dnsmasq` adds the IP addresses of actual DNS nameserver to
Turning off `dnsmasq` adds the IP addresses of actual DNS nameservers to
`/etc/resolv.conf`, and you lose the benefits of `dnsmasq`.
You only need to use one of these methods.
@ -234,7 +234,7 @@ Two common firewall daemons are:
- [firewalld](https://firewalld.org), often used for RPM-based systems.
Consult the documentation for your OS and firewall. The following information
might help you get started. These settings used in this instruction are
might help you get started. The settings used in this instruction are
permissive, and you may want to use a different configuration that locks your
system down more.

View File

@ -1,6 +1,6 @@
---
description: Jumpstart your client-side server applications with Docker Engine on
Ubuntu. This guide details prerequisites and multiple methods to install.
Ubuntu. This guide details prerequisites and multiple methods to install Docker Engine on Ubuntu.
keywords: docker install script, ubuntu docker server, ubuntu server docker, install
docker engine ubuntu, install docker on ubuntu server, ubuntu 22.04 docker-ce, install
docker engine on ubuntu, ubuntu install docker ce, ubuntu install docker engine
@ -48,10 +48,9 @@ s390x, and ppc64le (ppc64el) architectures.
### Uninstall old versions
Before you can install Docker Engine, you must first make sure that any
conflicting packages are uninstalled.
Before you can install Docker Engine, you need to uninstall any conflicting packages.
Distro maintainers provide an unofficial distributions of Docker packages in
Distro maintainers provide unofficial distributions of Docker packages in
APT. You must uninstall these packages before you can install the official
version of Docker Engine.
@ -90,20 +89,20 @@ You can install Docker Engine in different ways, depending on your needs:
the easiest and quickest way to get started.
- Set up and install Docker Engine from
[Docker's Apt repository](#install-using-the-repository).
[Docker's `apt` repository](#install-using-the-repository).
- [Install it manually](#install-from-a-package) and manage upgrades manually.
- Use a [convenience script](#install-using-the-convenience-script). Only
recommended for testing and development environments.
### Install using the Apt repository {#install-using-the-repository}
### Install using the `apt` repository {#install-using-the-repository}
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.
1. Set up Docker's Apt repository.
1. Set up Docker's `apt` repository.
```bash
# Add Docker's official GPG key:

View File

@ -31,7 +31,7 @@ of the convenience script:
using the script to update an existing installation, dependencies may not be
updated to the expected version, resulting in outdated versions.
> Tip: preview script steps before running
> **Tip: preview script steps before running**
>
> You can run the script with the `--dry-run` option to learn what steps the
> script will run when invoked: