From cfad6d978bfb8639b541f393e9b8f49f4aad0fde Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Th=C3=A9o=20FIDRY?=
<5175937+theofidry@users.noreply.github.com>
Date: Thu, 2 Nov 2023 23:20:49 +0100
Subject: [PATCH] doc: Add a reference to the docker image (#1140)
---
README.md | 1 +
doc/installation.md | 10 ++++++++++
2 files changed, 11 insertions(+)
diff --git a/README.md b/README.md
index 9a274165e..497d39b7f 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,7 @@ For the full documentation see https://box-project.github.io/box.
1. [Composer](doc/installation.md#composer)
1. [Homebrew](doc/installation.md#homebrew)
1. [GitHub](doc/installation.md#github)
+ 1. [Docker](doc/installation.md#docker)
1. [Usage](#usage)
1. [Configuration][the configuration documentation]
1. [Base path (`base-path`)](doc/configuration.md#base-path-base-path)
diff --git a/doc/installation.md b/doc/installation.md
index bfda1de55..e1d22e000 100644
--- a/doc/installation.md
+++ b/doc/installation.md
@@ -5,6 +5,7 @@
1. [Composer](#composer)
1. [Homebrew](#homebrew)
1. [GitHub](#github)
+1. [Docker](#docker)
## PHAR
@@ -88,6 +89,14 @@ rm box.phar.asc
chmod +x box.phar
```
+## Docker
+
+The official docker image for the project is [`boxproject/box`][docker-image]:
+
+```shell
+docker pull boxproject/box
+```
+