Skip to content

docs: 更新基本使用说明，明确系统代理默认行为 #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sesame2 merged 1 commit into from
Oct 26, 2025
Merged

docs: 更新基本使用说明，明确系统代理默认行为 #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ go install github.com/Sesame2/gotun/cmd/gotun@latest
### 基本使用

```bash
# 基本用法：连接到SSH服务器并启动代理
# 基本用法：连接到SSH服务器并启动系统代理
./gotun [email protected]

# 指定SSH端口
Expand All @@ -104,8 +104,9 @@ go install github.com/Sesame2/gotun/cmd/gotun@latest
# 自定义代理监听端口
./gotun -listen :8888 [email protected]

# 自动设置系统代理
./gotun -sys-proxy [email protected]
# 自动设置系统代理（默认开启）
# 若你希望启动时不修改系统代理，请显式关闭：
./gotun -sys-proxy=false [email protected]
```

### 在浏览器中使用
Expand Down Expand Up @@ -146,7 +147,7 @@ go install github.com/Sesame2/gotun/cmd/gotun@latest
./gotun [email protected]
```

启动后，配置浏览器或应用使用 `http://127.0.0.1:8080` 代理，即可访问内网地址如 `http://192.168.1.100:8080`。
启动后，浏览器和其他支持系统代理的应用将自动通过 `gotun` 访问网络。现在可以直接在浏览器中打开 `http://192.168.1.100:8080` 等内网地址。

#### 2. 开发调试

Expand All @@ -157,13 +158,16 @@ go install github.com/Sesame2/gotun/cmd/gotun@latest
./gotun -listen :8888 -v [email protected]
```

`gotun` 会自动设置系统代理（指向 `127.0.0.1:8888`）。开发工具如果支持系统代理，将能直接访问远程资源。如果不想影响系统其他应用的联网，可以禁用系统代理并手动配置开发工具：
`./gotun -sys-proxy=false -listen :8888 -v [email protected]`

#### 3. 作为网络出口

将远程服务器作为你当前网络的出口，适合需要固定IP或访问特定网络资源的场景。

```bash
# 启动并自动配置为系统代理
./gotun -sys-proxy [email protected]
./gotun [email protected]
```

### 跳板机 (Jump Host)
Expand Down Expand Up @@ -223,7 +227,9 @@ go install github.com/Sesame2/gotun/cmd/gotun@latest

### 系统代理设置

当使用 `-sys-proxy` 参数时，程序会自动：
默认情况下 (`-sys-proxy=true`)，`gotun` 会自动管理您操作系统的 HTTP 代理。如果您不希望 `gotun` 修改您的系统设置，可以在启动时使用 `-sys-proxy=false` 参数来禁用此功能。

当系统代理功能开启时，程序会：

1. **启动时**: 保存当前系统代理设置，然后设置为使用 gotun 代理
2. **运行中**: 所有系统网络流量通过 gotun 代理
Expand All @@ -244,7 +250,7 @@ go install github.com/Sesame2/gotun/cmd/gotun@latest
./gotun -v [email protected]

# 指定日志文件
./gotun -v -log /tmp/gotun.log [email protected]
./gotun -v -log ./gotun.log [email protected]
```

#### 权限问题
Expand Down