ljw 1 год назад
Родитель
Сommit
9afd11e3b8
3 измененных файлов с 29 добавлено и 35 удалено
  1. 12 12
      README.md
  2. 17 23
      README_EN.md
  3. BIN
      docs/web_admin_gr.png

+ 12 - 12
README.md

@@ -68,13 +68,13 @@
68 68
 
69 69
 ![pc_ab](docs/pc_ab.png)
70 70
 
71
-#### 群组,群组分为`共享组`和`普通组`,共享组中所有人都能看到小组成员的地址,普通组只有管理员能看到所有小组成员的地址
71
+#### 群组,群组分为`共享组`和`普通组`,共享组中所有人都能看到小组成员的设备,普通组只有管理员能看到所有小组成员的设备
72 72
 
73 73
 ![pc_gr](docs/pc_gr.png)
74 74
 
75
-### **Web Admin**: 使用前后端分离,提供用户友好的管理界面,主要用来管理和展示。
75
+### Web Admin: 
76 76
 
77
-***前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)***
77
+***使用前后端分离,提供用户友好的管理界面,主要用来管理和展示。前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)***
78 78
 
79 79
 ***后台访问地址是`http://<your server>[:port]/_admin/`初次安装管理员为用户名密码为`admin` `admin`,请即时更改密码***
80 80
 
@@ -82,21 +82,21 @@
82 82
    ![web_admin](docs/web_admin.png)
83 83
 2. 普通用户界面
84 84
    ![web_user](docs/web_admin_user.png)
85
-3. 右上角也可以更改密码
85
+   右上角也可以更改密码
86 86
    ![web_resetpwd](docs/web_resetpwd.png)
87 87
 
88
-4. 分组可以自定义,方便管理,暂时支持两种类型: `共享组` 和 `普通组`
88
+3. 分组可以自定义,方便管理,暂时支持两种类型: `共享组` 和 `普通组`
89 89
    ![web_admin_gr](docs/web_admin_gr.png)
90
-5. 可以直接打开webclient,方便使用
90
+4. 可以直接打开webclient,方便使用
91 91
    ![web_webclient](docs/admin_webclient.png)
92
-6. Oauth,暂时只支持了`Github`和`Google`, 需要创建一个`OAuth App`,然后配置到后台
92
+5. Oauth,暂时只支持了`Github`和`Google`, 需要创建一个`OAuth App`,然后配置到后台
93 93
    ![web_admin_oauth](docs/web_admin_oauth.png)
94 94
     - `github oauth app`在`Settings`->`Developer settings`->`OAuth Apps`->`New OAuth App`
