Xray-core

https://xtls.github.io
Admin
Xray-core is a high-performance network proxy toolkit and a superset of v2ray-core, featuring...
Tokens:66,088
Snippets:702
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Sudo

Source: https://xtls.github.io/document/level-0/ch04-security.html

Update package lists and install the sudo utility.

```shell
apt update && apt install sudo
```

--------------------------------

### mKCP Configuration Example

Source: https://xtls.github.io/config/transports/mkcp.html

Example configuration for the kcpSettings object within streamSettings, applicable to both inbound and outbound connections.

```json
{
  // outbound 示例，同样可用于 inbound
  "outbounds": [
    {
      // ...
      "streamSettings": {
        "method": "mkcp",
        "kcpSettings": {
          "mtu": 1350,
          "tti": 20,
          "uplinkCapacity": 5,
          "downlinkCapacity": 20,
          "congestion": false,
          "readBufferSize": 1,
          "writeBufferSize": 1
        }
      }
    }
  ]
}
```

--------------------------------

### Complete DnsObject Configuration Example

Source: https://xtls.github.io/config/dns.html

A comprehensive example showing the structure of the dns object, including static hosts, various server types, and global settings.

```json
{
  "dns": {
    "hosts": {
      "baidu.com": "127.0.0.1",
      "dns.google": ["8.8.8.8", "8.8.4.4"]
    },
    "servers": [
      "8.8.8.8",
      "8.8.4.4",
      {
        "address": "1.2.3.4",
        "port": 5353,
        "domains": ["domain:xray.com"],
        "expectedIPs": ["geoip:cn"],
        "skipFallback": false,
        "clientIP": "1.2.3.4"
      },
      {
        "address": "https://8.8.8.8/dns-query",
        "domains": ["geosite:netflix"],
        "skipFallback": true,
        "queryStrategy": "UseIPv4"
      },
      {
        "address": "https://1.1.1.1/dns-query",
        "domains": ["geosite:openai"],
        "skipFallback": true,
        "queryStrategy": "UseIPv6"
      },
      "localhost"
    ],
    "clientIp": "1.2.3.4",
    "queryStrategy": "UseIP",
    "disableCache": false,
    "serveStale": false,
    "serveExpiredTTL": 0,
    "disableFallback": false,
    "disableFallbackIfMatch": false,
    "enableParallelQuery": false,
    "useSystemHosts": false,
    "tag": "dns_inbound"
  }
}
```

--------------------------------

### QUIC Parameters Configuration

Source: https://xtls.github.io/config/transports/finalmask.html

Example configuration object for fine-tuning QUIC transport behavior.

```json
{
  "finalmask": {
    "quicParams": {
      "congestion": "force-brutal",
      "bbrProfile": "standard",
      "debug": false,
      "brutalUp": "60 mbps",
      "brutalDown": 0,
      "udpHop": {
        "ports": "20000-50000",
        "interval": "5-10"
      },
      "initStreamReceiveWindow": 8388608,
      "maxStreamReceiveWindow": 8388608,
      "initConnectionReceiveWindow": 20971520,
      "maxConnectionReceiveWindow": 20971520,
      "maxIdleTimeout": 30,
      "keepAlivePeriod": 0,
      "disablePathMTUDiscovery": false,
      "maxIncomingStreams": 1024
    }
  }
}
```

--------------------------------

### Start Xray with Protobuf Configuration

Source: https://xtls.github.io/document/command.html

Use the -c flag to specify a protobuf-encoded configuration file.

```bash
xray -c mix.pb
```

--------------------------------

### Example Tunnel Configuration for Port Mapping

Source: https://xtls.github.io/config/inbounds/tunnel.html

A complete configuration example for mapping a local port to a remote server, such as a Minecraft server.

```json
{
  "listen": "127.0.0.1",
  "port": 25565,
  "protocol": "tunnel",
  "settings": {
    "allowedNetwork": "tcp",
    "rewriteAddress": "mc.hypixel.net",
    "rewritePort": 25565,
    "followRedirect": false,
    "userLevel": 0
  },
  "tag": "mc"
}
```

