Skip to content

Latest commit

 

History

38 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VeloraBot

Telegram VPN Configuration Management Bot

Python-based Telegram bot for automated VPN configuration sales, user management, payments, referrals, service renewal, and configuration delivery.


Python 3X-UI Status


VeloraBot

Overview

VeloraBot is a Python-based Telegram bot designed to automate VPN configuration sales and management through the MHSanaei 3X-UI panel.

It provides an automated environment for selling and managing VPN configurations directly through Telegram, including user management, payments, referrals, configuration delivery, service renewal, logging, and optional AI-powered support.

The bot is designed to work specifically with MHSanaei 3X-UI and its API.


Features

Feature Description
Telegram Bot User and administrator management through Telegram
VPN Sales Sell and automatically deliver VPN configurations
3X-UI Integration Manage clients and configurations through MHSanaei 3X-UI
Service Renewal Allow users to renew existing VPN services
Payments Balance management, orders and receipt handling
Referrals Referral links and reward system
AI Support Optional Google Gemini integration
Logging Application and Telegram logging
Configuration Delivery Automated configuration and subscription delivery
User Management Manage users and their services
Local Data Storage JSON-based runtime data storage

3X-UI

VeloraBot is developed specifically for:

MHSanaei 3X-UI

https://github.com/MHSanaei/3x-ui

Other VPN management panels are not supported.

Compatibility with future 3X-UI releases is not guaranteed until tested.


Screenshots

Ai Support

VeloraBot User Interface

Admin Panel

VeloraBot Admin Panel

Requirements

Before installing VeloraBot, make sure your server has the following:

  • Linux server
  • Python 3.10+
  • Git
  • Telegram Bot Token
  • MHSanaei 3X-UI
  • 3X-UI API access

Installation

1. Clone the Repository

cd /opt
git clone https://github.com/navidmn56/VeloraBot.git
cd VeloraBot

2. Create a Virtual Environment

Install the required Python packages:

sudo apt update
sudo apt install -y python3-venv python3-pip

Create the virtual environment:

python3 -m venv .venv

Activate it:

source .venv/bin/activate

3. Install Dependencies

pip install -r requirements.txt

4. Configure the Bot

Open the configuration file:

nano config.py

Configure your Telegram bot, 3X-UI panel and other required settings.

5. Run the Bot

python main.py

systemd Service

For production environments, it is recommended to run VeloraBot as a systemd service.

Create the service file:

sudo nano /etc/systemd/system/velorabot.service

Add:

[Unit]
Description=VeloraBot
After=network-online.target
Wants=network-online.target

[Service]
Type=simple

User=root
WorkingDirectory=/opt/VeloraBot

ExecStart=/opt/VeloraBot/.venv/bin/python /opt/VeloraBot/main.py

Restart=always
RestartSec=5

Environment=PYTHONUNBUFFERED=1

[Install]
WantedBy=multi-user.target

Enable the Service

sudo systemctl daemon-reload
sudo systemctl enable velorabot
sudo systemctl start velorabot

Service Commands

Check the current status:

sudo systemctl status velorabot

Restart the bot:

sudo systemctl restart velorabot

Stop the bot:

sudo systemctl stop velorabot

View live logs:

sudo journalctl -u velorabot -f

Update

To update an existing installation:

cd /opt/VeloraBot
sudo systemctl stop velorabot

git pull origin main

source .venv/bin/activate
pip install -r requirements.txt

sudo systemctl restart velorabot

Versioning

VeloraBot uses semantic versioning.

Current release:

v1.1.0

The v1.1.0 release introduces the Service Renewal functionality.

Version format:

vMAJOR.MINOR.PATCH

For example:

v1.0.0
v1.1.0
v1.1.1
  • MAJOR — Breaking changes
  • MINOR — New features
  • PATCH — Bug fixes and small improvements

Project Structure

VeloraBot/
├── data/
│   └── .gitkeep
├── .gitignore
├── config.py
├── install.sh
├── logger_system.py
├── main.py
├── requirements.txt
└── test.py

Runtime files generated inside data/ are ignored by Git.


Data Storage

VeloraBot currently uses local JSON-based runtime storage.

Runtime data is stored inside:

data/

These files are intentionally excluded from Git through .gitignore.


Configuration

The main configuration file is:

config.py

Before starting the bot, make sure the required Telegram and 3X-UI settings are correctly configured.

Never commit private credentials, bot tokens, passwords, or other sensitive configuration values to the repository.


Compatibility

VeloraBot is currently designed for:

MHSanaei 3X-UI

The bot depends on the 3X-UI API and may require changes when future 3X-UI versions introduce API or structural changes.


Development Status

VeloraBot is actively developed.

New features, improvements and bug fixes may be added regularly.

The project may still contain bugs and unexpected behavior.


Contributing

Contributions, bug reports and feature suggestions are welcome.

If you find a bug or have an idea for improving VeloraBot, feel free to open an issue or submit a pull request.


Author


VeloraBot — Telegram VPN Configuration Management

About

A Python Telegram bot for VPN configuration sales, user management, payments, referrals, and AI-powered support.

Topics

Resources

Stars

15 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages