docs Documentation

<template #离线安装>

1. 访问 olares.com/larepass 下载扩展 ZIP 包。
2. 在浏览器地址栏输入 chrome://extensions/。
3. 打开右上角 开发者模式。
4. 点击 加载已解压的扩展程序，选择解压后的 LarePass 文件夹。
5. 登录流程：
   • 打开 LarePass 扩展，点击 导入账户。
   • 输入 Olares ID 的助记词。
   • 输入 Olares 密码完成登录。

::: tip 快速访问
安装完成后，可在 Chrome 扩展菜单中固定 LarePass，方便一键启动。
:::

Zh Manual Olares Index (`docs/zh/manual/olares/index.md`) Copy Section

Olares 系统应用文档

Olares 系统应用是 Olares 生态的核心组成部分，它们预装在你的 Olares 系统中，旨在提供一套基础且强大的工具集，帮助你高效地管理文件、应用、设置系统，管理知识、以及完成更多日常任务。理解这些系统应用的功能和价值，将使你能够充分利用 Olares 的潜力，打造一个符合你个人需求的工作和生活环境。

本文档将帮助你全面掌握 Olares 系统应用的使用方法，打造一个符合个人工作和生活需求的个人云环境。

系统应用能做什么？ Copy Chapter

探索以下指南，充分发挥 Olares 内置应用的价值：

• 导航并自定义桌面：启动应用、整理工作区并在 Olares 中全局搜索。
• 安装和管理应用：在开放、无许可的应用商店中发现、安装、更新或移除应用及推荐算法。
• 存储、同步与访问文件：在集中式存储中安全上传、下载、组织与共享文件，并实现实时同步。
• 使用 Vault 管理密码：安全存储凭据、管理数字身份并生成一次性验证码。
• 使用 Wise 收集与整理知识：从多平台收集、消费并管理内容，获取个性化推荐，构建个人信息中心。
• 使用设置配置系统：在单一界面完成用户、应用、网络、集成、安全、外观、备份等设置。
• 通过控制面板监控、管理应用：在单一控制台监控系统状态、管理应用服务并优化 Olares 环境。
• 通过仪表盘了解系统状态：以直观界面查看实时资源使用和性能指标。
• 设计专属 Olares 个人主页：定制个人主页，展示身份并与他人分享。

Developer Contribute Olares Id Verifiable Credential Overview (`docs/developer/contribute/olares-id/verifiable-credential/overview.md`) Copy Section

VC Service

The purpose of this documentation is to help you understand how to configure various schemas and create Issuers and Verifiers for your own scenarios using:

• verifiable-credential-gate and did-gate by Terminus.
• SSI Service by the tbd team.

::: tip
If you want to engage in lower-level development, read the protocol standard together with the source code in SSI SDK.
:::

Introduction Copy Chapter

We have learned about VC and the basic process for applying VCs.

Before we get into the implementation details, we can familiarize ourselves with the terms that we will encounter in the real communication process of Wallet, Verifier and Issuer.

Reference Copy Chapter

The following reference materials come from the SSI SDK project.

Specifications Copy Section

Here are a set of references to specifications that this library currently supports. It is a dynamic set that will change as the library evolves.

• Decentralized Identifiers (DIDs) v1.0 W3C Proposed Recommendation 03 August 2021
• Verifiable Credentials Data Model v1.1 W3C Recommendation 09 November 2021
  • Supports Linked Data Proof formats.
  • Supports VC-JWT and VP-JWT formats.
• Verifiable Credentials JSON Schema Specification Draft Community Group Report, 21 September 2021
• Presentation Exchange 2.0.0 Working Group Draft, March 2022
• Wallet Rendering Strawman, June 2022
• Credential Manifest Strawman, June 2022
• Status List 2021 Draft Community Group Report 04 April 2022

Signing Methods Copy Section

• Data Integrity 1.0 Draft Community Group Report
• Linked Data Cryptographic Suite Registry Draft Community Group Report 29 December 2020
• JSON Web Signature 2020 Draft Community Group Report 09 February 2022
  • VC Proof Formats Test Suite, VC Data Model with JSON Web Signatures Unofficial Draft 09 March 2022 This implementation's compliance with the JWS Test Suite can be found here.
  • Supports both JWT and Linked Data proof formats with JOSE compliance.

Developer Develop Tutorial Note Index (`docs/developer/develop/tutorial/note/index.md`) Copy Section

Create Your First Olares App

You can learn how to develop an Olares app using DevBox through this tutorial.

The tutorial shows how to make a simple Note tool. It demonstrates how to start from scratch and develop a complete Olares App.

The tutorial includes three parts:

1. Create an App
   This section provides a step-by-step guide on how to create an Olares App and set up the initial development environment.

2. Backend Development
   In this section, you'll learn how to use DevBox's IDE to develop the backend programs in Golang and provide API interfaces for the frontend.

3. Frontend Development
   In this section, you'll learn how to use DevBox's IDE to develop frontend pages, using NodeJS as an example.

Zh Developer Contribute System App Overview (`docs/zh/developer/contribute/system-app/overview.md`) Copy Section

开发 Olares 的系统应用

::: tip 前置知识：

• 用 DevBox 调试第三方应用
• 用 DevBox 开发程序
• 了解 Olares 的架构和机制
  :::

经过一年半开发，Olares 团队在开发系统应用时已经逐渐迁移到 DevBox 上。

下面我们将演示如何在 Devbox 里调试 Desktop 的前端代码。

1. 在 DevBox 中创建应用
2. 配置 deployment.yaml
3. 配置 OlaresManifest.yaml
4. 安装应用
5. 配置 nginx.conf

还有其它一些开发注意事项。

Zh Developer Develop Advanced Index (`docs/zh/developer/develop/advanced/index.md`) Copy Section

Advanced

1. Terminus Info
2. Service Provider
3. AI
4. Cookie
5. 数据库
6. 账户
7. 应用市场
8. Websocket
9. 文件上传
10. 密钥
11. Kubesphere

Zh Developer Develop Submit Index (`docs/zh/developer/develop/submit/index.md`) Copy Section

outline: [2, 3] Copy Chapter

提交应用

详细步骤 Copy Chapter

基本流程

1. 在 Olares 上测试你的应用，根据指南创建 Olares 应用 Chart。
2. Fork 官方 Olares 应用市场仓库。添加应用 Chart。创建 PR 到 beclab/apps:main。
3. 等待 GitBot 检查你的 PR。如果需要，修改 PR 直至通过。
4. PR 合并后，你的应用程序就可以启动了。

1. 创建并测试 Olares 应用 Copy Section

在提交应用程序之前，请确保它已在你的 Olares 上经过完整测试。

• 使用 DevBox 的开发容器在真实的在线环境中测试和调试你的应用。 了解有关 DevBox 的更多信息。
• 使用 Market 应用程序中的自定义安装 进行用户测试。

2. 提交应用 Copy Section

应用提交需要通过 Pull Request 完成。具体步骤如下：

• 从官方 Olares 应用市场仓库创建 fork，并在你的 fork 仓库中添加应用 Chart。

• 创建一个指向 beclab/apps:main 分支的 Draft PR。

• 请按照模板要求编辑 PR 标题和内容。

  • PR 标题必须符合以下格式：[PR 类型][文件夹名][版本]标题内容
  • PR 类型包括：
    • NEW: 提交新应用
    • UPDATE: 更新已成功合并的应用
    • REMOVE: 移除已成功合并的应用
    • SUSPEND: 暂停已成功合并的应用在应用商店的分发
  • 文件夹名是你的 Olares 应用 Chart 名称。必须符合 chart 规范中的命名要求。
  • 版本指你的应用 chart 的 Chart 版本，需要与 Chart.yaml 中的 version 字段和 OlaresManifest.yaml 元数据部分保持一致。

• 为防止你的 PR 被错误解析或关闭，请遵守以下规则：

  • PR 标题只能包含一个 PR 类型、文件夹名和版本。
  • 你的 PR 类型必须是预定义类型之一。
  • PR 只能添加或修改PR标题中声明的文件夹名下的内容。
  • 同一文件夹名同时只能存在一个 Open PR 或 Draft PR。
  • 你必须是要修改的文件夹的所有者之一。所有者列在chart中的owners文件中。如果你正在提交新应用，你的 GitHub 用户名应该包含在 owners 文件中。

• 在 Draft PR阶段，你可以持续调整 PR 内容并添加新的提交。一切就绪后，点击 Ready for review 按钮提交 PR 并调用 GitBot 进行检查。

:::info 注意
PR 的标题和内容对于 GitBot 来说至关重要。请按照模板规范填写。GitBot 可能会自动关闭任何无效的PR。
:::

3. 跟踪 PR 状态 Copy Section

• 当你的 PR 被标记为 PR 类型时，表示你的 PR 标题有效。请**不要在之后修改 PR 类型。**如果它不符合你的意图，只需关闭它并创建一个新的。

• 你可以通过状态标签跟踪PR的进度：

  • waiting to submit: 你的 PR 存在问题，需要在合并前进行进一步修改。
  • closed: 你的 PR 无效或包含无法纠正的错误。
  • waiting to merge: 一切进展顺利。你的PR已通过检查，现在正等待 GitBot 自动合并。
  • merged: 你的PR已被自动合并到beclab/apps:main中。

• 如果 GitBot 自动关闭了你的 PR，请不要重新打开它。这表示 PR 存在不可修复的问题，GitBot 不得不终止检查流程。你可以在进行必要修改后提交新的 PR。

• 当 PR 处于 waiting to submit 状态时，你可以继续提交 Commits 来修改你的 PR。提交 Commit 后，GitBot将重新检查你提交的应用 chart 文件并更新 PR 状态。

• 一旦你的 PR 通过所有检查，它将自动合并到 beclab/apps:main 中。应用将在一段时间后在Olares Market上列出。

• 如果你在提交过程中遇到任何问题，随时可以联系 Olares 团队或寻求社区帮助。

管理你的应用 Copy Chapter

你可以通过创建 Pull Request 到 beclab/apps:main 继续管理和维护你的应用。你可以升级应用、修改其可用性，或从Olares Market完全移除它。

管理应用的流程与提交类似。你创建特定类型的 Pull Request，GitBot 会处理剩余工作。Olares 使用应用 chart 根目录中的特殊控制文件来管理应用状态。这些特殊控制文件是带有特定后缀的空文件，如 .suspend 和 .remove。

:::info 注意
初次提交时不应包含 ".suspend" 或 ".remove" 文件。
:::

更新 Copy Section

当你需要更新已发布的应用时，你需要创建一个 UPDATE PR。

请注意：

• 每当你对应用chart进行更改时，如升级程序、更新元数据或更改所有者列表，请务必升级你的chart版本。
• 更新后的应用chart版本必须大于仓库中的当前版本。
• 更新的应用chart根目录中不包含 .suspend 或 .remove 文件。
• Olares 应用市场不提供版本回滚。如果你的应用存在任何问题，你需要提交新版本来修复它。
• 为避免潜在冲突，我们建议同步你的fork并将PR的提交变基到最新的main分支。

暂停 Copy Section

如果出于任何原因你想暂时禁用你的应用在Olares 应用市场的下载和安装，请提交一个SUSPEND PR。

请注意：

• 提交的应用chart版本必须与仓库中的当前版本匹配。
• 你提交的根目录应包含 .suspend 文件，且不应包含 .remove 文件。
• 一旦暂停PR通过检查并合并，应用商店将停止列出你的应用。
• 已经下载并安装应用的用户在暂停后可以继续使用它。

移除 Copy Section

如果出于任何原因你想从Olares Market移除你的应用，请提交一个 REMOVE PR。

请注意：

• 完全清空当前应用目录中的文件，并在根目录中添加一个 .remove 文件。
• 一旦移除PR通过检查并合并，应用商店将移除你的应用。
• 你将无法在未来重用相同的目录或应用chart名称。
• 已经下载并安装应用的用户在移除后可以继续使用它。

推广你的应用 Copy Chapter

通过使用组织良好的应用描述、截图和宣传图片来突出显示应用的特点和功能，可以帮助吸引Market中的新用户。截图和预览可以直观地展示用户体验，帮助你的应用脱颖而出。

要在应用详情页添加宣传图片，请在 OlaresManifest.yaml 文件的 spec 部分的 promoteImage 字段中包含这些资源的链接。

:::info Olares 应用市场的资源规范

• 应用的图标必须为 PNG 或 WEBP 格式，大小不超过 512 KB，尺寸为 256x256 像素。

• 强烈建议至少上传 2 张截图用于推广。截图必须为 JPEG、PNG 或 WEBP 格式，每张大小不超过 8MB，尺寸为1440x900像素。你最多可以上传 8 张截图。

• 如果你希望你的应用在市场中被推荐，则需要一张特色图片。在 OlaresManifest.yaml 文件的 spec 部分的 featuredImage 字段中添加此图片的链接。图片必须为 JPEG、PNG 或 WEBP 格式，大小不超过 8MB，尺寸为 1440x900 像素。
  :::

邀请他人协作 Copy Chapter

有两种方式可以邀请他人一起开发Olares应用：

1. 将其他开发者的 GitHub 用户名添加到 owners 文件中。列在owners中的每个开发者都可以独立 fork 仓库并提交他们的更改。
2. 将其他人添加为你 fork 仓库的协作者。在这种情况下，你作为代表创建 Pull Request，所有其他人可以共同提交到计划合并的分支。

Zh Developer Develop Tutorial Index (`docs/zh/developer/develop/tutorial/index.md`) Copy Section

教程

欢迎阅读 Olares 应用开发指南。这些详细的教程将逐步指导你从零开始构建 Olares 应用。

在开始前，你可以先了解一些 Olares 的基本概念，如：

• Olares 的组成
• Olares 应用 Chart
• Olares 在 Helm 上的扩展。

这些基础知识将帮助你更有效地掌握的开发流程。

你还可以先了解下 DevBox，这是 Olares 为开发人员构建 Olares 应用程序提供的内置应用程序。

如果你是 Olares 开发的新手，想直接开始编码，可以从创建首个应用开始。本教程将指导你构建一个小型笔记应用程序。

Zh Manual Olares Controlhub Index (`docs/zh/manual/olares/controlhub/index.md`) Copy Section

outline: [2, 3] Copy Chapter

通过控制面板管理 Olares

控制面板是 Olares 的控制台，为开发者和用户提供对系统操作和底层环境的精准控制。本文档将帮助你了解控制面板的界面并高效监控资源。

导航 Copy Chapter

Olares Copy Section

通过以下三种视图监控应用的状态：

• 浏览（以应用为中心）：通过三列布局导航与特定应用相关的资源使用情况，高效定位资源。
• 命名空间（以用户为中心）：访问每位用户的应用资源使用情况的详细信息，并支持排序和筛选。
• 容器组：以最细粒度监控容器（Pod）的状态和资源消耗。

资源 Copy Section

查看和管理 Kubernetes 系统资源：

• 网络：监控系统中实施的网络安全策略以及每个命名空间的网络连接性。
• CRDs：管理系统中的各种自定义资源声明。

中间件 Copy Section

查看 Olares 中各种中间件服务的使用情况。

Zh Manual Olares Files Index (`docs/zh/manual/olares/files/index.md`) Copy Section

管理文件

Olares 内置的文件应用为用户提供了安全高效的文件存储与同步解决方案，支持从任何设备或浏览器访问各种文件类型。主要优势包括：

• 随时随地访问：使用任意设备端的浏览器，从任何位置查看、下载或共享存储在 Olares 中的文件。
• 无缝同步：确保数据在所有设备间保持最新。
• 集中存储：简化信息检索与集成，无论是个人文档还是团队共享资料，均可轻松访问、管理与更新。

界面概览 Copy Chapter

文件管理器的界面类似于 Windows 资源管理器或 macOS 的访达，允许你整理和访问文档、图片、视频或其他文件。主要由以下三个部分组成：

• 存储盘（Drive）：用于存储不需要频繁同步或修改的文件。
• 同步盘（Sync）：用于在设备间同步文件和目录。
• 应用盘（Application）：存储应用与缓存数据，仅用于开发和调试目的。
• 云存储 （Cloud Drive）：用于加载、访问第三方云存储服务包括 Google Drive、Drop Box、 AWS S3、腾讯云对象存储服务（COS）。

[添加、编辑和下载文件](./add-edit-download)

[同步和共享文件](../../larepass/sync-share)

[挂载 SMB](./mount-SMB)

[挂载云存储](./mount-cloud-storage)

Zh Manual Olares Settings Index (`docs/zh/manual/olares/settings/index.md`) Copy Section

设置和管理 Olares

Olares 的设置提供了简洁直观的界面，让你轻松配置并管理 Olares。这里是个性化设置、系统安全、服务集成、应用管理等操作的中心入口。

设置包含以下功能模块：

• 安全管理：管理登录设备和系统安全设置。
• 账户管理：创建并管理 Olares 集群中的用户。
• 应用管理：监控并配置各个应用的运行状态与行为。
• 服务集成：为 Olares 连接外部服务与工具。
• 外观设置：设置系统语言与背景等外观选项。
• 网络配置：配置 FRP、VPN，并编辑 hosts 文件。
• 备份与恢复：创建并管理指定目录的备份与恢复任务。
• 系统更新：查看系统详情并执行版本更新。
• 日志导出：生成并导出系统日志，用于诊断问题。

Zh Manual Olares Vault Index (`docs/zh/manual/olares/vault/index.md`) Copy Section

密钥管理

Vault 是 Olares 中的密码管理器，旨在安全存储和管理敏感数据。通过 Vault，你可以安全地存储和组织私钥与密码、数字身份 (DIDs) 、Olares ID、一次性密码 (OTPs) 以及其他机密数据。

Vault 的关键功能包括：

• 端到端加密，确保最高安全性
• 私有和共享 Vault，满足个人与组织需求
• 跨设备的无缝同步
• 自动填充功能，轻松输入凭据
• 支持 2FA（双因素认证），管理 OTP

客户端 Copy Chapter

