chore: readme

This commit is contained in:
zhanghelong 2022-12-02 14:55:47 +08:00
parent 3d089c7fed
commit 6b85a7ea8a
1 changed files with 33 additions and 0 deletions

33
README.md Normal file
View File

@ -0,0 +1,33 @@
# Login Sim
IDMesh 调试用的组件,主要用于登录完成后拿到响应的用户信息,并重定向至开发者配置的指定地址。
## 开始
### 如何工作
Login sim 实际上模拟了一个受到 IDMesh SSO 保护的组件,它会在真实环境中完成用户登录流程(因此您可能需要创建测试用户以方便测试),
拿到用户凭据后它会根据配置信息,重定向至开发者配置的地址。
在过程中,它按照组件开发约定,将 `IDMesh-User-Id`、`IDMesh-User-Token` 写入 Cookie 并进行重定向。
### 安装
配置样例:
```json
{
"default_redirect_url": "https://default.cn",
"roles": {
"123": "https://somewhere123.cn"
}
}
```
配置说明:
`default_redirect_url`:必填,默认跳转地址,当未命中`roles`的规则时候会选择该地址进行重定向。
`roles`选填key 为
注:除非在环境变量`CONFIG_FILE_PATH`中指定,系统将会从``/data/config/settings.json``中读取配置信息。