Install Docker Engine on Raspberry Pi OS (2023)

To get started with Docker Engine on Raspberry Pi OS, make sure youmeet the prerequisites, and then follow theinstallation steps.

Prerequisites

Note

If you use ufw or firewalld to manage firewall settings, be aware thatwhen you expose container ports using Docker, these ports bypass yourfirewall rules. For more information, refer toDocker and ufw.

OS requirements

To install Docker Engine, you need the 64-bit version or 32-bit version of one of these Raspberry Pi OSversions:

• Raspberry Pi OS Bookworm 12 (testing)
• Raspberry Pi OS Bullseye 11 (stable)
• Raspberry Pi OS Buster 10 (oldstable)

Docker Engine for Raspberry Pi OS is compatible with the armhf architecture.

For the 64-bit version of Raspberry Pi OS follow the instructions for Debian.

Uninstall old versions

Before you can install Docker Engine, you must first make sure that anyconflicting packages are uninstalled.

Distro maintainers provide an unofficial distributions of Docker packages inAPT. You must uninstall these packages before you can install the officialversion of Docker Engine.

The unofficial packages to uninstall are:

• docker.io
• docker-compose
• docker-doc
• podman-docker

Moreover, Docker Engine depends on containerd and runc. Docker Enginebundles these dependencies as one bundle: containerd.io. If you haveinstalled the containerd or runc previously, uninstall them to avoidconflicts with the versions bundled with Docker Engine.

Run the following command to uninstall all conflicting packages:

$ for pkg in docker.io docker-doc docker-compose podman-docker containerd runc; do sudo apt-get remove $pkg; done

apt-get might report that you have none of these packages installed.

Images, containers, volumes, and networks stored in /var/lib/docker/ aren’tautomatically removed when you uninstall Docker. If you want to start with aclean installation, and prefer to clean up any existing data, read theuninstall Docker Engine section.

Installation methods

You can install Docker Engine in different ways, depending on your needs:

• Docker Engine comes bundled withDocker Desktop for Linux. This isthe easiest and quickest way to get started.

• Set up and install Docker Engine fromDocker’s apt repository.

• Install it manually and manage upgrades manually.

  (Video) How To Install Docker on Raspberry Pi 4 - Run Docker Container on Raspberry Pi

• Use a convenience scripts. Onlyrecommended for testing and development environments.

Install using the apt repository

Before you install Docker Engine for the first time on a new host machine, youneed to set up the Docker repository. Afterward, you can install and updateDocker from the repository.

Set up the repository

1. Update the apt package index and install packages to allow apt to use arepository over HTTPS:

   $ sudo apt-get update$ sudo apt-get install ca-certificates curl gnupg

   See Also

   Como Instalar Archlinux en VirtualboxAnfängerleitfaden zur Installation von Arch Linux in VirtualBox – CodePre.comHow to install ArchLinux 2021 on VirtualBoxGuía para principiantes para instalar Arch Linux en VirtualBox – Rzldn.com

2. Add Docker’s official GPG key:

   $ sudo install -m 0755 -d /etc/apt/keyrings$ curl -fsSL https://download.docker.com/linux/raspbian/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg$ sudo chmod a+r /etc/apt/keyrings/docker.gpg

3. Use the following command to set up the repository:

   $ echo \ "deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/raspbian \ "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \ sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

4. Update the apt package index:

   $ sudo apt-get update

Install Docker Engine

1. Install Docker Engine, containerd, and Docker Compose.

   • Latest
   • Specific version
   
   

   To install the latest version, run:

    $ sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

   (Video) How to install Docker (and Portainer) on a RaspberryPi and run millions of apps on your RaspberryPi!

   To install a specific version of Docker Engine, start by listing the availableversions in the repository:

   # List the available versions:$ apt-cache madison docker-ce | awk '{ print $3 }'5:24.0.0-1~raspbian.11~bullseye5:23.0.6-1~raspbian.11~bullseye<...>

   Select the desired version and install:

   $ VERSION_STRING=5:24.0.0-1~raspbian.11~bullseye$ sudo apt-get install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING containerd.io docker-buildx-plugin docker-compose-plugin

2. Verify that the Docker Engine installation is successful by running thehello-world image:

   $ sudo docker run hello-world

   This command downloads a test image and runs it in a container. When thecontainer runs, it prints a confirmation message and exits.

You have now successfully installed and started Docker Engine.

Tip

Receiving errors when trying to run without root?

The docker user group exists but contains no users, which is why you’re required to use sudo to run Docker commands. Continue to Linux postinstall to allow non-privileged users to run Docker commands and for other optional configuration steps.

Upgrade Docker Engine

To upgrade Docker Engine, follow theinstallation instructions, choosing the new versionyou want to install.

Install from a package

If you can’t use Docker’s apt repository to install Docker Engine, you candownload the deb file for your release and install it manually. You need todownload a new file each time you want to upgrade Docker Engine.

1. Go to https://download.docker.com/linux/raspbian/dists/.

   (Video) Install Docker On Raspberry Pi 4

2. Select your Raspberry Pi OS version in the list.

3. Go to pool/stable/ and select the applicable architecture (amd64,armhf, arm64, or s390x).

