使用文档

详细的使用指南和常见问题解答

文档目录

快速开始

1. 下载客户端

首先从下载页面获取适合您系统的客户端版本。

Windows

# 在Powershell中使用命令行直接运行程序
wxt-windows-amd64.exe

Linux 和 macOS

# 修改权限后直接运行
chmod +x wxt-linux-amd64
./wxt-linux-amd64
chmod +x wxt-darwin-amd64
./wxt-darwin-amd64

2. 创建配置文件

在客户端软件同目录创建配置文件，文件名称为 wxt.yml：


authtoken: "your_auth_token_here"
tunnels:
  site:
    proto: https
    addr: 3000
  ssh:
    proto: tcp
    addr: 22

3. Web服务隧道配置

将本地Web服务暴露到公网的详细配置：

tunnels:
  site1:
    proto: http
    addr: 192.168.1.100:3000  #若是本机服务直接配置端口号
    subdomain: myapp-secure1  #若不配置subdomain系统会生成随机域名，需登录后操作
    auth: "user:password"   #可选，用于HTTP Basic Authentication
    hostname: your-domain  #可选，绑定自己的域名，优先于subdomain。需要在DNS添加CNAME记录指向 wxtnet.site
    websocket: true      #若使用此通道传输WebSocket， 则配置此参数。Http协议下支持WebSocket(ws://)
  site2:
    proto: https               #建议优先使用HTTPS，确保您的本地服务安全
    addr: 192.168.1.100:4000
    subdomain: myapp-secure2
    auth: "user:password"
    websocket: true      #若使用此通道传输WebSocket， 则配置此参数。Http协议下支持WebSocket Secure (wss://)

4. TCP/UDP 隧道配置

用于数据库访问、SSH连接、应用系统等TCP/UDP服务：

tunnels
  tcp1:
    proto: tcp
    addr: 22        #本地端口号
    remote_addr: 50050  #服务器端口号，固定端口号需登录后操作。若未指定则随机分配。
  udp1:
    proto: udp
    addr: 4000
    remote_addr: 40050  #服务器端口号，固定端口号需登录后操作。若未指定则随机分配。

高级功能

1. 命令行参数

使用命令行参数


./wxt [全局选项] <命令> [命令选项]

| 全局选项         | 说明                                           |
| ---------------- | ---------------------------------------------- |
| -config=PATH     | 指定配置文件路径                               |
| -log=PATH        | 指定日志文件路径                               |
| -loglevel=LEVEL  | 设置日志级别 (DEBUG, INFO, WARNING, ERROR)     |
| -authtoken=TOKEN | 设置认证令牌（令牌保存到配置文件中并启动隧道） |

命令:
  start <隧道名称><隧道名称>      启动隧道
  version     显示版本信息
  help        显示帮助信息
  list        列出当前隧道信息
  http/https <端口号>   创建HTTP/HTTPS隧道
  tcp <端口号>       创建TCP隧道

2. 本地WEB监控

客户端提供了一个内置的Web界面用于监控隧道状态和流量。Web界面运行在 `http://127.0.0.1:4040`。

通过WEB界面，您可以：

  1. 查看所有活动隧道
  2. 查看请求和响应详情
  3. 重放HTTP请求

常见问题

客户端无法连接到服务器怎么办？

请检查以下几个方面：

  • 确认网络连接正常，可以访问外网
  • 检查防火墙设置，确保没有阻止客户端的网络访问
  • 确认订阅有效期
  • 验证认证Token是否有效
隧道无法访问

请检查以下几个方面：

  • 本地服务是否正常运行
  • 本地服务端口是否正确
  • 本地防火墙是否阻止了连接
认证失败

请检查以下几个方面：

  • authtoken是否正确
  • 订阅是否已过有效期
  • 是否已在其他主机使用（实例数超出订阅数量）
支持哪些本地端口？

WxtNet支持几乎所有端口：

  • HTTP/HTTPS隧道：支持任意本地端口
  • TCP/UDP隧道：支持1-65535端口范围
  • 建议避免使用系统保留端口（1-1023）

故障排除

连接问题诊断

检查网络连通性

# 测试服务器连通性
ping wxtnet.site

日志分析

客户端日志位置：

  • Windows: 客户端软件目录\logs\
  • Linux: 客户端软件目录/logs/
  • macOS: 客户端软件目录/logs/

技术支持

如果您在使用过程中遇到问题，可以通过以下方式获取帮助：

邮件支持

发送邮件，我们会在24小时内回复您的问题。

在线客服

目前尚未开通。

QQ群交流

加入QQ群与其他用户交流使用心得和解决方案。