Vault 的服务器组件运行在 Olares 上，同步单个用户的多个客户端设备。数据在传输和存储过程中使用私钥加密，确保安全性。
你可以通过 Olares 使用 Vault，也可以通过移动设备、桌面和浏览器扩展的 LarePass 客户端访问，实现跨平台一致的用户体验。

访问 LarePass 页面 获取 LarePass 的详细信息和下载选项。

[Vault 基本操作](./vault-items)

[共享 Vault 项目](./share-vault-items)

[设置双因素认证代码](./two-factor-verification)

[使用 LarePass 的自动填充功能](./autofill)

Zh Manual Olares Wise Index (`docs/zh/manual/olares/wise/index.md`) Copy Section

使用 Wise 一站式聚合、管理内容

Wise 是一款以本地优先和 AI 驱动的现代阅读器，是 Olares 生态系统中的核心应用之一。它帮助你从各种平台收集、阅读和管理信息，从而创建并维护个人信息中心。

关键功能包括：

• 自托管推荐算法：你可以运行个性化算法过滤和排序在线内容，打破信息茧房，接收多样化和个性化的内容推荐。
• 跨平台内容聚合：Wise 集成文章、视频、音频及其他多媒体内容，为你提供全面的阅读体验。
• 无缝书签功能：通过 LarePass 浏览器扩展，你可以一键将网页保存到 Olares，随时访问和管理内容。

[Wise 基础知识](./wise-basics)

[发现主题内容](./recommend)

[订阅和管理订阅源](./subscribe)

[添加过滤视图](./filter)

Zh Developer Contribute Olares Id Verifiable Credential Overview (`docs/zh/developer/contribute/olares-id/verifiable-credential/overview.md`) Copy Section

VC 服务

本文档旨在帮助你了解如何使用以下工具，为你自己的场景配置各种 schema 并创建发行方 (Issuers) 和验证方 (Verifiers)：

• Olares 的 verifiable-credential-gate 和 did-gate
• tbd 团队的 SSI Service

::: tip
如果你想进行更底层的开发，请结合 SSI SDK 中的源代码阅读协议标准。
:::

简介 Copy Chapter

我们已经了解了 VC 的概念以及申请 VC 的基本流程。

在深入实现细节之前，我们可以先熟悉一下在钱包 (Wallet)、验证方 (Verifier) 和发行方 (Issuer) 的实际通信过程中会遇到的术语。

参考资料 Copy Chapter

以下参考资料来自 SSI SDK 项目。

规范 Copy Section

以下是本库目前支持的一系列规范参考。这是一个动态集合，会随着库的演进而变化。

• 去中心化标识符 (DIDs) v1.0 W3C 建议提案 2021年8月3日
• 可验证凭证数据模型 v1.1 W3C 推荐标准 2021年11月9日
  • 支持 链接数据证明 (Linked Data Proof) 格式。
  • 支持 VC-JWT 和 VP-JWT 格式。
• 可验证凭证 JSON Schema 规范 社区组报告草案 2021年9月21日
• 呈现交换 (Presentation Exchange) 2.0.0 工作组草案 2022年3月
• 钱包渲染草案 (Wallet Rendering Strawman) 2022年6月
• 凭证清单 (Credential Manifest) 草案 2022年6月
• 状态列表 (Status List) 2021 社区组报告草案 2022年4月4日

签名方法 Copy Section

• 数据完整性 (Data Integrity) 1.0 社区组报告草案
• 链接数据加密套件注册表 (Linked Data Cryptographic Suite Registry) 社区组报告草案 2020年12月29日
• JSON Web 签名 (JSON Web Signature) 2020 社区组报告草案 2022年2月9日
  • VC 证明格式测试套件，使用 JSON Web 签名的 VC 数据模型 非官方草案 2022年3月9日 本实现对 JWS 测试套件的合规性可以在此处找到。
  • 支持 JWT 和链接数据证明两种格式，并符合 JOSE 规范。

Zh Developer Develop Tutorial Note Index (`docs/zh/developer/develop/tutorial/note/index.md`) Copy Section

创建你的首个 Olares 应用

你可以通过本教程学习如何使用 DevBox 开发一个 Olares 应用。

整个教程以开发一个简单的 Note 工具为例。展示如何从创建应用开始，开发一个完整的 Olares 应用。

整个教程分为以下3个部分：

1. 创建应用
   展示如何创建一个 Olares 应用，并逐步配置这个应用的初始化开发环境。

2. 开发后端
   学习如何利用 DevBox 的 IDE 完成后端 Golang 程序的开发，并为前端提供 API 接口。

3. 开发前端
   以 NodeJS 为例，学习如何在 DevBox 的提供的 IDE 中开始前端页面的相关开发。

Manual Docs Home (`docs/manual/docs-home.md`) Copy Section

Olares documentation

What is Olares? Copy Chapter

Olares is an open-source personal cloud operating system designed to empower you to own and manage your digital assets locally. Instead of relying on public cloud services, you can deploy powerful open-source alternatives locally on Olares, such as Ollama for hosting LLMs, SD WebUI for image generation, and Mastodon for building censor free social space. Imagine the power of the cloud, but with you in complete command.

With Olares, self-hosting is no longer a daunting task. It simplifies complex processes like network setup, domain management, and service orchestration, enabling both beginners or experienced users to focus on what truly matters.

Privacy and independence are at the core of Olares. It is perfect for individuals or teams who want to avoid relying on centralized platforms. Your data stays on your hardware, and all tasks are processed locally, so your sensitive information never leaves your control. Olares gives you complete ownership of your data and infrastructure without sacrificing performance or simplicity.

<h3>New to Olares?</h3>
  Check out the get-started guide to set up Olares on your local machine

→

Highlighted features Copy Chapter

Olares offers a wide array of features designed to enhance security, ease of use, and development flexibility:

• Enterprise-grade security: Secure your self-hosted cloud with simplified network configuration using Tailscale, Headscale, Cloudflare Tunnel, and FRP.
• Secure and permissionless application ecosystem: Access nearly 100 free applications in a secure, sandboxed environment. See what Olares Market has to offer.
• Unified file system and database: Support automated scaling, backups, and high availability.
• Single sign-on: Log in once to access all applications within Olares with a shared authentication service.
• AI capabilities: Manage GPU resources, host AI models locally, and build private knowledge bases with complete privacy.
• Built-in applications: Get started with essential pre-installed applications such as Files, Vault, Wise, Profile and Dashboard.
• Seamless anywhere access: Access your devices from anywhere using dedicated clients for mobile, desktop, and browsers.
• Development tools: Build and port applications easily with comprehensive development tools.

Key use cases Copy Chapter

• 🖥️ Homelab server: Turn your personal devices into a versatile homelab for experimenting with containerized applications, running local AI models, managing self-hosted services, or testing cloud technologies—all within your own private infrastructure.

• 🤖 Local AI: Host and run cutting-edge open-source AI models—including large language models, image generation, and speech recognition—directly on your devices. Build custom AI assistants that integrate with your data and applications while keeping everything private and secure.

• 💻 Personal data repository: Securely store, sync, and manage your photos, documents, and important files in a unified, private storage system accessible from anywhere.

• 🛠️ Self-hosted workspace: Create a free, collaborative workspace for your team or family with open-source alternatives to commercial productivity tools.

• 🎥 Private media server: Turn your personal media collection into your own streaming service, hosted entirely on your devices.

• 🏡 Smart home: Use Olares as the central control point for managing IoT devices and home automation.

• 🤝 Decentralized social media: Host decentralized social media platforms like Mastodon, Ghost, or WordPress to build your personal brand without the risks of bans or platform fees.

Pick your path Copy Chapter

Before you roll up your sleeves and get your hands dirty with Olares, feel free to take a quick tour. Here are some alternative paths to get a feel for what Olares can do.

Other resources Copy Chapter

• Develop Olares apps
• Join our community on Discord
• Check out Olares blogs

Manual Glossary (`docs/manual/glossary.md`) Copy Section

Glossary

C
|
D
|
F
|
T
|
V

C Copy Chapter

CNAME Record Copy Section

A CNAME (Canonical Name) record is a type of DNS (Domain Name System) record that maps your custom domain name to an Olares-provided address, enabling domain-to-application mapping.

D Copy Chapter

DID Copy Section

A Decentralized Identifier (DID) is a unique digital identification method that enables any person or entity to have a persistent, unique identity on the network. This identifier is fully independent and doesn't require verification or registration through a central authority. A DID is a unique string that starts with "did" and follows specific formatting and naming conventions.

F Copy Chapter

FRP Copy Section

Fast Reverse Proxy (FRP) is a high-performance reverse proxy application designed for internal network penetration scenarios. It enables servers behind NAT or firewalls to provide services externally, even without public IP addresses. FRP helps users easily expose internal services to the public network.

T Copy Chapter

TOTP Copy Section

Time-Based One-Time Password (TOTP) is a time-based algorithm for generating one-time passwords, widely used in two-factor authentication (2FA). It generates single-use passwords using a shared key and current time to enhance account security. Each password is valid for a brief period (typically 30 or 60 seconds) before a new one is generated.

V Copy Chapter

VC Copy Section

Verifiable Credential (VC) is a digital format proof that verifies certain attributes or qualifications of its holder without revealing additional personal information. It involves three primary roles:

• Holder: The individual who possesses and uses the credential to prove certain information
• Issuer: The authority or entity that creates and issues verifiable credentials
• Verifier: The individual or organization that needs to verify the authenticity of the holder's information by validating the credential

Manual Olares Vs Nas (`docs/manual/olares-vs-nas.md`) Copy Section

outline: [2, 3] Copy Chapter

Compare Olares and NAS

Olares is dedicated to creating a one-stop personal cloud experience. Its core functionalities and user positioning are significantly different from traditional Network Attached System (NAS).

This document provides a detailed comparison between Olares and general NAS systems. We will highlight key differences in storage solutions, application ecosystem, virtual machine support, network configuration, and AI capabilities, using Unraid and Synology DSM as reference points.

Overview Copy Chapter

Project information Copy Chapter

Storage features Copy Chapter

Application management Copy Chapter

Virtual machine management Copy Chapter

Network access Copy Chapter

AI capabilities Copy Chapter

Manual System Architecture (`docs/manual/system-architecture.md`) Copy Section

outline: [2, 3] Copy Chapter

Olares architecture

This document provides a comprehensive explanation of the Olares architecture, outlining the purpose and functionality of each layer and its components.

Infrastructure Copy Chapter

The infrastructure layer provides essential infrastructure services such as container orchestration, storage, networking, and cluster management.

Container orchestration Copy Section

Olares supports different Kubernetes distributions depending on the underlying environment:

• Linux environments (including WSL, PVE, LXC, Raspberry Pi): Users can choose to install Kubernetes or the lightweight K3s, with K3s being the default for its better performance and resource efficiency on local hardware.
• macOS: minikube is used to deploy Kubernetes within a Linux virtual machine, ensuring a unified experience across platforms.

Regardless of the chosen Kubernetes distribution, users get consistent core capabilities and experience with Olares.

Networking Copy Section

The networking stack ensures seamless communication between containers, nodes, and services. Key components include:

• CoreDNS: Provides DNS services for the cluster, ensuring efficient name resolution.
• Calico: A container networking interface (CNI) that facilitates communication between containers and virtual machines while offering advanced network policy controls.
• Envoy: A high-performance, extensible edge and service proxy. Envoy acts as middleware for communication between services, handling load balancing, service discovery, secure communication, and observability. It can operate as a standalone reverse proxy or an API gateway and is often used as a data plane component in service meshes.

These components collectively ensure robust, scalable, and secure networking within Olares.

Distributed storage Copy Section

Olares provides flexibility in storage solutions tailored to both single-node and multi-node setups:

• Local storage (default): Ideal for single-node deployments, offering the best read/write performance.
• S3: A cloud-based storage option. Ideal for cloud deployment via S3 or any S3-compatible service.
• MinIO: A distributed storage solution for self-hosted deployment. Users can either set up a MinIO cluster through Olares or mount an existing one.

This approach ensures that applications have access to the necessary storage mechanisms, whether it's for local or distributed environments.

Distributed key-value storage Copy Section

Olares uses etcd as its distributed key-value store. etcd is integral for storing and managing all cluster data for Kubernetes.

GPU management Copy Section

Olares leverages components like CUDA driver, NVIDIA device plugin, and nvShare, which work in conjunction to manage and provision GPU resources effectively:

• CUDA: Acts as the core interface between the GPU hardware and the operating system.
• NVIDIA device plugin: Allows GPU resources to be advertised, scheduled, and allocated to containers or pods.
• nvshare: Allows multiple containers or pods to share a single GPU, enabling both shared and exclusive GPU usage in Olares for better GPU utilization.

:::info
Currently, Olares GPU support is restricted to deployments with one GPU per node.
:::
Starting with Olares v1.11, CUDA (12.4 and above) is supported. Changes in the host environment's CUDA configuration can be synchronized with the Olares cluster using olares-cli.

Container management Copy Section

Olares uses containerd, a lightweight container runtime, for containerized deployments.

Olares Controller Panel Copy Section

The management of Olares is implemented through the following:

• olares-cli: A command-line tool for managing Olares clusters, applications, and hardware nodes.
• olaresd: A daemon process that monitors hardware and network changes, while also managing cluster upgrades, restarts, and other maintenance operations.

These tools streamline installation, maintenance, and scaling for Olares.

Platform Copy Chapter

The platform layer services run in containers with middlewares such as databases, messaging system, file system, workflow orchestration, secret management, and observability.

Relational database Copy Section

Olares uses PostgreSQL 16 as its primary relational database. All applications share a single PostgreSQL instance, with each having dedicated accounts for isolation. PostgreSQL also serves as a full-text search engine and vector database.

For multi-nodes, Citus is used, though its production readiness is still under evaluation.

In the future, PostgreSQL is expected to migrate to the infrastructure layer for better resource management.

Key-value cache Copy Section

Olares integrates KVRocks, a Redis-compatible persistent key-value store built on RocksDB. KVRocks balances memory and disk storage, making it more resource-efficient than Redis clusters, though slightly slower in performance.

Message queue Copy Section

Olares integrates NATS, a lightweight and high-performance message-oriented middleware, as the messaging system. NATS ensures low resource consumption while delivering reliable message queues.

Distributed file system Copy Section

Olares employs JuiceFS, a cloud-native distributed file system, to provide POSIX-compatible interfaces for applications. When S3 or MinIO is used as the storage backend, JuiceFS ensures seamless file access across nodes.

Workflow management Copy Section

Olares uses Argo Workflows for workflow orchestration. This Kubernetes-native tool automates complex tasks, such as those required by Olares' distributed recommendation engine. Currently, this functionality is not available to third-party applications.

Secret management Copy Section

Two secret management solutions are integrated into Olares:

• Vault: Protects sensitive data like accounts, passwords, and mnemonics. It encrypts secrets, ensuring that even if the server is compromised, the data remains secure. Vault is developed by the Olares team based on Padloc.
• Infisical: A tool for managing sensitive information and preventing secret leaks in Olares development.

Observability Copy Section

Olares provides observability through the following:

• Prometheus: Used for system monitoring and resource usage tracking. It collects resource metrics for applications like Dashboard and Market.
• OpenTelemetry*: Enables tracing of request workflows within the Olares system using eBPF-based monitoring. (In development)

Other middlewares Copy Section

The Olares application store includes common middleware such as Grafana for visualization, MongoDB for document storage, and Chaos Mesh for chaos testing.

Application framework Copy Chapter

The application framework layer provides common functionality and interfaces for system and third-party applications.

Authentication and authorization Copy Section

Olares uses LLDAP to manage user accounts and provide LDAP (Lightweight Directory Access Protocol) services for applications.

Additionally, Authelia adds authentication and authorization support, including multi-factor authentication and single sign-on (SSO).

Application governance Copy Section

Components for application governance include:

• app-service: Handles application lifecycle management and resource allocation.
• system-server: Manages permissions for inter-application API calls and handles network routing between applications and database middlewares.
• image-server: Works with app-service to manage container images required by Olares applications.
• bfl: The Backend For Launcher service that aggregates backend interfaces and proxies requests for all system services, including user-isolated system and cluster information.

Network connectivity Copy Section

Olares supports secure and flexible network connectivity through:

• Reverse proxy: Options include Cloudflare Tunnel, Olares Tunnel, and self-built FRP.
• Tailscale: Enables users to securely access the system from anywhere.
• Headscale: A self-hosted implementation of the Tailscale control server.

File service Copy Section

Components for file service include:

• File server: Provides essential file management services.
• Seafile: An open-source alternative to Dropbox for file synchronization. Olares deeply integrates Seafile, enabling users to synchronize files across multiple devices into a centralized repository.
• Drive server: Provides integration with external storage services like Google Drive, Dropbox and S3.
• Media server: Streams video files using ffmpeg.

Knowledge service Copy Section

Components for knowledge service include:

• Knowledge: Stores content such as web pages, videos, audio files, PDFs, and EPUBs that users collect via the browser extension or share from their mobile phones using LarePass. This repository is also utilized by the decentralized recommendation engine to store its results.
• Download: Uses aria2 and youtube-dlp to download files, magnet links, and online videos.
• Search: Provides full-text search for stored content in Knowledge and Files.
• RSSHub: Generates RSS feeds for easier content subscription.

AI service Copy Section

Olares empowers AI capabilities with:

• Model serving*: Hosts AI models for applications. (In development)
• RAG interface*: Provides Retrieval-Augmented Generation (RAG) services for files, articles, images, and videos. (In development)
• Agent & workflow orchestration*: Manages agents and tool workflows. (In development)

System service Copy Section

System services include:

• Notification: Delivers system-wide notifications.
• Backup*: Supports backups for directories, applications, and clusters. (In development)
• Upgrade*: Supports automated system upgrades. (In development)

System applications Copy Chapter

System applications offer tools for managing files, knowledge, passwords, and the system itself. These applications are pre-installed.

Users can install additional applications via the Market app.

Files Copy Section

A file management app that manages and synchronizes files across devices and sources, enabling seamless sharing and access.

Wise Copy Section

A local-first and AI-native modern reader that helps to collect, read, and manage information from various platforms. Users can run self-hosted recommendation algorithms to filter and sort online content.

