├── .github └── workflows │ └── update.yml ├── README.md ├── VCBot └── vcguide.md ├── contributing ├── plugins.md └── translate.md ├── guides └── index.md ├── installation ├── heroku.md └── local.md ├── pyUltroid └── pyUltroid.md ├── ultroid ├── intro.md ├── languages.md └── modes.md └── variables ├── env_variables.md └── redis_vars.md /.github/workflows/update.yml: -------------------------------------------------------------------------------- 1 | name: "Update Main Repo" 2 | 3 | on: 4 | push: 5 | branches: [master] 6 | workflow_dispatch: 7 | 8 | env: 9 | GitHubMail: "newdev0@outlook.com" 10 | GitHubName: "New-dev0" 11 | 12 | jobs: 13 | build: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Checkout 17 | uses: actions/checkout@v2 18 | - name: "Set Git Configs & Secrets" 19 | run: | 20 | git config --global user.email ${GitHubMail} 21 | git config --global user.name ${GitHubName} 22 | git config --global credential.helper store 23 | echo "https://${GitHubName}:${{ secrets.GH_TOKEN }}@github.com" > ~/.git-credentials 24 | - name: "cloning repo" 25 | continue-on-error: true 26 | run: | 27 | git clone https://github.com/TeamUltroid/Ultroid-docs from-repo 28 | git clone https://github.com/TeamUltroid/TeamUltroid.github.io to-repo 29 | rm -rf from-repo/.git* 30 | rm -rf to-repo/docs/* 31 | rm -rf from-repo/README.md 32 | mv from-repo/* to-repo/docs/ 33 | cd to-repo 34 | git add . 35 | git commit -m "Auto: Update Repo" 36 | git push -q https://${{ secrets.GH_TOKEN }}@github.com/TeamUltroid/TeamUltroid.github.io HEAD:main 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Ultroid Documention 2 | - Ultroid-Docs are hosted at [ultroid.tech](https://ultroid.tech) 3 | - Ultroid Source Code is available at [TeamUltroid/Ultroid](https://GitHub.com/TeamUltroid/Ultroid) 4 | 5 | Archived 6 | - Please refer [TeamUltroid/teamultroid.github.io](https://github.com/TeamUltroid/teamultroid.github.io) repository for current docs. 7 | 8 | # [![Website](https://img.shields.io/website?down_color=red&down_message=Down&label=ultroid.tech%20%20%20%20%20&up_message=Online&url=https%3A%2F%2Fultroid.tech) ![GitHub labels](https://img.shields.io/github/labels/TeamUltroid/Ultroid-Docs/Help%20Wanted?color=black) ![GitHub forks](https://img.shields.io/github/forks/TeamUltroid/Ultroid-Docs)](#) 9 | 10 | ### - Status 11 | [![Netlify Status](https://api.netlify.com/api/v1/badges/e29a7c4e-9f10-4a20-87e1-faac9ce15865/deploy-status)](https://app.netlify.com/sites/ultroid/deploys) 12 | 13 | ### - Key Features to Include 14 | - About Ultroid and Deployment. 15 | - List of available feature in Ultroid. 16 | - Detail about setup and available variables. 17 | - Make things easier to understand. 18 | 19 | ### - Contributing 20 | - Fork this repository. [[Read how to fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)] 21 | - Now, you can do your relevant changes. 22 | - Create a pull request to this repo. [[Creating a Pull Request](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request#creating-a-pull-request)] 23 | 24 | ### [TeamUltroid](https://t.me/TeamUltroid) 25 | -------------------------------------------------------------------------------- /VCBot/vcguide.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: vcguide 3 | title: VC Bot 4 | sidebar: VC Bot 5 | slug: /vcbot 6 | --- 7 | 8 | --- 9 | [![Vc](https://telegra.ph/file/69a40c03714e4e4ffc752.jpg)](https://github.com/TeamUltroid) 10 | 11 | From the addition of Vc in Telegram, along with the time Ultroid have evolved many times, changing the Library used and programming language. 12 | This page contain present information about setting up Vc with Ultroid. 13 | 14 | ## TgCalls 15 | 16 | > Ultroid is using [Tgcalls](https://github.com/MarshalX/Tgcalls) Library for Voice/Video calls. It uses codes of Official Telegram tgcalls library which is in C++. 17 | 18 | ## VcBot 19 | 20 | ### Setting up 21 | 22 | - You need to do `.setdb VCBOT True` (in order to enable VcBOT.) 23 | - Now Restart your Bot. 24 | 25 | ### About `VC_SESSION` 26 | 27 | `VC_SESSION` is Database key used for storing String Session of another account which should be used for Vc Purpose. If not present, User's account will be used. 28 | 29 | ### Adding `VC_SESSION` 30 | 31 | To Add `VC_SESSION`, First Go to ur Assistant Bot 32 | 33 | - Send: `/start` 34 | - Click: `Settings` >> `VC Song Bot` >> `VC Session` 35 | - Send: VC Session (2nd Account) 36 | - Restart your bot using `.restart`. 37 | 38 | :::info 39 | Shortcut : 40 | 41 | - `.setdb VC_SESSION ` 42 | - Restart your bot using `.restart`. 43 | - Done Your `VC_SESSION` is added 😉. 44 | 45 | ::: 46 | 47 | 48 | :::note 49 | 50 | Your VC Session should be of Another ID else you won't be able to hear from same account. 51 | 52 | ::: 53 | 54 | #### Knowing **VcBot Commands** 55 | 56 | You can know VcBot Commands through two ways (after setting up VcBot). 57 | 58 | - Send `.help` -> `VcBot` -> `Explore plugins`. 59 | - Send `.vchelp` to your Vc Account. 60 | 61 | --- -------------------------------------------------------------------------------- /contributing/plugins.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: userplugins 3 | title: sharing self plugins. 4 | sidebar_label: plugins 5 | slug: /plugins 6 | --- 7 | 8 | ### If you have made any Good Plugin for Ultroid? and want to make it used by all? 9 | You can Give Your Plugins to Us by Following Ways.. 10 | 11 | ### [@UltroidPlugins](https://t.me/UltroidPlugins) 12 | - You can Send Your Plugin File at [@UltroidSupportChat](https://t.me/ultroidsupportchat) or [@UltroidSpam](https://t.me/UltroidSpam). 13 | - Tag any of Admin and wait for it to get listed at [@UltroidPlugins](https://t.me/ultroidplugins). 14 | - INFO : `@UltroidPlugins is used as official PLUGIN_CHANNEL` 15 | 16 | ### Contributing to Addons Repo. 17 | - You can Contribute your Plugins to [Addons Repo](https://github.com/TeamUltroid/UltroidAddons). 18 | - Plugin are Loaded From that, on Redis Var `ADDONS`. 19 | -------------------------------------------------------------------------------- /contributing/translate.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: translate 3 | title: Translate Ultroid to your native language 4 | sidebar_label: Translating 5 | slug: /translate 6 | --- 7 | 8 | You can help in translating Ultroid into your native language! 9 | 10 | ### Crowdin 11 | - You can help translate Ultroid in Crowdin Platform. 12 | - URL : [crowdin@Ultroid](https://crowdin.com/project/Ultroid) 13 | 14 | - Note: 15 | ```If your language isn't listed on that list, you can follow Github way..``` 16 | 17 | 18 | ### Directly on Github 19 | - You can download [en.yml](https://github.com/TeamUltroid/Ultroid/blob/dev/strings/strings/en.yml) file from Github Repository. 20 | - You can translate it to any language you want. 21 | - File should be named in format : `langcode.yml` 22 | - Now, You can make a [Pull Request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the Official Github Repo. 23 | -------------------------------------------------------------------------------- /guides/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: index 3 | title: Guides 4 | sidebar: Guides 5 | slug: /guides 6 | --- 7 | 8 | --- 9 | 10 | ### How to Enable/Disable `PM Permit` ? 11 | 12 | To Enable PM Permit, go to your Assistant bot (the bot you Made from botfather and using in ultroid). 13 | - Send: `/start` 14 | - Click: `Settings` >> `Other Vars` >> `PM Permit` >> `Turn PMPermit On` 15 | 16 | You can also disable PMPermit by clicking on `Turn PMPermit Off` 17 | 18 | --- 19 | 20 | ### How to Customize `PM Permit` ? 21 | 22 | To customize PM Permit message/media, go to your Assistant bot. 23 | - Send: `/start` 24 | - Click: `Settings` >> `PM Customization` 25 | 26 | You can customize from Here 27 | 28 | --- 29 | 30 | ### How to Customize `ALIVE` message? 31 | 32 | To customize `alive`, go to your Assistant bot (the bot you Made from botfather and using in ultroid) . 33 | - Send: `/start` 34 | - Click: `Settings` >> `Alive Customization` 35 | 36 | From here you can delete media/update media/update text. 37 | 38 | --- 39 | 40 | ### How To Setup `PMLOGGER`? 41 | 42 | To setup `PMLOGGER`, go to your Assistant bot. 43 | - Send: `/start` 44 | - Click: `Settings` >> `PmPermit` >> `Customize PmPermit` >> `PMLOGGER` >> `PMLOGGER ON/OFF` 45 | 46 | :::info 47 | Shortcut: 48 | - `.setdb PMLOGGER True/False` 49 | ::: 50 | 51 | • Done Your PMLOGGER is set 😉 52 | 53 | --- 54 | 55 | ### How To Setup `RMBG_API`? 56 | 57 | This is API for Removing Background through Ultroid, Steps are as Follows: 58 | To setup `RMBG_API`, go to your Asistant bot. 59 | - Send: `/start` 60 | - Click: `Settings` >> `API Keys` >> `Remove.bg API` 61 | - Send: `API` 62 | 63 | - Get Your API 👉 [From Here](https://remove.bg/api) 64 | 65 | :::info 66 | Shortcut: 67 | - `.setdb RMBG_API ` 68 | ::: 69 | 70 | • Done Your `Remove.bg API` is set 😉 71 | 72 | --- 73 | 74 | ### How to Change Inline Help Menu Media? 75 | 76 | To Change `INLINE_PIC`, go to your Assistant bot. 77 | - Send: `/start` 78 | - Click: `Settings` >> `Features` >> `Inline Pic` 79 | - Send: Media (GIF/PIC) 80 | 81 | :::info 82 | Shortcut: 83 | - `.setdb INLINE_PIC ` 84 | ::: 85 | 86 | • Done Your `INLINE_PIC` is set 😉 87 | 88 | :::note 89 | You can set `INLINE_PIC` to `False` to remove media in help menu. 90 | ::: 91 | 92 | --- 93 | 94 | ### How to Change `Command Handler`? 95 | 96 | HNDLR is the Symbol which is Trigger/Suffix of your bot, like `.` 97 | 98 | To Change `HNDLR`, go to your Assistant bot. 99 | - Send: `/start` 100 | - Click: `Settings` >> `Features` >> `HANDLER` 101 | - Send: `Handler (Symbol)` 102 | 103 | :::info 104 | Shortcut: 105 | - `.setdb HNDLR ` 106 | ::: 107 | --- 108 | -------------------------------------------------------------------------------- /installation/heroku.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: heroku 3 | title: Deploy to Heroku 4 | sidebar_label: Heroku 5 | --- 6 | --- 7 | Deploying Ultroid in Heroku is the Easiest way to run Ultroid, to get started you will need a heroku account . [Sign Up](https://signup.heroku.com/) if you don't have one . 8 | 9 | :::note 10 | 11 | Free account will do the work , While signing up don't worry about `Role` or `Primary development language` in signup form. It doesn't matter 12 | 13 | ::: 14 | 15 | --- 16 | 17 | ## Using Deploy Button 18 | 19 | If you have a heroku account by now then click the below button to Start deploying 20 | 21 | [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://deploy.ultroid.tech) 22 | 23 | Now you will be asked for environment variables . [Click here](/docs/variables/env_variables) know more. 24 | -------------------------------------------------------------------------------- /installation/local.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: local_deploy 3 | title: Local Deploying 4 | sidebar_label: Local Deploy 5 | --- 6 | --- 7 | Ultroid can be deployed anywhere! 8 | 9 | :::tip 10 | Using a VPS is recommended, as running it on a laptop/phone would require it to be switched on 24/7 11 | ::: 12 | 13 | ## Steps 14 | 15 | * Step 1 : Cloning the repository. 16 | `git clone https://github.com/TeamUltroid/Ultroid.git && cd Ultroid` 17 | 18 | * Step 2 : Creating a virtual environment to run the bot. 19 | `virtualenv -p /usr/bin/python3 venv` or `python3 -m venv venv` 20 | `. ./venv/bin/activate` 21 | 22 | * Step 3 : Installing the requirements. 23 | `pip install -U -r requirements.txt` 24 | and 25 | `pip install -U -r resources/startup/optional-requirements.txt` 26 | 27 | :::note 28 | pip3 can also be used, depending upon which version you are having. 29 | ::: 30 | 31 | * Step 4 : Get the required variable values. 32 | Learn more about getting the `API_ID`, `API_HASH` and `SESSION` [here](/docs/variables/env_variables). 33 | 34 | * Step 5 : Creating a `.env` file and filling your vars. 35 | Go to the [`.env.sample`](https://github.com/TeamUltroid/ultroid/blob/main/.env.sample) file. Copy the contents into a text editor. 36 | Now edit it and fill in your values. 37 | Read More [on how to get all variables](/docs/variables/env_variables). 38 | Now open a terminal, make sure you are in the cloned repository directory. 39 | `touch .env` 40 | `nano.env` 41 | This will open up a text editor within the terminal. 42 | Now paste the edited file (from the text edior), here. 43 | `CTRL + S` 44 | `CTRL + X` 45 | 46 | * Step 6 : Run the bot. 47 | Use `bash startup` to start the bot. 48 | You will recieve a message in your `LOG_CHANNEL` if everything is done right! 49 | 50 | :::note 51 | Use `python3 -m pyUltroid`, if you had used `pip3` before. 52 | You can also use `bash startup` to run Ultroid. 53 | ::: 54 | -------------------------------------------------------------------------------- /pyUltroid/pyUltroid.md: -------------------------------------------------------------------------------- 1 | # py-Ultroid Library 2 | 3 | Core library of [The Ultroid](https://github.com/TeamUltroid/pyUltroid), a python based telegram userbot. 4 | 5 | [![CodeFactor](https://www.codefactor.io/repository/github/teamultroid/pyultroid/badge)](https://www.codefactor.io/repository/github/teamultroid/pyultroid) 6 | [![PyPI - Version](https://img.shields.io/pypi/v/py-Ultroid?style=round)](https://pypi.org/project/py-Ultroid) 7 | [![PyPI - Downloads](https://img.shields.io/pypi/dm/py-Ultroid?label=DOWNLOADS&style=round)](https://pypi.org/project/py-Ultroid) 8 | [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/TeamUltroid/Ultroid/graphs/commit-activity) 9 | [![Open Source Love svg2](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/TeamUltroid/Ultroid) 10 | [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) 11 | 12 | # Installation 13 | ```bash 14 | pip3 install -U py-Ultroid 15 | ``` 16 | 17 | # Documentation 18 | [![Documentation](https://img.shields.io/badge/Documentation-Ultroid-blue)](https://ultroid.tech/) 19 | 20 | # Usage 21 | - Create folders named `plugins`, `addons`, `assistant` and `resources`. 22 | - Add your plugins in the `plugins` folder and others accordingly. 23 | - Create a `.env` file with following mandatory Environment Variables 24 | ``` 25 | API_ID 26 | API_HASH 27 | SESSION 28 | REDIS_URI 29 | REDIS_PASSWORD 30 | ``` 31 | - Check 32 | [`.env.sample`](https://github.com/TeamUltroid/Ultroid/blob/main/.env.sample) for more details. 33 | - Run `python3 -m pyUltroid` to start the bot. 34 | 35 | ## Creating plugins 36 | - ### To work everywhere 37 | 38 | ```python 39 | @ultroid_cmd( 40 | pattern="start" 41 | ) 42 | async def _(e): 43 | await eor(e, "Ultroid Started.") 44 | ``` 45 | 46 | - ### To work only in groups 47 | 48 | ```python 49 | @ultroid_cmd( 50 | pattern="start", 51 | groups_only=True, 52 | ) 53 | async def _(e): 54 | await eor(e, "Ultroid Started.") 55 | ``` 56 | 57 | - ### Assistant Plugins 👇 58 | 59 | ```python 60 | @asst_cmd("start") 61 | async def _(e): 62 | await e.reply("Ultroid Started.") 63 | ``` 64 | 65 | See more working plugins on [the offical repository](https://github.com/TeamUltroid/Ultroid)! 66 | 67 | > Made with 💕 by [@TeamUltroid](https://t.me/TeamUltroid). 68 | 69 | 70 | # License 71 | [![License](https://www.gnu.org/graphics/agplv3-155x51.png)](https://github.com/TeamUltroid/pyUltroid/blob/main/LICENSE) 72 | Ultroid is licensed under [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html) v3 or later. 73 | 74 | # Credits 75 | * [![TeamUltroid-Devs](https://img.shields.io/static/v1?label=TeamUltroid&message=devs&color=critical)](https://t.me/UltroidDevs) 76 | * [Lonami](https://github.com/Lonami) for [Telethon](https://github.com/LonamiWebs/Telethon) -------------------------------------------------------------------------------- /ultroid/intro.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: intro 3 | title: Ultroid 4 | sidebar_label: Introduction 5 | slug: / 6 | --- 7 | 8 | Ultroid is a pluggable telegram userbot, made in python using Telethon! 9 | 10 | # Why Ultroid ? 11 | --- 12 | ### 1. Built From Scratch 13 | 14 | Ultroid has been written from scratch, making it more stable and less of crashes. 15 | 16 | ### 2. Better Error Handling 17 | 18 | Error handling been done in the best way possible, such that the bot doesn't crash and stop all of a sudden. 19 | 20 | ### 3. Lightweight 21 | 22 | Ultroid has minimal amount of plugins (just the necessary ones) in the main repository, and all the other less-usefull stuff in the addons repository. This facilitates quick deployments and lag free use. 23 | 24 | ### 4. Install any plugin 25 | 26 | Ultroid can install any plugin from the most of the other 'userbots' without any issue. 27 | 28 | ### 5. Safety First 29 | 30 | Ultroid warns you when you try to install/execute dangerous stuff (people nowadays make plugins to hack user accounts, Ultroid is safe) 31 | 32 | ### 6. Multi-Language Support 33 | 34 | Currently We Have 22 Language Support, More will be added Soon 😁. 35 | 36 | ### 7. Many Cool Features 37 | 38 | ### 8. py-Ultroid 39 | 40 | We have managed to pack the core into a pip package, Check it out [`py-Ultroid`](https://pypi.org/project/py-Ultroid/). 41 | 42 | -------------------------------------------------------------------------------- /ultroid/languages.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: languages 3 | title: Setting up Language 4 | sidebar_label: Languages 5 | slug: /languages 6 | --- 7 | 8 | ### Ultroid Supports Multiple Language. 9 | 10 | 11 | | Name | Langauge Code | 12 | |------|---------------| 13 | | Arabic | `ar`| 14 | | Azerbaijani | `az` | 15 | | Bengali | `bn` | 16 | | Brazilian Portuguese | `pt|br` | 17 | | Chinese | `cn` | 18 | | English | `en` (default) | 19 | | Gujarati | `gu`| 20 | | Hindi | `hi`| 21 | | Indonesian | `id` | 22 | | Italian | `it` | 23 | | Japenese | `jp`| 24 | | Kannada | `ka` | 25 | | Malay |`my`| 26 | | Malayalam | `ml` | 27 | | Marathi | `mr` | 28 | | Odia | `od` | 29 | | Persian | `fa`| 30 | | Russian | `ru`| 31 | | Sinhala | `si`| 32 | | Spanish | `es`| 33 | | Tamil | `ta`| 34 | | Turkish | `tr`| 35 | 36 |
37 | 38 | ## Setting Up Langauge 39 | ### Via Assistant Bot 40 | - Send `/start` to your assistant bot. 41 | ![](https://telegra.ph/file/5b85534f6a45ad1112590.jpg) 42 | - Click `Languages` Button. 43 | - Select your desired Language. 44 | - Done! 45 | 46 | ### Via Command 47 | - Check Language code in table above. 48 | - Do `.setdb language lang_code` to set your language. 49 | - Now `restart` your bot. 50 | - Done 51 | 52 | ## Contributing 53 | - Want to add your language or do any fixes ? 54 | - >.[Click Here](/docs/translate) -------------------------------------------------------------------------------- /ultroid/modes.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: modes 3 | title: Modes in Ultroid 4 | sidebar_label: About Modes 5 | slug: /modes 6 | --- 7 | 8 | ### Dual Mode 9 | - Dual Mode, enables you to use your assistant bot same as your UserBot. 10 | - Your Assistant bot and Userbot will both take your commands and will work similarly.. 11 | 12 | - To Enable Dual Mode : ```.setdb DUAL_MODE True``` 13 | 14 | - #### About DUAL_HNDLR 15 | - You can Customise the Assistant Handler of Dual Mode. 16 | - By : ```.setdb DUAL_HNDLR ``` 17 | - Default Value : `/` 18 | 19 | ### Manager 20 | - After setting this, you can use your Assistant bot as Group Management Bot. 21 | 22 | - To Set this : ```.setdb MANAGER True``` 23 | - After Adding Redis Var, Restart Your Bot.. 24 | 25 | :::info 26 | 27 | - After setting this, send "/help" to your assistant bot to know about Manager Commands. 28 | ::: -------------------------------------------------------------------------------- /variables/env_variables.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: env_variables 3 | title: Environmental Variables to run Ultroid. 4 | sidebar_label: ENV Variables 5 | --- 6 | Ultroid needs five mandatory variables to run 7 | 8 | - `API_ID` 9 | - `API_HASH` 10 | - `SESSION` 11 | - `REDIS_URI` 12 | - `REDIS_PASSWORD` 13 | 14 | 15 | ### Obtaining API_ID & API_HASH 16 | 17 | 1. Visit [my.telegram.org](https://my.telegram.org) 18 | 2. Enter your phone number in [international format](https://telegram.org/faq#login-and-sms). Example : `+9199966XXXXX` 19 | 3. Enter the web login code sent to you by Telegram in app. 20 | 4. After successful sign in , Click on `API development tools` 21 | 5. Fill `App Title` & `Short name` and create app. 22 | 23 | ![app_id_and_short_code](https://telegra.ph/file/375ec338bc92a1119d390.jpg) 24 | 25 | 6. Yay, you got your `API_ID` & `API_HASH` 26 | 27 | ![api_id_and_api_hash](https://telegra.ph/file/6e1c7b54d547b2dc7419a.jpg) 28 | 29 | Or Use can use [@apiscrapperbot](https://t.me/apiscrapperbot). (running on free servers.) 30 | 31 | ### Obtaining SESSION 32 | 33 | There are below ways by which you can get your SESSION. 34 | 35 | 1. Via terminal. 36 | `(. <($(which curl>/dev/null&&echo curl -Ls||echo wget -qO-) https://del.dog/ultroid))` 37 | Now follow the on-screen instructions. 38 | 39 | 2. Via termux. 40 | `sh -c "$(curl -fsSL https://git.io/JqgsR)"` 41 | 42 | 3. Via [Repl.it](https://repl.it/@TeamUltroid/UltroidStringSession#main.py) 43 | 44 | 4. Via Telegram Bot. 45 | Use [@SessionGeneratorBot](https://t.me/SessionGeneratorBot). 46 | 47 | 5. For the ones who deployed locally. 48 | `bash sessiongen` 49 | 50 | ### Obtaining REDIS Info 51 | 52 | Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache, and message broker. 53 | 54 | You can get a free REDIS db from [redislabs.com](https://redislabs.com) 55 | 56 | - Login/Register a free account in [RedisLabs](https://redislabs.com) 57 | - Create a new Database 58 | - Choose Free Subscription 59 | - Give Database a name, Change password and Save 60 | 61 | Go to the Configuration 62 | 63 | ![redis_db](https://telegra.ph/file/d4ede025f65fa97957f66.png) 64 | 65 | - The Endpoint is your `REDIS_URI` 66 | - `REDIS_PASSWORD` is the Pasword you gave , you can check it again by clicking on eye button 67 | 68 | [YouTube Redis Tutorial](http://youtu.be/jpUdcH9cjIo) 69 | 70 | 71 | ## Mandatory Vars for Heroku Users : 72 | 73 | - `HEROKU_APP_NAME` 74 | - `HEROKU_API` 75 | 76 | ### HEROKU_API & HEROKU_APP_NAME 77 | 78 | `HEROKU_API` & `HEROKU_APP_NAME` is required so that you can update/restart Ultroid or check dyno usage wasily with Ultroid 79 | 80 | * __HEROKU_API :__ Sign in to your Heroku Account and go to [Account Settings](https://dashboard.heroku.com/account) , Scroll down and you will find your API Key 81 | * __HEROKU_APP_NAME :__ The app name you gave while deploying Ultroid 82 | 83 | -------------------------------------------------------------------------------- /variables/redis_vars.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: redis_vars 3 | title: Redis Variables used By Ultroid 4 | sidebar_label: Redis Variables 5 | --- 6 | 7 | Ultroid stores most of the Variables in Redis database. You can play with Redis DB with the redis plugin available in Ultroid Plugins. 8 | 9 | 10 | ### ALIVE_PIC 11 | - This Variable used to store `alive` message media , You can set `direct url` or `bot file api id` 12 | 13 | ### ALIVE_TEXT 14 | - Stores text to show in `alive` command 15 | 16 | ### AUTOAPPROVE 17 | 18 | - Value Type : `Boolean` 19 | - If `AUTOAPPROVE` is set to `True` then it will automatically approve users in PM if you send any msg to user . Else if set `False` , you need to approve user manually 20 | 21 | ### BOT_USERS 22 | 23 | - List of users who sent `/start` your assitant bot 24 | 25 | ### BROADCAST 26 | 27 | - List of chats for broadcast feature 28 | 29 | ### EMOJI_IN_HELP 30 | 31 | - In the inline help menu, every button text is wrapped inside an emoji . To change the default one , set this variable with your desired Emoji/Text/ASCII Icon. 32 | 33 | ### HNDLR 34 | 35 | - Default : `.` 36 | 37 | - You can change command handler prefix using this variable. 38 | 39 | ### I_DEV 40 | 41 | - By default Ultroid users can't use commands like `bash` & `eval` . If you wan't to use these commands then set value `True` 42 | 43 | ### OWNER 44 | 45 | - Stores Ultroid users telegram user id 46 | 47 | ### PMSETTING 48 | 49 | - Default : `False` 50 | 51 | - This variable is used to toggle `PMPERMIT` . PM PERMIT is on when value is set to `True` 52 | 53 | ### PMPIC 54 | 55 | - You can customize PM Permit default media using this variable . You can store direct links or file id to customize media. 56 | 57 | ### PMPERMIT 58 | 59 | - It stores the list of approved users of PM Permit 60 | 61 | ### INLINE_PM 62 | 63 | - Default : `True` 64 | 65 | - Whether PmPermit should be send by Inline. Set to `False` to use Static One. 66 | 67 | ### RMBG_API 68 | 69 | - Stores API key of remove.bg 70 | 71 | ### SUDO_HNDLR 72 | - Default : `same as UserBot HNDLR` 73 | - Handler for Sudo Users. 74 | 75 | ### SUDOS 76 | 77 | - This variable stores the list of SUDO User's ids 78 | 79 | ### VC_SUDOS 80 | 81 | - Used to store User with Vc Access, for VC Bot 82 | 83 | ### VC_SESSION 84 | 85 | - Stores the Telethon `session` of the VC Bot. If not set, UserBot account will be used for Vc. 86 | 87 | ### language 88 | 89 | Stores the default language for Ultroid. 90 | --------------------------------------------------------------------------------