Olares

English

简体中文

English

简体中文

Appearance

Install Olares using Docker image ​

You can use Docker to install and run Olares in a containerized environment. This guide explains how to set up Olares using the Docker command line interface (CLI), prepare the installation environment, activate Olares, and manage the container lifecycle.

WARNING

Currently, installing Olares via the Docker image:

  • has only been tested and verified on Linux platforms.
  • does not support GPU enablement.

System requirements ​

Make sure your device meets the following requirements.

  • Architecture: AMD64
  • CPU: At least 4 cores
  • RAM: At least 8GB of available memory
  • Storage: At least 64GB of available space (SSD recommended)

Before you begin ​

Before you begin, ensure the following:

Run Olares using the Docker CLI ​

To pull the image of Olares, execute the following command.

Replace <host ip> with your device's IP address and <olares version> with the desired version of Olares:

bash
docker run -d --privileged -v oic-data:/var \
  -e HOST_IP=<host ip> \
  -p 80:80 \
  -p 443:443 \
  -p 30180:30180 \
  --name oic \
  beclab/olares:<olares version>

where:

  • -d: Starts the container in detached mode to allow it to run in the background.
  • --privileged: Grants the container elevated privileges.
  • -v oic-data:/var: Binds a Docker volume (oic-data) to the /var directory inside the container to persist data.
  • -e HOST_IP=<host ip>: Specifies the host device's IP address as an environment variable.
  • -p 80:80: Maps port 80 on the host to port 80 in the container.
  • -p 443:443: Maps port 443 on the host to port 443 in the container.
  • -p 30180:30180: Maps port 30180 on the host to port 30180 in the container.
  • --name oic: Names the container oic for easier reference.
  • beclab/olares:<olares version>: Specifies the Olares Docker image and version. For example: beclab/olares:1.11.3.

When the container is running, you will see a container ID output. :::

Do not add the --rm flag

The --rm flag automatically deletes the container after it stops. If this happens, you will not be able to restart the container and will need to reinstall Olares to run it again. Omitting this flag preserves the container after stoppage, enabling you to resume it with thedocker start command.

Install Olares ​

Once the container is running, run the following:

bash
docker exec -it oic olares-install

Prepare Wizard URL ​

At the end of the installation process, you will be prompted to enter your domain name and Olares ID.

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.

    Select language

  4. Activate Olares using LarePass app.

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

    Same network required

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

    Activate Olares

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

    Reactivate Olares with the same Olares ID

    If you have reinstalled Olares, the original instance becomes unavailable. To reactivate Olares with the same Olares ID:

    1. Open LarePass on your phone, and you can see a red prompt: "No active Olares found".
    2. Tap Learn more, then Reactivate to enter the QR scan page.
    3. Tap Scan QR code to scan the QR code on the wizard page and activate Olares.

After successful setup, the LarePass app will automatically go to the home screen, and the Wizard will redirect you to the login page.

Log in to Olares ​

  1. Enter 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 the two-factor verification. You can confirm login on LarePass, or manually enter the 6-digit verification code.

    INFO

    The verification code is time-sensitive. Ensure you enter it before it expires. If it does, you will need to generate a new code.

    Confirm login

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

Manage the Olares container ​

Restart the container ​

To restart the container after it has been stopped:

bash
docker start oic

Stop the container ​

To stop the running container:

bash
docker stop oic

Uninstall the container ​

To completely remove the container and its associated data:

bash
docker stop oic
docker rm oic
docker volume rm oic-data

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.