From 00a8d59284e993844640db332be3263d982e6856 Mon Sep 17 00:00:00 2001 From: dijunkun Date: Wed, 27 May 2026 17:22:51 +0800 Subject: [PATCH] [chore] update README --- README.md | 23 +++++++++++++++++++++++ README_EN.md | 25 +++++++++++++++++++++++++ 2 files changed, 48 insertions(+) diff --git a/README.md b/README.md index 3c88e43..77e1766 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,29 @@ CrossDesk 是 [MiniRTC](https://github.com/kunkundi/minirtc.git) 实时音视频 _cgi-bin_mmwebwx-bin_webwxgetmsgimg__ MsgID=932911462648581698 skey=@crypt_1f5153b1_b550ca7462b5009ce03c991cca2a92a7 mmweb_appid=wx_webfilehelper +### Windows 服务（CrossDesk Service） +CrossDesk 在 Windows 平台提供本地辅助服务 **CrossDesk Service**，服务名为 `CrossDeskService`。该服务用于锁屏、登录界面和安全桌面等受保护场景下的远程控制增强能力，包括： +- 上报远端当前是否处于锁屏、登录、凭据输入或安全桌面状态； +- 支持从控制端发送 `Ctrl+Alt+Del`（SAS）； +- 在锁屏、登录和安全桌面阶段转发键盘、鼠标输入。 + +Windows 安装包会自动打包 `crossdesk_service.exe` 和 `crossdesk_session_helper.exe`，并在安装时注册为按需启动的 Windows 服务。CrossDesk 客户端启动时会尝试启动已安装的服务；当本机没有 CrossDesk 客户端进程运行时，服务会自动退出。卸载客户端时会同步停止并移除该服务。 + +如果是手动编译或手动部署 Windows 版本，请确保 `CrossDesk.exe`、`crossdesk_service.exe` 和 `crossdesk_session_helper.exe` 位于同一目录。安装或卸载服务需要使用管理员权限打开 PowerShell： +``` +# 安装 +.\CrossDesk.exe --service-install +# 启动 +.\CrossDesk.exe --service-start +# 查看状态 +.\CrossDesk.exe --service-status +.\CrossDesk.exe --service-stop +# 卸载 +.\CrossDesk.exe --service-uninstall +``` + +如果远端 Windows 服务未安装、未启动或暂时不可用，基础远程桌面连接仍可使用，但锁屏、登录界面和安全桌面阶段的控制能力会受限，客户端会提示“远端Windows服务不可用”。 + ## 如何编译 依赖： diff --git a/README_EN.md b/README_EN.md index d9afb22..8837a5d 100644 --- a/README_EN.md +++ b/README_EN.md @@ -56,6 +56,31 @@ Enter the **Remote Device ID** and **Password**, then click Connect to access th _cgi-bin_mmwebwx-bin_webwxgetmsgimg__ MsgID=932911462648581698 skey=@crypt_1f5153b1_b550ca7462b5009ce03c991cca2a92a7 mmweb_appid=wx_webfilehelper +### Windows Service (CrossDesk Service) +CrossDesk provides a local helper service on Windows named **CrossDesk Service**. Its service name is `CrossDeskService`. The service improves remote control in protected Windows states such as the lock screen, sign-in UI, credential UI, and secure desktop. It provides: +- Remote status reporting for lock screen, sign-in, credential, and secure desktop states. +- Remote `Ctrl+Alt+Del` (SAS) delivery. +- Keyboard and mouse input forwarding while the remote Windows device is on the lock screen, sign-in UI, or secure desktop. + +The Windows installer bundles `crossdesk_service.exe` and `crossdesk_session_helper.exe`, then registers the service as an on-demand Windows service during installation. When the CrossDesk client starts, it tries to start the installed service automatically. When no CrossDesk client process is running on the machine, the service exits automatically. Uninstalling the client also stops and removes the service. + +For manual Windows builds or deployments, make sure `CrossDesk.exe`, `crossdesk_service.exe`, and `crossdesk_session_helper.exe` are placed in the same directory. Open PowerShell with administrator privileges to install or uninstall the service: +``` +# install +.\CrossDesk.exe --service-install +# start +.\CrossDesk.exe --service-start +# check status +.\CrossDesk.exe --service-status +.\CrossDesk.exe --service-ping +# stop +.\CrossDesk.exe --service-stop +# uninstall +.\CrossDesk.exe --service-uninstall +``` + +If the remote Windows service is not installed, not running, or temporarily unavailable, the basic remote desktop connection still works, but remote control on the lock screen, sign-in UI, and secure desktop is limited. The client will show “Remote Windows service unavailable”. + ## How to build Requirements: