Skip to content

VikumKarunathilake/3x-ui-monitor

Repository files navigation

3X-UI Monitor


A modern web interface for monitoring 3X-UI client usage statistics

Next.js React Tailwind CSS TypeScript shadcnui

Features

  • 📊 Real-time Usage Monitoring: View upload, download, and total usage statistics
  • 🎯 Client Identification: Supports VLESS protocol only (UUID and V2Ray config URLs)
  • 🚀 Modern UI: Clean, responsive interface built with Tailwind CSS
  • 🔒 Secure: Rate limiting and input validation
  • 📱 Mobile Friendly: Responsive design that works on all devices

Screenshots

Home Screenshot Usage Statistics Screenshot

Quick Installation

One-command installation (requires sudo privileges):

bash <(curl -Ls https://raw.githubusercontent.com/VikumKarunathilake/3x-ui-monitor/master/install.sh)

The installation script will:

  • Install Node.js
  • Set up a systemd service
  • Configure proper permissions
  • Start the 3X-UI Monitor service

Usage

  1. Open the application in your web browser

  2. Enter your client information:

    • VLESS protocol only
    • UUID (e.g., 12345678-1234-1234-1234-123456789012)
    • V2Ray config URL (e.g., vless://uuid@domain.com:443?security=tls)
  3. View usage statistics including:

    • Upload/Download traffic
    • Total data allowance
    • Remaining data
    • Account status and expiry

Note: This tool is designed to work only with the VLESS protocol.

Systemd Service

The installation creates a systemd service for easy management:

Start service:

sudo systemctl start 3x-ui-monitor

Stop service:

sudo systemctl stop 3x-ui-monitor

Check status:

sudo systemctl status 3x-ui-monitor

View logs:

journalctl -u 3x-ui-monitor -f

Contributing

This project is licensed under Creative Commons Attribution-NoDerivs (CC-BY-ND). This means:

  • ✅ You can use and redistribute this software
  • ✅ You must give appropriate credit to the original author
  • ❌ You cannot distribute modified versions without permission

For modification requests, please contact the maintainer.

License

This project is licensed under the Creative Commons Attribution-NoDerivs 4.0 International License (CC-BY-ND-4.0).

CC BY-ND 4.0

Support

If you find this project useful, please consider giving it a star ⭐ on GitHub!

Stargazers over time

Stargazers over time

Disclaimer: This project is not affiliated with the official 3X-UI project. It is a third-party monitoring interface.

About

A modern web interface for monitoring 3X-UI client usage statistics

Topics

Resources

License

Stars

Watchers

Forks