Olares

English

简体中文

English

简体中文

Appearance

Activate an Olares device using the Olares CLI ​

Activate a new or uninitialized Olares device, such as Olares One, using the Olares CLI tool.

Learning objectives ​

In this tutorial, you will learn how to:

  • Install Olares on a new device.
  • Obtain and run the correct Olares CLI tool for your system version.
  • Retrieve a Fast Reverse Proxy (FRP) host for remote access.
  • Run the activation command to configure your device.

Prerequisites ​

Before you begin, ensure the following requirements are met:

  • You can access the Olares device directly with a keyboard and monitor, or via SSH.

  • The device has internet access to download packages, query FRP servers, and complete activation.

  • You can run commands as the root user, or prepend commands with sudo.

  • You have created an Olares ID using the LarePass app, and have backed up your 12-word mnemonic phrase.

    Fast creation

Step 1: Install Olares ​

For Olares One hardware

A fresh Olares One device is shipped in an uninstalled state. You must run the installation command to set up Olares first before you attempt activation.

  1. Run the install command as root.

    bash
    sudo olares-cli install

  2. When prompted to enter the domain name, enter olares.com.

  3. When prompted for the Olares ID, enter the one you registered in the LarePass app. For example, alice2026.

  4. Wait for the installation process to finish. The terminal outputs a wizard URL and a default password. Note down these details for the activation step.

    Example:

    • Wizard URL: The local gateway address, such as http://192.168.31.127:30180.
    • Password: The default Olares login password.

    Wizard URL

Step 2: Prepare the CLI tool ​

Determine your CLI preparation steps based on your Olares version.

  1. Run the following command to check the current Olares version.

    bash
    sudo olares-cli --version

  2. Check the version in the output, and select the method based on your version.

Step 3: Retrieve the FRP list ​

Find an available FRP host to enable remote access to your device.

  1. Run the following command based on your Olares version. Replace {olares-id} with your registered Olares ID.

  2. Select a host address from the output list and note it down for the activation step. For example, bb.hongkong.frp.olares.com.

Step 4: Activate Olares ​

Run the activation command to configure and secure your device. This process connects your Olares ID to the device and configures network tunneling and credentials.

  1. Prepare your activation command based on the following required parameters:

    ParameterDescription
    olares-idThe Olares ID you created in LarePass, for example alice2026@olares.com.
    mnemonicThe 12-word mnemonic phrase of your Olares ID.
    passwordThe default Olares login password from Step 1.
    reset-passwordA new login password to replace the default one.
    authurlThe Wizard URL from Step 1.
    vaultThe Wizard URL from Step 1, followed by /server.
    bflThe Wizard URL from Step 1.
    hostThe FRP host address from Step 3.
    enable-tunnelSet to true to enable tunnel mode.

  2. Based on your Olares version, replace the placeholders in the following command with your specific values, and then run it.

  3. Wait until the terminal displays a message indicating that the activation finished successfully.

Next step ​

You can now log into Olares using your Olares ID and the login password you specified in reset-password.

Learn more ​