--------------------------------

### Minimal API Configuration

Source: https://xtls.github.io/config/api.html

A simplified configuration example enabling only the StatsService.

```json
{
  "api": {
    "tag": "api",
    "services": ["StatsService"]
  }
}
```

--------------------------------

### WebSocketObject Configuration Example

Source: https://xtls.github.io/config/transports/websocket.html

Example configuration for WebSocket transport settings within the streamSettings object, applicable to both inbound and outbound connections.

```json
{
  // outbound 示例，同样可用于 inbound
  "outbounds": [
    {
      // ...
      "streamSettings": {
        "method": "websocket",
        "wsSettings": {
          "acceptProxyProtocol": false,
          "path": "/",
          "host": "xray.com",
          "headers": {
            "key": "value"
          },
          "heartbeatPeriod": 10
        }
      }
    }
  ]
}
```

--------------------------------

### Load Balancing Routing Example

Source: https://xtls.github.io/config/routing.html

Demonstrates how to integrate a balancer into the routing rules and define the corresponding outbounds.

```json
{
  "routing": {
    "rules": [
      {
        "inboundTag": ["in"],
        "balancerTag": "round"
      }
    ],
    "balancers": [
      {
        "selector": ["out"],
        "strategy": {
          "type": "roundRobin"
        },
        "tag": "round"
      }
    ]
  },

  "inbounds": [
    {
      // 入站配置
      "tag": "in"
    }
  ],

  "outbounds": [
    {
      // 出站配置
      "tag": "out1"
    },
    {
      // 出站配置
      "tag": "out2"
    }
  ]
}
```

--------------------------------

### Cross-Compile for Linux

Source: https://xtls.github.io/development/intro/compile.html

Example of cross-compiling for a Linux server from a Windows environment.

```powershell
$env:CGO_ENABLED=0
$env:GOOS="linux"
$env:GOARCH="amd64"

go build -o xray -trimpath -buildvcs=false -ldflags "-s -w -buildid=" ./main
```

--------------------------------

### Sockopt Configuration Object

Source: https://xtls.github.io/config/transports/sockopt.html

Example structure for defining sockopt settings within an outbound or inbound stream configuration.

```json
{
  // outbound 示例，同样可用于 inbound
  "outbounds": [
    {
      // ...
      "streamSettings": {
        "sockopt": {
          "mark": 0,
          "tcpMaxSeg": 1440,
          "tcpFastOpen": false,
          "tproxy": "off",
          "domainStrategy": "AsIs",
          "happyEyeballs": {},
          "dialerProxy": "",
          "acceptProxyProtocol": false,
          "trustedXForwardedFor": [],
          "tcpKeepAliveInterval": 0,
          "tcpKeepAliveIdle": 300,
          "tcpUserTimeout": 10000,
          "tcpcongestion": "bbr",
          "interface": "wg0",
          "V6Only": false,
          "tcpWindowClamp": 600,
          "tcpMptcp": false,
          "addressPortStrategy": "",
          "customSockopt": []
        }
      }
    }
  ]
}
```

--------------------------------

### TLSObject Configuration Example

Source: https://xtls.github.io/config/transports/tls.html

A template for configuring TLS settings within the streamSettings of an outbound or inbound connection.

```json
{
  // outbound 示例，同样可用于 inbound
  "outbounds": [
    {
      // ...
      "streamSettings": {
        "security": "tls",
        "tlsSettings": {
          "serverName": "xray.com",
          "verifyPeerCertByName": "",
          "rejectUnknownSni": false,
          "allowInsecure": false,
          "alpn": ["h2", "http/1.1"],
          "minVersion": "1.2",
          "maxVersion": "1.3",
          "cipherSuites": "此处填写你需要的加密套件名称,每个套件名称之间用:进行分隔",
          "certificates": [],
          "disableSystemRoot": false,
          "enableSessionResumption": false,
          "fingerprint": "",
          "pinnedPeerCertSha256": "",
          "curvePreferences": [""],
          "masterKeyLog": "",
          "echServerKeys": "",
          "echConfigList": "",
          "echSockopt": {}
        }
      }
    }
  ]
}
```

