Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/developer/concepts/olares-id.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,13 @@ The format of an Olares ID is the same as an email address, consisting of two pa
For example, in `alice123@olares.com`, *`alice123`* is the local name, and *`olares.com`* is the domain.

Local names are unique within each domain, ensuring that each Olares ID is unique.
The username part of an Olares ID must be 8-24 characters long.

### Domain types
Within Olares, there are three types of Domains:

* Individual domain: For personal use, similar to personal email. Currently, Olares provides default domain `olares.com` for individual users.
* Organizational domain: For organizational use, like company email addresses. After joining an organization, users can apply for an Olares ID under that organization's domain. The administrator can revoke this Olares ID when the user leaves the organization.
* Organizational domain: For organizational use, like company email addresses. Organization domain names must be 2-24 characters long. After joining an organization, users can apply for an Olares ID under that organization's domain. The administrator can revoke this Olares ID when the user leaves the organization.
* Entity domain: For applications and other entities that cannot be classified as either personal or organizational.

### Olares ID creation for individuals
Expand Down
4 changes: 2 additions & 2 deletions docs/developer/install/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,12 +150,12 @@ Specifies the password to use instead of a generated one.
### TERMINUS_OS_USERNAME

Specifies the username before installation to skip the interactive prompt.
- **Valid values**: Any valid username (2–250 characters, excluding reserved keywords)
- **Valid values**: Any valid username (8-24 characters, excluding reserved keywords)
- **Default**: None (prompts for username if not set)
- **Validation**: Reserved keywords include `user`, `system`, `space`, `default`, `os`, `kubesphere`, `kube`, `kubekey`, `kubernetes`, `gpu`, `tapr`, `bfl`, `bytetrade`, `project`, `pod`.

### TOKEN_MAX_AGE

Sets the maximum validity period for a token (in seconds).
- **Valid values**: Any integer (in seconds)
- **Default**: `31536000` (365 days)
- **Default**: `31536000` (365 days)
4 changes: 2 additions & 2 deletions docs/reusables/custom-domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,10 @@ Once TXT and NS records are verified, you can proceed to create an organization
Once an organization is created for a domain, the domain cannot be removed from Olares Space.
:::

4. Enter the username for your Olares ID. For example, if you enter `alex`, your Olares ID will be `alex@space.n1.monster`.
4. Enter the username for your Olares ID. For example, if you enter `alex2026`, your Olares ID will be `alex2026@space.n1.monster`.

:::info
The username part of your Olares ID should be 1-63 characters long, with lowercase alphanumeric characters only.
The username part of your Olares ID should be 8-24 characters long, with lowercase alphanumeric characters only.
:::
![Create an Olares ID with admin privileges](/images/manual/tutorials/custom-domain-create-olares-id-as-admin.png)

Expand Down
4 changes: 2 additions & 2 deletions docs/zh/developer/concepts/olares-id.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Olares ID 带来无缝访问、增强安全与个性化体验:
- **本地名(前缀)**
- **域名(后缀)**

如 `alice123@olares.com` 中,`alice123` 为本地名,`olares.com` 为域名。本地名在域内唯一,保证整体唯一性。
如 `alice123@olares.com` 中,`alice123` 为本地名,`olares.com` 为域名。本地名在域内唯一,保证整体唯一性。Olares ID 的用户名部分长度应为 8-24 个字符。

### 域名类型

Expand All @@ -46,7 +46,7 @@ Olares 提供三类域名:
| 类型 | 说明 |
|------------|--------------------------------------------|
| 个人域名 | 供个人使用,目前提供默认域名 `olares.com` |
| 组织域名 | 供企业/组织使用,管理员可在成员离职时回收 |
| 组织域名 | 供企业/组织使用,组织域名长度应为 2-24 个字符,管理员可在成员离职时回收 |
| 实体域名 | 供应用或其他无法归类为个人/组织的实体使用 |

### 个人 Olares ID 创建方式
Expand Down
4 changes: 2 additions & 2 deletions docs/zh/developer/install/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,12 +166,12 @@ curl -sSfL https://olares.sh | bash
### TERMINUS_OS_USERNAME

在安装前预先设置用户名,会跳过安装过程中的对应交互式提示。
- **可选值**:任意有效用户名(长度 2~250,且不与保留关键词冲突)
- **可选值**:任意有效用户名(长度 8-24 个字符,且不与保留关键词冲突)
- **默认值**:无(若不设置则会提示输入用户名)
- **验证规则**:保留关键词包括 `user`、`system`、`space`、`default`、`os`、`kubesphere`、`kube`、`kubekey`、`kubernetes`、`gpu`、`tapr`、`bfl`、`bytetrade`、`project`、`pod`

### TOKEN_MAX_AGE

设置 Token 的最大有效时长(单位:秒)。
- **可选值**:任意整数(单位:秒)
- **默认值**:`31536000`(365 天)
- **默认值**:`31536000`(365 天)
4 changes: 2 additions & 2 deletions docs/zh/reusables/custom-domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,10 @@ TXT 和 NS 记录验证通过后,可以在 LarePass 中创建组织。
为域名创建组织后,该域名将无法从 Olares Space 中移除。
:::

4. 输入 Olares ID 的用户名部分。例如输入 `alex`,则 Olares ID 为 `alex@space.n1.monster`。
4. 输入 Olares ID 的用户名部分。例如输入 `alex2026`,则 Olares ID 为 `alex2026@space.n1.monster`。

:::info
用户名部分应为 1-63 个字符,仅支持小写字母和数字。
用户名部分应为 8-24 个字符,仅支持小写字母和数字。
:::
![以管理员身份创建 Olares ID](/images/manual/tutorials/custom-domain-create-olares-id-as-admin.png)

Expand Down