diff --git a/README.md b/README.md index 32c523f..d8e387e 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ ## 功能 + ### API 服务 基本实现了PC端基础的接口。支持Personal版本接口,可以通过配置文件`rustdesk.personal`或环境变量`RUSTDESK_API_RUSTDESK_PERSONAL`来控制是否启用 @@ -70,23 +71,20 @@ * 使用前后端分离,提供用户友好的管理界面,主要用来管理和展示。前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web) -* 后台访问地址是`http://[:port]/_admin/`初次安装管理员为用户名密码为`admin` `admin`,请即时更改密码 +* 后台访问地址是`http://[:port]/_admin/` +* 初次安装管理员为用户名为`admin`,密码将在控制台打印,可以通过[命令行](#CLI)更改密码 + + ![img.png](./docs/init_admin_pwd.png) 1. 管理员界面 ![web_admin](docs/web_admin.png) 2. 普通用户界面 ![web_user](docs/web_admin_user.png) - 右上角可以更改密码,可以切换语言,可以切换`白天/黑夜`模式 - - ![web_resetpwd](docs/web_resetpwd.png) - 3. 每个用户可以多个地址簿,也可以将地址簿共享给其他用户 4. 分组可以自定义,方便管理,暂时支持两种类型: `共享组` 和 `普通组` 5. 可以直接打开webclient,方便使用;也可以分享给游客,游客可以直接通过webclient远程到设备 - ![web_webclient](docs/admin_webclient.png) 6. Oauth,支持了`Github`, `Google` 以及 `OIDC`, 需要创建一个`OAuth App`,然后配置到后台 - ![web_admin_oauth](docs/web_admin_oauth.png) - 对于`Google` 和 `Github`, `Issuer` 和 `Scopes`不需要填写. - 对于`OIDC`, `Issuer`是必须的。`Scopes`是可选的,默认为 `openid,profile,email`. 确保可以获取 `sub`,`email` 和`preferred_username` - `github oauth app`在`Settings`->`Developer settings`->`OAuth Apps`->`New OAuth App` @@ -127,6 +125,7 @@ ![api_swag](docs/api_swag.png) ### CLI + ```bash # 查看帮助 ./apimain -h diff --git a/README_EN.md b/README_EN.md index 0960522..6d81403 100644 --- a/README_EN.md +++ b/README_EN.md @@ -69,23 +69,22 @@ Basic implementation of the PC client's primary interfaces.Supports the Personal * The frontend and backend are separated to provide a user-friendly management interface, primarily for managing and displaying data.Frontend code is available at [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web) -* Admin panel URL: `http:///_admin/`. The default username and password for the initial -installation are `admin` `admin`, please change the password immediately. +* Admin panel URL: `http:///_admin/` +* For the initial installation, the admin username is `admin`, and the password will be printed in the console. You can change the password via the [command line](#CLI). + + ![img.png](./docs/init_admin_pwd.png) + 1. Admin interface: ![web_admin](docs/en_img/web_admin.png) 2. Regular user interface: ![web_user](docs/en_img/web_admin_user.png) - In the top right corner, you can change the password, switch languages, and toggle between `day/night` mode. - ![web_resetpwd](docs/en_img/web_resetpwd.png) 3. Each user can have multiple address books, which can also be shared with other users. 4. Groups can be customized for easy management. Currently, two types are supported: `shared group` and `regular group`. 5. You can directly launch the client or open the web client for convenience; you can also share it with guests, who can remotely access the device via the web client. - ![web_webclient](docs/en_img/admin_webclient.png) 6. OAuth support: Currently, `GitHub`, `Google` and `OIDC` are supported. You need to create an `OAuth App` and configure it in the admin panel. - ![web_admin_oauth](docs/en_img/web_admin_oauth.png) - For `Google` and `Github`, you don't need to fill the `Issuer` and `Scpoes` - For `OIDC`, you must set the `Issuer`. And `Scopes` is optional which default is `openid,email,profile`, please make sure this `Oauth App` can access `sub`, `email` and `preferred_username` - Create a `GitHub OAuth App` @@ -97,16 +96,15 @@ installation are `admin` `admin`, please change the password immediately. 8. Connection logs 9. File transfer logs 10. Server control + - `Simple mode`, some simple commands have been GUI-ized and can be executed directly in the backend + ![rustdesk_command_simple](./docs/en_img/rustdesk_command_simple.png) -- `Simple mode`, some simple commands have been GUI-ized and can be executed directly in the backend - ![rustdesk_command_simple](./docs/en_img/rustdesk_command_simple.png) - -- `Advanced mode`, commands can be executed directly in the backend + - `Advanced mode`, commands can be executed directly in the backend * Official commands can be used * Custom commands can be added * Custom commands can be executed - ![rustdesk_command_advance](./docs/en_img/rustdesk_command_advance.png) + ![rustdesk_command_advance](./docs/en_img/rustdesk_command_advance.png) diff --git a/docs/init_admin_pwd.png b/docs/init_admin_pwd.png new file mode 100644 index 0000000..c44ff0b Binary files /dev/null and b/docs/init_admin_pwd.png differ