Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
130 lines (83 loc) · 3.47 KB

GETTING_STARTED.md

File metadata and controls

130 lines (83 loc) · 3.47 KB
Raw

Getting started with v2rayF

1. Install

Download the latest release for your platform from:

https://github.com/drmikecrypto/v2rayF/releases/latest

Extract the zip. Do not move cores/ away from the executable.

OS Command
Windows Double-click v2rayF.exe
Linux chmod +x run-v2rayF.sh && ./run-v2rayF.sh
macOS ./run-v2rayF.sh (see Gatekeeper note below)
Android Install v2rayF-android-arm64.apk from the release zip; grant VPN permission when prompted

macOS Gatekeeper

If macOS says the app is damaged or from an unidentified developer:

xattr -cr /path/to/extracted/v2rayF-folder

Or: Right-click the app → Open → confirm once.

2. Import servers

Single link — paste a share URL and click Import, or use Clipboard:

  • vless://… (VLESS, REALITY)
  • vmess://…
  • ss://… (Shadowsocks)
  • trojan://…

Subscription — paste an https://… URL in the top bar and click Import URL. The URL is saved automatically. Use Refresh later to pull updated servers without pasting again.

See Subscription URLs and Latency testing.

3. Connect

  1. Click a server in the list (or double-click to connect immediately).
  2. Click Connect.
  3. The tray icon shows status. Closing the window while connected minimizes to tray.

Disconnect stops Xray and restores system proxy settings.

4. Settings (right panel)

Routing

Mode Behavior
Global All TCP/UDP through the proxy
Bypass LAN Private IPs go direct (default)
Bypass China CN domains/IPs direct (uses geo files in cores/)
Custom Your own direct list (domains or CIDRs, one per line)

Click Save settings before connecting if you changed routing.

TUN mode

Routes all device traffic through the virtual adapter (like a system VPN).

OS Requirement
Windows Run v2rayF.exe as Administrator
Linux / macOS sudo ./run-v2rayF.sh
Android Tap Connect and approve the VPN permission prompt (always uses VPN mode)

When TUN is on, system HTTP proxy is usually not needed.

System proxy

When enabled (default), v2rayF sets OS proxy to 127.0.0.1:10809 on connect.

Supported: Windows registry, macOS networksetup, Linux GNOME / KDE / XFCE.

5. Latency test

  • Test — selected server
  • Test All — every server in the list

Shows TCP connect time in ms (not full proxy handshake).

Data storage

File Location
Server list %APPDATA%\v2rayF\servers.json (Windows)
App settings %APPDATA%\v2rayF\settings.json
Runtime Xray config %APPDATA%\v2rayF\runtime\config.json

On Linux/macOS, ApplicationData maps to ~/.config/ or equivalent.

Troubleshooting

Problem Try
“Xray core missing” Ensure cores/xray or cores/xray.exe is next to the app
Connect fails Check server link, firewall, VPS port
Bypass China fails Confirm geoip.dat and geosite.dat exist in cores/
TUN fails Run with Admin / sudo
Linux proxy not set Use TUN, or set manual proxy 127.0.0.1:10809
macOS blocked xattr -cr on the folder

Build your own packages

pwsh -File scripts/package-all.ps1

Output: dist/v2rayF-<platform>.zip

See CONTRIBUTING.md for development setup.