# 使用手册
| ⽂档版本 | 内容修订 | 修订⼈ | 修订⽇期 |
|---|---|---|---|
| V1.0 | 初稿 | 郭程豪 | 2023-09-01 |
# 目录
# 目标
- 解决用户使用困难的问题：降低使用成本
- 解决服务对接繁琐的问题：降低交互成本
- 解决部署配置项过多问题：降低部署成本
# 页面展示
# 应用列表
# 用户管理
# 个人信息
# 令牌管理
# 功能
# 应用管理
- 查看已有应用
- 搜索局域网中可用服务
- 编辑应用信息
- 维护应用角色
# 用户管理
- 添加用户
- 编辑用户信息
- 设置用户启停状态
- 设置用户角色
# 账号管理
- 维护个人信息
- 绑定管理账号
# 令牌管理
- 新增令牌
- 删除令牌
# API
https://console-docs.apipost.cn/preview/1a52b8b93925675e/55922c519a517dd9
# 硬件和操作系统要求
| 硬件要求 | 推荐规格 |
|---|---|
| 处理器(CPU) | >= i5-10500，arm 或 x84-64 |
| 内存(RAM) | >= 16G |
| 硬盘(DISK) | >= 512G，推荐 SSD |
| 操作系统 | 推荐版本 |
|---|---|
| Windows | >= Win10 |
| Macos | >= 12.1 |
| Ubuntu | >= 20.04 |
| 浏览器 | 推荐版本 |
|---|---|
| chrome | >= 90.0.4430 |
| edge | >= 90.0.818.8 |
# 认证流程-授权码方式
+--------+ +---------------+
| |--(A)- Authorization Request ->| Resource |
| | | Owner |
| |<-(B)-- Authorization Grant ---| |
| | +---------------+
| |
| | +---------------+
| |--(C)-- Authorization Grant -->| Authorization |
| Client | | Server |
| |<-(D)----- Access Token -------| |
| | +---------------+
| |
| | +---------------+
| |--(E)----- Access Token ------>| Resource |
| | | Server |
| |<-(F)--- Protected Resource ---| |
+--------+ +---------------+
- A 客户端向资源拥有者发送授权申请；
- B 资源拥有者同意客户端的授权，返回授权码；
- C 客户端使用授权码向认证服务器申请令牌token；
- D 认证服务器对客户端进行身份校验，认证通过后发放令牌；
- E 客户端拿着认证服务器颁发的令牌去资源服务器请求资源；
- F 资源服务器校验令牌的有效性，返回给客户端资源信息；
# 认证流程-密码方式
+----------+
| Resource |
| Owner |
| |
+----------+
v
| Resource Owner
(A) Password Credentials
|
v
+---------+ +---------------+
| |>--(B)---- Resource Owner ------->| |
| | Password Credentials | Authorization |
| Client | | Server |
| |<--(C)---- Access Token ---------<| |
| | (w/ Optional Refresh Token) | |
+---------+ +---------------+
A 资源拥有者向客户端提供账号密码
B 客户端使用账号密码向认证服务器申请令牌token
C 授权服务器对客户端和资源所有者凭据进行验证，如果有效，则返回token代币
# 服务发现-使用范围
- 局域网开启
- 公网不开启
如果服务发现功能开启，应用列表页面显示服务状态字段，列表5秒自动刷新一次
如果服务发现功能关闭，应用列表页面不显示服务状态字段，列表不自动刷新
# 服务发现-原理
使用ssdp搜索服务，搜索到服务后，执行如下操作
- 自动搜索局域网内可用设备
应用管理无服务，自动创建新应用
应用管理有n个服务，遍历服务，寻找第一个未绑定IP的服务，自动绑定
应用管理有n个服务，遍历服务，未寻找到可绑定IP的服务，自动创建新应用
- 应用列表
对于不需要的服务，可以设置忽略
忽略后的应用，通过点击添加服务-已忽略列表，点击恢复重新添加至应用列表