Vault Copy Section

A secure password manager for storing and mangaging sensitive information across devices.

Market Copy Section

A decentralized and permissionless app store for installing, uninstalling, and updating applications and recommendation algorithms.

Desktop Copy Section

A hub for managing and interacting with installed applications. File and application searching are also supported.

Profile Copy Section

An app to customize the user's profile page.

Settings Copy Section

A system configuration application.

Dashboard Copy Section

An app for monitoring system resource usage.

Control Hub Copy Section

The console for Olares, providing precise and autonomous control over the system and its environment.

DevBox Copy Section

A development tool for building and deploying Olares applications.

Learn more Copy Chapter

• To get started with Olares, see the Getting Started guide.
• To learn more about the internals of Olares, see the topics in Concept.
• For in-depth details about how each component of Olares is orchestrated, see Olares installation overview.

Manual What Is Olares (`docs/manual/what-is-olares.md`) Copy Section

What is Olares

Olares is the sovereign cloud that puts you in control. It's an open-source, self-hosted alternative to public clouds like AWS, built to reclaim your data ownership and privacy. By combining the power of Kubernetes with a streamlined interface, Olares enables you to take full control of your data and computing resources. Whether you're managing a homelab, hosting applications, or safeguarding your privacy, Olares delivers the flexibility and capabilities of public clouds, without compromising privacy or security.

What can you do with Olares Copy Chapter

Typical use cases of Olares include:

• 🖥️ Homelab server: Turn your personal devices into a versatile homelab for experimenting with containerized applications, running local AI models, managing self-hosted services, or testing cloud technologies—all within your own private infrastructure.
• 🤖 Local AI: Host and run cutting-edge open-source AI models—including large language models, image generation, and speech recognition—directly on your devices. Build custom AI assistants that integrate with your data and applications while keeping everything private and secure.
• 💻 Personal data repository: Securely store, sync, and manage your photos, documents, and important files in a unified, private storage system accessible from anywhere.
• 🛠️ Self-hosted workspace: Create a free, collaborative workspace for your team or family with open-source alternatives to commercial productivity tools.
• 🎥 Private media server: Turn your personal media collection into your own streaming service, hosted entirely on your devices.
• 🏡 Smart home: Use Olares as the central control point for managing IoT devices and home automation.
• 🤝 Decentralized social media: Host decentralized social media platforms like Mastodon, Ghost, or WordPress to build your personal brand without the risks of bans or platform fees.

Manual Why Olares (`docs/manual/why-olares.md`) Copy Section

Why Olares

Here are some typical use scenarios for Olares.

🤖 Edge AI:

Run cutting-edge open AI models locally, including large language models, computer vision, and speech recognition. Create private AI services tailored to your data for enhanced functionality and privacy.

📊 Personal data repository:

Securely store, sync, and manage your important files, photos, and documents across devices and locations.

🚀 Self-hosted workspace:

Build a free collaborative workspace for your team using secure, open-source SaaS alternatives.

🎥 Private media server:

Host your own streaming services with your personal media collections.

🏡 Smart home

Create a central control point for your IoT devices and home automation.

🤝 Decentralized social media

Easily install decentralized social media apps such as Mastodon, Ghost, and WordPress on Olares, allowing you to build a personal brand without the risk of being banned or paying platform commissions.

📚 Learning platform

Explore self-hosting, container orchestration, and cloud technologies hands-on.

Space Backup Restore (`docs/space/backup-restore.md`) Copy Section

Back up and restore

Olares Space is the official solution to back up snapshots for your Olares instances. You can restore an Olares to its most recent state whenever needed. This section provides instructions for managing backups and restores in Olares Space.

:::tip
Each Olares is provided with 10 GB of free backup space. Any usage beyond this will be charged according to the cloud provider's pricing.
:::

View backup list Copy Chapter

The backup task list shows information for each backup task, including:

• Initial creation time
• Most recent snapshot time
• Overall storage usage

Click View Details on a task to see its detail page. The detail page shows the storage usage since the task was created and a list of all successful snapshots.

:::info NOTE
Currently, only restoring from the most recent snapshot is supported.
:::

Restore backup to the Olares Space Copy Chapter

Restoring a snapshot to the cloud is similar to setting up a new cloud-based Olares.

1. Set up relevant details.

   a. Select the cloud service provider and their data center location.

   b. Choose the hardware configuration for the instance.

   c. Confirm the snapshot details and enter the backup password.

2. Understand charges for storage and bandwidth. Each instance includes a certain amount of free storage and traffic. Any usage exceeding these quotas will incur charges.

3. Confirm the order and complete the payment. After that, the Olares begins to install.

:::info NOTE
During the installation process, Olares will verify the backup password. If it is incorrect, you'll be asked to re-enter the correct one. If you forget the backup password, the restoration process won't be able to continue. In this case, please return your instance and try restoring again.
:::

:::info NOTE
To avoid conflicts or other unforeseeable problem, you must return the existing Olares that uses the same name before restoring to a cloud-based Olares.
:::

Space Billing (`docs/space/billing.md`) Copy Section

Billing

Olares partners with Stripe for secure payment processing. Your invoices and receipts will be sent via email, allowing you to keep records for analysis. If you have any questions during the payment process, please contact support.

The scope of billing Copy Chapter

The following services or products are billed:

• Hosted Olares: Prepaid product required for setting up an Olares on a cloud provider like AWS or GCS. Pricing varies depends on the provider you choose.
• Host instance traffic: Postpaid charges for external traffic generated by cloud hosting out of assigned regions.
• Worker instance: Adding a Worker node to a hosted Olares also incurs monthly charges. Charges will be combined to the monthly bill.
• Cloud storage: Postpaid product storing system data via JuiceFS. Billed based on usage at the end of the billing cycle.
• Cloud backup/restore: Backs up host data to public storage. Billed based on usage at the end of the billing cycle.
• Cloudflare tunnel (FRP) traffic: Postpaid for traffic incurred by self-hosted Olares when services are accessed via public links.
• GPU unit: Prepaid for GPU-related services. Charges are deducted from prepaid units based on usage.

Bill generation and payment scenarios Copy Section

The following actions generate bills:

• Creating an Olares in the cloud: An invoice is generated immediately after you select a cloud provider and configuration. Payment is required for installation to begin.
• Adding/Removing workers: Bills are generated for adding workers based on the remaining time in the billing period. Similarly, refunds are calculated when removing workers.
• Restoring a snapshot: Equivalent to creating a new Olares, with monthly charges applied.
• Destroying an Olares: Fees are settled up to the destruction date. Refunds are processed as applicable.

The monthly bill updated once per month. It includes the base subscription fees as well as any additional charges incurred during the month, such as adding a Worker, or extra traffic and storage fees.

How fees are deducted monthly Copy Chapter

Olares operates on a monthly billing cycle:

• Automatic deduction: Your first payment will authorize automatic deductions, with the first payment method set as default. You can disable auto-deductions from the control panel if you prefer to pay manually, but make sure to settle your bills on time to avoid service interruption.
• Payment validity period: For each purchase, you'll receive a bill valid for 24 hours.

Use promotional credits or coupons Copy Chapter

We distribute trial credits or coupons through promotions.

• Once you have received trial credits, you can view them in Billing > Balance History, and apply directly to specific products when you pay.
• Once you receive a promotional coupon codes, you can redeem them in Billing > Coupons. It could be a discount to your plans, plan subscriptions, Olares memberships, and more.

::: tip NOTE
Trial credits or coupons are non-refundable. If you request a refund, the system will only refund your actual payment.
:::

FAQs Copy Chapter

Will I be charged if someone accesses the WordPress site deployed on Olares? Copy Section

Yes, charges will occur from both Cloudflare for the traffic going through Cloudflare FRP tunnel. It mainly helps to hide the real IP of Olares and provides security protection against Distributed Denial of Service (DDoS) and other threats. If you host Olares on the cloud, traffic fee from your chosen vendor will apply.

What happens if my bill is less than $1? Copy Section

If your total bill is under $1, it won't trigger a card charge. Instead, this amount will be added to your balance and rolled into the next bill.

How do I resolve a negative balance? Copy Section

A negative balance doesn't always mean you owe money. If you have a negative balance, check the Billing > Balance section for details. Pay any outstanding amounts to avoid service interruptions.

Space Create Olares (`docs/space/create-olares.md`) Copy Section

outline: [2, 3] Copy Chapter

Create a cloud-based Olares

Cloud-based Olares offer a convenient deployment option, enabling you to set up an Olares environment without managing hardware directly.
This section provides a step-by-step guide to creating and managing your cloud-based Olares.

::: tip NOTE

• The Host Service is currently in an invite-only beta phase. To access the cloud-based Olares, contact us for an invitation.
• If you are looking for information about setting up a self-hosted Olares, refer to the Getting Started Guide.
  :::

Prerequisites Copy Chapter

Ensure you get an Olares ID to log in to Olares Space and activate the Olares instance.

Create an Olares Copy Chapter

1. Log in to Olares Space by scanning the QR code using LarePass.

2. Navigate to the Cluster page and select the second option to start creating.

3. Configure the environment for installation as below:

   • Select Cloud Provider: Choose a cloud service provider and the data center location closest to your users or workloads.
   • Hardware Configuration: Select the instance's CPU, RAM, and storage resources.
   • Olares Version & Kubernetes Setup: Choose the appropriate version of Olares and the Kubernetes/K3S solution to be installed.

   :::tip
   If you intend to host large language models (LLMs), select the Alibaba Cloud Hong Kong region. Currently, it is the only region that offers instances with shared GPU services.
   :::

4. Review the fees for storage and traffic.

   ::: tip NOTE
   Each instance comes with a set amount of free storage and bandwidth. If your usage exceeds these quotas, additional fees will apply based on your cloud provider's pricing.
   :::

5. Review your order details, including instance configuration, selected options, and fees.

6. Complete the payment to initiate the installation process.

Monitor installation Copy Chapter

The creation and installation of your cloud-based Olares typically take around 10 minutes. During this time, you can monitor the progress and logs in real-time.

System statuses Copy Section

The installation follows several key stages, represented by different statuses:

Real-time logs Copy Section

Click Log to view detailed logs and monitor the installation process in real time.

Activate Olares Copy Chapter

When the installation enters the Pending Activation state, activate Olares:

1. Click Activation. A pop-up window will display Olares ID, one-time password, and a wizard URL.

2. Access the wizard URL in your browser, and use the one-time password to log into Olares for the first time.

3. Change the Olares password via LarePass when prompted.

4. Follow the on-screen instructions to finish the rest of activation process.

Space Host Domain (`docs/space/host-domain.md`) Copy Section

outline: [2, 3] Copy Chapter

Set up a custom domain

Whether you're an organizational user wanting employees to use a company-specific domain for login, or you simply wish to use a domain that you own, Olares Space allows you to set up a custom domain for easy access.

This guide walks you through adding your own domain for your Olares system on Olares Space.

Prerequisites Copy Chapter

::: tip NOTE
A new domain can only be bound if the account is in the DID stage. If the account has already been bound with an Olares ID, it means that the account is already associated with a Domain.
:::

Before creating and configuring your own domain, make sure that:

• DID account status: Ensure your account is in DID status (i.e., not yet bound to an Olares ID).

• Domain Name: Ensure you have a domain name registered through a domain registrar. The domain should not already be bound to another account in Olares Space.

• LarePass app: Make sure the LarePass app is installed on your phone, as it is required for Verifiable Credential and domain management tasks.

• Access to the DNS settings of your domain: This is for configuring the TXT record and NS record.

Add your domain Copy Chapter

When you have everything ready, take the steps below to add your domain in Olares Space.

1. In the Olares Space console, navigate to Domain > Domain Name Setup, and enter your custom domain as instructed.

2. Add a TXT record for your domain to confirm your domain ownership. The system will verify your configuration. Once verified, the domain setup status will update automatically to Await NS Record for Your Domain.

3. Add NS records to allow Olares Space to configure DNS for your domain.

   The system will verify your configuration. Once verified, the domain status will update to Awaiting the application for the domain's Verifiable Credential.

4. Launch your LarePass app, and navigate to Organization Olares ID > Create an Organization. You should see your domain listed.

5. Click on the domain name to store the domain name on blockchain. When it's done, the domain setup status should change to Awaiting rule configuration on Olares Space.

So far you have successfully associated your domain with your DID. You can now continue to set the email invitation rule and create an organization Olares ID using the domain.

Create an Org Olares ID Copy Chapter

Now that your organization has a verified domain name, you or other members you invite can create an Olares ID using this domain.

1. In the LarePass app, navigate to Organization Olares ID > Join an existing organization.
2. Enter your organization's domain name and click Continue. Recheck whether your domain name has been verified and configured if an error occurs.
3. Bind the VC via your email accounts. Currently, only Gmail and Google Workspace email are supported.

Upon completion, you will receive an Organization Olares ID. Now you can go ahead to Activate Olares.

Domain status and processing Copy Chapter

After submitting a domain name, several steps are necessary to validate the entered domain.

The table below explains different domain statuses and the corresponding actions required:

Space Manage Accounts (`docs/space/manage-accounts.md`) Copy Section

Manage accounts in Olares Space

This guide walks you through common account operations with Olares Space, including logging in, managing multiple accounts, and logging out.

Log in to Olares Space Copy Chapter

Olares Space uses a decentralized ID (DID) or Olares ID for authentication. Make sure you already have obtained your credentials on your LarePass.

1. In the LarePass app, select the DID or Olares ID you wish to use to log in.
2. Open https://space.olares.com/ in your browser.
3. Scan the QR code using LarePass.

::: tip NOTE
The features and services available on Olares Space vary depending on whether you use a DID or Olares ID for login.

• Logging in with a DID allows you to set your own domain since no domain is associated to the account. However, you must bind the DID to an Olares ID before you can activate an Olares device.
• Logging in with an Olares ID enables you to create an Olares, provided the name isn't already linked to another Olares device. However, you cannot use your custom domain since your Olares ID already corresponds to a unique domain.
  :::

Log out Copy Chapter

To log out of your account:

1. Click your avatar in the top-right corner.
2. Select Log Out.

Alternatively, you can:

1. Choose Switch Account from the menu.
2. Click logout next to any listed account.

Manage multiple accounts Copy Chapter

Each Olares ID is linked to only one Olares. With multi-account management in Olares Space, you can switch between accounts effortlessly — perfect for managing multiple Olares IDs and instances.

To add an account:

1. Click your avatar in the top-right corner.
2. In the pop-up menu, select Import Account.
3. Launch LarePass, and scan the QR code to log in.

Once you've added multiple accounts, switch between them using the Switch Account option in the menu. If the account is logged out, you'll be redirected to the QR code login page.

Space Manage Domain (`docs/space/manage-domain.md`) Copy Section

outline: [2, 3] Copy Chapter

Manage your domain

You must add a domain before managing it. Once your domain is set up, you can configure email invitation rules for organization members and invite them to create their own organizational Olares ID via email.

Set email invitation rules Copy Chapter

Most companies use a standard domain suffix for their team members' emails, like [email protected] for person A or [email protected] for person B. However, sometimes, team members might use emails in different domains. To accommodate these scenarios, Olares provides two types of rules for adding organization members' emails:

• Fixed email suffix: Use this option when all team members share the same email domain. Enter your organization's domain suffix (example: @company.com). Any email matching this suffix can be associated with your organization's Olares ID.

• Specified email address: Use this option if your organization doesn't have a corporate email suffix. You need to manually add the email address for each member of the organization.

:::info NOTE

• Currently, only Gmail is supported for both rule types.
• Emails that have been used to create organizational Olares IDs will appear in the member list and cannot be deleted.
• Emails that are manually added and have not been used to create the Olares ID appear as "unbound" and can be removed.
  :::

Manage members Copy Chapter

After setting email rules, you can add or remove members under your organization.

Add a member Copy Section

To add a member:

1. On the domain management page, add members to the organization by entering their email address.
2. Notify the corresponding users to use their email addresses to create an organizational Olares ID.

Remove a member Copy Section

You can remove email addresses that haven't been used to create an Olares ID. Once an email address is associated with an organization's Olares ID, it cannot be removed.

Space Manage Olares (`docs/space/manage-olares.md`) Copy Section

outline: [2, 3] Copy Chapter

Manage Olares

This page covers Olares management tasks in Olares Space, including monitoring system data, adding worker nodes, and managing cloud services.

View system status Copy Chapter

You can monitor the system status of Olares through Olares Space:

1. In your LarePass app, go to Settings > Integration.
2. Click add in the top right corner and link your Olares Space account to the Olares device. This authorizes Olares Space's access to your system data.
3. Log into Olares Space.
4. On the Olares page, view Storage usage and Traffic consumption in the system panel.

:::info
For self-hosted Olares users, it's important to monitor Traffic statistics for intranet penetration services, and Storage usage for backup services. These services may incur charges based on usage.
:::

Add worker nodes Copy Chapter

For cloud Olares users, you can improve performance by adding worker nodes:

1. Click more_horiz in the upper right corner, and select Add Worker.
2. On the guide page, choose your preferred hardware configuration.
3. Review the fees for storage and traffic.
4. Confirm your order and submit.

Return Olares Copy Chapter

If you no longer need your Olares service, you can return the instance by following these steps:

1. Click more_horiz in the upper right corner.
2. Select Destroy Olares.
3. Confirm the action and settle your usage:
   • If you are eligible for a refund, the amount will be credited back to your account balance.
   • If additional payment is required, please confirm and settle the payment.

Shared GPU solution Copy Chapter

Currently, we do not offer cloud instances that include GPUs. However, for users who need GPU capabilities, we provide a shared GPU solution via rCuda. This solution is ideal for applications like Stable Diffusion, costing approximately $0.02 per image.

::: tip NOTE
For Large Language Models (LLMs), the shared GPU solution is still under development and may require further enhancements.
:::

If you need GPU support, please reach us on Discord.

Use Cases Comfyui For Krita (`docs/use-cases/comfyui-for-krita.md`) Copy Section

AI art creation with ComfyUI and Krita

