docs: Up readme
This commit is contained in:
45
README.md
45
README.md
@@ -49,21 +49,22 @@
|
||||
### API 服务
|
||||
基本实现了PC端基础的接口。支持Personal版本接口,可以通过配置文件`rustdesk.personal`或环境变量`RUSTDESK_API_RUSTDESK_PERSONAL`来控制是否启用
|
||||
|
||||
#### 登录
|
||||
|
||||
- 添加了`github`, `google` 以及`OIDC`授权登录,需要在后台配置好就可以用了,具体可看后台OAuth配置
|
||||
- 添加了web后台授权登录,点击后直接登录后台就自动登录客户端了
|
||||
|
||||

|
||||
|
||||
#### 地址簿
|
||||
|
||||

|
||||
|
||||
#### 群组
|
||||
群组分为`共享组`和`普通组`,共享组中所有人都能看到小组成员的设备,普通组只有管理员能看到所有小组成员的设备
|
||||
|
||||

|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%" align="center" colspan="2"><b>登录</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%" align="center" colspan="2"><img src="docs/pc_login.png"></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%" align="center"><b>地址簿</b></td>
|
||||
<td width="50%" align="center"><b>群组</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%" align="center"><img src="docs/pc_ab.png"></td>
|
||||
<td width="50%" align="center"><img src="docs/pc_gr.png"></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Web Admin:
|
||||
|
||||
@@ -75,6 +76,7 @@
|
||||

|
||||
2. 普通用户界面
|
||||

|
||||
|
||||
右上角可以更改密码,可以切换语言,可以切换`白天/黑夜`模式
|
||||
|
||||

|
||||
@@ -330,4 +332,15 @@ jwt:
|
||||
- [WIKI](https://github.com/lejianwen/rustdesk-api/wiki)
|
||||
- [链接超时问题](https://github.com/lejianwen/rustdesk-api/issues/92)
|
||||
- [修改客户端ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer)
|
||||
- [webclient来源](https://hub.docker.com/r/keyurbhole/flutter_web_desk)
|
||||
- [webclient来源](https://hub.docker.com/r/keyurbhole/flutter_web_desk)
|
||||
|
||||
|
||||
## 鸣谢
|
||||
|
||||
感谢所有做过贡献的人!
|
||||
|
||||
<a href="https://github.com/lejianwen/rustdesk-api/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=lejianwen/rustdesk-api" />
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
32
README_EN.md
32
README_EN.md
@@ -47,22 +47,22 @@ desktop software that provides self-hosted solutions.
|
||||
### 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.
|
||||
|
||||
#### Login
|
||||
|
||||
- Added `GitHub`, `Google` and `OIDC` login, which can be used after configuration in the admin panel. See the OAuth
|
||||
configuration section for details.
|
||||
- Added authorization login for the web admin panel.
|
||||
|
||||

|
||||
|
||||
#### Address Book
|
||||
|
||||

|
||||
|
||||
#### 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.
|
||||
|
||||

|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%" align="center" colspan="2"><b>Login</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%" align="center" colspan="2"><img src="docs/en_img/pc_login.png"></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%" align="center"><b>Address Book</b></td>
|
||||
<td width="50%" align="center"><b>Groups</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%" align="center"><img src="docs/en_img/pc_ab.png"></td>
|
||||
<td width="50%" align="center"><img src="docs/en_img/pc_gr.png"></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Web Admin
|
||||
|
||||
|
||||
Reference in New Issue
Block a user