SideRail README

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

SideRail

Deploy on Railway

License   Xray-core   TypeScript   React + Vite

Protocols   Transports



A bold, neobrutalist VPN control panel — powered by Xray-core and shipped to Railway in one click.

Clean client links. Live stats. Gorgeous subscription pages. No config, no fuss.


[!TIP] Fork → Deploy on Railway → Expose port 8080 → Open the panel. Four steps, zero config, live in minutes.


Why SideRail

One job, done right

No feature bloat. SideRail masters HTTP-based transports behind a TLS edge — every link is clean, standard, and always security=tls on port 443.

Impossible to ignore

A loud neobrutalist UI — thick borders, hard shadows, animated icons — that looks razor-sharp on phone and desktop alike.

Deploy and forget

Xray-core pulls itself on first boot, the session secret is generated for you, and the DB just works. Zero environment variables required.

Team-friendly

The Owner adds Admins with scoped page access and personal data quotas — and every Admin only ever sees the users they created.

Features
Dashboard Live CPU, RAM, Swap and Storage metrics, plus one-click Backup & Restore of users, inbounds, admins and settings.
Users Rich create form, summary cards, a fully responsive table, live Connected IPs, and per-user actions.
Inbounds Five HTTP inbounds auto-seeded on first boot. Enable or disable only, each with a unique port and /SideRail/... path.
Activity Log A live timeline of every administrative event.
Settings & Admins Owner and Admin roles, scoped permissions, and per-admin data quotas.
Subscription A gorgeous per-user page with a live usage chart, QR codes and a base64 subscription for clients.
Security JWT sessions, built-in rate limiting, and sniffing fully disabled to prevent the QUIC crash.

Deploy on Railway

No code required. Just follow these steps:

1. Fork this repository — click Fork at the top-right to copy it to your GitHub account.

2. Create a Railway project — head to railway.app, then New Project → Deploy from GitHub repo, and pick your fork.

3. Deploy — Railway reads the Dockerfile and railway.json and builds automatically.

4. Expose port 8080 — open Settings → Networking → Generate Domain, and set the port to 8080.

[!IMPORTANT] SideRail listens on port 8080 — this is the only port you expose. The ports 10085 and 20000–20004 are Xray's internal ports bound to 127.0.0.1; they are private and must not be exposed.

5. Add a volume (optional) — attach a Volume at /data so users, admins and settings survive redeploys.

6. Open your panel — visit the generated *.up.railway.app domain, land on the Setup page, and create your Owner account.


Environment variables

All optional.

Variable Default Description
PORT 8080 HTTP port. Expose this one on Railway.
JWT_SECRET auto Signs admin session cookies. Auto-generated and persisted if unset.
XRAY_VERSION v26.9.9 Xray-core release fetched on first boot.
SIDERAIL_DATA_DIR /data Persistent data directory (mount a volume here).
PUBLIC_DOMAIN auto Override for a custom domain. Falls back to RAILWAY_PUBLIC_DOMAIN.
XRAY_API_PORT 10085 Internal Xray stats API port.
XRAY_INBOUND_BASE_PORT 20000 Base port for internal inbound listeners.

Architecture 
apps/
├─ web/           React + Vite + Tailwind (neobrutalism) frontend
│  └─ src/
│     ├─ components/ui/   Reusable neobrutalist primitives
│     ├─ pages/           Dashboard · Users · Inbounds · Activity · Settings · Setup · Login · Subscription
│     └─ lib/             API client, auth context, helpers
└─ server/        Express + Node (node:sqlite) backend
   └─ src/
      ├─ xray.ts          Binary fetch, process manager, traffic stats, client IPs
      ├─ xray-config.ts   Config builder (sniffing fully disabled)
      ├─ tunnel.ts        WS/HTTPUpgrade via net.Socket, XHTTP via http-proxy
      ├─ links.ts         VLESS/VMess/Trojan link generation
      ├─ inbounds.ts      Default inbound seeding + enable/disable
      ├─ users.ts         User model, traffic reset, sub-token logic
      ├─ auth.ts          Owner/Admin roles, permissions, sessions
      ├─ ratelimit.ts     Rate limiting / brute-force protection
      └─ routes.ts        Authenticated REST API

