mirror of
https://github.com/beclab/Olares
synced 2026-05-24 09:18:23 +00:00
Update field names and relevant description (#1982)
This commit is contained in:
Calvin W.
GitHub
commit
ac482bceae
2 changed files with 113 additions and 39 deletions
|
|
@ -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://<username>.olares.com/api/terminus-info
|
||||
https://<username>.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. <br> 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. |
|
||||
<table style="width:100%; table-layout:fixed; border-collapse:collapse;">
|
||||
<colgroup>
|
||||
<col style="width:25%;">
|
||||
<col style="width:75%;">
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="text-align:left;">Field</th>
|
||||
<th style="text-align:left;">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="text-align:left;">olaresId </td>
|
||||
<td style="text-align:left; white-space:normal; word-break:break-word;">The user's Olares ID follows a format like <code>username@domain.com</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>wizardStatus</td>
|
||||
<td style="white-space:normal; word-break:break-word;">Activation status of Olares, possible statuses includes: <code>wait_activate_vault</code>, <code>vault_activating</code>, <code>vault_activate_failed</code>, <code>wait_activate_system</code>, <code>system_activating</code>, <code>system_activate_failed</code>, <code>wait_activate_network</code>, <code>network_activating</code>, <code>network_activate_failed</code>, <code>wait_reset_password</code>, <code>completed</code>. <br>When the status displays <code>completed</code>, 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.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>enable_reverse_proxy</td>
|
||||
<td>Whether a reverse proxy is enabled.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>tailScaleEnable </td>
|
||||
<td>Whether the TailScale is activated. If so, all private entrances can only be accessed through the VPN. <br>Note: This field does not affect whether LarePass uses local access when connecting to Olares.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>osVersion </td>
|
||||
<td>Olares version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>avatar</td>
|
||||
<td>User's Avatar</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>loginBackground</td>
|
||||
<td>Background image of the login interface</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>Every time the user activates Olares, a new unique ID is generated.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1,37 +1,74 @@
|
|||
# terminus-info
|
||||
# olares-info
|
||||
|
||||
terminus-info 是一个无需鉴权的接口，我们将一些系统可以对外展示的信息放在这里。可以理解为它是房子的门牌。
|
||||
olares-info 是一个无需鉴权的接口，我们将一些系统可以对外展示的信息放在这里。可以理解为它是房子的门牌。
|
||||
|
||||
## 外部调用
|
||||
|
||||
```
|
||||
https://<username>.olares.com/api/terminus-info
|
||||
https://<username>.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 的激活状态，有以下状态：<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 |
|
||||
<table style="width:100%; table-layout:fixed; border-collapse:collapse;">
|
||||
<colgroup>
|
||||
<col style="width:25%;">
|
||||
<col style="width:75%;">
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="text-align:left;">Field</th>
|
||||
<th style="text-align:left;">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="text-align:left;">olaresId </td>
|
||||
<td style="text-align:left; white-space:normal; word-break:break-word;">用户的 Olares ID。格式是：<code>username@domain.com</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>wizardStatus</td>
|
||||
<td style="white-space:normal; word-break:break-word;">Olares 的激活状态，有以下状态：<br><code>wait_activate_vault</code>，<code>vault_activating</code>，<code>vault_activate_failed</code>，<code>wait_activate_system</code>，<code>system_activating</code>，<code>system_activate_failed</code>，<code>wait_activate_network</code>，<code>network_activating</code>，<code>network_activate_failed</code>，<code>wait_reset_password</code>，<code>completed</code>。<br>当状态为 <code>completed</code> 时，代表用户激活成功。在用户激活成功前，不推荐第三方程序进行太多业务相关的逻辑。
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>enable_reverse_proxy</td>
|
||||
<td>用户是否启用了反向代理</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>tailScaleEnable </td>
|
||||
<td>用户是否激活了 TailScale。如果激活了私有入口，只能通过 VPN 访问。<br>用途：LarePass 在连接 Olares 时，不根据这个变量决定是否增加 local 访问。</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>osVersion </td>
|
||||
<td>Olares 的系统版本</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>avatar</td>
|
||||
<td>用户的头像</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>loginBackground</td>
|
||||
<td>登录界面的背景图</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>用户在每次激活时，都会生成一个新的唯一 ID</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
Loading…
Reference in a new issue