mirror of
				https://github.com/spantaleev/matrix-docker-ansible-deploy.git
				synced 2025-11-04 09:08:56 +01:00 
			
		
		
		
	Update files for Sygnal (#3958)
* Rename sygnal.yaml.j2 to config.yaml.j2 There does not seem to exist other yaml.j2 files, which would be named after the servive. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-sygnal.md: add the section "Extending the configuration" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> --------- Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
		@@ -46,8 +46,6 @@ aux_file_definitions:
 | 
			
		||||
    group: "{{ matrix_user_groupname }}"
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
For a more complete example of available fields and values they can take, see `roles/custom/matrix-sygnal/templates/sygnal.yaml.j2` (or the [upstream `sygnal.yaml.sample` configuration file](https://github.com/matrix-org/sygnal/blob/master/sygnal.yaml.sample)).
 | 
			
		||||
 | 
			
		||||
Configuring [GCM/FCM](https://firebase.google.com/docs/cloud-messaging/) is easier, as it only requires that you provide some config values.
 | 
			
		||||
 | 
			
		||||
To configure [APNS](https://developer.apple.com/notifications/) (Apple Push Notification Service), you'd need to provide one or more certificate files. To do that, the above example configuration:
 | 
			
		||||
@@ -75,6 +73,15 @@ After changing the domain, **you may need to adjust your DNS** records to point
 | 
			
		||||
 | 
			
		||||
If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration.
 | 
			
		||||
 | 
			
		||||
### Extending the configuration
 | 
			
		||||
 | 
			
		||||
There are some additional things you may wish to configure about the component.
 | 
			
		||||
 | 
			
		||||
Take a look at:
 | 
			
		||||
 | 
			
		||||
- `roles/custom/matrix-sygnal/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
 | 
			
		||||
- `roles/custom/matrix-sygnal/templates/config.yaml.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_sygnal_configuration_extension_yaml` variable
 | 
			
		||||
 | 
			
		||||
## Installing
 | 
			
		||||
 | 
			
		||||
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:
 | 
			
		||||
 
 | 
			
		||||
@@ -103,7 +103,7 @@ matrix_sygnal_metrics_prometheus_enabled: false
 | 
			
		||||
#
 | 
			
		||||
# For a more advanced customization, you can extend the default (see `matrix_sygnal_configuration_extension_yaml`)
 | 
			
		||||
# or completely replace this variable with your own template.
 | 
			
		||||
matrix_sygnal_configuration_yaml: "{{ lookup('template', 'templates/sygnal.yaml.j2') }}"
 | 
			
		||||
matrix_sygnal_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
 | 
			
		||||
 | 
			
		||||
matrix_sygnal_configuration_extension_yaml: |
 | 
			
		||||
  # Your custom YAML configuration for Sygnal goes here.
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user