Olares

English

简体中文

English

简体中文

Appearance

Install Olares on Linux via the script ​

This guide explains how to install Olares on Linux using the provided installation script.

Prerequisites ​

  • Olares device: A machine that meets the Linux system requirements.
  • Operating system: Ubuntu 22.04–25.04 or Debian 12/13.
  • LarePass: Install LarePass on your phone. It is required to finish setup and activate Olares.
  • Permissions: A user account with sudo access.

Install Olares ​

In your terminal, run the following command:

bash
curl -fsSL https://olares.sh |  bash -

Root user password

During the installation, you may be prompted to enter your root password.

Errors during installation?

If an error occurs during installation, use the following command to uninstall first:

bash
olares-cli uninstall --all

After uninstalling, retry the installation by running the original installation command.

Prepare Wizard URL ​

At the end of the installation process, you will be prompted to enter your domain name and Olares ID. Enter the ID you use in LarePass. If you do not have one yet, open LarePass, tap Create an account, and follow the prompts before continuing.

Enter domain name and Olares ID

For example, if your full Olares ID is alice123@olares.com:

  • Domain name: Press Enter to use the default domain name or type olares.com.
  • Olares ID: Enter the prefix of your Olares ID. In this example, enter alice123.

Upon completion of the installation, the initial system information, including the Wizard URL and the initial login password, will appear on the screen. You will need them later in the activation stage.

Wizard URL

Activate Olares ​

Use the Wizard URL and initial one-time password to activate. This process connects the Olares device with your Olares ID using LarePass.

  1. Enter the Wizard URL in your browser. You will be directed to the welcome page. Press any key to continue.

    Open wizard

  2. Enter the one-time password and click Continue.

    Enter password

  3. Select the system language. Olares supports English, Simplified Chinese, German, Spanish, Italian, French, and Japanese. The Wizard switches to the selected language immediately, and Olares Desktop uses the same language after activation.

    Select language

  1. Select a reverse proxy node that is geographically closest to your location. You can adjust this later on the Change reverse proxy page.

    Select FRP

    Note

    If your Olares device is connected to a public IP network, this step will be skipped automatically.

  1. Activate Olares using LarePass app.

Same network required for admin users

To avoid activation failures, ensure that both your phone and the Olares device are connected to the same network.

a. Open LarePass app, and tap Scan QR code to scan the QR code on the Wizard page and complete the activation.

Activate Olares

b. Reset the login password for Olares by following the on-screen instructions on LarePass.

TIP

If you reinstall Olares, the original instance becomes unavailable. To continue using the same Olares ID, you need to reactivate Olares.

After setup is complete, the LarePass app returns to the home screen, and the Wizard redirects you to the Olares login page.

Log in to Olares ​

  1. Open the Olares desktop address in your browser, and press any key to continue.

  2. On the login page, enter your Olares login password.

    Log in

  3. You will be prompted to complete two-factor verification:

    • Confirm on LarePass: Open the login notification on your phone, and tap Confirm.
    • Enter the code manually: Select Verify using one time password from LarePass on the login page. Get the 6-digit code from the LarePass app on your phone (Settings > My Olares card, tap the authenticator) or from the LarePass desktop client (Vault, the first item in the list), and enter it to complete the login.

    Confirm login

    INFO

    The verification code is time-sensitive. Ensure you enter it before it expires.

Once you've logged in, you'll be directed to the Olares desktop.🎉

Next step: Protect your Olares ID ​

You're almost ready to start using Olares! Before diving in, it's crucial to ensure your Olares ID is securely backed up. Without this step, you won't be able to recover Olares ID if needed.

Having trouble?

If you run into any issues, submit a GitHub Issue and include your platform, installation method, and error details.