TeamUltroid Logo

Ultroid - UserBot

A stable pluggable Telegram userbot + Voice & Video Call music bot, based on Telethon. [![](https://img.shields.io/badge/Ultroid-v0.8-crimson)](#) [![Stars](https://img.shields.io/github/stars/TeamUltroid/Ultroid?style=flat-square&color=yellow)](https://github.com/TeamUltroid/Ultroid/stargazers) [![Forks](https://img.shields.io/github/forks/TeamUltroid/Ultroid?style=flat-square&color=orange)](https://github.com/TeamUltroid/Ultroid/fork) [![Size](https://img.shields.io/github/repo-size/TeamUltroid/Ultroid?style=flat-square&color=green)](https://github.com/TeamUltroid/Ultroid/) [![Python](https://img.shields.io/badge/Python-v3.10+-blue)](https://www.python.org/) [![CodeFactor](https://www.codefactor.io/repository/github/teamultroid/ultroid/badge/main)](https://www.codefactor.io/repository/github/teamultroid/ultroid/overview/main) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/TeamUltroid/Ultroid/graphs/commit-activity) [![Docker Pulls](https://img.shields.io/docker/pulls/theteamultroid/ultroid?style=flat-square)](https://img.shields.io/docker/pulls/theteamultroid/ultroid?style=flat-square) [![Open Source Love svg2](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/TeamUltroid/Ultroid) [![Contributors](https://img.shields.io/github/contributors/TeamUltroid/Ultroid?style=flat-square&color=green)](https://github.com/TeamUltroid/Ultroid/graphs/contributors) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) [![License](https://img.shields.io/badge/License-AGPL-blue)](https://github.com/TeamUltroid/Ultroid/blob/main/LICENSE) ---- # Deploy - [Heroku](#deploy-to-heroku) - [Okteto](#deploy-to-okteto) - [Local Machine](#deploy-locally) # Documentation [![Documentation](https://img.shields.io/badge/Documentation-Ultroid-blue)](http://ultroid.tech/) # Tutorial - Full Tutorial - [![Full Tutorial](https://img.shields.io/badge/Watch%20Now-blue)](https://www.youtube.com/watch?v=0wAV7pUzhDQ) - Tutorial to get Redis URL and password - [here.](./resources/extras/redistut.md) --- ## Deploy to Heroku Get the [Necessary Variables](#Necessary-Variables) and then click the button below!

Deploy To Heroku

## Deploy to Okteto Get the [Necessary Variables](#Necessary-Variables) and then click the button below! [![Develop on Okteto](https://okteto.com/develop-okteto.svg)](https://cloud.okteto.com/deploy?repository=https://github.com/TeamUltroid/Ultroid) ## Deploy Locally - [Traditional Method](#local-deploy---traditional-method) - [Easy Method](#local-deploy---easy-method) - [Ultroid CLI](#ultroid-cli) ### Local Deploy - Easy Method - Linux - `wget -O locals.py https://git.io/JY9UM && python3 locals.py` - Windows - `cd desktop ; wget https://git.io/JY9UM -o locals.py ; python locals.py` - Termux - `wget -O install-termux https://tiny.ultroid.tech/termux && bash install-termux` ### Local Deploy - Traditional Method - Get your [Necessary Variables](#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 `wget -O session.py https://git.io/JY9JI && python3 session.py` - For Termux users: `wget -O session.py https://git.io/JY9JI && python session.py` - 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`](https://github.com/TeamUltroid/Ultroid/blob/main/.env.sample). (You can either edit and rename the file or make a new file named `.env`.) - Run the bot: - Linux Users: `bash startup` - Windows Users: `python(3) -m pyUltroid` --- ## Necessary Variables - `SESSION` - SessionString for your accounts login session. Get it from [here](#Session-String) One of the following database: - For **Redis** (tutorial [here](./resources/extras/redistut.md)) - `REDIS_URI` - Redis endpoint URL, from [redislabs](http://redislabs.com/). - `REDIS_PASSWORD` - Redis endpoint Password, from [redislabs](http://redislabs.com/). - For **MONGODB** - `MONGO_URI` - Get it from [mongodb](https://mongodb.com/atlas). - For **SQLDB** - `DATABASE_URL`- Get it from [elephantsql](https://elephantsql.com). ## Session String Different ways to get your `SESSION`: * [![Run on Repl.it](https://replit.com/badge/github/TeamUltroid/Ultroid)](https://replit.com/@TeamUltroid/UltroidStringSession) * Linux : `wget -O session.py https://git.io/JY9JI && python3 session.py` * PowerShell : `cd desktop ; wget https://git.io/JY9JI ; python ultroid.py` * Termux : `wget -O session.py https://git.io/JY9JI && python session.py` * TelegramBot : [@SessionGeneratorBot](https://t.me/SessionGeneratorBot) --- # Core Contributor Team

_@xditya	_{@1danish_00}	_@buddhhu	_@TechiError
_@New-dev0	_@Arnab431	_@sppidy	_{@hellboi_atul}
_{@iAkashPattnaik}

## Contributors

We are highly grateful for all the contributions made by our amazing community! ❤️ --- # License [![License](https://www.gnu.org/graphics/agplv3-155x51.png)](LICENSE) Ultroid is licensed under [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html) v3 or later. --- # Credits * [![TeamUltroid-Devs](https://img.shields.io/static/v1?label=Teamultroid&message=devs&color=critical)](https://t.me/UltroidDevs) * [Lonami](https://github.com/LonamiWebs/) for [Telethon.](https://github.com/LonamiWebs/Telethon) * [MarshalX](https://github.com/MarshalX) for [PyTgCalls.](https://github.com/MarshalX/tgcalls) > Made with 💕 by [@TeamUltroid](https://t.me/TeamUltroid).