lejianwen месяцев назад: 11
Родитель
Сommit
e549416d94
3 измененных файлов с 15 добавлено и 18 удалено
  1. 6 7
      README.md
  2. 9 11
      README_EN.md
  3. BIN
      docs/init_admin_pwd.png

+ 6 - 7
README.md

@@ -46,6 +46,7 @@
46 46
 
47 47
 ## 功能
48 48
 
49
+
49 50
 ### API 服务 
50 51
 基本实现了PC端基础的接口。支持Personal版本接口,可以通过配置文件`rustdesk.personal`或环境变量`RUSTDESK_API_RUSTDESK_PERSONAL`来控制是否启用
51 52
 
@@ -70,23 +71,20 @@
70 71
 
71 72
 * 使用前后端分离,提供用户友好的管理界面,主要用来管理和展示。前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)
72 73
 
73
-* 后台访问地址是`http://<your server>[:port]/_admin/`初次安装管理员为用户名密码为`admin` `admin`,请即时更改密码
74
+* 后台访问地址是`http://<your server>[:port]/_admin/`
75
+* 初次安装管理员为用户名为`admin`,密码将在控制台打印,可以通过[命令行](#CLI)更改密码
76
+
77
+  ![img.png](./docs/init_admin_pwd.png)
74 78
 
75 79
 1. 管理员界面
76 80
    ![web_admin](docs/web_admin.png)
77 81
 2. 普通用户界面
78 82
    ![web_user](docs/web_admin_user.png)
79 83
 
80
-   右上角可以更改密码,可以切换语言,可以切换`白天/黑夜`模式
81
-
82
-   ![web_resetpwd](docs/web_resetpwd.png)
83
-
84 84
 3. 每个用户可以多个地址簿,也可以将地址簿共享给其他用户
85 85
 4. 分组可以自定义,方便管理,暂时支持两种类型: `共享组` 和 `普通组`
86 86
 5. 可以直接打开webclient,方便使用;也可以分享给游客,游客可以直接通过webclient远程到设备
87
-   ![web_webclient](docs/admin_webclient.png)
88 87
 6. Oauth,支持了`Github`, `Google` 以及 `OIDC`, 需要创建一个`OAuth App`,然后配置到后台
89
-   ![web_admin_oauth](docs/web_admin_oauth.png)
90 88
     - 对于`Google` 和 `Github`, `Issuer` 和 `Scopes`不需要填写.
91 89
     - 对于`OIDC`, `Issuer`是必须的。`Scopes`是可选的,默认为 `openid,profile,email`. 确保可以获取 `sub`,`email` 和`preferred_username`
92 90
     - `github oauth app`在`Settings`->`Developer settings`->`OAuth Apps`->`New OAuth App`
@@ -127,6 +125,7 @@
127 125
    ![api_swag](docs/api_swag.png)
128 126
 
129 127
 ### CLI
128
+
130 129
 ```bash
131 130
 # 查看帮助
132 131
 ./apimain -h

+ 9 - 11
README_EN.md

@@ -69,23 +69,22 @@ Basic implementation of the PC client's primary interfaces.Supports the Personal
69 69
 * The frontend and backend are separated to provide a user-friendly management interface, primarily for managing and
70 70
 displaying data.Frontend code is available at [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)
71 71
 
72
-* Admin panel URL: `http://<your server[:port]>/_admin/`. The default username and password for the initial
73
-installation are `admin` `admin`, please change the password immediately.
72
+* Admin panel URL: `http://<your server[:port]>/_admin/`
73
+* 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).
74
+
75
+  ![img.png](./docs/init_admin_pwd.png)
76
+
74 77
 
75 78
 1. Admin interface:
76 79
    ![web_admin](docs/en_img/web_admin.png)
77 80
 2. Regular user interface:
78 81
    ![web_user](docs/en_img/web_admin_user.png)
79
-   In the top right corner, you can change the password, switch languages, and toggle between `day/night` mode.
80 82
 
81
-   ![web_resetpwd](docs/en_img/web_resetpwd.png)
82 83
 3. Each user can have multiple address books, which can also be shared with other users.
83 84
 4. Groups can be customized for easy management. Currently, two types are supported: `shared group` and `regular group`.
84 85
 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.
85
-   ![web_webclient](docs/en_img/admin_webclient.png)
86 86
 6. OAuth support: Currently, `GitHub`, `Google` and `OIDC`  are supported. You need to create an `OAuth App` and configure it in
87 87
    the admin panel.
88
-   ![web_admin_oauth](docs/en_img/web_admin_oauth.png)
89 88
     - For `Google` and `Github`, you don't need to fill the `Issuer` and `Scpoes`
90 89
     - 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`
91 90
     - Create a `GitHub OAuth App`
@@ -97,16 +96,15 @@ installation are `admin` `admin`, please change the password immediately.
97 96
 8. Connection logs
98 97
 9. File transfer logs
99 98
 10. Server control
99
+  - `Simple mode`, some simple commands have been GUI-ized and can be executed directly in the backend
100
+    ![rustdesk_command_simple](./docs/en_img/rustdesk_command_simple.png)
100 101
 
101
-- `Simple mode`, some simple commands have been GUI-ized and can be executed directly in the backend
102
-  ![rustdesk_command_simple](./docs/en_img/rustdesk_command_simple.png)
103
-
104
-- `Advanced mode`, commands can be executed directly in the backend
102
+  - `Advanced mode`, commands can be executed directly in the backend
105 103
     * Official commands can be used
106 104
     * Custom commands can be added
107 105
     * Custom commands can be executed
108 106
 
109
-  ![rustdesk_command_advance](./docs/en_img/rustdesk_command_advance.png)
107
+    ![rustdesk_command_advance](./docs/en_img/rustdesk_command_advance.png)
110 108
 
111 109
 
112 110
 

BIN
docs/init_admin_pwd.png