Elgato_dark/Olares
1
0
Fork 0
mirror of https://github.com/beclab/Olares synced 2026-05-24 09:18:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: add documentation for the "user activate" CLI command (#1994)

Browse source
This commit is contained in:
Calvin W. 2025-10-31 10:55:17 +08:00 committed by GitHub
commit 6285359f31
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 140 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/.vitepress/en.ts
View file

@ -559,6 +559,10 @@ const side = {
text: "install",
link: "/developer/install/cli/install",
},
{
text: "user activate",
link: "/developer/install/cli/user-activate",
},
{
text: "logs",
link: "/developer/install/cli/logs",

99
docs/.vitepress/zh.ts
View file

@ -548,55 +548,60 @@ const side = {
{text: "backup", link: "/zh/developer/install/cli/backups-backup"},
{text: "restore", link: "/zh/developer/install/cli/backups-restore"},
{text: "snapshots", link: "/zh/developer/install/cli/backups-snapshots"},
],
},
],
},
{
text: "change-ip",
link: "/zh/developer/install/cli/change-ip",
},
{
text: "download",
link: "/zh/developer/install/cli/download",
},
{ text: "info", link: "/zh/developer/install/cli/info" },
{
text: "install",
link: "/zh/developer/install/cli/install",
},
{
text: "user activate",
link: "/zh/developer/install/cli/user-activate",
},
{
text: "logs",
link: "/zh/developer/install/cli/logs",
},
{
text: "precheck",
link: "/zh/developer/install/cli/precheck",
},
{
text: "prepare",
link: "/zh/developer/install/cli/prepare",
},
{
text: "release",
link: "/zh/developer/install/cli/release",
},
{
text: "start",
link: "/zh/developer/install/cli/start",
},
{
text: "stop",
link: "/zh/developer/install/cli/stop",
},
{
text: "uninstall",
link: "/zh/developer/install/cli/uninstall",
},
],
},
{
text: "change-ip",
link: "/zh/developer/install/cli/change-ip",
text: "版本说明",
link: "/zh/developer/install/versioning",
},
{
text: "download",
link: "/zh/developer/install/cli/download",
},
{text: "info", link: "/zh/developer/install/cli/info"},
{
text: "install",
link: "/zh/developer/install/cli/install",
},
{
text: "logs",
link: "/zh/developer/install/cli/logs",
},
{
text: "precheck",
link: "/zh/developer/install/cli/precheck",
},
{
text: "prepare",
link: "/zh/developer/install/cli/prepare",
},
{
text: "release",
link: "/zh/developer/install/cli/release",
},
{
text: "start",
link: "/zh/developer/install/cli/start",
},
{
text: "stop",
link: "/zh/developer/install/cli/stop",
},
{
text: "uninstall",
link: "/zh/developer/install/cli/uninstall",
},
],
},
{
text: "版本说明",
link: "/zh/developer/install/versioning",
},
],
},
{

42
docs/developer/install/cli/user-activate.md Normal file
View file

@ -0,0 +1,42 @@
# `user activate`
## Synopsis
The `user activate` command activates an existing Olares account. It requires the user's Olares ID, password, and 12-word mnemonic phrase to complete the activation. This command typically requires administrator privileges (`sudo`).
```bash
olares-cli user activate <Olares ID> [options]
```
## Arguments
| Argument | Description | Required|
|--|--|--|
| `<Olares ID>` | Specifies the unique identifier for the Olares user account to be activated. <br>Similar to an email address(e.g., `alice123@olares.com`).| **Yes** |
## Options
| Option | Shorthand | Usage | Required | Default |
|--|--|--|--|--|
| `--bfl` | | Specifies the Backend For Launcher (BFL) service URL (e.g., `https://example.com`). | No | `http://127.0.0.1:30180` |
| `--enable-tunnel` | | Enables or disables tunnel mode for activation. | No | `false` |
| `--help` | `-h` | Displays help information. | No | N/A |
| `--host` | | Specifies the Fast Reverse Proxy (FRP) host. <br>Only used when the `--enable-tunnel` option is set to `true`. | No | N/A |
| `--jws` | | Specifies the FRP JWS token.<br>Only used when the `--enable-tunnel` option is set to `true`.| No | N/A |
| `--language` | | Sets the system language. | No | `en-US` |
| `--location` | | Sets the timezone location. | No | `Asia/Shanghai` |
| `--mnemonic` | | Specifies the 12-word mnemonic phrase required for activation. | **Yes** | N/A |
| `--password` | `-p` | Specifies the Olares login password for authentication. | **Yes** | N/A |
| `--vault` | | Specifies the Vault service URL (e.g., `https://example.com`). | No | `http://127.0.0.1:30181` |
## Example
```bash
# Activate an Olares user account
sudo olares-cli user activate alice@olares.com -p "HerPassWord" --mnemonic "apple banana cherry door eagle forest grape house island jacket kite lemon"
# Activate an Olares user account with tunnel mode enabled
sudo olares-cli user activate david@olares.com -p "HisPassWord" --enable-tunnel --host "frp-gateway.olares.com" --jws "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.demo.signature" --bfl http://127.0.0.1:30180 --vault http://127.0.0.1:30180/server --mnemonic "apple banana cherry door eagle forest grape house island jacket kite lemon"
# Activate an Olares user account with specific language and timezone settings
sudo olares-cli user activate carol@olares.com -p "AnotherPassWord" --mnemonic "alpha beta gamma delta epsilon zeta eta theta iota kappa lambda mu" --language "en-US" --location "America/New_York"
```

42
docs/zh/developer/install/cli/user-activate.md Normal file
View file

@ -0,0 +1,42 @@
# `user activate`
## 命令说明
`user activate`命令用于激活已有的 Olares 账户，你需要至少提供 Olares ID、登录密码和助记词短语才能完成激活。该命令通常需要使用管理员权限（`sudo`）执行。
```bash
olares-cli user activate <Olares ID> [选项]
```
## 参数
| 参数 | 描述 | 是否必需 |
|--|--|--|
| `<Olares ID>` | 指定待激活的 Olares 用户账户的唯一标识符。<br>格式类似电子邮件地址（例如：`alice123@olares.com`）| **是** |
## 选项
| 选项 | 简写 | 用途 | 是否必需 | 默认值 |
|--|--|--|--|--|
| `--bfl` | | 指定聚合后端接口（BFL）服务地址。<br>例如：`https://example.com` | 否 | `http://127.0.0.1:30180` |
| `--enable-tunnel` | | 启用或关闭隧道模式进行激活。 | 否 | `false` |
| `--help` | `-h` | 显示帮助信息。 | 否 | 无 |
| `--host` | | 指定快速反向代理（FRP）主机地址。<br>仅当`--enable-tunnel`设置为`true`时使用。 | 否 | 无 |
| `--jws` | | 指定指定 FRP 的 JWS（JSON Web Signature）令牌。<br>仅当`--enable-tunnel`设置为`true`时使用。| 否 | 无 |
| `--language` | | 设置系统语言。| 否 | `en-US` |
| `--location` | | 设置系统时区位置。 | 否 | `Asia/Shanghai` |
| `--mnemonic` | | 指定用于激活的 12 词助记词短语。 | **是** | 无 |
| `--password` | `-p` | 指定待激活 Olares 账户的登录密码。 | **是** | 无 |
| `--vault` | | 指定 Vault 服务的 URL。<br>例如：`https://example.com` | 否 | `http://127.0.0.1:30181` |
## 使用示例
```bash
# 激活 Olares 账户
sudo olares-cli user activate alice@olares.cn -p "HerPassWord" --mnemonic "apple banana cherry door eagle forest grape house island jacket kite lemon"
# 启用隧道模式激活 Olares 账户
sudo olares-cli user activate david@olares.cn -p "HisPassWord" --enable-tunnel --host "frp-gateway.olares.com" --jws "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.demo.signature" --bfl http://127.0.0.1:30180 --vault http://127.0.0.1:30180/server --mnemonic "apple banana cherry door eagle forest grape house island jacket kite lemon"
# 使用指定的语言和时区设置，激活 Olares 账户
sudo olares-cli user activate carol@olares.cn -p "AnotherPassWord" --mnemonic "alpha beta gamma delta epsilon zeta eta theta iota kappa lambda mu" --language "cn-ZH" --location "Asia/Shanghai"
```