Ultroid - UserBot

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

🚀 Getting Started

The easiest way to set up Ultroid is by using our unified setup script.

Run this command in your terminal:

bash <(curl -s https://raw.githubusercontent.com/overspend1/Ultroid-fork/main/ultroid_setup.sh)

Or, clone this repository and run the script:

git clone https://github.com/overspend1/Ultroid-fork.git
cd Ultroid-fork
bash ultroid_setup.sh

This script will guide you through choosing either a Docker-based or a local Python installation for this fork and help configure the necessary variables.

For more detailed deployment options, including manual Docker setup, see below.

Deployment Options

Automated Setup (Recommended): Use the ultroid_setup.sh script as described above.
Docker (Manual): For a manual Docker setup, see the Manual Docker Setup section below or the comprehensive README_DOCKER.md for advanced details.
Local Python (Manual): See Manual Local Python Setup.
Okteto: See Deploy to Okteto.

Documentation

Tutorial

Full Tutorial -
Tutorial to get Redis URL and password - here.

Deploy to Okteto

Get the Necessary Variables and then click the button below!

Manual Docker Setup

If you prefer a manual Docker setup:

Clone the repository:

git clone https://github.com/overspend1/Ultroid-fork.git
cd Ultroid-fork

Configure .env file: Copy the sample and fill in your details (API_ID, API_HASH, SESSION, etc.).
```
cp .env.sample .env
nano .env 
```
Refer to the Necessary Variables section and README_DOCKER.md for details on all variables.
Build and Run with Docker Compose:
```
docker-compose build
docker-compose up -d
```
This will build the Docker images and start the Ultroid bot and any configured database services (like Redis) in detached mode.

For more advanced Docker configurations, troubleshooting, and management commands (like using the Makefile), please refer to the detailed README_DOCKER.md.

Manual Local Python Setup

The ultroid_setup.sh script automates these steps, but if you prefer manual local Python setup:

Clone this repository: git clone https://github.com/overspend1/Ultroid-fork.git && cd Ultroid-fork
Create a Python virtual environment: python3 -m venv .venv
Activate it: source .venv/bin/activate (for Linux/macOS) or .\.venv\Scripts\activate (for Windows)
Install dependencies: pip install -r requirements.txt
Configure your variables in a .env file (see Necessary Variables below).
Run the bot: python3 -m pyUltroid

Important: Necessary Variables

Whether using the setup script or a manual method, you will need the following:

SESSION: Your Telegram user account session string. The setup script and other utilities can help you generate this. See Session String for methods.

One of the following database:

For Redis (tutorial here)
- REDIS_URI - Redis endpoint URL, from redislabs.
- REDIS_PASSWORD - Redis endpoint Password, from redislabs.
For MONGODB
- MONGO_URI - Get it from mongodb.
For SQLDB
- DATABASE_URL- Get it from elephantsql.

Session String

Different ways to get your SESSION:

Linux : wget -O session.py https://git.io/JY9JI && python3 session.py
PowerShell : cd desktop ; wget https://git.io/JY9JI -OutFile session.py ; python session.py
Termux : wget -O session.py https://git.io/JY9JI && python session.py
Telegram Bot : @SessionGeneratorBot
Using ultroid_setup.sh: The setup script will guide you through session generation if needed.
Using generate-session.sh: This script in the repository provides various methods: bash generate-session.sh