diff --git a/README.md b/README.md new file mode 100644 index 0000000..db50987 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +openwrt-xray +------------ + +Install +------- +1. Drop the files onto OpenWRT (22.03 and higher) router +2. Run `install_xray.sh`: `chmod +x /root/install_xray.sh && /root/install_xray.sh` +3. Configure this installation: +- Edit this rule in `configure_xray_startup.sh`: `iptables -t mangle -A XRAY -d 1.1.1.1 -j RETURN` to match your public static IP address +- In `/root/xray_config/04_outbounds.json` add your connection details +4. Enable the `xray` service in LuCI (System -> Startup, it should be at the end of the list) and reboot your router. + +(In case it fails to work, you may disable the service and reboot the router again to revert the effects)