Drag commited on
Commit
7a1328c
·
1 Parent(s): 3a0fcde

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +1 -122
README.md CHANGED
@@ -1,122 +1 @@
1
- <p align="center">
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
- [![](https://img.shields.io/badge/Ultroid-v0.8-crimson)](#)
11
- [![Stars](https://img.shields.io/github/stars/TeamUltroid/Ultroid?style=flat-square&color=yellow)](https://github.com/TeamUltroid/Ultroid/stargazers)
12
- [![Forks](https://img.shields.io/github/forks/TeamUltroid/Ultroid?style=flat-square&color=orange)](https://github.com/TeamUltroid/Ultroid/fork)
13
- [![Size](https://img.shields.io/github/repo-size/TeamUltroid/Ultroid?style=flat-square&color=green)](https://github.com/TeamUltroid/Ultroid/)
14
- [![Python](https://img.shields.io/badge/Python-v3.10.3-blue)](https://www.python.org/)
15
- [![CodeFactor](https://www.codefactor.io/repository/github/teamultroid/ultroid/badge/main)](https://www.codefactor.io/repository/github/teamultroid/ultroid/overview/main)
16
- [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/TeamUltroid/Ultroid/graphs/commit-activity)
17
- [![Docker Pulls](https://img.shields.io/docker/pulls/theteamultroid/ultroid?style=flat-square)](https://img.shields.io/docker/pulls/theteamultroid/ultroid?style=flat-square)
18
- [![Open Source Love svg2](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/TeamUltroid/Ultroid)
19
- [![Contributors](https://img.shields.io/github/contributors/TeamUltroid/Ultroid?style=flat-square&color=green)](https://github.com/TeamUltroid/Ultroid/graphs/contributors)
20
- [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
21
- [![License](https://img.shields.io/badge/License-AGPL-blue)](https://github.com/TeamUltroid/Ultroid/blob/main/LICENSE)
22
- [![Sparkline](https://stars.medv.io/Teamultroid/Ultroid.svg)](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
- [![Documentation](https://img.shields.io/badge/Documentation-Ultroid-blue)](http://ultroid.tech/)
32
-
33
- # Tutorial
34
- - Full Tutorial - [![Full Tutorial](https://img.shields.io/badge/Watch%20Now-blue)](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
- [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://deploy.ultroid.tech)
43
-
44
- ## Deploy to Okteto
45
- Get the [Necessary Variables](#Necessary-Variables) and then click the button below!
46
-
47
- [![Develop on Okteto](https://okteto.com/develop-okteto.svg)](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
- * [![Run on Repl.it](https://replit.com/badge/github/TeamUltroid/Ultroid)](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](https://www.gnu.org/graphics/agplv3-155x51.png)](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
- * [![TeamUltroid-Devs](https://img.shields.io/static/v1?label=Teamultroid&message=devs&color=critical)](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 .