olares-info

olares-info 是一个无需鉴权的接口，我们将一些系统可以对外展示的信息放在这里。可以理解为它是房子的门牌。

外部调用

https://<username>.olares.com/api/olares-info

字段含义

interface OlaresInfo {
  olaresId: string;
  wizardStatus: string;
  enable_reverse_proxy: boolean;
  tailScaleEnable: boolean;
  osVersion: string;
  avatar: string;
  loginBackground: string;
  id: string;
}

字段含义

Field	Description
olaresId	用户的 Olares ID。格式是：[email protected].
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 时，代表用户激活成功。在用户激活成功前，不推荐第三方程序进行太多业务相关的逻辑。
enable_reverse_proxy	用户是否启用了反向代理
tailScaleEnable	用户是否激活了 TailScale。如果激活了私有入口，只能通过 VPN 访问。 用途：LarePass 在连接 Olares 时，不根据这个变量决定是否增加 local 访问。
osVersion	Olares 的系统版本
avatar	用户的头像
loginBackground	登录界面的背景图
id	用户在每次激活时，都会生成一个新的唯一 ID