--------------------------------

### Configure DNS with Query Strategy Conflict

Source: https://xtls.github.io/config/dns.html

Example demonstrating how a global query strategy can conflict with a server-specific strategy, resulting in an empty response for matched domains.

```json
{
  "dns": {
    "servers": [
      "https://1.1.1.1/dns-query",
      {
        "address": "https://8.8.8.8/dns-query",
        "domains": ["geosite:netflix"],
        "skipFallback": true,
        "queryStrategy": "UseIPv6" // 全局 "UseIPv4" 与 子项 "UseIPv6" 冲突
      }
    ],
    "queryStrategy": "UseIPv4"
  }
}
```

--------------------------------

### Example Metrics Output

Source: https://xtls.github.io/config/metrics.html

Sample JSON output containing observatory and statistics data, typically retrieved from the expvars endpoint.

```json
{
  "observatory": {
    "tcp_outbound": {
      "alive": true,
      "delay": 782,
      "outbound_tag": "tcp_outbound",
      "last_seen_time": 1648477189,
      "last_try_time": 1648477189
    },
    "udp_outbound": {
      "alive": true,
      "delay": 779,
      "outbound_tag": "udp_outbound",
      "last_seen_time": 1648477191,
      "last_try_time": 1648477191
    }
  },
  "stats": {
    "inbound": {
      "api": {
        "downlink": 0,
        "uplink": 0
      },
      "dns_server_inbound_5300": {
        "downlink": 14286,
        "uplink": 5857
      },
      "http_inbound": {
        "downlink": 74460,
        "uplink": 10231
      },
      "https_inbound": {
        "downlink": 0,
        "uplink": 0
      },
      "metrics": {
        "downlink": 6327,
        "uplink": 1347
      },
      "socks_inbound": {
        "downlink": 19925615,
        "uplink": 5512
      },
      "tproxy_tcp_inbound": {
        "downlink": 4739161,
        "uplink": 1568869
      },
      "tproxy_udp_inbound": {
        "downlink": 0,
        "uplink": 2608142
      }
    },
    "outbound": {
      "blackhole_outbound": {
        "downlink": 0,
        "uplink": 0
      },
      "direct": {
        "downlink": 97714548,
        "uplink": 3234617
      },
      "dns_server_outbound": {
        "downlink": 7116,
        "uplink": 2229
      },
      "manual_tproxy_outbound_tcp_1": {
        "downlink": 0,
        "uplink": 0
      },
      "manual_tproxy_outbound_udp_1": {
        "downlink": 0,
        "uplink": 0
      },
      "tcp_outbound": {
        "downlink": 23873238,
        "uplink": 1049595
      },
      "udp_outbound": {
        "downlink": 639282,
        "uplink": 74634
      }
    },
    "user": {}
  }
}
```

--------------------------------

### Automatic FakeDNS Initialization

Source: https://xtls.github.io/config/fakedns.html

Examples of how Xray initializes FakeDNS based on the queryStrategy setting when not explicitly defined.

```json
{
  "fakedns": [
    {
      "ipPool": "198.18.0.0/15",
      "poolSize": 32768
    },
    {
      "ipPool": "fc00::/18",
      "poolSize": 32768
    }
  ]
}
```

```json
{
  "fakedns": {
    "ipPool": "198.18.0.0/15",
    "poolSize": 65535
  }
}
```

```json
{
  "fakedns": {
    "ipPool": "fc00::/18",
    "poolSize": 65535
  }
}
```

--------------------------------

### Configure Happy Eyeballs

Source: https://xtls.github.io/config/transports/sockopt.html

Example configuration for the Happy Eyeballs algorithm to optimize connection establishment.

```json
{
  "happyEyeballs": {
    "tryDelayMs": 250,
    "prioritizeIPv6": false,
    "interleave": 1,
    "maxConcurrentTry": 4
  }
}
```

--------------------------------

