| @@ -92,7 +92,7 @@ When updating the playbook, refer to [the changelog](CHANGELOG.md) to catch up w | |||||
| This playbook sets up your server using the following Docker images: | This playbook sets up your server using the following Docker images: | ||||
| - [matrixdotorg/synapse](https://hub.docker.com/r/matrixdotorg/synapse/) - the official [Matrix Synapse](https://github.com/matrix-org/synapse) server | |||||
| - [matrixdotorg/synapse](https://hub.docker.com/r/matrixdotorg/synapse/) - the official [Synapse](https://github.com/matrix-org/synapse) Matrix homeserver | |||||
| - [instrumentisto/coturn](https://hub.docker.com/r/instrumentisto/coturn/) - the [Coturn](https://github.com/coturn/coturn) STUN/TURN server (optional) | - [instrumentisto/coturn](https://hub.docker.com/r/instrumentisto/coturn/) - the [Coturn](https://github.com/coturn/coturn) STUN/TURN server (optional) | ||||
| @@ -1,9 +1,9 @@ | |||||
| # Storing Matrix media files on Amazon S3 (optional) | # Storing Matrix media files on Amazon S3 (optional) | ||||
| By default, this playbook configures your server to store Matrix Synapse's content repository (`media_store`) files on the local filesystem. | |||||
| By default, this playbook configures your server to store Synapse's content repository (`media_store`) files on the local filesystem. | |||||
| If that's alright, you can skip this. | If that's alright, you can skip this. | ||||
| If you'd like to store Matrix Synapse's content repository (`media_store`) files on Amazon S3, | |||||
| If you'd like to store Synapse's content repository (`media_store`) files on Amazon S3, | |||||
| you can let this playbook configure [Goofys](https://github.com/kahing/goofys) for you. | you can let this playbook configure [Goofys](https://github.com/kahing/goofys) for you. | ||||
| You'll need an Amazon S3 bucket and some IAM user credentials (access key + secret key) with full write access to the bucket. Example security policy: | You'll need an Amazon S3 bucket and some IAM user credentials (access key + secret key) with full write access to the bucket. Example security policy: | ||||
| @@ -36,4 +36,4 @@ matrix_s3_media_store_bucket_name: "your-bucket-name" | |||||
| matrix_s3_media_store_aws_access_key: "access-key-goes-here" | matrix_s3_media_store_aws_access_key: "access-key-goes-here" | ||||
| matrix_s3_media_store_aws_secret_key: "secret-key-goes-here" | matrix_s3_media_store_aws_secret_key: "secret-key-goes-here" | ||||
| matrix_s3_media_store_region: "eu-central-1" | matrix_s3_media_store_region: "eu-central-1" | ||||
| ``` | |||||
| ``` | |||||
| @@ -1,6 +1,6 @@ | |||||
| # Importing `media_store` data files from an existing installation (optional) | # Importing `media_store` data files from an existing installation (optional) | ||||
| Run this if you'd like to import your `media_store` files from a previous installation of Matrix Synapse. | |||||
| Run this if you'd like to import your `media_store` files from a previous installation of Synapse. | |||||
| ## Prerequisites | ## Prerequisites | ||||
| @@ -19,4 +19,4 @@ Run this command (make sure to replace `<server-path-to-media_store>` with a pat | |||||
| ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_media_store=<server-path-to-media_store>' --tags=import-media-store | ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_media_store=<server-path-to-media_store>' --tags=import-media-store | ||||
| **Note**: `<server-path-to-media_store>` must be a file path to a `media_store` directory on the server (not on your local machine!). | |||||
| **Note**: `<server-path-to-media_store>` must be a file path to a `media_store` directory on the server (not on your local machine!). | |||||
| @@ -1,6 +1,6 @@ | |||||
| # Importing an existing Postgres database from another installation (optional) | # Importing an existing Postgres database from another installation (optional) | ||||
| Run this if you'd like to import your database from a previous installation of Matrix Synapse. | |||||
| Run this if you'd like to import your database from a previous installation of Synapse. | |||||
| (don't forget to import your `media_store` files as well - see [the importing-media-store guide](importing-media-store.md)). | (don't forget to import your `media_store` files as well - see [the importing-media-store guide](importing-media-store.md)). | ||||
| @@ -1,12 +1,12 @@ | |||||
| # Importing an existing SQLite database from another installation (optional) | # Importing an existing SQLite database from another installation (optional) | ||||
| Run this if you'd like to import your database from a previous default installation of Matrix Synapse. | |||||
| Run this if you'd like to import your database from a previous default installation of Synapse. | |||||
| (don't forget to import your `media_store` files as well - see [the importing-media-store guide](importing-media-store.md)). | (don't forget to import your `media_store` files as well - see [the importing-media-store guide](importing-media-store.md)). | ||||
| While this playbook always sets up PostgreSQL, by default a Matrix Synapse installation would run | |||||
| While this playbook always sets up PostgreSQL, by default a Synapse installation would run | |||||
| using an SQLite database. | using an SQLite database. | ||||
| If you have such a Matrix Synapse setup and wish to migrate it here (and over to PostgreSQL), this command is for you. | |||||
| If you have such a Synapse setup and wish to migrate it here (and over to PostgreSQL), this command is for you. | |||||
| ## Prerequisites | ## Prerequisites | ||||
| @@ -20,4 +20,4 @@ Run this command (make sure to replace `<server-path-to-homeserver.db>` with a f | |||||
| ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_homeserver_db=<server-path-to-homeserver.db>' --tags=import-sqlite-db | ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_homeserver_db=<server-path-to-homeserver.db>' --tags=import-sqlite-db | ||||
| **Note**: `<server-path-to-homeserver.db>` must be a file path to a `homeserver.db` file on the server (not on your local machine!). | |||||
| **Note**: `<server-path-to-homeserver.db>` must be a file path to a `homeserver.db` file on the server (not on your local machine!). | |||||
| @@ -119,26 +119,26 @@ matrix_synapse_auto_join_rooms: [] | |||||
| # automatically if they don't already exist. | # automatically if they don't already exist. | ||||
| matrix_synapse_autocreate_auto_join_rooms: true | matrix_synapse_autocreate_auto_join_rooms: true | ||||
| # Controls password-peppering for Matrix Synapse. Not to be changed after initial setup. | |||||
| # Controls password-peppering for Synapse. Not to be changed after initial setup. | |||||
| matrix_synapse_password_config_pepper: "" | matrix_synapse_password_config_pepper: "" | ||||
| # Controls the number of events that Matrix Synapse caches in memory. | |||||
| # Controls the number of events that Synapse caches in memory. | |||||
| matrix_synapse_event_cache_size: "100K" | matrix_synapse_event_cache_size: "100K" | ||||
| # Controls cache sizes for Matrix Synapse via the SYNAPSE_CACHE_FACTOR environment variable. | |||||
| # Controls cache sizes for Synapse via the SYNAPSE_CACHE_FACTOR environment variable. | |||||
| # Raise this to increase cache sizes or lower it to potentially lower memory use. | # Raise this to increase cache sizes or lower it to potentially lower memory use. | ||||
| # To learn more, see: | # To learn more, see: | ||||
| # - https://github.com/matrix-org/synapse#help-synapse-eats-all-my-ram | # - https://github.com/matrix-org/synapse#help-synapse-eats-all-my-ram | ||||
| # - https://github.com/matrix-org/synapse/issues/3939 | # - https://github.com/matrix-org/synapse/issues/3939 | ||||
| matrix_synapse_cache_factor: 0.5 | matrix_synapse_cache_factor: 0.5 | ||||
| # Controls whether Matrix Synapse will federate at all. | |||||
| # Controls whether Synapse will federate at all. | |||||
| # Disable this to completely isolate your server from the rest of the Matrix network. | # Disable this to completely isolate your server from the rest of the Matrix network. | ||||
| # Also see: `matrix_synapse_tls_federation_listener_enabled` if you wish to keep federation enabled, | # Also see: `matrix_synapse_tls_federation_listener_enabled` if you wish to keep federation enabled, | ||||
| # but want to stop the TLS listener (port 8448). | # but want to stop the TLS listener (port 8448). | ||||
| matrix_synapse_federation_enabled: true | matrix_synapse_federation_enabled: true | ||||
| # A list of domain names that are allowed to federate with the given Matrix Synapse server. | |||||
| # A list of domain names that are allowed to federate with the given Synapse server. | |||||
| # An empty list value (`[]`) will also effectively stop federation, but if that's the desired | # An empty list value (`[]`) will also effectively stop federation, but if that's the desired | ||||
| # result, it's better to accomplish it by changing `matrix_synapse_federation_enabled`. | # result, it's better to accomplish it by changing `matrix_synapse_federation_enabled`. | ||||
| matrix_synapse_federation_domain_whitelist: ~ | matrix_synapse_federation_domain_whitelist: ~ | ||||
| @@ -73,7 +73,7 @@ | |||||
| # We don't chown for Goofys, because due to the way it's mounted, | # We don't chown for Goofys, because due to the way it's mounted, | ||||
| # all files become owned by whoever needs to own them. | # all files become owned by whoever needs to own them. | ||||
| - name: Ensure Matrix Synapse is started (if it previously was) | |||||
| - name: Ensure Synapse is started (if it previously was) | |||||
| service: | service: | ||||
| name: "{{ item }}" | name: "{{ item }}" | ||||
| state: started | state: started | ||||
| @@ -22,7 +22,7 @@ | |||||
| daemon_reload: yes | daemon_reload: yes | ||||
| register: start_result | register: start_result | ||||
| - name: Wait a while, so that Matrix Synapse can manage to start | |||||
| - name: Wait a while, so that Synapse can manage to start | |||||
| pause: | pause: | ||||
| seconds: 7 | seconds: 7 | ||||
| when: start_result.changed | when: start_result.changed | ||||
| @@ -1,7 +1,7 @@ | |||||
| --- | --- | ||||
| # This will throw a Permission Denied error if already mounted using fuse | # This will throw a Permission Denied error if already mounted using fuse | ||||
| - name: Check Matrix Synapse media store path | |||||
| - name: Check Synapse media store path | |||||
| stat: | stat: | ||||
| path: "{{ matrix_synapse_media_store_path }}" | path: "{{ matrix_synapse_media_store_path }}" | ||||
| register: local_path_media_store_stat | register: local_path_media_store_stat | ||||
| @@ -9,7 +9,7 @@ | |||||
| # This is separate and conditional, to ensure we don't execute it | # This is separate and conditional, to ensure we don't execute it | ||||
| # if the path already exists or we failed to check, because it's mounted using fuse. | # if the path already exists or we failed to check, because it's mounted using fuse. | ||||
| - name: Ensure Matrix media store path exists | |||||
| - name: Ensure Synapse media store path exists | |||||
| file: | file: | ||||
| path: "{{ matrix_synapse_media_store_path }}" | path: "{{ matrix_synapse_media_store_path }}" | ||||
| state: directory | state: directory | ||||
| @@ -18,7 +18,7 @@ | |||||
| group: "{{ matrix_user_username }}" | group: "{{ matrix_user_username }}" | ||||
| when: "not local_path_media_store_stat.failed and not local_path_media_store_stat.stat.exists" | when: "not local_path_media_store_stat.failed and not local_path_media_store_stat.stat.exists" | ||||
| - name: Ensure Matrix Docker image is pulled | |||||
| - name: Ensure Synapse Docker image is pulled | |||||
| docker_image: | docker_image: | ||||
| name: "{{ matrix_synapse_docker_image }}" | name: "{{ matrix_synapse_docker_image }}" | ||||
| @@ -34,7 +34,7 @@ | |||||
| # | # | ||||
| # We don't use the `docker_container` module, because using it with `cap_drop` requires | # We don't use the `docker_container` module, because using it with `cap_drop` requires | ||||
| # a very recent version, which is not available for a lot of people yet. | # a very recent version, which is not available for a lot of people yet. | ||||
| - name: Generate initial Matrix config and signing key | |||||
| - name: Generate initial Synapse config and signing key | |||||
| command: | | command: | | ||||
| docker run | docker run | ||||
| --rm | --rm | ||||
| @@ -49,13 +49,13 @@ | |||||
| generate | generate | ||||
| when: "not matrix_synapse_signing_key_stat.stat.exists" | when: "not matrix_synapse_signing_key_stat.stat.exists" | ||||
| - name: Ensure Matrix homeserver config installed | |||||
| - name: Ensure Synapse homeserver config installed | |||||
| template: | template: | ||||
| src: "{{ matrix_synapse_template_synapse_homeserver }}" | src: "{{ matrix_synapse_template_synapse_homeserver }}" | ||||
| dest: "{{ matrix_synapse_config_dir_path }}/homeserver.yaml" | dest: "{{ matrix_synapse_config_dir_path }}/homeserver.yaml" | ||||
| mode: 0644 | mode: 0644 | ||||
| - name: Ensure Matrix log config installed | |||||
| - name: Ensure Synapse log config installed | |||||
| template: | template: | ||||
| src: "{{ matrix_synapse_template_synapse_log }}" | src: "{{ matrix_synapse_template_synapse_log }}" | ||||
| dest: "{{ matrix_synapse_config_dir_path }}/{{ matrix_server_fqn_matrix }}.log.config" | dest: "{{ matrix_synapse_config_dir_path }}/{{ matrix_server_fqn_matrix }}.log.config" | ||||
| @@ -4,7 +4,7 @@ | |||||
| matrix_synapse_media_store_parent_path: "{{ matrix_synapse_media_store_path|dirname }}" | matrix_synapse_media_store_parent_path: "{{ matrix_synapse_media_store_path|dirname }}" | ||||
| matrix_synapse_media_store_directory_name: "{{ matrix_synapse_media_store_path|basename }}" | matrix_synapse_media_store_directory_name: "{{ matrix_synapse_media_store_path|basename }}" | ||||
| - name: Ensure Matrix Synapse paths exist | |||||
| - name: Ensure Synapse paths exist | |||||
| file: | file: | ||||
| path: "{{ item }}" | path: "{{ item }}" | ||||
| state: directory | state: directory | ||||
| @@ -17,4 +17,4 @@ | |||||
| - "{{ matrix_synapse_ext_path }}" | - "{{ matrix_synapse_ext_path }}" | ||||
| # We handle matrix_synapse_media_store_path elsewhere (in setup_synapse_main.yml), | # We handle matrix_synapse_media_store_path elsewhere (in setup_synapse_main.yml), | ||||
| # because if it's using Goofys and it's already mounted (from before), | # because if it's using Goofys and it's already mounted (from before), | ||||
| # trying to chown/chmod it here will cause trouble. | |||||
| # trying to chown/chmod it here will cause trouble. | |||||
| @@ -1,5 +1,5 @@ | |||||
| [Unit] | [Unit] | ||||
| Description=Matrix Synapse server | |||||
| Description=Synapse server | |||||
| {% for service in matrix_synapse_systemd_required_services_list %} | {% for service in matrix_synapse_systemd_required_services_list %} | ||||
| Requires={{ service }} | Requires={{ service }} | ||||
| After={{ service }} | After={{ service }} | ||||