From c7d315f8484caa9db87886e9c16535e92662831f Mon Sep 17 00:00:00 2001 From: "Shishkevich D." <135337715+shishkevichd@users.noreply.github.com> Date: Thu, 5 Jun 2025 18:56:33 +0700 Subject: chore: clean readme, add link to wiki (#3045) --- README.ar_EG.md | 571 ++------------------------------- README.es_ES.md | 591 ++-------------------------------- README.fa_IR.md | 530 ++----------------------------- README.md | 598 ++--------------------------------- README.ru_RU.md | 598 ++--------------------------------- README.zh_CN.md | 591 ++-------------------------------- media/01-overview-dark.png | Bin 91433 -> 258966 bytes media/01-overview-light.png | Bin 97793 -> 253504 bytes media/02-inbounds-dark.png | Bin 106285 -> 246229 bytes media/02-inbounds-light.png | Bin 109064 -> 246206 bytes media/05-settings-dark.png | Bin 85751 -> 283414 bytes media/05-settings-light.png | Bin 85515 -> 272795 bytes media/06-configs-dark.png | Bin 66373 -> 207048 bytes media/06-configs-light.png | Bin 67333 -> 211351 bytes web/html/index.html | 19 +- web/translation/translate.ar_EG.toml | 1 + web/translation/translate.en_US.toml | 1 + web/translation/translate.es_ES.toml | 1 + web/translation/translate.fa_IR.toml | 1 + web/translation/translate.id_ID.toml | 1 + web/translation/translate.ja_JP.toml | 1 + web/translation/translate.pt_BR.toml | 1 + web/translation/translate.ru_RU.toml | 1 + web/translation/translate.tr_TR.toml | 1 + web/translation/translate.uk_UA.toml | 1 + web/translation/translate.vi_VN.toml | 1 + web/translation/translate.zh_CN.toml | 1 + web/translation/translate.zh_TW.toml | 1 + 28 files changed, 202 insertions(+), 3309 deletions(-) diff --git a/README.ar_EG.md b/README.ar_EG.md index 50c3cdf5..99354e55 100644 --- a/README.ar_EG.md +++ b/README.ar_EG.md @@ -7,563 +7,50 @@

-**لوحة تحكم ويب متقدمة • مبنية على Xray Core** +[![](https://img.shields.io/github/v/release/mhsanaei/3x-ui.svg?style=for-the-badge)](https://github.com/MHSanaei/3x-ui/releases) +[![](https://img.shields.io/github/actions/workflow/status/mhsanaei/3x-ui/release.yml.svg?style=for-the-badge)](https://github.com/MHSanaei/3x-ui/actions) +[![GO Version](https://img.shields.io/github/go-mod/go-version/mhsanaei/3x-ui.svg?style=for-the-badge)](#) +[![Downloads](https://img.shields.io/github/downloads/mhsanaei/3x-ui/total.svg?style=for-the-badge)](https://github.com/MHSanaei/3x-ui/releases/latest) +[![License](https://img.shields.io/badge/license-GPL%20V3-blue.svg?longCache=true&style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0.en.html) -[![](https://img.shields.io/github/v/release/mhsanaei/3x-ui.svg)](https://github.com/MHSanaei/3x-ui/releases) -[![](https://img.shields.io/github/actions/workflow/status/mhsanaei/3x-ui/release.yml.svg)](#) -[![GO Version](https://img.shields.io/github/go-mod/go-version/mhsanaei/3x-ui.svg)](#) -[![Downloads](https://img.shields.io/github/downloads/mhsanaei/3x-ui/total.svg)](#) -[![License](https://img.shields.io/badge/license-GPL%20V3-blue.svg?longCache=true)](https://www.gnu.org/licenses/gpl-3.0.en.html) +**3X-UI** — لوحة تحكم متقدمة مفتوحة المصدر تعتمد على الويب مصممة لإدارة خادم Xray-core. توفر واجهة سهلة الاستخدام لتكوين ومراقبة بروتوكولات VPN والوكيل المختلفة. -> **تنبيه:** المشروع ده للتعلم الشخصي والتواصل فقط. رجاءً استخدمه بشكل قانوني. +> [!IMPORTANT] +> هذا المشروع مخصص للاستخدام الشخصي والاتصال فقط، يرجى عدم استخدامه لأغراض غير قانونية، يرجى عدم استخدامه في بيئة الإنتاج. -**لو المشروع عجبك وساعدك، ممكن تدعمنا بعمل** :star2: +كمشروع محسن من مشروع X-UI الأصلي، يوفر 3X-UI استقرارًا محسنًا ودعمًا أوسع للبروتوكولات وميزات إضافية. -

- - Image - -

- -- USDT (TRC20): `TXncxkvhkDWGts487Pjqq1qT9JmwRUz8CC` -- MATIC (polygon): `0x41C9548675D044c6Bfb425786C765bc37427256A` -- LTC (Litecoin): `ltc1q2ach7x6d2zq0n4l0t4zl7d7xe2s6fs7a3vspwv` - -## التثبيت والتحديث - -لتثبيت المشروع أو تحديثه، نفذ الأمر ده: -```bash -bash <(curl -Ls https://raw.githubusercontent.com/MHSanaei/3x-ui/refs/tags/v2.6.0/install.sh) -``` - -## تثبيت النسخة القديمة (مش موصى بيها) - -لو عايز تثبت نسخة معينة، استخدم الأمر ده، مثلاً نسخة `v1.7.9`: -```bash -VERSION=v1.7.9 && bash <(curl -Ls "https://raw.githubusercontent.com/mhsanaei/3x-ui/$VERSION/install.sh") $VERSION -``` - -## شهادة SSL - -
- اضغط لعرض تفاصيل شهادة SSL +## البدء السريع -### ACME - -عشان تدير شهادات SSL باستخدام ACME: - -1. تأكد إن الدومين بتاعك متربط صح بالسيرفر. -2. شغّل أمر `x-ui` في الترمينال واختار خيار "إدارة شهادات SSL". -3. هتلاقي الخيارات دي: - - **Get SSL:** الحصول على شهادة SSL. - - **Revoke:** إلغاء شهادة SSL موجودة. - - **Force Renew:** تجديد شهادة SSL بالقوة. - - **Show Existing Domains:** عرض كل شهادات الدومين المتوفرة على السيرفر. - - **Set Certificate Paths for the Panel:** تعيين مسارات الشهادة عشان البانل يستخدمها. - -### Certbot - -لتثبيت واستخدام Certbot: -```sh -apt-get install certbot -y -certbot certonly --standalone --agree-tos --register-unsafely-without-email -d yourdomain.com -certbot renew --dry-run ``` - -### Cloudflare - -السكريبت بتاع الإدارة فيه آلية مدمجة للتقديم على شهادة SSL من خلال Cloudflare. عشان تستخدمها، هتحتاج: -- بريد إلكتروني مسجل على Cloudflare. -- الـ Global API Key بتاع Cloudflare. -- الدومين لازم يكون مربوط للسيرفر الحالي عن طريق Cloudflare. - -**كيفية الحصول على Global API Key من Cloudflare:** - -1. شغّل أمر `x-ui` في الترمينال واختار "Cloudflare SSL Certificate". -2. ادخل على [Cloudflare API Tokens](https://dash.cloudflare.com/profile/api-tokens). -3. دوس على "View Global API Key" (شوف الصورة التوضيحية): - ![](media/APIKey1.PNG) -4. يمكن تحتاج تعيد تسجيل الدخول، وبعدها هتظهر الـ API Key (شوف الصورة التوضيحية): - ![](media/APIKey2.png) - -عند الاستخدام، ادخل اسم الدومين، البريد الإلكتروني، وAPI Key. المخطط كالتالي: - ![](media/DetailEnter.png) - -
- -## التثبيت والتحديث يدويًا - -
- اضغط لعرض تفاصيل التثبيت اليدوي - -#### الاستخدام - -1. لتحميل أحدث نسخة من الباكدج المظغوطة مباشرة على السيرفر، نفذ الأمر التالي: -```sh -ARCH=$(uname -m) -case "${ARCH}" in - x86_64 | x64 | amd64) XUI_ARCH="amd64" ;; - i*86 | x86) XUI_ARCH="386" ;; - armv8* | armv8 | arm64 | aarch64) XUI_ARCH="arm64" ;; - armv7* | armv7) XUI_ARCH="armv7" ;; - armv6* | armv6) XUI_ARCH="armv6" ;; - armv5* | armv5) XUI_ARCH="armv5" ;; - s390x) echo 's390x' ;; - *) XUI_ARCH="amd64" ;; -esac - -wget https://github.com/MHSanaei/3x-ui/releases/latest/download/x-ui-linux-${XUI_ARCH}.tar.gz +$ bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) ``` -2. بعد تحميل الباكدج، نفذ الأوامر دي للتثبيت أو التحديث: -```sh -ARCH=$(uname -m) -case "${ARCH}" in - x86_64 | x64 | amd64) XUI_ARCH="amd64" ;; - i*86 | x86) XUI_ARCH="386" ;; - armv8* | armv8 | arm64 | aarch64) XUI_ARCH="arm64" ;; - armv7* | armv7) XUI_ARCH="armv7" ;; - armv6* | armv6) XUI_ARCH="armv6" ;; - armv5* | armv5) XUI_ARCH="armv5" ;; - s390x) echo 's390x' ;; - *) XUI_ARCH="amd64" ;; -esac - -cd /root/ -rm -rf x-ui/ /usr/local/x-ui/ /usr/bin/x-ui -tar zxvf x-ui-linux-${XUI_ARCH}.tar.gz -chmod +x x-ui/x-ui x-ui/bin/xray-linux-* x-ui/x-ui.sh -cp x-ui/x-ui.sh /usr/bin/x-ui -cp -f x-ui/x-ui.service /etc/systemd/system/ -mv x-ui/ /usr/local/ -systemctl daemon-reload -systemctl enable x-ui -systemctl restart x-ui -``` - -
- -## التثبيت باستخدام Docker - -
- اضغط لعرض تفاصيل Docker - -#### الاستخدام - -1. **تثبيت Docker:** - ```sh - bash <(curl -sSL https://get.docker.com) - ``` - -2. **نسخ مستودع المشروع:** - ```sh - git clone https://github.com/MHSanaei/3x-ui.git - cd 3x-ui - ``` - -3. **تشغيل الخدمة:** - ```sh - docker compose up -d - ``` - ممكن تضيف الخيار ```--pull always``` عشان Docker يسحب أحدث صورة لو موجودة. (راجع [مستندات Docker](https://docs.docker.com/reference/cli/docker/container/run/#pull) للمزيد من التفاصيل). - - **أو** - ```sh - docker run -itd \ - -e XRAY_VMESS_AEAD_FORCED=false \ - -v $PWD/db/:/etc/x-ui/ \ - -v $PWD/cert/:/root/cert/ \ - --network=host \ - --restart=unless-stopped \ - --name 3x-ui \ - ghcr.io/mhsanaei/3x-ui:latest - ``` - -4. **التحديث إلى أحدث نسخة:** - ```sh - cd 3x-ui - docker compose down - docker compose pull 3x-ui - docker compose up -d - ``` - -5. **إزالة 3x-ui من Docker:** - ```sh - docker stop 3x-ui - docker rm 3x-ui - cd -- - rm -r 3x-ui - ``` - -
- -## إعدادات Nginx - -
- اضغط لعرض إعدادات البروكسي العكسي (Reverse Proxy) - -#### Reverse Proxy باستخدام Nginx -```nginx -location / { - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header Host $http_host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header Range $http_range; - proxy_set_header If-Range $http_if_range; - proxy_redirect off; - proxy_pass http://127.0.0.1:2053; -} -``` - -#### استخدام Nginx مع sub-path -- تأكد إن "URI Path" في إعدادات `/sub` للبانل متطابق. -- لازم يكون رابط `url` في إعدادات البانل منتهي بـ `/`. - -```nginx -location /sub { - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header Host $http_host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header Range $http_range; - proxy_set_header If-Range $http_if_range; - proxy_redirect off; - proxy_pass http://127.0.0.1:2053; -} -``` -
- -## نظام التشغيل الموصى به - -- Ubuntu 22.04+ -- Debian 12+ -- CentOS 8+ -- OpenEuler 22.03+ -- Fedora 36+ -- Arch Linux -- Parch Linux -- Manjaro -- Armbian -- AlmaLinux 9.5+ -- Rocky Linux 9.5+ -- Oracle Linux 8+ -- OpenSUSE Tubleweed -- Amazon Linux 2023 -- Virtuozzo Linux 8+ -- Windows x64 - -## المعماريات والأجهزة المدعومة - -
- اضغط لعرض تفاصيل المعماريات والأجهزة المدعومة - -منصتنا بتدعم مجموعة متنوعة من المعماريات والأجهزة عشان تناسب بيئات مختلفة. أبرز المعماريات هي: - -- **amd64:** المعمارية القياسية للكمبيوترات الشخصية والسيرفرات. -- **x86 / i386:** مستخدمة على نطاق واسع في أجهزة الديسكتوب واللاب توب. -- **armv8 / arm64 / aarch64:** موجهة للأجهزة المحمولة والمضمنة زي Raspberry Pi 4, Raspberry Pi 3, Raspberry Pi Zero 2/Zero 2 W, Orange Pi 3 LTS، وغيرها. -- **armv7 / arm / arm32:** للأجهزة المحمولة والأجهزة المضمنة القديمة، مثل Orange Pi Zero LTS, Orange Pi PC Plus, Raspberry Pi 2. -- **armv6 / arm / arm32:** للأجهزة المضمنة القديمة جداً، زي Raspberry Pi 1, Raspberry Pi Zero/Zero W. -- **armv5 / arm / arm32:** معمارية أقدم مرتبطة بالأنظمة المضمنة القديمة. -- **s390x:** مستخدمة في الحواسيب الرئيسية من IBM وتوفر أداء عالي واعتمادية للمشاريع الكبيرة. -
- -## اللغات - -- English (إنجليزي) -- Persian (فارسي) -- Traditional Chinese (الصيني التقليدي) -- Simplified Chinese (الصيني المبسط) -- Japanese (ياباني) -- Russian (روسي) -- Vietnamese (فيتنامي) -- Spanish (إسباني) -- Indonesian (إندونيسي) -- Ukrainian (أوكراني) -- Turkish (تركي) -- Português (Brazil) (برتغالي - البرازيل) - -## الميزات - -- مراقبة حالة النظام -- البحث داخل كل الإدخالات والعملاء -- ثيم داكن وفاتح -- دعم تعدد المستخدمين والبروتوكولات -- دعم بروتوكولات زي VMESS، VLESS، Trojan، Shadowsocks، Dokodemo-door، Socks، HTTP، wireguard -- دعم بروتوكولات XTLS الأصلية مثل RPRX-Direct، Vision، REALITY -- إحصائيات الترافيك، تحديد حد للترافيك، وتحديد فترة انتهاء الصلاحية -- قوالب إعدادات Xray قابلة للتخصيص -- دعم لوحة تحكم عبر HTTPS (بإستخدام الدومين الخاص وشهادة SSL) -- دعم التقديم على شهادات SSL بلمسة واحدة والتجديد التلقائي -- لمزيد من إعدادات التخصيص المتقدمة، راجع إعدادات البانل -- إصلاح مسارات الـ API (سيتم إنشاء إعدادات للمستخدم مع الـ API) -- دعم تغيير الإعدادات من خلال الخيارات المتوفرة في البانل -- دعم تصدير/استيراد قاعدة البيانات من خلال البانل - -## إعدادات البانل الافتراضية - -
- اضغط لعرض تفاصيل الإعدادات الافتراضية - -### اسم المستخدم، الباسورد، البورت ومسار الويب الأساسي - -لو مش هتعدل الإعدادات دي، هتتولد تلقائياً (ده مش بينطبق على Docker). - -**الإعدادات الافتراضية لـ Docker:** -- **اسم المستخدم:** admin -- **الباسورد:** admin -- **البورت:** 2053 +للحصول على الوثائق الكاملة، يرجى زيارة [ويكي المشروع](https://github.com/MHSanaei/3x-ui/wiki). -### إدارة قاعدة البيانات: +## شكر خاص إلى -ممكن تعمل نسخ احتياطية واسترجاع لقاعدة البيانات مباشرة من البانل. - -- **مسار قاعدة البيانات:** - - `/etc/x-ui/x-ui.db` - -### المسار الأساسي للويب - -1. **إعادة تعيين المسار الأساسي:** - - افتح الترمينال. - - نفذ أمر `x-ui`. - - اختار خيار "إعادة تعيين المسار الأساسي للويب". - -2. **توليد أو تخصيص المسار:** - - المسار هيتولد تلقائياً، أو ممكن تدخل مسار مخصص. - -3. **عرض الإعدادات الحالية:** - - لمشاهدة الإعدادات الحالية، نفذ أمر `x-ui settings` في الترمينال أو استخدم خيار "عرض الإعدادات الحالية" في البانل. - -### توصية الأمان: -- لتحسين الأمان، استخدم كلمة طويلة وعشوائية في مسار URL الخاص بالبانل. - -**مثال:** -- `http://ip:port/*webbasepath*/panel` -- `http://domain:port/*webbasepath*/panel` - -
- -## إعداد WARP - -
- اضغط لعرض تفاصيل إعداد WARP - -#### الاستخدام - -**لإصدارات `v2.1.0` وما بعدها:** - -WARP مدمج ومش محتاج تثبيت إضافي. فعل الإعدادات المطلوبة من خلال البانل. - -
- -## تحديد IP - -
- اضغط لعرض تفاصيل تحديد IP - -#### الاستخدام - -**ملحوظة:** تحديد IP ممكن مايشتغلش صح مع IP Tunnel. - -- **للإصدارات حتى `v1.6.1`:** - - تحديد IP مدمج في البانل. - -**للإصدارات `v1.7.0` وما بعدها:** - -لتفعيل وظيفة تحديد IP، هتحتاج تثبيت `fail2ban` والملفات المطلوبة من خلال الخطوات دي: - -1. شغل أمر `x-ui` في الترمينال واختار "إدارة تحديد IP". -2. هتلاقي الخيارات التالية: - - **تغيير مدة الحظر:** لتعديل مدة الحظر. - - **رفع الحظر عن الجميع:** لإلغاء كل الحظر الحالي. - - **عرض السجلات:** لمراجعة السجلات. - - **حالة Fail2ban:** لمراجعة حالة fail2ban. - - **إعادة تشغيل Fail2ban:** لإعادة تشغيل خدمة fail2ban. - - **إلغاء تثبيت Fail2ban:** لإلغاء تثبيت fail2ban مع إعداداته. - -3. حدد مسار سجل الوصول على البانل من خلال ضبط `Xray Configs/log/Access log` على `./access.log` ثم احفظ وأعد تشغيل x-ui. - -- **للإصدارات قبل `v2.1.3`:** - - هتحتاج تضبط مسار سجل الوصول يدويًا في إعدادات Xray: - ```sh - "log": { - "access": "./access.log", - "dnsLog": false, - "loglevel": "warning" - }, - ``` - -- **للإصدارات `v2.1.3` وما بعدها:** - - في خيار لضبط `access.log` مباشرة من البانل. - -
- -## بوت Telegram - -
- اضغط لعرض تفاصيل بوت Telegram - -#### الاستخدام - -تدعم لوحة التحكم إشعارات بترافيك يومي، تسجيل الدخول للبانل، نسخ احتياطية للقاعدة، حالة النظام، معلومات العملاء، وغيرها من الوظائف عن طريق بوت Telegram. عشان تستخدم البوت، لازم تضبط معلمات البوت في البانل، ومن ضمنهم: -- توكن Telegram -- ID شات الأدمن (يمكن إدخال أكثر من واحد بفواصل) -- وقت الإشعار (باستخدام صيغة cron) -- إشعار بتاريخ انتهاء الصلاحية -- إشعار حد الترافيك -- نسخ احتياطية للقاعدة -- إشعار حمل المعالج - -**صيغة مرجعية:** - -- `30 * * * * *` - إشعار عند الـ 30 ثانية من كل دقيقة. -- `0 */10 * * * *` - إشعار عند أول ثانية من كل 10 دقايق. -- `@hourly` - إشعار كل ساعة. -- `@daily` - إشعار يومي (في تمام منتصف الليل). -- `@weekly` - إشعار أسبوعي. -- `@every 8h` - إشعار كل 8 ساعات. - -### ميزات بوت Telegram - -- تقارير دورية. -- إشعارات عند تسجيل الدخول. -- إشعار عند تجاوز حمل المعالج. -- تنبيهات قبل انتهاء الصلاحية أو وصول حد الترافيك. -- دعم قوائم تقارير العملاء لو تم إضافة اسم مستخدم Telegram للمستخدم في الإعدادات. -- إمكانية البحث عن تقرير الترافيك باستخدام UUID (VMESS/VLESS) أو الباسورد (TROJAN) بشكل مجهول. -- بوت يعتمد على القوائم. -- البحث عن العملاء بالإيميل (للأدمن فقط). -- استعراض كافة الإدخالات. -- عرض حالة السيرفر. -- استعراض العملاء المستنفدين. -- استقبال النسخ الاحتياطية عند الطلب وفي التقارير الدورية. -- بوت متعدد اللغات. - -### إعداد بوت Telegram - -- ابدأ [Botfather](https://t.me/BotFather) في حساب Telegram بتاعك: - ![Botfather](./media/botfather.png) - -- أنشئ بوت جديد باستخدام أمر /newbot: هيسألك سؤالين، اسم للبوت واسم مستخدم (لازم ينتهي بكلمة "bot"). - ![Create new bot](./media/newbot.png) - -- شغل البوت اللي أنشأته. هتلاقي رابط البوت بعد كده. - ![token](./media/token.png) - -- ادخل على البانل واضبط إعدادات بوت Telegram زي ما هو موضح: -![Panel Config](./media/panel-bot-config.png) - -ادخل توكن البوت في الحقل رقم 3. -ادخل ID المستخدم في الحقل رقم 4. الحسابات اللي بالـ ID ده هيبقى ليها صلاحية الأدمن. (يمكن إدخال أكثر من واحد بفواصل) - -- كيفية الحصول على ID حساب Telegram؟ استخدم [هذا البوت](https://t.me/useridinfobot). شغله وهيدي الـ ID بتاعك. -![User ID](./media/user-id.png) - -
- -## مسارات API - -
- اضغط لعرض تفاصيل مسارات API - -#### الاستخدام - -- [توثيق الـ API](https://www.postman.com/hsanaei/3x-ui/collection/q1l5l0u/3x-ui) -- `/login` مع بيانات المستخدم باستخدام `POST`: `{username: '', password: ''}` لتسجيل الدخول. -- المسار الأساسي لـ `/panel/api/inbounds` للعمليات التالية: - -| الطريقة | المسار | الفعل | -| :-----: | ------------------------------------ | ------------------------------------------ | -| `GET` | `"/list"` | استرجاع كل الإدخالات | -| `GET` | `"/get/:id"` | استرجاع إدخال بالـ id | -| `GET` | `"/getClientTraffics/:email"` | استرجاع ترافيك عميل بالإيميل | -| `GET` | `"/getClientTrafficsById/:id"` | استرجاع ترافيك عميل بالـ id | -| `GET` | `"/createbackup"` | البوت بيرسل نسخة احتياطية للأدمن | -| `POST` | `"/add"` | إضافة إدخال | -| `POST` | `"/del/:id"` | حذف إدخال | -| `POST` | `"/update/:id"` | تحديث إدخال | -| `POST` | `"/clientIps/:email"` | استرجاع عنوان IP للعميل | -| `POST` | `"/clearClientIps/:email"` | مسح عنوان IP للعميل | -| `POST` | `"/addClient"` | إضافة عميل للإدخال | -| `POST` | `"/:id/delClient/:clientId"` | حذف عميل باستخدام clientId\* | -| `POST` | `"/updateClient/:clientId"` | تحديث بيانات عميل باستخدام clientId\* | -| `POST` | `"/:id/resetClientTraffic/:email"` | إعادة ضبط ترافيك عميل | -| `POST` | `"/resetAllTraffics"` | إعادة ضبط الترافيك لكل الإدخالات | -| `POST` | `"/resetAllClientTraffics/:id"` | إعادة ضبط ترافيك كل العملاء في إدخال معين | -| `POST` | `"/delDepletedClients/:id"` | حذف العملاء المستنفدين في الإدخال (-1: الكل) | -| `POST` | `"/onlines"` | استرجاع قائمة العملاء الأونلاين (الإيميلات) | - -\*- بالنسبة لحقل `clientId`: -- استخدم `client.id` لـ VMESS و VLESS. -- استخدم `client.password` لـ TROJAN. -- استخدم `client.email` لـ Shadowsocks. - -- [![Run In Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/5146551-dda3cab3-0e33-485f-96f9-d4262f437ac5?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D5146551-dda3cab3-0e33-485f-96f9-d4262f437ac5%26entityType%3Dcollection%26workspaceId%3Dd64f609f-485a-4951-9b8f-876b3f917124) -
- -## المتغيرات البيئية - -
- اضغط لعرض تفاصيل المتغيرات البيئية - -#### الاستخدام - -| المتغير | النوع | القيمة الافتراضية | -| ---------------- | :--------------------------------------------: | ------------------: | -| XUI_LOG_LEVEL | `"debug"` \| `"info"` \| `"warn"` \| `"error"` | `"info"` | -| XUI_DEBUG | `boolean` | `false` | -| XUI_BIN_FOLDER | `string` | `"bin"` | -| XUI_DB_FOLDER | `string` | `"/etc/x-ui"` | -| XUI_LOG_FOLDER | `string` | `"/var/log"` | - -مثال: -```sh -XUI_BIN_FOLDER="bin" XUI_DB_FOLDER="/etc/x-ui" go build main.go -``` - -
+- [alireza0](https://github.com/alireza0/) -## المعاينة +## الاعتراف - - - 3x-ui - - - - 3x-ui - - - - 3x-ui - - - - 3x-ui - - - - 3x-ui - - - - 3x-ui - - - - 3x-ui - +- [Iran v2ray rules](https://github.com/chocolate4u/Iran-v2ray-rules) (الترخيص: **GPL-3.0**): _قواعد توجيه v2ray/xray و v2ray/xray-clients المحسنة مع النطاقات الإيرانية المدمجة وتركيز على الأمان وحظر الإعلانات._ +- [Russia v2ray rules](https://github.com/runetfreedom/russia-v2ray-rules-dat) (الترخيص: **GPL-3.0**): _يحتوي هذا المستودع على قواعد توجيه V2Ray محدثة تلقائيًا بناءً على بيانات النطاقات والعناوين المحظورة في روسيا._ -## شكر خاص لـ +## دعم المشروع -- [alireza0](https://github.com/alireza0/) +**إذا كان هذا المشروع مفيدًا لك، فقد ترغب في إعطائه**:star2: -## التحيات +

+ + Image + +

-- [Iran v2ray rules](https://github.com/chocolate4u/Iran-v2ray-rules) (الرخصة: **GPL-3.0**): _قواعد محدثة لتوجيهات v2ray/xray مع تضمين دومينات إيرانية وتركيز على الأمان وحجب الإعلانات._ -- [Russia v2ray rules](https://github.com/runetfreedom/russia-v2ray-rules-dat) (الرخصة: **GPL-3.0**): _المستودع ده بيحتوي على قواعد توجيه v2ray/xray محدثة تلقائيًا بناءً على بيانات الدومينات والعناوين المحظورة في روسيا._ +- USDT (TRC20): `TXncxkvhkDWGts487Pjqq1qT9JmwRUz8CC` +- MATIC (polygon): `0x41C9548675D044c6Bfb425786C765bc37427256A` +- LTC (Litecoin): `ltc1q2ach7x6d2zq0n4l0t4zl7d7xe2s6fs7a3vspwv` -## عدد النجوم مع مرور الوقت +## النجوم عبر الزمن -[![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui) \ No newline at end of file +[![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui) \ No newline at end of file diff --git a/README.es_ES.md b/README.es_ES.md index 4b61d770..915cc4c4 100644 --- a/README.es_ES.md +++ b/README.es_ES.md @@ -7,583 +7,50 @@

-**Un Panel Web Avanzado • Construido sobre Xray Core** +[![](https://img.shields.io/github/v/release/mhsanaei/3x-ui.svg?style=for-the-badge)](https://github.com/MHSanaei/3x-ui/releases) +[![](https://img.shields.io/github/actions/workflow/status/mhsanaei/3x-ui/release.yml.svg?style=for-the-badge)](https://github.com/MHSanaei/3x-ui/actions) +[![GO Version](https://img.shields.io/github/go-mod/go-version/mhsanaei/3x-ui.svg?style=for-the-badge)](#) +[![Downloads](https://img.shields.io/github/downloads/mhsanaei/3x-ui/total.svg?style=for-the-badge)](https://github.com/MHSanaei/3x-ui/releases/latest) +[![License](https://img.shields.io/badge/license-GPL%20V3-blue.svg?longCache=true&style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0.en.html) -[![](https://img.shields.io/github/v/release/mhsanaei/3x-ui.svg)](https://github.com/MHSanaei/3x-ui/releases) -[![](https://img.shields.io/github/actions/workflow/status/mhsanaei/3x-ui/release.yml.svg)](#) -[![GO Version](https://img.shields.io/github/go-mod/go-version/mhsanaei/3x-ui.svg)](#) -[![Downloads](https://img.shields.io/github/downloads/mhsanaei/3x-ui/total.svg)](#) -[![License](https://img.shields.io/badge/license-GPL%20V3-blue.svg?longCache=true)](https://www.gnu.org/licenses/gpl-3.0.en.html) +**3X-UI** — panel de control avanzado basado en web de código abierto diseñado para gestionar el servidor Xray-core. Ofrece una interfaz fácil de usar para configurar y monitorear varios protocolos VPN y proxy. -> **Descargo de responsabilidad:** Este proyecto es solo para aprendizaje personal y comunicación, por favor no lo uses con fines ilegales, por favor no lo uses en un entorno de producción +> [!IMPORTANT] +> Este proyecto es solo para uso personal y comunicación, por favor no lo use para fines ilegales, por favor no lo use en un entorno de producción. -**Si este proyecto te es útil, podrías considerar darle una**:star2: +Como una versión mejorada del proyecto X-UI original, 3X-UI proporciona mayor estabilidad, soporte más amplio de protocolos y características adicionales. -

- - Image - -

- -- USDT (TRC20): `TXncxkvhkDWGts487Pjqq1qT9JmwRUz8CC` -- MATIC (polygon): `0x41C9548675D044c6Bfb425786C765bc37427256A` -- LTC (Litecoin): `ltc1q2ach7x6d2zq0n4l0t4zl7d7xe2s6fs7a3vspwv` - -## Instalar y Actualizar +## Inicio Rápido ``` -bash <(curl -Ls https://raw.githubusercontent.com/MHSanaei/3x-ui/refs/tags/v2.6.0/install.sh) +$ bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) ``` -## Instalar versión antigua (no recomendamos) - -Para instalar la versión deseada, utiliza el siguiente comando de instalación. Por ejemplo, ver `v1.7.9`: - -``` -VERSION=v1.7.9 && bash <(curl -Ls "https://raw.githubusercontent.com/mhsanaei/3x-ui/$VERSION/install.sh") $VERSION -``` - -## Certificado SSL - -
- Haga clic para ver los detalles del certificado SSL - -### ACME - -Para gestionar certificados SSL utilizando ACME: - -1. Asegúrate de que tu dominio esté correctamente resuelto al servidor. -2. Ejecuta el comando `x-ui` en la terminal y elige `Gestión de Certificados SSL`. -3. Se te presentarán las siguientes opciones: - - - **Get SSL:** Obtener certificados SSL. - - **Revoke:** Revocar certificados SSL existentes. - - **Force Renew:** Forzar la renovación de certificados SSL. - - **Show Existing Domains:** Mostrar todos los certificados de dominio disponibles en el servidor. - - **Set Certificate Paths for the Panel:** Especificar el certificado para tu dominio que será utilizado por el panel. - -### Certbot - -Para instalar y usar Certbot: - -```sh -apt-get install certbot -y -certbot certonly --standalone --agree-tos --register-unsafely-without-email -d yourdomain.com -certbot renew --dry-run -``` - -### Cloudflare - -El script de gestión incluye una aplicación de certificado SSL integrada para Cloudflare. Para usar este script para solicitar un certificado, necesitas lo siguiente: - -- Correo electrónico registrado en Cloudflare -- Clave API Global de Cloudflare -- El nombre de dominio debe estar resuelto al servidor actual a través de Cloudflare - -**Cómo obtener la Clave API Global de Cloudflare:** - -1. Ejecuta el comando `x-ui` en la terminal y elige `Certificado SSL de Cloudflare`. -2. Visita el enlace: [Tokens de API de Cloudflare](https://dash.cloudflare.com/profile/api-tokens). -3. Haz clic en "Ver Clave API Global" (consulta la captura de pantalla a continuación): - ![](media/APIKey1.PNG) -4. Es posible que necesites volver a autenticar tu cuenta. Después de eso, se mostrará la Clave API (consulta la captura de pantalla a continuación): - ![](media/APIKey2.png) - -Al utilizarlo, simplemente ingresa tu `nombre de dominio`, `correo electrónico` y `CLAVE API`. El diagrama es el siguiente: - ![](media/DetailEnter.png) - -
- -## Instalación y Actualización Manual - -
- Haz clic para más detalles de la instalación manual - -#### Uso - -1. Para descargar la última versión del paquete comprimido directamente en tu servidor, ejecuta el siguiente comando: - -```sh -ARCH=$(uname -m) -case "${ARCH}" in - x86_64 | x64 | amd64) XUI_ARCH="amd64" ;; - i*86 | x86) XUI_ARCH="386" ;; - armv8* | armv8 | arm64 | aarch64) XUI_ARCH="arm64" ;; - armv7* | armv7) XUI_ARCH="armv7" ;; - armv6* | armv6) XUI_ARCH="armv6" ;; - armv5* | armv5) XUI_ARCH="armv5" ;; - *) XUI_ARCH="amd64" ;; -esac - - -wget https://github.com/MHSanaei/3x-ui/releases/latest/download/x-ui-linux-${XUI_ARCH}.tar.gz -``` - -2. Una vez que se haya descargado el paquete comprimido, ejecuta los siguientes comandos para instalar o actualizar x-ui: - -```sh -ARCH=$(uname -m) -case "${ARCH}" in - x86_64 | x64 | amd64) XUI_ARCH="amd64" ;; - i*86 | x86) XUI_ARCH="386" ;; - armv8* | armv8 | arm64 | aarch64) XUI_ARCH="arm64" ;; - armv7* | armv7) XUI_ARCH="armv7" ;; - armv6* | armv6) XUI_ARCH="armv6" ;; - armv5* | armv5) XUI_ARCH="armv5" ;; - *) XUI_ARCH="amd64" ;; -esac - -cd /root/ -rm -rf x-ui/ /usr/local/x-ui/ /usr/bin/x-ui -tar zxvf x-ui-linux-${XUI_ARCH}.tar.gz -chmod +x x-ui/x-ui x-ui/bin/xray-linux-* x-ui/x-ui.sh -cp x-ui/x-ui.sh /usr/bin/x-ui -cp -f x-ui/x-ui.service /etc/systemd/system/ -mv x-ui/ /usr/local/ -systemctl daemon-reload -systemctl enable x-ui -systemctl restart x-ui -``` - -
- -## Instalar con Docker - -
- Haz clic para más detalles del Docker - -#### Uso - -1. Instala Docker: - - ```sh - bash <(curl -sSL https://get.docker.com) - ``` - -2. Clona el Repositorio del Proyecto: - - ```sh - git clone https://github.com/MHSanaei/3x-ui.git - cd 3x-ui - ``` - -3. Inicia el Servicio - - ```sh - docker compose up -d - ``` - - O tambien - - ```sh - docker run -itd \ - -e XRAY_VMESS_AEAD_FORCED=false \ - -v $PWD/db/:/etc/x-ui/ \ - -v $PWD/cert/:/root/cert/ \ - --network=host \ - --restart=unless-stopped \ - --name 3x-ui \ - ghcr.io/mhsanaei/3x-ui:latest - ``` - -actualizar a la última versión - - ```sh - cd 3x-ui - docker compose down - docker compose pull 3x-ui - docker compose up -d - ``` - -eliminar 3x-ui de docker - - ```sh - docker stop 3x-ui - docker rm 3x-ui - cd -- - rm -r 3x-ui - ``` - -
- -## Configuración de Nginx -
- Haga clic aquí para configurar el proxy inverso - -#### Proxy inverso Nginx -```nginx -location / { - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header Host $http_host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header Range $http_range; - proxy_set_header If-Range $http_if_range; - proxy_redirect off; - proxy_pass http://127.0.0.1:2053; -} -``` - -#### Nginx sub-path -- EAsegúrese de que la "Ruta Raíz de la URL del Panel" en la configuración del panel `/sub` es la misma. -- El `url` en la configuración del panel debe terminar con `/`. - -```nginx -location /sub { - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header Host $http_host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header Range $http_range; - proxy_set_header If-Range $http_if_range; - proxy_redirect off; - proxy_pass http://127.0.0.1:2053; -} -``` -
- -## SO Recomendados - -- Ubuntu 22.04+ -- Debian 12+ -- CentOS 8+ -- OpenEuler 22.03+ -- Fedora 36+ -- Arch Linux -- Parch Linux -- Manjaro -- Armbian -- AlmaLinux 9.5+ -- Rocky Linux 9.5+ -- Oracle Linux 8+ -- OpenSUSE Tubleweed -- Amazon Linux 2023 -- Virtuozzo Linux 8+ -- Windows x64 - -## Arquitecturas y Dispositivos Compatibles - -
- Haz clic para detalles de arquitecturas y dispositivos compatibles - -Nuestra plataforma ofrece compatibilidad con una amplia gama de arquitecturas y dispositivos, garantizando flexibilidad en diversos entornos informáticos. A continuación se presentan las principales arquitecturas que admitimos: - -- **amd64**: Esta arquitectura predominante es la estándar para computadoras personales y servidores, y admite la mayoría de los sistemas operativos modernos sin problemas. - -- **x86 / i386**: Ampliamente adoptada en computadoras de escritorio y portátiles, esta arquitectura cuenta con un amplio soporte de numerosos sistemas operativos y aplicaciones, incluidos, entre otros, Windows, macOS y sistemas Linux. - -- **armv8 / arm64 / aarch64**: Diseñada para dispositivos móviles y embebidos contemporáneos, como teléfonos inteligentes y tabletas, esta arquitectura está ejemplificada por dispositivos como Raspberry Pi 4, Raspberry Pi 3, Raspberry Pi Zero 2/Zero 2 W, Orange Pi 3 LTS, entre otros. - -- **armv7 / arm / arm32**: Sirve como arquitectura para dispositivos móviles y embebidos más antiguos, y sigue siendo ampliamente utilizada en dispositivos como Orange Pi Zero LTS, Orange Pi PC Plus, Raspberry Pi 2, entre otros. - -- **armv6 / arm / arm32**: Orientada a dispositivos embebidos muy antiguos, esta arquitectura, aunque menos común, todavía se utiliza. Dispositivos como Raspberry Pi 1, Raspberry Pi Zero/Zero W, dependen de esta arquitectura. - -- **armv5 / arm / arm32**: Una arquitectura más antigua asociada principalmente con sistemas embebidos tempranos, es menos común hoy en día pero aún puede encontrarse en dispositivos heredados como versiones antiguas de Raspberry Pi y algunos teléfonos inteligentes más antiguos. -
- -## Idiomas - -- Arabic (Árabe) -- English (inglés) -- Persian (persa) -- Traditional Chinese (chino tradicional) -- Simplified Chinese (chino simplificado) -- Japanese (japonés) -- Russian (ruso) -- Vietnamese (vietnamita) -- Spanish (español) -- Indonesian (indonesio) -- Ukrainian (ucraniano) -- Turkish (turco) -- Português (Brazil) (portugués (Brasil)) - - -## Características +Para documentación completa, visita la [Wiki del proyecto](https://github.com/MHSanaei/3x-ui/wiki). -- Monitoreo del Estado del Sistema -- Búsqueda dentro de todas las reglas de entrada y clientes -- Tema Oscuro/Claro -- Soporta multiusuario y multiprotocolo -- Soporta protocolos, incluyendo VMess, VLESS, Trojan, Shadowsocks, Dokodemo-door, Socks, HTTP, wireguard -- Soporta Protocolos nativos XTLS, incluyendo RPRX-Direct, Visión, REALITY -- Estadísticas de tráfico, límite de tráfico, límite de tiempo de vencimiento -- Plantillas de configuración de Xray personalizables -- Soporta acceso HTTPS al panel (dominio proporcionado por uno mismo + certificado SSL) -- Soporta la solicitud y renovación automática de certificados SSL con un clic -- Para elementos de configuración más avanzados, consulta el panel -- Corrige rutas de API (la configuración del usuario se creará con la API) -- Soporta cambiar las configuraciones por diferentes elementos proporcionados en el panel. -- Soporta exportar/importar base de datos desde el panel +## Un Agradecimiento Especial a +- [alireza0](https://github.com/alireza0/) -## Configuración Predeterminada del Panel - -
- Haz clic para ver los detalles de la configuración predeterminada - -### Nombre de usuario, Contraseña, Puerto y Ruta Base Web - -Si elige no modificar estas configuraciones, se generarán aleatoriamente (esto no se aplica a Docker). - -**Configuraciones predeterminadas para Docker:** -- **Nombre de usuario:** admin -- **Contraseña:** admin -- **Puerto:** 2053 - -### Gestión de la Base de Datos: - - Puedes realizar copias de seguridad y restauraciones de la base de datos directamente desde el panel. - -- **Ruta de la Base de Datos:** - - `/etc/x-ui/x-ui.db` - -### Ruta Base Web - -1. **Restablecer la Ruta Base Web:** - - Abre tu terminal. - - Ejecuta el comando `x-ui`. - - Selecciona la opción `Restablecer la Ruta Base Web`. - -2. **Generar o Personalizar la Ruta:** - - La ruta se generará aleatoriamente, o puedes ingresar una ruta personalizada. - -3. **Ver Configuración Actual:** - - Para ver tu configuración actual, utiliza el comando `x-ui settings` en el terminal o selecciona `Ver Configuración Actual` en `x-ui`. - -### Recomendación de Seguridad: -- Para mayor seguridad, utiliza una palabra larga y aleatoria en la estructura de tu URL. - -**Ejemplos:** -- `http://ip:port/*webbasepath*/panel` -- `http://domain:port/*webbasepath*/panel` - -
- -## Configuración de WARP - -
- Haz clic para ver los detalles de la configuración de WARP - -#### Uso - -**Para versiones `v2.1.0` y posteriores:** - -WARP está integrado, no se requiere instalación adicional. Simplemente habilita la configuración necesaria en el panel. - -
- -## Límite de IP - -
- Haz clic para ver los detalles del límite de IP - -#### Uso - -**Nota:** El Límite de IP no funcionará correctamente cuando uses Túnel IP. - -- **Para versiones hasta `v1.6.1`:** - - El límite de IP está integrado en el panel. - -**Para versiones `v1.7.0` y posteriores:** - -Para habilitar la funcionalidad de límite de IP, necesitas instalar `fail2ban` y los archivos requeridos siguiendo estos pasos: - -1. Ejecuta el comando `x-ui` en el terminal, luego elige `Gestión de Límite de IP`. -2. Verás las siguientes opciones: - - - **Cambiar la Duración del Bloqueo:** Ajustar la duración de los bloqueos. - - **Desbloquear a Todos:** Levantar todos los bloqueos actuales. - - **Revisar los Registros:** Revisar los registros. - - **Estado de Fail2ban:** Verificar el estado de `fail2ban`. - - **Reiniciar Fail2ban:** Reiniciar el servicio `fail2ban`. - - **Desinstalar Fail2ban:** Desinstalar Fail2ban con la configuración. - -3. Agrega una ruta para el registro de acceso en el panel configurando `Xray Configs/log/Access log` a `./access.log`, luego guarda y reinicia Xray. - -- **Para versiones anteriores a `v2.1.3`:** - - Necesitas configurar manualmente la ruta del registro de acceso en tu configuración de Xray: - - ```sh - "log": { - "access": "./access.log", - "dnsLog": false, - "loglevel": "warning" - }, - ``` - -- **Para versiones `v2.1.3` y posteriores:** - - Hay una opción para configurar `access.log` directamente desde el panel. - -
- -## Bot de Telegram - -
- Haz clic para más detalles del bot de Telegram - -#### Uso - -El panel web admite tráfico diario, inicio de sesión en el panel, copia de seguridad de la base de datos, estado del sistema, información del cliente y otras notificaciones y funciones a través del Bot de Telegram. Para usar el bot, debes establecer los parámetros relacionados con el bot en el panel, que incluyen: - -- Token de Telegram -- ID de chat de administrador(es) -- Hora de Notificación (en sintaxis cron) -- Notificación de Fecha de Caducidad -- Notificación de Capacidad de Tráfico -- Copia de seguridad de la base de datos -- Notificación de Carga de CPU - - -**Sintaxis de referencia:** - -- `30 \* \* \* \* \*` - Notifica a los 30s de cada punto -- `0 \*/10 \* \* \* \*` - Notifica en el primer segundo de cada 10 minutos -- `@hourly` - Notificación por hora -- `@daily` - Notificación diaria (00:00 de la mañana) -- `@weekly` - Notificación semanal -- `@every 8h` - Notifica cada 8 horas - -### Funcionalidades del Bot de Telegram - -- Reporte periódico -- Notificación de inicio de sesión -- Notificación de umbral de CPU -- Umbral de Notificación para Fecha de Caducidad y Tráfico para informar con anticipación -- Soporte para menú de reporte de cliente si el nombre de usuario de Telegram del cliente se agrega a las configuraciones de usuario -- Soporte para reporte de tráfico de Telegram buscado con UUID (VMESS/VLESS) o Contraseña (TROJAN) - anónimamente -- Bot basado en menú -- Buscar cliente por correo electrónico (solo administrador) -- Ver todas las Entradas -- Ver estado del servidor -- Ver clientes agotados -- Recibir copia de seguridad bajo demanda y en informes periódicos -- Bot multilingüe - -### Configuración del Bot de Telegram - -- Inicia [Botfather](https://t.me/BotFather) en tu cuenta de Telegram: - ![Botfather](./media/botfather.png) - -- Crea un nuevo bot usando el comando /newbot: Te hará 2 preguntas, Un nombre y un nombre de usuario para tu bot. Ten en cuenta que el nombre de usuario debe terminar con la palabra "bot". - ![Create new bot](./media/newbot.png) - -- Inicia el bot que acabas de crear. Puedes encontrar el enlace a tu bot aquí. - ![token](./media/token.png) - -- Ingresa a tu panel y configura los ajustes del bot de Telegram como se muestra a continuación: -![Panel Config](./media/panel-bot-config.png) - -Ingresa el token de tu bot en el campo de entrada número 3. -Ingresa el ID de chat de usuario en el campo de entrada número 4. Las cuentas de Telegram con esta ID serán los administradores del bot. (Puedes ingresar más de uno, solo sepáralos con ,) - -- ¿Cómo obtener el ID de chat de Telegram? Usa este [bot](https://t.me/useridinfobot), Inicia el bot y te dará el ID de chat del usuario de Telegram. -![User ID](./media/user-id.png) - -
- -## Rutas de API - -
- Haz clic para más detalles de las rutas de API - -#### Uso - -- [Documentación de API](https://www.postman.com/hsanaei/3x-ui/collection/q1l5l0u/3x-ui) -- `/login` con `POST` datos de usuario: `{username: '', password: ''}` para iniciar sesión -- `/panel/api/inbounds` base para las siguientes acciones: - -| Método | Ruta | Acción | -| :----: | ---------------------------------- | --------------------------------------------------------- | -| `GET` | `"/list"` | Obtener todas los Entradas | -| `GET` | `"/get/:id"` | Obtener Entrada con inbound.id | -| `GET` | `"/getClientTraffics/:email"` | Obtener Tráficos del Cliente con email | -| `GET` | `"/createbackup"` | El bot de Telegram envía copia de seguridad a los admins | -| `POST` | `"/add"` | Agregar Entrada | -| `POST` | `"/del/:id"` | Eliminar Entrada | -| `POST` | `"/update/:id"` | Actualizar Entrada | -| `POST` | `"/clientIps/:email"` | Dirección IP del Cliente | -| `POST` | `"/clearClientIps/:email"` | Borrar Dirección IP del Cliente | -| `POST` | `"/addClient"` | Agregar Cliente a la Entrada | -| `POST` | `"/:id/delClient/:clientId"` | Eliminar Cliente por clientId\* | -| `POST` | `"/updateClient/:clientId"` | Actualizar Cliente por clientId\* | -| `POST` | `"/:id/resetClientTraffic/:email"` | Restablecer Tráfico del Cliente | -| `POST` | `"/resetAllTraffics"` | Restablecer tráfico de todos las Entradas | -| `POST` | `"/resetAllClientTraffics/:id"` | Restablecer tráfico de todos los clientes en una Entrada | -| `POST` | `"/delDepletedClients/:id"` | Eliminar clientes agotados de la entrada (-1: todos) | -| `POST` | `"/onlines"` | Obtener usuarios en línea (lista de correos electrónicos) | - -\*- El campo `clientId` debe llenarse por: - -- `client.id` para VMESS y VLESS -- `client.password` para TROJAN -- `client.email` para Shadowsocks - -- [Run In Postman](https://app.getpostman.com/run-collection/5146551-dda3cab3-0e33-485f-96f9-d4262f437ac5?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D5146551-dda3cab3-0e33-485f-96f9-d4262f437ac5%26entityType%3Dcollection%26workspaceId%3Dd64f609f-485a-4951-9b8f-876b3f917124) -
- -## Variables de Entorno - -
- Haz clic para más detalles de las variables de entorno - -#### Uso - -| Variable | Tipo | Predeterminado | -| -------------- | :--------------------------------------------: | :------------- | -| XUI_LOG_LEVEL | `"debug"` \| `"info"` \| `"warn"` \| `"error"` | `"info"` | -| XUI_DEBUG | `boolean` | `false` | -| XUI_BIN_FOLDER | `string` | `"bin"` | -| XUI_DB_FOLDER | `string` | `"/etc/x-ui"` | -| XUI_LOG_FOLDER | `string` | `"/var/log"` | - -Ejemplo: - -```sh -XUI_BIN_FOLDER="bin" XUI_DB_FOLDER="/etc/x-ui" go build main.go -``` - -
- -## Vista previa +## Reconocimientos - - - 3x-ui - - - - 3x-ui - - - - 3x-ui - - - - 3x-ui - - - - 3x-ui - - - - 3x-ui - - - - 3x-ui - +- [Iran v2ray rules](https://github.com/chocolate4u/Iran-v2ray-rules) (Licencia: **GPL-3.0**): _Reglas de enrutamiento mejoradas para v2ray/xray y v2ray/xray-clients con dominios iraníes incorporados y un enfoque en seguridad y bloqueo de anuncios._ +- [Russia v2ray rules](https://github.com/runetfreedom/russia-v2ray-rules-dat) (Licencia: **GPL-3.0**): _Este repositorio contiene reglas de enrutamiento V2Ray actualizadas automáticamente basadas en datos de dominios y direcciones bloqueadas en Rusia._ -## Un agradecimiento especial a +## Apoyar el Proyecto -- [alireza0](https://github.com/alireza0/) +**Si este proyecto te es útil, puedes darle una**:star2: -## Reconocimientos +

+ + Image + +

-- [Iran v2ray rules](https://github.com/chocolate4u/Iran-v2ray-rules) (Licencia: **GPL-3.0**): _Reglas de enrutamiento mejoradas de v2ray/xray y v2ray/xray-clients con dominios iraníes integrados y un enfoque en seguridad y bloqueo de anuncios._ -- [Russia v2ray rules](https://github.com/runetfreedom/russia-v2ray-rules-dat) (License: **GPL-3.0**): _Este repositorio contiene reglas de enrutamiento de V2Ray actualizadas automáticamente basadas en datos de dominios y direcciones bloqueados en Rusia._ +- USDT (TRC20): `TXncxkvhkDWGts487Pjqq1qT9JmwRUz8CC` +- MATIC (polygon): `0x41C9548675D044c6Bfb425786C765bc37427256A` +- LTC (Litecoin): `ltc1q2ach7x6d2zq0n4l0t4zl7d7xe2s6fs7a3vspwv` -## Estrellas a lo largo del tiempo +## Estrellas a lo Largo del Tiempo -[![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui) +[![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui) \ No newline at end of file diff --git a/README.fa_IR.md b/README.fa_IR.md index 1216d6ad..e194b663 100644 --- a/README.fa_IR.md +++ b/README.fa_IR.md @@ -7,522 +7,50 @@

-**یک پنل وب پیشرفته • ساخته شده بر پایه Xray Core** +[![](https://img.shields.io/github/v/release/mhsanaei/3x-ui.svg?style=for-the-badge)](https://github.com/MHSanaei/3x-ui/releases) +[![](https://img.shields.io/github/actions/workflow/status/mhsanaei/3x-ui/release.yml.svg?style=for-the-badge)](https://github.com/MHSanaei/3x-ui/actions) +[![GO Version](https://img.shields.io/github/go-mod/go-version/mhsanaei/3x-ui.svg?style=for-the-badge)](#) +[![Downloads](https://img.shields.io/github/downloads/mhsanaei/3x-ui/total.svg?style=for-the-badge)](https://github.com/MHSanaei/3x-ui/releases/latest) +[![License](https://img.shields.io/badge/license-GPL%20V3-blue.svg?longCache=true&style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0.en.html) -[![](https://img.shields.io/github/v/release/mhsanaei/3x-ui.svg)](https://github.com/MHSanaei/3x-ui/releases) -[![](https://img.shields.io/github/actions/workflow/status/mhsanaei/3x-ui/release.yml.svg)](#) -[![GO Version](https://img.shields.io/github/go-mod/go-version/mhsanaei/3x-ui.svg)](#) -[![Downloads](https://img.shields.io/github/downloads/mhsanaei/3x-ui/total.svg)](#) -[![License](https://img.shields.io/badge/license-GPL%20V3-blue.svg?longCache=true)](https://www.gnu.org/licenses/gpl-3.0.en.html) +**3X-UI** — یک پنل کنترل پیشرفته مبتنی بر وب با کد باز که برای مدیریت سرور Xray-core طراحی شده است. این پنل یک رابط کاربری آسان برای پیکربندی و نظارت بر پروتکل‌های مختلف VPN و پراکسی ارائه می‌دهد. -> **سلب مسئولیت:** این پروژه صرفاً برای اهداف آموزشی و تحقیقاتی است. استفاده از آن برای مقاصد غیرقانونی یا در محیط‌های عملیاتی ممنوع است. +> [!IMPORTANT] +> این پروژه فقط برای استفاده شخصی و ارتباطات است، لطفاً از آن برای اهداف غیرقانونی استفاده نکنید، لطفاً از آن در محیط تولید استفاده نکنید. -**اگر این پروژه برای شما مفید بوده، می‌توانید با دادن یک**:star2: از آن حمایت کنید. +به عنوان یک نسخه بهبود یافته از پروژه اصلی X-UI، 3X-UI پایداری بهتر، پشتیبانی گسترده‌تر از پروتکل‌ها و ویژگی‌های اضافی را ارائه می‌دهد. -

- - Image - -

- -- USDT (TRC20): `TXncxkvhkDWGts487Pjqq1qT9JmwRUz8CC` -- MATIC (polygon): `0x41C9548675D044c6Bfb425786C765bc37427256A` -- LTC (Litecoin): `ltc1q2ach7x6d2zq0n4l0t4zl7d7xe2s6fs7a3vspwv` - -## نصب و ارتقا - -``` -bash <(curl -Ls https://raw.githubusercontent.com/MHSanaei/3x-ui/refs/tags/v2.6.0/install.sh) -``` - -## نصب نسخه‌های قدیمی (توصیه نمی‌شود) - -برای نصب نسخه خاصی از دستور زیر استفاده کنید. مثال برای نسخه `v1.7.9`: - -``` -VERSION=v1.7.9 && bash <(curl -Ls "https://raw.githubusercontent.com/mhsanaei/3x-ui/$VERSION/install.sh") $VERSION -``` - -## گواهی SSL - -
- جزئیات گواهی SSL - -### ACME - -برای مدیریت گواهی‌های SSL با استفاده از ACME: - -1. اطمینان حاصل کنید دامنه شما به درستی به سرور متصل است. -2. دستور `x-ui` را در ترمینال اجرا کرده و گزینه `مدیریت گواهی SSL` را انتخاب کنید. -3. گزینه‌های زیر نمایش داده می‌شوند: - - - **دریافت SSL:** دریافت گواهی SSL - - **لغو:** لغو گواهی‌های موجود - - **تمدید اجباری:** تمدید اجباری گواهی‌ها - - **نمایش دامنه‌های موجود:** نمایش تمام دامنه‌های دارای گواهی - - **تنظیم مسیر گواهی برای پنل:** تنظیم مسیر گواهی برای دامنه شما - -### Certbot - -نصب و استفاده از Certbot: - -```sh -apt-get install certbot -y -certbot certonly --standalone --agree-tos --register-unsafely-without-email -d yourdomain.com -certbot renew --dry-run -``` - -### Cloudflare - -اسکریپت داخلی برای دریافت گواهی SSL از Cloudflare. نیازمند: - -- ایمیل ثبت‌شده در Cloudflare -- کلید API جهانی Cloudflare -- دامنه باید از طریق Cloudflare به سرور متصل باشد - -**دریافت کلید API جهانی Cloudflare:** - -1. دستور `x-ui` را اجرا و گزینه `گواهی SSL کلادفلر` را انتخاب کنید. -2. به لینک [Cloudflare API Tokens](https://dash.cloudflare.com/profile/api-tokens) مراجعه کنید. -3. روی "View Global API Key" کلیک کنید: - ![](media/APIKey1.PNG) -4. پس از احراز هویت، کلید API نمایش داده می‌شود: - ![](media/APIKey2.png) - -در هنگام استفاده، نام دامنه، ایمیل و کلید API را وارد کنید: - ![](media/DetailEnter.png) - -
- -## نصب دستی و ارتقا - -
- جزئیات نصب دستی +## شروع سریع -#### استفاده - -1. دریافت آخرین نسخه از سرور: - -```sh -ARCH=$(uname -m) -case "${ARCH}" in - x86_64 | x64 | amd64) XUI_ARCH="amd64" ;; - i*86 | x86) XUI_ARCH="386" ;; - armv8* | armv8 | arm64 | aarch64) XUI_ARCH="arm64" ;; - armv7* | armv7) XUI_ARCH="armv7" ;; - armv6* | armv6) XUI_ARCH="armv6" ;; - armv5* | armv5) XUI_ARCH="armv5" ;; - s390x) echo 's390x' ;; - *) XUI_ARCH="amd64" ;; -esac - -wget https://github.com/MHSanaei/3x-ui/releases/latest/download/x-ui-linux-${XUI_ARCH}.tar.gz ``` - -2. نصب یا ارتقا: - -```sh -ARCH=$(uname -m) -case "${ARCH}" in - x86_64 | x64 | amd64) XUI_ARCH="amd64" ;; - i*86 | x86) XUI_ARCH="386" ;; - armv8* | armv8 | arm64 | aarch64) XUI_ARCH="arm64" ;; - armv7* | armv7) XUI_ARCH="armv7" ;; - armv6* | armv6) XUI_ARCH="armv6" ;; - armv5* | armv5) XUI_ARCH="armv5" ;; - s390x) echo 's390x' ;; - *) XUI_ARCH="amd64" ;; -esac - -cd /root/ -rm -rf x-ui/ /usr/local/x-ui/ /usr/bin/x-ui -tar zxvf x-ui-linux-${XUI_ARCH}.tar.gz -chmod +x x-ui/x-ui x-ui/bin/xray-linux-* x-ui/x-ui.sh -cp x-ui/x-ui.sh /usr/bin/x-ui -cp -f x-ui/x-ui.service /etc/systemd/system/ -mv x-ui/ /usr/local/ -systemctl daemon-reload -systemctl enable x-ui -systemctl restart x-ui +$ bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) ``` -
- -## نصب با Docker - -
- جزئیات Docker - -#### استفاده - -1. **نصب Docker:** - - ```sh - bash <(curl -sSL https://get.docker.com) - ``` - -2. **کلون پروژه:** - - ```sh - git clone https://github.com/MHSanaei/3x-ui.git - cd 3x-ui - ``` - -3. **راه‌اندازی سرویس:** - - ```sh - docker compose up -d - ``` - - یا - - ```sh - docker run -itd \ - -e XRAY_VMESS_AEAD_FORCED=false \ - -v $PWD/db/:/etc/x-ui/ \ - -v $PWD/cert/:/root/cert/ \ - --network=host \ - --restart=unless-stopped \ - --name 3x-ui \ - ghcr.io/mhsanaei/3x-ui:latest - ``` - -4. **به‌روزرسانی:** - - ```sh - cd 3x-ui - docker compose down - docker compose pull 3x-ui - docker compose up -d - ``` - -5. **حذف:** - - ```sh - docker stop 3x-ui - docker rm 3x-ui - cd -- - rm -r 3x-ui - ``` - -
- -## تنظیمات Nginx -
- پیکربندی Reverse Proxy - -#### Nginx Reverse Proxy -```nginx -location / { - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header Host $http_host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header Range $http_range; - proxy_set_header If-Range $http_if_range; - proxy_redirect off; - proxy_pass http://127.0.0.1:2053; -} -``` - -#### مسیر فرعی در Nginx -- اطمینان حاصل کنید "URI Path" در تنظیمات پنل یکسان باشد. -- `url` در تنظیمات پنل باید با `/` پایان یابد. - -```nginx -location /sub { - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header Host $http_host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header Range $http_range; - proxy_set_header If-Range $http_if_range; - proxy_redirect off; - proxy_pass http://127.0.0.1:2053; -} -``` -
- -## سیستم‌عامل‌های توصیه شده - -- Ubuntu 22.04+ -- Debian 12+ -- CentOS 8+ -- OpenEuler 22.03+ -- Fedora 36+ -- Arch Linux -- Parch Linux -- Manjaro -- Armbian -- AlmaLinux 9.5+ -- Rocky Linux 9.5+ -- Oracle Linux 8+ -- OpenSUSE Tubleweed -- Amazon Linux 2023 -- Virtuozzo Linux 8+ -- Windows x64 - -## معماری‌ها و دستگاه‌های پشتیبانی شده - -
- جزئیات معماری‌ها و دستگاه‌ها - -- **amd64**: معماری استاندارد برای کامپیوترهای شخصی و سرورها -- **x86 / i386**: سیستم‌های دسکتاپ و لپ‌تاپ -- **armv8 / arm64 / aarch64**: دستگاه‌های موبایل و embedded مانند Raspberry Pi 4 -- **armv7 / arm / arm32**: دستگاه‌های قدیمی مانند Orange Pi Zero -- **armv6 / arm / arm32**: دستگاه‌های بسیار قدیمی مان