mirror of
https://github.com/nyakang/nyaterm.git
synced 2026-09-21 16:01:29 +00:00
docs: update README and session types documentation to include RDP and VNC support
- Enhanced README files to reflect the addition of RDP and VNC session types in NyaTerm. - Updated session types documentation to clarify features and configurations for RDP and VNC sessions. - Improved localization in both English and Simplified Chinese to ensure consistency across documentation.
This commit is contained in:
Kang
@@ -15,7 +15,7 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
SSH, local shells, Telnet, Serial, SFTP, tunnels, OTP, AI assistance, and encrypted sync in one desktop client.
|
||||
SSH, local shells, Telnet, Serial, RDP, VNC, SFTP, tunnels, OTP, AI assistance, and encrypted sync in one desktop client.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
@@ -75,7 +75,7 @@ NyaTerm includes an AI Assistant panel for command generation, terminal output e
|
||||
- **NyaTerm is** an SSH client for developers, sysadmins, and DevOps engineers
|
||||
- **NyaTerm is** a terminal workspace with tabs, horizontal splits, and vertical splits
|
||||
- **NyaTerm is** an SFTP browser with a transfer queue and local-edit-then-upload-back workflow
|
||||
- **NyaTerm supports** SSH, Local Terminal, Telnet, and Serial sessions
|
||||
- **NyaTerm supports** SSH, Local Terminal, Telnet, Serial, RDP, and VNC sessions
|
||||
- **NyaTerm is not** a shell replacement; it connects to remote shells, local shells, Telnet endpoints, and serial devices
|
||||
|
||||
---
|
||||
@@ -98,8 +98,9 @@ NyaTerm is built for people who move between servers, local commands, devices, a
|
||||
|
||||
## Sessions and Workspace
|
||||
|
||||
- SSH, Local Terminal, Telnet, and Serial session support
|
||||
- SSH, Local Terminal, Telnet, Serial, RDP, and VNC session support
|
||||
- Multi-tab workspace with horizontal and vertical pane splits, tab drag docking, and layout restoration
|
||||
- RDP and VNC remote desktop panes; VNC currently supports direct TCP, None / classic VNC Auth, Raw / ZRLE / Tight / Tight JPEG framebuffer updates, window scaling, bounded reconnects, and text clipboard exchange for Latin-1 text
|
||||
- Saved connections with folders, icons, metadata, duplication, keyboard copy, reconnect, and import flows
|
||||
- Command Palette and session quick switcher for finding actions, open sessions, saved connections, and new-session entry points
|
||||
- Main-window `Background Image` customization with `cover` / `contain` / `stretch` / `tile` sizing and adjustable `Background Content Opacity`
|
||||
|
||||
+4
-3
@@ -15,7 +15,7 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
在一个桌面客户端中处理 SSH、本地 Shell、Telnet、串口、SFTP、隧道、OTP、AI 辅助与加密同步。
|
||||
在一个桌面客户端中处理 SSH、本地 Shell、Telnet、串口、RDP、VNC、SFTP、隧道、OTP、AI 辅助与加密同步。
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
@@ -88,7 +88,7 @@ NyaTerm 内置 AI Assistant 面板，可用于生成命令、解释终端输出
|
||||
- **NyaTerm 是** 面向开发者、系统管理员和 DevOps 工程师的 SSH 客户端
|
||||
- **NyaTerm 是** 支持标签页、横向分屏和纵向分屏的终端工作区
|
||||
- **NyaTerm 是** 带传输队列和“本地编辑后回传”流程的 SFTP 文件浏览器
|
||||
- **NyaTerm 支持** SSH、本地终端、Telnet 和串口会话
|
||||
- **NyaTerm 支持** SSH、本地终端、Telnet、串口、RDP 和 VNC 会话
|
||||
- **NyaTerm 不是** Shell 替代品；它用于连接远程 Shell、本地 Shell、Telnet 端点和串口设备
|
||||
|
||||
---
|
||||
@@ -111,8 +111,9 @@ NyaTerm 适合每天在服务器、本地命令、设备调试和配置文件之
|
||||
|
||||
## 会话与工作区
|
||||
|
||||
- 支持 SSH、本地终端、Telnet 和串口会话
|
||||
- 支持 SSH、本地终端、Telnet、串口、RDP 和 VNC 会话
|
||||
- 多标签页工作区，标签页内支持横向/纵向分屏、标签拖拽停靠和布局恢复
|
||||
- RDP 与 VNC 远程桌面 pane；VNC 当前支持 direct TCP、None / classic VNC Auth、Raw / ZRLE / Tight / Tight JPEG framebuffer 更新、窗口缩放、有界重连，以及 Latin-1 文本剪贴板交换
|
||||
- 已保存连接支持分组、图标、元数据、复制、键盘复制、重连和导入
|
||||
- 命令面板与会话快速切换器，可查找应用动作、已打开会话、已保存连接和新建会话入口
|
||||
- 主窗口支持 `Background Image` 背景图自定义，可调 `cover` / `contain` / `stretch` / `tile` 以及 `Background Content Opacity`
|
||||
|
||||
@@ -4,13 +4,14 @@ sidebar_position: 0
|
||||
|
||||
# 会话类型
|
||||
|
||||
NyaTerm 不只是 SSH 客户端，而是一个把多类终端与远程桌面工作流放到同一工作区中的桌面应用。当前支持五类会话：
|
||||
NyaTerm 不只是 SSH 客户端，而是一个把多类终端与远程桌面工作流放到同一工作区中的桌面应用。当前支持六类会话：
|
||||
|
||||
- **SSH**
|
||||
- **本地终端**
|
||||
- **Telnet**
|
||||
- **串口**
|
||||
- **RDP**
|
||||
- **VNC**
|
||||
|
||||
理解它们之间的差异，有助于你判断某个功能为什么“只在某些标签页里出现”。
|
||||
|
||||
@@ -23,6 +24,7 @@ NyaTerm 不只是 SSH 客户端，而是一个把多类终端与远程桌面工
|
||||
| Telnet | 旧设备、实验环境、兼容性排障 | 终端工作区能力，支持 `Backspace Mode`，但不包含 SSH 专属特性 |
|
||||
| 串口 | 路由器、交换机、板卡、嵌入式调试口 | 串口参数配置、`Backspace Mode` 与终端工作区能力 |
|
||||
| RDP | Windows 远程桌面、图形化运维入口 | 远程桌面画面、NLA/CredSSP、证书验证、文本剪贴板、窗口适配与重连 |
|
||||
| VNC | 裸 TCP VNC 服务、虚拟机控制台、轻量图形远程桌面 | Raw / ZRLE / Tight / Tight JPEG 显示、None / VNC Auth、窗口适配、文本剪贴板与重连 |
|
||||
|
||||
## SSH
|
||||
|
||||
@@ -120,6 +122,32 @@ RDP 会话适合连接 Windows 主机或提供 RDP 服务的远程桌面环境
|
||||
|
||||
RDP 目前不提供终端命令历史、SFTP 文件浏览器、SSH 代理 / 跳板机或远程资源监控。如果你需要命令行增强能力，应优先使用 SSH、本地终端、Telnet 或串口会话。
|
||||
|
||||
## VNC
|
||||
|
||||
VNC 会话适合连接提供传统 RFB / VNC 服务的虚拟机控制台、实验环境或轻量图形桌面。它和 RDP 一样使用远程桌面 pane，并共享保存连接、最近使用、标签页和分屏工作区。
|
||||
|
||||
创建 VNC 会话时可以配置：
|
||||
|
||||
- 主机和端口
|
||||
- 安全模式：自动、None 或 classic VNC Authentication
|
||||
- 显示模式：适应窗口、实际尺寸或拉伸
|
||||
- 文本剪贴板开关
|
||||
- 自动重连次数
|
||||
- shared / view-only 行为
|
||||
|
||||
当前 VNC 传输仅支持 direct TCP，没有 TLS / VeNCrypt。classic VNC Authentication 的密码限制为 8 字节以内，NyaTerm 会拒绝超长密码而不会截断。画面编码默认按 `DesktopSizePseudo`、ZRLE、Tight、Raw 顺序声明；Tight JPEG 会在后端解码成统一 RGBA framebuffer，Raw 仍保留为稳定 fallback。暂不支持 CopyRect、cursor pseudo-encoding、远程 resize、代理和 SSH transport。文本剪贴板限定为 Latin-1 文本，避免把二进制或超大内容塞进 VNC 协议路径。
|
||||
|
||||
### VNC 互通矩阵
|
||||
|
||||
| 场景 | 安全模式 | 编码 | 状态 |
|
||||
| --- | --- | --- | --- |
|
||||
| Scripted RFB 3.8 fixture | None | ZRLE / Tight / Tight JPEG -> RGBA RawImage | 已通过自动测试 |
|
||||
| Scripted RFB 3.8 fixture | classic VNC Auth | ZRLE / Tight / Tight JPEG -> RGBA RawImage | 已通过自动测试 |
|
||||
| TigerVNC | None / VNC Auth | Raw / ZRLE / Tight / JPEG | 真实服务器待测 |
|
||||
| TightVNC | None / VNC Auth | Raw / Tight / JPEG | 真实服务器待测 |
|
||||
| x11vnc / LibVNCServer | None / VNC Auth | Raw / ZRLE / Tight / JPEG | 真实服务器待测 |
|
||||
| QEMU / KVM VNC | None / VNC Auth | Raw / ZRLE / Tight / JPEG | 真实服务器待测 |
|
||||
|
||||
## 如何选择？
|
||||
|
||||
可以按下面这个简单规则判断：
|
||||
@@ -129,6 +157,7 @@ RDP 目前不提供终端命令历史、SFTP 文件浏览器、SSH 代理 / 跳
|
||||
- 要兼容传统远程终端：用 **Telnet**
|
||||
- 要接调试口 / 设备串口：用 **串口**
|
||||
- 要 Windows 图形远程桌面：用 **RDP**
|
||||
- 要 VNC / 虚拟机控制台图形桌面：用 **VNC**
|
||||
|
||||
## 在一个工作区里混用
|
||||
|
||||
@@ -138,5 +167,6 @@ NyaTerm 的优势之一，是允许你把这些类型混合放进同一工作区
|
||||
- 右边本地终端执行打包脚本
|
||||
- 再开一个串口标签观察设备启动信息
|
||||
- 另一个分屏中打开 RDP 查看 Windows 远程桌面状态
|
||||
- 再开一个 VNC pane 操作虚拟机控制台
|
||||
|
||||
这也是为什么文档里很多功能会写成“某会话类型专属”或“某会话类型才显示”的原因——工作区统一，但能力边界仍然取决于底层会话类型。
|
||||
|
||||
@@ -4,13 +4,14 @@ sidebar_position: 0
|
||||
|
||||
# Session Types
|
||||
|
||||
NyaTerm is not just an SSH client. It is a desktop app that puts multiple terminal and remote-desktop workflows into one workspace. It currently supports five session types:
|
||||
NyaTerm is not just an SSH client. It is a desktop app that puts multiple terminal and remote-desktop workflows into one workspace. It currently supports six session types:
|
||||
|
||||
- **SSH**
|
||||
- **Local Terminal**
|
||||
- **Telnet**
|
||||
- **Serial**
|
||||
- **RDP**
|
||||
- **VNC**
|
||||
|
||||
Understanding the differences helps explain why some panels or enhancements only appear for certain tabs.
|
||||
|
||||
@@ -23,6 +24,7 @@ Understanding the differences helps explain why some panels or enhancements only
|
||||
| Telnet | Legacy devices, lab environments, compatibility troubleshooting | Terminal workspace features with `Backspace Mode`, but not SSH-only features |
|
||||
| Serial | Routers, switches, boards, embedded debug ports | Serial port settings, `Backspace Mode`, and terminal workspace features |
|
||||
| RDP | Windows Remote Desktop or graphical administration entry points | Remote desktop display, NLA/CredSSP, certificate verification, text clipboard, window fitting, and reconnects |
|
||||
| VNC | Raw TCP VNC services, VM consoles, lightweight graphical remote desktops | Raw / ZRLE / Tight / Tight JPEG display, None / VNC Auth, window scaling, text clipboard, and reconnects |
|
||||
|
||||
## SSH
|
||||
|
||||
@@ -118,6 +120,32 @@ When connecting to an RDP host with an unknown certificate, NyaTerm opens a cert
|
||||
|
||||
RDP does not provide terminal command history, the SFTP file explorer, SSH proxy/jump-host behavior, or remote resource monitoring. If you need command-line enhancements, use SSH, Local Terminal, Telnet, or Serial instead.
|
||||
|
||||
## VNC
|
||||
|
||||
VNC sessions are for traditional RFB / VNC services such as VM consoles, lab environments, and lightweight graphical desktops. Like RDP, they use a remote-desktop pane and share NyaTerm's saved-connection, recent-use, tab, and split-pane workspace model.
|
||||
|
||||
When creating a VNC session, you can configure:
|
||||
|
||||
- Host and port
|
||||
- Security mode: automatic, None, or classic VNC Authentication
|
||||
- Display mode: fit to window, actual size, or stretch
|
||||
- Text clipboard toggle
|
||||
- Automatic reconnect attempts
|
||||
- Shared / view-only behavior
|
||||
|
||||
The current VNC transport is direct TCP only, with no TLS / VeNCrypt. Classic VNC Authentication passwords are limited to 8 bytes; NyaTerm rejects longer passwords instead of truncating them. Framebuffer encodings are advertised by default as `DesktopSizePseudo`, ZRLE, Tight, then Raw; Tight JPEG is decoded in the backend into the same RGBA framebuffer path, and Raw remains the stable fallback. CopyRect, cursor pseudo-encoding, remote resize, proxies, and SSH transport are not supported. Text clipboard exchange is limited to Latin-1 text so binary or oversized payloads do not enter the VNC protocol path.
|
||||
|
||||
### VNC Interop Matrix
|
||||
|
||||
| Scenario | Security | Encoding | Status |
|
||||
| --- | --- | --- | --- |
|
||||
| Scripted RFB 3.8 fixture | None | ZRLE / Tight / Tight JPEG -> RGBA RawImage | Automated test passed |
|
||||
| Scripted RFB 3.8 fixture | classic VNC Auth | ZRLE / Tight / Tight JPEG -> RGBA RawImage | Automated test passed |
|
||||
| TigerVNC | None / VNC Auth | Raw / ZRLE / Tight / JPEG | Real server untested |
|
||||
| TightVNC | None / VNC Auth | Raw / Tight / JPEG | Real server untested |
|
||||
| x11vnc / LibVNCServer | None / VNC Auth | Raw / ZRLE / Tight / JPEG | Real server untested |
|
||||
| QEMU / KVM VNC | None / VNC Auth | Raw / ZRLE / Tight / JPEG | Real server untested |
|
||||
|
||||
## How to choose
|
||||
|
||||
A simple rule of thumb:
|
||||
@@ -127,6 +155,7 @@ A simple rule of thumb:
|
||||
- Need a traditional remote terminal? Use **Telnet**
|
||||
- Need a device console or debug port? Use **Serial**
|
||||
- Need a graphical Windows remote desktop? Use **RDP**
|
||||
- Need a VNC / VM console graphical desktop? Use **VNC**
|
||||
|
||||
## Mix them in one workspace
|
||||
|
||||
@@ -136,6 +165,7 @@ One of NyaTerm's strengths is that you can mix these session types in the same w
|
||||
- Local Terminal on the right to run packaging or Git commands
|
||||
- A Serial tab open to watch device boot output
|
||||
- An RDP pane open to inspect a Windows remote desktop
|
||||
- A VNC pane open to operate a VM console
|
||||
|
||||
That is why some features are documented as session-specific. The workspace is shared, but the capability boundary still depends on the underlying session type.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user