|
|
@@ -8,7 +8,7 @@ desktop software that provides self-hosted solutions.
|
|
8
|
8
|
<img src="https://img.shields.io/badge/gin-v1.9.0-lightBlue"/>
|
|
9
|
9
|
<img src="https://img.shields.io/badge/gorm-v1.25.7-green"/>
|
|
10
|
10
|
<img src="https://img.shields.io/badge/swag-v1.16.3-yellow"/>
|
|
11
|
|
-<img src="https://img.shields.io/badge/i18n-7-green"/>
|
|
|
11
|
+<img src="https://goreportcard.com/badge/github.com/lejianwen/rustdesk-api/v2"/>
|
|
12
|
12
|
<img src="https://github.com/lejianwen/rustdesk-api/actions/workflows/build.yml/badge.svg"/>
|
|
13
|
13
|
</div>
|
|
14
|
14
|
|
|
|
@@ -155,6 +155,7 @@ app:
|
|
155
|
155
|
web-client: 1 # web client route 1:open 0:close
|
|
156
|
156
|
register: false #register enable
|
|
157
|
157
|
show-swagger: 0 #show swagger 1:open 0:close
|
|
|
158
|
+ disable-pwd-login: false #disable password login
|
|
158
|
159
|
gin:
|
|
159
|
160
|
api-addr: "0.0.0.0:21114"
|
|
160
|
161
|
mode: "release"
|
|
|
@@ -212,43 +213,44 @@ ldap:
|
|
212
|
213
|
The environment variables correspond one-to-one with the configurations in the `conf/config.yaml` file. The prefix for variable names is `RUSTDESK_API`.
|
|
213
|
214
|
The table below does not list all configurations. Please refer to the configurations in `conf/config.yaml`.
|
|
214
|
215
|
|
|
215
|
|
-| Variable Name | Description | Example |
|
|
216
|
|
-|---------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
|
|
217
|
|
-| TZ | timezone | Asia/Shanghai |
|
|
218
|
|
-| RUSTDESK_API_LANG | Language | `en`,`zh-CN` |
|
|
219
|
|
-| RUSTDESK_API_APP_WEB_CLIENT | web client on/off; 1: on, 0 off, default: 1 | 1 |
|
|
220
|
|
-| RUSTDESK_API_APP_REGISTER | register enable; `true`, `false`; default:`false` | `false` |
|
|
221
|
|
-| RUSTDESK_API_APP_SHOW_SWAGGER | swagger visible; 1: yes, 0: no; default: 0 | `0` |
|
|
222
|
|
-| RUSTDESK_API_APP_TOKEN_EXPIRE | token expire duration(second) | `3600` |
|
|
223
|
|
-| ----- ADMIN Configuration----- | ---------- | ---------- |
|
|
224
|
|
-| RUSTDESK_API_ADMIN_TITLE | Admin Title | `RustDesk Api Admin` |
|
|
225
|
|
-| RUSTDESK_API_ADMIN_HELLO | Admin welcome message, you can use `html` | |
|
|
226
|
|
-| RUSTDESK_API_ADMIN_HELLO_FILE | Admin welcome message file,<br>will override `RUSTDESK_API_ADMIN_HELLO` | `./conf/admin/hello.html` |
|
|
227
|
|
-| ----- GIN Configuration ----- | --------------------------------------- | ----------------------------- |
|
|
228
|
|
-| RUSTDESK_API_GIN_TRUST_PROXY | Trusted proxy IPs, separated by commas. | 192.168.1.2,192.168.1.3 |
|
|
229
|
|
-| ----- GORM Configuration ----- | --------------------------------------- | ----------------------------- |
|
|
230
|
|
-| RUSTDESK_API_GORM_TYPE | Database type (`sqlite` or `mysql`). Default is `sqlite`. | sqlite |
|
|
231
|
|
-| RUSTDESK_API_GORM_MAX_IDLE_CONNS | Maximum idle connections | 10 |
|
|
232
|
|
-| RUSTDESK_API_GORM_MAX_OPEN_CONNS | Maximum open connections | 100 |
|
|
233
|
|
-| RUSTDESK_API_RUSTDESK_PERSONAL | Open Personal Api 1:Enable,0:Disable | 1 |
|
|
234
|
|
-| ----- MYSQL Configuration ----- | --------------------------------------- | ----------------------------- |
|
|
235
|
|
-| RUSTDESK_API_MYSQL_USERNAME | MySQL username | root |
|
|
236
|
|
-| RUSTDESK_API_MYSQL_PASSWORD | MySQL password | 111111 |
|
|
237
|
|
-| RUSTDESK_API_MYSQL_ADDR | MySQL address | 192.168.1.66:3306 |
|
|
238
|
|
-| RUSTDESK_API_MYSQL_DBNAME | MySQL database name | rustdesk |
|
|
239
|
|
-| ----- RUSTDESK Configuration ----- | --------------------------------------- | ----------------------------- |
|
|
240
|
|
-| RUSTDESK_API_RUSTDESK_ID_SERVER | Rustdesk ID server address | 192.168.1.66:21116 |
|
|
241
|
|
-| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk relay server address | 192.168.1.66:21117 |
|
|
242
|
|
-| RUSTDESK_API_RUSTDESK_API_SERVER | Rustdesk API server address | http://192.168.1.66:21114 |
|
|
243
|
|
-| RUSTDESK_API_RUSTDESK_KEY | Rustdesk key | 123456789 |
|
|
244
|
|
-| RUSTDESK_API_RUSTDESK_KEY_FILE | Rustdesk key file | `./conf/data/id_ed25519.pub` |
|
|
245
|
|
-| RUSTDESK_API_RUSTDESK<br/>_WEBCLIENT_MAGIC_QUERYONLINE | New online query method is enabled in the web client v2; '1': Enabled, '0': Disabled, not enabled by default | `0` |
|
|
246
|
|
-| ---- PROXY ----- | --------------- | ---------- |
|
|
247
|
|
-| RUSTDESK_API_PROXY_ENABLE | proxy_enable :`false`, `true` | `false` |
|
|
248
|
|
-| RUSTDESK_API_PROXY_HOST | proxy_host | `http://127.0.0.1:1080` |
|
|
249
|
|
-| ----JWT---- | -------- | -------- |
|
|
250
|
|
-| RUSTDESK_API_JWT_KEY | Custom JWT KEY, if empty JWT is not enabled.<br/>If `MUST_LOGIN` from `lejianwen/rustdesk-server` is not used, it is recommended to leave it empty. | |
|
|
251
|
|
-| RUSTDESK_API_JWT_EXPIRE_DURATION | JWT expire duration | 360000 |
|
|
|
216
|
+| Variable Name | Description | Example |
|
|
|
217
|
+|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
|
|
|
218
|
+| TZ | timezone | Asia/Shanghai |
|
|
|
219
|
+| RUSTDESK_API_LANG | Language | `en`,`zh-CN` |
|
|
|
220
|
+| RUSTDESK_API_APP_WEB_CLIENT | web client on/off; 1: on, 0 off, default: 1 | 1 |
|
|
|
221
|
+| RUSTDESK_API_APP_REGISTER | register enable; `true`, `false`; default:`false` | `false` |
|
|
|
222
|
+| RUSTDESK_API_APP_SHOW_SWAGGER | swagger visible; 1: yes, 0: no; default: 0 | `0` |
|
|
|
223
|
+| RUSTDESK_API_APP_TOKEN_EXPIRE | token expire duration(second) | `3600` |
|
|
|
224
|
+| RUSTDESK_API_APP_DISABLE_PWD_LOGIN | disable password login | `false` |
|
|
|
225
|
+| ----- ADMIN Configuration----- | ---------- | ---------- |
|
|
|
226
|
+| RUSTDESK_API_ADMIN_TITLE | Admin Title | `RustDesk Api Admin` |
|
|
|
227
|
+| RUSTDESK_API_ADMIN_HELLO | Admin welcome message, you can use `html` | |
|
|
|
228
|
+| RUSTDESK_API_ADMIN_HELLO_FILE | Admin welcome message file,<br>will override `RUSTDESK_API_ADMIN_HELLO` | `./conf/admin/hello.html` |
|
|
|
229
|
+| ----- GIN Configuration ----- | --------------------------------------- | ----------------------------- |
|
|
|
230
|
+| RUSTDESK_API_GIN_TRUST_PROXY | Trusted proxy IPs, separated by commas. | 192.168.1.2,192.168.1.3 |
|
|
|
231
|
+| ----- GORM Configuration ----- | --------------------------------------- | ----------------------------- |
|
|
|
232
|
+| RUSTDESK_API_GORM_TYPE | Database type (`sqlite` or `mysql`). Default is `sqlite`. | sqlite |
|
|
|
233
|
+| RUSTDESK_API_GORM_MAX_IDLE_CONNS | Maximum idle connections | 10 |
|
|
|
234
|
+| RUSTDESK_API_GORM_MAX_OPEN_CONNS | Maximum open connections | 100 |
|
|
|
235
|
+| RUSTDESK_API_RUSTDESK_PERSONAL | Open Personal Api 1:Enable,0:Disable | 1 |
|
|
|
236
|
+| ----- MYSQL Configuration ----- | --------------------------------------- | ----------------------------- |
|
|
|
237
|
+| RUSTDESK_API_MYSQL_USERNAME | MySQL username | root |
|
|
|
238
|
+| RUSTDESK_API_MYSQL_PASSWORD | MySQL password | 111111 |
|
|
|
239
|
+| RUSTDESK_API_MYSQL_ADDR | MySQL address | 192.168.1.66:3306 |
|
|
|
240
|
+| RUSTDESK_API_MYSQL_DBNAME | MySQL database name | rustdesk |
|
|
|
241
|
+| ----- RUSTDESK Configuration ----- | --------------------------------------- | ----------------------------- |
|
|
|
242
|
+| RUSTDESK_API_RUSTDESK_ID_SERVER | Rustdesk ID server address | 192.168.1.66:21116 |
|
|
|
243
|
+| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk relay server address | 192.168.1.66:21117 |
|
|
|
244
|
+| RUSTDESK_API_RUSTDESK_API_SERVER | Rustdesk API server address | http://192.168.1.66:21114 |
|
|
|
245
|
+| RUSTDESK_API_RUSTDESK_KEY | Rustdesk key | 123456789 |
|
|
|
246
|
+| RUSTDESK_API_RUSTDESK_KEY_FILE | Rustdesk key file | `./conf/data/id_ed25519.pub` |
|
|
|
247
|
+| RUSTDESK_API_RUSTDESK<br/>_WEBCLIENT_MAGIC_QUERYONLINE | New online query method is enabled in the web client v2; '1': Enabled, '0': Disabled, not enabled by default | `0` |
|
|
|
248
|
+| ---- PROXY ----- | --------------- | ---------- |
|
|
|
249
|
+| RUSTDESK_API_PROXY_ENABLE | proxy_enable :`false`, `true` | `false` |
|
|
|
250
|
+| RUSTDESK_API_PROXY_HOST | proxy_host | `http://127.0.0.1:1080` |
|
|
|
251
|
+| ----JWT---- | -------- | -------- |
|
|
|
252
|
+| RUSTDESK_API_JWT_KEY | Custom JWT KEY, if empty JWT is not enabled.<br/>If `MUST_LOGIN` from `lejianwen/rustdesk-server` is not used, it is recommended to leave it empty. | |
|
|
|
253
|
+| RUSTDESK_API_JWT_EXPIRE_DURATION | JWT expire duration | 360000 |
|
|
252
|
254
|
|
|
253
|
255
|
### Installation Steps
|
|
254
|
256
|
|
lejianwen