How traffic flows — TLS is terminated at the Railway edge; all client links use security=tls on port 443. The Node process routes WebSocket/HTTPUpgrade to Xray via raw net.Socket, and XHTTP through an HTTP proxy. Only ws, httpupgrade and xhttp are supported — raw TCP, gRPC, WireGuard and Hysteria are intentionally left out because they don't survive the edge.


Local development

Requires Node.js ≥ 22.5 (Node 24 recommended).

npm install     # install all workspaces
npm run dev     # web on :5173, server on :8080 (proxied)

npm run build   # production build (web + server)
npm start       # serve API + built frontend on :8080

Star history Star History Chart

Support the project

Countless late nights and a lot of coffee went into this. If SideRail powers your setup, a small crypto tip goes straight back into keeping it fast, secure and free for everyone.

Bitcoin bc1qx48j9lj989y5c9z8ewpgul2ed69mr50j97a0sk
Ethereum 0xF2ba522fD846F83D84131D433f56F885740cFc47
Litecoin ltc1qh6y8ld27fdleuy3r7gykxxg38rkawl7adzc0dw
TON UQBGN4jXPW44cWQ20EGWqX7sU6K4RlYbnolc3IHoT3UWtmvW

License & Copyright

SideRail is proprietary software. © 2025 icubaby — all rights reserved.

It is published for transparency and personal self-hosting only. You are welcome to fork and run your own instance, but the following are strictly prohibited without prior written permission:

The source code carries embedded authorship identifiers and watermarks used to prove origin.

Full license terms


License

SideRail (icubaby/SideRail)

Searching Database…

586 ·GitHub
SideRail
Что это?SideRail — веб-панель управления в стиле необрутализма для VPN-серверов на Xray-core, разворачиваемая на Railway в один клик: аккуратные клиентские ссылки, живая статистика и страницы подписок без ручной настройки.
Это хостинг-сервис или что-то, что я запускаю сам?Это self-hosted: вы делаете форк репозитория и разворачиваете собственный экземпляр на Railway (или любом Docker-хосте) — SideRail не SaaS, на который можно подписаться.
Как это запустить?Сделайте форк репозитория, создайте из форка проект Railway, дайте Railway автоматически собрать приложенный Dockerfile, затем откройте порт 8080 и зайдите на сгенерированный домен, чтобы создать аккаунт Owner.
Нужно ли самому настраивать Xray или переменные окружения?Нет — Xray-core скачивается сам при первом запуске, а секрет сессии генерируется автоматически, так что все переменные окружения опциональны. Запуск вне Docker требует Node.js 22.5+ (рекомендуется Node 24), но Dockerfile в Railway сделает это за вас.
Какие VPN-протоколы он реально поддерживает?Только HTTP-транспорты за TLS-гранью — WebSocket, HTTPUpgrade и XHTTP, всегда на порту 443. Raw TCP, gRPC, WireGuard и Hysteria намеренно исключены: они не выживают на краю Railway.
Можно ли перепродавать панель или выдавать её за свой продукт?Нет — SideRail проприетарное ПО. Форкнуть и self-host для личного использования можно, но продавать его, переклеивать брендинг или удалять встроенное указание авторства и водяные знаки строго запрещено.
Что показывает админ-дашборд?Живые метрики CPU, RAM, Swap и Storage, а также Backup и Restore в один клик, охватывающие пользователей, inbounds, админов и настройки.
Как устроена работа нескольких админов?Owner может добавлять Admins с ограниченным доступом к страницам и личными квотами данных; каждый Admin видит только тех пользователей, которых создал сам.
Что пользователи получают на странице подписки?Персональную страницу с живым графиком использования, QR-кодами и base64-ссылкой на подписку, которую VPN-клиенты импортируют напрямую.
Переживут ли мои данные передеплой?Только если подключите Railway Volume к /data — это опционально, но сохраняет пользователей, админов и настройки между передеплоями.
What are similar projects?nyx, SuperJinX, RVG, v2ray-agent, V2rayU, v2ray, Xray-core, Open-Box
Which topics is it in?xray-core, rate-limiting, xray, vmess, vless, trojan, qr-code, jwt, admin-dashboard, backup, tls, vpn
Creator
icubaby
Size
0.3 MB
Stars
586
Updated
CommitOct 11Releasev3.0.0Oct 11
Age
27d
Commits · 90 Days