/Ultroid

Pluggable Telethon - Telegram UserBot

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

TeamUltroid Logo

Ultroid - UserBot

A stable pluggable Telegram userbot + Voice & Video Call music bot, based on Telethon.

Stars Forks Size
Python CodeFactor Maintenance Docker Pulls Open Source Love svg2
Contributors PRs Welcome License Sparkline

Deploy

Documentation

Documentation

Tutorial

  • Full Tutorial - Full Tutorial

  • Tutorial to get Redis URL and password - here.

Deploy to Heroku

Get the Necessary Variables and then click the button below!

Deploy

Deploy Locally

Local Deploy - Latest Method

This is the latest and most fastest method currently.
First, go to This Project and install the latest release from the Github Releases.
Then, do as it's given in the README.md to add the executable to your system path.

Further, take a look at the docs to get more information.

Local Deploy - Easy Method

  • Linux - bash -c "$(curl -fsSL https://git.io/JY9UM)"
  • Windows - cd desktop ; wget https://git.io/JY9UM -o locals.py ; python locals.py
  • Termux - sh -c "$(curl -fsSL https://git.io/JY9UM)"

Local Deploy - Traditional Method

  • Get your Necessary Variables
  • Clone the repository:
    git clone https://github.com/TeamUltroid/Ultroid.git
  • Go to the cloned folder:
    cd Ultroid
  • Create a virtual env:
    virtualenv -p /usr/bin/python3 venv . ./venv/bin/activate
  • Install the requirements:
    pip(3) install -U -r re*/st*/optional-requirements.txt pip(3) install -U -r requirements.txt
  • Generate your SESSION:
    • For Linux users: bash sessiongen or bash -c "$(curl -fsSL https://git.io/JY9JI)"
    • For Termux users: sh -c "$(curl -fsSL https://git.io/JqgsR)"
    • For Windows Users: cd desktop ; wget https://git.io/JY9JI -o ultroid.py ; python ultroid.py
  • Fill your details in a .env file, as given in .env.sample. (You can either edit and rename the file or make a new file named .env.)
  • Run the bot:
    • Linux Users: bash resources/startup/startup.sh
    • Windows Users: python(3) -m pyUltroid

Necessary Variables

  • SESSION - SessionString for your accounts login session. Get it from here
  • REDIS_URI - Redis endpoint URL, from redislabs, tutorial here.
  • REDIS_PASSWORD - Redis endpoint Password, from redislabs, tutorial here.

Session String

Different ways to get your SESSION:

  • Run on Repl.it
  • Linux : bash -c "$(curl -fsSL https://git.io/JY9JI)"
  • PowerShell : cd desktop ; wget https://git.io/JY9JI ; python ultroid.py
  • Termux : sh -c "$(curl -fsSL https://da.gd/termux-tel)"
  • TelegramBot : @SessionGeneratorBot

Made with 💕 by @TeamUltroid.

License

Ultroid is licensed under GNU Affero General Public License v3 or later.

License

Credits