From 26bc83851ef7ca2dbbb194c13716b427638dd766 Mon Sep 17 00:00:00 2001 From: Sebastian Hugentobler Date: Mon, 31 Oct 2016 13:05:22 +0100 Subject: [PATCH] Update README.md --- README.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b863ee6 --- /dev/null +++ b/README.md @@ -0,0 +1,83 @@ +[Synapse](https://github.com/matrix-org/synapse) homeserver for the [matrix](http://matrix.org/) network. + +# Volumes +- `/var/lib/synapse/media_store/` +- `/var/lib/synapse/signing/` +- `/var/lib/synapse/uploads/` +- `/etc/ssl/synapse/:ro`: certificates have to be here + +# Environment Variables +## SERVER_NAME +Name of the synapse server. + +## PUBLIC_BASE_URL +Full base url. + +## SHARED_SECRET +If set, allows registration by anyone who also has the shared secret, even if registration is otherwise disabled. + +## MACAROON_SECRET_KEY +Secret key for macaroon. + +## TURN_URIS +Comma seperated list of TURN servers to use. + +## TURN_SHARED_SECRET +The shared secret used to compute passwords for the TURN server + +## TURN_USER_LIFETIME +- default: 1h + +How long generated TURN credentials last. + +## DB_HOST +Database host. + +## DB_NAME +Database name. + +## DB_USER +Database user. + +## DB_PASSWORD +Password for the database user. + +## CERT_NAME +- default: fullchain.pem + +Name of the certificate file. + +## KEY_NAME +- default: privkey.pem + +Name of the key file. + +## MAX_UPLOAD_SIZE +- default: 10M + +The largest allowed upload size. + +## MAX_THUMBNAIL_PIXELS +- default: 32M + +Maximum number of pixels that will be thumbnailed. + +## DYNAMIC_THUMBNAILS +- default: True + +Whether to generate new thumbnails on the fly to precisely match the resolution requested by the client. + +## REPORT_STATS +- default: no + +Whether to report statistics. + +# Ports +- 8448 + +# Capabilities +- CHOWN +- DAC_OVERRIDE +- NET_BIND_SERVICE +- SETGID +- SETUID