mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-10-01 11:49:51 -04:00
Make it clear that two modes are avaiable in the documentation, improve the compose file
This commit is contained in:
parent
1ffd9cb936
commit
63fd148724
@ -12,7 +12,7 @@ use that server.
|
|||||||
Build the docker image with the `docker build` command from the root of the synapse repository.
|
Build the docker image with the `docker build` command from the root of the synapse repository.
|
||||||
|
|
||||||
```
|
```
|
||||||
docker build -t matrixdotorg/synapse:v0.22.1 .
|
docker build -t matrixdotorg/synapse .
|
||||||
```
|
```
|
||||||
|
|
||||||
The `-t` option sets the image tag. Official images are tagged `matrixdotorg/synapse:<version>` where `<version>` is the same as the release tag in the synapse git repository.
|
The `-t` option sets the image tag. Official images are tagged `matrixdotorg/synapse:<version>` where `<version>` is the same as the release tag in the synapse git repository.
|
||||||
@ -76,12 +76,17 @@ Global settings:
|
|||||||
|
|
||||||
* ``UID``, the user id Synapse will run as [default 991]
|
* ``UID``, the user id Synapse will run as [default 991]
|
||||||
* ``GID``, the group id Synapse will run as [default 991]
|
* ``GID``, the group id Synapse will run as [default 991]
|
||||||
|
* ``SYNAPSE_CONFIG_PATH``, path to a custom config file
|
||||||
|
|
||||||
Synapse specific settings:
|
If ``SYNAPSE_CONFIG_PATH`` is set, you should generate a configuration file
|
||||||
|
then customize it manually. No other environment variable is required.
|
||||||
|
|
||||||
|
Otherwise, a dynamic configuration file will be used. The following environment
|
||||||
|
variables are available for configuration:
|
||||||
|
|
||||||
* ``SYNAPSE_SERVER_NAME`` (mandatory), the current server public hostname.
|
* ``SYNAPSE_SERVER_NAME`` (mandatory), the current server public hostname.
|
||||||
* ``SYNAPSE_CONFIG_PATH``, path to a custom config file (will ignore all
|
* ``SYNAPSE_REPORT_STATS``, (mandatory, ``yes`` or ``not``), enable anonymous
|
||||||
other options then).
|
statistics reporting back to the Matrix project which helps us to get funding.
|
||||||
* ``SYNAPSE_NO_TLS``, set this variable to disable TLS in Synapse (use this if
|
* ``SYNAPSE_NO_TLS``, set this variable to disable TLS in Synapse (use this if
|
||||||
you run your own TLS-capable reverse proxy).
|
you run your own TLS-capable reverse proxy).
|
||||||
* ``SYNAPSE_WEB_CLIENT``, set this variable to enable the embedded Web client.
|
* ``SYNAPSE_WEB_CLIENT``, set this variable to enable the embedded Web client.
|
||||||
@ -90,8 +95,6 @@ Synapse specific settings:
|
|||||||
* ``SYNAPSE_ALLOW_GUEST``, set this variable to allow guest joining this server.
|
* ``SYNAPSE_ALLOW_GUEST``, set this variable to allow guest joining this server.
|
||||||
* ``SYNAPSE_EVENT_CACHE_SIZE``, the event cache size [default `10K`].
|
* ``SYNAPSE_EVENT_CACHE_SIZE``, the event cache size [default `10K`].
|
||||||
* ``SYNAPSE_CACHE_FACTOR``, the cache factor [default `0.5`].
|
* ``SYNAPSE_CACHE_FACTOR``, the cache factor [default `0.5`].
|
||||||
* ``SYNAPSE_REPORT_STATS``, set this variable to `yes` to enable anonymous
|
|
||||||
statistics reporting back to the Matrix project which helps us to get funding.
|
|
||||||
* ``SYNAPSE_RECAPTCHA_PUBLIC_KEY``, set this variable to the recaptcha public
|
* ``SYNAPSE_RECAPTCHA_PUBLIC_KEY``, set this variable to the recaptcha public
|
||||||
key in order to enable recaptcha upon registration.
|
key in order to enable recaptcha upon registration.
|
||||||
* ``SYNAPSE_RECAPTCHA_PRIVATE_KEY``, set this variable to the recaptcha private
|
* ``SYNAPSE_RECAPTCHA_PRIVATE_KEY``, set this variable to the recaptcha private
|
||||||
@ -100,7 +103,7 @@ Synapse specific settings:
|
|||||||
uris to enable TURN for this homeserver.
|
uris to enable TURN for this homeserver.
|
||||||
* ``SYNAPSE_TURN_SECRET``, set this to the TURN shared secret if required.
|
* ``SYNAPSE_TURN_SECRET``, set this to the TURN shared secret if required.
|
||||||
|
|
||||||
Shared secrets, these will be initialized to random values if not set:
|
Shared secrets, that will be initialized to random values if not set:
|
||||||
|
|
||||||
* ``SYNAPSE_REGISTRATION_SHARED_SECRET``, secret for registrering users if
|
* ``SYNAPSE_REGISTRATION_SHARED_SECRET``, secret for registrering users if
|
||||||
registration is disable.
|
registration is disable.
|
||||||
|
@ -6,7 +6,7 @@ version: '3'
|
|||||||
services:
|
services:
|
||||||
|
|
||||||
synapse:
|
synapse:
|
||||||
image: matrixdotorg/synapse:latest
|
image: docker.io/matrixdotorg/synapse:latest
|
||||||
# Since snyapse does not retry to connect to the database, restart upon
|
# Since snyapse does not retry to connect to the database, restart upon
|
||||||
# failure
|
# failure
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
@ -15,7 +15,12 @@ services:
|
|||||||
- SYNAPSE_SERVER_NAME=my.matrix.host
|
- SYNAPSE_SERVER_NAME=my.matrix.host
|
||||||
- SYNAPSE_ENABLE_REGISTRATION=yes
|
- SYNAPSE_ENABLE_REGISTRATION=yes
|
||||||
volumes:
|
volumes:
|
||||||
|
# You may either store all the files in a local folder
|
||||||
- ./files:/data
|
- ./files:/data
|
||||||
|
# .. or you may split this between different storage points
|
||||||
|
# - ./files:/data
|
||||||
|
# - /path/to/ssd:/data/uploads
|
||||||
|
# - /path/to/large_hdd:/data/media
|
||||||
depends_on:
|
depends_on:
|
||||||
- db
|
- db
|
||||||
# In order to expose Synapse, remove one of the following, you might for
|
# In order to expose Synapse, remove one of the following, you might for
|
||||||
@ -29,10 +34,13 @@ services:
|
|||||||
- traefik.port=8448
|
- traefik.port=8448
|
||||||
|
|
||||||
db:
|
db:
|
||||||
image: postgres:latest
|
image: postgres:10-alpine
|
||||||
# Change that password, of course!
|
# Change that password, of course!
|
||||||
environment:
|
environment:
|
||||||
- POSTGRES_USER=matrix
|
- POSTGRES_USER=matrix
|
||||||
- POSTGRES_PASSWORD=changeme
|
- POSTGRES_PASSWORD=changeme
|
||||||
volumes:
|
volumes:
|
||||||
|
# You may store the database tables in a local folder..
|
||||||
- ./schemas:/var/lib/postgresql/data
|
- ./schemas:/var/lib/postgresql/data
|
||||||
|
# .. or store them on some high performance storage for better results
|
||||||
|
# - /path/to/ssd/storage:/var/lib/postfesql/data
|
||||||
|
Loading…
Reference in New Issue
Block a user