diff --git a/README.md b/README.md index 687230e..bd6c802 100644 --- a/README.md +++ b/README.md @@ -140,15 +140,12 @@ 1. 如果已经登录了后台,web client将自动直接登录 2. 如果没登录后台,点击右上角登录即可,api server已经自动配置好了 - ![webclient_conf](docs/webclient_conf.png) 3. 登录后,会自动同步ID服务器和KEY 4. 登录后,会将地址簿自动保存到web client中,方便使用 5. 现已支持`v2 Preview`,访问路径是`/webclient2` ![webclientv2](./docs/webclientv2.png) -6. `v2 preview` 部署 - - 如果是通过`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) - - 如果是`http`或者其他的`https`端口部署,则和`v1`一样,配置好`21118`,`21119`即可 - - 更多参考[Web-Client-V2-Preview-Document](https://github.com/lejianwen/rustdesk-api/wiki/Web-Client-V2-Preview-Document) +6. `v2 preview` 部署,参考[WIKI](https://github.com/lejianwen/rustdesk-api/wiki) + ### 自动化文档: 使用 Swag 生成 API 文档,方便开发者理解和使用 API。 @@ -180,6 +177,7 @@ lang: "en" app: web-client: 1 # 1:启用 0:禁用 register: false #是否开启注册 + show-swagger: 0 #是否显示swagger文档 gin: api-addr: "0.0.0.0:21114" mode: "release" @@ -218,6 +216,7 @@ proxy: | RUSTDESK_API_LANG | 语言 | `en`,`zh-CN` | | RUSTDESK_API_APP_WEB_CLIENT | 是否启用web-client; 1:启用,0:不启用; 默认启用 | 1 | | RUSTDESK_API_APP_REGISTER | 是否开启注册; `true`, `false` 默认`false` | `false` | +| RUSTDESK_API_APP_SHOW_SWAGGER | 是否可见swagger文档;`1`显示,`0`不显示,默认`0`不显示 | `1` | | -----ADMIN配置----- | ---------- | ---------- | | RUSTDESK_API_ADMIN_TITLE | 后台标题 | `RustDesk Api Admin` | | RUSTDESK_API_ADMIN_HELLO | 后台欢迎语,可以使用`html` | | @@ -263,7 +262,7 @@ proxy: lejianwen/rustdesk-api ``` -2. 使用`docker compose`,参考[wiki](https://github.com/lejianwen/rustdesk-api/wiki) +2. 使用`docker compose`,参考[WIKI](https://github.com/lejianwen/rustdesk-api/wiki) #### 下载release直接运行 diff --git a/README_EN.md b/README_EN.md index 677e095..d1ca0c5 100644 --- a/README_EN.md +++ b/README_EN.md @@ -144,16 +144,11 @@ installation are `admin` `admin`, please change the password immediately. 1. If you're already logged into the admin panel, the web client will log in automatically. 2. If you're not logged in, simply click the login button in the top right corner, and the API server will be pre-configured. - ![webclient_conf](docs/webclient_conf.png) 3. After logging in, the ID server and key will be automatically synced. 4. The address book will also be automatically saved to the web client for convenient use. 5. Now supports `v2 Preview`, accessible at `/webclient2` ![webclientv2](./docs/webclientv2.png) -6. `v2 preview` deployment - - 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) - - If deploying via `http` or other `https` ports, configure `21118` and `21119` as with `v1` - - More [Web-Client-V2-Preview-Document](https://github.com/lejianwen/rustdesk-api/wiki/Web-Client-V2-Preview-Document) - +6. `v2 preview` deployment, [WIKI](https://github.com/lejianwen/rustdesk-api/wiki) ### Automated Documentation : API documentation is generated using Swag, making it easier for developers to understand and use the API. @@ -185,6 +180,7 @@ lang: "en" app: web-client: 1 # web client route 1:open 0:close register: false #register enable + show-swagger: 0 #show swagger 1:open 0:close gin: api-addr: "0.0.0.0:21114" mode: "release" @@ -221,8 +217,9 @@ The prefix for variable names is `RUSTDESK_API`. If environment variables exist, |------------------------------------|-------------------------------------------------------------------------|-------------------------------| | TZ | timezone | Asia/Shanghai | | RUSTDESK_API_LANG | Language | `en`,`zh-CN` | -| RUSTDESK_API_APP_WEB_CLIENT | web client on/off; 1: on, 0 off, deault 1 | 1 | +| RUSTDESK_API_APP_WEB_CLIENT | web client on/off; 1: on, 0 off, default: 1 | 1 | | RUSTDESK_API_APP_REGISTER | register enable; `true`, `false`; default:`false` | `false` | +| RUSTDESK_API_APP_SHOW_SWAGGER | swagger visible; 1: yes, 0: no; default: 0 | `0` | | ----- ADMIN Configuration----- | ---------- | ---------- | | RUSTDESK_API_ADMIN_TITLE | Admin Title | `RustDesk Api Admin` | | 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, lejianwen/rustdesk-api ``` -2. Using `docker-compose`,look [wiki](https://github.com/lejianwen/rustdesk-api/wiki) +2. Using `docker-compose`,look [WIKI](https://github.com/lejianwen/rustdesk-api/wiki) #### Running from Release diff --git a/docs/admin_webclient.png b/docs/admin_webclient.png index 56edb44..38a1bfd 100644 Binary files a/docs/admin_webclient.png and b/docs/admin_webclient.png differ diff --git a/docs/en_img/admin_webclient.png b/docs/en_img/admin_webclient.png index 4b06251..d9ddaeb 100644 Binary files a/docs/en_img/admin_webclient.png and b/docs/en_img/admin_webclient.png differ diff --git a/docs/en_img/web_admin.png b/docs/en_img/web_admin.png index e05fed6..ca95f93 100644 Binary files a/docs/en_img/web_admin.png and b/docs/en_img/web_admin.png differ diff --git a/docs/en_img/web_admin_user.png b/docs/en_img/web_admin_user.png index 84d608a..e8e9005 100644 Binary files a/docs/en_img/web_admin_user.png and b/docs/en_img/web_admin_user.png differ diff --git a/docs/en_img/web_resetpwd.png b/docs/en_img/web_resetpwd.png index de8f125..9bee2d4 100644 Binary files a/docs/en_img/web_resetpwd.png and b/docs/en_img/web_resetpwd.png differ diff --git a/docs/web_admin.png b/docs/web_admin.png index 0056988..c2a8463 100644 Binary files a/docs/web_admin.png and b/docs/web_admin.png differ diff --git a/docs/web_admin_user.png b/docs/web_admin_user.png index 833acba..567415b 100644 Binary files a/docs/web_admin_user.png and b/docs/web_admin_user.png differ diff --git a/docs/web_resetpwd.png b/docs/web_resetpwd.png index 8299acf..6dd3584 100644 Binary files a/docs/web_resetpwd.png and b/docs/web_resetpwd.png differ diff --git a/docs/webclient_conf.png b/docs/webclient_conf.png deleted file mode 100644 index 384baba..0000000 Binary files a/docs/webclient_conf.png and /dev/null differ