Running ComfyUI locally on Olares gives you the flexibility of server-side AI processing, but making it work seamlessly with your creative tools requires additional steps. Instead of confining ComfyUI to a single device, Olares allows you to extend its functionality to other machines, enabling smooth integration with tools such as Krita for editing and refinement.

This tutorial will show you how to connect a locally hosted ComfyUI instance on Olares to Krita running on a separate computer. By combining the power of ComfyUI with Krita, you'll be able to create a streamlined, AI-driven workflow that fits naturally into your creative process.

Objectives Copy Chapter

In this tutorial, you will learn how to:

• Deploy and configure ComfyUI in Olares to maximize performance and resource efficiency.
• Integrate ComfyUI with Krita to create AI-generated artwork seamlessly.

Understanding the components Copy Chapter

Your AI art studio consists of three key pieces working together:

• ComfyUI: The AI engine running in your Olares environment that powers image generation.
• Krita: Professional-grade digital art software where you'll create and edit your artwork.
• Krita AI Diffusion Plugin: The connector that enables seamless communication between Krita and ComfyUI.

What you'll need Copy Chapter

Before starting, ensure you have:

• A working Olares installation with internet access
• A computer connected to the same local network as Olares
• Sufficient system resources (recommended: 16GB RAM for optimal performance)

Set up ComfyUI Copy Chapter

1. Install ComfyUI Shared from Market.

   • For administrator users, this installs both ComfyUI Launcher (the management UI) and ComfyUI (the client UI).
   • For member users, this only installs ComfyUI.

   {width=40%}

2. The administrator configures and launches the ComfyUI service from the ComfyUI Launcher.

3. Configure ComfyUI access policy.

   a. Open Settings, navigate to Applications > ComfyUI Shared > Entrances.

   b. Set the Authentication level for ComfyUI to Internal.
   {width=70%}

4. Launch ComfyUI from your desktop, and verify the installation by generating a sample image.

5. Copy the address of ComfyUI for next steps.
   :::tip
   For security, you should always run AI applications within your local network. When properly configured, your ComfyUI URL should contain .local.

If .local is missing, check your local network environment and make sure no external network proxy service is enabled.
:::

Set up Krita Copy Chapter

1. Download Krita.
2. Download the Krita AI Diffusion plugin.
3. Launch Krita, and navigate to Tools > Scripts > Import Python Plugin from File, and select the downloaded ZIP package.
   {width=70%}
4. Confirm the plugin activation and restart Krita.
5. Open Krita, and verify the installation in Settings > Configure Krita > Python Plugin Manager.

Connect Krita to ComfyUI Copy Chapter

Establish a secure connection between Krita and ComfyUI:

1. Create a new document in Krita.
   :::tip
   Start with a 512 x 512 pixel canvas to optimize performance and manage graphics memory efficiently.
   :::

2. Click Settings > Dockers > AI Image Generation to enable the plugin. You could position the panel to where it's convenient.

3. Click Configure to access the plugin settings.
   {width=70%}

4. Set up ComfyUI connection.

   a. In Connection, select Custom Server, and paste your ComfyUI URL.

   b. Click Connect to verify the connection. A green "Connected" indicator confirms successful connection.

   :::info
   If connection fails:

   • Verify network connectivity between your computer and Olares.
   • Confirm ComfyUI's authentication level is set to "Internal".
   • Check for and disable any interfering proxy services.
   • Ensure ComfyUI is running correctly on your Olares.
     :::

5. Adjust ComfyUI settings.

   a. In Styles, configure your preferred style templates and select appropriate model checkpoints.

   b. Keep default values for other settings unless you need specific optimizations.

Create AI art with text prompts Copy Chapter

Now comes the exciting part - creating AI-generated artwork using natural language prompts.

1. Enter your prompts in the text box, and click Generate.
2. Browse through the generated image variations.
3. Select a preferred result, and click Apply to save it to the canvas.

:::tip
If the results aren't quite what you want, you could:

• Create additional variations with new generations.
• Fine-tune the generation parameters.
• Refine your text prompt for more precise results.
• Experiment with different style settings.
  :::

Use Cases Comfyui Launcher (`docs/use-cases/comfyui-launcher.md`) Copy Section

Manage ComfyUI using ComfyUI Launcher

ComfyUI Launcher is the core management tool of ComfyUI for administrator users. You can use it to control the running status of the ComfyUI service within the cluster, while easily managing models, plugins, runtime environment, and network configurations.

This document guides you on how to use ComfyUI Launcher for ComfyUI service management and routine maintenance.

Start and stop the ComfyUI service Copy Chapter

As the administrator, you must start the ComfyUI service before you and other members can access it using the client interface.

• Start the ComfyUI Service: Click the START button in the upper-right corner to start the ComfyUI service.

  ::: tip Notes on first run

  • Initial startup of ComfyUI Launcher typically takes 10-20 seconds for environment initialization.
  • If the system prompts that essential models are missing, you can click the START ANYWAY button to launch the service. However, note that workflows may not run correctly if basic models are missing. It is recommended to download the essential model package before starting the service.
    :::

• Stop the ComfyUI Service: If you are not using ComfyUI for the moment, click the STOP button to stop the service. This releases the VRAM and memory resources occupied by ComfyUI.

Manage models Copy Chapter

:::tip Note
Before installing models, ensure your host can access GitHub and HuggingFace. For details, refer to Configure network.
:::

ComfyUI Launcher provides flexible ways to install models. You can install the essential models with one click, manually install from Hugging Face, or copy from external sources.

Install essential models Copy Section

Essential models are basic models required for ComfyUI to run, including SD large models, VAE, preview decoders, and auxiliary tools models. It is recommended to install the essential package when running ComfyUI for the first time.

1. Access the essential model package page in either of the following methods:

   • In the Missing essential models prompt window that appears when starting the service for the first time, click INSTALL MODELS.
   • In the Package installation section on the homepage, find Essential model package, and click VIEW.

2. On the essential model installation page, click GET ALL RESOURCES to start the automatic installation. You can view the installation status via the progress bar below.

Manually download models Copy Section

In addition to the essential models, ComfyUI Launcher also supports downloading models from the HuggingFace model library, allowing you to easily get the models you need.

:::tip Upload external models
If you can't find the desired model on Hugging Face, you can use Files to upload external models to the following directory:

External Devices/ai/model
:::

Delete a model Copy Section

To delete a model:

1. Navigate to Model management > Model library.
2. Under the Installed models section, find the model you want to delete, and click the delete button on the right to delete it permanently.

Manage plugins Copy Chapter

You can manage plugins through ComfyUI's built-in ComfyUI-Manager or use Plugin management in the Launcher.

Manage available plugins Copy Section

To manage available plugins registered in ComfyUI Manager:

1. Navigate to Plugin management > Plugin Library.
2. Under Available plugins, select the target plugin:
   • Click the pause button to disable the currently running plugin, and click the play_circle button to resume running.
   • Click the delete button to delete the plugin.
   • Click the download button to download the plugin.
   • Click the visibility button to view plugin details.
   • Click the UPDATE ALL PLUGINS button to update all installed plugins.
   • Click the REFRESH button to refresh the plugin status.

Download plugin from GitHub Copy Section

To install plugins directly from GitHub repositories:

1. Navigate to Plugin management > Custom Install.
2. Enter the URL of the repository.
3. Specify the branch (optional). Use the default (usually 'main' or 'master') if not specified.
4. Click INSTALL PLUGIN.

Manage Python environment Copy Chapter

ComfyUI's operation relies on a set of complex Python dependency libraries. You can manage these libraries easily on the Python dependency management page.

Install new dependency libraries Copy Section

To install a new dependency library:

1. Navigate to Python dependencies.
2. click INSTALL NEW PACKAGE.
3. In the pop-up window, enter the library name and version number (optional), and then click INSTALL.

Manage installed dependency libraries Copy Section

1. Under Installed Python packages, find the Python library you want to manage.
2. Click the arrow_upward button on the right to update the library, or the delete button to remove it.

Analyze dependency installation status Copy Section

1. Under the Dependency analysis tab, click ANALYZE NOW to start analyzing.
2. From the plugins list on the left, find the problematic plugin highlighted in red, and click on it.
3. From Dependency list, find the missing library for the plugin, and click the Install button on the right. You can also click FIX ALL to automatically install all missing libraries.

Troubleshooting and maintenance Copy Chapter

ComfyUI Launcher provides tools to help diagnose and maintain the ComfyUI service.

Configure network Copy Section

Network connection issues can affect the download of models and plugins. Before using ComfyUI, it's recommended to check the connection status to GitHub, PyPI, and HuggingFace on the Launcher homepage.

For example, if GitHub is inaccessible:

1. Navigate to the Network configuration.
2. Switch the provided URLs for GitHub.
3. Click the CHECK button on the right to refresh the connection status.

Repeat steps 2 and 3 until the network becomes "Accessible".

Export ComfyUI logs Copy Section

You can export logs to diagnose the current running status of ComfyUI:

1. In the upper-right corner of the Launcher homepage, click more_vert, then click View logs to view the current running log.
2. Click the refresh button to refresh the log, and the download button to download the log.

Reset ComfyUI configuration Copy Section

To reset ComfyUI to its initial state:

1. In the upper-right corner of the Launcher's homepage, click more_vert, and select Wipe and restore. After a second confirmation, the Launcher will begin the wiping and restoration process.

2. After the restoration operation is complete, restart ComfyUI for the changes to take effect.

:::warning Exercise caution
Restoring ComfyUI is an irreversible operation. Please operate carefully.
:::

Discover inspirations Copy Chapter

Enter the Discover page from the left sidebar to view the latest and most trending ComfyUI models and workflows on civit.ai.

::: tip Note
Please ensure your network can properly access civit.ai.
:::

Use Cases Comfyui (`docs/use-cases/comfyui.md`) Copy Section

ComfyUI

ComfyUI is a powerful node-based interface for Stable Diffusion that transforms AI image generation into a visual programming experience. By connecting different nodes together like building blocks, you gain precise control over every aspect of the generation process - from prompts and models to post-processing effects.

Unlike the straightforward interface of SD Web UI, ComfyUI lets you create custom workflows by connecting nodes that represent different operations. This approach gives you deeper control over the image generation pipeline while making complex operations reusable and shareable.

What can ComfyUI do? Copy Chapter

ComfyUI puts advanced AI image generation capabilities at your fingertips:

• Create reusable workflows by connecting nodes visually
• Fine-tune every aspect of the generation process
• Mix and match different models and techniques
• Save and share your custom workflows with others
• Batch process images with consistent settings
• Apply advanced post-processing effects

Install ComfyUI Shared Copy Chapter

Olares provides ComfyUI Shared to allow multiple users to share models, plugins, and workflow resources within the cluster. It also features ComfyUI Launcher, providing administrator users with a simple way to manage ComfyUI resources and runtime environments.

::: tip Note
Starting from Olares 1.11.6, Shared applications will replace previous cluster-scoped applications. If you have installed ComfyUI for Cluster and its client, please uninstall them before installing ComfyUI Shared.
:::

To install ComfyUI Shared:

1. Open Olares Market, find ComfyUI Shared, and click Get.

   • The administrator will see two icons on the Olares desktop: one is the client interface for ComfyUI, and the other is ComfyUI Launcher.

   {width=40%}

   • Member users will only see the ComfyUI client interface on the desktop.

   :::tip Start the ComfyUI service
   The administrator must start the ComfyUI service from the Launcher before all users in the cluster can access the service from the client interface.
   :::

2. Click the ComfyUI icon to open the interface. Administrators can also enter the ComfyUI interface from the Launcher.

Learn more Copy Chapter

• Manage ComfyUI using ComfyUI Launcher
• Krita + ComfyUI Real-time Painting: Learn how to leverage ComfyUI to assist creative workflows in Krita.

Use Cases Dify (`docs/use-cases/dify.md`) Copy Section

Customize your local AI assistant using Dify

Dify is an AI application development platform. It's one of the key open-source projects that Olares integrates to help you build and manage AI applications while maintaining full data ownership. Additionally, you can integrate your personal knowledge base documents into Dify for more personalized interactions.

Before you begin Copy Chapter

To use local AI models on Dify, ensure you have:

• Ollama installed and running in your Olares environment.
• Open WebUI installed with your preferred language models downloaded.
  :::tip
  For optimal performance, consider using lightweight yet powerful models like gemma2 or qwen, which offer a good balance between speed and capability.
  :::

Install Dify Copy Chapter

:::info
Starting from Olares 1.11.6, if "Dify For Cluster" or "Dify" was previously installed, uninstall them before proceeding.
:::

1. Install "Dify Shared" from Olares Market.
2. Launch Dify from your desktop. Please ensure the admin has already installed Dify Shared.

Create an AI assistant app Copy Chapter

1. Open Dify, navigate to the Studio tab, and select Create from Blank to create an app for the AI assistant. Here, we created an agent named "Ashia".

2. Click Go to settings on the right to access the model provider configuration page. You can choose between remote models or locally hosted models.

Add Ollama as model provider Copy Chapter

1. Navigate to Settings > Application > Ollama > Entrances, and set the authentication level for Ollama to Internal. This configuration allows other applications to access Ollama services within the local network without authentication.

2. In Dify, navigate to Settings > Model Provider.

3. Select Ollama as the model provider, with the following configurations:

   • Model Name: Enter the model name. For example: gemma2.
   • Base URL: Enter Ollama's local address: https://39975b9a1.local.{username}.olares.com. Replace {username} with the Olares Admin's local name. For example, https://39975b9a1.local.marvin123.olares.com.

   {width=70%}

   :::tip
   You can keep default values for other required fields.
   :::

4. Click Save.

Configure Ashia Copy Chapter

1. Navigate to Dify's Studio tab and enter Ashia.

2. From the model list on the right, select the Gemma2 model you just configured.

3. Click Publish. Now you can chat with Ashia in the Debug & Preview window.

Set up local knowledge base Copy Chapter

1. In Dify, navigate to the Knowledge tab.

2. Locate your default knowledge base. It will be named after your Olares ID and monitors the /Documents folder in Files.

3. Enter /Documents and add documents to the knowledge base.

4. In Ashia's orchestration page, click addAdd to add context support for Ashia.
   {width=70%}

5. Click Publish. Now try asking a domain-specific question with the help of the knowledge base.

Use Cases Host Cloud Android (`docs/use-cases/host-cloud-android.md`) Copy Section

outline: [2, 3] Copy Chapter

Host your cloud Android with redroid

redroid (Remote Android) is a GPU-accelerated Android-in-Cloud (AIC) solution that integrates seamlessly with Olares. You can easily host high-performance Android instances on your Olares and access them anytime to run Android games, apps, or even automation tests.

This tutorial walks you through installing redroid on Olares and accessing the Android instance from Windows and macOS.

Objectives Copy Chapter

By the end of this tutorial, you will learn how to:

• Install the required Linux kernel modules on the Olares host.
• Install the redroid app on Olares and get the service URL.
• Connect and operate the Android instance from Windows and macOS, using adb and scrcpy.
• Install APK apps on the Android instance.

Before you begin Copy Chapter

Make sure the following requirements are met:

• Olares is installed and running on a Linux machine.
  ::: tip Configuration requirements

  • redroid is only supported on Linux. Make sure your Olares instance is running on a Linux system.
  • redroid is resource-intensive. For best performance, we recommend using a machine with at least an 8-core CPU and 16GB of RAM.
    :::

• Your device and Olares are on the same local network.

  :::tip Remote access
  If your device is on a different network, use LarePass to enable a private network connection to Olares.
  :::

Install dependent kernel modules Copy Chapter

redroid requires specific kernel modules to run on Linux. For details, refer to the official redroid docs.

For example, on Ubuntu, you can install the required kernel modules by running the following commands in the terminal:

sudo apt install linux-modules-extra-`uname -r`
sudo modprobe binder_linux devices="binder,hwbinder,vndbinder"
# This command might fail on newer kernels; the error can be safely ignored.
sudo modprobe ashmem_linux

Install redroid on Olares Copy Chapter

redroid runs as a headless backend on Olares. To install redroid:

1. In Olares Market, find redroid under "Utilities", and click Get. redroid will launch automatically after installation.

2. Get the URL to access the redroid service:

   a. From Olares Desktop, navigate to Settings > Application > redroid.

   b. In Entrances > Set up endpoint, get the base domain of redroid, e.g., beb583c3.<olares_id>.olares.com.

   c. Append the exported port of redroid (46878) to the base domain.

   As redroid only allows local access, the domain should also include .local. Here is an example of our final URL to access the redroid service: beb583c3.local.olares01.olares.com:46878.

Connect to the redroid service Copy Chapter

To access the Android instance on Olares, you'll need to connect to the redroid service using adb and render the UI using scrcpy.

Install APK Copy Chapter

Once connected, you can use adb to install third-party APK apps on the Android instance.

After installation, run scrcpy again to render the Android screen. Swipe up to see the installed APK.

Common `adb` commands Copy Chapter

:::tip Note
The following commands are for macOS and Linux. On Windows, replace adb with adb.exe.
:::

# Start adb server
adb start-server

# Connect to a device
adb connect <url>:<port>

# List connected devices
adb devices

# Disconnect a device
adb disconnect <url>:<port>

# Install an APK by transport_id
adb -t 3 install your_app.apk

# View real-time logs
adb logcat

# Export logs to a file
adb logcat -v time > log.txt

# Push a file to the device
adb push <local_path> <device_path>

# Pull a file from the device
adb pull <device_path> <local_path>

# List directory contents on device
adb shell ls <path>

# View file contents
adb shell cat <file_path>

# Reboot the device
adb shell reboot

# Shut down the device
adb shell reboot -p

Use Cases Ollama (`docs/use-cases/ollama.md`) Copy Section

outline: [2, 3] Copy Chapter

Download and run AI models locally via Ollama

Ollama is a lightweight platform that allows you to run open-source AI models like deepseek-r1 and gemma3 directly on your machine. Within Olares, you can integrate Ollama with graphical interfaces like Open WebUI to add more features and simplify interactions.

This guide will show you how to set up and use Ollama CLI on Olares.

