|
|
@@ -144,16 +144,11 @@ installation are `admin` `admin`, please change the password immediately.
|
|
144
|
144
|
1. If you're already logged into the admin panel, the web client will log in automatically.
|
|
145
|
145
|
2. If you're not logged in, simply click the login button in the top right corner, and the API server will be
|
|
146
|
146
|
pre-configured.
|
|
147
|
|
- 
|
|
148
|
147
|
3. After logging in, the ID server and key will be automatically synced.
|
|
149
|
148
|
4. The address book will also be automatically saved to the web client for convenient use.
|
|
150
|
149
|
5. Now supports `v2 Preview`, accessible at `/webclient2`
|
|
151
|
150
|

|
|
152
|
|
-6. `v2 preview` deployment
|
|
153
|
|
- - If deploying via `https` on port `443`, you must configure a reverse proxy. Refer to the [official documentation](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq/#8-add-websocket-secure-wss-support-for-the-id-server-and-relay-server-to-enable-secure-communication-for-the-web-client)
|
|
154
|
|
- - If deploying via `http` or other `https` ports, configure `21118` and `21119` as with `v1`
|
|
155
|
|
- - More [Web-Client-V2-Preview-Document](https://github.com/lejianwen/rustdesk-api/wiki/Web-Client-V2-Preview-Document)
|
|
156
|
|
-
|
|
|
151
|
+6. `v2 preview` deployment, [WIKI](https://github.com/lejianwen/rustdesk-api/wiki)
|
|
157
|
152
|
|
|
158
|
153
|
### Automated Documentation : API documentation is generated using Swag, making it easier for developers to understand and use the API.
|
|
159
|
154
|
|
|
|
@@ -185,6 +180,7 @@ lang: "en"
|
|
185
|
180
|
app:
|
|
186
|
181
|
web-client: 1 # web client route 1:open 0:close
|
|
187
|
182
|
register: false #register enable
|
|
|
183
|
+ show-swagger: 0 #show swagger 1:open 0:close
|
|
188
|
184
|
gin:
|
|
189
|
185
|
api-addr: "0.0.0.0:21114"
|
|
190
|
186
|
mode: "release"
|
|
|
@@ -221,8 +217,9 @@ The prefix for variable names is `RUSTDESK_API`. If environment variables exist,
|
|
221
|
217
|
|------------------------------------|-------------------------------------------------------------------------|-------------------------------|
|
|
222
|
218
|
| TZ | timezone | Asia/Shanghai |
|
|
223
|
219
|
| RUSTDESK_API_LANG | Language | `en`,`zh-CN` |
|
|
224
|
|
-| RUSTDESK_API_APP_WEB_CLIENT | web client on/off; 1: on, 0 off, deault 1 | 1 |
|
|
|
220
|
+| RUSTDESK_API_APP_WEB_CLIENT | web client on/off; 1: on, 0 off, default: 1 | 1 |
|
|
225
|
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` |
|
|
226
|
223
|
| ----- ADMIN Configuration----- | ---------- | ---------- |
|
|
227
|
224
|
| RUSTDESK_API_ADMIN_TITLE | Admin Title | `RustDesk Api Admin` |
|
|
228
|
225
|
| RUSTDESK_API_ADMIN_HELLO | Admin welcome message, you can use `html` | |
|
|
|
@@ -267,7 +264,7 @@ The prefix for variable names is `RUSTDESK_API`. If environment variables exist,
|
|
267
|
264
|
lejianwen/rustdesk-api
|
|
268
|
265
|
```
|
|
269
|
266
|
|
|
270
|
|
-2. Using `docker-compose`,look [wiki](https://github.com/lejianwen/rustdesk-api/wiki)
|
|
|
267
|
+2. Using `docker-compose`,look [WIKI](https://github.com/lejianwen/rustdesk-api/wiki)
|
|
271
|
268
|
|
|
272
|
269
|
#### Running from Release
|
|
273
|
270
|
|