NewYork README

The project's README from github.com/x4gpanell/NewYork. As one markdown file: README.md.

کانال یوتوب : https://www.youtube.com/@X4GHUB

🚀 X4G

دروازه (Gateway) سریع و مدرن برای تونل‌زنی VLESS روی WebSocket و XHTTP + HTTP Proxy، با داشبورد مدیریتی زیبا، ربات مدیریت تلگرام، صفحات ساب حرفه‌ای و قابلیت ساخت لینک‌های اختصاصی با محدودیت ترافیک، سرعت و آی‌پی.

✨ ویژگی‌ها

1️⃣ Fork روی گیت‌هاب

ابتدا روی دکمه Fork کلیک کنید تا این ریپازیتوری را به حساب خود منتقل کنید.

2️⃣ Deploy روی Railway

  1. وارد سایت Railway.app شوید.
  2. روی New Project → Deploy from GitHub repo کلیک کنید.
  3. ریپازیتوری Fork شده را انتخاب کنید.
  4. Railway به‌صورت خودکار پروژه را Deploy می‌کند.

💡 پس از دیپلوی، یک دامنه عمومی (Public Domain) برای سرویس خود از تنظیمات Railway فعال کنید تا متغیر RAILWAY_PUBLIC_DOMAIN به‌درستی مقداردهی شود.

💾 ذخیره‌سازی دائمی (Volume)

وضعیت سرویس (کانفیگ‌ها، آمار مصرف، گروه‌های ساب، رمز ادمین) روی فایل x4g_state.json داخل مسیر DATA_DIR (پیش‌فرض /data) ذخیره می‌شود. برای این‌که این اطلاعات با هر ری‌استارت یا دیپلوی جدید روی Railway از بین نرود، حتماً یک Volume بسازید و آن را روی همان مسیر (/data) به سرویس متصل کنید (از تنظیمات سرویس → بخش Volumes). بدون این کار، اطلاعات فقط روی همان کانتینر فعلی می‌مانند و با تعویض کانتینر پاک می‌شوند.

3️⃣ اتصال به کانفیگ‌ها

پس از دیپلوی موفق:

  1. به آدرس https://your-app.up.railway.app/dashboard بروید.
  2. در صفحه داشبورد کلی، لینک VLESS پیش‌فرض (بدون محدودیت) را مشاهده و کپی کنید.
  3. این لینک را در کلاینت دلخواه (v2rayNG، NekoBox، Streisand و...) وارد کنید.
  4. برای ساخت لینک‌های جداگانه با محدودیت ترافیک، سرعت، آی‌پی و... به بخش مدیریت لینک‌ها بروید.

🔧 تنظیمات دستی هر کانفیگ

هنگام ساخت یا ویرایش هر کانفیگ می‌توانید این موارد را جداگانه تنظیم کنید:

🗂 گروه‌های ساب (لینک ساب حرفه‌ای)

به‌جای لینک ساب ساده (/sub/{uuid} که فقط متن base64 کانفیگ رو برمی‌گردونه)، می‌تونید چند کانفیگ رو داخل یک گروه ساب قرار بدید تا یک صفحه‌ی عمومی و زیبا (/p/{uuid_key}) براشون ساخته بشه؛ شامل نمایش گرافیکی لیست کانفیگ‌ها، وضعیت هرکدوم، مصرف و QR Code، و در صورت نیاز قابل رمزدار کردن با پسورد. برای ساخت این لینک:

  1. به بخش «گروه‌های ساب» در پنل (یا از طریق ربات تلگرام) بروید.
  2. یک گروه جدید بسازید.
  3. کانفیگ(های) مورد نظر را داخل همان گروه اضافه کنید.
  4. لینک صفحه‌ی عمومی گروه را از همان‌جا کپی کنید.

🤖 ربات مدیریت تلگرام (اختیاری)