Before you begin Copy Chapter

Before you start, ensure that:

• You have Olares admin privileges.

Install Ollama Copy Chapter

Directly install Ollama from the Market.

Once installation is complete, you can access Ollama terminal from the Launchpad.

Ollama CLI Copy Chapter

Ollama CLI allows you to manage and interact with AI models directly. Below are the key commands and their usage:

Download model Copy Section

:::tip Check Ollama library
If you are unsure which model to download, check the Ollama Library to explore available models.
:::
To download a model, use the following command:

ollama pull [model]

Run model Copy Section

:::tip
If the specified model has not been downloaded yet, the ollama run command will automatically download it before running.
:::

To run a model, use the following command:

ollama run [model]

After running the command, you can enter queries directly into the CLI, and the model will generate responses.

When you're finished interacting with the model, type:

/bye

This will exit the session and return you to the standard terminal interface.

Stop model Copy Section

To stop a model that is currently running, use the following command:

ollama stop [model]

List models Copy Section

To view all models installed on your system, use:

ollama list

Remove a model Copy Section

If you need to delete a model, you can use the following command:

ollama rm [model]

Show information for a model Copy Section

To display detailed information about a model, use:

ollama show [model]

List running models Copy Section

To see all currently running models, use:

ollama ps

Learn more Copy Chapter

• Learn how to run Ollama models with Open WebUI

Use Cases Openwebui (`docs/use-cases/openwebui.md`) Copy Section

outline: [2, 3] Copy Chapter

Open WebUI

Open WebUI provides an intuitive interface for managing Large Language Models (LLMs) that supports both Ollama and OpenAI-compatible APIs. This page helps you set up and configure Open WebUI in Olares for:

• Model management
• Voice interactions (speech-to-text and text-to-speech)
• Image generation capabilities

Installation Copy Chapter

Ollama is required prior to launching Open WebUI:

• For admin: Install both "Ollama" and "Open WebUI".
• For team members: Ensure that "Ollama" is already installed by Olares admin, and then install "Open WebUI" only.

{width=30%}

:::info
First-time users need to create a local Open WebUI account. This account is specifically for your Olares installation and doesn't connect to external services. Note that existing Open WebUI accounts from other installations cannot be used here - you'll need to create a new one.
:::

Download models Copy Chapter

:::tip
Browse available models on Hugging Face's Chatbot Arena Leaderboard and verify model names in the Ollama Library before downloading.
:::

Recommended starter models for optimal performance (13B parameters or smaller):

• gemma2: Google's latest efficient and powerful language model
• llama3.2: Meta's latest open-source vision-language model

Quick download Copy Section

1. Click the dropdown menu, enter the model name (e.g., llama3.2).
2. Select Pull from Ollama.com. The download starts automatically.

Download from settings Copy Section

1. Click your username in the bottom left.
2. Navigate to Admin Panel > Settings > Models.
3. Under Pull a model from Ollama.com, enter the model name (e.g., llama3.2).
4. Click download to initiate the download.

Configure speech features Copy Chapter

Speech-to-text Copy Section

1. Install Faster Whisper from Market based on your role:

   • Admin: Install both "Faster Whisper For Cluster" and "Faster Whisper".
   • Team members: Ensure that "Faster Whisper For Cluster" is already installed by Olares admin, and install "Faster Whisper" only.

   {width=40%}

2. Open WebUI, and navigate to Admin Panel > Settings > Audio.

3. Select OpenAI as the speech-to-text engine, with the following configurations:

   • API Base URL: http://whisper.whisper-{admin's local name}:8000/v1. For example: http://whisper.whisper-alice123:8000/v1.
   • API key: enter any character.

4. Enter a model variant (default: whisper-1). You can select from the following:

   • tiny.en
   • tiny
   • base.en
   • base
   • small.en
   • small
   • medium.en
   • medium
   • large-v1
   • large-v2
   • large-v3
   • large
   • distil-large-v2
   • distil-medium.en
   • distil-small.en
   • distil-large-v3

5. Click Save.

6. Launch Faster Whisper after configuration. You'll see that the model you configured in Open WebUI is automatically loaded. At this point, you can either:

   • Upload audio directly to start transcription
   • Adjust parameters including:
     • Select different sub-models
     • Choose task types
     • Configure Temperature settings

Text-to-speech Copy Section

1. The admin installs OpenedAI Speech from Market. This launches the service within the cluster.
   :::info
   "OpenedAI Speech" is a shared application and can only be installed by Olares admin. If you are a team member, ensure that the Olares admin has already installed "OpenedAI Speech".
2. Open WebUI, and navigate to Admin Panel > Settings > Audio.
3. Select OpenAI as the text-to-speech engine, with the following configurations:
   • API Base URL: http://openedaispeech.openedaispeech-{admin's local name}:8000/v1. For example: http://openedaispeech.openedaispeech-alice123:8000/v1.
   • API key: enter any character.
4. Click Save.

Text-to-image Copy Section

With SD Web UI Shared installed in your Olares environment, you can leverage Stable Diffusion's powerful image generation capabilities directly through Open WebUI.

1. The admin installs SD Web UI Shared from Market. This launches the Stable Diffusion service within the cluster.
2. Open Open WebUI, and navigate to Admin Panel > Settings > Images.
3. Select Automatic1111 as the image generation engine, with the base URL: http://sdwebui.sdwebui--{admin's local name}:7860. For example: http://sdwebui.sdwebui-alice123:7860.
4. Click cached to verify the connection.
5. Turn on Image Generation (Experimental), and select your preferred text-to-image model checkpoint.
6. Click Save.

Use Cases Perplexica (`docs/use-cases/perplexica.md`) Copy Section

Perplexica

Perplexica is an open-source AI-powered search engine that provides intelligent search capabilities while maintaining user privacy. As an alternative to Perplexity AI, it combines advanced machine learning with comprehensive web search functionality to deliver accurate, source-cited answers to your queries.

The backend: SearSNG Copy Chapter

SearXNG serves as the privacy-focused meta-search engine backend for Perplexica. It:

• Aggregates results from multiple search engines
• Removes tracking and preserves your privacy
• Provides clean, unbiased search results for the AI model to process

This integration enables Perplexica to function as a complete search solution while maintaining the security of your sensitive information.

Before you begin Copy Chapter

Before getting started, ensure you have:

• Ollama installed and running in your Olares environment
• Open WebUI installed with your preferred language models downloaded
  :::tip
  For optimal performance, consider using lightweight yet powerful models like gemma2, which offer a good balance between speed and capability.
  :::

Set up Perplexica Copy Chapter

1. The admin installs SearXNG from Market.

   :::info
   Starting from Olares 1.11.6, if "SearXNG For Cluster" or the "SearXNG" client was previously installed, uninstall them before proceeding.
   :::

2. Install Perplexica from Market.

3. Launch Perplexica, and click settings in the bottom left corner to open the settings window.

4. Configure your search environment with the following settings (using gemma2 as an example):

   • Chat model Provider: Ollama
   • Chat Model: gemma2:latest
   • Embedding model Provider: Ollama
   • Embedding Model: gemma2:latest

   {width=50%}

5. Click the confirmation button to save your configuration and return to the search interface.

Your setup is complete. Try searching for a topic you're interested in to test your new search environment.

Use Cases Remote.Reusables (`docs/use-cases/remote.reusables.md`) Copy Section

search: false Copy Chapter

:::info
iOS or macOS versions of LarePass will require adding a VPN configuration file to the system when turning on the VPN. Follow the prompts to complete the setup.
:::

Use Cases Stable Diffusion (`docs/use-cases/stable-diffusion.md`) Copy Section

Stable Diffusion

Stable Diffusion represents a groundbreaking implementation of latent diffusion models (LDMs) in AI image synthesis. This deep learning architecture operates by decomposing the image generation process into a lower-dimensional latent space, significantly reducing computational requirements while maintaining high-fidelity output.

Olares simplifies the deployment and management of Stable Diffusion. Unlike traditional deployments that require manual configuration of file systems and databases, Olares shields developers from these infrastructure complexities, allowing you to focus solely on using the model for image generation.

With Olares's multi-user support, team members can share a single Stable Diffusion deployment while maintaining individual data privacy. This approach eliminates the need for redundant system installations that would otherwise consume excessive hardware resources.

What can Stable Diffusion do? Copy Chapter

Whether you're an artist looking to expand your creative toolkit, a developer integrating AI imaging into your workflow, or simply curious about AI art generation, Stable Diffusion offers:

• Text-to-image generation
• Image-to-image transformation
• Inpainting and outpainting capabilities
• Style transfer and artistic modifications
• High-resolution image creation and upscaling

Install SD Web UI Copy Chapter

:::info
Starting from Olares 1.11.6, if "SD Web UI For Cluster" or "SD Web UI" was previously installed, uninstall them before proceeding.
:::

1. Install SD Web UI Shared directly from Market.

2. Launch SD Web UI from your desktop. Please ensure the admin has already installed SD Web UI Shared.

Now you are ready to unleash your creativity and start generating stunning images!

Prevent conflicts among members Copy Chapter

In SD Web UI, checkpoint settings are globally applied to all users by default. When one user switches to a different checkpoint, all subsequent image generations by other users will also use this newly selected checkpoint. To prevent workflow disruptions in multi-user environments, you could specify checkpoints for individual tasks.

1. Global checkpoint
2. Per-task checkpoint

Adjust system settings Copy Chapter

When launching SD Web UI, the --xformers flag is enabled by default to:

• Reduce VRAM usage
• Accelerate image generation
• Support higher resolution outputs

While this optimization allows for higher resolution image generation, it comes with some trade-offs, such as less stylistic variation between generated images, and slightly reduced prompt interpretation accuracy.

If you need to remove --xformers:

:::info
Only Olares admin can adjust system parameters through the Control Hub app.
:::

1. Open Control Hub, and navigate to Browse.

2. Locate sdwebui under the admin's namespace.

3. Under Deployments, click sdwebui.

4. Click more_vert in the top right corner, and click Edit YAML.

5. In the YAML editor, locate --xformers and remove it. The default YAML file should look similar to the following.

   yaml {5} Copy

   env:
     - name: CLI_ARGS
       value: >-
         --allow-code --enable-insecure-extension-access --api
         --no-hashing --gradio-queue --xformers

6. Click OK to apply the system settings.

Gallery Copy Chapter

Use Cases Stream Game (`docs/use-cases/stream-game.md`) Copy Section

outline: [2, 3] Copy Chapter

Stream your favorite games with Steam Headless

Want to enjoy some gaming with the power of Olares? You are all set. With the Steam Headless app, Olares easily transforms into a steam streaming server. You can now play your favorite games on any compatible device via Moonlight or Steam Link.

This guide walks you through installing Steam Headless on Olares, configuring the streaming service, and using the Moonlight client to stream your games.

Objectives Copy Chapter

By the end of this tutorial, you will learn how to:

• Install Steam Headless on Olares and configure compatibility for Windows games on the Steam client.
• Configure the streaming service, which involves pairing the Sunshine streaming server with the host on the Moonlight client.
• Stream games on the Moonlight client from both local and remote networks.

Before you begin Copy Chapter

Before you begin, ensure the following:

• Olares is up and running on a machine equipped with an NVIDIA GPU.
• Your streaming device has Moonlight installed. Visit the Moonlight website to download and install the appropriate version.
• Your streaming device is connected to the same LAN as your Olares.
  :::tip Remote streaming
  For remote streaming, install LarePass on your streaming device. You can download the appropriate version from the LarePass site.
  :::
• You have a valid Steam account to access your games.

Install Steam Headless Copy Chapter

1. In Olares Market, find Steam Headless under the Entertainment category, and click Get.

2. Open Steam Headless, and then click Connect to access the Steam Headless console.

3. In the Steam Headless console, click the Install button to install and update the Steam client. Once completed, the Steam login page should appear.

4. Log into your Steam account and complete the initial setup.

::: tip Retry installation upon failures
Due to network issues, Steam installation or update may fail. If this happens, go to the top-left menu in Steam console and navigate to Applications > Internet > Steam to reinstall.
:::

Configure game compatibility Copy Chapter

Olares runs on a Linux environment. You'll need to enable Proton, a compatibility layer, to support Windows games.

1. In the Steam client page, navigate to Steam > Settings in the top left corner.

2. Go to the Compatibility tab and check Enable Steam Play for all other titles.

3. Restart the Steam client to view your complete game library.

Configure the streaming service Copy Chapter

Steam Headless also integrates Sunshine, the streaming server. To stream games using Moonlight, you need to pair the host PC on moonlight with Sunshine.

Prepare for paring Copy Section

1. From your Steam client in the browser, get the URL and append :47990, for example, https://139ebc4f0.local.<your Olares ID>.olares.com:47990. Open this URL to access the Sunshine console page.

2. On your first visit, log in using the default credentials:

   • Username: sam
   • Password: password

3. Click the Pin tab to open the pairing page, where you will be prompted to enter the pairing code.

Add host in Moonlight Copy Section

1. Open the Moonlight client on your streaming device and click the add_to_queue button in the top-right corner.

2. When promoted to enter the IP address of your host PC, enter the local URL of Steam, for example, 139ebc4f0.local.<your Olares ID>.olares.com.

   ::: tip Note
   Do not include https:// and make sure to include the .local part in the hostname.
   :::

3. Click OK, and a host icon appears in locked status.

4. Click the host icon to receive a pairing code.

Complete paring Copy Section

1. In Sunshine's paring page, enter the pairing code.
2. Enter a name for the device and click Send to finish pairing. If successful, you will see the message: "Success! Please check Moonlight to continue".
3. Check the host status in Moonlight. The icon should be active now.

Stream your game Copy Chapter

Now you are done with configuring and ready for gaming.

Stream locally Copy Section

If you are streaming locally from the same network of Olares:

1. Open Moonlight on your streaming device.
2. Click your steam host, and then click the Steam icon to enter the Steam Big Screen mode and play.

Stream remotely Copy Section

With Olares's VPN feature, you can enjoy a smooth streaming experience even across different networks.

To enable the VPN:

Once VPN is enabled on your device, simply follow the same instructions as local streaming.

FAQs Copy Chapter

Why isn't the game displaying in full screen? Copy Section

This could be due to your resolution settings. Try adjusting the resolution:

• In Moonlight: adjust in Settings > Basic Settings > Resolution and FPS.
• On the Steam console page: adjust in Applications > Settings > Display.

How do I exit full-screen streaming? Copy Section

To exit streaming in the full-screen mode:

• On Windows: Use the shortcut combo Ctrl + Alt + Shift + Q.
• On Mac: Use the shortcut combo Control (^) + Option (⌥) + Shift + Q.
• On mobile devices: use the controller button combo Start + Select + L1 + R1.

After finishing your streaming session, exit the Steam Big Picture mode to release system resources on Olares.

Where are my downloaded games stored? Copy Section

By default, games are stored at:

/Cache/olares/steam-headless/c0/.steam/debian-installation/steamapps/common

We recommend not changing this default directory.

Use Cases Stream Media (`docs/use-cases/stream-media.md`) Copy Section

outline: [2, 3] Copy Chapter

Stream your media library from anywhere with Olares

Olares makes it easy to access and enjoy your personal media library from anywhere, whether you're at home or on the go. With built-in VPN support and media management tools like Jellyfin, you can stream your favorite movies and TV shows securely and seamlessly. This tutorial will guide you through the process of setting up Olares VPN, accessing media files, and configuring Jellyfin for advanced streaming capabilities.

Objectives Copy Chapter

In this tutorial, you will learn how to:

• Configure Olares VPN to securely access your media library from anywhere with LAN-like performance.
• Explore and play video files stored in Olares Files using the LarePass client or a web browser.
• Install and set up Jellyfin for media streaming.

Enable Olares VPN connection Copy Chapter

To achieve smooth streaming over external networks, enable the Olares VPN connection in LarePass. This ensures all traffic from devices with LarePass installed routes through the dedicated network, providing LAN-like speed and performance.
:::tip
For different LarePass download options, visit the official page.
:::

Once enabled, you can also access your applications using the format: https://[RouteID].local.[OlaresDomainName].

Devices with activated VPN will use the VPN connection to access Olares, whether through the LarePass client or a browser.

Access media files in LarePass Copy Chapter

After enabling VPN, you can browse media files stored on Olares.

Access via LarePass Client Copy Section

1. Open LarePass, and navigate to your media directory containing movies and TV shows in Files.
2. Click on any file to start playback on your computer or mobile device.

Access from browser Copy Section

1. Open files from your Olares desktop, or directly using the local address: https://files.local.[OlaresDomainName].
2. Locate your media directory, and click on video files to begin playback.

Access media files using Jellyfin Copy Chapter

For advanced media management features like subtitle support and multi-channel audio, install Jellyfin.

1. Open the Market app in Olares and go to the Entertainment category.
2. Locate and download Jellyfin.
3. Launch Jellyfin and complete first-time setup:
   • Set administrator password.
   • Configure media library directories.
4. Wait for Jellyfin to scan and index your media library. It will automatically fetch metadata including:
   • Movie posters
   • Descriptions
   • Cast information

Access your media library through Jellyfin clients Copy Chapter

To stream your media on various devices:

1. Configure Jellyfin authentication.

   a. Open Settings, and navigate to Applications > Jellyfin > Entrances.

   b. Set Authentication level to Internal.

2. Download and install Jellyfin's official client.

3. Connect clients to your Jellyfin server in Olares.

   a. In your Jellyfin client, auto-discovery should locate your server for devices on the same network.

   b. If auto-discovery fails, manually enter the server address from Olares.

4. Log in to Jellyfin client with your credentials.
   :::tip
   Keep the VPN connection active for optimal streaming performance when accessing your media library remotely.
   :::

Use Cases Wise.Reusables (`docs/use-cases/wise.reusables.md`) Copy Section

search: false Copy Chapter

将你的内容收集到 Wise 后，你可以通过 Olares 的聚合搜索功能进行全文搜索。

::: info 搜索格式
目前仅支持文档类型内容（PDF、网页文章和 EPUB）的搜索。其他格式将在后续版本中支持。
:::

