Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/davidar/hubot-matrix

Matrix adapter for hubot
https://github.com/davidar/hubot-matrix

Last synced: 18 days ago
JSON representation

Matrix adapter for hubot

Awesome Lists containing this project

README

        

# Hubot adapter for Matrix

This is a [Hubot](https://hubot.github.com) adapter for [Matrix](https://matrix.org/).

## Installation

Use the version of this adapter appropriate to your Hubot version.

* For Hubot v2, `npm i hubot-matrix@1`
* For Hubot v3, `npm i hubot-matrix@2`

| **hubot** | **hubot-matrix** |
|----|----|
| v2 | v1 |
| v3 | v2 |

## Adapter configuration

Set the following variables:

* `HUBOT_MATRIX_HOST_SERVER` - the Matrix server to connect to (default is `https://matrix.org` if unset)
* `HUBOT_MATRIX_USER` - bot login on the Matrix server - eg `@examplebotname:matrix.example.org`
* `HUBOT_MATRIX_PASSWORD` - bot password on the Matrix server