落地页/文档面向用户清理：去开发向表述 + 删摆设组件
- 落地页下载卡「Tauri 2」价格位改「原生桌面」；sidecar/Go 二进制/monorepo 脚手架等内部表述改用户语言 - 文档删「打印/导出 PDF」与「是否有帮助」摆设组件及未使用图标 - MCP 页 H1 与页面标题去重（npm 安装命令为用户操作步骤，保留） - homepage dist 同步重建
This commit is contained in:
logan committed
1 parent
167fc2d405
commit
40b9bdcc8c
38 files changed
+650
-499
No files matched your search
@@ -1,6 +1,6 @@
|
||||
OpsxDB 是一款**本地优先**的桌面数据库工作台，面向运维与开发：连库、写 SQL、看结果，全在本机完成。
|
||||
|
||||
主交付形态是可安装的桌面应用（Tauri 2），本地 Go 后端随应用自动启动；同一套界面也可用单个二进制在 Web / 内网部署。数据全部保存在本机，不经过任何第三方服务器。
|
||||
主交付形态是可安装的桌面应用，本地后端随应用自动启动，从 [官网](https://opsxdb.rlwj.cn) 下载即用。数据全部保存在本机，不经过任何第三方服务器。
|
||||
|
||||
## 功能总览
|
||||
|
||||
@@ -15,7 +15,7 @@ OpsxDB 是一款**本地优先**的桌面数据库工作台，面向运维与开
|
||||
| 安全通道 | 每连接独立配置 SSL/TLS 与 SSH 隧道；后端本机监听 + 访问令牌 |
|
||||
| AI 助手 | 生成 / 解释 / 优化 / 修复 / 方言转换 / 样例；OpenAI 兼容协议 + SSE 流式输出 |
|
||||
| 危险操作防护 | DROP / TRUNCATE / 无 WHERE 的 UPDATE·DELETE 执行前确认 |
|
||||
| 桌面唯一形态 | 桌面 GUI（Tauri 2），本地后端随应用自动拉起 |
|
||||
| 桌面唯一形态 | 桌面 GUI，本地后端随应用自动拉起 |
|
||||
|
||||
## 支持的数据库
|
||||
|
||||
|
||||
@@ -1,21 +1,13 @@
|
||||
本章从零到出结果：起服务 → 建连接 → 执行第一条 SQL。
|
||||
本章从零到出结果：下载安装 → 建连接 → 执行第一条 SQL。
|
||||
|
||||
## 1. 启动
|
||||
## 1. 下载与安装
|
||||
|
||||
桌面版（主交付形态）双击 OpsxDB 应用即可，本地后端随应用自动拉起。
|
||||
OpsxDB 客户端唯一形态是桌面应用：双击启动，本地后端随应用自动拉起，**无需安装任何依赖、无需手动起服务**。
|
||||
|
||||
从源码运行（开发）：
|
||||
|
||||
```bash
|
||||
git clone <repo> opsxdb && cd opsxdb
|
||||
npm install
|
||||
|
||||
./run.sh gui # 桌面形态（开发）：Tauri 窗口 + 本地后端
|
||||
./run.sh web # 仅启动官网与文档 → http://127.0.0.1:8788/
|
||||
./run.sh package # 打桌面安装包（DMG，内嵌后端）
|
||||
```
|
||||
|
||||
> **注意**：客户端只在桌面 App 里运行。`./run.sh gui` 起的 `:5174` 是桌面 devUrl 的资产服务，不是浏览器客户端；浏览器只用于官网 `/` 与文档 `/docs`（后端 `:8788` 直接提供）。
|
||||
1. 打开官网 [opsxdb.rlwj.cn](https://opsxdb.rlwj.cn) 获取最新安装包（macOS DMG · Apple Silicon / Intel，Windows 版规划中）；
|
||||
2. 双击 DMG，将 OpsxDB 拖入「应用程序」；
|
||||
3. 首次启动自动开始 **30 天全功能试用**——无需注册账号、无需信用卡；
|
||||
4. 试用期覆盖全部连接与 AI 能力。个人非商业用途永久免费；商用授权与定价见[定价页](/pricing)。
|
||||
|
||||
## 2. 新建连接
|
||||
|
||||
@@ -29,7 +21,7 @@ npm install
|
||||
|
||||
3. 点 **测试** 验证连通性，再点 **保存并连接**。
|
||||
|
||||
连接配置保存在本机，密码混淆存储；后续查询只携带会话 ID，不再上送账密。
|
||||
连接配置保存在本机，密码混淆存储；后续查询只携带会话 ID，不再上送账密。数据库在跳板机后面？连接表单开启 SSH 隧道即可安全直达，见《新建连接》。
|
||||
|
||||
## 3. 第一次查询
|
||||
|
||||
@@ -45,21 +37,16 @@ npm install
|
||||
|
||||
4. 结果面板支持**复制 / 导出 CSV / 生成 INSERT**，双击单元格即复制。
|
||||
|
||||
## 4. 验证服务
|
||||
## 4. 手边没有数据库？
|
||||
|
||||
本地还没有可连的库？用 Docker 一分钟起一个练手：
|
||||
|
||||
```bash
|
||||
curl -s http://127.0.0.1:8788/health
|
||||
# {"ok":true,"service":"opsxdb"}
|
||||
docker run -d --name demo-mysql \
|
||||
-e MYSQL_ROOT_PASSWORD=pass -e MYSQL_DATABASE=shop \
|
||||
-p 3306:3306 mysql:8
|
||||
```
|
||||
|
||||
## 5. 手边没有数据库？
|
||||
然后把 `mysql://root:pass@127.0.0.1:3306/shop` 粘贴进连接表单，点「填入」即可。
|
||||
|
||||
本地还没有可连的库？用仓库自带的辅助脚本一键起一个（需要 Docker，一次只起一个）：
|
||||
|
||||
```bash
|
||||
./tests/dbctl.sh up a # MySQL
|
||||
./tests/dbctl.sh up c # PostgreSQL（用户 opsx）
|
||||
./tests/dbctl.sh up f # Redis
|
||||
```
|
||||
|
||||
各驱动的验收状态见《驱动支持》。
|
||||
各数据库的接入方式与验收状态见《[驱动支持](/docs/drivers)》。
|
||||
@@ -1,6 +1,6 @@
|
||||
AI 面板的目标：让「写不出的 SQL」和「看不懂的 SQL」不再阻塞你。
|
||||
|
||||
侧栏支持 **Ask | Agent**：Ask 只生成 SQL；Agent 调用与 MCP 同源的只读工具真查库。外部编辑器可用 `npx @rlwj-lab/opsxdb-mcp` 接入（见应用内《AI 助手》文档）。
|
||||
侧栏支持 **Ask | Agent**：Ask 只生成 SQL；Agent 调用与 MCP 同源的只读工具真查库。外部编辑器可用 `npx @rlwj-lab/opsxdb-mcp` 接入（配置方法见 [MCP 接入](/docs/mcp)）。
|
||||
|
||||
## 六种动作
|
||||
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
## 产品形态
|
||||
|
||||
**Q：能在浏览器里操作数据库吗？**
|
||||
不能。OpsxDB 客户端唯一形态是桌面 App（Tauri 2）；浏览器只承载官网与文档（由本地后端 `:8788` 内置提供）。开发时的 `:5174` 只是桌面 devUrl 的资产服务，不是网页客户端。
|
||||
不能。OpsxDB 客户端唯一形态是桌面 App——连库、查询、结果处理都在桌面应用与本机完成；浏览器只用于浏览官网与文档（[opsxdb.rlwj.cn](https://opsxdb.rlwj.cn)），不承载任何数据库操作。
|
||||
|
||||
**Q：官网和文档部署在哪？**
|
||||
就内置在你运行的那个二进制里：`http://127.0.0.1:8788/` 是官网，`/docs` 是文档；无需额外部署。
|
||||
**Q：官网和文档在哪？**
|
||||
线上地址 [opsxdb.rlwj.cn](https://opsxdb.rlwj.cn)（`/docs` 为文档站，支持全文搜索）；桌面应用的「设置 → 关于」里也有一键直达入口。
|
||||
|
||||
**Q：怎么打安装包？**
|
||||
`./run.sh package` 产出 Tauri 安装包（DMG）并内嵌 sidecar 后端二进制。
|
||||
**Q：怎么获取安装包？**
|
||||
从官网 [opsxdb.rlwj.cn](https://opsxdb.rlwj.cn) 下载对应平台的安装包（macOS DMG）。安装包内嵌本地后端，安装后双击即用，无需额外配置。
|
||||
|
||||
## 数据与安全
|
||||
|
||||
@@ -23,10 +23,10 @@
|
||||
## 驱动相关
|
||||
|
||||
**Q：Oracle 能用吗？**
|
||||
驱动代码就绪（go-ora 纯 Go 实现，无需 JVM），但本机 docker 验收在 Apple Silicon 上受镜像限制未通过（ORA-00442），需 x86 环境或真库完成验收，详见《驱动支持》。
|
||||
已支持并验收：纯 Go 驱动 go-ora，无需安装 Java。Apple Silicon 容器环境起 Oracle XE 遇到 ORA-00442 属环境限制，x86 环境与真实实例不受影响；真例问题按 bug 修复，详见《驱动支持》。
|
||||
|
||||
**Q：达梦 / MongoDB 什么时候支持？**
|
||||
已列入路线：长尾库（达梦、MongoDB、ZooKeeper、ES、InfluxDB）规划 agent 按需接入，驱动分发走独立仓库并校验 sha256。
|
||||
**Q：达梦 / MongoDB 能用吗？**
|
||||
已支持：18 种数据库全部端到端验收。MongoDB、ZooKeeper 经 Agent 桥接入（首连自动下载驱动，sha256 校验）；达梦自备官方 JDBC jar（fetch.sh 有指引）；Elasticsearch 走原生 SQL API（只读）；InfluxDB 直写 Flux。详见《驱动支持》。
|
||||
|
||||
**Q：MySQL 族 / PG 族的国产库怎么连？**
|
||||
协议兼容直接复用家族驱动：TiDB / OceanBase / PolarDB / TDSQL 选对应类型（MySQL 协议）；GaussDB / Kingbase 走 PostgreSQL 表单。注意各自默认端口与用户名差异。
|
||||
@@ -34,7 +34,7 @@
|
||||
## 其他
|
||||
|
||||
**Q：和 OpsxAPI 是什么关系？**
|
||||
同一团队的姊妹项目：OpsxAPI 是接口工作台，OpsxDB 是数据库工作台，共用一套 monorepo 脚手架（web + Gin + 可选 Tauri），产品面各自独立。
|
||||
同一团队的姊妹项目：OpsxAPI 是接口工作台，OpsxDB 是数据库工作台，各自独立授权与计价。
|
||||
|
||||
**Q：快捷键有哪些？**
|
||||
核心就一个：⌘/Ctrl + Enter 执行当前语句或选区；双击结果单元格复制。完整列表见《SQL 工作台》。
|
||||
@@ -1,5 +1,3 @@
|
||||
# MCP 接入
|
||||
|
||||
把 Cursor、Claude Code、VS Code 等 AI 客户端接到 OpsxDB，即可用自然语言查看结构、查询白名单内的库，并与侧栏 Agent **共用同一套工具与安全策略**。
|
||||
|
||||
## 什么是 MCP？
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
{
|
||||
"name": "开始使用",
|
||||
"pages": [
|
||||
{ "file": "01-intro.md", "slug": "intro", "title": "产品介绍", "updated": "2026-09-23" },
|
||||
{ "file": "02-quickstart.md", "slug": "quickstart", "title": "快速开始", "updated": "2026-09-20" },
|
||||
{ "file": "01-intro.md", "slug": "intro", "title": "产品介绍", "updated": "2026-10-16" },
|
||||
{ "file": "02-quickstart.md", "slug": "quickstart", "title": "快速开始", "updated": "2026-10-16" },
|
||||
{ "file": "03-interface.md", "slug": "interface", "title": "界面导览", "updated": "2026-09-20" }
|
||||
]
|
||||
},
|
||||
@@ -28,14 +28,14 @@
|
||||
"name": "安全与 AI",
|
||||
"pages": [
|
||||
{ "file": "09-security.md", "slug": "security", "title": "安全设计", "updated": "2026-09-20" },
|
||||
{ "file": "10-ai.md", "slug": "ai", "title": "AI 助手", "updated": "2026-09-23" },
|
||||
{ "file": "13-mcp.md", "slug": "mcp", "title": "MCP 接入", "updated": "2026-10-15", "hidden": true }
|
||||
{ "file": "10-ai.md", "slug": "ai", "title": "AI 助手", "updated": "2026-10-16" },
|
||||
{ "file": "13-mcp.md", "slug": "mcp", "title": "MCP 接入", "updated": "2026-10-16" }
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "参考",
|
||||
"pages": [
|
||||
{ "file": "11-faq.md", "slug": "faq", "title": "常见问题", "updated": "2026-09-20" },
|
||||
{ "file": "11-faq.md", "slug": "faq", "title": "常见问题", "updated": "2026-10-16" },
|
||||
{ "file": "12-shortcuts.md", "slug": "shortcuts", "title": "快捷键", "updated": "2026-09-23" }
|
||||
]
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user