yjpark / V2RayX

GUI for v2ray-core on macOS

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

V2RayX

V2RayX: A simple GUI for V2Ray on macOS

what is V2Ray?

V2Ray logo

Project V2Ray.

YOU SHOULD READ V2RAY'S OFFICIAL INSTRUCTION BEFORE USING V2RAYX!

Download V2RayX

Releases

How to build

V2RayX.app is built by running one of the following commands in your terminal. You can install this via the command-line with curl.

sh -c "$(curl -fsSL https://raw.githubusercontent.com/Cenmrev/V2RayX/master/compilefromsource.sh)"

or step by step:

git clone --recursive https://github.com/Cenmrev/V2RayX.git

open V2RayX.xcodeproj and use Xcode to build V2RayX.

How does V2RayX work

V2RayX provides a GUI to generate the config file for V2Ray. It includes V2Ray's binary executable in the app bundle. V2RayX starts and stops V2Ray with launchd of macOS.

V2RayX also allows users to change system proxy settings and switch proxy servers on the macOS menu bar.

As default, V2RayX will open a socks5 proxy at port 1081 as the main inbound, as well as a http proxy at port 8001 as an inboundDetour.

auto-run on login

Open macOS System Preferences -> Users & Group -> Login Itmes, add V2RayX.app to the list.

登录后自动运行

打开 macOS 系统设置 -> 用户与组 -> 登录项,把 V2RayX.app 添加到列表中。

manually update v2ray-core

replace V2RayX.app/Contents/MacOS/v2ray with the newest v2ray version from v2ray-core repo. However, compatibility is not guaranteed.

Uninstall

V2RayX will create the following files and folders:

  • /Library/Application Support/V2RayX
  • ~/Library/Application Support/V2RayX
  • ~/Library/Preferences/cenmrev.V2RayX.plist

So, to totally uninstall V2RayX, just delete V2RayX.app and the files above. :)

Acknowledge

V2RayX uses GCDWebServer to provide a local pac server. V2RayX also uses many ideas and codes from ShadowsocksX, especially, the codes of v2rays_sysconfig are simply copied from shadowsocks_sysconf with some modifications.

Donation

If Project V2Ray or V2RayX helped you, you can also help us by donation in your will. To donate to Project V2Ray, you may refer to this page. To help this GUI program, you can send gift cards to cenmrev@tutanota.de.

Disclaimer

The developer does not major in CS nor Software Engineer and currently is busy with grad school courses. So V2rayX will not be updated frequently. Users can replace V2RayX.app/Contents/Resources/v2ray with the newest v2ray-core downloaded from https://github.com/v2ray/v2ray-core/releases.

The developer currently does not have enough time to add more features to V2RayX, nor to merge PRs. However, forking and releasing your own version are always welcome.

About

GUI for v2ray-core on macOS

License:GNU General Public License v3.0


Languages

Language:Objective-C 89.5%Language:JavaScript 5.5%Language:Shell 5.1%