Quick Start

This guide covers running vx-core as a server on Linux. For GUI-based deployment, use the VX client's server panel instead.

Prerequisites

Linux VPS (amd64 or arm64)
Root or sudo access

Install via Script

The recommended install method uses the official install script:

bash -c "$(curl -L https://github.com/5vnetwork/vx-install/raw/main/install-vx.sh)" @ install

This installs the vx binary and sets up a systemd service.

Manual Configuration

Config files can be protobuf binary or JSON using ProtoJSON format. Create config.json:

{
  "inbounds": [
    {
      "tag": "vmess",
      "ports": [10000],
      "protocol": {
        "@type": "type.googleapis.com/vx.proxy.vmess.VmessServerConfig",
        "secureEncryptionOnly": true
      }
    }
  ],
  "router": {
    "rules": [
      {
        "matchAll": true,
        "outboundTag": "direct"
      }
    ]
  },
  "outbounds": [
    {
      "tag": "direct",
      "protocol": {
        "@type": "type.googleapis.com/vx.proxy.freedom .FreedomConfig"
      }
    }
  ]
}

The full server config schema is defined in protos/proto/vx/server.proto. See Configuration for each section.

Run the Server

vx run --config config.json

When installed via the install script, manage the service with systemd:

systemctl start vx
systemctl enable vx
systemctl status vx

Default Config Path

When installed via the install script, the config lives at:

/usr/local/etc/vx/config.json

Next Steps

See Configuration for config file details
Add more inbounds for different protocols in Protocols
Use VX to deploy and manage the server remotely