summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2019-11-22 19:54:05 +0000
committerAmber Brown <hawkowl@atleastfornow.net>2019-11-23 06:54:05 +1100
commit265c0bd2fe54db7f8a7dab05f41b27ce9a450563 (patch)
treef81a111d7ae57a822d01173de0a6e4acbd254f42
parentFix link to user_dir_populate.sql in the user directory docs (#6388) (diff)
downloadsynapse-265c0bd2fe54db7f8a7dab05f41b27ce9a450563.tar.xz
Add working build command for docker image (#6390)
* Add working build command for docker image

* Add changelog
-rw-r--r--changelog.d/6390.doc1
-rw-r--r--docker/README.md12
2 files changed, 13 insertions, 0 deletions
diff --git a/changelog.d/6390.doc b/changelog.d/6390.doc
new file mode 100644
index 0000000000..093411bec1
--- /dev/null
+++ b/changelog.d/6390.doc
@@ -0,0 +1 @@
+Add build instructions to the docker readme.
\ No newline at end of file
diff --git a/docker/README.md b/docker/README.md
index 24dfa77dcc..9f112a01d0 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -130,3 +130,15 @@ docker run -it --rm \
 This will generate the same configuration file as the legacy mode used, but
 will store it in `/data/homeserver.yaml` instead of a temporary location. You
 can then use it as shown above at [Running synapse](#running-synapse).
+
+## Building the image
+
+If you need to build the image from a Synapse checkout, use the following `docker
+ build` command from the repo's root:
+ 
+```
+docker build -t matrixdotorg/synapse -f docker/Dockerfile .
+```
+
+You can choose to build a different docker image by changing the value of the `-f` flag to
+point to another Dockerfile.