Skip to content

Commit d2d3ff5

Browse files
committed
docs: update landing page and readme content
1 parent a304585 commit d2d3ff5

6 files changed

Lines changed: 41 additions & 29 deletions

File tree

README.CN.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
[English](README.md)
66

7-
**一款桌面 GUI 应用,用于管理 SSH 隧道——支持自动重连,界面简洁易用。**
7+
**快速稳定的 SSH 隧道管理工具**
8+
9+
**在 macOS 和 Windows 上轻松管理 SSH 隧道,自动重连、集中整理,日常使用更省心。**
810

911
![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Windows-blue)
1012
![License](https://img.shields.io/badge/license-Apache%202.0-green)
@@ -16,9 +18,9 @@
1618

1719
## 项目简介
1820

19-
**Loris Tunnel** 是一款跨平台桌面应用,让你通过图形界面创建、管理和监控 SSH 隧道。它将 SSH 端口转发的能力封装成直观的 UI,并支持自动重连,即使网络不稳定也能保持隧道畅通
21+
**Loris Tunnel** 是一款跨平台桌面应用,用图形界面帮你创建、管理和监控 SSH 隧道。它把常用的 SSH 端口转发能力整理成易用的桌面界面,并内置自动重连机制,网络波动时也能尽量保持连接稳定
2022

21-
适合经常需要访问防火墙后面的远程服务器、数据库和内网服务的开发者与运维工程师——不用每次都敲命令行
23+
如果你经常需要访问远程服务器、数据库,或防火墙后的内网服务,Loris Tunnel 可以把这些隧道集中管理起来,减少反复敲命令和手动排查连接状态的麻烦
2224

2325
![总览](screenshots/screenshot-overview.png)
2426

@@ -37,17 +39,17 @@
3739
- 🧠 **AI Debug 故障分析** — 当跳板机或隧道连接测试失败时,一键触发 AI 分析,快速给出可能根因和可执行修复建议
3840
- ▶️ **启动时自动开启** — 将隧道标记为自动启动,应用打开后立即连接
3941
- 🌍 **跨平台** — 支持 macOS 和 Windows
40-
- 💬 **多语言 UI**English 与 简体中文
42+
- 💬 **多语言界面**支持英文和简体中文
4143

4244
---
4345

4446
## 截图
4547

46-
**从 SSH 命令批量导入隧道**
48+
**从 SSH 命令导入隧道**
4749

4850
![从 SSH 命令导入](screenshots/screenshot-create-tunnels-from-ssh-command.png)
4951

50-
**实时显示 SSH 连接延迟:**
52+
**查看 SSH 连接延迟:**
5153

5254
![SSH 延迟](screenshots/screenshot-show-ssh-latency.png)
5355

@@ -57,24 +59,24 @@
5759

5860
### 下载安装
5961

60-
前往 [Releases](../../releases) 页面下载最新版本
62+
前往 [Releases](../../releases) 页面下载最新版本
6163

6264
- **macOS**`.dmg` 安装包
6365
- **Windows**`.exe` 安装包
6466

65-
### macOS 运行隔离放行方法
67+
### macOS 安全提示处理
6668

67-
首次运行 macOS 版本时,可能会遇到系统安全拦截。以下是两种解除方法:
69+
首次运行 macOS 版本时,系统可能会提示无法打开应用。可以通过下面两种方式放行。
6870

6971
**方法一:系统设置放行**
7072

71-
1. 打开应用遇到拦截弹窗后,点击"取消"
72-
2. 打开系统的"系统设置" -> "隐私与安全性"
73-
3. 向下滚动,找到安全性板块,点击"仍要打开"
73+
1. 打开应用并看到安全提示后,点击“取消”
74+
2. 打开“系统设置 -> 隐私与安全性
75+
3. 在安全性区域找到 Loris Tunnel,点击“仍要打开
7476

75-
**方法二:终端一键解除**
77+
**方法二:通过终端解除限制**
7678

77-
打开终端(Terminal),输入以下命令并回车(可能需要输入电脑密码):
79+
打开终端(Terminal),执行下面的命令。系统可能会要求输入电脑密码。
7880

7981
```bash
8082
sudo xattr -rd com.apple.quarantine /Applications/loris-tunnel.app
@@ -106,15 +108,15 @@ wails build
106108

107109
## 配置文件
108110

109-
Loris Tunnel 使用 TOML 格式存储配置,路径解析规则如下
111+
Loris Tunnel 使用 TOML 文件保存配置,配置文件位置按以下规则确定
110112

111113
- **开发模式(`wails dev`**
112-
- 若当前工作目录可写:使用 `./config.toml`
113-
- 否则:使用 `~/.loris-tunnel/config.toml`
114-
- **打包后的生产版本(二进制,可执行文件,包括开机自启动)**
114+
- 如果当前工作目录可写,使用 `./config.toml`
115+
- 否则使用 `~/.loris-tunnel/config.toml`
116+
- **打包后的正式版本(二进制可执行文件,包括开机自启动)**
115117
- 始终使用 `~/.loris-tunnel/config.toml`
116118

117-
在以上任意模式下,如果目标配置文件不存在或内容为空,Loris Tunnel 会在首次运行时自动创建一个默认配置文件
119+
无论哪种模式,如果目标配置文件不存在或内容为空,Loris Tunnel 都会在首次运行时自动创建默认配置
118120

119121
配置示例:
120122

@@ -142,9 +144,9 @@ remote_port = 5432
142144

143145
| 模式 | 说明 |
144146
|------|------|
145-
| `local` | 将本地端口转发到远程地址(通过 SSH 服务器) |
146-
| `remote` | SSH 服务器上的远程端口转发到本地地址 |
147-
| `socks5` | SSH 服务器为 SOCKS5 代理(动态转发) |
147+
| `local` | 通过 SSH 服务器把本地端口转发到远程地址 |
148+
| `remote` | SSH 服务器上的远程端口转发到本地地址 |
149+
| `socks5` | SSH 服务器作为 SOCKS5 代理使用,也就是动态转发 |
148150

149151
---
150152

@@ -161,7 +163,7 @@ remote_port = 5432
161163

162164
## 社区交流
163165

164-
欢迎加入 QQ 群参与讨论、获取支持和最新动态
166+
欢迎加入 QQ 群交流使用经验、反馈问题,或了解最新动态
165167

166168
- 💬 **QQ 交流群**: **1009737419**
167169
- 📧 **联系作者**: [yang.rangerwolf@gmail.com](mailto:yang.rangerwolf@gmail.com)

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
[简体中文](README.CN.md)
66

7-
**A desktop GUI application for managing SSH tunnels — with automatic reconnection and a clean interface.**
7+
**A Fast, Reliable SSH Tunnel Manager**
8+
9+
**A desktop app that keeps SSH tunnels stable, organized, and easy to manage on macOS and Windows.**
810

911
![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Windows-blue)
1012
![License](https://img.shields.io/badge/license-Apache%202.0-green)

web/docs/.vitepress/config.mts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ export default defineConfig({
66
description: "A desktop GUI application for managing SSH tunnels — with automatic reconnection and a clean interface.",
77
head: [
88
['script', { async: '', src: 'https://www.googletagmanager.com/gtag/js?id=G-776FG9SDVQ' }],
9-
['script', {}, `window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-776FG9SDVQ');`]
9+
['script', {}, `window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-776FG9SDVQ');`],
10+
['link', { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }],
11+
['link', { rel: 'shortcut icon', type: 'image/x-icon', href: '/favicon.ico' }]
1012
],
1113
themeConfig: {
1214
logo: '../imgs/logo.png',
@@ -28,10 +30,8 @@ export default defineConfig({
2830
text: 'Articles',
2931
items: [
3032
{ text: 'All Articles', link: '/articles/' },
31-
{ text: 'Cherry Studio, Codex & SSH MCP (SSH Pilot)', link: '/articles/20260405-cherry-studio-codex-ssh-mcp-pilot' },
3233
{ text: 'Codex SSH Login on Remote Servers', link: '/articles/20260331-codex-ssh-login-with-loris-tunnel' },
3334
{ text: 'OpenClaw + SSH Tunnels', link: '/articles/20260329-openclaw-remote-gateway-ssh-tunnel' },
34-
{ text: 'Sample Template', link: '/articles/20260316-sample' },
3535
]
3636
}
3737
],

web/docs/.vitepress/theme/index.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import DefaultTheme from 'vitepress/theme'
2+
import type { Theme } from 'vitepress'
3+
4+
const theme: Theme = {
5+
...DefaultTheme,
6+
}
7+
8+
export default theme

web/docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ layout: home
33

44
hero:
55
name: "Loris Tunnel"
6-
text: "Efficient SSH Tunnel Management"
7-
tagline: "A desktop GUI application for managing SSH tunnels — with automatic reconnection and a clean interface."
6+
text: "A Fast, Reliable SSH Tunnel Manager"
7+
tagline: "A desktop app that keeps SSH tunnels stable, organized, and easy to manage on macOS and Windows."
88
image:
99
src: /logo.png
1010
alt: Loris Tunnel Logo

web/docs/public/favicon.ico

631 KB
Binary file not shown.

0 commit comments

Comments
 (0)