2017-05-27 23:45:07 +00:00
# Dimension
2017-09-03 05:08:56 +00:00
[](https://travis-ci.org/turt2live/matrix-dimension)
[](https://waffle.io/turt2live/waffle-matrix?utm_source=badge)
[](https://waffle.io/turt2live/waffle-matrix?utm_source=badge)
2017-05-26 18:59:34 +00:00
2017-05-28 00:39:01 +00:00
An alternative integrations manager for [Riot ](https://riot.im ). Join us on matrix: [#dimension:t2l.io ](https://matrix.to/#/#dimension:t2l.io )
2017-05-25 22:01:25 +00:00
2017-05-28 00:39:01 +00:00
2017-05-27 23:45:07 +00:00
2017-06-10 21:02:59 +00:00
# ⚠️ Dimension is in Alpha ⚠️
Dimension supports some bridges and bots, however using Dimension in a production scenario is not recommended. Dimension uses features available in recent builds of Riot and may not work on older versions.
There are plans on the matrix.org front to better support integration managers. Those changes may require an updated homeserver and Riot when made available.
2017-05-27 23:45:07 +00:00
# Configuring Riot to use Dimension
Change the values in Riot's `config.json` as shown below. If you do not have a `config.json` , copy the `config.sample.json` from Riot.
```
"integrations_ui_url": "https://dimension.t2bot.io/riot",
"integrations_rest_url": "https://dimension.t2bot.io/api/v1/scalar",
```
The remaining settings should be tailored for your Riot deployment.
2017-09-09 02:30:49 +00:00
# Building
2017-05-27 23:45:07 +00:00
2017-09-09 02:30:49 +00:00
To create a production build of Dimension, run `npm run build` . For development environments, see the Development section below.
2017-05-27 23:45:07 +00:00
2017-09-09 02:30:49 +00:00
# Running your own
2017-05-27 23:45:07 +00:00
2017-09-09 02:30:49 +00:00
1. Run `npm run build`
2. Copy `config/default.yaml` to `config/production.yaml` and edit `config/production.yaml`
3. Edit any integration settings in `config/integrations`
4. Run Dimension with `NODE_ENV=production node app.js`
Dimension is now available on the port/host you configured.
### Running Dimension behind nginx
1. Run `npm run build`
2. Copy `config/default.yaml` to `config/production.yaml` and edit `config/production.yaml`
3. Edit any integration settings in `config/integrations`
4. Set the host for Dimension to listen on to `localhost` or `127.0.0.1`
5. Run Dimension with `NODE_ENV=production node app.js`
6. Set up the following reverse proxy information as applicable
```
location / {
proxy_set_header X-Forwarded-For $remote_addr;
proxy_pass http://localhost:8184;
}
```
Be sure to also configure any SSL offloading.
2017-05-27 23:45:07 +00:00
# Development
2017-09-09 02:30:49 +00:00
1. Copy `config/default.yaml` to `config/development.yaml` and make any edits
2. Run Dimension with `NODE_ENV=development node app.js`
3. Run the web app with `npm run dev`
