Install Docker Engine on Raspberry Pi OS (32-bit)

もくじ

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

重要

This installation instruction refers to the 32-bit (armhf) version of Raspberry Pi OS. If you're using the 64-bit (arm64) version, follow the instructions for Debian.

Prerequisites

Firewall limitations

警告

Before you install Docker, make sure you consider the following security implications and firewall incompatibilities.

  • If you use ufw or firewalld to manage firewall settings, be aware that when you expose container ports using Docker, these ports bypass your firewall rules. For more information, refer to Docker and ufw.
  • Docker is only compatible with iptables-nft and iptables-legacy. Firewall rules created with nft are not supported on a system with Docker installed. Make sure that any firewall rulesets you use are created with iptables or ip6tables, and that you add them to the DOCKER-USER chain, see Packet filtering and firewalls.

OS requirements

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 need to uninstall any conflicting packages.

Your Linux distribution may provide unofficial Docker packages, which may conflict with the official packages provided by Docker. You must uninstall these packages before you install the official version 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 Engine bundles these dependencies as one bundle: containerd.io. If you have installed the containerd or runc previously, uninstall them to avoid conflicts 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't automatically removed when you uninstall Docker. If you want to start with a clean installation, and prefer to clean up any existing data, read the uninstall Docker Engine section.

Installation methods

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

Install using the apt 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 Docker from the repository.

  1. Set up Docker's apt repository.

    # Add Docker's official GPG key:
sudo apt-get update
sudo apt-get install ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/raspbian/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

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

  2. Install the Docker packages.

    To install the latest version, run:

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

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

    # 利用可能バージョンの一覧表示
$ apt-cache madison docker-ce | awk '{ print $3 }'

5:27.4.0-1~raspbian.12~bookworm
5:27.3.1-1~raspbian.12~bookworm
...

    Select the desired version and install:

    $ VERSION_STRING=5:27.4.0-1~raspbian.12~bookworm
$ sudo apt-get install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING containerd.io docker-buildx-plugin docker-compose-plugin

  3. Verify that the installation is successful by running the hello-world image:

    $ sudo docker run hello-world

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

You have now successfully installed and started Docker Engine.

情報

非 root ユーザーでの実行時にエラーが発生したら？

ユーザーグループ docker は存在していてもユーザーが一切含まれていない状態の場合、Docker コマンドの実行にあたっては sudo の利用を求められることになります。 Linux インストール後の作業 を確認して、Docker コマンドやその他の設定作業を非特権ユーザーにも許可する手順を進めてください。

Upgrade Docker Engine

To upgrade Docker Engine, follow step 2 of the installation instructions, choosing the new version you want to install.

Install from a package

If you can't use Docker's apt 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 Engine.

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

  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 to where 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 installation is successful by running the hello-world image:

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

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

You have now successfully installed and started Docker Engine.

情報

非 root ユーザーでの実行時にエラーが発生したら？

ユーザーグループ docker は存在していてもユーザーが一切含まれていない状態の場合、Docker コマンドの実行にあたっては sudo の利用を求められることになります。 Linux インストール後の作業 を確認して、Docker コマンドやその他の設定作業を非特権ユーザーにも許可する手順を進めてください。

Upgrade Docker Engine

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

便利スクリプトを使ったインストール

Docker では https://get.docker.com/ において便利なスクリプトを提供しています。 これは Docker を開発マシンに対話形式をとらずにすばやくインストールするものです。 このスクリプトを本番環境において利用することはお勧めしませんが、環境に適したプロビジョニングを行うサンプルとして活用することはできます。 また リポジトリを利用したインストール における作業手順に従うことで、パッケージリポジトリを利用したインストール手順を身につけることができます。 このスクリプトのソースコードはオープンソースであり、 GitHub 条の docker-install リポジトリ から入手可能です。

