diff --git a/docs/developer/develop/advanced/terminus-info.md b/docs/developer/develop/advanced/terminus-info.md index 4d99fbf85..24f68a646 100644 --- a/docs/developer/develop/advanced/terminus-info.md +++ b/docs/developer/develop/advanced/terminus-info.md @@ -1,37 +1,74 @@ -# terminus-info +# olares-info -terminus-info is an API without authentication. It displays publicly available system information. You can think of it as a house number sign. +olares-info is an API without authentication. It displays publicly available system information. You can think of it as a house number sign. ## API Call ``` -https://.olares.com/api/terminus-info +https://.olares.com/api/olares-info ``` ## Data Structure ```json -interface TerminusInfo { - terminusName: string; +interface OlaresInfo { + olaresId: string; wizardStatus: string; - selfhosted: boolean; + enable_reverse_proxy: boolean; tailScaleEnable: boolean; osVersion: string; avatar: string; loginBackground: string; - terminusId: string; + id: string; } ``` ## API Field Definitions -| Field | Description | -|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| terminusName | The user's Olares ID follows a format like `username@domain.com`. | -| wizardStatus | Activation status of Olares, possible statuses includes: `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`. When the status displays `completed`, it indicates that the system has been successfully activated. We advise against third-party programs executing excessive business-related logic before the system is fully activated. | -| selfhosted | Whether the Olares is running on Olares Space | -| tailScaleEnable | Whether the TailScale is activated. If so, all private entrances can only be accessed through the VPN.
Note: This field does not affect whether LarePass uses local access when connecting to Olares. | -| osVersion | Olares version | -| avatar | User's Avatar | -| loginBackground | Background image of the login interface | -| olaresId | Every time the user activates Olares, a new unique ID is generated. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
olaresId The user's Olares ID follows a format like username@domain.com.
wizardStatusActivation status of Olares, possible statuses includes: 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.
When the status displays completed, it indicates that the system has been successfully activated. We advise against third-party programs executing excessive business-related logic before the system is fully activated. +
enable_reverse_proxyWhether a reverse proxy is enabled.
tailScaleEnable Whether the TailScale is activated. If so, all private entrances can only be accessed through the VPN.
Note: This field does not affect whether LarePass uses local access when connecting to Olares.
osVersion Olares version
avatarUser's Avatar
loginBackgroundBackground image of the login interface
idEvery time the user activates Olares, a new unique ID is generated.
\ No newline at end of file diff --git a/docs/zh/developer/develop/advanced/terminus-info.md b/docs/zh/developer/develop/advanced/terminus-info.md index a51c74171..13b87b14d 100644 --- a/docs/zh/developer/develop/advanced/terminus-info.md +++ b/docs/zh/developer/develop/advanced/terminus-info.md @@ -1,37 +1,74 @@ -# terminus-info +# olares-info -terminus-info 是一个无需鉴权的接口，我们将一些系统可以对外展示的信息放在这里。可以理解为它是房子的门牌。 +olares-info 是一个无需鉴权的接口，我们将一些系统可以对外展示的信息放在这里。可以理解为它是房子的门牌。 ## 外部调用 ``` -https://.olares.com/api/terminus-info +https://.olares.com/api/olares-info ``` ## 字段含义 ```json -interface TerminusInfo { - terminusName: string; - wizardStatus: string; - selfhosted: boolean; - tailScaleEnable: boolean; - osVersion: string; - avatar: string; - loginBackground: string; - terminusId: string; +interface OlaresInfo { + olaresId: string; + wizardStatus: string; + enable_reverse_proxy: boolean; + tailScaleEnable: boolean; + osVersion: string; + avatar: string; + loginBackground: string; + id: string; } ``` ## 字段含义 -| 字段 | 解释 | -| --------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| terminusName | 用户的 Olares ID。格式是: `username@domain.com`。 | -| wizardStatus | Olares 的激活状态，有以下状态：
`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`。
当状态为 `completed` 时，代表用户激活成功。在用户激活成功前，不推荐第三方程序进行太多业务相关的逻辑。 | -| selfhosted | 用户所在的 Olares 是否运行在 Olares Space 上 | -| tailScaleEnable | 用户是否激活了 TailScale，如果激活了私有入口只能通过 VPN 访问
用途：LarePass 在连接 Olares 时，不根据这个变量决定是否增加 local 访问。 | -| osVersion | Olares 的系统版本 | -| avatar | 用户的头像 | -| loginBackground | 登录界面的背景图 | -| terminusId | 用户在每次激活时，都会生成一个新的唯一 ID | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
olaresId 用户的 Olares ID。格式是：username@domain.com.
wizardStatusOlares 的激活状态，有以下状态：
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。
当状态为 completed 时，代表用户激活成功。在用户激活成功前，不推荐第三方程序进行太多业务相关的逻辑。 +
enable_reverse_proxy用户是否启用了反向代理
tailScaleEnable 用户是否激活了 TailScale。如果激活了私有入口，只能通过 VPN 访问。
用途：LarePass 在连接 Olares 时，不根据这个变量决定是否增加 local 访问。
osVersion Olares 的系统版本
avatar用户的头像
loginBackground登录界面的背景图
id用户在每次激活时，都会生成一个新的唯一 ID
\ No newline at end of file