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
NewYork
这是什么？X4G 是一个快速、现代的网关，用于通过 WebSocket 和 XHTTP 隧道传输 VLESS，内置 HTTP 代理、管理仪表盘、Telegram 管理机器人，以及可分享的分组配置订阅页面。
这是 VPN 客户端，还是需要我自己运行的服务端？它是需要你自己部署（例如部署在 Railway 上）的服务端代理/隧道网关，不是客户端应用；部署后你可以用任何支持 VLESS 的客户端连接它，比如 v2rayNG、NekoBox 或 Streisand。
这个怎么部署？在 GitHub 上 fork 仓库，然后在 Railway 中进入 New Project → Deploy from GitHub repo 并选择你的 fork；Railway 会自动构建并部署，之后你为该服务启用一个公开域名即可。
使用它需要 Telegram 机器人 token 吗？不需要，Telegram 管理机器人是可选的；只有当你想通过 Telegram 而不是网页仪表盘管理配置时，才需要设置 TELEGRAM_BOT_TOKEN 和 TELEGRAM_ADMIN_IDS。
重启后我的配置和设置还在吗？只有给 DATA_DIR 路径（默认 /data）挂载一个持久化的 Railway Volume 才行；否则所有状态——包括配置、统计和管理密码——都只存在于当前容器中，重新部署或重启时会被清空。
这里的 VLESS 可以跑在哪些传输协议上？X4G 支持 VLESS over WebSocket 以及两种 XHTTP 模式（packet-up 和 stream-up），每个配置可单独选择。
能按链接限制流量、速度和并发用户吗？可以，每条生成的链接都可以设置自己的流量上限（KB/MB/GB）、带宽限速（Mbps）、并发 IP/用户数限制，以及按天计算的自动过期时间。
什么是 sub group？订阅分组把多个配置打包到一个公开（可选密码保护）页面上，展示所有配置的实时状态、用量和二维码，而不是一条单纯的 base64 订阅链接。
怎么登录管理仪表盘？使用 ADMIN_PASSWORD 环境变量登录，如果你没有自行设置，默认密码为 “X4GKING”。
What are similar projects?CFNext, vodiwalker_panel, nyx, RVG, Open-Box, back4app-vless, CF-Workers-TGProxy, SuperJinX
Which topics is it in?proxy-server, telegram-bot, vless, qr-code, tunnel, anti-censorship, censorship-circumvention, vpn, websocket, http, encryption, proxy
Creator
x4gpanell
Size
0.1 MB
Stars
1.2K
Updated
CommitSep 21
Age
2mo
Commits · 90 Days