ASUSWRT Merlin XrayUI

This repository provides a lightweight and efficient UI to manage your X-RAY Core services on routers running ASUSWRT-Merlin firmware.

[english] [русский]

Supported devices

In general, all devices that can run Merlin-WRT firmware (`384.15` or later, `3006.102.1` or later) are supported. Below is the list of models where xrayui has been proven to work:

• RT-AC66U
• RT-AC68U
• RT-AX58U
• TUF-AX5400
• RT-AX92U
• RT-AX86U
• RT-AX88U
• GT-AX11000
• GT-AXE11000
• GT-AX6000
• RT-AX86U Pro
• RT-AX88U Pro
• GT-AX11000 Pro
• RT-BE88U

Requirements

SSH Access

Access your router via SSH to execute installation commands.

Prerequisites

• Merlin firmware (384.15 or later, 3006.102.1 or later)
• Entware installed
  • you can use built-in amtm tool to install Entware

Installation

To install the latest version of ASUSWRT Merlin XrayUI, simply run the following command in your router’s SSH terminal:

wget -O /tmp/asuswrt-merlin-xrayui.tar.gz https://github.com/DanielLavrushin/asuswrt-merlin-xrayui/releases/latest/download/asuswrt-merlin-xrayui.tar.gz && rm -rf /jffs/addons/xrayui && tar -xzf /tmp/asuswrt-merlin-xrayui.tar.gz -C /jffs/addons && mv /jffs/addons/xrayui/xrayui /jffs/scripts/xrayui && chmod 0755 /jffs/scripts/xrayui && sh /jffs/scripts/xrayui install

How to uninstall

To uninstall and clean up run the command

/jffs/scripts/xrayui uninstall

Usage

Post-Installation Steps

• Log Out and Back In: After installing, log out from the router's browser UI and then log back in.
• Access the X-RAY Tab: Navigate to the VPN menu item in the router's web UI and look for the new tab labeled X-RAY.

Custom Scripts for Firewall Rules/IPTABLES

You can enhance the flexibility of your Xray configuration by adding custom scripts to handle specific firewall rules during Xray startup and shutdown. These scripts should be placed in the /jffs/xrayui_custom directory and named according to their purpose:

• firewall_server - Executed when Xray starts in server mode.
• firewall_client - Executed when Xray starts in client mode.
• firewall_cleanup - Executed when Xray stops. Ensure the scripts are executable (chmod +x <script>).

FAQ

Q: Telegram group?

A:

Q: Do you have any documentation?

A: a complete how-to guide is avilable here.

Contributing

This article fully describe how you can contribute. If you have any problems with the XRAYUI, feel free to share them by opening an issue. You can also suggest/request a new feature to be created or added. Contributions are welcome and encouraged.

License

XRAYUI is licensed under (CC BY-NC-SA 4.0)