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. Similar to an email address(e.g., [email protected]). | 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. Only used when the --enable-tunnel option is set to true. | No | N/A | |
--jws | Specifies the FRP JWS token. 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 [email protected] -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 [email protected] -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 [email protected] -p "AnotherPassWord" --mnemonic "alpha beta gamma delta epsilon zeta eta theta iota kappa lambda mu" --language "en-US" --location "America/New_York"