v2ray-core README

The project's README from github.com/v2ray/v2ray-core. As one markdown file: README.md.

Move To https://github.com/v2fly/v2ray-core


Project V

GitHub Test Badge codecov.io GoDoc codebeat Downloads Downloads

Project V is a set of network tools that help you to build your own computer network. It secures your network connections and thus protects your privacy. See our website for more information.

License

The MIT License (MIT)

Credits

This repo relies on the following third-party projects:

v2ray-core (v2ray/v2ray-core)

Searching Database…

What is this?Project V (v2ray-core) is a set of network tools for building your own proxy network that secures your connections and helps you bypass network restrictions while protecting your privacy.
Is this a GUI app or a background proxy engine?It's the core proxy engine — a background service/binary, not a GUI app. Third-party GUI clients are built separately on top of it.
How do I get it running?The README has no step-by-step setup guide; the project ships release binaries via GitHub Releases and provides a Docker image, configured through a config file that defines protocols like VMess or Shadowsocks.
Do I need anything besides the binary to run it?Running a compiled release needs nothing extra; building from source requires the Go toolchain, and the production build depends on gorilla/websocket and gRPC.
Does the README explain how to configure it?No — the README is essentially just badges, a one-line description, and a license notice; actual usage and configuration docs live on the project's website, not in this repo.
Does it run on Windows and macOS too, or just Linux?Written in Go, v2ray-core builds cross-platform, so it runs on Linux, Windows, and macOS without any OS restriction mentioned in the repo.
What protocols does v2ray-core support?Based on the project's GitHub topics, it supports VMess, Shadowsocks, SOCKS5, and standard HTTP proxying.
What's the relationship between v2ray and v2fly?The README tracks download badges for both v2ray/v2ray-core and v2fly/v2ray-core, suggesting v2fly is a closely related community fork or continuation of the project.
Does it come with a GUI?No, this repository is only the core engine; GUI frontends like V2RayN or V2RayNG are separate third-party projects built on top of it.
What are similar projects?Xray-core, v2ray-core, hysteria, gluetun, nyx, v2rayNG, Open-Box, v2rayN
Creator
v2ray
Size
53.9 MB
Stars
46.9K
Age
11y
Commits · 90 Days