Skip to content

VortexUI Documentation

Next-generation proxy management panel
Core-agnostic · User-centric · Real-time · Anti-censorship

Welcome to the official VortexUI documentation. This site covers everything from installation to advanced operations for VortexUI v1.2.0 — the most feature-rich release yet, with 17 major features and 24 UX improvements.

Quick Install

bash <(curl -Ls https://raw.githubusercontent.com/iPmartNetwork/VortexUI/master/install.sh)
One command. Interactive setup. HTTPS included.

What's in v1.2.0

  • Self-Service Portal

    End-users login with their sub token, view usage, purchase renewals, and open support tickets.

  • Reality Scanner

    Built-in TLS probe — discover optimal SNIs for REALITY with latency scoring.

  • Smart Quota

    Progressive speed reduction instead of hard-cut. Configurable tiers per ISP.

  • Anti-Censorship Suite

    TLS Tricks (ISP profiles), probing protection, fingerprint validation, decoy websites, DoH.

  • Federation

    Connect multiple panels. Sync users and nodes. Single sign-on across your fleet.

  • Advanced Analytics

    Geo-IP breakdown, top users, peak hours, world map heatmap, CSV export.

Documentation Map

Section What you'll learn
Introduction Architecture, core concepts, comparison with other panels
Installation One-line install, Docker, native, node agent setup
First Steps Create first admin, add node, add users, verify
Dashboard Overview page, real-time charts, system gauges, widgets
Users CRUD, quotas, families, referrals, portal, subscriptions
Nodes Fleet management, auto-migration, health monitoring
Network Outbounds, routing, balancers, relay chains, SNI routing
Security TLS tricks, probing protection, fingerprint, decoy, DoH
Plans & Payments Plan system, gateways, orders, self-service purchase
Notifications Webhooks, Telegram, quota alerts, notification center
Settings Branding, backup, federation, deep links, updates
API Reference OpenAPI 3.0, authentication, endpoints
Protocols VLESS, VMess, Trojan, SS, Hysteria2, TUIC, WireGuard
Operations HTTPS, SSE, GeoIP, monitoring, scaling
Troubleshooting Common issues, FAQ, debug tips

Architecture

flowchart TB
    subgraph Clients["Clients"]
        Browser["Browser / PWA"]
        Portal["User Portal"]
        ProxyApp["Clash / sing-box / v2rayNG"]
    end
    subgraph Web["Web Layer"]
        Caddy["Caddy — HTTPS + SPA + DoH"]
    end
    subgraph Panel["Control Plane"]
        API["Panel API — Go 1.22+"]
        SSE["SSE — Live Events"]
        Scanner["Reality Scanner"]
        Migration["Auto-Migration Engine"]
        DB[(PostgreSQL + TimescaleDB)]
        Redis[(Redis — cache + sessions)]
    end
    subgraph Nodes["Node Fleet"]
        Local["Local Node (in-process)"]
        Remote1["Remote Node 1 — mTLS"]
        Remote2["Remote Node 2 — mTLS"]
        RemoteN["Remote Node N — mTLS"]
    end
    subgraph Federation["Federation"]
        Peer1["Peer Panel 1"]
        Peer2["Peer Panel 2"]
    end
    Browser --> Caddy
    Portal --> Caddy
    ProxyApp --> Caddy
    Caddy --> API
    API --> DB
    API --> Redis
    API --> Local
    API --> Remote1
    API --> Remote2
    API --> RemoteN
    API <--> Peer1
    API <--> Peer2

Tech Stack

Layer Technology
Backend Go 1.22+, Echo, gRPC, sqlc, pgx
Frontend React 18, TypeScript 5.6, Tailwind CSS, TanStack Query
Database PostgreSQL 16 + TimescaleDB
Cache Redis 7
Proxy Cores Xray-core, sing-box
Web Server Caddy (auto HTTPS)
Transport gRPC + mTLS (panel ↔ nodes)
Notifications Webhook (HMAC), Telegram Bot API
Monitoring Prometheus metrics + Grafana
Resource Link
GitHub Repository github.com/iPmartNetwork/VortexUI
Telegram Channel @vortex_ui
OpenAPI Spec openapi.yaml
Changelog CHANGELOG.md
Docker Hub ipmartnetwork/vortexui
Bug Reports GitHub Issues
Discussions GitHub Discussions

Languages

This documentation is available in English, فارسی, العربية, and Türkçe. Use the language selector in the header to switch.