--- # Sygnal is a reference Push Gateway for Matrix. # To make use of it for delivering push notificatins, you'll need to develop/build your own Matrix app. # Project source code URL: https://github.com/matrix-org/sygnal matrix_sygnal_enabled: true # The hostname at which Sygnal is served. matrix_sygnal_hostname: '' # The path at which Sygnal is exposed. # This value must either be `/` or not end with a slash (e.g. `/sygnal`). matrix_sygnal_path_prefix: / matrix_sygnal_version: v0.12.0 matrix_sygnal_base_path: "{{ matrix_base_data_path }}/sygnal" matrix_sygnal_config_path: "{{ matrix_sygnal_base_path }}/config" matrix_sygnal_data_path: "{{ matrix_sygnal_base_path }}/data" # List of systemd services that matrix-sygnal.service depends on. matrix_sygnal_systemd_required_services_list: ['docker.service'] # List of systemd services that matrix-sygnal.service wants matrix_sygnal_systemd_wanted_services_list: [] matrix_sygnal_docker_image: "{{ matrix_sygnal_docker_image_registry_prefix }}matrixdotorg/sygnal:{{ matrix_sygnal_docker_image_tag }}" matrix_sygnal_docker_image_tag: "{{ matrix_sygnal_version }}" matrix_sygnal_docker_image_registry_prefix: "{{ matrix_container_global_registry_prefix }}" matrix_sygnal_docker_image_force_pull: "{{ matrix_sygnal_docker_image.endswith(':latest') }}" # The base container network. It will be auto-created by this role if it doesn't exist already. matrix_sygnal_container_network: "{{ matrix_sygnal_identifier }}" # A list of additional container networks that the container would be connected to. # The role does not create these networks, so make sure they already exist. # Use this to expose this container to another reverse proxy, which runs in a different container network. matrix_sygnal_container_additional_networks: [] # Controls whether the matrix-sygnal container exposes its HTTP port (tcp/6000 in the container). # # Takes an ":" or "" value (e.g. "127.0.0.1:6000"), or empty string to not expose. matrix_sygnal_container_http_host_bind_port: '' # matrix_sygnal_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container. # See `../templates/labels.j2` for details. # # To inject your own other container labels, see `matrix_sygnal_container_labels_additional_labels`. matrix_sygnal_container_labels_traefik_enabled: true matrix_sygnal_container_labels_traefik_docker_network: "{{ matrix_sygnal_container_network }}" matrix_sygnal_container_labels_traefik_hostname: "{{ matrix_sygnal_hostname }}" # The path prefix must either be `/` or not end with a slash (e.g. `/sygnal`). matrix_sygnal_container_labels_traefik_path_prefix: "{{ matrix_sygnal_path_prefix }}" matrix_sygnal_container_labels_traefik_rule: "Host(`{{ matrix_sygnal_container_labels_traefik_hostname }}`){% if matrix_sygnal_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_sygnal_container_labels_traefik_path_prefix }}`){% endif %}" matrix_sygnal_container_labels_traefik_priority: 0 matrix_sygnal_container_labels_traefik_entrypoints: web-secure matrix_sygnal_container_labels_traefik_tls: "{{ matrix_sygnal_container_labels_traefik_entrypoints != 'web' }}" matrix_sygnal_container_labels_traefik_tls_certResolver: default # noqa var-naming # Controls which additional headers to attach to all HTTP responses. # To add your own headers, use `matrix_sygnal_container_labels_traefik_additional_response_headers_custom` matrix_sygnal_container_labels_traefik_additional_response_headers: "{{ matrix_sygnal_container_labels_traefik_additional_response_headers_auto | combine(matrix_sygnal_container_labels_traefik_additional_response_headers_custom) }}" matrix_sygnal_container_labels_traefik_additional_response_headers_auto: {} matrix_sygnal_container_labels_traefik_additional_response_headers_custom: {} # matrix_sygnal_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file. # See `../templates/labels.j2` for details. # # Example: # matrix_sygnal_container_labels_additional_labels: | # my.label=1 # another.label="here" matrix_sygnal_container_labels_additional_labels: '' # A list of extra arguments to pass to the container matrix_sygnal_container_extra_arguments: [] # A map (dictionary) of apps instances that this server works with. # # Example configuration: # # matrix_sygnal_apps: # com.example.myapp.ios: # type: apns # # .. more configuration .. # com.example.myapp.android: # type: gcm # api_key: your_api_key_for_gcm # # .. more configuration .. # # The APNS configuration needs to reference some certificate files. # One can put these in the `matrix_sygnal_data_path` directory (`/matrix/sygnal/data`), mounted to `/data` in the container. # The `matrix_sygnal_apps` paths need to use the in-container path (`/data`). # To install these files via the playbook, one can use the `matrix-aux` role. # Examples and more details are available in `docs/configuring-playbook-sygnal.md`. matrix_sygnal_apps: [] matrix_sygnal_metrics_prometheus_enabled: false # Default Sygnal configuration template which covers the generic use case. # You can customize it by controlling the various variables inside it. # # 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_extension_yaml: | # Your custom YAML configuration for Sygnal goes here. # This configuration extends the default starting configuration (`matrix_sygnal_configuration_yaml`). # # You can override individual variables from the default configuration, or introduce new ones. # # If you need something more special, you can take full control by # completely redefining `matrix_sygnal_configuration_yaml`. # # Example configuration extension follows: # metrics: # opentracing: # enabled: true matrix_sygnal_configuration_extension: "{{ matrix_sygnal_configuration_extension_yaml | from_yaml if matrix_sygnal_configuration_extension_yaml | from_yaml is mapping else {} }}" # Holds the final sygnal configuration (a combination of the default and its extension). # You most likely don't need to touch this variable. Instead, see `matrix_sygnal_configuration_yaml`. matrix_sygnal_configuration: "{{ matrix_sygnal_configuration_yaml | from_yaml | combine(matrix_sygnal_configuration_extension, recursive=True) }}"