اگر می‌خواهید بدون باز کردن پنل وب، از طریق تلگرام کانفیگ‌ها را مدیریت کنید:

  1. دو متغیر محیطی زیر را در تنظیمات سرویس Railway اضافه کنید:
    • TELEGRAM_BOT_TOKEN — توکن ربات از @BotFather
    • TELEGRAM_ADMIN_IDS — آیدی عددی تلگرام ادمین‌های مجاز، جدا شده با کاما (مثلاً 123456789,987654321)
  2. بعد از ری‌استارت سرویس، به ربات پیام /start بدهید.

امکانات ربات:

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

متغیر توضیح پیش‌فرض
ADMIN_PASSWORD رمز عبور ورود به داشبورد وب X4GKING
SECRET_KEY کلید امضای سشن/پسورد؛ اگر تنظیم نشود، خودکار ساخته و روی دیسک ذخیره می‌شود —
DATA_DIR مسیر ذخیره‌سازی وضعیت (نیازمند Volume دائمی) /data
TELEGRAM_BOT_TOKEN توکن ربات تلگرام (اختیاری) —
TELEGRAM_ADMIN_IDS آیدی عددی ادمین‌های مجاز ربات، جدا با کاما (اختیاری) —
RAILWAY_PUBLIC_DOMAIN دامنه عمومی سرویس؛ به‌صورت خودکار توسط Railway تنظیم می‌شود localhost

⚠️ نکته مهم

اگرچه وضعیت سرویس (کانفیگ‌ها، آمار، گروه‌های ساب) روی دیسک ذخیره می‌شود، اما بدون اتصال یک Volume دائمی به مسیر DATA_DIR، این اطلاعات فقط داخل همان کانتینر فعلی باقی می‌مانند و با تعویض/بازسازی کانتینر روی Railway از بین می‌روند. حتماً طبق راهنمای بخش «ذخیره‌سازی دائمی» بالا، یک Volume متصل کنید.


X4G · پشتیبانی: @Farajian2004f

NewYork (x4gpanell/NewYork)

Searching Database…

1.2K ·GitHub
Что это?X4G — быстрый современный шлюз для туннелирования VLESS через WebSocket и XHTTP со встроенным HTTP-прокси, панелью управления, админ-ботом в Telegram и общедоступными страницами подписки для групповых конфигов.
Это VPN-клиент или сервер, который я запускаю сам?Это серверный прокси/туннельный шлюз, который вы разворачиваете сами (например, на Railway), а не клиентское приложение; подключаться к нему нужно любым клиентом с поддержкой VLESS, например v2rayNG, NekoBox или Streisand.
Как это развернуть?Сделайте форк репозитория на GitHub, затем в Railway перейдите в New Project → Deploy from GitHub repo и выберите свой форк; Railway соберёт и развернёт его автоматически, после чего включите публичный домен для сервиса.
Нужен ли токен Telegram-бота для использования?Нет, админ-бот в Telegram опционален; TELEGRAM_BOT_TOKEN и TELEGRAM_ADMIN_IDS нужно задать, только если хотите управлять конфигами из Telegram, а не из веб-панели.
Переживут ли конфиги и настройки перезапуск?Только если подключите постоянный Railway Volume к пути DATA_DIR (по умолчанию /data); иначе всё состояние, включая конфиги, статистику и админ-пароль, живёт лишь в текущем контейнере и стирается при пересборке или перезапуске.
По каким транспортным протоколам здесь может работать VLESS?X4G поддерживает VLESS через WebSocket и два режима XHTTP (packet-up и stream-up), выбираемые отдельно для каждого конфига.
Можно ли ограничить трафик, скорость и число одновременных пользователей для каждой ссылки?Да, у каждой сгенерированной ссылки может быть свой лимит трафика в КБ/МБ/ГБ, ограничение полосы в Мбит/с, лимит одновременных IP/пользователей и автоматический срок действия в днях.
Что такое sub group?Sub group объединяет несколько конфигов на одной публичной (опционально защищённой паролем) странице с живым статусом, использованием и QR-кодами для всех, вместо простой base64-ссылки подписки.
Как войти в админ-панель?Вход по переменной окружения ADMIN_PASSWORD, которая по умолчанию равна 'X4GKING', если не задать свою.
Creator
x4gpanell
Size
0.1 MB
Stars
1.2K
Updated
CommitSep 21
Age
2mo
Commits · 90 Days