v2ray-core README

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

V2Ray

Project V

Project V is a set of network tools that helps you to build your own computer network. It secures your network connections and thus protects your privacy.

GitHub Test Badge codecov.io goreportcard Codacy Badge Downloads

Packaging Status

If you are willing to package V2Ray for other distros/platforms, please let us know or seek for help via GitHub issues.

Packaging status

License

The MIT License (MIT)

Credits

This repo relies on the following third-party projects:

v2ray-core (v2fly/v2ray-core)

Searching Database…

What is this?V2Ray (Project V) is a set of network tools for building your own proxy network, encrypting your connections to protect privacy and bypass network restrictions like censorship.
Is this a ready-to-use VPN app or more of a building-block engine?It is the core engine/platform rather than a polished end-user app; you assemble a proxy setup (client and/or server) from it, and many separate GUI clients are built on top of this core.
How do I install and configure it?The README points to the official 'Documentation and Newcomer's Instructions' for installing and configuring V2Ray rather than giving inline setup steps.
Do I need to compile it myself, or are prebuilt packages available?You can build it from source with Go, but ready-made distro packages depend on community maintainers; the project explicitly invites volunteers to package V2Ray for other distros and platforms.
Does the repo itself include a GUI client?No, this repository is just the core proxy engine with no graphical interface included; you pair it with a separate client/GUI if you want a visual front end.
Does it only run on Linux servers, or also on Windows and macOS?As a Go binary, V2Ray builds and runs across Linux, Windows, and macOS, which is why packagers are asked to provide builds for multiple distros and platforms.
What protocols can V2Ray tunnel traffic through?Based on the project's topics, V2Ray supports protocols including VMess, VLESS, Trojan, Shadowsocks, and SOCKS5 for building proxy tunnels.
What is V2Fly in relation to V2Ray?V2Fly is the community organization (v2fly/v2ray-core) that now maintains this V2Ray/Project V core after the original project.
What third-party libraries does the core rely on?In production it depends on libraries like gorilla/websocket, quic-go/quic-go, pires/go-proxyproto, seiflotfy/cuckoofilter, google/starlark-go, jhump/protoreflect, and inetaf/netaddr.
Creator
v2fly
Size
67.9 MB
Stars
34.7K
Age
7y
Commits · 90 Days