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)

proxy-server
Searching Database…

1.2K ·GitHub
What is this?X4G is a fast, modern gateway for tunneling VLESS over WebSocket and XHTTP, with a built-in HTTP proxy, a management dashboard, a Telegram admin bot, and shareable subscription pages for grouped configs.
Is this a VPN client or a server I run myself?It is a server-side proxy/tunnel gateway that you deploy yourself (for example on Railway), not a client app; you then connect to it with any VLESS-capable client such as v2rayNG, NekoBox, or Streisand.
How do I deploy this?Fork the repo on GitHub, then in Railway go to New Project → Deploy from GitHub repo and pick your fork; Railway builds and deploys it automatically, after which you enable a public domain for the service.
Do I need a Telegram bot token to use it?No, the Telegram admin bot is optional; you only need to set TELEGRAM_BOT_TOKEN and TELEGRAM_ADMIN_IDS if you want to manage configs from Telegram instead of the web dashboard.
Will my configs and settings survive a restart?Only if you attach a persistent Railway Volume to the DATA_DIR path (default /data); otherwise all state, including configs, stats, and the admin password, lives only in the current container and is wiped on redeploy or restart.
What transport protocols can VLESS run over here?X4G supports VLESS over WebSocket and two XHTTP modes (packet-up and stream-up), selectable individually per config.
Can I limit traffic, speed, and concurrent users per link?Yes, each generated link can have its own traffic cap in KB/MB/GB, a bandwidth throttle in Mbps, a concurrent IP/user limit, and an automatic expiry in days.
What is a sub group?A sub group bundles several configs into one public (optionally password-protected) page showing live status, usage, and QR codes for all of them, instead of a plain base64 subscription link.
How do I log into the admin dashboard?Log in with the ADMIN_PASSWORD environment variable, which defaults to 'X4GKING' if you don't set your own.
Creator
x4gpanell
Size
0.1 MB
Stars
1.2K
Updated
CommitSep 21
Age
2mo
Commits · 90 Days