2022-02-05 20:32:54 +00:00
---
2022-07-16 20:59:21 +00:00
# Project source code URL: https://github.com/turt2live/matrix-dimension
2022-02-05 20:32:54 +00:00
2019-03-07 05:22:08 +00:00
matrix_dimension_enabled : false
2019-03-08 13:00:53 +00:00
# You are required to specify an access token for Dimension to work.
2019-03-07 05:22:08 +00:00
# For information on how to acquire an access token, visit https://t2bot.io/docs/access_tokens
2019-03-08 13:00:53 +00:00
matrix_dimension_access_token : ""
2019-03-07 05:22:08 +00:00
# Users in form: ['@user1:domain.com', '@user2:domain.com']
2019-03-08 13:00:53 +00:00
matrix_dimension_admins : [ ]
2019-03-07 05:22:08 +00:00
2019-03-12 10:17:12 +00:00
# Whether to allow Dimension widgets serve websites with invalid or self signed SSL certificates
matrix_dimension_widgets_allow_self_signed_ssl_certificates : false
2021-11-28 04:31:06 +00:00
matrix_dimension_container_image_self_build : false
matrix_dimension_container_image_self_build_repo : "https://github.com/turt2live/matrix-dimension.git"
matrix_dimension_container_image_self_build_branch : master
2019-03-07 05:22:08 +00:00
matrix_dimension_base_path : "{{ matrix_base_data_path }}/dimension"
2021-11-28 04:31:06 +00:00
matrix_dimension_docker_src_files_path : "{{ matrix_base_data_path }}/docker-src/dimension"
2019-03-07 05:22:08 +00:00
2021-02-20 17:08:28 +00:00
matrix_dimension_version : latest
2021-11-28 04:31:06 +00:00
matrix_dimension_docker_image : "{{ matrix_dimension_docker_image_name_prefix }}turt2live/matrix-dimension:{{ matrix_dimension_version }}"
matrix_dimension_docker_image_name_prefix : "{{ 'localhost/' if matrix_dimension_container_image_self_build else matrix_container_global_registry_prefix }}"
2019-06-10 11:23:51 +00:00
matrix_dimension_docker_image_force_pull : "{{ matrix_dimension_docker_image.endswith(':latest') }}"
2019-03-07 05:22:08 +00:00
2020-12-14 18:31:07 +00:00
# List of systemd services that matrix-dimension.service depends on.
matrix_dimension_systemd_required_services_list : [ 'docker.service' ]
# List of systemd services that matrix-dimension.service wants
matrix_dimension_systemd_wanted_services_list : [ ]
2019-03-08 13:00:53 +00:00
# The user and group id correspond to the node user in the `turt2live/matrix-dimension` image.
2019-06-07 14:44:32 +00:00
matrix_dimension_user_uid : '1000'
matrix_dimension_user_gid : '1000'
2019-03-08 13:00:53 +00:00
2019-05-24 22:41:04 +00:00
# Controls whether the matrix-dimension container exposes its HTTP port (tcp/8184 in the container).
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8184"), or empty string to not expose.
matrix_dimension_container_http_host_bind_port : ''
2019-03-08 13:00:53 +00:00
2019-04-30 14:35:18 +00:00
# A list of extra arguments to pass to the container
matrix_dimension_container_extra_arguments : [ ]
2020-09-13 02:19:19 +00:00
matrix_dimension_integrations_ui_url : "https://{{ matrix_server_fqn_dimension }}/element"
2019-03-07 05:22:08 +00:00
matrix_dimension_integrations_rest_url : "https://{{ matrix_server_fqn_dimension }}/api/v1/scalar"
matrix_dimension_integrations_widgets_urls : [ "https://{{ matrix_server_fqn_dimension }}/widgets" ]
matrix_dimension_integrations_jitsi_widget_url : "https://{{ matrix_server_fqn_dimension }}/widgets/jitsi"
2019-03-09 17:08:00 +00:00
2021-11-15 10:07:54 +00:00
matrix_dimension_homeserver_federationUrl : ""
2020-04-22 17:01:56 +00:00
2020-12-14 19:01:47 +00:00
# Database-related configuration fields.
#
# To use SQLite, stick to these defaults.
#
# To use Postgres:
# - change the engine (`matrix_dimension_database_engine: 'postgres'`)
2021-12-08 10:13:12 +00:00
# - adjust your database credentials via the `matrix_dimension_database_*` variables
2020-12-14 19:01:47 +00:00
matrix_dimension_database_engine : 'sqlite'
matrix_dimension_sqlite_database_path_local : "{{ matrix_dimension_base_path }}/dimension.db"
matrix_dimension_sqlite_database_path_in_container : "dimension.db"
matrix_dimension_database_username : 'matrix_dimension'
matrix_dimension_database_password : 'some-password'
matrix_dimension_database_hostname : 'matrix-postgres'
matrix_dimension_database_port : 5432
2020-12-22 15:10:02 +00:00
matrix_dimension_database_name : 'matrix_dimension'
2020-12-14 19:01:47 +00:00
2020-12-22 15:10:02 +00:00
matrix_dimension_database_connection_string : 'postgres://{{ matrix_dimension_database_username }}:{{ matrix_dimension_database_password }}@{{ matrix_dimension_database_hostname }}:{{ matrix_dimension_database_port }}/{{ matrix_dimension_database_name }}'
2020-12-14 19:01:47 +00:00
2019-03-09 17:08:00 +00:00
# Default Dimension 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_dimension_configuration_extension_yaml`)
# or completely replace this variable with your own template.
2020-06-03 06:33:28 +00:00
matrix_dimension_configuration_yaml : "{{ lookup('template', 'templates/config.yaml.j2') }}"
2019-03-09 17:08:00 +00:00
matrix_dimension_configuration_extension_yaml : |
# Your custom YAML configuration for Dimension goes here.
# This configuration extends the default starting configuration (`matrix_dimension_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_dimension_configuration_yaml`.
#
# Example configuration extension follows:
# telegram:
# botToken: "YourTokenHere"
#
2019-03-10 20:23:06 +00:00
2019-06-07 08:46:35 +00:00
matrix_dimension_configuration_extension : "{{ matrix_dimension_configuration_extension_yaml|from_yaml if matrix_dimension_configuration_extension_yaml|from_yaml is mapping else {} }}"
2019-03-09 17:08:00 +00:00
# Holds the final Dimension configuration (a combination of the default and its extension).
# You most likely don't need to touch this variable. Instead, see `matrix_dimension_configuration_yaml`.
matrix_dimension_configuration : "{{ matrix_dimension_configuration_yaml|from_yaml|combine(matrix_dimension_configuration_extension, recursive=True) }}"