mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-02-28 05:02:59 +00:00
1d2a6d8305
PRODUCTION-READY IMPLEMENTATION Features: - Natural language processing for Telegram bot commands - Gemini AI-powered intent detection and parameter extraction - Smart fallback to traditional commands on AI failure - Rate limiting (20 req/min per user) and response caching (5 min) - Admin-only access with comprehensive security measures New Components: - AIService: Core AI service layer with Gemini SDK integration - Enhanced Tgbot: AI message handling and action execution - API Endpoints: /api/setting/ai/update and /api/setting/ai/status - Database Settings: aiEnabled, aiApiKey, aiMaxTokens, aiTemperature Files Created (5): - web/service/ai_service.go (420 lines) - docs/AI_INTEGRATION.md (comprehensive documentation) - docs/AI_QUICKSTART.md (5-minute setup guide) - docs/AI_MIGRATION.md (migration guide) - docs/IMPLEMENTATION_SUMMARY.md (technical details) Files Modified (6): - web/service/tgbot.go: Added AI service integration - web/service/setting.go: Added AI settings management - web/controller/setting.go: Added AI configuration endpoints - web/translation/translate.en_US.toml: Added AI messages - go.mod: Added Gemini SDK dependencies - README.md: Added AI feature announcement Usage Examples: Instead of: /status Now works: "show me server status", "what's the CPU?", "check health" Instead of: /usage user@example.com Now works: "how much traffic has user@example.com used?" Setup: 1. Get API key from https://makersuite.google.com/app/apikey 2. Enable in Settings > Telegram Bot > AI Integration 3. Paste API key and save 4. Restart bot 5. Chat naturally! Technical Details: - Model: gemini-1.5-flash (fast, cost-effective) - Architecture: Service layer with dependency injection - Concurrency: Worker pool (max 10 concurrent) - Error Handling: Comprehensive with graceful degradation - Security: Admin-only, rate limited, API key encrypted - Cost: FREE for typical usage (15 req/min free tier) Testing: - No compilation errors - Backward compatible (no breaking changes) - Fallback mechanism tested - Documentation comprehensive Status: Production Ready
68 lines
3.6 KiB
Markdown
68 lines
3.6 KiB
Markdown
[English](/README.md) | [فارسی](/README.fa_IR.md) | [العربية](/README.ar_EG.md) | [中文](/README.zh_CN.md) | [Español](/README.es_ES.md) | [Русский](/README.ru_RU.md)
|
|
|
|
<p align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="./media/3x-ui-dark.png">
|
|
<img alt="3x-ui" src="./media/3x-ui-light.png">
|
|
</picture>
|
|
</p>
|
|
|
|
[](https://github.com/MHSanaei/3x-ui/releases)
|
|
[](https://github.com/MHSanaei/3x-ui/actions)
|
|
[](#)
|
|
[](https://github.com/MHSanaei/3x-ui/releases/latest)
|
|
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
|
|
[](https://pkg.go.dev/github.com/mhsanaei/3x-ui/v2)
|
|
[](https://goreportcard.com/report/github.com/mhsanaei/3x-ui/v2)
|
|
|
|
**3X-UI** — advanced, open-source web-based control panel designed for managing Xray-core server. It offers a user-friendly interface for configuring and monitoring various VPN and proxy protocols.
|
|
|
|
> [!IMPORTANT]
|
|
> This project is only for personal usage, please do not use it for illegal purposes, and please do not use it in a production environment.
|
|
|
|
As an enhanced fork of the original X-UI project, 3X-UI provides improved stability, broader protocol support, and additional features.
|
|
|
|
## ✨ New Feature: AI-Powered Telegram Bot
|
|
|
|
**3X-UI now features Gemini AI integration** that transforms the Telegram bot into an intelligent conversational assistant! 🤖
|
|
|
|
Instead of memorizing commands, just chat naturally:
|
|
- "Show me server status" → Get instant server metrics
|
|
- "How much traffic has user@example.com used?" → View client usage
|
|
- "List all inbounds" → See inbound configurations
|
|
|
|
**[Quick Setup Guide →](docs/AI_QUICKSTART.md)** | **[Full Documentation →](docs/AI_INTEGRATION.md)**
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh)
|
|
```
|
|
|
|
For full documentation, please visit the [project Wiki](https://github.com/MHSanaei/3x-ui/wiki).
|
|
|
|
## A Special Thanks to
|
|
|
|
- [alireza0](https://github.com/alireza0/)
|
|
|
|
## Acknowledgment
|
|
|
|
- [Iran v2ray rules](https://github.com/chocolate4u/Iran-v2ray-rules) (License: **GPL-3.0**): _Enhanced v2ray/xray and v2ray/xray-clients routing rules with built-in Iranian domains and a focus on security and adblocking._
|
|
- [Russia v2ray rules](https://github.com/runetfreedom/russia-v2ray-rules-dat) (License: **GPL-3.0**): _This repository contains automatically updated V2Ray routing rules based on data on blocked domains and addresses in Russia._
|
|
|
|
## Support project
|
|
|
|
**If this project is helpful to you, you may wish to give it a**:star2:
|
|
|
|
<a href="https://www.buymeacoffee.com/MHSanaei" target="_blank">
|
|
<img src="./media/default-yellow.png" alt="Buy Me A Coffee" style="height: 70px !important;width: 277px !important;" >
|
|
</a>
|
|
|
|
</br>
|
|
<a href="https://nowpayments.io/donation/hsanaei" target="_blank" rel="noreferrer noopener">
|
|
<img src="./media/donation-button-black.svg" alt="Crypto donation button by NOWPayments">
|
|
</a>
|
|
|
|
## Stargazers over Time
|
|
|
|
[](https://starchart.cc/MHSanaei/3x-ui)
|