TC Multibridge update into master

Dockerfile

@@ -0,0 +1,14 @@
+FROM node:12-alpine
+
+WORKDIR /opt/TediCross/
+
+COPY . .
+
+RUN npm install --production
+
+# The node user (from node:12-alpine) has UID 1000, meaning most people with single-user systems will not have to change UID
+USER node
+
+VOLUME /opt/TediCross/data/
+
+ENTRYPOINT /usr/local/bin/npm start -- -c data/settings.yaml

README-Docker.md

@@ -0,0 +1,31 @@
+TediCross with Docker
+=====================
+
+**This document assumes you know how to use [Docker](https://en.wikipedia.org/wiki/Docker_(software)). If you are completely clueless, please disregard Docker and follow the ordinary [install instructions](README.md#step-by-step-installation)**
+
+TediCross is available as a Docker image, through [DockerHub](https://cloud.docker.com/u/tedicross/repository/docker/tedicross/tedicross)
+
+It requires the `data/` directory to be mounted as a volume.
+
+Unlike the non-docker version, the `settings.yaml` file must be in the `data/` directory instead of in the root of the project.
+
+Using the official Docker image
+-------------------------------
+
+The official docker image is used  like this:
+
+```
+docker run \
+  -v /path/to/data/:/opt/TediCross/data \
+  -e TELEGRAM_BOT_TOKEN="Your Telegram token" \
+  -e DISCORD_BOT_TOKEN="Your Discord token" \
+  tedicross/tedicross
+```
+
+Of course, you can add `-d` or `--rm` or a name or whatever else you want to that command
+
+If you have the tokens in the settings file instead of reading them from the environment, you can of course drop the `-e` lines
+
+### Permissions
+
+The dockerfile says the container should start as the user with UID 1000. This should be fine for most single user Linux systems, but may cause problems for multi user systems. If you get a permission error when starting the container, try changing the user the container is using. Find your user's UID with the command `id -u $USER`, then add the argument `-u <UID>` to the `docker run` command. For example `docker run -u 1001 -v ...`

README.md

@@ -26,7 +26,7 @@ Setting up the bot requires basic knowledge of the command line, which is bash o
  1. Install [nodejs](https://nodejs.org)
  2. Clone this git repo, or download it as a zip or whatever
  3. Open a terminal and enter the repo with the [`cd`](https://en.wikipedia.org/wiki/Cd_(command)) command. Something like `cd Downloads/TediCross-master`. Your exact command may differ
- 4. Run the command `npm install`
+ 4. Run the command `npm install --production`
  5. Make a copy of the file `example.settings.yaml` and name it `settings.yaml`
  6. Aquire a bot token for Telegram ([How to create a Telegram bot](https://core.telegram.org/bots#3-how-do-i-create-a-bot)) and put it in the settings file
    - The Telegram bot must be able to access all messages. Talk to [@BotFather](https://t.me/BotFather) to disable privacy mode for the bot
@@ -39,7 +39,7 @@ Setting up the bot requires basic knowledge of the command line, which is bash o
  10. Start TediCross: `npm start`
  11. Ask the bots for the remaining details. In the Telegram chat and the Discord channel, write `/chatinfo`. Put the info you get in the settings file.
    - If you want to bridge a Telegram group or channel, remember that the ID is negative. Include the `-` when entering it into the settings file
-   - It is important that the Discord IDs are wrapped with single quotes when entered into the settings file. `'244791815503347712'`, not `244791815503347712`
+   - It is important that the Discord  channel ID is wrapped with single quotes when entered into the settings file. `'244791815503347712'`, not `244791815503347712`
  12. Restart TediCross. You stop it by pressing CTRL + C in the terminal it is running in
 
 Done! You now have a nice bridge between a Telegram chat and a Discord channel
@@ -55,11 +55,14 @@ As mentioned in the step by step installation guide, there is a settings file. H
 	* `useFirstNameInsteadOfUsername`: **EXPERIMENTAL** If set to `false`, the messages sent to Discord will be tagged with the sender's username. If set to `true`, the messages sent to Discord will be tagged with the sender's first name (or nickname). Note that Discord users can't @-mention Telegram users by their first name. Defaults to `false`
 	* `colonAfterSenderName`: Whether or not to put a colon after the name of the sender in messages from Discord to Telegram. If true, the name is displayed `Name:`. If false, it is displayed `Name`. Defaults to false
 	* `skipOldMessages`: Whether or not to skip through all previous messages cached from the telegram-side and start processing new messages ONLY. Defaults to true. Note that there is no guarantee the old messages will arrive at Discord in order
-	* `sendEmojisWithStickers`: Whether or not to send the corresponding emoji when relaying stickers to Discord
+	* `sendEmojiWithStickers`: Whether or not to send the corresponding emoji when relaying stickers to Discord
 * `discord`: Object authorizing and defining the Discord bot's behaviour
 	* `token`: The Discord bot's token. It is needed for the bot to authenticate to the Discord servers and be able to send and receive messages. If set to `"env"`, TediCross will read the token from the environment variable `DISCORD_BOT_TOKEN`
 	* `skipOldMessages`: Whether or not to skip through all previous messages sent since the bot was last turned off and start processing new messages ONLY. Defaults to true. Note that there is no guarantee the old messages will arrive at Telegram in order. **NOTE:** [Telegram has a limit](https://core.telegram.org/bots/faq#my-bot-is-hitting-limits-how-do-i-avoid-this) on how quickly a bot can send messages. If there is a big backlog, this will cause problems
 	* `useNickname`: Uses the sending user's nickname instead of username when relaying messages to Telegram
+	* `displayTelegramReplies`: How to display Telegram replies. Either the string `blockqoute`, `inline` or `embed`
+	* `replyLength`: How many characters of the original message to display on replies
+	* `maxReplyLines`: How many lines of the original message to display on replies
 * `debug`: If set to `true`, activates debugging output from the bot. Defaults to `false`
 * `bridges`: An array containing all your chats and channels. For each object in this array, you should have the following properties:
 	* `name`: A internal name of the chat. Appears in the log
@@ -68,8 +71,8 @@ As mentioned in the step by step installation guide, there is a settings file. H
 	* `telegram.relayJoinMessages`: Whether or not to relay messages to Discord about people joining the Telegram chat
 	* `telegram.relayLeaveMessages`: Whether or not to relay messages to Discord about people leaving the Telegram chat
 	* `telegram.sendUsernames`: Whether or not to send the sender's name with the messages to Discord
-	* `discord.guild`: ID of the server the Discord end of the bridge is in. If a message to the bot originates from within this server, but not the correct channel, it is ignored, instead of triggering a reply telling the sender to get their own bot. See step 11 on how to aquire it
-	* `discord.channel`: ID of the channel the Discord end of the bridge is in. See step 11 on how to aquire it
+	* `telegram.relayCommands`: If set to `false`, messages starting with a `/` are not relayed to Discord
+	* `discord.channelId`: ID of the channel the Discord end of the bridge is in. See step 11 on how to aquire it
 	* `discord.relayJoinMessages`: Whether or not to relay messages to Telegram about people joining the Discord chat
 	* `discord.relayLeaveMessages`: Whether or not to relay messages to Telegram about people leaving the Discord chat
 	* `discord.sendUsernames`: Whether or not to send the sender's name with the messages to Telegram
@@ -114,6 +117,12 @@ The Telegram team unfortunately decided that bots cannot interact with each othe
 
 See https://core.telegram.org/bots/faq#why-doesn-39t-my-bot-see-messages-from-other-bots
 
+### Deleting a message in Telegram does not delete it in Discord
+
+Telegram bots are unfortunately completely unable to detect when a message is deleted. There is no way to implement T2D cross-deletion until Telegram implements this.
+
+Deleting messages D2T works.
+
 ### When running `npm install`, it complains about missing dependencies?
 
 The [Discord library](https://discord.js.org/#/) TediCross is using has support for audio channels and voice chat. For this, it needs some additional libraries, like [node-opus](https://www.npmjs.com/package/node-opus), [libsodium](https://www.npmjs.com/package/libsodium) and others. TediCross does not do audio, so these warnings can safely be ignored

example.settings.yaml

@@ -8,18 +8,22 @@ discord:
   useNickname: false
   token: DISCORD_BOT_TOKEN_HERE       # Discord bot tokens look like this: MjI3MDA1NzIvOBQ2MzAzMiMz.DRf-aw.N0MVYtDxXYPSQew4g2TPqvQve2c
   skipOldMessages: true
+  displayTelegramReplies: embed
+  replyLength: 100
+  maxReplyLines: 2
 bridges:
-  - name: Default bridge
+  - name: First bridge
     direction: both
     telegram:
       chatId: TELEGRAM_CHAT_ID  # Remember that Telegram group and channel IDs are negative. Include the `-` if you are bridging a group or a channel
       relayJoinMessages: true
       relayLeaveMessages: true
       sendUsernames: true
+      relayCommands: true
     discord:
-      serverId: 'DISCORD_SERVER_ID'         # This ID must be wrapped in single quotes. Example: '244791815503347712'
       channelId: 'DISCORD_CHANNEL_ID'       # This ID must be wrapped in single quotes. Example: '244791815503347712'
       relayJoinMessages: true
       relayLeaveMessages: true
       sendUsernames: true
+      crossDeleteOnTelegram: true
 debug: false