Elgato_dark/Olares
1
0
Fork 0
mirror of https://github.com/beclab/Olares synced 2026-05-24 09:18:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: improve formatting and fix minor errors

Browse source
This commit is contained in:
Meow33 2025-10-28 20:14:47 +08:00
parent 36167790df
commit e4d31241da
4 changed files with 54 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/.vitepress/en.ts
View file

@ -356,7 +356,7 @@ const side = {
link: "/manual/best-practices/install-olares-multi-node",
},
{
text: "Install Olares on PVE (GPU Passthrough)",
text: "Install Olares on PVE with GPU Passthrough",
link: "/manual/best-practices/install-olares-gpu-passthrough",
},
{

2
docs/.vitepress/zh.ts
View file

@ -358,7 +358,7 @@ const side = {
link: "/zh/manual/best-practices/set-up-SMTP-service",
},
{
text: "PVE 上安装 Olares 及配置显卡直通",
text: "在启用显卡直通的 PVE 上安装 Olares",
link: "/zh/manual/best-practices/install-olares-gpu-passthrough",
},
{

36
docs/manual/best-practices/install-olares-gpu-passthrough.md
View file

@ -7,7 +7,9 @@ description: Step-by-step tutorial on how to set up GPU passthrough in Proxmox V
GPU passthrough in **Proxmox Virtual Environment (PVE)** allows virtual machines (VMs) to directly access the physical GPU, enabling hardware-accelerated computing for workloads like AI model inference and graphics processing.
This tutorial provides a comprehensive, end-to-end process for configuring a PVE host for GPU passthrough and then installing Olares from its official ISO image into a new VM that fully leverage the dedicated GPU.
This tutorial provides a comprehensive process for:
- Configuring a PVE host for GPU passthrough.
- Installing Olares from its official ISO image into a new VM that fully leverage the dedicated GPU.
::: warning Not recommended for production use
Currently, Olares on PVE has certain limitations. We recommend using it only for development or testing purposes.
@ -26,7 +28,7 @@ Before proceeding, ensure that your setup meets the following requirements:
- 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.
## Configure GPU Passthrough in PVE
## Configure GPU passthrough in PVE
To use GPU-accelerated workloads in Olares, you must first enable GPU passthrough for the PVE host.
@ -60,7 +62,7 @@ The **Input-Output Memory Management Unit (IOMMU)** is a hardware feature that a
reboot
```
4. After restarting, check whether IOMMU is enabled (still in the PVE host):
4. After restarting, check whether IOMMU is enabled on the PVE host:
```bash
dmesg | grep -e DMAR -e IOMMU
@ -99,11 +101,11 @@ The **Input-Output Memory Management Unit (IOMMU)** is a hardware feature that a
3. Save and close the file.
### Blacklist Host GPU Drivers
### Blacklist host GPU drivers
To prevent the Proxmox host from using the GPU you plan to pass through, it's best to blacklist its default drivers. This ensures the GPU is available for `vfio-pci`.
1. Run the following command on the PVE host to create the blacklist file:
1. Run the following command on the PVE host to create the blacklist configuration:
```bash
nano /etc/modprobe.d/blacklist.conf
@ -158,7 +160,7 @@ To prevent the Proxmox host from using the GPU you plan to pass through, it's be
echo "options vfio-pci ids=10de:2803,10de:22bd" > /etc/modprobe.d/vfio.conf
```
4. Apply all module and driver changes by updating the initramfs, then reboot:
4. Apply all module and driver changes by updating the `initramfs` (the root file system), then reboot:
```bash
update-initramfs -u
@ -184,15 +186,23 @@ To prevent the Proxmox host from using the GPU you plan to pass through, it's be
## Set up VM and install Olares
With the GPU passthrough enabled, you can now install Olares in PVE.
### Create and configure the VM
This section creates and configures a VM using the Olares ISO image:
1. Upload the official Olares ISO you downloaded to your PVE storage (e.g., `local`). You can do this by selecting the storage, clicking **ISO Images**, and then *Upload**.
1. Upload the official Olares ISO you downloaded to your PVE storage (e.g., `local`).
1. In the PVE web interface, select your target storage (e.g., `local`).
2. Click **ISO Images** > **Upload**.
3. Click **Select File**, choose the Olares ISO file you downloaded, and then click **Upload**.
2. Click **Create VM**.
3. Configure the settings as follows:
3. Configure the VM settings as follows:
- OS:
- `ISO image`: Select the official Olares ISO image you just downloaded.
@ -228,13 +238,19 @@ Now your VM is ready to use GPU passthrough.
### Install Olares
Once the VM is set up, follow these steps to install the ISO on PVE.
Once the VM is set up, follow these steps to install Olares using the installer ISO image.
1. Select and start the VM you just created.
2. From the boot menu, select **Install Olares to Hard Disk** and press **Enter**.
3. In the Olares System Installer, a list of available disks will display (for example, `sda 200G QEMU HARDDISK`). Select the first disk by typing `/dev/` plus its name (for example, `/dev/sda`). When the on-screen warning appears, just type `yes` to continue.
3. In the Olares System Installer, select the installation disk.
1. Review the list of available disks (for example, `sda 200G QEMU HARDDISK`).
2. Select the first disk by typing `/dev/` plus its name (for example, `/dev/sda`).
3. When the on-screen warning appears, just type `yes` to continue.
::: tip Note
During installation, warnings related to the NVIDIA graphics driver may appear. If they do, press **Enter** to ignore them.

34
docs/zh/manual/best-practices/install-olares-gpu-passthrough.md
View file

@ -3,11 +3,15 @@ outline: [2, 3]
description: 在 Proxmox VE（PVE）中配置 GPU 直通，并在启用 GPU 加速的虚拟机中安装 Olares 的详细教程。
---
# PVE 上安装 Olares 镜像及配置显卡直通
# 在启用显卡直通的 PVE 上安装 Olares
**Proxmox 虚拟环境（PVE）** 中的 GPU 直通允许虚拟机（VM）直接访问物理 GPU ，从而启用 AI 模型推理、图形渲染等需要硬件加速的计算任务。
本教程将完整介绍如何在 PVE 主机中配置 GPU 直通，并通过官方 ISO 镜像安装 Olares ，从而在虚拟机中充分利用独立 GPU 的算力。
本教程将完整介绍如何在 PVE 主机中：
- 配置 GPU 直通；
- 通过官方 ISO 镜像安装 Olares。
这样，你可以在虚拟机中充分利用独立 GPU 的算力。
:::warning 不适用于生产环境
该部署方式当前仍有功能限制，建议仅用于开发或测试环境。
@ -60,7 +64,7 @@ description: 在 Proxmox VE（PVE）中配置 GPU 直通，并在启用 GPU 加
update-grub
reboot
```
4. 重启后，检查 IOMMU 是否已启用（仍在 PVE 主机上）：
4. 重启后，在 PVE 主机上检查 IOMMU 是否已启用：
```bash
dmesg | grep -e DMAR -e IOMMU
@ -103,7 +107,7 @@ description: 在 Proxmox VE（PVE）中配置 GPU 直通，并在启用 GPU 加
为避免 PVE 主机占用你计划直通的 GPU，建议屏蔽其默认驱动，让 GPU 专用于`vfio-pci`。
1. 在 PVE 主机上运行以下命令来创建黑名单文件：
1. 在 PVE 主机上运行以下命令来创建黑名单配置：
```bash
nano /etc/modprobe.d/blacklist.conf
@ -158,7 +162,7 @@ description: 在 Proxmox VE（PVE）中配置 GPU 直通，并在启用 GPU 加
echo "options vfio-pci ids=10de:2803,10de:22bd" > /etc/modprobe.d/vfio.conf
```
4. 更新 initramfs 以应用所有模块和驱动程序的更改，然后重启系统：
4. 更新`initramfs`（根文件系统）以应用所有模块和驱动程序的更改，然后重启系统：
```bash
update-initramfs -u
@ -184,15 +188,23 @@ description: 在 Proxmox VE（PVE）中配置 GPU 直通，并在启用 GPU 加
## 设置虚拟机并安装 Olares
启用 GPU 直通后，你现在可以在 PVE 中安装 Olares 了。
### 创建和配置虚拟机
本节为你介绍如何使用 Olares ISO 镜像来创建和配置虚拟机：
1. 将你下载的 Olares 官方 ISO 上传到你的 PVE 存储（例如，`local`）。在 PVE 界面中，选择存储 > **ISO 镜像** > **上传**。
1. 将下载的 Olares 官方 ISO 上传到你的 PVE 存储（例如，`local`）。
1. 在 PVE Web 界面中，选择目标存储（例如，`local`）。
2. 点击**ISO 镜像** > **上传**。
3. 点击**选择文件**，选择下载的 Olares ISO 文件，然后点击**上传**。
2. 点击**创建虚拟机**.
3. 配置以下参数：
3. 配置以下虚拟机参数：
- 操作系统：
- `ISO 镜像`：选择下载的 Olares 官方镜像。
@ -234,7 +246,13 @@ description: 在 Proxmox VE（PVE）中配置 GPU 直通，并在启用 GPU 加
2. 从启动菜单中，选择 **Install Olares to Hard Disk**，并按回车确认。
3. 在 Olares System Installer 界面，会显示可用磁盘列表（例如，`sda 200G QEMU HARDDISK`）。输入`/dev/`加上第一个磁盘的名称（例如，`/dev/sda`）来选择目标磁盘。当屏幕上出现警告时，输入`yes`继续即可。
3. 在 Olares System Installer 界面，选择安装磁盘。
1. 查看可用磁盘列表（例如，`sda 200G QEMU HARDDISK`）。
2. 输入`/dev/`加上第一个磁盘的名称来选择目标磁盘（例如，`/dev/sda`）。
3. 当屏幕上出现警告时，输入`yes`继续即可。
::: tip 注意
安装过程中，可能会出现与 NVIDIA 显卡驱动相关的警告。如果出现此类警告，按**回车键**忽略即可。