Note for Mainland China users

The steps in this guide differ for users in Mainland China due to regional differences. For a version tailored to your region, please read the Simplified Chinese documentation.

Install Olares

This page provides an overview of the installation methods for Olares. To run Olares, you must create an Olares ID, and have a supported operating system, a hardware that meets or exceeds minimum requirements.

Currently, Olares is supported on the following platforms or environments:

• Linux (Ubuntu or Debian)
• PVE
• LXC
• Raspberry Pi
• macOS
• Windows (WSL)

You can install Olares using one of the following approaches:

• Using the script: Install Olares directly on your system using a simple installation script.
• Using Docker image: Run Olares as a containerized application without installing it directly on your machine.