Skip to content

Latest commit

 

History

History
212 lines (154 loc) · 10 KB

README.md

File metadata and controls

212 lines (154 loc) · 10 KB

🌕 Moon-Userbot

Moon-Userbot

Open Source Love Maintenance CodeFactor DeepSource GitHub Forks GitHub Stars Last commit Size Contributors License PRs Welcome

A Simple, Fast, Customizable, Ai powered Userbot for Telegram made after Dragon-Userbot abandoned

Warning

The use of this Telegram Userbot is at your own risk, and you are solely responsible for any consequences that may arise from your use of this Userbot. The developer of this Userbot shall not be held liable for any damages or consequences that may occur as a result of your use of this software, whether such use is lawful, unlawful, or malicious. By using this Userbot, you acknowledge that you have read and understood this warning, and that you agree to comply with all applicable laws and regulations, and to use this software responsibly and ethically.

🤖 Ai powers

  • Gemini Pro Ai [ ✅ ]
    • Ask/Chat with Ai
    • Get details from image
    • Cooking instructions
    • Ai Marketer
  • Cohere Coral Ai [ ✅ ]
    • Ask/Chat with Ai
    • UP-TO Date Info
    • Site-Search Support
    • Chat History Support
  • ChatGPT 3.5 Turbo [ ✅ ]
    • Ask/Chat with Ai
  • SDXL [ ✅ ]
  • DALL-E 3 [ ✅ ]
  • Upscaling [✅]
  • Text to Image [✅]

🚀 Installation

🏕️ Necessary Vars

  • API_ID - Get it from my.telegram.org
  • API_HASH - Get it from my.telegram.org
  • PM_LIMIT - set your pm permit warn limit
  • DATABASE_URL - ONLY for MongoDB, your mongodb url
  • DATABASE_NAME - set to db.sqlite3 if want to use sqlite3 db else leave blank
  • DATABASE_TYPE - set to sqlite3 if want to use sqlite3 db else leave blank

⛺ Optional Vars

  • STRINGSESSION
    • only If you want to use on cloud hosts use string_gen.py to generate OR Run on Repl.it

Important

STRINGSESSION is necessary for deployment through Docker/Cloud Host etc.

  • APIFLASH_KEY - ONLY, If you want to use web screnshot plugin You can get it from here

  • RMBG_KEY - ONLY, If you want to use removbg plugin You can get it from here

  • VT_KEY - ONLY, If you want to use VirusTotal plugin You can get it from here

  • GEMINI_KEY - ONLY, If you want to use gemini ai plugin You can get it from here

  • COHERE_KEY - ONLY, If you want to use cohere ai plugin You can get it from here

  • VCA_API_KEY - ONLY, If you want to use ai tools like sdxl,upscale plugin You can get it from here

☁️ Cloud Host

Koyeb Heroku Render
Deploy To Koyeb Deploy To Heroku Deploy to Render

🐳 Docker

You can either use docker run or docker compose.

Prerequisites

  • Docker
  • Docker Compose (version 1.x for docker-compose.yml, version 2.x for compose.yml)
  • Put your environment vars in .env file check .env.dist for example format

👷‍♂️docker run:

  • Start:
    docker run --env-file ./.env -d qbtaumai/moonuserbot:latest
  • Updating:
    docker stop $(docker ps -q) && docker rm $(docker ps -a -q)
    then re-run the start command

🍟 docker compose [recommended]:

Docker Compose V1 (docker-compose.yml):

If you're using Docker Compose version 1.x, use the following commands to start and update the service:

  • Start:
    docker-compose -f docker-compose.yml up -d
  • Updating & running:
    docker-compose -f docker-compose.yml down && docker-compose -f docker-compose.yml pull && docker-compose -f docker-compose.yml up -d

Docker Compose V2 (compose.yml):

If you're using Docker Compose version 2.x, use the following commands to start and update the service:

  • Start:
    docker compose -f compose.yml up -d
  • Updating & running:
    docker compose -f compose.yml down && docker compose -f compose.yml pull && docker compose -f compose.yml up -d

Important

Make Sure you add appropriate env vars

🖥️ Local Host

Linux, Windows [only wsl]

Update the packages

sudo apt update && sudo apt upgrade -y

Install Git

Tip

Ignore if already installed

sudo apt install git

Clone the repo

git clone https://github.com/The-MoonTg-project/Moon-Userbot.git

Setup

cd Moon-Userbot/ && sudo bash install.sh

📱 Termux

Tip

use GitHub version


Full Installation instruction Given here

Note

If you choose MongoDB for your cloud then you need to setup mongo_db_url**

Recommended: sqlite

🐩 Contributions

Contributions of any type are welcome like custom_modules etc. Feel free to do pull-request's with your changes!

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

👨🏻‍💻 Support

👨🏻‍💼 Credits

Disclaimer

Warning

The use of this Telegram Userbot is entirely at your own risk. The developer of this Userbot is not responsible for any misuse, damage, or legal consequences that may arise from your use of this software.

It is your responsibility to ensure that you use this Userbot in accordance with all applicable laws and regulations, and that you do not engage in any activities that may cause harm to others or violate their privacy. This includes, but is not limited to, the use of this Userbot to send spam, harass others, or engage in any other form of unlawful or malicious activity. The developer of this Userbot does not endorse or condone any such activities, and any such use of this software is strictly prohibited. By using this Userbot, you acknowledge that you are solely responsible for your own actions and that the developer of this Userbot shall not be held liable for any damages or consequences that may arise from your use of this software. It is your responsibility to ensure that you have obtained all necessary permissions and consents before using this Userbot to interact with others, and that you respect their privacy and rights. The developer of this Userbot shall not be held liable for any breach of privacy or rights that may occur as a result of your use of this software.

Licence

                    GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007

  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.

                             Preamble

   The GNU General Public License is a free, copyleft license for
 software and other kinds of works.