iartamonov/mautrix-telegram
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Tulir Asokan
2017-11-21 17:45:26 +02:00
parent cb0d931652
commit 7cdbaf5eff
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -1
View File
@@ -1,12 +1,19 @@
# mautrix-telegram # mautrix-telegram
**Only the very basic functionality has been implemented.** **Work in progress: Expect bugs, do not use in production.**
A Matrix-Telegram puppeting bridge. A Matrix-Telegram puppeting bridge.
## Usage ## Usage
### Setup
1. Create a copy of `example-config.yaml` and fill out the fields. 1. Create a copy of `example-config.yaml` and fill out the fields.
2. Generate the appservice registration with `./mautrix-telegram -g`. 2. Generate the appservice registration with `./mautrix-telegram -g`.
You can use the `-c` and `-r` flags to change the location of the config and registration files. You can use the `-c` and `-r` flags to change the location of the config and registration files.
They default to `config.yaml` and `registration.yaml` respectively. They default to `config.yaml` and `registration.yaml` respectively.
3. Run the bridge `./mautrix-telegram`. You can also use forever: `forever start mautrix-telegram` (probably, I didn't actually test it). 3. Run the bridge `./mautrix-telegram`. You can also use forever: `forever start mautrix-telegram` (probably, I didn't actually test it).
4. Invite the appservice bot to a private room and view the commands with `!tg help`. 4. Invite the appservice bot to a private room and view the commands with `!tg help`.
### Logging in
1. Request a Telegram auth code with `!tg login <phone number>`.
2. Send your auth code with `!tg <auth code>`.
3. If you have two-factor authentication enabled, send your password with `!tg <password>`
4. If all prior steps were executed successfully, the bridge should now create rooms for all your Telegram dialogs and invite you to them.