eliott/Olares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add docs to main (#1559)

Browse Source
This commit is contained in:
Peng Peng
2025-07-17 11:58:59 +08:00
committed by GitHub
parent e00018de59
commit af8e3b172c
1037 changed files with 40779 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/zh/developer/develop/advanced/terminus-info.md Normal file
View File

@@ -0,0 +1,37 @@
# terminus-info
terminus-info 是一个无需鉴权的接口，我们将一些系统可以对外展示的信息放在这里。可以理解为它是房子的门牌。
## 外部调用
```
https://<username>.olares.com/api/terminus-info
```
## 字段含义
```json
interface TerminusInfo {
terminusName: string;
wizardStatus: string;
selfhosted: boolean;
tailScaleEnable: boolean;
osVersion: string;
avatar: string;
loginBackground: string;
terminusId: string;
}
```
## 字段含义
| 字段 | 解释 |
| --------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| terminusName | 用户的 Olares ID。格式是: `username@domain.com`。 |
| wizardStatus | Olares 的激活状态，有以下状态：<br>`wait_activate_vault`，`vault_activating`，`vault_activate_failed`，`wait_activate_system`，`system_activating`，`system_activate_failed`，`wait_activate_network`，`network_activating`，`network_activate_failed`，`wait_reset_password`, `completed`。 <br> 当状态为 `completed` 时，代表用户激活成功。在用户激活成功前，不推荐第三方程序进行太多业务相关的逻辑。 |
| selfhosted | 用户所在的 Olares 是否运行在 Olares Space 上 |
| tailScaleEnable | 用户是否激活了 TailScale，如果激活了私有入口只能通过 VPN 访问 <br> 用途：LarePass 在连接 Olares 时，不根据这个变量决定是否增加 local 访问。 |
| osVersion | Olares 的系统版本 |
| avatar | 用户的头像 |
| loginBackground | 登录界面的背景图 |
| terminusId | 用户在每次激活时，都会生成一个新的唯一 ID |