1. 点击 Dock 中的 search 打开搜索窗口。
2. 指定搜索范围为 Wise，并输入关键词进行搜索。

:::info
具体步骤可能会因操作系统和浏览器而有所不同。以下以 Safari 为例。
:::

1. 在浏览器中点击 ios_share，选择 LarePass 为分享对象。你可以：

   • 在分享选项中选择 LarePass 的图标，或者
   • 在其他操作栏中选择 LarePass

   LarePass 应用会自动打开并检测待分享页面的内容，并提示是否要添加至 Wise。

2. 点击确认添加。

::: tip 复制 URL 分享
你也可以直接复制网页 URL 并打开 LarePass。LarePass 会自动检测剪贴板中的 URL 和可收藏的内容。
:::

收集完成后，可以在 Wise 的库 > 文章中阅读收集的文章。

Developer Contribute Olares (`docs/developer/contribute/olares.md`) Copy Section

Olares

Directory structure Copy Chapter

olares
|-- apps                  # olares built-in apps
|   |-- agent
|   |-- analytic
|   |-- market
|   |-- market-server
|   |-- argo
|   |-- desktop
|   |-- devbox
|   |-- vault
|   |-- files
|   |-- knowledge
|   |-- nitro
|   |-- notifications
|   |-- profile
|   |-- rss
|   |-- search
|   |-- settings
|   |-- system-apps
|   |-- wise
|   |-- wizard
|-- build                 # olares installer
|   |-- installer
|   |-- manifest
|-- frameworks            # system runtime frameworks
|   |-- app-service
|   |-- backup-server
|   |-- bfl
|   |-- GPU
|   |-- l4-bfl-proxy
|   |-- osnode-init
|   |-- system-server
|   |-- tapr
|-- libs                  # toolkit libs
|   |-- fs-lib
|-- scripts               # scripts for build or package the olares installer
|-- third-party           # third party libs or apps integrated in olares
|   |-- authelia
|   |-- headscale
|   |-- infisical
|   |-- juicefs
|   |-- ks-console
|   |-- ks-installer
|   |-- kube-state-metrics
|   |-- notification-mananger
|   |-- predixy
|   |-- redis-cluster-operator
|   |-- seafile-server
|   |-- seahub
|   |-- tailscale

How to install Copy Chapter

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

How to build Copy Chapter

git clone https://github.com/beclab/olares

cd olares

bash scripts/build.sh

Run the above scripts, you will get the debug version installer package install-wizard-debug.tar.gz

How to install debug version Copy Chapter

mkdir -p /path/to/unpack && cd /path/to/unpack

tar zxvf /path/to/olares/install-wizard-debug.tar.gz

make install VERSION=0.0.0-DEBUG

How to uninstall Copy Chapter

bash olares-uninstall.sh

Developer Install Activate Olares (`docs/developer/install/activate-olares.md`) Copy Section

search: false Copy Chapter

Activate Olares Copy Chapter

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.

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

3. Select the system 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.
   :::warning Same network required
   To avoid activation failures, ensure that both your phone and the Olares device are connected to the same network.
   :::

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

   ::: tip 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.

Developer Install Additional Installations (`docs/developer/install/additional-installations.md`) Copy Section

Additional installation options

Additional installation options in this section are intended for development or testing on special containerized or virtual environments including Linux, macOS, Windows, PVE, or Raspberry Pi.

:::tip Recommendation for production environment
Olares is optimized for Linux systems (Ubuntu or Debian). We recommend installing Olares on Linux using script to get the best performance and reliability for production use.
:::

To run Olares, you must create an Olares ID, and ensure that both the operating system and hardware meet the minimum requirements.

Choose your preferred option to get started:

• Install on Linx using Docker
• Install on macOS
• Install on Windows (WSL 2)
• Install on PVE
• Install on LXC
• Install on Raspberry Pi

Developer Install Environment Variables (`docs/developer/install/environment-variables.md`) Copy Section

outline: [2, 3] Copy Chapter

Olares environment variables

Olares provides a highly customizable installation process through the use of environment variables. These variables can override default settings, enabling advanced configurations to suit your specific requirements.

Usage examples Copy Chapter

To customize the installation process, you can set the environment variables before running the installation command. For example:

# Specify Kubernetes (k8s) instead of k3s
export KUBE_TYPE=k8s \
&& curl -sSfL https://olares.sh | bash -

Or, if you have already downloaded the installation script install.sh:

# Specify Kubernetes (k8s) instead of k3s
export KUBE_TYPE=k8s && bash install.sh

Both methods achieve the same result. The environment variable KUBE_TYPE will be passed to the script, and the script will use it to modify its behavior.

Environment variables reference Copy Chapter

The section lists all the environment variables, along with their default values, optional values, and descriptions. Configure them as needed.

`CLOUDFLARE_ENABLE` Copy Section

Specifies whether to enable the Cloudflare proxy.

• Valid values:
  • 0 (disable)
  • 1 (enable)
• Default: 0

`DID_GATE_URL` Copy Section

Specifies the endpoint for the DID gateway.

• Valid values:
  • https://did-gate-v3.bttcdn.com
  • https://did-gate-v3.api.jointerminus.cn/ (recommended for better connectivity in mainland China)
• Default: https://did-gate-v3.bttcdn.com

`FIREBASE_PUSH_URL` Copy Section

Specifies the endpoint for Firebase push services.

• Valid values:
  • https://firebase-push-test.bttcdn.com/v1/api/push
  • https://firebase-push-test.api.jointerminus.cn/v1/api/push (recommended for better connectivity in mainland China)
• Default: https://firebase-push-test.bttcdn.com/v1/api/push

`FRP_AUTH_METHOD` Copy Section

Sets the FRP authentication method.

• Valid values:
  • jws
  • token (requires FRP_AUTH_TOKEN)
  • (empty) – No authentication
• Default: jws

`FRP_AUTH_TOKEN` Copy Section

Specifies the token for FRP communication (required if FRP_AUTH_METHOD=token).

• Valid values: Any non-empty string
• Default: None

`FRP_ENABLE` Copy Section

Specifies whether to enable FRP for internal network tunneling. Requires additional FRP-related variables if using a custom server.

• Valid values:
  • 0 (disable)
  • 1 (enable)
• Default: 0

`FRP_LIST_URL` Copy Section

Specifies the endpoint for the Olares FRP information service.

• Valid values:
  • https://terminus-frp.snowinning.com
  • https://terminus-frp.api.jointerminus.cn (recommended for better connectivity in mainland China)
• Default: https://terminus-frp.snowinning.com

`FRP_PORT` Copy Section

Specifies the FRP server's listening port.

• Valid values: An integer in the range 1–65535
• Default: 7000 (if not set or set to 0)

`JUICEFS` Copy Section

Installs JuiceFS alongside Olares.

• Valid values: 1
• Default: None (does not install JuiceFS if not set)

`KUBE_TYPE` Copy Section

Determines the Kubernetes distribution to install.

• Valid values:
  • k8s (full Kubernetes)
  • k3s (lightweight Kubernetes)
• Default: k3s

`LOCAL_GPU_ENABLE` Copy Section

Specifies whether to enable GPU support and install related drivers.

• Valid values:
  • 0 (disable)
  • 1 (enable)
• Default: 0

`LOCAL_GPU_SHARE` Copy Section

Specifies whether to enable GPU sharing. Applies only if GPU is enabled.

• Valid values:
  • 0 (disable)
  • 1 (enable)
• Default: 0

`MARKET_PROVIDER` Copy Section

Specifies the backend domain used by the application marketplace (Market).

• Valid values:
  • appstore-server-prod.bttcdn.com
  • appstore-china-server-prod.api.jointerminus.cn (recommended for better connectivity in mainland China)
• Default: appstore-server-prod.bttcdn.com

`NVIDIA_CONTAINER_REPO_MIRROR` Copy Section

Specifies the APT repository mirror for installing NVIDIA Container Toolkit.

• Valid values:
  • nvidia.github.io
  • mirrors.ustc.edu.cn (recommended for better connectivity in mainland China)
• Default: nvidia.github.io

`OLARES_SPACE_URL` Copy Section

Specifies the endpoint for the Olares Space service.

• Valid values:
  • https://cloud-api.bttcdn.com/
  • https://cloud-api.api.jointerminus.cn/ (recommended for better connectivity in mainland China)
• Default: https://cloud-api.bttcdn.com/

`PREINSTALL` Copy Section

Runs only the pre-installation phase (system dependency setup) without proceeding to the full Olares installation.

• Valid values: 1
• Default: None (performs full installation if not set)

`PUBLICLY_ACCESSIBLE` Copy Section

Explicitly specifies that this machine is accessible publicly on the internet, and a reverse proxy should not be used.

• Valid values:
  • 0 (false)
  • 1 (true)
• Default: 0

`REGISTRY_MIRRORS` Copy Section

Specifies a custom Docker registry mirror for faster image pulls.

• Valid values: https://mirrors.joinolares.cn or any other valid URL
• Default: https://registry-1.docker.io

`TAILSCALE_CONTROLPLANE_URL` Copy Section

Specifies the endpoint for the Olares Tailscale control-plane service.

• Valid values:
  • https://controlplane.snowinning.com
  • https://controlplane.api.jointerminus.cn (recommended for better connectivity in mainland China)
• Default: https://controlplane.snowinning.com

`TERMINUS_CERT_SERVICE_API` Copy Section

Specifies the endpoint for the Olares HTTPS certificate service.

• Valid values:
  • https://terminus-cert.snowinning.com
  • https://terminus-cert.api.jointerminus.cn (recommended for better connectivity in mainland China)
• Default: https://terminus-cert.snowinning.com

`TERMINUS_DNS_SERVICE_API` Copy Section

Specifies the endpoint for the Olares DNS service.

• Valid values:
  • https://terminus-dnsop.snowinning.com
  • https://terminus-dnsop.api.jointerminus.cn (recommended for better connectivity in mainland China)
• Default: https://terminus-dnsop.snowinning.com

`TERMINUS_IS_CLOUD_VERSION` Copy Section

Marks the machine explicitly as a cloud instance.

• Valid values: true
• Default: None

`TERMINUS_OS_DOMAINNAME` Copy Section

Sets the domain name before installation to skip the interactive prompt.

• Valid values: Any valid domain name
• Default: None (prompts for domain name if not set)

`TERMINUS_OS_EMAIL` Copy Section

Specifies the email address to use instead of a generated one.

• Valid values: Any valid email address
• Default: None (a temporary email is generated if not set)

`TERMINUS_OS_PASSWORD` Copy Section

Specifies the password to use instead of a generated one.

• Valid values: A valid password with 6–32 characters
• Default: A randomly generated 8-character password

`TERMINUS_OS_USERNAME` Copy Section

Specifies the username before installation to skip the interactive prompt.

• Valid values: Any valid username (2–250 characters, excluding reserved keywords)
• Default: None (prompts for username if not set)
• Validation: Reserved keywords include user, system, space, default, os, kubesphere, kube, kubekey, kubernetes, gpu, tapr, bfl, bytetrade, project, pod

`TOKEN_MAX_AGE` Copy Section

Sets the maximum validity period for a token (in seconds).

• Valid values: Any integer (in seconds)
• Default: 31536000 (365 days)

Developer Install Install And Activate Olares (`docs/developer/install/install-and-activate-olares.md`) Copy Section

search: false Copy Chapter

Install and activate Olares Copy Chapter

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

1. Open LarePass, on your account activation page, tap Discover nearby Olares. LarePass will list the detected Olares instances in the same network.
2. Select the target Olares device from the list and tap Install now.
3. When the installation completes, tap Activate now. Olares will enter the activation process, including initial configuration and network setup.
4. Follow the on-screen instructions to reset the login password for Olares, then tap Complete.

Once activation is complete, LarePass will display the desktop address of your Olares device, such as https://desktop.marvin123.olares.com.

{width=30%}

Developer Install Installation Process (`docs/developer/install/installation-process.md`) Copy Section

outline: [2, 3] Copy Chapter

Olares installation breakdown

This document explains the Olares installation process from the perspective of its four main phases. It is aimed at developers and system administrators who want to understand the installation in detail, including the underlying commands, configurations, and logic behind each phase.

Four phases of installation Copy Chapter

The Olares installation process is divided into four phases, each ensuring a smooth and stable setup:

• Precheck: Verifies that the system environment meets all prerequisites for Olares installation.
• Download: Retrieves all necessary files, dependencies, and container images for the installation.
• Prepare: Configures the operating system and system services to create an environment ready for Kubernetes and Olares components.
• Install: Deploys Kubernetes, integrates KubeSphere, and installs core Olares services and applications.

Precheck phase Copy Chapter

The precheck phase focuses on verifying that your system meets the necessary requirements for installing Olares. The olares-cli precheck command is used to run a series of validation checks. Any issues identified during this phase must be resolved before continuing with the installation.

Key checks include:

• Checks the compatibility with the operating system type, version, and CPU architecture
• Confirms that the system uses Systemd as its initialization process
• Ensures required ports that Olares needs to expose are available
• Verifies that no conflicting container runtime is installed

If the precheck fails, you'll see a warning like this:

In this example:

• Port 9100 required by Olares is already in use.
• An existing container runtime is detected in the system.

You must resolve these issues before proceeding.

Download phase Copy Chapter

The download phase retrieves the necessary wizard files, system dependencies, and container images required for Olares installation.

Download the wizard file Copy Section

The wizard file is a metadata package that contains download URLs and configuration details for all Olares components. It is the first file retrieved during this phase, as it provides critical information for the subsequent downloads.

By default, the wizard file is stored in:

HOME/.olares/versions/<version>

where:

• $HOME/.olares is the base directory for Olares.
• <version> refers to the version number of Olares (e.g. 1.12.0-20241215).

:::details Example script output

➜  ~ ./install.sh
the KUBE_TYPE env var is not set, defaulting to "k3s"
olares-cli already installed and is the expected version

downloading installation wizard...

current: root
2024-12-17T18:01:19.501+0800        [Job] [Download Installation Wizard] start ...
2024-12-17T18:01:19.501+0800        [Module] GreetingsModule
Greetings, Olares
2024-12-17T18:01:19.502+0800        [A] ubuntu: Greetings success (611.77µs)
2024-12-17T18:01:19.502+0800        [Module] DownloadInstallWizard
/home/keven/.olares/versions/v1.12.0-20241215/.env
/home/keven/.olares/versions/v1.12.0-20241215/wizard/config/account/Chart.yaml

:::

Download components and container images Copy Section

Once the wizard file has been downloaded, the script retrieves all necessary dependencies and container images. These files are stored in:

• $HOME/.olares/pkg for dependency packages.
• $HOME/.olares/image for container images.

This storage structure allows reusing stable components across multiple versions to avoid redundant downloads.

:::details Example script output

downloading installation packages...

current: root
2024-12-17T19:41:36.847+0800        [Job] [Download Installation Package] start ...
2024-12-17T19:41:36.847+0800        [Module] GreetingsModule
Greetings, Olares
2024-12-17T19:41:36.848+0800        [A] ubuntu: Greetings success (512.711µs)
2024-12-17T19:41:36.848+0800        [Module] GenerateOlaresUninstallScript
2024-12-17T19:41:36.879+0800        [A] LocalHost: GenerateOlaresUninstallScript success (31.279866ms)
2024-12-17T19:41:36.879+0800        [Module] PackageDownloadModule
2024-12-17T19:41:36.879+0800        checking local cache ...
2024-12-17T19:41:44.614+0800        5 out of 177 files need to be downloaded
2024-12-17T19:41:44.615+0800        (1/5) downloading package olaresd, file: olaresd-v0.0.50.tar.gz
2024-12-17T19:41:51.814+0800        (2/5) downloading image calico/kube-controllers:v3.23.2, file: 521564c4b60ae73c78899b7b40ae655e.tar.gz
...

:::

Prepare phase Copy Chapter

The prepare phase configures the system environment to support Kubernetes, container images, and Olares services.

This phase involves three main tasks:

• Configure the system
• Set up the container runtime
• Install the system daemon

Configure system Copy Section

The installation script configures the Linux environment to meet Olares' requirements. These configurations include:

• Adjusts DNS, NTP, and SSH services to ensure proper network functionality and time synchronization.
• Installs essential dependencies (e.g., curl, net-tools, gcc, make) via apt.

:::details Example script output

preparing installation environment...

current: root
2024-12-17T19:46:39.517+0800        [Job] [Prepare the System Environment] start ...
2024-12-17T19:46:39.517+0800        [Module] PreCheckOs
2024-12-17T19:46:39.517+0800        [A] LocalHost: PreCheckSupport success (29.999µs)
2024-12-17T19:46:39.517+0800        [A] LocalHost: PreCheckPortsBindable success (144.035µs)
2024-12-17T19:46:39.517+0800        [A] LocalHost: PreCheckNoConflictingContainerd success (31.009µs)
2024-12-17T19:46:39.517+0800        [A] ubuntu: PatchAppArmor skipped (7.677µs)
2024-12-17T19:46:39.517+0800        [A] ubuntu: RaspbianCheck success (5.796µs)
2024-12-17T19:46:39.517+0800        [A] ubuntu: CorrectHostname success (5.363µs)
nameserver
nameserver
2024-12-17T19:46:41.921+0800        [A] ubuntu: DisableLocalDNS success (2.40336625s)
2024-12-17T19:46:41.921+0800        [INFO] installing and configuring OS dependencies ...
2024-12-17T19:46:41.921+0800        [Module] InstallDeps
Hit:1 http://security.ubuntu.com/ubuntu jammy-security InRelease
Hit:2 https://download.docker.com/linux/ubuntu jammy InRelease
Hit:3 http://hk.archive.ubuntu.com/ubuntu jammy InRelease
...

:::

Set up container runtime Copy Section

The container runtime is a critical component for running containerized applications. During this step, the installation script:

• Installs and start the previously downloaded dependencies
• Installs containerd on the system and start the service
• Imports the downloaded container images into containerd

:::details Example script output

