up readme

2026-02-16 19:20:56 +00:00 · 2024-09-24 15:15:26 +08:00
parent c485035e74
commit c5b43fae08
2 changed files with 194 additions and 10 deletions
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@

 [English Doc](README_EN.md)

-本项目使用 Go 实现了 RustDesk 的 API，并包含了 Web UI 和 Web 客户端。RustDesk 是一个远程桌面软件，提供了自托管的解决方案。
+本项目使用 Go 实现了 RustDesk 的 API，并包含了 Web Admin 和 Web 客户端。RustDesk 是一个远程桌面软件，提供了自托管的解决方案。

 <div align=center>
 <img src="https://img.shields.io/badge/golang-1.22-blue"/>
@@ -10,8 +10,30 @@
 <img src="https://img.shields.io/badge/gorm-v1.25.7-green"/>
 <img src="https://img.shields.io/badge/swag-v1.16.3-yellow"/>
 <img src="https://github.com/lejianwen/rustdesk-api/actions/workflows/release.yml/badge.svg"/>
+<img src="https://github.com/lejianwen/rustdesk-api/actions/workflows/docker.yml/badge.svg"/>
 </div>

+# 特性
+
+- PC端API
+    - 个人版API
+    - 登录
+    - 地址簿
+    - 群组
+    - 授权登录，支持`github`和`google`登录，支持`web后台`授权登录
+- Web Admin
+    - 用户管理
+    - 设备管理
+    - 地址簿管理
+    - 标签管理
+    - 群组管理
+    - Oauth 管理
+    - 快速使用web client
+- Web Client
+    - 自动获取API server
+    - 自动获取ID服务器和KEY
+    - 自动获取地址簿
+
 ## 使用前准备

 ### [Rustdesk](https://github.com/rustdesk/rustdesk)
@@ -33,7 +55,7 @@

 ## 功能

-### API 服务: 基本实现了PC端基础的接口。
+### API 服务: 基本实现了PC端基础的接口。支持Personal版本接口，可以通过配置文件`rustdesk.personal`或环境变量`RUSTDESK_PERSONAL`来控制是否启用

 #### 登录

@@ -50,7 +72,7 @@

 ![pc_gr](docs/pc_gr.png)

-### **Web UI**: 使用前后端分离，提供用户友好的管理界面，主要用来管理和展示。
+### **Web Admin**: 使用前后端分离，提供用户友好的管理界面，主要用来管理和展示。

 ***前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)***

@@ -119,7 +141,7 @@ rustdesk:
 * 环境变量,变量名前缀是RUSTDESK_API，环境变量如果存在将覆盖配置文件中的配置

 | 变量名                                 | 说明                                   | 示例                          |
-|:------------------------------------|:-------------------------------------|-----------------------------|
+|-------------------------------------|--------------------------------------|-----------------------------|
 | TZ                                  | 时区                                   | Asia/Shanghai               |
 | -----GIN配置-----                     | ----------                           | ----------                  |
 | RUSTDESK_API_GIN_TRUST_PROXY        | 信任的代理IP列表，以`,`分割，默认信任所有              | 192.168.1.2,192.168.1.3     |
@@ -128,7 +150,7 @@ rustdesk:
 | RUSTDESK_API_GORM_MAX_IDLE_CONNS    | 数据库最大空闲连接数                           | 10                          |
 | RUSTDESK_API_GORM_MAX_OPEN_CONNS    | 数据库最大打开连接数                           | 100                         |
 | RUSTDESK_PERSONAL                   | 是否启用个人版API， 1:启用,0:不启用； 默认启用         | 1                           |
-| -----MYSQL配置-----                   | -----数据库类型为sqlite时不用填-----           | ----------                  |
+| -----MYSQL配置-----                   | ----------                           | ----------                  |
 | RUSTDESK_API_MYSQL_USERNAME         | mysql用户名                             | root                        |
 | RUSTDESK_API_MYSQL_PASSWORD         | mysql密码                              | 111111                      |
 | RUSTDESK_API_MYSQL_ADDR             | mysql地址                              | 192.168.1.66:3306           |
@@ -242,6 +264,72 @@ lejianwen/rustdesk-api
   
   ```

+    - 如果使用的是S6的镜像，会需要修改启动脚本，覆盖镜像中的`/etc/s6-overlay/s6-rc.d/hbbr/run`
+      和`/etc/s6-overlay/s6-rc.d/hbbr/run`
+
+        1. 创建`hbbr/run`
+
+            ```bash
+            #!/command/with-contenv sh
+            cd /data
+            PARAMS=
+            [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}"
+            /usr/bin/hbbr $PARAMS
+            ```
+
+        2. 创建`hbbs/run`
+            ```bash
+            #!/command/with-contenv sh
+            sleep 2
+            cd /data
+            PARAMS=
+            [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}"
+            /usr/bin/hbbs -r $RELAY $PARAMS
+            ```
+        3. 修改`docker-compose.yml`中的`s6`部分
+
+            ```
+            networks:
+              rustdesk-net:
+                external: false
+            services:
+              rustdesk-server:
+                container_name: rustdesk-server
+                ports:
+                  - 21115:21115
+                  - 21116:21116
+                  - 21116:21116/udp
+                  - 21117:21117
+                  - 21118:21118
+                  - 21119:21119
+                image: rustdesk/rustdesk-server-s6:latest
+                environment:
+                  - RELAY=192.168.1.66:21117
+                  - ENCRYPTED_ONLY=1
+                  - KEY=abc123456789
+                volumes:
+                  - ./data:/data
+                  - ./hbbr/run:/etc/s6-overlay/s6-rc.d/hbbr/run
+                  - ./hbbs/run:/etc/s6-overlay/s6-rc.d/hbbs/run
+                restart: unless-stopped
+              rustdesk-api:
+                container_name: rustdesk-api
+                ports:
+                  - 21114:21114
+                image: lejianwen/rustdesk-api
+                environment:
+                  - TZ=Asia/Shanghai
+                  - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
+                  - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
+                  - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
+                  - RUSTDESK_API_RUSTDESK_KEY=abc123456789
+                volumes:
+                  - /data/rustdesk/api:/app/data #将数据库挂载
+                networks:
+                  - rustdesk-net
+                restart: unless-stopped
+            ```
+
 #### 下载release直接运行

 下载地址[release](https://github.com/lejianwen/rustdesk-api/releases)