jowj/matrix-docker-ansible-deploy
1
0
Fork 0
forked from mirrors/matrix-docker-ansible-deploy
Code Issues Pull Requests Releases Wiki Activity
d5e8d2a939
matrix-docker-ansible-deploy/docs/configuring-playbook-dimension.md

79 lines
4.6 KiB
Markdown
Raw Normal View History

Provide Dimension documentation
2019-03-10 08:12:31 +00:00
# Setting up Dimension (optional)
Add some more links to Dimension's homepage
2019-03-10 19:43:03 +00:00
**[Dimension](https://dimension.t2bot.io) can only be installed after Matrix services are installed and running.**
Make some additions to Dimension documentation
2019-03-10 11:17:56 +00:00
If you're just installing Matrix services for the first time, please continue with the [Configuration](configuring-playbook.md) / [Installation](installing.md) flow and come back here later.
Update configuring-playbook-dimension.md
2021-10-11 23:50:46 +00:00
**Note**: This playbook now supports running [Dimension](https://dimension.t2bot.io) in both a federated and [unfederated](https://github.com/turt2live/matrix-dimension/blob/master/docs/unfederated.md) environments. This is handled automatically based on the value of `matrix_synapse_federation_enabled`. Enabling Dimension, means that the `openid` API endpoints will be exposed on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. It's something to be aware of, especially in terms of firewall whitelisting (make sure port `8448` is accessible).
Automatically enable openid listeners when ma1sd enabled ma1sd requires the openid endpoints for certain functionality. Example: https://github.com/ma1uta/ma1sd/blob/90b2b5301c34168346fdc5e7eccc09d6958e999f/src/main/java/io/kamax/mxisd/auth/AccountManager.java#L67-L99 If federation is disabled, we still need to expose these openid APIs on the federation port. Previously, we were doing similar magic for Dimension. As per its documentation, when running unfederated, one is to enable the openid listener as well. As per their recommendation, people are advised to do enable it on the Client-Server API port and use the `federationUrl` variable to override where the federation port is (making federation requests go to the Client-Server API). Because ma1sd always uses the federation port (unless you do some DNS overwriting magic using its configuration -- which we'd rather not do), it's better if we just default to putting the `openid` listener where it belongs - on the federation port. With this commit, we retain the "automatically enable openid APIs" thing we've been doing for Dimension, but move it to the federation port instead. We also now do the same thing when ma1sd is enabled.
2020-12-08 14:48:25 +00:00
Make some additions to Dimension documentation
2019-03-10 11:17:56 +00:00
## Prerequisites
Make it clearer that Dimension requires a dedicated user
2020-05-06 07:29:43 +00:00
Update configuring-playbook-dimension.md
2021-10-11 23:50:46 +00:00
The `dimension.<your-domain>` DNS record must be created. See [Configuring your DNS server](configuring-dns.md) on how to set up DNS record correctly.
Make some additions to Dimension documentation
2019-03-10 11:17:56 +00:00
Make it clearer that Dimension requires a dedicated user
2020-05-06 07:29:43 +00:00
Make some additions to Dimension documentation
2019-03-10 11:17:56 +00:00
## Enable
Make it clearer that Dimension requires a dedicated user
2020-05-06 07:29:43 +00:00
Fix incorrect inventory host_vars paths
2019-05-23 23:06:42 +00:00
[Dimension integrations manager](https://dimension.t2bot.io) installation is disabled by default. You can enable it in your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):
Provide Dimension documentation
2019-03-10 08:12:31 +00:00
```yaml
matrix_dimension_enabled: true
```
## Define admin users
Make it clearer that Dimension requires a dedicated user
2020-05-06 07:29:43 +00:00
Move roles/matrix* to roles/custom/matrix* This paves the way for installing other roles into `roles/galaxy` using `ansible-galaxy`, similar to how it's done in: - https://github.com/spantaleev/gitea-docker-ansible-deploy - https://github.com/spantaleev/nextcloud-docker-ansible-deploy In the near future, we'll be removing a lot of the shared role code from here and using upstream roles for it. Some of the core `matrix-*` roles have already been extracted out into other reusable roles: - https://github.com/devture/com.devture.ansible.role.postgres - https://github.com/devture/com.devture.ansible.role.systemd_docker_base - https://github.com/devture/com.devture.ansible.role.timesync - https://github.com/devture/com.devture.ansible.role.vars_preserver - https://github.com/devture/com.devture.ansible.role.playbook_runtime_messages - https://github.com/devture/com.devture.ansible.role.playbook_help We just need to migrate to those.
2022-11-03 07:11:29 +00:00
These users can modify the integrations this Dimension supports.
Fix incorrect inventory host_vars paths
2019-05-23 23:06:42 +00:00
Add this to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):
Provide Dimension documentation
2019-03-10 08:12:31 +00:00
```yaml
Clarify domain of Dimension admin users in docs by using matrix_domain variable
2020-05-04 15:34:23 +00:00
matrix_dimension_admins:
- "@user1:{{ matrix_domain }}"
- "@user2:{{ matrix_domain }}"
Provide Dimension documentation
2019-03-10 08:12:31 +00:00
```
Update configuring-playbook-dimension.md
2022-03-18 20:52:25 +00:00
The admin interface is accessible within Element by accessing it in any room and clicking the cog wheel/settings icon in the top right. Currently, Dimension can be opened in Element by the "Add widgets, bridges, & bots" link in the room information.
Make it clearer that Dimension requires a dedicated user
2020-05-06 07:29:43 +00:00
Provide Dimension documentation
2019-03-10 08:12:31 +00:00
## Access token
Make it clearer that Dimension requires a dedicated user
2020-05-06 07:29:43 +00:00
We recommend that you create a dedicated Matrix user for Dimension (`dimension` is a good username).
Follow our [Registering users](registering-users.md) guide to learn how to register **a regular (non-admin) user**.
You are required to specify an access token (belonging to this new user) for Dimension to work.
Create dedicated doc page on obtaining access tokens
2022-08-20 09:47:14 +00:00
To get an access token for the Dimension user, you can follow the documentation on [how to do obtain an access token](obtaining-access-tokens.md).
Add a secondary option on how to get access token Potentially the CURLing could be a better approach, since then you don't leave spare sessions hanging.
2020-07-29 16:53:39 +00:00
Provide Dimension documentation
2019-03-10 08:12:31 +00:00
**Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.**
Fix incorrect inventory host_vars paths
2019-05-23 23:06:42 +00:00
Add access token to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):
Provide Dimension documentation
2019-03-10 08:12:31 +00:00
```yaml
matrix_dimension_access_token: "YOUR ACCESS TOKEN HERE"
Minor fixup
2020-03-20 22:13:31 +00:00
```
Move things around a bit
2020-03-20 22:12:26 +00:00
For more information on how to acquire an access token, visit [https://t2bot.io/docs/access_tokens](https://t2bot.io/docs/access_tokens).
Provide Dimension documentation
2019-03-10 08:12:31 +00:00
Make it clearer that Dimension requires a dedicated user
2020-05-06 07:29:43 +00:00
## Installation
Move things around a bit
2020-03-20 22:12:26 +00:00
After these variables have been set, please run the following command to re-run setup and to restart Dimension:
how to activate dimensions I am new to synapse. Thanks so much for these playbooks! I wasn't sure how you actual activate dimensions after setting these variables. Should you re run ansible-playbook -i inventory/hosts setup.yml --tags=setup-all ansible-playbook -i inventory/hosts setup.yml --tags=start ? If so perhaps you could tell the readers to do this somewhere in the help file Thanks =]
2020-03-20 20:45:53 +00:00
```
Move things around a bit
2020-03-20 22:12:26 +00:00
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
how to activate dimensions I am new to synapse. Thanks so much for these playbooks! I wasn't sure how you actual activate dimensions after setting these variables. Should you re run ansible-playbook -i inventory/hosts setup.yml --tags=setup-all ansible-playbook -i inventory/hosts setup.yml --tags=start ? If so perhaps you could tell the readers to do this somewhere in the help file Thanks =]
2020-03-20 20:45:53 +00:00
```
Update configuring-playbook-dimension.md
2021-10-11 23:50:46 +00:00
After Dimension has been installed you may need to log out and log back in for it to pick up the new integrations manager. Then you can access integrations in Element by opening a room, clicking the Room info button (`i`) button in the top right corner of the screen, and then clicking Add widgets, bridges & bots.
Make it clearer that Dimension requires a dedicated user
2020-05-06 07:29:43 +00:00
Document how to point dimension jitsi widgets at your own jitsi instance This can be removed once turt2live/matrix-dimension#345 is resolved.
2020-04-29 17:00:24 +00:00
## Jitsi domain
Add some links
2020-04-30 07:14:46 +00:00
By default Dimension will use [jitsi.riot.im](https://jitsi.riot.im/) as the `conferenceDomain` of [Jitsi](https://jitsi.org/) audio/video conference widgets. For users running [a self-hosted Jitsi instance](./configuring-playbook-jitsi.md), you will likely want the widget to use your own Jitsi instance. Currently there is no way to configure this via the playbook, see [this issue](https://github.com/turt2live/matrix-dimension/issues/345) for details.
Document how to point dimension jitsi widgets at your own jitsi instance This can be removed once turt2live/matrix-dimension#345 is resolved.
2020-04-29 17:00:24 +00:00
Riot is now Element Fixes #586 (Github Issue)
2020-07-17 08:31:20 +00:00
In the interim until the above limitation is resolved, an admin user needs to configure the domain via the admin ui once dimension is running. In Element, go to *Manage Integrations* &rightarrow; *Settings* &rightarrow; *Widgets* &rightarrow; *Jitsi Conference Settings* and set *Jitsi Domain* and *Jitsi Script URL* appropriately.
Document how to point dimension jitsi widgets at your own jitsi instance This can be removed once turt2live/matrix-dimension#345 is resolved.
2020-04-29 17:00:24 +00:00
Make it clearer that Dimension requires a dedicated user
2020-05-06 07:29:43 +00:00
Provide Dimension documentation
2019-03-10 08:12:31 +00:00
## 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.
Move roles/matrix* to roles/custom/matrix* This paves the way for installing other roles into `roles/galaxy` using `ansible-galaxy`, similar to how it's done in: - https://github.com/spantaleev/gitea-docker-ansible-deploy - https://github.com/spantaleev/nextcloud-docker-ansible-deploy In the near future, we'll be removing a lot of the shared role code from here and using upstream roles for it. Some of the core `matrix-*` roles have already been extracted out into other reusable roles: - https://github.com/devture/com.devture.ansible.role.postgres - https://github.com/devture/com.devture.ansible.role.systemd_docker_base - https://github.com/devture/com.devture.ansible.role.timesync - https://github.com/devture/com.devture.ansible.role.vars_preserver - https://github.com/devture/com.devture.ansible.role.playbook_runtime_messages - https://github.com/devture/com.devture.ansible.role.playbook_help We just need to migrate to those.
2022-11-03 07:11:29 +00:00
To learn more about how to do this, refer to the information about `matrix_dimension_configuration_extension_yaml` in the [default variables file](../roles/custom/matrix-dimension/defaults/main.yml) of the Dimension component.
Provide Dimension documentation
2019-03-10 08:12:31 +00:00
You can find all configuration options on [GitHub page of Dimension project](https://github.com/turt2live/matrix-dimension/blob/master/config/default.yaml).
Reference in New Issue Copy Permalink