2024-12-17T19:47:37.510+0800        [Module] InstallContainerModule(k3s)
2024-12-17T19:47:37.518+0800        [A] ubuntu: ZfsMountReset skipped (7.321811ms)
2024-12-17T19:47:37.525+0800        [A] ubuntu: CreateZfsMount skipped (7.322591ms)
2024-12-17T19:47:38.188+0800        [A] ubuntu: SyncContainerd success (662.643982ms)
2024-12-17T19:47:38.368+0800        [A] ubuntu: SyncCrictlBinaries success (179.758334ms)
2024-12-17T19:47:38.399+0800        [A] ubuntu: GenerateContainerdService success (31.410118ms)
2024-12-17T19:47:38.451+0800        [A] ubuntu: GenerateContainerdConfig success (52.047108ms)
2024-12-17T19:47:38.505+0800        [A] ubuntu: GenerateCrictlConfig success (53.760209ms)
2024-12-17T19:47:38.857+0800        [A] ubuntu: EnableContainerd success (352.128078ms)
2024-12-17T19:47:38.857+0800        [Module] PreloadImages
2024-12-17T19:47:41.665+0800        (1/145) imported image: rancher/mirrored-pause:3.6, time: 194.363948ms
...

:::

Install system daemon Copy Section

The Olares system daemon, olaresd, is then installed and started to monitor the system and automatically perform maintenance tasks.

:::details Example script output

024-12-17T19:52:31.862+0800        [A] ubuntu: GenerateOlaresdEnv success (23.829684ms)
2024-12-17T19:52:31.862+0800        template OlaresdService result: [Unit]
Description=olaresd
After=network.target
StartLimitIntervalSec=0

[Service]
User=root
EnvironmentFile=/etc/systemd/system/olaresd.service.env
ExecStart=/usr/local/bin/olaresd
RestartSec=10s
LimitNOFILE=40000
Restart=always

[Install]
WantedBy=multi-user.target

2024-12-17T19:52:31.885+0800        [A] ubuntu: GenerateOlaresdService success (23.050958ms)
2024-12-17T19:52:32.033+0800        [A] ubuntu: EnableOlaresdService success (147.987242ms)
...

:::

Install phase Copy Chapter

The install phase brings all system components online and ensures the runtime environment is fully operational.

During this phase, the script primarily completes the following tasks:

• Deploy Kubernetes.
• Integrate KubeSphere for cloud-native management and observability.
• Configure the Olares account.
• Deploy and start built-in apps and services.

Deploy Kubernetes Copy Section

Kubernetes is the backbone of the Olares system. During this step, the installation script:

1. Starts the etcd database.
2. Starts and configures K3s.
3. Installs a Container Network Interface (CNI) plugin for cluster networking.
4. Copies the kubeconfig file to the current user's directory, enabling interaction with the cluster via kubectl.

K3s is the default Kubernetes distribution for Olares due to its lightweight design and ease of use. However, kubernetes is also available for advanced or custom setups.

On macOS, the scripts uses minikube, which will skip the above step.

:::details Example script output

/* Detailed source-code truncated for AI context efficiency. */

:::

Integrate KubeSphere Copy Section

KubeSphere is installed on top of Kubernetes to enhance system management and observability. It provides features such as:

• System monitoring and alerting.
• Resource and workspace management.
• Namespaces and custom resource definitions (CRDs).

Configure account Copy Section

The Olares ID is created in the LarePass app. During this step, the installation script prompts you to enter the following info, so you can use LarePass to activate Olares later:

• Olares domain name: Olares provides default names olares.com and olares.cn. This can be customized if the custom domain has been added to Olares Space.
• Olares ID: Enter the username part of your Olares ID.

This creates a system account for logging in to Olares and completes several background access and permission configurations.

:::details Example script output

Enter the domain name ( olares.com by default ): 
2024-12-17T20:58:15.690+0800        using Domain Name: olares.com

Enter the Olares ID (which you registered in the LarePass app): marvin113
2024-12-17T20:58:52.584+0800        using Olares Local Name: marvin113
2024-12-17T20:58:52.584+0800        using Olares ID: [email protected]
2024-12-17T20:58:52.584+0800        using password: 2uO5PZ2X

:::

Deploy built-in applications Copy Section

The final deployment step installs core services and user applications using Helm charts:

• Core system services (in the os-system namespace): Includes backups (Velero), storage (OpenEBS), Redis, Nats, MinIO, etc.
• User applications (in namespaces like user-space-xxx): Includes Files, Desktop, Settings, etc.

During installation, the log will display messages such as [helm] app installed success and xxx created, indicating that the respective Helm charts or Kubernetes resources have been installed successfully.

:::details Example script output

/* Detailed source-code truncated for AI context efficiency. */

:::

Complete the installation Copy Section

Once all components are deployed, the script outputs a summary with a URL for the activation wizard:

2024-12-17T21:00:58.086+0800        [INFO] Installation wizard is complete
2024-12-17T21:00:58.086+0800        [INFO] All done

------------------------------------------------

2024-12-17T21:00:58.086+0800        Olares is running at:
2024-12-17T21:00:58.086+0800        http://192.168.1.16:30180

2024-12-17T21:00:58.086+0800        Open your browser and visit the above address
2024-12-17T21:00:58.086+0800        with the following credentials:

2024-12-17T21:00:58.086+0800        Username: marvin113
2024-12-17T21:00:58.086+0800        Password: 2uO5PZ2X

To complete the installation, you need to:

1. Open your browser and enter the provided URL.
2. Log in to the activation wizard with initial password.
3. Follow the on-screen prompt to finish the activation.

After activation, your Olares will be fully operational and ready to use.

Learn more Copy Chapter

• Olares installation overview
• Olares environment variables

Developer Install Installation Troubleshooting (`docs/developer/install/installation-troubleshooting.md`) Copy Section

search:false Copy Chapter

:::info Troubleshooting installation issues
If any issues arise during installation, report them by creating a GitHub issue. Include the following details:

• The platform or environment being used (e.g., Ubuntu, Docker, WSL, etc.).
• The installation method (script or Docker image).
• Detailed error information (including logs, error messages, or screenshots).
  :::

Developer Install Linux Via Docker Compose (`docs/developer/install/linux-via-docker-compose.md`) Copy Section

outline: [2, 3] Copy Chapter

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.
:::

System requirements Copy Chapter

Make sure your device meets the following requirements.

• CPU: At least 4 cores
• RAM: At least 8GB of available memory
• Storage: At least 64GB of available space (SSD recommended)
• Supported systems:
  • Ubuntu 20.04 LTS or later
  • Debian 11 or later

:::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.
:::

Before you begin Copy Chapter

Before you begin, ensure the following:

• Docker and Docker Compose are installed and running on your system.
• You know the IP address of the current device.
  :::tip Verify host IP
  To verify your host IP, run the following command in the terminal:
  bash Copy

  ip r

  Look for the line starting with default via. It will show the default gateway and the network interface being used.
  :::
• You have created an Olares ID via LarePass.

Create a new directory Copy Chapter

Create a directory to store the Olares configuration files. For example, you could make a new directory called olares-config with the following command:

mkdir ~/olares-config
cd ~/olares-config

Prepare `docker-compose.yaml` Copy Chapter

1. Create a docker-compose.yaml file in the olares-config directory.
2. Add the appropriate content to the file based on whether GPU support is required:
   :::code-group
   <<< @/code-snippets/docker-compose.yaml
   <<< @/code-snippets/docker-compose-GPU.yaml
   :::
3. Save the docker-compose.yaml file.

Set up environment variables and start container Copy Chapter

1. In the olares-config directory, use the following command to set the environment variables and start the Olares services:

   bash [with docker compose plugin] Copy

   VERSION=<olares version> HOST_IP=<host ip> docker compose up -d

   • VERSION=<olares version>: Specifies the Olares version. Replace <olares version> with the actual one. For example: 1.11.5.
   • HOST_IP=<host ip>: Specifies the Linux machine's IP address. Replace <host ip> with the actual one.

   After executing the command, you should see output similar to the following, showing the status and port mappings of all containers:
   ```

/* Detailed source-code truncated for AI context efficiency. */

2. Verify if the container is running successfully:
   ```bash
   docker ps

You should see an output like this:

CONTAINER ID   IMAGE                         COMMAND                  CREATED              STATUS              PORTS                   NAMES
28e86c473750   beclab/olaresd:proxy-v0.1.0   "/mdns-agent"            About a minute ago   Up About a minute                           olares-olaresd-proxy-1
5fd68a8709ad   beclab/olares:1.11.5       "/usr/local/bin/entr…"   2 minutes ago        Up About a minute   0.0.0.0:80->80/tcp...   olares-olares-1

Manage the Olares container Copy Chapter

Ensure that you are in the directory containing the docker-compose.yaml file before proceeding with any commands.

Stop the container Copy Section

To stop the running container:

docker compose stop

Restart the container Copy Section

To restart the container after it has been stopped:

docker compose start

It may take 6 to 7 minutes for all services to fully initialize after restarting.

Uninstall the container Copy Section

To uninstall the container:

docker compose down

Developer Install Log In To Olares (`docs/developer/install/log-in-to-olares.md`) Copy Section

search: false Copy Chapter

Log in to Olares Copy Chapter

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.

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.
   :::

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

Developer Install Lxc (`docs/developer/install/lxc.md`) Copy Section

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
Currently, Olares on LXC has certain limitations. We recommend using it only for development or testing purposes.
:::

System requirements Copy Chapter

Make sure your device meets the following requirements.

• CPU: At least 4 cores
• RAM: At least 8GB of available memory
• Storage: At least 64GB of available space (SSD recommended)
• 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.
:::

Prerequisites Copy Chapter

• Working directories for storing images and packages on the PVE host. You can set it using the following command:

  bash Copy

  mkdir -p /root/.olares/images /root/.olares/pkg

• The container template (CT) for debian-12-standard_12.7-1_amd64.tar.zst. Download it from the PVE image repository.

Configure the LXC environment Copy Chapter

::: tip Install on existing LXC
To install Olares on an existing LXC container, skip to step 2 directly. Make sure you use the corresponding container ID.
:::

1. Create the LXC container using the following script:

   ::: tip Unique container ID
   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} Copy

   export ROOTPASS=123456 
   pct create 16553 /var/lib/vz/template/cache/debian-12-standard_12.7-1_amd64.tar.zst \
   --hostname olares \
   --ostype ubuntu \
   --cores 4 \
   --memory 10240 \
   --swap 0 \
   --net0 name=eth0,bridge=vmbr0,firewall=1,ip=dhcp,ip6=dhcp,type=veth \
   --rootfs local-lvm:80 \
   --unprivileged 0 \
   --ignore-unpack-errors \
   --mp0 "/root/.olares/images,mp=/root/.olares/images" \
   --mp1 "/root/.olares/pkg,mp=/root/.olares/pkg" \
   --password="$ROOTPASS"

2. Modify the LXC configuration.

   a. Open the configuration file using the following command:

   bash Copy

   nano /etc/pve/lxc/16553.conf

   b. Copy and paste the following configurations into the file:

   bash Copy

   arch: amd64
   cores: 4
   hostname: olares
   memory: 10240
   net0: name=eth0,bridge=vmbr0,firewall=1,hwaddr=BC:24:11:13:05:7C,ip=dhcp,ip6=dhcp,type=veth
   ostype: debian
   rootfs: local-lvm:vm-16553-disk-0,size=80G
   
   # Storage config
   mp0: /root/.olares/images,mp=/root/.olares/images
   mp1: /root/.olares/pkg,mp=/root/.olares/pkg
   
   # Permision config 
   lxc.apparmor.profile: unconfined
   lxc.cgroup.devices.allow: a
   lxc.cap.drop:
   lxc.mount.auto: "proc sys cgroup:mixed"

   c. Save and close the file.

3. Enable IP Virtual Server (IPVS) modules on the PVE host:

   bash Copy

   sudo modprobe ip_vs
   sudo modprobe ip_vs_rr
   sudo modprobe ip_vs_wrr
   sudo modprobe ip_vs_sh
   sudo modprobe overlay

4. Start the LXC container, make initial configurations, and exit:

   bash Copy

   # Start the container
   pct start 16553
   
   # Enter the container
   pct enter 16553
   
   # Create missing directories
   mkdir -p /lib/modules
   
   # Update PATH environment variable
   echo 'export PATH="/usr/local/bin:$PATH"' >> /root/.bashrc
   source ~/.bashrc
   
   # exit LXC
   exit

5. Copy PVE dependencies to the LXC container:

   bash Copy

   # Copy kernel config from PVE host to LXC container
   pct push 16553 /boot/config-$(uname -r) /boot/config-$(uname -r)
   
   # Package and copy kernel modules directory
   tar cvf /lib/modules/6.8.4-2-pve.tar.gz /lib/modules/6.8.4-2-pve
   pct push 16553 /lib/modules/6.8.4-2-pve.tar.gz /lib/modules/6.8.4-2-pve.tar.gz
   
   # Extract the archive inside the container
   pct enter 16553
   cd /lib/modules
   tar xvf /lib/modules/6.8.4-2-pve.tar.gz -C /

Install on LXC Copy Chapter

Run the following installation command inside the LXC container:

Developer Install Mac Via Docker Image (`docs/developer/install/mac-via-docker-image.md`) Copy Section

outline: [2, 3] Copy Chapter

Install Olares on Mac with Docker image

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.

:::warning Not for production use
Currently, Olares on Mac has certain limitations including:

• Lack of distributed storage support.
• Inability to add local nodes.

We recommend using it only for development or testing purposes.
:::

System requirements Copy Chapter

Make sure your device meets the following requirements.

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

Before you begin Copy Chapter

Before you begin, ensure the following:

• Docker is installed and running on your system.
• You know the IP address of the current device.
  ::: tip View IP Address
  To view the IP address on a Mac, there are two methods:
  • Using the graphical interface: Open System Settings (or System Preferences) > Network, and check the details under the currently active network connection.
  • Using the command line: Open a terminal window and enter ipconfig getifaddr en0 for Wi-Fi, or ipconfig getifaddr en1 for wired network.
    :::
• You have created an Olares ID via LarePass.

Run `olaresd-proxy` Copy Chapter

::: tip Check Mac chip
If you are unsure which chip your Mac is using, go to the Apple menu and select About This Mac to verify.
:::

<template #Apple-Silicon>

1. Download olaresd-proxy via the link: 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.
   :::

<template #Intel>

1. Download olaresd-proxy via the link: 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.
   :::

Pull the Olares image Copy Chapter

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:

docker run -d --privileged -v oic-data:/var \
  -e HOST_IP=<host ip> \
  -p 80:80 \
  -p 443:443 \
  -p 30180:30180 \
  -p 18088:18088 \
  -p 41641:41641/udp \
  --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.
• -p 18088:18088: Maps port 18088 on the host to port 18088 in the container.
• -p 41641:41641/udp: Maps UDP port 41641 on the host to UDP port 41641 in the container.
• --name oic: Names the container oic (Olares in container) for easier reference.
• beclab/olares:<olares version>: Specifies the Olares Docker image and version. For example: beclab/olares:1.11.5.

When the container is running, you will see a container ID output.
:::
:::warning 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.
:::

Developer Install Mac (`docs/developer/install/mac.md`) Copy Section

Install Olares on Mac via the script

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

:::warning Not for production use
Olares on Mac has certain limitations including:

• Lack of distributed storage support.
• Inability to add local nodes.

We recommend using it only for development or testing purposes.
:::

System compatibility Copy Chapter

Make sure your Mac meets the following requirements.

• Architecture: X86-64 or ARM64
• RAM: 8 GB or above (available memory)
• Storage: 90 GB or above (available disk space)
• MacOS: Monterey (12) or later

Before you begin Copy Chapter

Ensure you have the following installed:

• Docker Desktop
• MiniKube
  ::: tip
  It's recommended to install via homebrew.
  :::

Set up system environment Copy Chapter

1. In Docker Desktop, navigate to Settings > Resources, and configure as below:

   • CPU limit: Set to at least 4 CPUs
   • Memory limit: Set to at least 9 GB
   • Virtual disk limit: Set to at least 80 GB

2. Click Apply & restart to implement the changes.

Install Olares Copy Chapter

In terminal, run the following command:

Developer Install Manage Olares Container (`docs/developer/install/manage-olares-container.md`) Copy Section

search: false Copy Chapter

Manage the Olares container Copy Chapter

Stop the container Copy Section

To stop the running container:

docker stop oic

Restart the container Copy Section

To restart the container after it has been stopped:

docker start oic

Uninstall the container Copy Section

To completely remove the container and its associated data:

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

Developer Install Olares Home (`docs/developer/install/olares-home.md`) Copy Section

Olares Home

"Olares Home" is the default installation directory for Olares. It stores images, logs, dependency components, and version management data. In this document, you will learn the structure of Olares Home and gain a clearer understanding of the Olares installation process.

Path configuration Copy Chapter

By default, Olares Home is located at ~/.olares. You can customize its location using the --base-dir option with a specific olares-cli command, for example:

#  Specifies the base directory where all downloaded components will be saved
olares-cli download component --base-dir /custom/path

Directory structure Copy Chapter

A typical Olares Home directory might look like this:

./olares
├── images                # Stores downloaded image files
│   ├── {image-file}.tar.gz
│   └── {image-file}.tar.gz
├── logs                  # Stores all logs
├── pkg                   # Stores downloaded system dependency components
│   ├── cni               # Container Network Interface (K8s network plugins)
│   ├── components        # Olares foundation software dependencies (not directly related to K8s)
│   │                       such as olaresd, JuiceFS, Redis, etc.
│   ├── containerd        # Container Runtime Interface (CRI) runtime
│   ├── crictl            # CRI command-line tool
│   ├── etcd              # Persistent database for K8s
│   ├── helm              # Command-line tool for K8s application management
│   ├── kube              # Core K8s programs (e.g., kubeadm, kubelet, k3s)
│   └── runc              # Open Container Initiative (OCI) runtime
└── versions              # Stores different Olares versions
    ├── v1.10.0-20241001
    │   ├── cli
    │   ├── deploy
    │   ├── files
    │   ├── images
    │   ├── logs          # Stores logs specific to this version of Olares
    │   │   ├── install.log
    │   │   └── uninstall.log
    │   └── wizard        # Contains Helm charts for system and user applications
    └── v1.10.0-20240930
        ├── cli
        ├── deploy
        ├── files
        ├── images
        ├── logs
        │   ├── install.log
        │   └── uninstall.log
        └── wizard

