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.
520 Commits 13 Branches 0 Tags 9 MiB
TypeScript 82.8%
HTML 13.2%
SCSS 3.5%
JavaScript 0.3%
Dockerfile 0.2%
d77f1bab3a
Go to file
Jonathan Giroux (Koltes) d77f1bab3a
Update README.md
2020-03-19 15:26:56 +01:00
config Support .well-known on Dimension 2019-08-21 20:58:41 -06:00
docs Add docs for installing, troubleshooting, and non-federated environments 2019-03-27 20:52:07 -06:00
scripts Sticker pack administration 2018-05-12 21:55:02 -06:00
src Fix DimensionStore after sequelize-typescript update 2019-11-02 11:45:57 -06:00
web fix #308 2019-12-09 22:51:10 +01:00
.dockerignore Add a dockerignore and README instruction for Docker 2018-07-20 18:30:08 -06: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
DEVELOPMENT.md Link to helpful material in the DEVELOPMENT.md documentation 2018-10-20 19:05:38 -06:00
docker-entrypoint.sh add docker file 2018-07-19 20:57:07 +02:00
Dockerfile Update Node to LTS 10.16.0 2019-07-29 22:21:35 +02:00
LICENSE Initial commit 2017-05-25 15:41:56 -06:00
package-lock.json Fix DimensionStore after sequelize-typescript update 2019-11-02 11:45:57 -06:00
package.json Fix DimensionStore after sequelize-typescript update 2019-11-02 11:45:57 -06:00
postcss.config.js Upgrade dependencies to be nodejs 6.11 & npm5 compatible 2017-06-25 21:57:13 -06:00
README.md Update README.md 2020-03-19 15:26:56 +01:00
tsconfig-app.json Move app from src-ts to src 2017-12-24 02:28:48 -07:00
tsconfig.json Support provisioning bots in go-neb 2018-03-24 14:54:12 -06:00
tslint.json Appease the linter 2019-02-07 21:26:09 -07:00
webpack.config.js Support .well-known on Dimension 2019-08-21 20:58:41 -06:00

README.md

dimension

TravisCI badge

An open source integration manager for matrix clients, like Riot. 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 Riot 1.1.0 or higher, 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 Riot.im, named Modular, 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.