finallycoffee/matrix-docker-ansible-deploy
finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity
1bff4893d9
matrix-docker-ansible-deploy/docs/configuring-playbook-dimension.md
Edgars Voroboks 1bff4893d9 Provide Dimension documentation
2019-03-10 10:12:31 +02:00

2.4 KiB
Raw Blame History

Setting up Dimension (optional)

Dimension integrations manager installation is disabled by default. You can enable it in your configuration file (inventory/matrix.<your-domain>/vars.yml):

matrix_dimension_enabled: true

Your Matrix also needs federation enabled for Dimension to work, so if you have disabled it by setting matrix_synapse_federation_enabled to false, please remove or comment this variable in your configuration file. Or set it to:

matrix_synapse_federation_enabled: true

Define admin users

These users can modify the integrations this Dimension supports. Admin interface is accessible by opening Dimension in Riot and clicking the settings icon.
Add this to your configuration file (inventory/matrix.<your-domain>/vars.yml):

matrix_dimension_admins: ['@user1:domain.com', '@user2:domain.com']

Access token

You are required to specify an access token for Dimension to work. To get an access token, follow these steps:

  1. In a private browsing session (incognito window), open Riot.
  2. It's better to you use dedicated user for getting access token, so log in with this user's username and password.
  3. Set the display name and avatar, if required.
  4. In the settings page, scroll down to the bottom and click Access Token: <click to reveal>.
  5. Copy the highlighted text to your configuration.
  6. Close the private browsing session. Do not log out. Logging out will invalidate the token, making it not work.

Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

Add access token to your configuration file (inventory/matrix.<your-domain>/vars.yml):

matrix_dimension_access_token: "YOUR ACCESS TOKEN HERE"

For more information on how to acquire an access token, visit https://t2bot.io/docs/access_tokens.

Additional features

To use a more custom configuration, you can define a matrix_dimension_configuration_extension_yaml string variable and put your configuration in it. To learn more about how to do this, refer to the information about matrix_dimension_configuration_extension_yaml in the default variables file of the Dimension component.

You can find all configuration options on GitHub page of Dimension project.