Quick Start

This guide explains how to run vx-core in server mode on Linux. For graphical deployment, use the VX client server panel instead.

Prerequisites

Linux VPS (amd64 or arm64)
root or sudo access

Script installation

We recommend the official install script:

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

The script installs the vx binary and configures a systemd service.

Manual configuration

The configuration file can be binary protobuf or JSON in 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 configuration schema is defined in protos/proto/vx/server.proto. See Configuration for each section.

Run the server

vx run --config config.json

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

systemctl start vx
systemctl enable vx
systemctl status vx

Default configuration path

After installation via the install script, the configuration file is located at:

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

Next steps

See Configuration for configuration file details
Add more inbounds for different protocols in Protocols
Use VX to deploy and manage servers remotely