mirror of
https://github.com/turt2live/matrix-dimension.git
synced 2024-10-01 01:05:53 -04:00
67 lines
3.6 KiB
Markdown
67 lines
3.6 KiB
Markdown
|
|
|
|
|
|
An open source integration manager for matrix clients, like Element. For help and support, please visit
|
|
us in [#dimension:t2bot.io](https://matrix.to/#/#dimension:t2bot.io) on Matrix.
|
|
|
|
# 🚨 Project not receiving maintenance
|
|
|
|
Please be aware that Dimension is no longer formally maintained. Bugs are not being looked at, and features are not being implemented.
|
|
Support for the project is extremely limited as well - please check the issue tracker before attempting to use Dimension.
|
|
|
|
At a future date, Dimension may be replaced or made obsolete, however this is not planned for the immediate horizon.
|
|
|
|
Chances are you don't need an integration manager though:
|
|
|
|
* Widgets can be added to rooms with Element Web/Desktop with `/addwidget`
|
|
* Self-hosted bots and bridges can be managed entirely by commands
|
|
* Stickers can either be supported by https://github.com/maunium/stickerpicker or MSC2545-supported clients (like Nheko)
|
|
|
|
# Installing Dimension / Running your own
|
|
|
|
See [docs/installing.md](./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](./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:
|
|
|
|
|
|
# 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.
|