Spaces:
Paused
Paused
Drag commited on
Commit ·
7a1328c
1
Parent(s): 3a0fcde
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,122 +1 @@
|
|
| 1 |
-
|
| 2 |
-
<img src="./resources/extras/logo_readme.jpg" alt="TeamUltroid Logo">
|
| 3 |
-
</p>
|
| 4 |
-
<h1 align="center">
|
| 5 |
-
<b>Ultroid - UserBot</b>
|
| 6 |
-
</h1>
|
| 7 |
-
|
| 8 |
-
<b>A stable pluggable Telegram userbot + Voice & Video Call music bot, based on Telethon.</b>
|
| 9 |
-
|
| 10 |
-
[](#)
|
| 11 |
-
[](https://github.com/TeamUltroid/Ultroid/stargazers)
|
| 12 |
-
[](https://github.com/TeamUltroid/Ultroid/fork)
|
| 13 |
-
[](https://github.com/TeamUltroid/Ultroid/)
|
| 14 |
-
[](https://www.python.org/)
|
| 15 |
-
[](https://www.codefactor.io/repository/github/teamultroid/ultroid/overview/main)
|
| 16 |
-
[](https://github.com/TeamUltroid/Ultroid/graphs/commit-activity)
|
| 17 |
-
[](https://img.shields.io/docker/pulls/theteamultroid/ultroid?style=flat-square)
|
| 18 |
-
[](https://github.com/TeamUltroid/Ultroid)
|
| 19 |
-
[](https://github.com/TeamUltroid/Ultroid/graphs/contributors)
|
| 20 |
-
[](https://makeapullrequest.com)
|
| 21 |
-
[](https://github.com/TeamUltroid/Ultroid/blob/main/LICENSE)
|
| 22 |
-
[](https://stars.medv.io/TeamUltroid/Ultroid)
|
| 23 |
-
----
|
| 24 |
-
|
| 25 |
-
# Deploy
|
| 26 |
-
- [Heroku](#deploy-to-heroku)
|
| 27 |
-
- [Okteto](#deploy-to-okteto)
|
| 28 |
-
- [Local Machine](#deploy-locally)
|
| 29 |
-
|
| 30 |
-
# Documentation
|
| 31 |
-
[](http://ultroid.tech/)
|
| 32 |
-
|
| 33 |
-
# Tutorial
|
| 34 |
-
- Full Tutorial - [](https://www.youtube.com/watch?v=0wAV7pUzhDQ)
|
| 35 |
-
|
| 36 |
-
- Tutorial to get Redis URL and password - [here.](./resources/extras/redistut.md)
|
| 37 |
-
---
|
| 38 |
-
|
| 39 |
-
## Deploy to Heroku
|
| 40 |
-
Get the [Necessary Variables](#Necessary-Variables) and then click the button below!
|
| 41 |
-
|
| 42 |
-
[](https://deploy.ultroid.tech)
|
| 43 |
-
|
| 44 |
-
## Deploy to Okteto
|
| 45 |
-
Get the [Necessary Variables](#Necessary-Variables) and then click the button below!
|
| 46 |
-
|
| 47 |
-
[](https://cloud.okteto.com/deploy?repository=https://github.com/TeamUltroid/Ultroid)
|
| 48 |
-
|
| 49 |
-
## Deploy Locally
|
| 50 |
-
- [Traditional Method](#local-deploy---traditional-method)
|
| 51 |
-
- [Easy Method](#local-deploy---easy-method)
|
| 52 |
-
- [Ultroid CLI](#ultroid-cli)
|
| 53 |
-
|
| 54 |
-
### Local Deploy - Easy Method
|
| 55 |
-
- Linux - `wget -O locals.py https://git.io/JY9UM && python3 locals.py`
|
| 56 |
-
- Windows - `cd desktop ; wget https://git.io/JY9UM -o locals.py ; python locals.py`
|
| 57 |
-
- Termux - `wget -O install-termux https://tiny.ultroid.tech/termux && bash install-termux`
|
| 58 |
-
|
| 59 |
-
### Local Deploy - Traditional Method
|
| 60 |
-
- Get your [Necessary Variables](#Necessary-Variables)
|
| 61 |
-
- Clone the repository:
|
| 62 |
-
`git clone https://github.com/TeamUltroid/Ultroid.git`
|
| 63 |
-
- Go to the cloned folder:
|
| 64 |
-
`cd Ultroid`
|
| 65 |
-
- Create a virtual env:
|
| 66 |
-
`virtualenv -p /usr/bin/python3 venv`
|
| 67 |
-
`. ./venv/bin/activate`
|
| 68 |
-
- Install the requirements:
|
| 69 |
-
`pip3 install -U -r re*/st*/optional-requirements.txt`
|
| 70 |
-
`pip3 install -U -r requirements.txt`
|
| 71 |
-
- Generate your `SESSION`:
|
| 72 |
-
- For Linux users:
|
| 73 |
-
`bash sessiongen`
|
| 74 |
-
or
|
| 75 |
-
`wget -O session.py https://git.io/JY9JI && python3 session.py`
|
| 76 |
-
- For Termux users:
|
| 77 |
-
`wget -O session.py https://git.io/JY9JI && python session.py`
|
| 78 |
-
- For Windows Users:
|
| 79 |
-
`cd desktop ; wget https://git.io/JY9JI -o ultroid.py ; python ultroid.py`
|
| 80 |
-
- Fill your details in a `.env` file, as given in [`.env.sample`](https://github.com/TeamUltroid/Ultroid/blob/main/.env.sample).
|
| 81 |
-
(You can either edit and rename the file or make a new file named `.env`.)
|
| 82 |
-
- Run the bot:
|
| 83 |
-
- Linux Users:
|
| 84 |
-
`bash startup`
|
| 85 |
-
- Windows Users:
|
| 86 |
-
`python(3) -m pyUltroid`
|
| 87 |
-
|
| 88 |
-
---
|
| 89 |
-
## Necessary Variables
|
| 90 |
-
- `SESSION` - SessionString for your accounts login session. Get it from [here](#Session-String)
|
| 91 |
-
|
| 92 |
-
One of the following database:
|
| 93 |
-
- For **Redis** (tutorial [here](./resources/extras/redistut.md))
|
| 94 |
-
- `REDIS_URI` - Redis endpoint URL, from [redislabs](http://redislabs.com/).
|
| 95 |
-
- `REDIS_PASSWORD` - Redis endpoint Password, from [redislabs](http://redislabs.com/).
|
| 96 |
-
- For **MONGODB**
|
| 97 |
-
- `MONGO_URI` - Get it from [mongodb](https://mongodb.com/atlas).
|
| 98 |
-
- For **SQLDB**
|
| 99 |
-
- `DATABASE_URL`- Get it from [elephantsql](https://elephantsql.com).
|
| 100 |
-
|
| 101 |
-
## Session String
|
| 102 |
-
Different ways to get your `SESSION`:
|
| 103 |
-
* [](https://replit.com/@TeamUltroid/UltroidStringSession)
|
| 104 |
-
* Linux : `wget -O session.py https://git.io/JY9JI && python3 session.py`
|
| 105 |
-
* PowerShell : `cd desktop ; wget https://git.io/JY9JI ; python ultroid.py`
|
| 106 |
-
* Termux : `wget -O session.py https://git.io/JY9JI && python session.py`
|
| 107 |
-
* TelegramBot : [@SessionGeneratorBot](https://t.me/SessionGeneratorBot)
|
| 108 |
-
|
| 109 |
-
---
|
| 110 |
-
|
| 111 |
-
# License
|
| 112 |
-
[](LICENSE)
|
| 113 |
-
Ultroid is licensed under [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html) v3 or later.
|
| 114 |
-
|
| 115 |
-
---
|
| 116 |
-
|
| 117 |
-
# Credits
|
| 118 |
-
* [](https://t.me/UltroidDevs)
|
| 119 |
-
* [Lonami](https://github.com/LonamiWebs/) for [Telethon.](https://github.com/LonamiWebs/Telethon)
|
| 120 |
-
* [MarshalX](https://github.com/MarshalX) for [PyTgCalls.](https://github.com/MarshalX/tgcalls)
|
| 121 |
-
|
| 122 |
-
> Made with 💕 by [@TeamUltroid](https://t.me/TeamUltroid).
|
|
|
|
| 1 |
+
test! all credits goes to ultroid .
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|