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
2019-03-07 05:22:08 +00:00
matrix_dimension_base_path : "{{ matrix_base_data_path }}/dimension"
matrix_dimension_docker_image : "turt2live/matrix-dimension:latest"
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
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 : [ ]
2019-03-07 05:22:08 +00:00
matrix_dimension_integrations_ui_url : "https://{{ matrix_server_fqn_dimension }}/riot"
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
# 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.
matrix_dimension_configuration_yaml : |
2019-05-07 11:02:38 +00:00
#jinja2: lstrip_blocks: True
2019-03-09 17:08:00 +00:00
# The web settings for the service (API and UI).
# It is best to have this run on localhost and use a reverse proxy to access Dimension.
web :
port : 8184
address : '0.0.0.0'
# Homeserver configuration
homeserver :
# The domain name of the homeserver. This is used in many places, such as with go-neb
# setups, to identify the homeserver.
2019-03-11 18:05:52 +00:00
name : "{{ matrix_domain }}"
2019-03-09 17:08:00 +00:00
# The URL that Dimension, go-neb, and other services provisioned by Dimension should
# use to access the homeserver with.
2019-04-14 13:09:29 +00:00
clientServerUrl : "http://matrix-synapse:8008"
2019-03-09 17:08:00 +00:00
# The URL that Dimension should use when trying to communicate with federated APIs on
# the homeserver. If not supplied or left empty Dimension will try to resolve the address
# through the normal federation process.
federationUrl : "http://matrix-synapse:8048"
# The URL that Dimension will redirect media requests to for downloading media such as
# stickers. If not supplied or left empty Dimension will use the clientServerUrl.
2019-04-14 13:09:29 +00:00
mediaUrl : "https://{{ matrix_server_fqn_matrix }}"
2019-03-09 17:08:00 +00:00
# The access token Dimension should use for miscellaneous access to the homeserver. This
# should be for a user on the configured homeserver: any user will do, however it is
# recommended to use a dedicated user (such as @dimension:t2bot.io). For information on
# how to acquire an access token, visit https://t2bot.io/docs/access_tokens
accessToken : "{{ matrix_dimension_access_token }}"
# These users can modify the integrations this Dimension supports.
# To access the admin interface, open Dimension in Riot and click the settings icon.
2019-03-10 20:23:06 +00:00
admins : {{ matrix_dimension_admins|to_json }}
2019-03-09 17:08:00 +00:00
# IPs and CIDR ranges listed here will be blocked from being widgets.
# Note: Widgets may still be embedded with restricted content, although not through Dimension directly.
widgetBlacklist :
- 10.0 .0 .0 /8
- 172.16 .0 .0 /12
- 192.168 .0 .0 /16
- 127.0 .0 .0 /8
# Where the database for Dimension is
database :
file : "dimension.db"
# Display settings that apply to self-hosted go-neb instances
goneb :
# The avatars to set for each bot. Usually these don't need to be changed, however if your homeserver
# is not able to reach t2bot.io then you should specify your own here. To not use an avatar for a bot,
# make the bot's avatar an empty string.
avatars :
giphy : "mxc://t2bot.io/c5eaab3ef0133c1a61d3c849026deb27"
imgur : "mxc://t2bot.io/6749eaf2b302bb2188ae931b2eeb1513"
github : "mxc://t2bot.io/905b64b3cd8e2347f91a60c5eb0832e1"
wikipedia : "mxc://t2bot.io/7edfb54e9ad9e13fec0df22636feedf1"
travisci : "mxc://t2bot.io/7f4703126906fab8bb27df34a17707a8"
rss : "mxc://t2bot.io/aace4fcbd045f30afc1b4e5f0928f2f3"
google : "mxc://t2bot.io/636ad10742b66c4729bf89881a505142"
guggy : "mxc://t2bot.io/e7ef0ed0ba651aaf907655704f9a7526"
echo : "mxc://t2bot.io/3407ff2db96b4e954fcbf2c6c0415a13"
circleci : "mxc://t2bot.io/cf7d875845a82a6b21f5f66de78f6bee"
jira : "mxc://t2bot.io/f4a38ebcc4280ba5b950163ca3e7c329"
2019-10-31 13:38:32 +00:00
# Settings for how Dimension is represented to the public
dimension :
# This is where Dimension is accessible from clients. Be sure to set this
# to your own Dimension instance.
publicUrl : "https://{{ matrix_server_fqn_dimension }}"
2019-03-09 17:08:00 +00:00
# Settings for controlling how logging works
logging :
file : /dev/null
console : true
consoleLevel : verbose
fileLevel : info
rotate :
size : 52428800 # bytes, default is 50mb
2019-03-10 20:23:06 +00:00
count : 5
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) }}"