Browse Source

update README.md

ljw 1 year ago
parent
commit
ebd1feb8d1
2 changed files with 27 additions and 16 deletions
  1. 22 16
      README.md
  2. 5 0
      docker-compose.yaml

+ 22 - 16
README.md

@@ -1,4 +1,5 @@
1 1
 # RustDesk API
2
+
2 3
 [English Doc](README_EN.md)
3 4
 
4 5
 本项目使用 Go 实现了 RustDesk 的 API,并包含了 Web UI 和 Web 客户端。RustDesk 是一个远程桌面软件,提供了自托管的解决方案。
@@ -99,22 +100,22 @@ docker run -d --name rustdesk-api -p 21114:21114 -v /data/rustdesk/api:/app/data
99 100
 
100 101
 - 环境变量,变量名前缀是RUSTDESK_API
101 102
 
102
-| 变量名                                 | 说明                                            | 示例                          |
103
-|:------------------------------------|:----------------------------------------------|-----------------------------|
104
-| -----------GORM配置------------------ | --------------------------------------------- | --------------------------- |
105
-| RUSTDESK_API_GORM_TYPE              | 数据库类型sqlite或者mysql,默认sqlite                   | sqlite                      |
106
-| RUSTDESK_API_GORM_MAX_IDLE_CONNS    | 数据库最大空闲连接数                                    | 10                          |
107
-| RUSTDESK_API_GORM_MAX_OPEN_CONNS    | 数据库最大打开连接数                                    | 100                         |
108
-| -----------MYSQL配置----------------- | -------------数据库类型为sqlite时不用填--------------   | ----------                  |
109
-| RUSTDESK_API_MYSQL_USERNAME         | mysql用户名                                      | root                        |
110
-| RUSTDESK_API_MYSQL_PASSWORD         | mysql密码                                       | 111111                      |
111
-| RUSTDESK_API_MYSQL_ADDR             | mysql地址                                       | 192.168.1.66:3306           |
112
-| RUSTDESK_API_MYSQL_DBNAME           | mysql数据库名                                     | rustdesk                    |
113
-| -----------RUSTDESK配置-------------- | -------------------------------------------   | ----------                  |
114
-| RUSTDESK_API_RUSTDESK_ID_SERVER     | Rustdesk的id服务器地址                              | 192.168.1.66:21116          |
115
-| RUSTDESK_API_RUSTDESK_RELAY_SERVER  | Rustdesk的relay服务器地址                           | 192.168.1.66:21117          |
116
-| RUSTDESK_API_RUSTDESK_API_SERVER    | Rustdesk的api服务器地址                             | http://192.168.1.66:21114   |
117
-| RUSTDESK_API_RUSTDESK_KEY           | Rustdesk的key                                  | 123456789                   |
103
+| 变量名                                 | 说明                                   | 示例                          |
104
+|:------------------------------------|:-------------------------------------|-----------------------------|
105
+| -----------GORM配置------------------ | ------------------------------------ | --------------------------- |
106
+| RUSTDESK_API_GORM_TYPE              | 数据库类型sqlite或者mysql,默认sqlite          | sqlite                      |
107
+| RUSTDESK_API_GORM_MAX_IDLE_CONNS    | 数据库最大空闲连接数                           | 10                          |
108
+| RUSTDESK_API_GORM_MAX_OPEN_CONNS    | 数据库最大打开连接数                           | 100                         |
109
+| -----------MYSQL配置----------------- | --------数据库类型为sqlite时不用填-------      | ----------                  |
110
+| RUSTDESK_API_MYSQL_USERNAME         | mysql用户名                             | root                        |
111
+| RUSTDESK_API_MYSQL_PASSWORD         | mysql密码                              | 111111                      |
112
+| RUSTDESK_API_MYSQL_ADDR             | mysql地址                              | 192.168.1.66:3306           |
113
+| RUSTDESK_API_MYSQL_DBNAME           | mysql数据库名                            | rustdesk                    |
114
+| -----------RUSTDESK配置-------------- | -----------------------------------  | ----------                  |
115
+| RUSTDESK_API_RUSTDESK_ID_SERVER     | Rustdesk的id服务器地址                     | 192.168.1.66:21116          |
116
+| RUSTDESK_API_RUSTDESK_RELAY_SERVER  | Rustdesk的relay服务器地址                  | 192.168.1.66:21117          |
117
+| RUSTDESK_API_RUSTDESK_API_SERVER    | Rustdesk的api服务器地址                    | http://192.168.1.66:21114   |
118
+| RUSTDESK_API_RUSTDESK_KEY           | Rustdesk的key                         | 123456789                   |
118 119
 
119 120
 2. 使用`docker compose`,根据rustdesk提供的示例加上自己的rustdesk-api
120 121
 
@@ -161,6 +162,11 @@ services:
161 162
           memory: 64M
162 163
   rustdesk-api:
163 164
     container_name: rustdesk-api
165
+    environment:
166
+      - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
167
+      - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
168
+      - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
169
+      - RUSTDESK_API_RUSTDESK_KEY=123456789
164 170
     ports:
165 171
       - 21114:21114
166 172
     image: lejianwen/rustdesk-api

+ 5 - 0
docker-compose.yaml

@@ -2,6 +2,11 @@ services:
2 2
   rustdesk-api:
3 3
     image: lejianwen/rustdesk-api
4 4
     container_name: rustdesk-api
5
+    environment:
6
+      - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
7
+      - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
8
+      - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
9
+      - RUSTDESK_API_RUSTDESK_KEY=123456789
5 10
     ports:
6 11
       - 21114:21114
7 12
     volumes: