diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2021-04-14 12:06:19 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-14 12:06:19 +0100 |
| commit | f16c6cf59aad485cac83ce9d6d87842ae53adedf (patch) | |
| tree | b08c7d02b09601caffd1aea2d4d6a4ed5cb3a9a1 /docker/README.md | |
| parent | Update changelog for v1.32.0 (diff) | |
| download | synapse-f16c6cf59aad485cac83ce9d6d87842ae53adedf.tar.xz | |
Add note to docker docs explaining platform support (#9801)
Context is in https://github.com/matrix-org/synapse/issues/9764#issuecomment-818615894. I struggled to find a more official link for this. The problem occurs when using WSL1 instead of WSL2, which some Windows platforms (at least Server 2019) still don't have. Docker have updated their documentation to paint a much happier picture now given WSL2's support. The last sentence here can probably be removed once WSL1 is no longer around... though that will likely not be for a very long time.
Diffstat (limited to 'docker/README.md')
| -rw-r--r-- | docker/README.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docker/README.md b/docker/README.md index 3a7dc585e7..b65bcea636 100644 --- a/docker/README.md +++ b/docker/README.md @@ -2,9 +2,12 @@ This Docker image will run Synapse as a single process. By default it uses a sqlite database; for production use you should connect it to a separate -postgres database. +postgres database. The image also does *not* provide a TURN server. -The image also does *not* provide a TURN server. +This image should work on all platforms that are supported by Docker upstream. +Note that Docker's WS1-backend Linux Containers on Windows +platform is [experimental](https://github.com/docker/for-win/issues/6470) and +is not supported by this image. ## Volumes @@ -208,4 +211,4 @@ healthcheck: ## Using jemalloc Jemalloc is embedded in the image and will be used instead of the default allocator. -You can read about jemalloc by reading the Synapse [README](../README.md) \ No newline at end of file +You can read about jemalloc by reading the Synapse [README](../README.md) |