Files

google-labs-jules[bot] 10da311d83 refine: Enhance Docker setup and docs for fork usability

- Corrected 'SpeechRecognition' casing in addons/addons.txt.
- Updated ultroid_setup.sh welcome message to specify the fork.
- Modified README.md, README_DOCKER.md, and DOCKER_DEPLOYMENT.md:
  - Pointed clone/curl URLs and repository links to the overspend1/Ultroid-fork.
  - Reinforced ultroid_setup.sh as the primary method for Docker deployment.
  - Ensured documentation clarity regarding building the Docker image from the fork's source.

2025-06-19 22:06:48 +00:00

8.0 KiB

Raw Permalink Blame History

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 other deployment options or more details, see below.

Other Deployment Options

Okteto
Manual Setup (Docker or Local)

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 Setup

If you prefer a manual setup or want to understand the components:

Docker: Refer to DOCKER_DEPLOYMENT.md and README_DOCKER.md. The ultroid_setup.sh script automates this using these Docker files.
Local Python: The ultroid_setup.sh script automates the following general steps using this fork's code:
1. Clone this repository: git clone https://github.com/overspend1/Ultroid-fork.git && cd Ultroid-fork
2. Create a Python virtual environment: python3 -m venv .venv
3. Activate it: source .venv/bin/activate
4. Install dependencies: pip install -r requirements.txt
5. Configure your variables in a .env file (see Necessary Variables below).
6. 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