nmdc-telegramfrontend/dist/README.txt

52 lines
1.8 KiB
Plaintext
Raw Normal View History

2018-06-09 01:57:59 +00:00
A bot to synchronise chat between an DC hub and a Telegram supergroup.
2018-06-03 03:27:50 +00:00
2018-06-03 06:24:08 +00:00
Tags: NMDC
Written in Go
## FEATURES
2018-06-09 01:57:59 +00:00
- Supports NMDC / NMDCS / ADC / ADCS hubs
- Automatically upload photos/files/videos/audio/stickers to a Contented server for DC users
- Fallback upload to thumbnail-only if exceeding declared Contented file size limit
- Convert telegram quoted messages to DC quoting style
- Exclude messages from multiple hub nicks (e.g. `Hub-Security` / `PtokaX` and helper bots)
2018-06-03 06:24:08 +00:00
- Standalone binary
2018-06-09 01:57:59 +00:00
- PM with native users
- Get native userlist inside the telegram group chat
- Option for length requirement on native nick
- Disconnect telegram users who fail to log in to the upstream hub
2018-06-03 06:24:08 +00:00
## SETUP
2018-06-03 03:27:50 +00:00
2018-06-03 06:24:08 +00:00
Create a new telegram bot
2018-06-03 03:27:50 +00:00
- Use BotFather to create a new bot
2018-06-03 06:24:08 +00:00
- Use BotFather to disable its privacy mode for group chats
2018-06-09 01:57:59 +00:00
- Use BotFather to add commands (that appear in the groupchat). Recommendation: `userlist - List native online users`
2018-06-03 03:27:50 +00:00
2018-06-03 06:24:08 +00:00
Create a telegram group
2018-06-03 03:27:50 +00:00
- Manually create a group chat and add the bot to it
- Convert group chat to supergroup
- Grant bot to be an administrator (including ability to add more administrators)
- Settings > "Who can add members" > Only administrators
- Create an invite link
2018-06-03 06:24:08 +00:00
Handover to nmdc-telegramfrontend
2018-06-03 03:27:50 +00:00
- Run this bot with no -GroupChatID, to learn the groupchat ID
- Post a test message in the group chat, to discover the groupchat ID
2018-06-03 06:24:08 +00:00
- Leave the group chat (long press on mobile, can't do it on desktop)
2018-06-03 03:27:50 +00:00
- Run this bot with -GroupChatID for normal operation
2018-06-03 06:24:08 +00:00
## USAGE
Chat with the bot to enter/leave the synchronised channel.
Sometimes the telegram invite links can take a few minutes to activate, especially if there has been unusual activity (e.g. frequent join/parts)
2018-06-09 01:57:59 +00:00
## CHANGELOG
2018-06-09 06:35:35 +00:00
2018-06-09 v1.0.0
- Initial public release
2018-06-09 01:57:59 +00:00
2018-06-03
- Private beta