使用GitHub Action 自动构建 RustDesk 客户端

首页 / 教程 / 正文

前言

RustDesk 是一个开源的远程桌面应用,允许用户自建服务器,以替代 TeamViewer 等远程控制软件。为了方便自建服务的用户快速使用Rustdesk,构建内置自己服务器和key的RustDesk 客户端便成为了广大互联网爱好者的需求。

默认情况下,RustDesk 依赖 hbb_common 作为其基础库,并默认连接到官方服务器。如果你希望使用自己的服务器,则需要修改 hbb_common 代码并让 rustdesk 指向你修改后的 hbb_common 仓库。

本教程将介绍如何利用Github Actions 实现自动构建内置你服务器和key的Rustdesk客户端。

1. 准备工作

在开始之前,请确保你已经安装了 Git,并且拥有一个 GitHub 账户。建议你对 Git 的基本使用有一定了解,以便顺利完成后续操作。

2. Fork Rustdesk仓库

  1. rustdesk/hbb_common
  2. rustdesk/rustdesk

2.1 拉取 Fork 后的代码

请注意,替换仓库地址为你fork后的仓库地址,而不是直接复制我下面的命令
# 可选:如果需要使用代理
# git config --global http.proxy http://127.0.0.1:10808
# git config --global https.proxy http://127.0.0.1:10808
# 拉取仓库代码到本地 请替换为你fork后的仓库地址
git clone https://github.com/irains/hbb_common.git
git clone https://github.com/irains/rustdesk.git

image-20250303165759904

3. 修改 hbb_common代码

打开 hbb_common 仓库下的 src/config.rs文件,修改 101-102 行 的默认服务器和密钥为你自己的服务器和密钥。

image-20250303170450035

3.1 推送修改后的代码

# 将修改的代码添加到暂存区
git add .
# 将代码提交到本地仓库
git commit -m "修改默认的服务器和 key"
# 将本地仓库代码推送到远程仓库 如果你没有登录过GitHub会要求你登录github
git push

image-20250303171409855

3.2 查看最新提交的 commit ID

git log --oneline
我这里提交后的commit id是b8d80ca,可用于后续验证rustdesk服务器和key是否修改成功

image-20250303172347046

4. 修改 rustdesk 仓库代码

我们切换到克隆下来的rustdesk代码目录下,按照下面的方式修改子模块地址并更新。

4.1 更新 .gitmodules

打开并编辑 .gitmodules 文件,将 url 替换为你Fork后的 hbb_common 仓库地址。

比如我fork后的仓库地址是https://github.com/irains/hbb_common则将 https://github.com/rustdesk/hbb_common地址换为前面这个地址即可,记住是hbb_common的地址,而不是rustdesk仓库的地址

image-20250303172942511

4.2 更新子模块

将上面修改好的代码保存,执行下面的命令更新子模块到最新的commit id

git submodule init
git submodule sync
git submodule update --remote

image-20250303173801265

4.3 提交并推送代码

git add .
git commit -m "修改子模块仓库地址"
git push

image-20250303173951608

4.4 确认 Commit ID 更新

代码推送完毕后,进入你Fork 后的 rustdesk 仓库的 libs 目录下,查看 hbb_common 后面的 commit id,确保它是3.2提到的b8d80ca(这个值每个人的是不同的),否则请回到上面的步骤重新检查是否遗漏了了某个操作。

image-20250303174211089

image-20250303174342359.png

5. 触发 GitHub Action 构建

5.1 创建 Tag

在本地 rustdesk 仓库中创建一个新 tag,例如 1.3.9,请使用 固定格式 (如 1.3.9v1.3.9),以便于自动匹配构建规则。

git tag -a 1.3.9 -m "修改内置服务器和 key"

image-20250303175213093

5.2 触发 GitHub Actions 构建

rustdesk 仓库中,进入 Actions 页面,点击下面图中的按钮启用自动构建。启用后回到本地rustdesk代码中使用下面的命令将tag推送到Github后将自动开始构建。

git push --tags

image-20250303174711633

5.3 下载构建好的客户端

Tag推送完毕后会出现下面的构建进度。

image-20250303175425229

等待 Action 执行完成后(时间比较长,一个半小时左右才能全部构建完成),进入 Releases 页面,即可下载构建好的客户端并使用。

image-20250303175612473

image-20250303185727688

评论区
头像
    头像
    Rustdesk
      

    非常感谢

    头像
    Light
      

    不错

    头像
    Atg
      

    请教一下, API服务器地址如何自定义进去呢

      头像
      @Atg

      rustdesk仓库src/common.rs文件里面搜索一下https://admin.rustdesk.com,大概在第920行左右,改成你的api服务器地址就行了。

    头像
    电打痴
      
    下面的命令没有反应的话先用"git submodule init"初始化,试过几次了,先执行初始化再执行下面的命令,不然会出错 git submodule sync git submodule update --remote

    现在问题是几个地方都改了,还是会登录官方服务器...

      头像
      @电打痴

      hbb_common代码更新了,.gitmodules里面地址改了吗,改了的话应该是没啥问题的啊。你们没生效多半是hbb_common没成功更新到最新的commit id。

        头像
        电打痴
          
        @雨落凋殇

        多谢,终于搞定了,也不知道是啥原因,突然就行了。