From a72096b56d420946d04adc4044f586b6438b35fa Mon Sep 17 00:00:00 2001 From: lejianwen <84855512@qq.com> Date: Thu, 16 Jan 2025 21:59:46 +0800 Subject: [PATCH] docs: Up readme --- README.md | 45 +++++++++++++++++++++++++++++---------------- README_EN.md | 32 ++++++++++++++++---------------- 2 files changed, 45 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index fc7f9ca..50348a2 100644 --- a/README.md +++ b/README.md @@ -49,21 +49,22 @@ ### API 服务 基本实现了PC端基础的接口。支持Personal版本接口,可以通过配置文件`rustdesk.personal`或环境变量`RUSTDESK_API_RUSTDESK_PERSONAL`来控制是否启用 -#### 登录 - -- 添加了`github`, `google` 以及`OIDC`授权登录,需要在后台配置好就可以用了,具体可看后台OAuth配置 -- 添加了web后台授权登录,点击后直接登录后台就自动登录客户端了 - -![pc_login](docs/pc_login.png) - -#### 地址簿 - -![pc_ab](docs/pc_ab.png) - -#### 群组 -群组分为`共享组`和`普通组`,共享组中所有人都能看到小组成员的设备,普通组只有管理员能看到所有小组成员的设备 - -![pc_gr](docs/pc_gr.png) + + + + + + + + + + + + + + + +
登录
地址簿群组
### Web Admin: @@ -75,6 +76,7 @@ ![web_admin](docs/web_admin.png) 2. 普通用户界面 ![web_user](docs/web_admin_user.png) + 右上角可以更改密码,可以切换语言,可以切换`白天/黑夜`模式 ![web_resetpwd](docs/web_resetpwd.png) @@ -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) \ No newline at end of file +- [webclient来源](https://hub.docker.com/r/keyurbhole/flutter_web_desk) + + +## 鸣谢 + +感谢所有做过贡献的人! + + + + + + diff --git a/README_EN.md b/README_EN.md index 6a9b70c..2e60ad2 100644 --- a/README_EN.md +++ b/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. - -![pc_login](docs/en_img/pc_login.png) - -#### Address Book - -![pc_ab](docs/en_img/pc_ab.png) - -#### 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. - -![pc_gr](docs/en_img/pc_gr.png) + + + + + + + + + + + + + + + +
Login
Address BookGroups
### Web Admin