Matrix-Mirrors/matrix-dimension
1
0
Fork 0
mirror of https://github.com/turt2live/matrix-dimension.git synced 2024-10-01 01:05:53 -04:00
Code Issues Packages Projects Releases Wiki Activity
An open source integration manager for matrix clients, like Element.
705 Commits 13 Branches 0 Tags 9 MiB
TypeScript 82.8%
HTML 13.2%
SCSS 3.5%
JavaScript 0.3%
Dockerfile 0.2%
d9006f4aec
Go to file
Travis Ralston d9006f4aec Make TradingView widget use new select field
2021-12-09 14:39:48 -07:00
.vscode Replace ngx-modialog with ng-bootstrap modals 2021-08-29 23:06:47 +02:00
config Random file cleanup 2021-11-30 19:23:02 -07:00
docs Add documentation on how to run Dimension locally 2021-12-07 12:46:04 -07:00
scripts refactor: reduce the size of the docker container 2020-04-09 09:45:23 +02:00
src Misc cleanup 2021-12-06 21:20:16 -07:00
web Make TradingView widget use new select field 2021-12-09 14:39:48 -07:00
.browserslistrc Docker and tsconfig updates, fix config loading, downgrade typescript-rest for compilation 2021-08-30 23:52:19 +02:00
.dockerignore Add a dockerignore and README instruction for Docker 2018-07-20 18:30:08 -06:00
.eslintignore Upgrade everything to Angular 12 and more + build changes 2021-08-29 19:39:43 +02:00
.eslintrc.json ESLint config, fix easy eslint errors 2021-09-02 01:01:01 +02:00
.gitignore Verify the utility user belongs to a dedicated user 2019-03-20 21:24:16 -06:00
.travis.yml Update linting to include the web project as well 2018-03-23 21:29:48 -06:00
angular.json Upgrade everything to Angular 12 and more + build changes 2021-08-29 19:39:43 +02:00
DEVELOPMENT.md Riot -> Element 2020-07-15 18:24:23 -06:00
docker-entrypoint.sh Docker and tsconfig updates, fix config loading, downgrade typescript-rest for compilation 2021-08-30 23:52:19 +02:00
Dockerfile Tidy apk add command 2021-09-21 15:35:46 +10:00
karma.conf.js Upgrade everything to Angular 12 and more + build changes 2021-08-29 19:39:43 +02:00
LICENSE Initial commit 2017-05-25 15:41:56 -06:00
package-lock.json Use read-pkg-up to search for package.json version 2021-12-01 21:40:24 +01:00
package.json Merge branch 'master' into travis/meaningless-branch-name 2021-12-01 14:36:06 -07:00
postcss.config.js Upgrade dependencies to be nodejs 6.11 & npm5 compatible 2017-06-25 21:57:13 -06:00
proxy.conf.json Upgrade everything to Angular 12 and more + build changes 2021-08-29 19:39:43 +02:00
README.md Riot -> Element 2020-07-15 18:24:23 -06:00
tsconfig.app.json Upgrade everything to Angular 12 and more + build changes 2021-08-29 19:39:43 +02:00
tsconfig.backend.json Docker and tsconfig updates, fix config loading, downgrade typescript-rest for compilation 2021-08-30 23:52:19 +02:00
tsconfig.json Docker and tsconfig updates, fix config loading, downgrade typescript-rest for compilation 2021-08-30 23:52:19 +02:00
tsconfig.spec.json Upgrade everything to Angular 12 and more + build changes 2021-08-29 19:39:43 +02:00

README.md

dimension

TravisCI badge

An open source integration manager for matrix clients, like Element. For help and support, please visit us in #dimension:t2bot.io on Matrix.

Installing Dimension / Running your own

See docs/installing.md for more information on running Dimension.

"Could not contact integrations server" error

  1. Check that federation is enabled and working on your homeserver. If you're not intentionally running Dimension in a non-federated environment, make sure that your homeserver is configured correctly. If you are running in a non-federated environment, consult docs/unfederated.md.
  2. Check your SRV records and .well-known delegation. If you are using SRV records to point to your federation port, make sure that the hostname and port are correct, and that HTTPS is listening on that port. Dimension will use the first record it sees and will only communicate over HTTPS. If you're using .well-known delegation for federation, double check that is set up correctly.
  3. Verify the homeserver information in your configuration. The name, access token, and client/ server API URL all need to be set to point towards your homeserver. It may also be necessary to set the federation URL if you're running a private server.
  4. Run the troubleshooter. If you're on Element, type /addwidget https://dimension.t2bot.io/widgets/manager-test in a private room then click the button.

Do I need an integrations manager?

Integration managers aim to ease a user's interaction with the various services a homeserver may provide. Often times the integrations manager provided by Element, is more than suitable. However, there are a few cases where running your own makes more sense:

  • Wanting to self-host all aspects of your services (client, homeserver, and integrations)
  • Wanting to advertise custom bots specific to your homeserver
  • Corporate or closed environments where the default integration manager won't work

How do integration managers work?

Integration managers sit between your users and your integrations (bots, bridges, etc). It helps guide users through the configuration of your integrations for their rooms. The integrations manager can only manage integrations it is configured for. For example, Modular can only provide configuration for the bridges and bots running on matrix.org, while Dimension can provide configuration for your own bots and bridges.

The infrastructure diagram looks something like this: infrastructure

Development

For more information about working on Dimension, see DEVELOPMENT.md.

License

For information about Dimension's license, please see the LICENSE file included in this repository.