インターネットからスクリプトをダウンロードしたら、まず内容を十分確認してからローカル実行してください。 インストールにあたっては、この便利スクリプトの潜在的リスクや制限について、よく理解してください。

  • スクリプトを実行するには root 権限か sudo が必要です。
  • スクリプトは自動的に情報取得を行い、利用している Linux ディストリビューション、そのバージョン、そしてパッケージ管理システムの設定を行います。
  • このスクリプトは、インストール時にパラメーターを受け渡すような設定はできないものになっています。
  • スクリプトは依存パッケージや推奨パッケージをすべてインストールします。 その際にはインストールして良いかどうかを問いません。 したがって相当数のパッケージがインストールされることもあります。 これはホストマシンのその時点での設定によります。
  • このスクリプトはデフォルトでは、最新版の Docker、containerd、runc をインストールします。 このスクリプトを使ってマシンをプロビジョニングした場合、Docker のメジャーバージョンへのアップグレードにより、予期しない結果を引き起こすことがあります。 本番環境へのデプロイを行う際には、必ず (メジャーバージョンへの) アップグレードをテスト環境においてテストしておいてください。
  • このスクリプトは、既にインストールされている Docker をアップグレードするように設計されていません。 このスクリプトを利用して既存インストールをアップデートする際には、依存パッケージが思いどおりにアップデートされない場合があります。 それによって古いバージョンのまま利用する状況となる場合があります。

情報

スクリプト実行前にインストールステップを確認します。 本スクリプトの実行にあたって --dry-run オプションを指定すると、このスクリプトのインストールステップを確認することができます。

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

以下は、このスクリプトを https://get.docker.com/ からダウンロードして実行することで、Linux 上に最新安定版をインストールする例です。

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

Docker が正常にインストールされます。 Debian ベースのディストリビューションでは docker サービスが自動的に開始されます。 CentOS、Fedora、RHEL、SLES といった RPM ベースの場合は手動での実行が必要となるため、systemctl か service のいずれか適当なものを実行します。 上の出力メッセージに示されているように、デフォルトでは非 root ユーザーによる Docker コマンド実行はできません。

非特権ユーザーでの Docker 利用、rootless モードでのインストール？

このインストールスクリプトでは、Docker をインストールして利用するために root あるいは sudo を用いた権限が必要です。 非 root ユーザーに Docker の利用を許可する場合は、 Linux インストール後の作業 を参照してください。 Docker は root 権限がなくてもインストールできます。 つまり rootless モードにより実行することができます。 rootless モードにより Docker を実行する手順については root ユーザー以外による Docker デーモン起動（rootless モード） を参照してください。

プレリリース版のインストール

Docker ではこの便利スクリプトを https://test.docker.com/ からも提供しています。 これを使って Linux 上にプレリリース版の Docker をインストールできます。 このスクリプトは get.docker.com から入手するものと同等であり、パッケージマネージャーを使って Docker パッケージリポジトリのテストチャネルが利用できるように設定されています。 テストチャネルには Docker の安定版とプレリリース版 (ベータ版、リリース候補版) の双方が含まれています。 このスクリプトを利用すれば、新規リリース向けの早期アクセスが利用できます。 これにより安定版として提供されるよりも前に、テスト環境においてそれらを評価することができます。

Linux への Docker 最新版のインストールをテストチャネルから行うには、以下を実行します。

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

便利スクリプトを使った後の Docker のアップグレード

便利スクリプトを使って Docker をインストールした場合、Docker のアップグレードはパッケージマネージャーを直接使って行ってください。 便利スクリプトは再実行する意味はありません。 ホストマシンにリポジトリが追加されているところに、このスクリプトを再実行したとすると、そのリポジトリを再度追加してしまうため、問題になることがあります。

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 host aren't automatically removed. To delete all images, containers, and volumes:

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

  3. Remove source list and keyrings

    $ sudo rm /etc/apt/sources.list.d/docker.list
$ sudo rm /etc/apt/keyrings/docker.asc

You have to delete any edited configuration files manually.

Next steps