# tunnel

**Repository Path**: XiaoYangProject/tunnel

## Basic Information

- **Project Name**: tunnel
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-25
- **Last Updated**: 2026-06-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 内网穿透工具 (Tunnel)

基于 ngrok 的内网穿透工具，一键将本地服务暴露到公网。

## 使用方式

### 1. 获取 authtoken

打开 https://dashboard.ngrok.com/get-started/your-authtoken 注册免费账号（用 GitHub/Google 直接登录），复制 authtoken。

### 2. 启动你的本地服务

```bash
dotnet run --project MyWebApp
python -m http.server 3000
npm run dev
```

### 3. 打开客户端

```bash
cd src/Tunnel.Client
dotnet run
```

填入 authtoken 和本地端口，点击"启动隧道"。首次运行会自动下载 ngrok，稍等片刻即获得公网地址：

```
https://xxxx.ngrok-free.app
```

### 4. 分享地址

把这个地址发给任何人即可访问你的本地服务。

## 工作原理

```
外网用户 ──(HTTPS)──> ngrok 服务器 ──(隧道)──> 你的电脑 ──(HTTP)──> 本地服务
```

## 常见问题

### Cloudflare 版本不在了？

Cloudflare Tunnel 在国内经常连不上，已切换为 ngrok（亚洲有节点）。

### authtoken 从哪里获取

免费注册 ngrok 账号即可获得: https://dashboard.ngrok.com/get-started/your-authtoken

### 下载慢

手动下载 ngrok.exe: https://ngrok.com/download, 解压到程序目录下的 `ngrok/` 文件夹。

## 项目结构

```
tunnel/
├── src/
│   ├── Tunnel.Common/     # 共享协议库 (TCP 消息帧)
│   ├── Tunnel.Server/     # 自建服务端 (可选)
│   └── Tunnel.Client/     # WPF 桌面客户端
└── tunnel.sln
```