95 95
       中创建,地址 [https://github.com/settings/developers](https://github.com/settings/developers)
96 96
     - `Authorization callback URL`填写`http://<your server[:port]>/api/oauth/callback`
97 97
       ,比如`http://127.0.0.1:21114/api/oauth/callback`
98 98
 
99
-### **Web Client**:
99
+### Web Client:
100 100
 
101 101
 1. 如果已经登录了后台,web client将自动直接登录
102 102
 2. 如果没登录后台,点击右上角登录即可,api server已经自动配置好了
@@ -104,10 +104,10 @@
104 104
 3. 登录后,会自动同步ID服务器和KEY
105 105
 4. 登录后,会将地址簿自动保存到web client中,方便使用
106 106
 
107
-### **自动化文档**: 使用 Swag 生成 API 文档,方便开发者理解和使用 API。
107
+### 自动化文档: 使用 Swag 生成 API 文档,方便开发者理解和使用 API。
108 108
 
109
-1. 后台文档 `<youer server>/admin/swagger/index.html`
110
-2. PC端文档 `<youer server>/swagger/index.html`
109
+1. 后台文档 `<youer server[:port]>/admin/swagger/index.html`
110
+2. PC端文档 `<youer server[:port]>/swagger/index.html`
111 111
    ![api_swag](docs/api_swag.png)
112 112
 
113 113
 ## 安装与运行
@@ -371,7 +371,7 @@ lejianwen/rustdesk-api
371 371
 5. 编译,如果想自己编译,先cd到项目根目录,然后windows下直接运行`build.bat`,linux下运行`build.sh`,编译后会在`release`
372 372
    目录下生成对应的可执行文件。直接运行编译后的可执行文件即可。
373 373
 
374
-6. 打开浏览器访问`http://<your server>:21114/_admin/`,默认用户名密码为`admin`,请及时更改密码。
374
+6. 打开浏览器访问`http://<your server[:port]>/_admin/`,默认用户名密码为`admin`,请及时更改密码。
375 375
 
376 376
 ## 其他
377 377
 

+ 17 - 23
README_EN.md

@@ -53,15 +53,13 @@ desktop software that provides self-hosted solutions.
53 53
    hbbr -k abc1234567
54 54
    ```
55 55
 
56
-## Features
56
+## Overview
57 57
 
58 58
 ### API Service: Basic implementation of the PC client's primary interfaces.Supports the Personal version api, which can be enabled by configuring the `rustdesk.personal` file or the `RUSTDESK_API_RUSTDESK_PERSONAL` environment variable.
59 59
 
60 60
 #### Login
61 61
 
62
-- Added `GitHub` and `Google` login, which can be used after configuration in the admin panel. See the OAuth
63
-  configuration section
64
-  for details.
62
+- Added `GitHub` and `Google` login, which can be used after configuration in the admin panel. See the OAuth configuration section for details.
65 63
 - Added authorization login for the web admin panel.
66 64
 
67 65
 ![pc_login](docs/pc_login.png)
@@ -70,31 +68,29 @@ desktop software that provides self-hosted solutions.
70 68
 
71 69
 ![pc_ab](docs/pc_ab.png)
72 70
 
73
-#### Groups: Groups are divided into `shared groups` and `regular groups`. In shared groups, everyone can see the addresses of all group members, while in regular groups, only administrators can see all members' addresses.
71
+#### Groups: Groups are divided into `shared groups` and `regular groups`. In shared groups, everyone can see the peers of all group members, while in regular groups, only administrators can see all members' peers.
74 72
 
75 73
 ![pc_gr](docs/pc_gr.png)
76 74
 
77
-### **Web UI
75
+### Web Admin
78 76
 
79
-**: The frontend and backend are separated to provide a user-friendly management interface, primarily for managing and
80
-displaying data.
77
+***The frontend and backend are separated to provide a user-friendly management interface, primarily for managing and
78
+displaying data.Frontend code is available at [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)***
81 79
 
82
-***Frontend code is available at [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)***
83
-
84
-***Admin panel URL: `http://<your server>[:port]/_admin/`. The default username and password for the initial
80
+***Admin panel URL: `http://<your server[:port]>/_admin/`. The default username and password for the initial
85 81
 installation are `admin` `admin`, please change the password immediately.***
86 82
 
87 83
 1. Admin interface:
88 84
    ![web_admin](docs/web_admin.png)
89 85
 2. Regular user interface:
90 86
    ![web_user](docs/web_admin_user.png)
91
-3. You can change your password from the top right corner:
87
+   You can change your password from the top right corner:
92 88
    ![web_resetpwd](docs/web_resetpwd.png)
93
-4. Groups can be customized for easy management. Currently, two types are supported: `shared group` and `regular group`.
89
+3. Groups can be customized for easy management. Currently, two types are supported: `shared group` and `regular group`.
94 90
    ![web_admin_gr](docs/web_admin_gr.png)
95
-5. You can open the web client directly for convenience:
91
+4. You can open the web client directly for convenience:
96 92
    ![web_webclient](docs/admin_webclient.png)
97
-6. OAuth support: Currently, `GitHub` and `Google`  is supported. You need to create an `OAuth App` and configure it in
93
+5. OAuth support: Currently, `GitHub` and `Google`  is supported. You need to create an `OAuth App` and configure it in
98 94
    the admin
99 95
    panel.
100 96
    ![web_admin_oauth](docs/web_admin_oauth.png)
@@ -103,7 +99,7 @@ installation are `admin` `admin`, please change the password immediately.***
103 99
     - Set the `Authorization callback URL` to `http://<your server[:port]>/api/oauth/callback`,
104 100
       e.g., `http://127.0.0.1:21114/api/oauth/callback`.
105 101
 
106
-### **Web Client**:
102
+### Web Client:
107 103
 
108 104
 1. If you're already logged into the admin panel, the web client will log in automatically.
109 105
 2. If you're not logged in, simply click the login button at the top right corner, and the API server will be
@@ -112,12 +108,10 @@ installation are `admin` `admin`, please change the password immediately.***
112 108
 3. After logging in, the ID server and key will be automatically synced.
113 109
 4. The address book will also be automatically saved to the web client for convenient use.
114 110
 
115
-### **Automated Documentation
116
-
117
-** : API documentation is generated using Swag, making it easier for developers to understand and use the API.
111
+### Automated Documentation : API documentation is generated using Swag, making it easier for developers to understand and use the API.
118 112
 
119
-1. Admin panel docs: `<your server>/admin/swagger/index.html`
120
-2. PC client docs: `<your server>/swagger/index.html`
113
+1. Admin panel docs: `<your server[:port]>/admin/swagger/index.html`
114
+2. PC client docs: `<your server[:port]>/swagger/index.html`
121 115
    ![api_swag](docs/api_swag.png)
122 116
 
123 117
 ## Installation and Setup
@@ -150,7 +144,7 @@ rustdesk:
150 144
   personal: 1
151 145
 ```
152 146
 
153
-* Environment variables, with the prefix `RUSTDESK_API`, will override the settings in the configuration file if
147
+* Environment variables, with the prefix `RUSTDESK_API_RUSTDESK_PERSONAL`, will override the settings in the configuration file if
154 148
   present.
155 149
 
156 150
 | Variable Name                      | Description                                               | Example                        |
@@ -383,7 +377,7 @@ Download the release from [release](https://github.com/lejianwen/rustdesk-api/re
383 377
    compiling, the corresponding executables will be generated in the `release` directory. Run the compiled executables
384 378
    directly.
385 379
 
386
-6. Open your browser and visit `http://<your server>:21114/_admin/`, with default credentials `admin admin`. Please
380
+6. Open your browser and visit `http://<your server[:port]>/_admin/`, with default credentials `admin admin`. Please
387 381
    change the password promptly.
388 382
 
389 383
 ## Miscellaneous

BIN
docs/web_admin_gr.png