aa09441014
Heroku deployment support has been temporarily removed due to recent patches affecting Ultroid deployments. This change helps prevent accidental bans caused by users unknowingly deploying to Heroku. Support will be re-added once a proper solution is implemented.
147 lines
7.7 KiB
Markdown
147 lines
7.7 KiB
Markdown
<p align="center">
|
|
<img src="./resources/extras/logo_readme.jpg" alt="TeamUltroid Logo">
|
|
</p>
|
|
<h1 align="center">
|
|
<b>Ultroid - UserBot</b>
|
|
</h1>
|
|
|
|
<b>A stable pluggable Telegram userbot + Voice & Video Call music bot, based on Telethon.</b>
|
|
|
|
[](#)
|
|
[](https://github.com/TeamUltroid/Ultroid/stargazers)
|
|
[](https://github.com/TeamUltroid/Ultroid/fork)
|
|
[](https://github.com/TeamUltroid/Ultroid/)
|
|
[](https://www.python.org/)
|
|
[](https://www.codefactor.io/repository/github/teamultroid/ultroid/overview/main)
|
|
[](https://github.com/TeamUltroid/Ultroid/graphs/commit-activity)
|
|
[](https://img.shields.io/docker/pulls/theteamultroid/ultroid?style=flat-square)
|
|
[](https://github.com/TeamUltroid/Ultroid)
|
|
[](https://github.com/TeamUltroid/Ultroid/graphs/contributors)
|
|
[](https://makeapullrequest.com)
|
|
[](https://github.com/TeamUltroid/Ultroid/blob/main/LICENSE)
|
|
[](https://stars.medv.io/TeamUltroid/Ultroid)
|
|
----
|
|
|
|
# Deploy
|
|
- [Okteto](#deploy-to-okteto)
|
|
- [Local Machine](#deploy-locally)
|
|
|
|
# Documentation
|
|
[](http://ultroid.tech/)
|
|
|
|
# Tutorial
|
|
- Full Tutorial - [](https://www.youtube.com/watch?v=0wAV7pUzhDQ)
|
|
|
|
- Tutorial to get Redis URL and password - [here.](./resources/extras/redistut.md)
|
|
---
|
|
|
|
## Deploy to Okteto
|
|
Get the [Necessary Variables](#Necessary-Variables) and then click the button below!
|
|
|
|
[](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`:
|
|
* [](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
|
|
|
|
<table>
|
|
<tr>
|
|
<td align="center"><a href="https://github.com/xditya"><img src="https://avatars.githubusercontent.com/xditya" width="75px;" alt=""/><br/><sub><b>@xditya</b></sub></a></td>
|
|
<td align="center"><a href="https://github.com/1danish-00"><img src="https://avatars.githubusercontent.com/1danish-00" width="75px;" alt=""/><br/><sub><b>@1danish_00</b></sub></a></td>
|
|
<td align="center"><a href="https://github.com/buddhhu"><img src="https://avatars.githubusercontent.com/buddhhu" width="75px;" alt=""/><br/><sub><b>@buddhhu</b></sub></a></td>
|
|
<td align="center"><a href="https://github.com/TechiError"><img src="https://avatars.githubusercontent.com/TechiError" width="75px;" alt=""/><br/><sub><b>@TechiError</b></sub></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><a href="https://github.com/New-dev0"><img src="https://avatars.githubusercontent.com/New-dev0" width="75px;" alt=""/><br/><sub><b>@New-dev0</b></sub></a></td>
|
|
<td align="center"><a href="https://github.com/ArnabXD"><img src="https://avatars.githubusercontent.com/ArnabXD" width="75px;" alt=""/><br/><sub><b>@Arnab431</b></sub></a></td>
|
|
<td align="center"><a href="https://github.com/sppidy"><img src="https://avatars.githubusercontent.com/sppidy" width="75px;" alt=""/><br/><sub><b>@sppidy</b></sub></a></td>
|
|
<td align="center"><a href="https://github.com/Atul-Kumar-Jena"><img src="https://avatars.githubusercontent.com/Atul-kumar-Jena" width="75px;" alt=""/><br/><sub><b>@hellboi_atul</b></sub></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><a href="https://github.com/iAkashPattnaik"><img src="https://avatars.githubusercontent.com/iAkashPattnaik" width="75px;" alt=""/><br/><sub><b>@iAkashPattnaik</b></sub></a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
## Contributors
|
|
|
|
<a href="https://github.com/TeamUltroid/Ultroid/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=TeamUltroid/Ultroid" />
|
|
</a>
|
|
|
|
We are highly grateful for all the contributions made by our amazing community! ❤️
|
|
|
|
---
|
|
|
|
# License
|
|
[](LICENSE)
|
|
Ultroid is licensed under [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html) v3 or later.
|
|
|
|
|
|
---
|
|
# Credits
|
|
* [](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).
|