summary refs log tree commit diff
path: root/docker/README.md (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Add a dockerfile for running a set of Synapse worker processes (#9162)Andrew Morgan2021-04-141-4/+8
| | | | | | | | | | | | | | | | | This PR adds a Dockerfile and some supporting files to the `docker/` directory. The Dockerfile's intention is to spin up a container with: * A Synapse main process. * Any desired worker processes, defined by a `SYNAPSE_WORKERS` environment variable supplied at runtime. * A redis for worker communication. * A nginx for routing traffic. * A supervisord to start all worker processes and monitor them if any go down. Note that **this is not currently intended to be used in production**. If you'd like to use Synapse workers with Docker, instead make use of the official image, with one worker per container. The purpose of this dockerfile is currently to allow testing Synapse in worker mode with the [Complement](https://github.com/matrix-org/complement/) test suite. `configure_workers_and_start.py` is where most of the magic happens in this PR. It reads from environment variables (documented in the file) and creates all necessary config files for the processes. It is the entrypoint of the Dockerfile, and thus is run any time the docker container is spun up, recreating all config files in case you want to use a different set of workers. One can specify which workers they'd like to use by setting the `SYNAPSE_WORKERS` environment variable (as a comma-separated list of arbitrary worker names) or by setting it to `*` for all worker processes. We will be using the latter in CI. Huge thanks to @MatMaul for helping get this all working :tada: This PR is paired with its equivalent on the Complement side: https://github.com/matrix-org/complement/pull/62. Note, for the purpose of testing this PR before it's merged: You'll need to (re)build the base Synapse docker image for everything to work (`matrixdotorg/synapse:latest`). Then build the worker-based docker image on top (`matrixdotorg/synapse:workers`).
* Add note to docker docs explaining platform support (#9801)Andrew Morgan2021-04-141-3/+6
| | | | | | | 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.
* Install jemalloc in docker image (#8553)Mathieu Velten2021-03-161-0/+5
| | | | Co-authored-by: Will Hunt <willh@matrix.org> Co-authored-by: Erik Johnston <erik@matrix.org>
* Remove vestiges of uploads_path config (#9462)Richard van der Hoff2021-02-221-1/+0
| | | | `uploads_path` was a thing that was never used; most of it was removed in #6628 but a few vestiges remained.
* Docker: support passing additional commandline args to synapse (#8390)Samuel Philipp2020-10-111-1/+15
|
* Add healthcheck for default localhost 8008 port on /health endpoint. (#8147)Christopher May-Townsend2020-08-241-0/+29
|
* Add help for creating a user via docker (#7885)Michael Kaye2020-07-171-0/+15
|
* Kill off deprecated "config-on-the-fly" docker mode (#6918)Richard van der Hoff2020-02-181-9/+14
| | | | | Lots of people seem to get confused by this mode, and it's been deprecated since Synapse 1.1.0. It's time for it to go.
* Add working build command for docker image (#6390)Andrew Morgan2019-11-231-0/+12
| | | | | | * Add working build command for docker image * Add changelog
* Fix broken URL in docker/README.md (#6264)Tobia De Koninck2019-10-281-1/+1
| | | Signed-off-by: Tobia De Koninck <LEDfan@users.noreply.github.com>
* Docker: support SYNAPSE_WORKER envvar (#6058)Michael Kaye2019-09-191-0/+2
| | | | | | | | | | | | | | | | * Allow passing SYNAPSE_WORKER envvar * changelog.d * Document SYNAPSE_WORKER. Attempting to imply that you don't need to change this default unless you're in worker mode. Also aware that there's a bigger problem of attempting to document a complete working configuration of workers using docker, as we currently only document to use `synctl` for worker mode, and synctl doesn't work that way in docker.
* Typographical corrections in docker/README (#5921)Victor Goff2019-08-281-5/+5
|
* Add ability to set timezone for Docker container (#5383)Amir Zarrinkafsh2019-07-021-1/+1
| | | | Signed-off-by: Amir Zarrinkafsh <nightah@me.com>
* Docker image: Add a migrate_config mode (#5567)Richard van der Hoff2019-06-271-0/+16
| | | ... to help people escape env var hell
* Deprecate the env var way of running the docker image (#5566)Richard van der Hoff2019-06-271-148/+68
| | | | | This is mostly a documentation change, but also adds a default value for SYNAPSE_CONFIG_PATH, so that running from the generated config is the default, and will Just Work provided your config is in the right place.
* Add support for SYNAPSE_CONFIG_DIRRichard van der Hoff2019-06-261-0/+2
|
* Docker image: add support for SYNAPSE_DATA_DIR parameterRichard van der Hoff2019-06-261-0/+4
| | | | Fixes #4830.
* document supported env vars for docker 'generate' optionRichard van der Hoff2019-06-261-0/+7
|
* Change to absolute path for contrib/dockerNeil Johnson2019-06-131-1/+1
| | | because this file is reproduced on dockerhub and relative paths don't work
* Update README.md (#5222)Steffen2019-05-221-1/+1
| | | Add missing backslash
* Fix handling of SYNAPSE_NO_TLS in docker image (#5005)*=0=1=4=*2019-04-251-2/+3
|
* Correct default POSTGRES_USER in Docker README (#4987)*=0=1=4=*2019-04-041-2/+3
| | | Correct default POSTGRES_USER in Docker README
* Add -p argument for docker run command exampleJurrie Overgoor2019-03-291-0/+1
| | | Signed-off-by: Jurrie Overgoor <1213142+Jurrie@users.noreply.github.com>
* Fix typo in TLS filenamesJurrie Overgoor2019-03-291-2/+2
| | | Signed-off-by: Jurrie Overgoor <1213142+Jurrie@users.noreply.github.com>
* Document the `generate` option for the docker image.Richard van der Hoff2019-03-071-4/+37
|
* Enable ACME support in the docker image (#4566)Richard van der Hoff2019-02-051-34/+54
| | | | | | | Also: * Fix wrapping in docker readme * Clean up some docs on the docker image * a workaround for #4554
* Added description for "SYNAPSE_MAX_UPLOAD_SIZE" variable.Simon Dwyer2018-09-161-1/+1
|
* Added description for "SYNAPSE_MAX_UPLOAD_SIZE" variable.Simon Dwyer2018-09-161-0/+1
|
* Update README.mdMichael Kaye2018-08-031-1/+1
| | | Link to contrib/docker
* Address SPAG issuesMichael Kaye2018-08-021-2/+4
|
* Refactor docker locations and README.Michael Kaye2018-08-021-0/+122
This addresses #3224
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-12-27 20:44:58 +0000