4. Download the following deb files for the Docker Engine, CLI, containerd,and Docker Compose packages:

   • containerd.io_<version>_<arch>.deb
   • docker-ce_<version>_<arch>.deb
   • docker-ce-cli_<version>_<arch>.deb
   • docker-buildx-plugin_<version>_<arch>.deb
   • docker-compose-plugin_<version>_<arch>.deb

5. Install the .deb packages. Update the paths in the following example towhere you downloaded the Docker packages.

   $ sudo dpkg -i ./containerd.io_<version>_<arch>.deb \ ./docker-ce_<version>_<arch>.deb \ ./docker-ce-cli_<version>_<arch>.deb \ ./docker-buildx-plugin_<version>_<arch>.deb \ ./docker-compose-plugin_<version>_<arch>.deb

   The Docker daemon starts automatically.

6. Verify that the Docker Engine installation is successful by running thehello-world image:

   $ sudo service docker start$ sudo docker run hello-world

   This command downloads a test image and runs it in a container. When thecontainer runs, it prints a confirmation message and exits.

You have now successfully installed and started Docker Engine.

Tip

Receiving errors when trying to run without root?

The docker user group exists but contains no users, which is why you’re required to use sudo to run Docker commands. Continue to Linux postinstall to allow non-privileged users to run Docker commands and for other optional configuration steps.

Upgrade Docker Engine

To upgrade Docker Engine, download the newer package files and repeat theinstallation procedure, pointing to the new files.

Install using the convenience script

Docker provides a convenience script athttps://get.docker.com/ to install Docker intodevelopment environments non-interactively. The convenience script isn’trecommended for production environments, but it’s useful for creating aprovisioning script tailored to your needs. Also refer to theinstall using the repository steps to learnabout installation steps to install using the package repository. The source codefor the script is open source, and you can find it in thedocker-install repository on GitHub.

Always examine scripts downloaded from the internet before running them locally.Before installing, make yourself familiar with potential risks and limitationsof the convenience script:

• The script requires root or sudo privileges to run.
• The script attempts to detect your Linux distribution and version andconfigure your package management system for you.
• The script doesn’t allow you to customize most installation parameters.
• The script installs dependencies and recommendations without asking forconfirmation. This may install a large number of packages, depending on thecurrent configuration of your host machine.
• By default, the script installs the latest stable release of Docker,containerd, and runc. When using this script to provision a machine, this mayresult in unexpected major version upgrades of Docker. Always test upgrades ina test environment before deploying to your production systems.
• The script isn’t designed to upgrade an existing Docker installation. Whenusing the script to update an existing installation, dependencies may not beupdated to the expected version, resulting in outdated versions.

Tip: preview script steps before running

(Video) Raspberry Pi 4 - How To Install Docker On Raspberry Pi

You can run the script with the --dry-run option to learn what steps thescript will run when invoked:

$ curl -fsSL https://get.docker.com -o get-docker.sh$ sudo sh ./get-docker.sh --dry-run

This example downloads the script fromhttps://get.docker.com/ and runs it to install thelatest stable release of Docker on Linux:

$ curl -fsSL https://get.docker.com -o get-docker.sh$ sudo sh get-docker.shExecuting docker install script, commit: 7cae5f8b0decc17d6571f9f52eb840fbc13b2737<...>

You have now successfully installed and started Docker Engine. The dockerservice starts automatically on Debian based distributions. On RPM baseddistributions, such as CentOS, Fedora, RHEL or SLES, you need to start itmanually using the appropriate systemctl or service command. As the messageindicates, non-root users can’t run Docker commands by default.

Use Docker as a non-privileged user, or install in rootless mode?

The installation script requires root or sudo privileges to install anduse Docker. If you want to grant non-root users access to Docker, refer to thepost-installation steps for Linux.You can also install Docker without root privileges, or configured to run inrootless mode. For instructions on running Docker in rootless mode, refer torun the Docker daemon as a non-root user (rootless mode).

Install pre-releases

Docker also provides a convenience script athttps://test.docker.com/ to install pre-releases ofDocker on Linux. This script is equal to the script at get.docker.com, butconfigures your package manager to use the test channel of the Docker packagerepository. The test channel includes both stable and pre-releases (betaversions, release-candidates) of Docker. Use this script to get early access tonew releases, and to evaluate them in a testing environment before they’rereleased as stable.

To install the latest version of Docker on Linux from the test channel, run:

$ curl -fsSL https://test.docker.com -o test-docker.sh$ sudo sh test-docker.sh

Upgrade Docker after using the convenience script

If you installed Docker using the convenience script, you should upgrade Dockerusing your package manager directly. There’s no advantage to re-running theconvenience script. Re-running it can cause issues if it attempts to re-installrepositories which already exist on the host machine.

Uninstall Docker Engine

1. Uninstall the Docker Engine, CLI, containerd, and Docker Compose packages:

   $ sudo apt-get purge docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin docker-ce-rootless-extras

2. Images, containers, volumes, or custom configuration files on your hostaren’t automatically removed. To delete all images, containers, and volumes:

   $ sudo rm -rf /var/lib/docker$ sudo rm -rf /var/lib/containerd

   (Video) Setting Up Your First Raspberry Pi 4 Docker Server with CasaOS - Episode 1

You have to delete any edited configuration files manually.

Next steps

• Continue to Post-installation steps for Linux.
• Review the topics in Develop with Docker to learnhow to build new applications using Docker.