summary refs log tree commit diff
path: root/docker/README-testing.md
diff options
context:
space:
mode:
authorBrendan Abolivier <babolivier@matrix.org>2022-07-21 14:29:58 +0200
committerGitHub <noreply@github.com>2022-07-21 14:29:58 +0200
commit10e40938398b6a462801be7eab9f5e6260649a0a (patch)
tree7d6f4087dfecf71995f3e8c40e371c84f824eca3 /docker/README-testing.md
parentTrack DB txn times w/ two counters, not histogram (#13342) (diff)
downloadsynapse-10e40938398b6a462801be7eab9f5e6260649a0a.tar.xz
Call out buildkit is required when building test docker images (#13338)
Co-authored-by: David Robertson <davidr@element.io>
Diffstat (limited to 'docker/README-testing.md')
-rw-r--r--docker/README-testing.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docker/README-testing.md b/docker/README-testing.md
index 1f0423f09b..21b99963d8 100644
--- a/docker/README-testing.md
+++ b/docker/README-testing.md
@@ -22,6 +22,10 @@ Consult the [contributing guide][guideComplementSh] for instructions on how to u
 Under some circumstances, you may wish to build the images manually.
 The instructions below will lead you to doing that.
 
+Note that these images can only be built using [BuildKit](https://docs.docker.com/develop/develop-images/build_enhancements/),
+therefore BuildKit needs to be enabled when calling `docker build`. This can be done by
+setting `DOCKER_BUILDKIT=1` in your environment.
+
 Start by building the base Synapse docker image. If you wish to run tests with the latest
 release of Synapse, instead of your current checkout, you can skip this step. From the
 root of the repository: