vx-core

module
v1.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 24, 2025 License: AGPL-3.0

README

vx-core

A proxy tool originated from v2ray-core. It powers our multi-platform proxy client app: VX

Features

Supported Proxy Protocols
  • VMESS - Versatile protocol with AEAD encryption
  • Shadowsocks - Classic proxy protocol with multiple encryption methods
  • Trojan - TLS-based proxy protocol with Vision support
  • Hysteria2 - UDP-based protocol optimized for low-latency and high-speed
  • VLESS - Lightweight protocol with Vision/XTLS support
  • SOCKS5 - Standard SOCKS proxy protocol
  • HTTP - HTTP proxy support
  • AnyTLS - Reduce characteristics of TLS in TLS
  • Dokodemo-door - For port forwarding

Server-Side Quick Start

We recommend to using our proxy client VX to install and configure vx-core, because the client has GUI interface and documentation.

Config file can be either protobuf file, or json file using ProtoJSON format.

  1. Create a configuration file config.json:

The server proto config can be found at protos/server/server.proto

{
    "inbounds": [
        {
            "tag": "vmess",
            "ports": [10000],
            "protocol": {
                "@type": "type.googleapis.com/x.proxy.VmessServerConfig",
                "secureEncryptionOnly": true
            }
        }
    ],
    "router": {
        "rules": [
            {
                "matchAll": true,
                "outboundTag": "direct"
            }
        ]
    },
    "outbounds": [
        {
            "tag": "direct",
            "protocol": {
                "@type": "type.googleapis.com/x.proxy.FreedomConfig"
            }
        }
    ]
}
  1. Run vx:
vx run --config config.json

License

See LICENSE file for details.

License Compliance

The code contains in "proxy/vless", "tranport/security/reality", "tranport/protocol/splithttp", "app/util/x25519", "api/reali_scanner", "tranport/security/tls/ech" folder is modified from Xray-core. It is distributed under the same licence(Mozilla Public License 2.0) as the original project.

Support

For issues, questions, or contributions, please open an issue on GitHub. Thanks

Directories

Path Synopsis
app
api
dns
geo
inbound/channel
Package channel provides the implementation of channel-based data-link layer endpoints.
Package channel provides the implementation of channel-based data-link layer endpoints.
cmd
client command
server command
buf
Package buf provides a light-weight memory allocation mechanism.
Package buf provides a light-weight memory allocation mechanism.
crypto
Package crypto provides common crypto libraries for V2Ray.
Package crypto provides common crypto libraries for V2Ray.
dice
Package dice contains common functions to generate random number.
Package dice contains common functions to generate random number.
dns
geo
log
mux
net
os
rtt
session
Package session provides functions for sessions of incoming requests.
Package session provides functions for sessions of incoming requests.
set
strmatcher
Package mph implements a minimal perfect hash table over strings.
Package mph implements a minimal perfect hash table over strings.
uot
i
vi
vless
Package proxy contains all proxies used by Xray.
Package proxy contains all proxies used by Xray.
vmess
Package vmess contains the implementation of VMess protocol and transportation.
Package vmess contains the implementation of VMess protocol and transportation.
mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
protocols/kcp
Package kcp - A Fast and Reliable ARQ Protocol
Package kcp - A Fast and Reliable ARQ Protocol
protocols/websocket
Package websocket implements Websocket transport
Package websocket implements Websocket transport
tun
netmon
Package monitor provides facilities for monitoring network interface and route changes.
Package monitor provides facilities for monitoring network interface and route changes.
win_service
service command
Example service program that beeps.
Example service program that beeps.
wfp
x_windows_service command
Example service program that beeps.
Example service program that beeps.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL