summary refs log tree commit diff
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2019-03-29 10:09:39 +0000
committerGitHub <noreply@github.com>2019-03-29 10:09:39 +0000
commit215c15d049cf813a34edd114372c23b5b62a454a (patch)
tree2fbd3e988abc0e53a8c2cf35ea954f205ee82d4f
parentMerge pull request #4955 from matrix-org/rav/merge_state_into_events (diff)
parentAdd changelog.d entry (diff)
downloadsynapse-215c15d049cf813a34edd114372c23b5b62a454a.tar.xz
Merge pull request #4968 from Jurrie/feature/fix_small_stuff_in_Docker_README.md
Feature/fix small stuff in docker readme.md
-rw-r--r--changelog.d/4968.misc1
-rw-r--r--docker/README.md5
2 files changed, 4 insertions, 2 deletions
diff --git a/changelog.d/4968.misc b/changelog.d/4968.misc
new file mode 100644
index 0000000000..7a7b69771c
--- /dev/null
+++ b/changelog.d/4968.misc
@@ -0,0 +1 @@
+Fix typo in TLS filenames in docker/README.md. Also add the '-p' commandline option to the 'docker run' example. Contributed by Jurrie Overgoor.
diff --git a/docker/README.md b/docker/README.md
index 4b98b7fd75..44ade63f27 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -31,6 +31,7 @@ docker run \
     --mount type=volume,src=synapse-data,dst=/data \
     -e SYNAPSE_SERVER_NAME=my.matrix.host \
     -e SYNAPSE_REPORT_STATS=yes \
+    -p 8448:8448 \
     matrixdotorg/synapse:latest
 ```
 
@@ -57,8 +58,8 @@ configuration file there. Multiple application services are supported.
 Synapse requires a valid TLS certificate. You can do one of the following:
 
  * Provide your own certificate and key (as
-   `${DATA_PATH}/${SYNAPSE_SERVER_NAME}.crt` and
-   `${DATA_PATH}/${SYNAPSE_SERVER_NAME}.key`, or elsewhere by providing an
+   `${DATA_PATH}/${SYNAPSE_SERVER_NAME}.tls.crt` and
+   `${DATA_PATH}/${SYNAPSE_SERVER_NAME}.tls.key`, or elsewhere by providing an
    entire config as `${SYNAPSE_CONFIG_PATH}`).
 
  * Use a reverse proxy to terminate incoming TLS, and forward the plain http