### Configure Custom Socket Options

Source: https://xtls.github.io/config/transports/sockopt.html

Example of using customSockopt to set TCP congestion control to bbr on Linux.

```json
{
  "customSockopt": [
    {
      "system": "linux",
      "network": "tcp",
      "type": "str",
      "level": "6",
      "opt": "13",
      "value": "bbr"
    }
  ]
}
```

--------------------------------

### HTTP Outbound Configuration Object

Source: https://xtls.github.io/config/outbounds/http.html

Example configuration for an HTTP outbound proxy, including authentication credentials and custom HTTP headers.

```json
{
  "outbounds": [
    {
      // ...
      "protocol": "http",
      "settings": {
        "address": "192.168.108.1",
        "port": 3128,
        "user": "my-username",
        "pass": "my-password",
        "level": 0,
        "email": "love@xray.com",
        "headers": {
          "User-Agent": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36",
          "Accept-Language": "zh-CN,zh;q=0.8,zh-TW;q=0.7,zh-HK;q=0.5,en-US;q=0.3,en;q=0.2"
        }
      }
    }
  ]
}
```

--------------------------------

### RealityObject Configuration Structure

Source: https://xtls.github.io/config/transports/reality.html

A comprehensive example showing the structure of the RealityObject within an outbound configuration, which also applies to inbound configurations.

```json
{
  // outbound 示例，同样可用于 inbound
  "outbounds": [
    {
      // ...
      "streamSettings": {
        "security": "reality",
        "realitySettings": {
          // 入站（服务端）配置
          "show": false,
          "target": "example.com:443",
          "xver": 0,
          "serverNames": ["example.com", "www.example.com"],
          "privateKey": "",
          "minClientVer": "26.3.27",
          "maxClientVer": "",
          "maxTimeDiff": 0,
          "shortIds": ["", "0123456789abcdef"],
          "mldsa65Seed": "",
          "limitFallbackUpload": {
            "afterBytes": 0,
            "bytesPerSec": 0,
            "burstBytesPerSec": 0
          },
          "limitFallbackDownload": {
            "afterBytes": 0,
            "bytesPerSec": 0,
            "burstBytesPerSec": 0
          },
          // 出站（客户端）配置
          "serverName": "",
          "fingerprint": "chrome",
          "password": "",
          "shortId": "",
          "mldsa65Verify": "",
          "spiderX": ""
        }
      }
    }
  ]
}
```

--------------------------------

### Define DNS Server Object

Source: https://xtls.github.io/config/dns.html

Example of a DnsServerObject configuration defining address, port, domain matching, and IP filtering rules.

```json
{
  "address": "1.2.3.4",
  "port": 5353,
  "domains": ["domain:xray.com"],
  "expectedIPs": ["geoip:cn"],
  "unexpectedIPs": ["geoip:cloudflare"],
  "skipFallback": false,
  "finalQuery": false,
  "tag": "dns-tag",
  "clientIP": "1.2.3.4",
  "queryStrategy": "UseIPv4",
  "disableCache": false
}
```

--------------------------------

### HTTP Inbound Configuration Object

Source: https://xtls.github.io/config/inbounds/http.html

Example configuration for an HTTP inbound, including user authentication and transparent proxy settings.

```json
{
  "inbounds": [
    {
      // ...
      "protocol": "http",
      "settings": {
        "users": [
          {
            "user": "my-username",
            "pass": "my-password"
          }
        ],
        "allowTransparent": false,
        "userLevel": 0
      }
    }
  ]
}
```

--------------------------------

### DNS Outbound Configuration Object

Source: https://xtls.github.io/config/outbounds/dns.html

Example configuration for the DNS outbound protocol, including rewrite settings and rule definitions.

