lejianwen 1 год назад
Родитель
Сommit
50b3d85270

+ 5 - 6
README.md

@@ -140,15 +140,12 @@
140
 
140
 
141
 1. 如果已经登录了后台,web client将自动直接登录
141
 1. 如果已经登录了后台,web client将自动直接登录
142
 2. 如果没登录后台,点击右上角登录即可,api server已经自动配置好了
142
 2. 如果没登录后台,点击右上角登录即可,api server已经自动配置好了
143
-   ![webclient_conf](docs/webclient_conf.png)
144
 3. 登录后,会自动同步ID服务器和KEY
143
 3. 登录后,会自动同步ID服务器和KEY
145
 4. 登录后,会将地址簿自动保存到web client中,方便使用
144
 4. 登录后,会将地址簿自动保存到web client中,方便使用
146
 5. 现已支持`v2 Preview`,访问路径是`/webclient2`
145
 5. 现已支持`v2 Preview`,访问路径是`/webclient2`
147
    ![webclientv2](./docs/webclientv2.png)
146
    ![webclientv2](./docs/webclientv2.png)
148
-6. `v2 preview` 部署 
149
-   - 如果是通过`443`端口的`https`部署,必须配置反向代理,可以参考[官方文档](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)
150
-   - 如果是`http`或者其他的`https`端口部署,则和`v1`一样,配置好`21118`,`21119`即可
151
-   - 更多参考[Web-Client-V2-Preview-Document](https://github.com/lejianwen/rustdesk-api/wiki/Web-Client-V2-Preview-Document)
147
+6. `v2 preview` 部署,参考[WIKI](https://github.com/lejianwen/rustdesk-api/wiki)
148
+
152
 
149
 
153
 ### 自动化文档: 使用 Swag 生成 API 文档,方便开发者理解和使用 API。
150
 ### 自动化文档: 使用 Swag 生成 API 文档,方便开发者理解和使用 API。
154
 
151
 
@@ -180,6 +177,7 @@ lang: "en"
180
 app:
177
 app:
181
   web-client: 1  # 1:启用 0:禁用
178
   web-client: 1  # 1:启用 0:禁用
182
   register: false #是否开启注册
179
   register: false #是否开启注册
180
+  show-swagger: 0 #是否显示swagger文档
183
 gin:
181
 gin:
184
   api-addr: "0.0.0.0:21114"
182
   api-addr: "0.0.0.0:21114"
185
   mode: "release"
183
   mode: "release"
@@ -218,6 +216,7 @@ proxy:
218
 | RUSTDESK_API_LANG                  | 语言                                                      | `en`,`zh-CN`                 |
216
 | RUSTDESK_API_LANG                  | 语言                                                      | `en`,`zh-CN`                 |
219
 | RUSTDESK_API_APP_WEB_CLIENT        | 是否启用web-client; 1:启用,0:不启用; 默认启用                        | 1                            |
217
 | RUSTDESK_API_APP_WEB_CLIENT        | 是否启用web-client; 1:启用,0:不启用; 默认启用                        | 1                            |
220
 | RUSTDESK_API_APP_REGISTER          | 是否开启注册; `true`, `false`  默认`false`                      | `false`                      |
218
 | RUSTDESK_API_APP_REGISTER          | 是否开启注册; `true`, `false`  默认`false`                      | `false`                      |
219
+| RUSTDESK_API_APP_SHOW_SWAGGER      | 是否可见swagger文档;`1`显示,`0`不显示,默认`0`不显示                     | `1`                          |
221
 | -----ADMIN配置-----                  | ----------                                              | ----------                   |
220
 | -----ADMIN配置-----                  | ----------                                              | ----------                   |
222
 | RUSTDESK_API_ADMIN_TITLE           | 后台标题                                                    | `RustDesk Api Admin`         |
221
 | RUSTDESK_API_ADMIN_TITLE           | 后台标题                                                    | `RustDesk Api Admin`         |
223
 | RUSTDESK_API_ADMIN_HELLO           | 后台欢迎语,可以使用`html`                                        |                              |
222
 | RUSTDESK_API_ADMIN_HELLO           | 后台欢迎语,可以使用`html`                                        |                              |
@@ -263,7 +262,7 @@ proxy:
263
     lejianwen/rustdesk-api
262
     lejianwen/rustdesk-api
264
     ```
263
     ```
265
 
264
 
266
-2. 使用`docker compose`,参考[wiki](https://github.com/lejianwen/rustdesk-api/wiki)
265
+2. 使用`docker compose`,参考[WIKI](https://github.com/lejianwen/rustdesk-api/wiki)
267
 
266
 
268
 #### 下载release直接运行
267
 #### 下载release直接运行
269
 
268
 

+ 5 - 8
README_EN.md

@@ -144,16 +144,11 @@ installation are `admin` `admin`, please change the password immediately.
144
 1. If you're already logged into the admin panel, the web client will log in automatically.
144
 1. If you're already logged into the admin panel, the web client will log in automatically.
145
 2. If you're not logged in, simply click the login button in the top right corner, and the API server will be
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
    pre-configured.
146
    pre-configured.
147
-   ![webclient_conf](docs/webclient_conf.png)
148
 3. After logging in, the ID server and key will be automatically synced.
147
 3. After logging in, the ID server and key will be automatically synced.
149
 4. The address book will also be automatically saved to the web client for convenient use.
148
 4. The address book will also be automatically saved to the web client for convenient use.
150
 5. Now supports `v2 Preview`, accessible at `/webclient2`
149
 5. Now supports `v2 Preview`, accessible at `/webclient2`
151
    ![webclientv2](./docs/webclientv2.png)
150
    ![webclientv2](./docs/webclientv2.png)
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
 ### Automated Documentation : API documentation is generated using Swag, making it easier for developers to understand and use the API.
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
 app:
180
 app:
186
   web-client: 1  # web client route 1:open 0:close  
181
   web-client: 1  # web client route 1:open 0:close  
187
   register: false #register enable
182
   register: false #register enable
183
+  show-swagger: 0 #show swagger 1:open 0:close
188
 gin:
184
 gin:
189
   api-addr: "0.0.0.0:21114"
185
   api-addr: "0.0.0.0:21114"
190
   mode: "release"
186
   mode: "release"
@@ -221,8 +217,9 @@ The prefix for variable names is `RUSTDESK_API`. If environment variables exist,
221
 |------------------------------------|-------------------------------------------------------------------------|-------------------------------|
217
 |------------------------------------|-------------------------------------------------------------------------|-------------------------------|
222
 | TZ                                 | timezone                                                                | Asia/Shanghai                 |
218
 | TZ                                 | timezone                                                                | Asia/Shanghai                 |
223
 | RUSTDESK_API_LANG                  | Language                                                                | `en`,`zh-CN`                  |
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
 | RUSTDESK_API_APP_REGISTER          | register enable; `true`, `false`; default:`false`                       | `false`                       |
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
 | ----- ADMIN Configuration-----     | ----------                                                              | ----------                    |
223
 | ----- ADMIN Configuration-----     | ----------                                                              | ----------                    |
227
 | RUSTDESK_API_ADMIN_TITLE           | Admin Title                                                             | `RustDesk Api Admin`          |
224
 | RUSTDESK_API_ADMIN_TITLE           | Admin Title                                                             | `RustDesk Api Admin`          |
228
 | RUSTDESK_API_ADMIN_HELLO           | Admin welcome message, you can use `html`                               |                               |
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
     lejianwen/rustdesk-api
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
 #### Running from Release
269
 #### Running from Release
273
 
270
 

BIN
docs/admin_webclient.png


BIN
docs/en_img/admin_webclient.png


BIN
docs/en_img/web_admin.png


BIN
docs/en_img/web_admin_user.png


BIN
docs/en_img/web_resetpwd.png


BIN
docs/web_admin.png


BIN
docs/web_admin_user.png


BIN
docs/web_resetpwd.png


BIN
docs/webclient_conf.png