OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity
MatrixSynapse/contrib/docker
History
mervyn 044f00c5aa Remove the old `docker-compose` example 
Signed-off-by: mervyn <6359152+reply2future@users.noreply.github.com>
 		2023-09-27 15:30:23 +08:00
..
deploy_data Update the `docker-compose` sqlite example 2023-09-27 15:30:23 +08:00
README.md Update `docker-compose` README.md 2023-09-27 15:30:23 +08:00
docker-compose.postgres.yml Update `docker-compose.yml` postgres example 2023-09-27 15:30:23 +08:00
docker-compose.sqlite.yml Update the `docker-compose` sqlite example 2023-09-27 15:30:23 +08:00

README.md

Synapse Docker

There are two docker-compose.yaml files to support sqlite and postgres databases.

  1. The postgres database is recommended for production use, you could use docker-compose.postgres.yaml.

  2. The sqlite database is recommended for development and testing, you could use docker-compose.sqlite.yaml.

Please comment/uncomment sections that are not suitable for your usecase. Go to the directory contrib/docker to run the below command.

Configuration

The container synapse-init is to generate a fresh homeserver.yaml, you can use the generate command. (See the documentation for more information.) You will need to specify appropriate values for at least the SYNAPSE_SERVER_NAME and SYNAPSE_REPORT_STATS environment variables. For example:

Specify a SYNAPSE_CONFIG_PATH, preferably to a persistent path, to use manual configuration.

You just choose one of the following options.

sqlite

  1. change the SYNAPSE_SERVER_NAME of synapse-init at the docker-compose.sqlite.yaml
  2. change the local device path of volumes at the docker-compose.sqlite.yaml
  3. run the command docker-compose -f docker-compose.sqlite.yml up -d

postgres

  1. change the SYNAPSE_SERVER_NAME of synapse-init at the docker-compose.postgres.yaml
  2. change the local device path of volumes for synapse_data and pg_data at the docker-compose.postgres.yaml
  3. create the direcotry of pg_data, such as mkdir -p pg_data
  4. change the postgres password by POSTGRES_PASSWORD
  5. run the command docker-compose -f docker-compose.postgres.yml up -d

Validate

Open http://localhost:8008 in your browser, and it's successful if you see the welcome page.

More information

For more information on required environment variables and mounts, see the main docker documentation at /docker/README.md