```json
{
  "outbounds": [
    {
      // ...
      "protocol": "dns",
      "settings": {
        "rewriteNetwork": "udp",
        "rewriteAddress": "1.1.1.1",
        "rewritePort": 53,
        "userLevel": 0,
        "rules": [
          {
            "action": "return",
            "rCode": 5,
            "domain": ["domain:example.com"]
          },
          {
            "action": "direct",
            "qType": 65,
            "domain": ["geosite:geolocation-!cn"]
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Configure RawObject in StreamSettings

Source: https://xtls.github.io/config/transports/raw.html

Example configuration for the raw transport method within streamSettings, applicable to both inbound and outbound connections.

```json
{
  // outbound 示例，同样可用于 inbound
  "outbounds": [
    {
      // ...
      "streamSettings": {
        "method": "raw",
        "rawSettings": {
          "acceptProxyProtocol": false,
          "header": {
            "type": "none"
          }
        }
      }
    }
  ]
}
```

--------------------------------

### Configure GRPCObject in StreamSettings

Source: https://xtls.github.io/config/transports/grpc.html

Example configuration for gRPC transport settings within the streamSettings object, applicable to both inbound and outbound configurations.

```json
{
  // outbound 示例，同样可用于 inbound
  "outbounds": [
    {
      // ...
      "streamSettings": {
        "method": "grpc",
        "grpcSettings": {
          "authority": "grpc.example.com",
          "serviceName": "name",
          "multiMode": false,
          "user_agent": "custom user agent",
          "idle_timeout": 60,
          "health_check_timeout": 20,
          "permit_without_stream": false,
          "initial_windows_size": 0
        }
      }
    }
  ]
}
```

--------------------------------

### Freedom Outbound Configuration Object

Source: https://xtls.github.io/config/outbounds/freedom.html

Example configuration for the Freedom outbound protocol, including settings for domain strategy, fragmentation, noise, and final rules.

```json
{
  "outbounds": [
    {
      // ...
      "protocol": "freedom",
      "settings": {
        "domainStrategy": "AsIs",
        "redirect": "127.0.0.1:3366",
        "userLevel": 0,
        "fragment": {
          "packets": "tlshello",
          "length": "100-200",
          "interval": "10-20" // 单位ms
        },
        "noises": [
          {
            "type": "base64",
            "packet": "7nQBAAABAAAAAAAABnQtcmluZwZtc2VkZ2UDbmV0AAABAAE=",
            "delay": "10-16"
          }
        ],
        "proxyProtocol": 0,
        "finalRules": [
          {
            "action": "block",
            "network": "tcp",
            "port": "22,25,465,587"
          },
          {
            "action": "block",
            "ip": ["geoip:cn"]
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Webhook POST Data Example

Source: https://xtls.github.io/config/routing.html

Example of the JSON payload sent to a webhook URL when a routing rule is matched.

```json
{
  "email": "2", // string | null
  "level": null, // number | null
  "protocol": "tls", // string | null
  "network": "tcp", // string
  "source": "tcp:127.0.0.1:54203", // string | null
  "destination": "tcp:dns.google:443", // string
  "routeTarget": null, // string | null
  "originalTarget": "tcp:8.8.8.8:443", // string | null
  "inboundTag": "VLESS_TCP", // string | null
  "inboundName": "vless", // string | null
  "inboundLocal": "tcp:192.168.108.1:443", // string | null
  "outboundTag": "notify-bittorrent", // string | null
  "ts": 1771886901 // number
}
```

--------------------------------

### Clone and Prepare Xray Source

Source: https://xtls.github.io/development/intro/compile.html

Download the source code and download necessary Go modules.

```bash
git clone https://github.com/XTLS/Xray-core.git
cd Xray-core && go mod download
```

--------------------------------

### Create New User

Source: https://xtls.github.io/document/level-0/ch04-security.html

Add a new user account to the system.

```shell
adduser vpsadmin
```

--------------------------------

### Golang 开发辅助命令

Source: https://xtls.github.io/development/intro/guide.html

在修改代码或 protobuf 定义时使用的辅助生成命令。

```bash
go generate core/format.go
```

```bash
go generate core/proto.go
```

```bash
go test ./...
```

--------------------------------

### GET /debug/vars

Source: https://xtls.github.io/config/metrics.html

Access exported variables including inbound, outbound, and observatory statistics.

```APIDOC
## GET /debug/vars

### Description
Returns a JSON object containing system statistics, including inbound/outbound traffic data and observatory results.

### Method
GET

### Endpoint
/debug/vars

### Response
#### Success Response (200)
- **stats** (object) - Contains inbound, outbound, and user traffic data.
- **observatory** (object) - Contains connectivity and delay results for outbounds.
```

--------------------------------

### GET /debug/pprof/

Source: https://xtls.github.io/config/metrics.html

Access pprof debugging endpoints for performance analysis and memory profiling.

```APIDOC
## GET /debug/pprof/

### Description
Provides access to Go pprof debugging tools. Use /debug/pprof/heap and /debug/pprof/goroutine for memory and goroutine analysis.

### Method
GET

### Endpoint
/debug/pprof/
```

--------------------------------

### Convert Configuration Formats

Source: https://xtls.github.io/document/command.html

Converts configuration files between JSON and protobuf formats.

```bash
xray convert <command> [arguments]

The commands are:

        pb           Convert multiple json configs to protobuf
        json         Convert typedMessage to json
```

```bash
# 用法：xray convert pb [-outpbfile out.pb] [-debug] [-type] [json file] [json file] ...

# 把三个配置合并成 mix.pb
xray convert pb -outpbfile mix.pb c1.json c2.json c3.json

# 使用 -debug 选项查看 mix.pb 的内容
xray convert pb -debug mix.pb
```

--------------------------------

### Build Xray Binary

Source: https://xtls.github.io/development/intro/compile.html

Compile the Xray binary for Windows, macOS, or Linux.

```powershell
$env:CGO_ENABLED=0
go build -o xray.exe -trimpath -buildvcs=false -ldflags "-s -w -buildid=" ./main
```

```bash
CGO_ENABLED=0 go build -o xray -trimpath -buildvcs=false -ldflags "-s -w -buildid=" ./main
```

--------------------------------

### FinalMaskObject Configuration

Source: https://xtls.github.io/config/transports/finalmask.html

Example structure for the finalmask object within streamSettings, applicable to both inbound and outbound configurations.

```json
{
  // outbound 示例，同样可用于 inbound
  "outbounds": [
    {
      // ...
      "streamSettings": {
        "finalmask": {
          "tcp": [
            {
              "type": "",
              "settings": {}
            }
          ],
          "udp": [
            {
              "type": "",
              "settings": {}
            }
          ],
          "quicParams": {
            "congestion": "force-brutal",
            "bbrProfile": "standard",
            "debug": false,
            "brutalUp": "60 mbps",
            "brutalDown": 0,
            "udpHop": {
              "ports": "20000-50000",
              "interval": "5-10"
            },
            "initStreamReceiveWindow": 8388608,
            "maxStreamReceiveWindow": 8388608,
            "initConnectionReceiveWindow": 20971520,
            "maxConnectionReceiveWindow": 20971520,
            "maxIdleTimeout": 30,
            "keepAlivePeriod": 0,
            "disablePathMTUDiscovery": false,
            "maxIncomingStreams": 1024
          }
        }
      }
    }
  ]
}
```

--------------------------------

### VLESS Inbound Configuration

Source: https://xtls.github.io/config/inbounds/vless.html

Example of a VLESS inbound configuration object within an Xray configuration file.

```json
{
  "inbounds": [
    {
      // ...
      "protocol": "vless",
      "settings": {
        "users": [
          {
            "id": "5783a3e7-e373-51cd-8642-c83782b807c5",
            "level": 0,
            "email": "love@xray.com",
            "flow": "xtls-rprx-vision",
            "reverse": {}
          }
        ],
        "flow": "",
        "decryption": "none",
        "fallbacks": [
          {
            "dest": 80
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### 查询与执行 Linux 软件更新

Source: https://xtls.github.io/document/level-0/ch03-ssh.html

使用 apt 包管理器更新 Debian 系统软件。apt update 用于查询更新，apt upgrade 用于执行更新。

```shell
apt update
```

```shell
apt upgrade
```

--------------------------------

### 运行 Xray 服务

Source: https://xtls.github.io/document/command.html

使用 run 命令启动 Xray，支持指定配置文件或目录。

```bash
xray run [-c config.json] [-confdir dir]
```

```bash
Run Xray with config, the default command.

The -config=file, -c=file flags set the config files for
Xray. Multiple assign is accepted.

The -confdir=dir flag sets a dir with multiple json config

The -format=json flag sets the format of config files.
Default "auto".

The -test flag tells Xray to test config files only,
without launching the server.

The -dump flag tells Xray to print the merged config.
```

--------------------------------

### 指定多个配置文件

Source: https://xtls.github.io/document/command.html

通过多次使用 -config 参数指定多个配置文件，Xray 会按顺序读取并合并。

```bash
xray run -config base.json -config routing.json -config outbounds.yaml
```

--------------------------------

### 创建网站目录与网页文件

Source: https://xtls.github.io/document/level-0/ch05-webpage.html

在用户主目录下创建存放网页的文件夹并使用 nano 编辑器创建 index.html。

```shell
mkdir -p ~/www/webpage/ && nano ~/www/webpage/index.html
```

--------------------------------

### 获取 Xray 基础帮助信息

Source: https://xtls.github.io/document/command.html

运行 xray help 查看所有可用命令及其说明。

```bash
Xray is a platform for building proxies.

Usage:

        xray <command> [arguments]

The commands are:

        run          Run Xray with config, the default command
        version      Show current version of Xray
        api          Call an API in an Xray process
        convert      Convert configs
        tls          TLS tools
        uuid         Generate UUIDv4 or UUIDv5 (VLESS)
        x25519       Generate key pair for X25519 key exchange (REALITY, VLESS Encryption)
        wg           Generate key pair for X25519 key exchange (WireGuard)
        mldsa65      Generate key pair for ML-DSA-65 post-quantum signature (REALITY)
        mlkem768     Generate key pair for ML-KEM-768 post-quantum key exchange (VLESS Encryption)
        vlessenc     Generate decryption/encryption json pair (VLESS Encryption)

Use "xray help <command>" for more information about a command.
```

--------------------------------

### Run Xray-core via Command Line

Source: https://xtls.github.io/document/level-0/ch08-xray-clients.html

Commands to launch Xray-core by specifying the configuration file path on different operating systems.

```shell
C:\Xray-windows-64\xray.exe -c C:\Xray-windows-64\config.json
```

```shell
/usr/local/bin/xray -c /usr/local/etc/xray/config.json
```

--------------------------------

### 配置 Nginx 服务器

Source: https://xtls.github.io/document/level-0/ch05-webpage.html

修改 Nginx 配置文件以指向自定义网页目录，并重新加载服务。

```shell
sudo nano /etc/nginx/nginx.conf
```

```text
        server {
                listen 80;
                server_name 二级域名.你的域名.com;
                root /home/vpsadmin/www/webpage;
                index index.html;
        }
```

```shell
sudo systemctl reload nginx
```

--------------------------------

### Configure GOPROXY

Source: https://xtls.github.io/development/intro/compile.html

Set the GOPROXY environment variable to ensure dependencies can be fetched in restricted network environments.

```bash
go env -w GOPROXY=https://goproxy.io,direct
```

--------------------------------

### Socks Outbound Configuration Object

Source: https://xtls.github.io/config/outbounds/socks.html

Example configuration for a Socks outbound within the outbounds array. Note that Socks protocol does not provide transport encryption and is not suitable for public network transmission.

```json
{
  "outbounds": [
    {
      // ...
      "protocol": "socks",
      "settings": {
        "address": "127.0.0.1",
        "port": 1234,
        "user": "test user",
        "pass": "test pass",
        "level": 0,
        "email": "love@xray.com"
      }
    }
  ]
}
```

--------------------------------

### DNS Query Strategy Configuration

Source: https://xtls.github.io/config/dns.html

Demonstrates how to set global and per-server query strategies to control whether A or AAAA records are requested.

```json
{
  "dns": {
    "servers": [
      "https://1.1.1.1/dns-query",
      {
        "address": "https://8.8.8.8/dns-query",
        "domains": ["geosite:netflix"],
        "skipFallback": true,
        "queryStrategy": "UseIPv4" // netflix 的域名查询 A 记录
      },
      {
        "address": "https://1.1.1.1/dns-query",
        "domains": ["geosite:openai"],
        "skipFallback": true,
        "queryStrategy": "UseIPv6" // openai 的域名查询 AAAA 记录
      }
    ],
    "queryStrategy": "UseIP" // 全局同时查询 A 和 AAAA 记录
  }
}
```

--------------------------------

### Load Xray Configuration

Source: https://xtls.github.io/document/command.html

Various methods to provide configuration files to the Xray runtime, including local files, stdin, remote URLs, and Unix Domain Sockets.

```bash
xray run -config ./config.json
```

```bash
cat config.json | xray run -config stdin:
```

```bash
xray run -config https://example.com/xray/config.json
```

```bash
xray run -config http+unix:///run/xray-config.sock/config.json
```

--------------------------------

### 查看合并后的配置

Source: https://xtls.github.io/config/features/multiple.html

使用 -dump 参数查看最终合并后的配置，注意输出格式可能因 protobuf 内部处理而有所不同。

```shell
xray run -confdir=./confs -dump
```

--------------------------------

### Reproducible Build

Source: https://xtls.github.io/development/intro/compile.html

Perform a reproducible build by injecting the commit ID into the binary.

```bash
CGO_ENABLED=0 go build -o xray -trimpath -buildvcs=false -gcflags="all=-l=4" -ldflags="-X github.com/xtls/xray-core/core.build=<short commit ID> -s -w -buildid=" -v ./main
```

```bash
CGO_ENABLED=0 go build -o xray -trimpath -buildvcs=false -gcflags="-l=4" -ldflags="-X github.com/xtls/xray-core/core.build=<short commit ID> -s -w -buildid=" -v ./main
```

--------------------------------

### List API Services via grpcurl

Source: https://xtls.github.io/config/api.html

Uses grpcurl to query the gRPC server for available API services.

```bash
$ grpcurl -plaintext localhost:10085 list
grpc.reflection.v1alpha.ServerReflection
v2ray.core.app.proxyman.command.HandlerService
v2ray.core.app.stats.command.StatsService
xray.app.proxyman.command.HandlerService
xray.app.stats.command.StatsService
```

--------------------------------

### 管理 Xray 服务

Source: https://xtls.github.io/document/level-0/ch07-xray-server.html

使用 systemctl 命令对 Xray 服务进行启动、状态查询、停止、重启、禁用及启用操作。

```shell
sudo systemctl start xray
```

```shell
sudo systemctl status xray
```

```shell
sudo systemctl stop xray
```

```shell
sudo systemctl restart xray
```

```shell
sudo systemctl disable xray
```

```shell
sudo systemctl enable xray
```

--------------------------------

### 创建证书存放目录

Source: https://xtls.github.io/document/level-0/ch07-xray-server.html

在用户目录下创建用于存放 Xray 证书的文件夹，以规避权限问题。

```shell
mkdir ~/xray_cert
```

--------------------------------

### 修改日志文件权限

Source: https://xtls.github.io/document/level-0/ch07-xray-server.html

赋予所有用户对日志文件的写权限，以避免 Xray 运行时的权限问题。

```shell
chmod a+w ~/xray_log/*.log
```

--------------------------------

### 设置文件权限

Source: https://xtls.github.io/document/level-0/ch05-webpage.html

赋予其他用户读取网页文件的权限。

```shell
chmod -R a+r .
```

--------------------------------

### 启动 Xray 多配置文件目录

Source: https://xtls.github.io/config/features/multiple.html

使用 -confdir 参数指定包含多个配置文件的目录。可以通过文件名前缀数字（如 01_）控制加载顺序。

```shell
$ xray run -confdir /etc/xray/confs
```
Tokens:
Raw