X-UI Subscription Template

A premium, modern, bilingual subscription page for 3x-ui / X-UI panel.

🇮🇷 مستندات فارسی

---

About

A beautifully crafted, production-ready subscription page template for X-UI panels. Features glassmorphism UI, dark/light themes, bilingual English/Persian support, animated circular usage gauge, traffic statistics, QR code generation, quick client import, and a fully responsive design — all in a single HTML file with zero dependencies.

---

Features

Feature	Description
Glassmorphism UI	Frosted glass cards, soft shadows, gradient accents
Dark / Light Theme	Auto-detect + manual toggle with persistence
Bilingual	English & Persian (RTL) with one-click switch
Usage Gauge	Animated SVG circular progress with gradient colors
Traffic Stats	Download, Upload, Used, Total, Remaining
Remaining Time	Live countdown with color-coded status
Quick Links	One-click import to V2RayNG, Happ, Incy
QR Code	Instant QR generation for subscription link
Config Links	JSON & Clash configs with copy and QR
Download Clients	Curated list for Android, Windows, iOS
Responsive	Mobile, tablet, desktop, 4K displays
Zero Dependencies	Pure HTML, CSS, JavaScript

---

Requirements

• X-UI Panel (3x-ui or x-ui) installed and running
• Ubuntu 20.04, 22.04, or 24.04
• Root access (sudo)
• curl or wget (usually pre-installed)

---

Quick Install

One-line install with curl:

bash <(curl -fsSL https://raw.githubusercontent.com/proxystore11/x-ui-sub-template/main/install.sh)

One-line install with wget:

bash <(wget -qO- https://raw.githubusercontent.com/proxystore11/x-ui-sub-template/main/install.sh)

---

Installation

Automatic (Recommended)

Run the installer script:

sudo bash install.sh

The script will:

1. Check for root privileges
2. Detect your Ubuntu version
3. Create /etc/x-ui/sub/ directory
4. Download the latest sub.html from GitHub
5. Verify the download
6. Install to /etc/x-ui/sub/sub.html
7. Set proper permissions (chmod 644)

Manual

# Create directory
sudo mkdir -p /etc/x-ui/sub

# Download sub.html
sudo curl -fsSL -o /etc/x-ui/sub/sub.html \
  https://raw.githubusercontent.com/proxystore11/x-ui-sub-template/main/sub.html

# Set permissions
sudo chmod 644 /etc/x-ui/sub/sub.html

---

Update

One-line update:

sudo bash <(curl -fsSL https://raw.githubusercontent.com/proxystore11/x-ui-sub-template/main/update.sh)

Or run locally:

sudo bash update.sh

The updater creates a backup before updating and restores it automatically if the download fails.

---

Uninstall

One-line uninstall:

sudo bash <(curl -fsSL https://raw.githubusercontent.com/proxystore11/x-ui-sub-template/main/uninstall.sh)

Or run locally:

sudo bash uninstall.sh

This only removes /etc/x-ui/sub/sub.html and does not affect any other X-UI files.

---

Directory Structure

Repository Structure

x-ui-sub-template/
├── README.md           # English documentation
├── README_FA.md        # Persian documentation
├── LICENSE             # MIT License
├── install.sh          # Installer script
├── update.sh           # Updater script
├── uninstall.sh        # Uninstaller script
└── sub.html            # Subscription template

After Installation

/etc/x-ui/
└── sub/
    └── sub.html        # Installed template

---

Usage

1. Install the template using one of the methods above
2. Open your X-UI panel web interface
3. Navigate to Panel Settings → Subscription
4. Set the subscription path to:

/sub/sub.html

5. Save the settings
6. Test your subscription link

Note: The template automatically detects the language based on the user's browser settings and supports both English (LTR) and Persian (RTL) layouts.

---

Screenshots

Light Theme

Dark Theme

---

Support

If you need help or have questions:

1. Check the documentation — Read through this README and the Persian README
2. Search existing issues — Your question may already be answered
3. Open a GitHub Issue — This is the preferred way to get help and is explained in detail below

We are committed to providing support through GitHub Issues. Opening an Issue ensures your question is visible to the community and helps us track and resolve problems efficiently.

---

Reporting Issues

Found a bug or have a suggestion? We'd love to hear from you!

Please open a GitHub Issue for:

• 🐛 Bugs — Something isn't working correctly
• 🛠️ Installation problems — Script fails or produces errors
• 💡 Feature requests — New functionality you'd like to see
• 🔗 Compatibility issues — Problems with specific X-UI versions
• 🎨 UI improvements — Design suggestions or visual issues
• 🌐 Translation corrections — Errors in English or Persian text

Tip: When reporting a bug, please include your Ubuntu version, X-UI version, and any error output. This helps us resolve issues faster.

Opening an Issue is the preferred way to receive support and helps us improve the project for everyone.

---

License

This project is licensed under the MIT License.

MIT License — Free to use, modify, and distribute.

---

Credits

• Fonts — Vazirmatn by Seyed Kazemi
• QR Code API — goqr.me
• Design — Inspired by modern glassmorphism trends
• Community — Thanks to all contributors and users

---

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