mirror of
https://github.com/lejianwen/rustdesk-api.git
synced 2026-03-04 21:04:43 +00:00
up readme
This commit is contained in:
24
README.md
24
README.md
@@ -68,13 +68,13 @@
|
||||
|
||||

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

|
||||
|
||||
### **Web Admin**: 使用前后端分离,提供用户友好的管理界面,主要用来管理和展示。
|
||||
### Web Admin:
|
||||
|
||||
***前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)***
|
||||
***使用前后端分离,提供用户友好的管理界面,主要用来管理和展示。前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)***
|
||||
|
||||
***后台访问地址是`http://<your server>[:port]/_admin/`初次安装管理员为用户名密码为`admin` `admin`,请即时更改密码***
|
||||
|
||||
@@ -82,21 +82,21 @@
|
||||

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

|
||||
3. 右上角也可以更改密码
|
||||
右上角也可以更改密码
|
||||

|
||||
|
||||
4. 分组可以自定义,方便管理,暂时支持两种类型: `共享组` 和 `普通组`
|
||||
3. 分组可以自定义,方便管理,暂时支持两种类型: `共享组` 和 `普通组`
|
||||

|
||||
5. 可以直接打开webclient,方便使用
|
||||
4. 可以直接打开webclient,方便使用
|
||||

|
||||
6. Oauth,暂时只支持了`Github`和`Google`, 需要创建一个`OAuth App`,然后配置到后台
|
||||
5. Oauth,暂时只支持了`Github`和`Google`, 需要创建一个`OAuth App`,然后配置到后台
|
||||

|
||||
- `github oauth app`在`Settings`->`Developer settings`->`OAuth Apps`->`New OAuth App`
|
||||
中创建,地址 [https://github.com/settings/developers](https://github.com/settings/developers)
|
||||
- `Authorization callback URL`填写`http://<your server[:port]>/api/oauth/callback`
|
||||
,比如`http://127.0.0.1:21114/api/oauth/callback`
|
||||
|
||||
### **Web Client**:
|
||||
### Web Client:
|
||||
|
||||
1. 如果已经登录了后台,web client将自动直接登录
|
||||
2. 如果没登录后台,点击右上角登录即可,api server已经自动配置好了
|
||||
@@ -104,10 +104,10 @@
|
||||
3. 登录后,会自动同步ID服务器和KEY
|
||||
4. 登录后,会将地址簿自动保存到web client中,方便使用
|
||||
|
||||
### **自动化文档**: 使用 Swag 生成 API 文档,方便开发者理解和使用 API。
|
||||
### 自动化文档: 使用 Swag 生成 API 文档,方便开发者理解和使用 API。
|
||||
|
||||
1. 后台文档 `<youer server>/admin/swagger/index.html`
|
||||
2. PC端文档 `<youer server>/swagger/index.html`
|
||||
1. 后台文档 `<youer server[:port]>/admin/swagger/index.html`
|
||||
2. PC端文档 `<youer server[:port]>/swagger/index.html`
|
||||

|
||||
|
||||
## 安装与运行
|
||||
@@ -371,7 +371,7 @@ lejianwen/rustdesk-api
|
||||
5. 编译,如果想自己编译,先cd到项目根目录,然后windows下直接运行`build.bat`,linux下运行`build.sh`,编译后会在`release`
|
||||
目录下生成对应的可执行文件。直接运行编译后的可执行文件即可。
|
||||
|
||||
6. 打开浏览器访问`http://<your server>:21114/_admin/`,默认用户名密码为`admin`,请及时更改密码。
|
||||
6. 打开浏览器访问`http://<your server[:port]>/_admin/`,默认用户名密码为`admin`,请及时更改密码。
|
||||
|
||||
## 其他
|
||||
|
||||
|
||||
Reference in New Issue
Block a user