A user-friendly Xray GUI client for Linux with a focus on simplicity and enhancing VPN experience.

• Simple, intuitive GUI with support for Xray configs and json sublinks
• Minimal setup required--select the Xray config or the text file containing your sublink and connect
• Easy toggle between Proxy and VPN modes
• Privacy-focused by having zero DNS-leak VPN mode through preprocessing config files and using tun2proxy
• Secure user permission handling via Polkit; optional passwordless VPN mode connection
• Linux desktop integration with tray, startup options and Unix socket connection
• All-in-one Python code; suitable for portability

You can run the program normally or use command-line options to start it in a specific mode at launch:

optional arguments:
  -h, --help        show this help message and exit
  --minimized       Start the app minimized (only tray icon)
  --connect-proxy   Connect to the last entry in Proxy mode automatically with startup
  --connect-vpn     Connect to the last entry in VPN mode automatically with startup
  --install-policy  Install a set of policy and rule files for use with Polkit for passwordless authentication in VPN mode

For better desktop integration, you can create custom shortcuts to control the app — such as connecting or disconnecting from VPN or Proxy modes — via the provided UNIX socket. For example, you can use socat to send a command through the socket and bind that to a keyboard shortcut:

echo 'setvpn' | socat - UNIX-CONNECT:/tmp/gorzray/gorzray.sock && echo 'connect' | socat - UNIX-CONNECT:/tmp/gorzray/gorzray.sock

The code is portable and you can directly run it by installing requests, psutil, PyGObject and pystray modules via pip or your distribution's package manager for Python. In that case, some modifications of the source code are required as currently it is set for use in an AppImage.

If you want to make an appimage, create a directory named AppDir with the following layout:

AppDir/
|-- AppRun
|-- GorzRay.desktop
|-- gorzray-icon-proxy.png
|-- gorzray-icon-vpn.png
|-- gorzray-icon.png
`-- usr
    |-- bin
    |   |-- gorzray.py
    |   |-- tun2proxy-bin
    |   `-- xray-bin
    `-- share
        |-- metainfo
        |   `-- GorzRay.appdata.xml
        `-- xray-geofiles
            |-- geoip.dat
            `-- geosite.dat

5 directories, 11 files

You can find the other needed files in the assets directory of this repository. Download the binaries from Xray-core and tun2proxy. Geo assets can be obtained from Xray-core or Iran-v2ray-rules, or any other reliable source.

Then include your version of choice for [a portable] Python. For example, using linuxdeploy, download the tools and run:

PIP_REQUIREMENTS="requests psutil PyGObject pystray" ./linuxdeploy-plugin-python.sh --appdir AppDir/

And:

DEPLOY_GTK_VERSION=3 ./linuxdeploy-x86_64.AppImage --appdir AppDir --output appimage --icon-file AppDir/gorzray-icon.png --desktop-file AppDir/GorzRay.desktop --plugin gtk

Which will build the AppImage.

This project is licensed under the GNU AGPL v3.0. See LICENSE for details.

This project includes unmodified binaries/assets from software developed by:

• Xray-core (MPL-2.0)
• tun2proxy (MIT License)
• Iran-v2ray-rules (GPL v3)

See LICENCES for full license texts. Icons were generated with OpenAI's ChatGPT (DALL-E) and modified in GIMP. No attribution is required.