Musify Telegram Bot

A simple inline music bot for Telegram based on vk.com music API

Docker image and compose example is here

Environmental Variables

• TELEGRAM_BOT_API_TOKEN
  required
  Telegram Bot token received from the Telegram's BotFather. To get started with Telegram Bots: https://core.telegram.org/bots

• VK_USERNAME
  required
  Your vk.com account's username (mobile phone or email). This remains totally secret inside your heroku deployment. VK Music API is accessed using some real user credentials.

• VK_PASSWORD
  required
  Your vk.com account's password. This remains totally secret inside your heroku deployment. VK Music API is accessed using some real user credentials.

• VK_USERID Your vk.com account's user ID. It is necessary for audio URLs decryption. Can be retreived automatically but sometimes it fails so it is better to provide it through this environamental variable.

• TELEGRAM_OWNER_CHAT_ID
  required
  ChatID of your account in Telegram. Bot will send you some error logs as well as captcha inquires in an unlikely case it is needed to login on vk.com. How to get your Chat ID

• VK_API_ACCESS_TOKEN
  Service token of any app on vk.com. Used for recognition of vk.com nicknames e.g. @durov (Extra bot feature: one can use their VK's playlist in Telegram using the bot if their music is public). You can create a dummy standalone VK's application here and use its service (not to confuse with account token) token. This functionality will not be available if you leave this variable empty

• MUSIFY_SQL_DSN
  MySQL DSN value of your own MySQL server. Used for storing some metadata and astatistics. See below in ethe readme. Also used to buffer lyrics. This functionality will not be available if you leave this variable empty

Miscellenious

A note on vk.com account use

MusifyBot makes use vk.com music API through its al_audio.php interface. A user account is needed to make calls to it, that is why VK_USERNAME and VK_PASSWORD are required in the environment.

THESE CREDENTIALS ARE NOT STORED ANYWHERE OUTSIDE YOUR DEPLOYMENT/MACHINE/ENVIRONMENT.

Note that the behavior is different based on the bot's server location:

• bot server is located outside Russia (this is the case for heroku servers):
  Your account must have a valid subscription on VK's Boom music service in order to work

• bot server is located in Russia (you will need to host it manually using, for example, Yandex.Cloud or other VM provider or host the bot on your own server in Russia):
  No Boom subscription is required

Statistics DB

To gather statistics on bot's activity, an instance of MySQL or MariaDB must be up and running somewhere on your own servers.

Launch such a database and execute the musify-db.sql script to initialize the schema compatible to this bot. Probably, the easiest way would be to launch a dockerized MariaDB. Please read the instructions from the link on how to properly set environmental variables.

After you've set the DB up, you must now be able to construct your database conncetion DSN that you should put into the MUSIFY_SQL_DSN config var of your heroku deployment, e.g.:

<MYSQL_USER>:<MYSQL_PASSWORD>@tcp(<public-ip-address>:3306)/<MYSQL_DATABASE>

Note that variables names in the DSN above are the same as their corresponding environmental variables of this docker container