Do you like the project? Buy me a coffee or a beer 🍻

• List of available commands
• How to install it
• Note
• Bugs, support and suggestions

• List of all torrents;
• Torrent status - Get all details about a torrent;
• Torrent start - Restart a torrent that is paused;
• Torrent stop - Stop a torrent;
• Torrent remove - Remove a torrent;
• Add torrent - Add a torrent from a .torrent file or from an url;

Clone the repository with git clone https://github.com/raffaelecalza/transmission-telegram-bot.git or download it as a zip file from here.

First of all you have to register your bot's name. To do this, begin a new chat to @BotFather. Send /newbot command. Then send to him the name of your bot (e.g. My Wonderful Bot). Then send a username for the bot (NOTE: this must end with the word 'bot'), e.g. MyWonderfulBot. After that the Bot Father will send you a message that contains the TOKEN for the bot. Save it because in the fourth step we'll use it.

This step is optional because the bot has a custom keyboard, but I suggest you to set the commands. After you have register your bot and take the token you have to send to BotFather the full list of commands. Use the /setcommands and send this string to BotFather:

torrentlist - Get the list of all torrents
torrentstatus - Get all details about a torrent
torrentadd - Add a torrent from url
torrentstart - Start a paused torrent
torrentstop - Stop a torrent
torrentremove - Remove a torrent
settings - Set your preferences
help - Get the list of available commands

Go to the next step if you have already installed NodeJS, NPM and PM2.

For Windows and OSX go to NodeJS site and download the installer (https://nodejs.org/en/download/). This also will install NPM.

For linux users, follow this guide (https://nodejs.org/en/download/package-manager/).

Open up a terminal, go to your bot's folder and then run npm install.

For running your bot forever and as a daemon, you have to install a simple library called PM2 - Process Manager 2. So, Open a console and type sudo npm install -g pm2. If everything goes right try to type this command in the terminal pm2 status, and you should see an empty list of applications.

Now, open the config.json file with a text editor. Replace the token string with your bot's token. If you already know your chats id insert it in the array. In the transmission section, insert the ip address of the computer where transmission is installed (localhost if the bot runs in the same machine). Insert your username and password if you've set it, otherwise leave this fileds empty (don't delete them). The last step is to specify the number of the port (if you have changed it).

{
  "bot": {
      "token": "your bot's token",
      "users": [000000, 000000, 2222222]
  },
  "transmission": {
      "address": "your ip address",
      "credentials": {
          "username": "leave this empty if you doesn't have a username",
          "password": "leave this empty if you doesn't have a password"
      },
      "port": 9091
  }
}

If you don't know your chat id, open a terminal and go to your bot repo's folder, open the bot/ folder then start your bot (after have installed all packages in the 3 step) with the command node bot.js. Try to send a message to your bot, you'll see in the console your chat id, hit Ctrl + C to stop the bot and insert your chat id in the config file.
NOTE: you must have inserted at least the bot token in the config file but i recommend you to configure also Transmission before running your bot.

Now you haven't to wait anymore, go to your bot folder and type pm2 start bot.js. Then your bot will start in background.

If you shutdown or reboot your PC, PM2 will stop your application so you have to re-run your bot every time with the command pm2 start bot.js.

If you have discovered a bug or if you have a suggestion, please open an issue or send me an email ([email protected])