The structure of Olares Home is designed to optimize file management, version control, and resource sharing. The advantages include:

• Each Olares version is stored under the versions directory. All files and logs related to a particular version are contained within its subdirectory.
• Only one Olares instance can run on a single machine at a time, preventing version conflicts.
• The images and pkg directories are shared across all Olares versions. This design reduces redundancy, minimizes duplicate downloads, and saves disk space.

Learn more Copy Chapter

• Olares CLI
• Olares installation breakdown
• Olares environment variables

Developer Install Pve (`docs/developer/install/pve.md`) Copy Section

Install Olares on PVE

Proxmox Virtual Environment (PVE) is an open-source virtualization platform based on Debian Linux. This guide explains how to install Olares in a PVE environment.

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

System requirements Copy Chapter

Make sure your device meets the following requirements.

• CPU: At least 4 cores
• RAM: At least 8GB of available memory
• Storage: At least 64GB of available space (SSD recommended)
• Supported Systems: PVE 8.2.2

:::info Version compatibility
While the specific version is 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.
:::

Install on PVE Copy Chapter

In PVE CLI, run the following command:

Developer Install Raspberry Pi (`docs/developer/install/raspberry-pi.md`) Copy Section

Install Olares on Raspberry Pi

This guide explains how to install Olares on a Raspberry Pi.

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

System requirements Copy Chapter

Make sure your Raspbian device meets the following requirements.

• Hardware: Raspberry Pi 4B or Raspberry Pi 5 with 8GB memory
• Operating system: Raspbian 12
• Storage: 64GB (SSD recommended)

Set up system environment Copy Chapter

1. Configure the Raspbian environment to enable necessary features:

   bash Copy

   echo "$(head -1 /boot/firmware/cmdline.txt) cgroup_enable=cpuset cgroup_enable=memory cgroup_memory=1" | sudo tee /boot/firmware/cmdline.txt
   
   echo "kernel=kernel8.img" | sudo tee -a /boot/firmware/config.txt

2. Reboot your Raspbian device to apply the change.

   bash Copy

   sudo reboot

Install Olares Copy Chapter

Run the following command:

Developer Install Reusables (`docs/developer/install/reusables.md`) Copy Section

search: false Copy Chapter

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

:::tip Root user password
During the installation, you may be prompted to enter your root password.
:::

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

bash olares-uninstall.sh

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

Prepare Wizard URL Copy Chapter

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

For example, if your full Olares ID is [email protected]:

• 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.

Next step: Protect your Olares ID Copy Chapter

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.

• Back up your mnemonic phrase

:::info Having trouble with installation?
If you encounter issues during the installation process, feel free to submit a GitHub Issue. Please include the following information when submitting:

• The platform or environment you're using (e.g., Ubuntu, Docker, WSL, etc.).
• The installation method (script installation or Docker image).
• Detailed error information (including logs, error messages, or screenshots).
  :::

Developer Install Versioning (`docs/developer/install/versioning.md`) Copy Section

outline: [2, 3] Copy Chapter

Olares versioning

The Olares versioning and release process is designed to provide clear version definitions and stable upgrade paths. This document outlines Olares' versioning rules, release types, branch management practices, and upgrade guidelines.

Versioning rules Copy Chapter

Olares primarily follows the Semantic versioning specification, which defines versions in format Major.Minor.Patch[-PreReleaseVersion]. For example, 1.11.0-rc.0 represents a release candidate for version 1.11.0.

Versions are ordered as follows:
1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-alpha.beta < 1.0.0-beta < 1.0.0-beta.2 < 1.0.0-beta.11 < 1.0.0-rc.1 < 1.0.0

Release types Copy Chapter

Olares offers three types of releases: Stable, Release Candidate (RC), and Daily build.

Stable releases Copy Section

Stable releases are thoroughly tested versions suitable for production environments. The official one-line installation command always defaults to the latest stable version.

• Release cadence: Monthly
• Examples: v1.10.5, v1.11.0, v1.11.1, v1.12.0

Release Candidate (RC) releases Copy Section

RC releases are pre-release versions for testing before a stable release. RC releases may go through several iterations before being promoted to stable.

• Release cadence: Based on testing status
• Examples: v1.11.0.rc.0, v1.11.0.rc.1

Daily build releases Copy Section

Daily build releases, or daily builds are automatically generated from the main branch every day at 2:00 AM (UTC+8), with the build date embedded in the version name. These versions reflect the latest code changes and are intended for development and testing purposes. Daily builds are often unstable and not suitable for production use.

• Release cadence: Daily
• Examples: v1.12.0-20241201

Release branch management Copy Chapter

During the 1.x phase, Olares follows a structured monthly release cadence:

1. At the end of each month, a release branch (e.g., release-1.11) is created from the main branch.

2. An initial RC version (e.g., v1.11.0.rc.0) is released from the new release branch. Additional RC versions may follow as testing progresses.

3. The main branch transitions to the next version (e.g., from v1.11 to v1.12).

4. Issues identified in the stable version are addressed through patch releases (e.g., v1.11.1), based on the corresponding release branch.

Developers can submit pull requests (PRs) to both the main branch and the relevant release branch as needed.

Upgrade policies and compatibility Copy Chapter

Olares is in a rapid development phase with frequent feature additions and changes. To ensure stability and avoid unexpected issues, Olares follows a controlled upgrade policy:

• Upgrades within the same minor version:

  Upgrading within the same minor version (e.g., 1.4.0 to 1.4.2) is fully supported. These updates typically include bug fixes or small improvements that do not affect compatibility.

• Upgrades across minor versions:

  Upgrading from one minor version to another (e.g., 1.4.x to 1.5.x) involves more significant changes, such as new features or architectural updates. Because these changes may not be backward-compatible, automatic upgrades are not supported. Instead, users must manually uninstall the existing version before installing the newer version.

The type of release you are using also determines what upgrades are possible:

• Stable: You can only upgrade to newer stable releases, ensuring maximum reliability and stability.
• RC: You can upgrade to newer RC versions or stable releases as they become available.
• Daily build: You can upgrade to newer daily build, RC, or stable releases.

::: tip Future upgrade policy
In the next major release, Olares plans to fully support seamless automatic upgrades for all versions within the same major version.
:::

Developer Install Windows Via Docker Image (`docs/developer/install/windows-via-docker-image.md`) Copy Section

outline: [2, 3] Copy Chapter

Install Olares on Windows (WSL 2) with Docker image

You can use Docker to install and run Olares in a containerized environment. This guide walks you through setting up Olares with Docker and WSL 2, preparing the installation environment, completing the activation process, and managing the container lifecycle.

:::warning Not recommended for production use
Currently, Olares on Windows has certain limitations including:

• Lack of distributed storage support
• Inability to add local nodes.

We recommend using it only for development or testing purposes.
:::

System requirements Copy Chapter

Make sure your Windows meets the following requirements.

• CPU: At least 4 cores
• RAM: At least 16GB of available memory
• Storage: At least 64GB of available space (SSD recommended)
• Supported systems:
  • Windows 10 or 11
  • Linux (on WSL 2): Ubuntu 20.04 LTS or later; Debian 11 or later

Before you begin Copy Chapter

Before you begin, ensure the following:

• Docker Desktop is installed and running on your system.
  :::info WSL 2 and Hyper-V
  If Docker Desktop is configured to use Hyper-V, GPU support for Olares cannot be enabled. Ensure Docker Desktop is set to run in the WSL 2 mode.
  :::
• You know the IP address of the current device.
  ::: tip View IP Address
  In PowerShell or Command Prompt, use the following command to confirm your IP address:
  bash Copy

  ipconfig | findstr /i "IPv4.*192"

  :::
• You have created an Olares ID via LarePass.

Configure WSL 2 Copy Chapter

1. Open PowerShell and run the following command to confirm the kernel version of WSL installed on your system:

   powershell Copy

   wsl --version

   Example output:

   powershell{2} Copy

   WSL version: 2.4.8.0
   Kernel version: 5.15.167.4-1
   WSLg version: 1.0.65
   MSRDC version: 1.611.1-81528511
   DXCore version: 10.0.26100.1-240331-1435.ge-release
   Windows version: 10.0.26100.3475

2. Use the link provided to download the appropriate kernel file matching your version: https://dc3p1870nn3cj.cloudfront.net/bzImage-<kernel-version>.
   For example, For kernel version 5.15.167.4, download the file from https://dc3p1870nn3cj.cloudfront.net/bzImage-5.15.167.4.

   Supported kernel versions (above 5.15.146.1) are:

   • linux-msft-wsl-5.15.146.1
   • linux-msft-wsl-5.15.150.1
   • linux-msft-wsl-5.15.153.1
   • linux-msft-wsl-5.15.167.4
   • linux-msft-wsl-6.6.75.1
   • linux-msft-wsl-6.6.36.6
   • linux-msft-wsl-6.6.36.3

3. Set the default version of WSL to version 2:

wsl --set-default-version 2

4. In the directory C:\Users\<YourUsername>\, create a file named .wslconfig with the following content:
   txt Copy

   [wsl2]
   kernel=c:\\path\\to\\your\\kernel\\bzImage-<version> # Note: Use double backslashes (\\) as path separators
   memory=8GB # Recommended: 16GB
   swap=0GB

   :::info
   If you installed Docker Desktop before modifying the .wslconfig file, it is recommended to remove the docker-desktop distribution installed under WSL:
   bash Copy

   wsl --unregister docker-desktop
   wsl --unregister docker-desktop-data # If this version exists

   :::
5. Restart your computer to apply the changes.

Prepare Docker Copy Chapter

If you have installed Docker Desktop before modifying .wslconfig, remove docker desktop then restart Windows.

Run `olaresd-proxy` Copy Chapter

1. Download olaresd-proxyfrom the following link: https://dc3p1870nn3cj.cloudfront.net/olaresd-proxy-v0.1.0-windows-amd64.tar.gz.
2. Extract the file and start the olaresd-proxy executable.
   :::info Keep olaresd-proxy running
   Ensure that olaresd-proxy runs in the background during the installation and activation of Olares.
   :::

Run Olares using the Docker CLI Copy Chapter

:::warning CUDA version requirements
CUDA version 12.4 or above is required for GPU support. Older versions are incompatible.
:::
Run the following command to pull the Olares image.
Replace <host ip> with your device's IP address and <olares version> with the desired version of Olares:
::: code-group

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

docker run --gpus all -d --privileged -v oic-data:/var \
 -e HOST_IP=<host ip> \
 -p 80:80 \
 -p 443:443 \
 -p 30180:30180 \
 -p 18088:18088 \
 -p 41641:41641/udp \
 --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.
• -p 18088:18088: Maps port 18088 on the host to port 18088 in the container.
• -p 41641:41641/udp: Maps UDP port 41641 on the host to UDP port 41641 in the container.
• --name oic: Names the container oic (Olares in container) for easier reference.
• beclab/olares:<olares version>: Specifies the Olares Docker image and version. For example: beclab/olares:1.11.5.

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

:::warning 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.
:::

Developer Install Windows (`docs/developer/install/windows.md`) Copy Section

outline: [2, 3] Copy Chapter

Install Olares on Windows via the script

This guide explains how to install Olares on Windows (WSL 2) using the provided installation script.

:::warning Not recommended for production use
Currently, Olares on Windows has certain limitations including:

• Lack of distributed storage support
• Inability to add local nodes.

We recommend using it only for development or testing purposes.
:::

System compatibility Copy Chapter

Make sure your Windows meets the following requirements.

• CPU: At least 4 cores
• RAM: At least 16GB of available memory
• Storage: At least 64GB of available space (SSD recommended)
• Supported systems:
  • Windows 10 or 11
  • Linux (on WSL 2): Ubuntu 20.04 LTS or later; Debian 11 or later

Set up system environment Copy Chapter

1. Enable the required Windows features for virtualization.

   a. Open Control Panel, then go to Programs > Programs and Features > Turn Windows features on or off.

   b. In the Windows Features window, check:

   • Hyper-V (not required for Windows 10 Home and Windows 11 Home)
   • Windows Subsystem for Linux
   • Virtual Machine Platform

   c. Click OK and restart your computer when prompted.

2. Set the execution policy for the current user.

   a. Open PowerShell as administrator, then run the following command:

   powershell Copy

   Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser

   b. When prompted to check whether to change the execution policy, type A and press Enter to confirm.

   powershell{5} Copy

   Execution Policy Change
   The execution policy helps protect you from scripts that you do not trust. Changing the execution policy might expose
   you to the security risks described in the about_Execution_Policies help topic at
   https:/go.microsoft.com/fwlink/?LinkID-135170. Do you want to change the execution policy?
   [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "N"):

Install Olares Copy Chapter

1. Click https://windows.olares.sh to download the installation script publicInstall.latest.ps1.

2. Execute the script.

   a. Open PowerShell as administrator, then navigate to the folder where the script is located. For example, if the script is in the Downloads folder, run the following command:

   powershell Copy

   cd C:\Users\<YourUsername>\Downloads

   b. Once in the correct folder, run the following command:

   powershell Copy

   .\publicInstall.latest.ps1

   :::warning Administrator privileges required
   Running PowerShell without administrator privileges will cause the installation to fail. See How to make sure I am using PowerShell as administrator.
   :::

3. When prompted with security warning, type R and press Enter to run the script once. The installation process for Olares will start.

   powershell{4} Copy

   Security warning
   Run only scripts that you trust. While scripts from the internet can be useful, this script can potentially harm your computer. If you trust this script, use the Unblock-File cmdlet to allow the script to run without this warning message. Do you want to run
   publicInstall.latest.ps1?
   [D] Do not run [R] Run once [S] Suspend [?] Help (default is "D"):

4. When prompted to select the drive to store the WSL Ubuntu distro, type the drive letter of an available disk. Ensure the selected drive has at least 80 GB of free space.

   powershell{8} Copy

   Installing Olares will create a WSL Ubuntu Distro and occupy at least 80 GB of disk space.
   Please select the drive where you want to install it.
   
   Available drives and free space:
   C:\  Free Disk: 391.07 GB
   D:\  Free Disk: 281.32 GB
   
   Please enter the drive letter (e.g., C):

5. When prompted with the firewall rules setup, type yes to automatically configure them, or type no to skip this step.
   If you choose to skip, either disable Windows Firewall Defender, or manually add TCP inbound rules.

   powershell{2} Copy

   Accessing Olares requires setting up firewall rules, specifically adding TCP inbound rules for ports 80, 443, and 30180.
   Do you want to set up the firewall rules? (yes/no):

6. When promoted to confirm the IP address of Windows, type Y to confirm, or R to re-enter.

   powershell Copy

   The NAT gateway (the Windows host)'s IP is 192.168.50.136. Confirm [Y] or Re-enter [R]?

   ::: tip Obtain the IPv4 address of Windows
   You can get the IPv4 address in advance by running ipconfig in the Windows command line.
   :::

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

wsl --unregister ubuntu

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

FAQ Copy Chapter

How to make sure I am using PowerShell as administrator? Copy Section

You can confirm that PowerShell is running as an administrator if you see "Administrator: Windows PowerShell" in the title bar of the PowerShell window.

{width=70%}

If not, use one of the following methods:

• Search for "PowerShell" in the Start menu, right-click it, and select Run as administrator.
• Or press Win + R, type powershell, and press Ctrl + Shift + Enter to open PowerShell as an administrator.

How to configure the CPU and memory for WLS? Copy Section

When installing Olares in WSL, the default memory allocation is 12GB. But you can configure the memory before Olares installation, or adjust both memory and CPU settings after installation.

Adjust the memory setting before installation

For example, to allocate 16GB of memory:

1. Add a user variable with the following:

   • Variable name: WSL_MEMORY
   • Variable value: 16

2. Click OK to apply changes.

   :::tip
   If you already have a PowerShell window open, changes to environment variables will not take effect in the current session. To ensure the updated environment variables are loaded, open a new PowerShell terminal as administrator, and then run the installation script.
   :::

Adjust memory and CPU settings after installation

After installation, a configuration file named .wslconfig will be created in the current user's home directory (C:\Users\<YourUsername>\). This file allows you to adjust memory and CPU settings. The default configuration looks like this:

[wsl2]
memory=12GB
swap=0GB

For example, to use 4 CPU cores:

1. Add the processors parameter to the file:
   bash Copy

   [wsl2]
   memory=12GB
   processors=4
   swap=0GB

2. Save the .wslconfig file with your custom changes.
3. Close all running virtual machines by running the following command in PowerShell:
   powershell Copy

   wsl --shutdown

4. Restart Olares by running:
   powershell Copy

   wsl -d Ubuntu

It will take a few minutes for Olares services to restart.

How to reactivate Olares after the PC restarts? Copy Section

Run the following command in PowerShell to restart the Olares service:

wsl -d Ubuntu

How to disable Windows Defender Firewall? Copy Section

:::tip
You can turn on Windows Defender Firewall when the Olares installation completes.
:::
To completely disable the firewall:

1. Open Control Panel > System and Security > Windows Defender Firewall.
2. In the navigation pane, click Turn Windows Defender Firewall on or off.
3. Select Turn off Windows Defender Firewall for both private and public networks, then click OK.

How to manually set firewall rules? Copy Section

If you choose not to configure firewall rules during installation, follow these steps to set them manually:

1. Open Control Panel > System and Security > Windows Defender Firewall.

2. In the navigation pane, select Advanced settings.

3. In the navigation pane, right-click Inbound Rules and select New Rule.

4. In the New Inbound Rule Wizard, select Port and click Next.

5. In Specific local ports, enter 80, 443, 30180, and click Next.

6. Select Allow the connection and click Next.

7. Confirm the rules apply to Domain, Private, and Public, then click Next.

8. Provide a name for the rule and click Finish.

How to uninstall Olares? Copy Section

Run the following command in PowerShell: