Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Before proceeding, ensure that your setup meets the following requirements:
- RAM: Recommended 16 GB or more
- Storage: Minimum 200 GB SSD (installation may fail on HDD)
- PVE Version: 8.3.2
- Olares ISO Image: Download the [official Olares ISO image](https://dc3p1870nn3cj.cloudfront.net/olares-v1.12.1-amd64.iso) before you start.
- Olares ISO Image: Download the [official Olares ISO image](https://cdn.olares.com/olares-latest-amd64.iso) before you start.

## Configure GPU passthrough in PVE

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/get-started/activate-olares.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Use the Wizard URL and initial one-time password to activate. This process conne
If you reinstall Olares, the original instance becomes unavailable. To continue using the same Olares ID, you need to [reactivate Olares](../larepass/activate-olares.md#reactivate-olares-with-the-same-olares-id).
:::

After setup is complete, the LarePass app returns to the home screen, and the Wizard redirects you to the Olares login page.
After setup is complete, the LarePass app returns to the home screen, and the Wizard redirects you to the Olares login page.
38 changes: 38 additions & 0 deletions docs/manual/get-started/gpu-requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
search: false
---

A GPU is not required to install Olares, but is necessary for most AI applications. Only NVIDIA GPUs are supported.

- **Architecture**: Turing or newer (GTX 16xx, RTX 20xx, 30xx, 40xx, 50xx series, and later).
:::info
GPUs with older architectures are not recognized by Olares. AI applications that require GPU access will not run.
:::
- **VRAM**: At least 8 GB recommended. Even on a supported GPU, limited VRAM will prevent many AI applications from running.

:::details Not sure if your GPU is supported?
Run the following command and check the code name prefix in the output:

```bash
lspci | grep -i nvidia
```

Example output:

```
3b:00.0 VGA compatible controller: NVIDIA Corporation AD102 [GeForce RTX 4090] (rev a1)
```

The code name prefix maps to GPU architecture as follows:

| Code name prefix | Architecture | Supported |
|:---|:---|:---:|
| GB | Blackwell | ✓ |
| AD | Ada Lovelace | ✓ |
| GA | Ampere | ✓ |
| TU | Turing | ✓ |
| GP | Pascal | ✗ |
| GM | Maxwell | ✗ |

You can also verify against the [full compatible GPU list](https://github.com/NVIDIA/open-gpu-kernel-modules?tab=readme-ov-file#compatible-gpus) from the NVIDIA open driver repository.
:::
3 changes: 0 additions & 3 deletions docs/manual/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ description: Choose your path to begin using Olares for personal or team use.
---
# Get started
Welcome to Olares! This guide will help you quickly set up and start using Olares on your preferred platform.
::: tip
If you prefer to try the cloud version of Olares instead of self-hosting, refer to the [Olares Space documentation](../../space/).
:::

<div class="cta">
<a href="./create-olares-id">
Expand Down
46 changes: 8 additions & 38 deletions docs/manual/get-started/install-linux-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,10 @@ description: Learn how to deploy Olares on a Linux server using Docker Compose.
# Install Olares on Linux using Docker Compose
You can use Docker to install and run Olares in a containerized environment. This guide walks you through setting up Olares with Docker, preparing the installation environment, completing the activation process, and managing the container lifecycle.

:::tip Recommendation for production use
For best performance and stability, we recommend [installing Olares on Linux via script](/manual/get-started/install-olares.md).
:::
<!--@include: ./reusables.md{44,51}-->

## System requirements

Make sure your device meets the following requirements.

### Required specifications

- **CPU**: At least 4 cores.
Expand All @@ -25,17 +21,11 @@ Make sure your device meets the following requirements.
- Ubuntu 22.04-25.04 LTS
- Debian 12 or 13

:::info Version compatibility
While these specific versions are confirmed to work, the process may still work on other versions. Adjustments may be necessary depending on your environment. If you meet any issues with these platforms, feel free to raise an issue on [GitHub](https://github.com/beclab/Olares/issues/new).
:::
<!--@include: ./reusables.md{63,65}-->

### Optional hardware

A GPU is not required to install Olares, but is necessary for AI applications.

- **GPU (NVIDIA only)**:
- **Architecture**: Turing or newer (e.g., GTX 16 series, RTX 20 series).
- **Verification**: Run `lspci | grep -i nvidia` and check the [compatible GPU table](https://github.com/NVIDIA/open-gpu-kernel-modules?tab=readme-ov-file#compatible-gpus).
<!--@include: ./gpu-requirements.md{5,}-->

## Before you begin
Before you begin, ensure the following:
Expand Down Expand Up @@ -75,8 +65,8 @@ cd ~/olares-config
sudo dpkg -i --force-all /tmp/keyring.deb

sudo apt update
sudo apt install nvidia-kernel-open-570
sudo apt install nvidia-driver-570
sudo apt install nvidia-kernel-open-590
sudo apt install nvidia-driver-590
````

2. Install the NVIDIA Container Toolkit to enable Docker to access your GPU.
Expand Down Expand Up @@ -114,7 +104,7 @@ cd ~/olares-config

```
+-----------------------------------------------------------------------------------------+
| NVIDIA-SMI 570.169 Driver Version: 570.169 CUDA Version: 12.8 |
| NVIDIA-SMI 590.44 Driver Version: 590.44 CUDA Version: 13.1 |
|-----------------------------------------+------------------------+----------------------+
| GPU Name Persistence-M | Bus-Id Disp.A | Volatile Uncorr. ECC |
| Fan Temp Perf Pwr:Usage/Cap | Memory-Usage | GPU-Util Compute M. |
Expand Down Expand Up @@ -175,28 +165,8 @@ cd ~/olares-config

<!--@include: ./install-and-activate-olares.md-->

## Manage the Olares container
Ensure that you are in the directory containing the `docker-compose.yaml` file before proceeding with any commands.
### Stop the container
To stop the running container:
```bash
docker compose stop
```

### Restart the container
To restart the container after it has been stopped:
```bash
docker compose start
```
It may take 6 to 7 minutes for all services to fully initialize after restarting.
<!--@include: ./log-in-to-olares.md-->

### Uninstall the container
To uninstall the container:
```bash
docker compose down
```
<!--@include: ./manage-olares-container.md-->

<!--@include: ./reusables.md{38,42}-->



41 changes: 19 additions & 22 deletions docs/manual/get-started/install-linux-iso.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,43 +9,40 @@ This guide explains how to install Olares on a physical machine using the offici

<!--@include: ./reusables.md{44,51}-->

## Prerequisites

### Required
- **Host requirements**:
- **CPU**: Minimum 4 cores with **x86-64 architecture** (Intel or AMD). ARM-based processors are not currently supported for this method.
- **Memory**: At least 8 GB of available RAM.
- **Storage**: Minimum 150 GB SSD.
- **Network**: The device must be connected to a wired LAN.
::: warning SSD required
The installation will likely fail if an HDD (mechanical hard drive) is used instead of an SSD.
:::
## System requirements

- **USB flash drive**: **8 GB** capacity or larger.
### Required specifications

### Optional
- **CPU**: At least 4 cores. Intel or AMD x86-64 architecture required. ARM is not currently supported.
- **RAM**: At least 8 GB of available memory.
- **Storage**: At least 150 GB of available SSD storage.
:::warning SSD required
The installation will fail if an HDD (mechanical hard drive) is used instead of an SSD.
:::
- **Network**: Wired LAN connection required.
- **USB flash drive**: 8 GB capacity or larger.

A GPU is not required to install Olares, but is necessary for AI applications.
### Optional hardware

- **GPU (NVIDIA only)**:
- **Architecture**: Turing or newer (e.g., GTX 16 series, RTX 20 series).
- **Verification**: Run `lspci | grep -i nvidia` and check the [compatible GPU table](https://github.com/NVIDIA/open-gpu-kernel-modules?tab=readme-ov-file#compatible-gpus).
<!--@include: ./gpu-requirements.md{5,}-->

## Create a bootable USB drive

1. Click [here](https://cdn.olares.com/olares-latest-amd64.iso) to download the official Olares ISO image.
1. Download [the latest official Olares ISO image](https://cdn.olares.com/olares-latest-amd64.iso).
2. Download and install [**Balena Etcher**](https://etcher.balena.io/).
3. Insert the USB flash drive into your computer.
4. Launch Etcher and follow these steps:
![Bootable USB](/images/manual/get-started/iso-flash.png#bordered)
- **Image**: Select the Olares ISO.
- **Target disk**: Select your USB drive.
- Click **Flash** to write the installer to the USB drive.
a. **Image**: Select the Olares ISO.

b. **Target disk**: Select your USB drive.

c. Click **Flash** to write the installer to the USB drive.

## Boot from USB drive

1. Insert the bootable USB drive into the target machine.
2. Enter the **BIOS setup** and set **USB Boot** as the first boot option.
2. Enter the BIOS setup and set USB Boot as the first boot option.
3. Save and restart. The system will automatically boot into the Olares installer interface.

## Install Olares
Expand Down
12 changes: 2 additions & 10 deletions docs/manual/get-started/install-linux-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ This guide explains how to install Olares on Linux using the provided installati

## System requirements

Make sure your device meets the following requirements.

### Required specifications

- **CPU**: At least 4 cores.
Expand All @@ -23,17 +21,11 @@ Make sure your device meets the following requirements.
- Ubuntu 22.04-25.04 LTS
- Debian 12 or 13

:::info Version compatibility
While these specific versions are confirmed to work, the process may still work on other versions. Adjustments may be necessary depending on your environment. If you meet any issues with these platforms, feel free to raise an issue on [GitHub](https://github.com/beclab/Olares/issues/new).
:::
<!--@include: ./reusables.md{63,65}-->

### Optional hardware

A GPU is not required to install Olares, but is necessary for AI applications.

- **GPU (NVIDIA only)**:
- **Architecture**: Turing or newer (e.g., GTX 16 series, RTX 20 series).
- **Verification**: Run `lspci | grep -i nvidia` and check the [compatible GPU table](https://github.com/NVIDIA/open-gpu-kernel-modules?tab=readme-ov-file#compatible-gpus).
<!--@include: ./gpu-requirements.md{5,}-->

## Install Olares

Expand Down
41 changes: 19 additions & 22 deletions docs/manual/get-started/install-lxc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,35 @@ description: Instructions for installing Olares on Linux Containers (LXC) includ
# Install Olares on LXC
LXC (Linux Containers) is a lightweight virtualization method that runs applications in isolated containers. When used on PVE, it enables an efficient way to deploy Olares without the overhead of a full virtual machine.

:::warning Not recommended for production use
:::warning Not for production use
Currently, Olares on LXC has certain limitations. We recommend using it only for development or testing purposes.
:::

<!--@include: ./reusables.md{44,51}-->

## System requirements
Make sure your device meets the following requirements.

### Required specifications
- CPU: At least 4 cores
- RAM: At least 8 GB of available memory
- Storage: At least 150 GB of available SSD storage.
::: warning SSD required
The installation will likely fail if an HDD (mechanical hard drive) is used instead of an SSD.
:::
- Supported systems:
- PVE 8.2.2
- Linux container: Debian 12 (for existing LXC containers on PVE)


:::info Version compatibility
While the specific versions are confirmed to work, the process may still work on other versions. Adjustments may be necessary depending on your environment. If you meet any issues with these platforms, feel free to raise an issue on [GitHub](https://github.com/beclab/Olares/issues/new).
:::

- **CPU**: At least 4 cores.
- **RAM**: At least 8 GB of available memory.
- **Storage**: At least 200 GB of available SSD storage.
:::warning SSD required
The installation will fail if an HDD (mechanical hard drive) is used instead of an SSD.
:::
- **Supported systems**:
- PVE 8.2.2
- Linux container: Debian 12 (for existing LXC containers on PVE)

<!--@include: ./reusables.md{63,65}-->

### Optional hardware

A GPU is not required to install Olares, but is necessary for AI applications.
<!--@include: ./gpu-requirements.md{5,}-->

- GPU (NVIDIA only):
- Architecture: Turing or newer (e.g., GTX 16 series, RTX 20 series, and later).
- Verification: Run `lspci | grep -i nvidia` in the PVE host shell to confirm the card is detected.
- Setup: To utilize the GPU, you must configure LXC device passthrough. Please refer to [Configure GPU passthrough in PVE](/manual/best-practices/install-olares-gpu-passthrough.md#configure-gpu-passthrough-in-pve) for detailed instructions.
:::tip LXC device passthrough required
To use the GPU within Olares on LXC, you must configure device passthrough first. Refer to [Configure GPU passthrough in PVE](/manual/best-practices/install-olares-gpu-passthrough.md#configure-gpu-passthrough-in-pve) for instructions.
:::

## Prerequisites

Expand All @@ -58,7 +55,7 @@ To install Olares on an existing LXC container, skip to step 2 directly. Make su
To create a container, you need to assign it a unique container ID. In this guide, we use `16553`, but you can replace it with any available numeric ID. Make sure to update all commands and configurations accordingly.
:::

``` bash{2}
```bash{2}
export ROOTPASS=123456
pct create 16553 /var/lib/vz/template/cache/debian-12-standard_12.7-1_amd64.tar.zst \
--hostname olares \
Expand Down
22 changes: 8 additions & 14 deletions docs/manual/get-started/install-mac-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,10 @@ We recommend using it only for development or testing purposes.
<!--@include: ./reusables.md{44,51}-->

## System requirements
Make sure your device meets the following requirements.

- Architecture: AMD64 or ARM64
- CPU: At least 4 cores
- RAM: At least 8 GB of available memory
- Storage: At least 150 GB of available SSD storage.
::: warning SSD required
The installation will fail if an HDD (mechanical hard drive) is used instead of an SSD.
:::
::: info GPU limitation
Olares GPU acceleration currently supports NVIDIA GPUs only. Consequently, GPU resources cannot be managed or utilized for AI workloads on macOS devices.
:::

- **CPU**: At least 4 cores.
- **RAM**: At least 8 GB of available memory.
- **Storage**: At least 150 GB of available storage.

## Before you begin
Before you begin, ensure the following:
Expand All @@ -47,7 +39,7 @@ If you are unsure which chip your Mac is using, go to the Apple menu and select
<tabs>
<template #Apple-Silicon>

1. Download `olaresd-proxy` via the link: https://dc3p1870nn3cj.cloudfront.net/olaresd-proxy-v0.1.0-darwin-arm64.tar.gz .
1. Download [`olaresd-proxy`](https://dc3p1870nn3cj.cloudfront.net/olaresd-proxy-v0.1.0-darwin-arm64.tar.gz).
2. Unzip the file, then start `olaresd-proxy`.
:::info Keep `olaresd-proxy` running in the background
During Olares installation and activation, keep `olaresd-proxy` running in the background.
Expand All @@ -56,7 +48,7 @@ If you are unsure which chip your Mac is using, go to the Apple menu and select

<template #Intel>

1. Download `olaresd-proxy` via the link: https://dc3p1870nn3cj.cloudfront.net/olaresd-proxy-v0.1.0-darwin-amd64.tar.gz .
1. Download [`olaresd-proxy`](https://dc3p1870nn3cj.cloudfront.net/olaresd-proxy-v0.1.0-darwin-amd64.tar.gz).
2. Unzip the file, then start `olaresd-proxy`.
:::info Keep `olaresd-proxy` running in the background
During Olares installation and activation, keep `olaresd-proxy` running in the background.
Expand Down Expand Up @@ -101,6 +93,8 @@ The `--rm` flag automatically deletes the container after it stops. If this happ

<!--@include: ./install-and-activate-olares.md-->

<!--@include: ./log-in-to-olares.md-->

<!--@include: ./manage-olares-container.md-->

<!--@include: ./reusables.md{38,42}-->
18 changes: 6 additions & 12 deletions docs/manual/get-started/install-mac-script.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
outline: [2, 3]
description: Step-by-step instructions for installing Olares on macOS systems including prerequisites, installation commands, and activation process.
---
# Install Olares on Mac via the script
Expand All @@ -14,19 +15,12 @@ We recommend using it only for development or testing purposes.

<!--@include: ./reusables.md{44,51}-->

## System compatibility
Make sure your Mac meets the following requirements.
- Architecture: X86-64 or ARM64.
- RAM: At least 8 GB of available memory.
- Storage: At least 150 GB of available SSD storage.
::: warning SSD required
The installation will likely fail if an HDD (mechanical hard drive) is used instead of an SSD.
:::
- MacOS: Monterey (12) or later.
## System requirements

::: info GPU limitation
Olares GPU acceleration currently supports NVIDIA GPUs only. Consequently, GPU resources cannot be managed or utilized for AI workloads on macOS devices.
:::
- **CPU**: At least 4 cores.
- **RAM**: At least 8 GB of available memory.
- **Storage**: At least 150 GB of available storage.
- **macOS**: Monterey 12 or later.

## Before you begin
Ensure you have the following installed:
Expand Down
Loading