Skip to content

README.fa_IR.md

Latest commit

 

History

History
615 lines (461 loc) · 30.6 KB

README.fa_IR.md

File metadata and controls

615 lines (461 loc) · 30.6 KB
Raw

فارسی | انگلیسی | چینی | اسپانیایی | روسی

tx-ui

یک پنل وب پیشرفته • ساخته شده بر روی هسته Xray این پروژه یک فورک از پنل 3x-ui است.

GO Version Downloads License

سلب مسئولیت: این پروژه فقط برای یادگیری و ارتباطات شخصی است، لطفاً از آن برای مقاصد غیرقانونی استفاده نکنید، لطفاً از آن در محیط عملیاتی (production) استفاده نکنید.

اگر این پروژه برای شما مفید بود، ممکن است بخواهید به آن یک ستاره بدهید🌟

USDT(TON): UQD6dwK0jcZuJfH-xMPu4HcnXru9xMKVIzTy_2oZZm-HZzCl

نصب و ارتقا

< (curl -Ls https://raw.githubusercontent.com/Incognito-Coder/tx-ui/master/install.sh)

گواهی SSL

برای جزئیات گواهی SSL کلیک کنید

ACME

برای مدیریت گواهی‌های SSL با استفاده از ACME:

  1. اطمینان حاصل کنید که دامنه شما به درستی به سرور متصل شده است.

  2. دستور x-ui را در ترمینال اجرا کنید، سپس مدیریت گواهی SSL را انتخاب کنید.

  3. گزینه‌های زیر به شما نمایش داده می‌شود:

    • دریافت SSL: دریافت گواهی‌های SSL.
    • لغو: لغو گواهی‌های SSL موجود.
    • تمدید اجباری: تمدید اجباری گواهی‌های SSL.
    • نمایش دامنه‌های موجود: نمایش تمام گواهی‌های دامنه موجود در سرور.
    • تنظیم مسیرهای گواهی برای پنل: مشخص کردن گواهی دامنه شما برای استفاده توسط پنل.

Certbot

برای نصب و استفاده از Certbot:

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 سراسری (Global API Key) Cloudflare
  • نام دامنه باید از طریق Cloudflare به سرور فعلی متصل شده باشد

چگونه کلید API سراسری Cloudflare را دریافت کنیم:

  1. دستور x-ui را در ترمینال اجرا کنید، سپس گواهی SSL کلودفلر را انتخاب کنید.
  2. از این لینک بازدید کنید: توکن‌های API کلودفلر.
  3. روی "View Global API Key" کلیک کنید (تصویر زیر را ببینید):
  4. ممکن است نیاز به احراز هویت مجدد حساب خود داشته باشید. پس از آن، کلید API نمایش داده خواهد شد (تصویر زیر را ببینید):

هنگام استفاده، فقط نام دامنه، ایمیل، و کلید API خود را وارد کنید. نمودار به شرح زیر است:

نصب و ارتقا دستی

برای جزئیات نصب دستی کلیک کنید

نحوه استفاده

  1. برای دانلود آخرین نسخه بسته فشرده به طور مستقیم روی سرور خود، دستور زیر را اجرا کنید:
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/Incognito-Coder/tx-ui/releases/latest/download/x-ui-linux-${XUI_ARCH}.tar.gz
  1. پس از دانلود بسته فشرده، دستورات زیر را برای نصب یا ارتقا x-ui اجرا کنید:
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/
systemctl daemon-reload
systemctl enable x-ui
systemctl restart x-ui

نصب با Docker

برای جزئیات Docker کلیک کنید

نحوه استفاده

  1. نصب Docker:

    bash <(curl -sSL https://get.docker.com)

  2. کلون کردن ریپازیتوری پروژه:

    git clone https://github.com/Incognito-Coder/tx-ui.git
cd tx-ui

  3. شروع سرویس:

    docker compose up -d

فلگ --pull always را اضافه کنید تا داکر در صورت کشیده شدن یک ایمیج جدیدتر، کانتینر را به طور خودکار بازسازی کند. برای اطلاعات بیشتر به https://docs.docker.com/reference/cli/docker/container/run/#pull مراجعه کنید.

یا

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 tx-ui \
   ghcr.io/incognitocoder/tx-ui:latest

  1. به‌روزرسانی به آخرین نسخه:

    cd tx-ui
docker compose down
docker compose pull tx-ui
docker compose up -d

  2. حذف tx-ui از Docker:

    docker stop tx-ui
docker rm tx-ui
cd --
rm -r tx-ui

تنظیمات 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

  • اطمینان حاصل کنید که "مسیر URI" در تنظیمات پنل /sub یکسان باشد.
  • url در تنظیمات پنل باید با / خاتمه یابد.
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
  • Windows x64 / x86 / ARM64
  • macOS (Intel & Apple Silicon M1/M2/M3/M4)
  • FreeBSD
  • OpenBSD

معماری‌ها و دستگاه‌های پشتیبانی شده

برای جزئیات معماری‌ها و دستگاه‌های پشتیبانی شده کلیک کنید

پلتفرم ما با طیف متنوعی از معماری‌ها و دستگاه‌ها سازگاری دارد و انعطاف‌پذیری را در محیط‌های مختلف محاسباتی تضمین می‌کند. معماری‌های کلیدی که ما پشتیبانی می‌کنیم به شرح زیر است:

  • amd64: این معماری رایج، استاندارد کامپیوترهای شخصی و سرورها است و اکثر سیستم‌عامل‌های مدرن را به راحتی پشتیبانی می‌کند.

  • x86 / i386: این معماری که به طور گسترده در کامپیوترهای رومیزی و لپ‌تاپ‌ها استفاده می‌شود، از پشتیبانی وسیع سیستم‌عامل‌ها و برنامه‌های کاربردی از جمله ویندوز، macOS، لینوکس، FreeBSD و OpenBSD برخوردار است.

  • armv8 / arm64 / aarch64: این معماری برای دستگاه‌های مدرن موبایل، دسکتاپ و توکار (Apple Silicon M1/M2/M3/M4، Raspberry Pi 4/5، Orange Pi 3/5 و غیره) طراحی شده است.

  • armv7 / arm / arm32: این معماری برای دستگاه‌های موبایل و توکار مانند Orange Pi Zero LTS، Orange Pi PC Plus، Raspberry Pi 2/3 و غیره کاربرد دارد.

  • armv6 / arm / arm32: برای دستگاه‌های توکار کم‌مصرف (Raspberry Pi 1، Raspberry Pi Zero/Zero W).

  • armv5 / arm / arm32: یک معماری قدیمی‌تر که عمدتاً با سیستم‌های توکار اولیه مرتبط است.

  • mips64 / mips64le / mips32 / mips32le: معماری‌های MIPS برای روترها، تجهیزات شبکه (پلتفرم‌های OpenWrt/لینوکس توکار) و سرورها.

  • riscv64: معماری ۶۴ بیتی متن‌باز RISC-V برای سخت‌افزارهای مدرن توکار و کامپیوترهای تک‌بردی (SiFive، Milk-V، StarFive).

  • ppc64 / ppc64le: معماری ۶۴ بیتی PowerPC برای سرورهای سازمانی (سیستم‌های IBM Power).

  • s390x: این معماری معمولاً در کامپیوترهای مین‌فریم IBM استفاده می‌شود و عملکرد و قابلیت اطمینان بالایی را ارائه می‌دهد.

  • loong64: معماری ۶۴ بیتی LoongArch برای پلتفرم‌های Loongson.

زبان‌ها

  • عربی
  • انگلیسی
  • فارسی
  • چینی سنتی
  • چینی ساده‌شده
  • ژاپنی
  • روسی
  • ویتنامی
  • اسپانیایی
  • اندونزیایی
  • اوکراینی
  • ترکی
  • پرتغالی (برزیل)

ویژگی‌ها

  • پشتیبانی از پروتکل امنزیا (AmneziaWG AWG 3.1): اجرای بومی و یکپارچه‌سازی با هسته، پارامترهای مبهم‌سازی پیشرفته ضد فیلترینگ (jc, jmin, jmax, s1-s4, h1-h4)، تولید جفت‌کلید Curve25519 استاندارد RFC 7748، دانلود فایل کانفیگ .conf با یک کلیک و لینک‌های موبایل (vpn://, wireguard://).
  • پروکسی MTProto با FakeTLS: رانر جانبی چندکاربره بومی mtg، تولید خودکار سکرت‌های FakeTLS با دامنه استتار (ee.../dd...)، لینک‌های اتصال مستقیم تلگرام (tg://proxy, t.me/proxy) و کدهای QR.
  • اعمال آدرس و پورت External Proxy: اعمال خودکار آدرس و پورت پروکسی خارجی در کانفیگ‌های WireGuard و AmneziaWG، لینک‌های vpn:// / wireguard:// و لینک‌های تلگرام tg://proxy.
  • مستندات تعاملی API درون پنل (/panel/docs): بررسی، جستجو، کپی نقاط پایانی و مشاهده نمونه کدهای زنده cURL، پایتون و نود در خود رابط وب.
  • بازگردانی خودکار و دستی وضعیت پیکربندی: اعتبارسنجی پیش‌پرواز، تشخیص فوری خروج هسته و بازگشت خودکار به config.json.last_working جهت جلوگیری از قطعی سرویس.
  • هسته به‌روز Xray (نسخه v26.10.31): پشتیبانی کامل از فیلتر IP مبدا در Finalmask، حذف خودکار فیلتر از لینک‌های اشتراک کلاینت، پشتیبانی از ذخیره‌سازی S3 در انتقال XDRIVE، پارامترهای h2Params و متد OPTIONS در XHTTP، و گسترش سایفرهای TLS.
  • جداسازی کامل گذرواژه‌ها بر اساس پروتکل: تولید و ذخیره اختصاصی برای تروجان، شادوساکس ۲۰۲۲ (کلید Base64 استاندارد ۱۶/۳۲ بایتی و اصلاح خودکار)، مسک (MASQUE)، هیستریا، ام‌تی‌پروتو و وایرگارد/امنزیا.
  • مدیریت دستگاه‌های متصل: ردیابی دستگاه‌های متصل هر کاربر (IP، برنامه، سیستم‌عامل و آخرین اتصال) با قابلیت پاکسازی تاریخچه.
  • سلامت و نگهداری دیتابیس: عیب‌یابی مستقیم SQLite در پنل، کاهش حجم WAL، بهینه‌سازی PRAGMA، فشرده‌سازی VACUUM و پاکسازی رکوردهای یتیم.
  • نصب پنل با Force HTTPS
  • نظارت بر وضعیت سیستم (بار CPU، حافظه RAM، دیسک، اتصالات TCP/UDP و ترافیک زنده)
  • جستجو و فیلتر در میان تمام ورودی‌ها و کاربران
  • پشتیبانی از تم‌های تیره، اولترا دارک و روشن
  • پشتیبانی از چند کاربر و چند پروتکل: VMess، VLESS، Trojan، Shadowsocks، WireGuard، AmneziaWG (AWG 3.1)، MTProto (FakeTLS)، MASQUE، Hysteria، Tunnel، Socks، HTTP
  • پشتیبانی از پروتکل‌های بومی XTLS: شامل RPRX-Direct، Vision، REALITY
  • آمار ترافیک، محدودیت ترافیک، محدودیت زمان انقضا
  • قالب‌های قابل تنظیم پیکربندی Xray
  • پشتیبانی از دسترسی به پنل با HTTPS (دامنه و گواهی SSL)
  • درخواست گواهی SSL با یک کلیک و تمدید خودکار
  • بومی‌سازی و ترجمه ۱۰۰٪ کامل در تمامی ۱۳ زبان
  • صادرات/واردات پایگاه داده از پنل
  • به‌روزرسان داخلی برنامه

تنظیمات پیش‌فرض پنل

برای جزئیات تنظیمات پیش‌فرض کلیک کنید

نام کاربری، رمز عبور، پورت و مسیر پایه وب

اگر این تنظیمات را تغییر ندهید، به صورت تصادفی ایجاد خواهند شد (این مورد برای Docker صدق نمی‌کند).

تنظیمات پیش‌فرض برای Docker:

  • نام کاربری: admin
  • رمز عبور: admin
  • پورت: 2053

مدیریت پایگاه داده:

شما می‌توانید به راحتی پشتیبان‌گیری و بازیابی پایگاه داده را مستقیماً از پنل انجام دهید.

  • مسیر پایگاه داده:
    • /etc/x-ui/x-ui.db

مسیر پایه وب

  1. بازنشانی مسیر پایه وب:

    • ترمینال خود را باز کنید.
    • دستور x-ui را اجرا کنید.
    • گزینه بازنشانی مسیر پایه وب را انتخاب کنید.

  2. ایجاد یا سفارشی‌سازی مسیر:

    • مسیر به صورت تصادفی ایجاد می‌شود، یا می‌توانید یک مسیر سفارشی وارد کنید.

  3. مشاهده تنظیمات فعلی:

    • برای مشاهده تنظیمات فعلی خود، از دستور x-ui settings در ترمینال یا مشاهده تنظیمات فعلی در x-ui استفاده کنید.

توصیه امنیتی:

  • برای امنیت بیشتر، از یک کلمه طولانی و تصادفی در ساختار URL خود استفاده کنید.

مثال‌ها:

  • http://ip:port/*webbasepath*/panel
  • http://domain:port/*webbasepath*/panel

محدودیت IP

برای جزئیات محدودیت IP کلیک کنید

نحوه استفاده

توجه: محدودیت IP هنگام استفاده از تونل IP به درستی کار نخواهد کرد.

برای فعال کردن قابلیت محدودیت IP، باید fail2ban و فایل‌های مورد نیاز آن را با دنبال کردن این مراحل نصب کنید:

  1. دستور x-ui را در ترمینال اجرا کنید، سپس مدیریت محدودیت IP را انتخاب کنید.

  2. گزینه‌های زیر را مشاهده خواهید کرد:

    • تغییر مدت زمان مسدودیت: تنظیم مدت زمان مسدودیت‌ها.
    • رفع مسدودیت همه: لغو تمام مسدودیت‌های فعلی.
    • بررسی لاگ‌ها: بازبینی لاگ‌ها.
    • وضعیت Fail2ban: بررسی وضعیت fail2ban.
    • راه‌اندازی مجدد Fail2ban: راه‌اندازی مجدد سرویس fail2ban.
    • حذف Fail2ban: حذف Fail2ban به همراه تنظیمات.

  3. یک مسیر برای لاگ دسترسی در پنل با تنظیم Xray Configs/log/Access log به ./access.log اضافه کنید، سپس ذخیره کرده و xray را مجدداً راه‌اندازی کنید.

ربات تلگرام

برای جزئیات ربات تلگرام کلیک کنید

نحوه استفاده

پنل وب از طریق ربات تلگرام از گزارش ترافیک روزانه، ورود به پنل، پشتیبان‌گیری از پایگاه داده، وضعیت سیستم، اطلاعات کاربر و سایر اعلان‌ها و عملکردها پشتیبانی می‌کند. برای استفاده از ربات، باید پارامترهای مربوط به ربات را در پنل تنظیم کنید، از جمله:

  • توکن تلگرام
  • شناسه چت ادمین(ها)
  • زمان اعلان (با سینتکس cron)
  • اعلان تاریخ انقضا
  • اعلان سقف ترافیک
  • پشتیبان‌گیری از پایگاه داده
  • اعلان بار CPU

سینتکس مرجع:

  • 30 * * * * * - اعلان در ثانیه ۳۰ هر دقیقه
  • 0 */10 * * * * - اعلان در ثانیه اول هر ۱۰ دقیقه
  • @hourly - اعلان ساعتی
  • @daily - اعلان روزانه (ساعت ۰۰:۰۰ بامداد)
  • @weekly - اعلان هفتگی
  • @every 8h - اعلان هر ۸ ساعت

ویژگی‌های ربات تلگرام

  • گزارش دوره‌ای
  • اعلان ورود
  • اعلان آستانه CPU
  • آستانه برای زمان انقضا و ترافیک برای گزارش پیشاپیش
  • پشتیبانی از منوی گزارش کلاینت در صورتی که نام کاربری تلگرام کلاینت به تنظیمات کاربر اضافه شده باشد
  • پشتیبانی از گزارش ترافیک تلگرام با جستجوی UUID (VMESS/VLESS) یا رمز عبور (TROJAN) - به صورت ناشناس
  • ربات مبتنی بر منو
  • جستجوی کلاینت با ایمیل (فقط ادمین)
  • بررسی تمام ورودی‌ها
  • بررسی وضعیت سرور
  • بررسی کاربران منقضی شده
  • دریافت پشتیبان بر اساس درخواست و در گزارش‌های دوره‌ای
  • ربات چند زبانه

راه‌اندازی ربات تلگرام

  • Botfather را در حساب تلگرام خود شروع کنید: Botfather

  • یک ربات جدید با استفاده از دستور /newbot ایجاد کنید: از شما ۲ سوال پرسیده می‌شود، یک نام و یک نام کاربری برای ربات شما. توجه داشته باشید که نام کاربری باید با کلمه "bot" خاتمه یابد. Create new bot

  • رباتی را که تازه ایجاد کرده‌اید، شروع کنید. می‌توانید لینک ربات خود را اینجا پیدا کنید. token

  • وارد پنل خود شوید و تنظیمات ربات تلگرام را مانند زیر پیکربندی کنید: Panel Config

توکن ربات خود را در فیلد ورودی شماره ۳ وارد کنید. شناسه کاربری را در فیلد ورودی شماره ۴ وارد کنید. حساب‌های تلگرامی با این شناسه، ادمین ربات خواهند بود. (می‌توانید بیش از یک شناسه وارد کنید، فقط آنها را با , جدا کنید)

  • چگونه شناسه کاربری تلگرام را دریافت کنیم؟ از این ربات استفاده کنید، ربات را شروع کنید و شناسه کاربری تلگرام را به شما خواهد داد. User ID

مسیرهای API

برای جزئیات مسیرهای API کلیک کنید

مستندات کامل

  • مستندات تعاملی درون پنل: مستقیماً در مسیر /panel/docs در رابط وب پنل TX-UI در دسترس است.
  • مشخصات کامل API و نمونه کدها: مشاهده API.md
  • مجموعه پست‌من (Postman)
  • احراز هویت: ارسال POST /login با { "username": "admin", "password": "..." } کوکی سشن را تنظیم می‌کند.

API کاربران (/panel/api/clients)

متد مسیر عمل
GET "/list" دریافت تمام کاربران با جزئیات و لینک‌های ورودی
GET "/get/:id" دریافت اطلاعات یک کاربر با شناسه
POST "/create" ایجاد کاربر جدید با گذرواژه‌های اختصاصی پروتکل‌ها (password, ssPassword, masquePass, auth, secret, privateKey, publicKey, preSharedKey)
POST "/bulkCreate" ایجاد گروهی کاربران
POST "/update/:id" به‌روزرسانی تنظیمات کاربر
POST "/del/:id" حذف کاربر
POST "/bulkDel" حذف گروهی کاربران
POST "/:id/toggle" فعال یا غیرفعال کردن کاربر
GET "/:id/links" دریافت ورودی‌های متصل به کاربر
POST "/:id/addLink" اتصال کاربر به ورودی
POST "/:id/setLinks" تنظیم تمام ورودی‌های متصل به کاربر
POST "/:id/removeLink/:inboundId" حذف اتصال به ورودی مشخص
GET "/:id/traffic" دریافت آمار لحظه‌ای ترافیک
POST "/:id/resetTraffic" بازنشانی ترافیک کاربر
POST "/resetAllTraffics" بازنشانی ترافیک تمام کاربران
POST "/delDepleted" حذف تمام کاربران منقضی شده یا تمام شده
GET "/:id/devices" دریافت سابقه دستگاه‌های متصل (IP، سیستم‌عامل، برنامه)
POST "/:id/clearDevices" پاکسازی تاریخچه دستگاه‌های متصل

API ورودی‌ها (/panel/api/inbounds)

متد مسیر عمل
GET "/list" دریافت تمام ورودی‌ها
GET "/get/:id" دریافت ورودی با شناسه inbound.id
GET "/getClientTraffics/:email" دریافت ترافیک کاربر بر اساس ایمیل
GET "/getClientTrafficsById/:id" دریافت ترافیک کاربر با شناسه
POST "/add" افزودن ورودی جدید
POST "/del/:id" حذف ورودی
POST "/update/:id" به‌روزرسانی تنظیمات ورودی
POST "/reorder" مرتب‌سازی مجدد ورودی‌ها
POST "/clientIps/:email" لاگ آدرس‌های IP کاربر
POST "/clearClientIps/:email" پاکسازی لاگ آدرس‌های IP کاربر
POST "/updateClientTraffic/:email" ویرایش دستی ترافیک کاربر (بایت)
POST "/:id/resetClientTraffic/:email" بازنشانی ترافیک کاربر در یک ورودی
POST "/resetAllTraffics" بازنشانی ترافیک تمام ورودی‌ها
POST "/resetAllClientTraffics/:id" بازنشانی ترافیک کاربران در ورودی (-1: همه)
POST "/delDepletedClients/:id" حذف کاربران منقضی در ورودی (-1: همه)
POST "/onlines" دریافت لیست ایمیل کاربران آنلاین
POST "/depleted" دریافت لیست ایمیل کاربران تمام شده
POST "/disabled" دریافت لیست ایمیل کاربران غیرفعال

API سرور و سیستم (/panel/api/server)

متد مسیر عمل
GET "/status" دریافت وضعیت CPU، حافظه، دیسک و هسته Xray
POST "/restartXrayService" راه‌اندازی مجدد هسته Xray
POST "/stopXrayService" متوقف کردن هسته Xray
POST "/rollbackXrayConfig" بازگردانی پیکربندی Xray به آخرین وضعیت کارکرد
GET "/getRollbackStatus" وضعیت و علت بازگردانی پیکربندی
GET "/getXrayVersion" نسخه نصب شده هسته Xray
GET "/getConfigJson" دریافت فایل config.json فعال
GET "/getDb" دانلود فایل پشتیبان دیتابیس SQLite
POST "/importDB" بازگردانی دیتابیس از فایل پشتیبان
POST "/logs/:count" مشاهده لاگ‌های وب‌پنل
POST "/xraylogs/:count" مشاهده لاگ‌های هسته Xray
GET "/getNewUUID" تولید یک UUID v4 تصادفی
GET "/getNewX25519Cert" تولید جفت‌کلید Reality X25519
POST "/installPanel" نصب یا ارتقای پکیج پنل

API تنظیمات و نگهداری دیتابیس (/panel/setting)

متد مسیر عمل
POST "/all" دریافت تمامی تنظیمات پنل
POST "/update" ذخیره و به‌روزرسانی تنظیمات
POST "/restartPanel" راه‌اندازی مجدد پردازه وب پنل
POST "/dbStatus" وضعیت سلامت، حجم دیتابیس و لاگ WAL
POST "/optimizeDatabase" بهینه‌سازی دیتابیس (WAL truncate و PRAGMA optimize)
POST "/vacuumDatabase" فشرده‌سازی و آزادسازی فضای دیسک با VACUUM
POST "/cleanDatabase" شناسایی و پاکسازی ردیف‌های یتیم یا خراب

API پیکربندی پیشرفته Xray (/panel/xray)

متد مسیر عمل
POST "/" دریافت تنظیمات پیشرفته قالب Xray JSON
POST "/update" اعتبارسنجی و ذخیره تنظیمات پیشرفته
POST "/rollback" بازگردانی به آخرین پیکربندی کارآمد
GET "/getRollbackStatus" دریافت پرچم وضعیت و دلیل بازگردانی
POST "/testOutbound" تست اتصال و پینگ خروجی‌ها
GET "/getOutboundsTraffic" آمار تجمیعی ترافیک خروجی‌ها
POST "/resetOutboundsTraffic" بازنشانی شمارنده ترافیک خروجی‌ها

متغیرهای محیطی

برای جزئیات متغیرهای محیطی کلیک کنید

نحوه استفاده

متغیر نوع پیش‌فرض
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"

مثال:

XUI_BIN_FOLDER="bin" XUI_DB_FOLDER="/etc/x-ui" go build main.go

رابط کاربری اشتراک

می‌توانید از این ریپازیتوری برای ایجاد یک رابط کاربری اشتراک برای پنل خود استفاده کنید TX-UI Theming Hub

سپاس‌گزاری

  • Iran v2ray rules (مجوز: GPL-3.0): قوانین مسیریابی پیشرفته v2ray/xray و v2ray/xray-clients با دامنه‌های ایرانی داخلی و تمرکز بر امنیت و مسدود کردن تبلیغات.
  • Russia v2ray rules (مجوز: GPL-3.0): این ریپازیتوری شامل قوانین مسیریابی V2Ray است که به طور خودکار بر اساس داده‌های دامنه‌ها و آدرس‌های مسدود شده در روسیه به‌روز می‌شود.

ستاره‌دهندگان در طول زمان

Stargazers over time