stonewareslord/telematrix
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add some documentation for bridging rooms (#30)

Browse Source 
There was no information on how to do this, and while it is common knowledge around those who actively use the bridge, it would be better if it was properly documented. Open for suggestions on how to improve on this.
This commit is contained in:
Jan Christian Grünhage 2017-09-05 14:20:48 +02:00 committed by Sijmen Schoon
parent 18c5a5cd7b
commit 5a4b21db77
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -2,6 +2,16 @@
A bridge between Telegram and [Matrix](http://matrix.org/). Currently under development — this project isn't considered to be in a usable state right now. A bridge between Telegram and [Matrix](http://matrix.org/). Currently under development — this project isn't considered to be in a usable state right now.
## Usage
After the [installation](#installation), follow these steps to bridge a matrix room to a telegram group chat or channel:
- Invite the bot to the telegram chat.
- Send `/alias` in the telegram chat.
- The bot will answer with an alias, something like `#telegram_-XXXXXXXXX:yourserver.example`. Add that as an alias to the matrix room you want to bridge.
In case it doesn't work make sure that all these are true:
- You are on the same server as the brigde. If that is not the case, you can't set the alias, because you can only set aliases on the server you are on.
- The matrix room is not set to invite only. The bridge currently doesn't support invite only rooms, so the rooms must be set to be open for all. Guests access is not required though.
## Installation ## Installation
### Dependencies ### Dependencies