ljw 1 год назад
Родитель
Сommit
f2ee00d49e
1 измененных файлов с 23 добавлено и 3 удалено
  1. 23 3
      README.md

+ 23 - 3
README.md

@@ -2,9 +2,16 @@
2 2
 
3 3
 本项目使用 Go 实现了 RustDesk 的 API,并包含了 Web UI 和 Web 客户端。RustDesk 是一个远程桌面软件,提供了自托管的解决方案。
4 4
 
5
+ <div align=center>
6
+<img src="https://img.shields.io/badge/golang-1.22-blue"/>
7
+<img src="https://img.shields.io/badge/gin-v1.9.0-lightBlue"/>
8
+<img src="https://img.shields.io/badge/gorm-v1.25.7-green"/>
9
+<img src="https://img.shields.io/badge/swag-v1.16.3-yellow"/>
10
+</div>
11
+
5 12
 ## 使用前准备
6 13
 
7
-### Rustdesk
14
+### [Rustdesk](https://github.com/rustdesk/rustdesk)
8 15
 
9 16
 1. PC客户端使用的是 ***1.3.0***,经测试 ***1.2.6+*** 都可以
10 17
 2. server端必须指定key,不能用自带的生成的key,否则可能链接不上或者超时
@@ -33,9 +40,10 @@ hbbr -k 123456789
33 40
    ![web_user](docs/web_user.png)
34 41
 3. 更改密码在右上角
35 42
 
36
-![web_resetpwd](docs/web_resetpwd.png)
43
+   ![web_resetpwd](docs/web_resetpwd.png)
37 44
 
38 45
 4. 分组可以自定义,方便管理,暂时支持两种类型: `共享组` 和 `普通组`
46
+
39 47
    ![web_admin_gr](docs/web_admin_gr.png)
40 48
 
41 49
 ### **Web 客户端**:
@@ -81,11 +89,15 @@ rustdesk:
81 89
 ### 安装步骤
82 90
 
83 91
 #### docker运行
92
+
84 93
 1. 直接docker运行
94
+
85 95
 ```bash
86 96
 docker run -d --name rustdesk-api -p 21114:21114 -v /data/rustdesk/api:/app/data lejianwen/rustdesk-api
87 97
 ```
98
+
88 99
 2. 使用`docker compose`,根据rustdesk提供的示例加上自己的rustdesk-api
100
+
89 101
 ```docker-compose
90 102
 networks:
91 103
   rustdesk-net:
@@ -151,12 +163,15 @@ services:
151 163
    git clone https://github.com/lejianwen/rustdesk-api.git
152 164
    cd rustdesk-api
153 165
    ```
166
+   
154 167
 2. 安装依赖
168
+
155 169
     ```bash
156 170
     go mod tidy
157 171
     #安装swag,如果不需要生成文档,可以不安装
158 172
     go install github.com/swaggo/swag/cmd/swag@latest
159 173
     ```
174
+   
160 175
 3. 编译后台前端,前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)中
161 176
    ```bash
162 177
    cd resources
@@ -177,4 +192,9 @@ services:
177 192
 5. 编译,如果想自己编译,先cd到项目根目录,然后windows下直接运行`build.bat`,linux下运行`build.sh`,编译后会在`release`
178 193
    目录下生成对应的可执行文件。直接运行编译后的可执行文件即可。
179 194
 
180
-6. 打开浏览器访问`http://<your server>:21114/_admin/`,默认用户名密码为`admin`,请及时更改密码。
195
+6. 打开浏览器访问`http://<your server>:21114/_admin/`,默认用户名密码为`admin`,请及时更改密码。
196
+
197
+## 其他
198
+
199
+- [修改客户端ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer)
200
+- [webclient](https://hub.docker.com/r/keyurbhole/flutter_web_desk)