rebrand docs content for beOS Pro
This commit is contained in:
88
README_CN.md
88
README_CN.md
@@ -1,16 +1,16 @@
|
||||
<div align="center">
|
||||
|
||||
# Olares：助您重获数据主权的开源个人云
|
||||
# beOS Pro：助您重获数据主权的开源个人云
|
||||
|
||||
[](#)<br/>
|
||||
[](https://github.com/beclab/olares/commits/main)
|
||||
[](https://github.com/beclab/olares/commits/main)
|
||||
|
||||
[](https://github.com/beclab/olares/releases)
|
||||
[](https://github.com/beclab/Olares/stargazers)
|
||||
[](https://github.com/beclab/olares/releases)
|
||||
[](https://github.com/beclab/beOS Pro/stargazers)
|
||||
[](https://discord.gg/olares)
|
||||
[](https://github.com/beclab/olares/blob/main/LICENSE)
|
||||
|
||||
<a href="https://trendshift.io/repositories/15376" target="_blank"><img src="https://trendshift.io/api/badge/repositories/15376" alt="beclab%2FOlares | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||||
<a href="https://trendshift.io/repositories/15376" target="_blank"><img src="https://trendshift.io/api/badge/repositories/15376" alt="beclab%2FbeOS Pro | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||||
|
||||
<p>
|
||||
<a href="./README.md"><img alt="Readme in English" src="https://img.shields.io/badge/English-FFFFFF"></a>
|
||||
@@ -21,46 +21,46 @@
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://olares.com">网站</a> ·
|
||||
<a href="https://docs.olares.com">文档</a> ·
|
||||
<a href="https://www.olares.cn/larepass">下载 LarePass</a> ·
|
||||
<a href="https://github.com/beclab/apps">Olares 应用</a> ·
|
||||
<a href="https://space.olares.com">Olares Space</a>
|
||||
<a href="https://beos.local">网站</a> ·
|
||||
<a href="https://docs.beos.local">文档</a> ·
|
||||
<a href="https://www.beos.local/larepass">下载 beOS Pro app</a> ·
|
||||
<a href="https://github.com/beclab/apps">beOS Pro 应用</a> ·
|
||||
<a href="https://space.beos.local">Remote Space</a>
|
||||
</p>
|
||||
|
||||
> *基于公有云构建的现代互联网日益威胁着您的个人数据隐私。随着您对 ChatGPT、Midjourney 和脸书等服务的依赖加深，您对数字自主权的掌控也在减弱。您的数据存储在他人服务器上，受其条款约束，被追踪并审查。*
|
||||
>
|
||||
> *是时候做出改变了。*
|
||||
|
||||
|
||||
|
||||
|
||||
我们坚信，**您拥有掌控自己数字生活的基本权利**。维护这一权利最有效的方式，就是将您的数据托管在本地，在您自己的硬件上。
|
||||
|
||||
Olares 是一款开源个人云操作系统，旨在让您能够轻松在本地拥有并管理自己的数字资产。您无需再依赖公有云服务，而可以在 Olares 上本地部署强大的开源平替服务或应用，例如可以使用 Ollama 托管大语言模型，使用 ComfyUI 生成图像，以及使用 Perplexica 打造本地化、注重隐私的 AI 搜索与问答体验。Olares 让您坐拥云计算的强大威力，又能完全将其置于自己掌控之下。
|
||||
beOS Pro 是一款开源个人云操作系统，旨在让您能够轻松在本地拥有并管理自己的数字资产。您无需再依赖公有云服务，而可以在 beOS Pro 上本地部署强大的开源平替服务或应用，例如可以使用 Ollama 托管大语言模型，使用 ComfyUI 生成图像，以及使用 Perplexica 打造本地化、注重隐私的 AI 搜索与问答体验。beOS Pro 让您坐拥云计算的强大威力，又能完全将其置于自己掌控之下。
|
||||
|
||||
> 为 Olares 点亮 🌟 以及时获取新版本和更新的通知。
|
||||
> 为 beOS Pro 点亮 🌟 以及时获取新版本和更新的通知。
|
||||
|
||||
## 系统架构
|
||||
|
||||
公有云具有基础设施即服务（IaaS）、平台即服务（PaaS）和软件即服务（SaaS）等层级。Olares 为这些层级提供了开源替代方案。
|
||||
公有云具有基础设施即服务（IaaS）、平台即服务（PaaS）和软件即服务（SaaS）等层级。beOS Pro 为这些层级提供了开源替代方案。
|
||||
|
||||
|
||||
|
||||
|
||||
详细描述请参考 [Olares 架构](https://docs.olares.cn/zh/developer/concepts/system-architecture.html)文档。
|
||||
详细描述请参考 [beOS Pro 架构](https://docs.beos.local/zh/developer/concepts/system-architecture.html)文档。
|
||||
|
||||
>🔍**Olares 和 NAS 有什么不同？**
|
||||
>🔍**beOS Pro 和 NAS 有什么不同？**
|
||||
>
|
||||
> Olares 致力于打造一站式的自托管个人云体验。其核心功能与用户定位，均与专注于网络存储的传统 NAS 有着显著的不同，详情请参考 [Olares 与 NAS 对比](https://blog.olares.com/compare-olares-and-nas/)。
|
||||
> beOS Pro 致力于打造一站式的自托管个人云体验。其核心功能与用户定位，均与专注于网络存储的传统 NAS 有着显著的不同，详情请参考 [beOS Pro 与 NAS 对比](https://blog.beos.local/compare-olares-and-nas/)。
|
||||
|
||||
|
||||
## 功能特性
|
||||
|
||||
Olares 提供了一系列功能，旨在提升安全性、使用便捷性以及开发的灵活性：
|
||||
beOS Pro 提供了一系列功能，旨在提升安全性、使用便捷性以及开发的灵活性：
|
||||
|
||||
- **企业级安全**：使用 Tailscale、Headscale、Cloudflare Tunnel 和 FRP 简化网络配置，确保安全连接。
|
||||
- **安全且无需许可的应用生态系统**：应用通过沙箱化技术实现隔离，保障应用运行的安全性。
|
||||
- **统一文件系统和数据库**：提供自动扩展、数据备份和高可用性功能，确保数据的持久安全。
|
||||
- **单点登录**：用户仅需一次登录，即可访问 Olares 中所有应用的共享认证服务。
|
||||
- **单点登录**：用户仅需一次登录，即可访问 beOS Pro 中所有应用的共享认证服务。
|
||||
- **AI 功能**：包括全面的 GPU 管理、本地 AI 模型托管及私有知识库，同时严格保护数据隐私。
|
||||
- **内置应用程序**：涵盖文件管理器、同步驱动器、密钥管理器、阅读器、应用市场、设置和面板等，提供全面的应用支持。
|
||||
- **无缝访问**：通过移动端、桌面端和网页浏览器客户端，从全球任何地方访问设备。
|
||||
@@ -70,19 +70,19 @@ Olares 提供了一系列功能，旨在提升安全性、使用便捷性以及
|
||||
|
||||
| **桌面：熟悉高效的访问入口** | **文件管理器：安全存储数据**
|
||||
| :--------: | :-------: |
|
||||
|  |  |
|
||||
|  |  |
|
||||
| **Vault：密码无忧管理**|**市场：可控的应用生态系统** |
|
||||
|  |  |
|
||||
|**Wise：数字后花园** | **设置：高效管理 Olares** |
|
||||
|  |  |
|
||||
|**仪表盘：持续监控 Olares** | **Profile：独特的个人主页** |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|**Wise：数字后花园** | **设置：高效管理 beOS Pro** |
|
||||
|  |  |
|
||||
|**仪表盘：持续监控 beOS Pro** | **Profile：独特的个人主页** |
|
||||
|  |  |
|
||||
| **Studio：一站式开发、调试和部署**|**控制面板：轻松管理 Kubernetes 集群** |
|
||||
|  | |
|
||||
|  | |
|
||||
|
||||
## 使用场景
|
||||
|
||||
在以下场景中，Olares 为您带来私密、强大且安全的私有云体验：
|
||||
在以下场景中，beOS Pro 为您带来私密、强大且安全的私有云体验：
|
||||
|
||||
🤖**本地 AI 助手**：在本地部署运行顶级开源 AI 模型，涵盖语言处理、图像生成和语音识别等领域。根据个人需求定制 AI 助手，确保数据隐私和控制权均处于自己手中。<br>
|
||||
|
||||
@@ -94,7 +94,7 @@ Olares 提供了一系列功能，旨在提升安全性、使用便捷性以及
|
||||
|
||||
🏡**智能家居中心**：将所有智能设备和自动化系统集中在一个易于管理的控制中心，实现家庭智能化的简便操作。<br>
|
||||
|
||||
🤝**独立的社交媒体平台**：在 Olares 上部署去中心化社交媒体应用，如 Mastodon、Ghost 和 WordPress，自由建立和扩展个人品牌，无需担忧封号或支付额外费用。<br>
|
||||
🤝**独立的社交媒体平台**：在 beOS Pro 上部署去中心化社交媒体应用，如 Mastodon、Ghost 和 WordPress，自由建立和扩展个人品牌，无需担忧封号或支付额外费用。<br>
|
||||
|
||||
📚**学习探索**：深入学习自托管服务、容器技术和云计算，并上手实践。<br>
|
||||
|
||||
@@ -102,23 +102,23 @@ Olares 提供了一系列功能，旨在提升安全性、使用便捷性以及
|
||||
|
||||
### 系统兼容性
|
||||
|
||||
Olares 已在以下 Linux 平台完成测试与验证：
|
||||
beOS Pro 已在以下 Linux 平台完成测试与验证：
|
||||
|
||||
- Ubuntu 24.04 LTS 及以上版本
|
||||
- Debian 11 及以上版本
|
||||
|
||||
### 安装 Olares
|
||||
### 安装 beOS Pro
|
||||
|
||||
参考[快速上手指南](https://docs.olares.cn/zh/manual/get-started/)安装并激活 Olares。
|
||||
参考[快速上手指南](https://docs.beos.local/zh/manual/get-started/)安装并激活 beOS Pro。
|
||||
|
||||
## 项目目录
|
||||
Olares 代码库中的主要目录如下：
|
||||
beOS Pro 代码库中的主要目录如下：
|
||||
|
||||
* **[`apps`](./apps)**: 用于存放系统应用，主要是 `larepass` 的代码。
|
||||
* **[`cli`](./cli)**: 用于存放 `olares-cli`（Olares 的命令行界面工具）的代码。
|
||||
* **[`cli`](./cli)**: 用于存放 `olares-cli`（beOS Pro 的命令行界面工具）的代码。
|
||||
* **[`daemon`](./daemon)**: 用于存放 `olaresd`（系统守护进程）的代码。
|
||||
* **[`docs`**](./docs)**: 用于存放 Olares 项目的文档。
|
||||
* **[`framework`](./framework)**: 用来存放 Olares 系统服务代码。
|
||||
* **[`docs`**](./docs)**: 用于存放 beOS Pro 项目的文档。
|
||||
* **[`framework`](./framework)**: 用来存放 beOS Pro 系统服务代码。
|
||||
* **[`infrastructure`](./infrastructure)**: 用于存放计算，存储，网络，GPU 等基础设施的代码。
|
||||
* **[`platform`](./platform)**: 用于存放数据库、消息队列等云原生组件的代码。
|
||||
* **`vendor`**: 用于存放来自第三方硬件供应商的代码。
|
||||
@@ -127,19 +127,19 @@ Olares 代码库中的主要目录如下：
|
||||
|
||||
我们欢迎任何形式的贡献！
|
||||
|
||||
- 如果您想在 Olares 上开发自己的应用，请参考：<br>
|
||||
https://docs.olares.com/developer/develop/
|
||||
- 如果您想在 beOS Pro 上开发自己的应用，请参考：<br>
|
||||
https://docs.beos.local/developer/develop/
|
||||
|
||||
|
||||
- 如果您想帮助改进 Olares，请参考：<br>
|
||||
https://docs.olares.com/developer/contribute/olares.html
|
||||
- 如果您想帮助改进 beOS Pro，请参考：<br>
|
||||
https://docs.beos.local/developer/contribute/olares.html
|
||||
|
||||
## 社区支持
|
||||
|
||||
* [**GitHub Discussion**](https://github.com/beclab/olares/discussions) - 讨论 Olares 使用过程中的疑问。
|
||||
* [**GitHub Issues**](https://github.com/beclab/olares/issues) - 报告 Olares 的遇到的问题或提出功能改进建议。
|
||||
* [**Discord**](https://discord.gg/olares) - 日常交流，分享经验，或讨论与 Olares 相关的任何主题。
|
||||
* [**GitHub Discussion**](https://github.com/beclab/olares/discussions) - 讨论 beOS Pro 使用过程中的疑问。
|
||||
* [**GitHub Issues**](https://github.com/beclab/olares/issues) - 报告 beOS Pro 的遇到的问题或提出功能改进建议。
|
||||
* [**Discord**](https://discord.gg/olares) - 日常交流，分享经验，或讨论与 beOS Pro 相关的任何主题。
|
||||
|
||||
## 特别感谢
|
||||
|
||||
Olares 项目整合了许多第三方开源项目，包括：[Kubernetes](https://kubernetes.io/)、[Kubesphere](https://github.com/kubesphere/kubesphere)、[Padloc](https://padloc.app/)、[K3S](https://k3s.io/)、[JuiceFS](https://github.com/juicedata/juicefs)、[MinIO](https://github.com/minio/minio)、[Envoy](https://github.com/envoyproxy/envoy)、[Authelia](https://github.com/authelia/authelia)、[Infisical](https://github.com/Infisical/infisical)、[Dify](https://github.com/langgenius/dify)、[Seafile](https://github.com/haiwen/seafile)、[HeadScale](https://headscale.net/)、 [tailscale](https://tailscale.com/)、[Redis Operator](https://github.com/spotahome/redis-operator)、[Nitro](https://nitro.jan.ai/)、[RssHub](http://rsshub.app/)、[predixy](https://github.com/joyieldInc/predixy)、[nvshare](https://github.com/grgalex/nvshare)、[LangChain](https://www.langchain.com/)、[Quasar](https://quasar.dev/)、[TrustWallet](https://trustwallet.com/)、[Restic](https://restic.net/)、[ZincSearch](https://zincsearch-docs.zinc.dev/)、[filebrowser](https://filebrowser.org/)、[lego](https://go-acme.github.io/lego/)、[Velero](https://velero.io/)、[s3rver](https://github.com/jamhall/s3rver)、[Citusdata](https://www.citusdata.com/)。
|
||||
beOS Pro 项目整合了许多第三方开源项目，包括：[Kubernetes](https://kubernetes.io/)、[Kubesphere](https://github.com/kubesphere/kubesphere)、[Padloc](https://padloc.app/)、[K3S](https://k3s.io/)、[JuiceFS](https://github.com/juicedata/juicefs)、[MinIO](https://github.com/minio/minio)、[Envoy](https://github.com/envoyproxy/envoy)、[Authelia](https://github.com/authelia/authelia)、[Infisical](https://github.com/Infisical/infisical)、[Dify](https://github.com/langgenius/dify)、[Seafile](https://github.com/haiwen/seafile)、[HeadScale](https://headscale.net/)、 [tailscale](https://tailscale.com/)、[Redis Operator](https://github.com/spotahome/redis-operator)、[Nitro](https://nitro.jan.ai/)、[RssHub](http://rsshub.app/)、[predixy](https://github.com/joyieldInc/predixy)、[nvshare](https://github.com/grgalex/nvshare)、[LangChain](https://www.langchain.com/)、[Quasar](https://quasar.dev/)、[TrustWallet](https://trustwallet.com/)、[Restic](https://restic.net/)、[ZincSearch](https://zincsearch-docs.zinc.dev/)、[filebrowser](https://filebrowser.org/)、[lego](https://go-acme.github.io/lego/)、[Velero](https://velero.io/)、[s3rver](https://github.com/jamhall/s3rver)、[Citusdata](https://www.citusdata.com/)。
|
||||
|
||||
86
README_JP.md
86
README_JP.md
@@ -1,16 +1,16 @@
|
||||
<div align="center">
|
||||
|
||||
# Olares: ローカルAIのためのオープンソース主権クラウドOS<!-- omit in toc -->
|
||||
# beOS Pro: ローカルAIのためのオープンソース主権クラウドOS<!-- omit in toc -->
|
||||
|
||||
[](#)<br/>
|
||||
[](https://github.com/beclab/olares/commits/main)
|
||||
[](https://github.com/beclab/olares/commits/main)
|
||||
|
||||
[](https://github.com/beclab/olares/releases)
|
||||
[](https://github.com/beclab/Olares/stargazers)
|
||||
[](https://github.com/beclab/olares/releases)
|
||||
[](https://github.com/beclab/beOS Pro/stargazers)
|
||||
[](https://discord.gg/olares)
|
||||
[](https://github.com/beclab/olares/blob/main/LICENSE)
|
||||
|
||||
<a href="https://trendshift.io/repositories/15376" target="_blank"><img src="https://trendshift.io/api/badge/repositories/15376" alt="beclab%2FOlares | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||||
<a href="https://trendshift.io/repositories/15376" target="_blank"><img src="https://trendshift.io/api/badge/repositories/15376" alt="beclab%2FbeOS Pro | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||||
|
||||
<p>
|
||||
<a href="./README.md"><img alt="Readme in English" src="https://img.shields.io/badge/English-FFFFFF"></a>
|
||||
@@ -21,44 +21,44 @@
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://olares.com">ウェブサイト</a> ·
|
||||
<a href="https://docs.olares.com">ドキュメント</a> ·
|
||||
<a href="https://www.olares.com/larepass">LarePassをダウンロード</a> ·
|
||||
<a href="https://github.com/beclab/apps">Olaresアプリ</a> ·
|
||||
<a href="https://space.olares.com">Olares Space</a>
|
||||
<a href="https://beos.local">ウェブサイト</a> ·
|
||||
<a href="https://docs.beos.local">ドキュメント</a> ·
|
||||
<a href="https://www.beos.local/larepass">beOS Pro appをダウンロード</a> ·
|
||||
<a href="https://github.com/beclab/apps">beOS Proアプリ</a> ·
|
||||
<a href="https://space.beos.local">Remote Space</a>
|
||||
</p>
|
||||
|
||||
> *パブリッククラウドを基盤とする現代のインターネットは、あなたの個人データのプライバシーをますます脅かしています。ChatGPT、Midjourney、Facebookといったサービスへの依存が深まるにつれ、デジタル主権に対するあなたのコントロールも弱まっています。あなたのデータは他者のサーバーに保存され、その利用規約に縛られ、追跡され、検閲されているのです。*
|
||||
>
|
||||
>*今こそ、変革の時です。*
|
||||
|
||||
|
||||
|
||||
|
||||
私たちは、あなたが自身のデジタルライフをコントロールする基本的な権利を有すると確信しています。この権利を守る最も効果的な方法は、あなたのデータをローカルの、あなた自身のハードウェア上でホストすることです。
|
||||
|
||||
Olaresは、あなたが自身のデジタル資産をローカルで所有し管理できるように設計された、オープンソースのパーソナルクラウドOSです。パブリッククラウドサービスに依存する代わりに、Olares上で強力なオープンソースの代替をローカルにデプロイできます。例えば、LLMのホスティングにはOllama、画像生成にはComfyUI、そしてプライバシーを重視したAI駆動の検索と推論にはPerplexicaを利用できます。クラウドの力をそのままに、主導権は常にあなたの手に。
|
||||
beOS Proは、あなたが自身のデジタル資産をローカルで所有し管理できるように設計された、オープンソースのパーソナルクラウドOSです。パブリッククラウドサービスに依存する代わりに、beOS Pro上で強力なオープンソースの代替をローカルにデプロイできます。例えば、LLMのホスティングにはOllama、画像生成にはComfyUI、そしてプライバシーを重視したAI駆動の検索と推論にはPerplexicaを利用できます。クラウドの力をそのままに、主導権は常にあなたの手に。
|
||||
> 🌟 *新しいリリースや更新についての通知を受け取るために、スターを付けてください。*
|
||||
|
||||
## アーキテクチャ
|
||||
|
||||
パブリッククラウドは、IaaS (Infrastructure as a Service)、PaaS (Platform as a Service)、SaaS (Software as a Service) といったサービスレイヤーで構成されています。Olaresは、これら各レイヤーに対するオープンソースの代替ソリューションを提供しています。
|
||||
パブリッククラウドは、IaaS (Infrastructure as a Service)、PaaS (Platform as a Service)、SaaS (Software as a Service) といったサービスレイヤーで構成されています。beOS Proは、これら各レイヤーに対するオープンソースの代替ソリューションを提供しています。
|
||||
|
||||
|
||||
|
||||
|
||||
各コンポーネントの詳細については、[Olares アーキテクチャ](https://docs.olares.com/developer/concepts/system-architecture.html)（英語版）をご参照ください。
|
||||
各コンポーネントの詳細については、[beOS Pro アーキテクチャ](https://docs.beos.local/developer/concepts/system-architecture.html)（英語版）をご参照ください。
|
||||
|
||||
> 🔍**OlaresとNASの違いは何ですか？**
|
||||
> 🔍**beOS ProとNASの違いは何ですか？**
|
||||
>
|
||||
> Olaresは、ワンストップのセルフホスティング・パーソナルクラウド体験の実現を目指しています。そのコア機能とユーザーの位置付けは、ネットワークストレージに特化した従来のNASとは大きく異なります。詳細は、[OlaresとNASの比較](https://blog.olares.com/compare-olares-and-nas/)（英語版）をご参照ください。
|
||||
> beOS Proは、ワンストップのセルフホスティング・パーソナルクラウド体験の実現を目指しています。そのコア機能とユーザーの位置付けは、ネットワークストレージに特化した従来のNASとは大きく異なります。詳細は、[beOS ProとNASの比較](https://blog.beos.local/compare-olares-and-nas/)（英語版）をご参照ください。
|
||||
|
||||
## 機能
|
||||
|
||||
Olaresは、セキュリティ、使いやすさ、開発の柔軟性を向上させるための幅広い機能を提供します：
|
||||
beOS Proは、セキュリティ、使いやすさ、開発の柔軟性を向上させるための幅広い機能を提供します：
|
||||
|
||||
- **エンタープライズグレードのセキュリティ**: Tailscale、Headscale、Cloudflare Tunnel、FRPを使用してネットワーク構成を簡素化します。
|
||||
- **安全で許可のないアプリケーションエコシステム**: サンドボックス化によりアプリケーションの分離とセキュリティを確保します。
|
||||
- **統一ファイルシステムとデータベース**: 自動スケーリング、バックアップ、高可用性を提供します。
|
||||
- **シングルサインオン**: 一度ログインするだけで、Olares内のすべてのアプリケーションに共有認証サービスを使用してアクセスできます。
|
||||
- **シングルサインオン**: 一度ログインするだけで、beOS Pro内のすべてのアプリケーションに共有認証サービスを使用してアクセスできます。
|
||||
- **AI機能**: GPU管理、ローカルAIモデルホスティング、プライベートナレッジベースの包括的なソリューションを提供し、データプライバシーを維持します。
|
||||
- **内蔵アプリケーション**: ファイルマネージャー、同期ドライブ、ボールト、リーダー、アプリマーケット、設定、ダッシュボードを含みます。
|
||||
- **どこからでもシームレスにアクセス**: モバイル、デスクトップ、ブラウザ用の専用クライアントを使用して、どこからでもデバイスにアクセスできます。
|
||||
@@ -68,19 +68,19 @@ Olaresは、セキュリティ、使いやすさ、開発の柔軟性を向上
|
||||
|
||||
| **デスクトップ：馴染みやすく効率的なアクセスポイント** | **ファイルマネージャー：データを安全に保管** |
|
||||
| :--------: | :-------: |
|
||||
|  |  |
|
||||
|  |  |
|
||||
| **Vault：安心のパスワード管理**|**マーケット：コントロール可能なアプリエコシステム** |
|
||||
|  |  |
|
||||
| **Wise：あなただけのデジタルガーデン** | **設定：Olaresを効率的に管理** |
|
||||
|  |  |
|
||||
| **ダッシュボード：Olaresを継続的に監視** | **プロフィール：ユニークなパーソナルページ** |
|
||||
|  |  |
|
||||
|  |  |
|
||||
| **Wise：あなただけのデジタルガーデン** | **設定：beOS Proを効率的に管理** |
|
||||
|  |  |
|
||||
| **ダッシュボード：beOS Proを継続的に監視** | **プロフィール：ユニークなパーソナルページ** |
|
||||
|  |  |
|
||||
| **Studio：開発、デバッグ、デプロイをワンストップで**|**コントロールパネル：Kubernetesクラスターを簡単に管理** |
|
||||
|  | |
|
||||
|  | |
|
||||
|
||||
## なぜOlaresなのか？
|
||||
## なぜbeOS Proなのか？
|
||||
|
||||
以下の理由とシナリオで、Olaresはプライベートで強力かつ安全な主権クラウド体験を提供します：
|
||||
以下の理由とシナリオで、beOS Proはプライベートで強力かつ安全な主権クラウド体験を提供します：
|
||||
|
||||
🤖 **エッジAI**: 最先端のオープンAIモデルをローカルで実行し、大規模言語モデル、コンピュータビジョン、音声認識などを含みます。データに合わせてプライベートAIサービスを作成し、機能性とプライバシーを向上させます。<br>
|
||||
|
||||
@@ -92,7 +92,7 @@ Olaresは、セキュリティ、使いやすさ、開発の柔軟性を向上
|
||||
|
||||
🏡 **スマートホームハブ**: IoTデバイスやホームオートメーションの中央制御ポイントを作成します。<br>
|
||||
|
||||
🤝 **ユーザー所有の分散型ソーシャルメディア**: Mastodon、Ghost、WordPressなどの分散型ソーシャルメディアアプリをOlaresに簡単にインストールし、プラットフォームの手数料やアカウント停止のリスクなしに個人ブランドを構築します。<br>
|
||||
🤝 **ユーザー所有の分散型ソーシャルメディア**: Mastodon、Ghost、WordPressなどの分散型ソーシャルメディアアプリをbeOS Proに簡単にインストールし、プラットフォームの手数料やアカウント停止のリスクなしに個人ブランドを構築します。<br>
|
||||
|
||||
📚 **学習プラットフォーム**: セルフホスティング、コンテナオーケストレーション、クラウド技術を実践的に学びます。
|
||||
|
||||
@@ -100,44 +100,44 @@ Olaresは、セキュリティ、使いやすさ、開発の柔軟性を向上
|
||||
|
||||
### システム互換性
|
||||
|
||||
Olaresは以下のLinuxプラットフォームで動作検証を完了しています：
|
||||
beOS Proは以下のLinuxプラットフォームで動作検証を完了しています：
|
||||
|
||||
- Ubuntu 24.04 LTS 以降
|
||||
- Debian 11 以降
|
||||
|
||||
### Olaresのセットアップ
|
||||
自分のデバイスでOlaresを始めるには、[はじめにガイド](https://docs.olares.com/manual/get-started/)に従ってステップバイステップの手順を確認してください。
|
||||
### beOS Proのセットアップ
|
||||
自分のデバイスでbeOS Proを始めるには、[はじめにガイド](https://docs.beos.local/manual/get-started/)に従ってステップバイステップの手順を確認してください。
|
||||
|
||||
|
||||
## プロジェクトナビゲーションx
|
||||
このセクションでは、Olares リポジトリ内の主要なディレクトリをリストアップしています：
|
||||
このセクションでは、beOS Pro リポジトリ内の主要なディレクトリをリストアップしています：
|
||||
|
||||
* **[`apps`](./apps)**: システムアプリケーションのコードが含まれており、主に `larepass` 用です。
|
||||
* **[`cli`](./cli)**: Olares のコマンドラインインターフェースツールである `olares-cli` のコードが含まれています。
|
||||
* **[`cli`](./cli)**: beOS Pro のコマンドラインインターフェースツールである `olares-cli` のコードが含まれています。
|
||||
* **[`daemon`](./daemon)**: システムデーモンプロセスである `olaresd` のコードが含まれています。
|
||||
* **[`docs`](./docs)**: プロジェクトのドキュメントが含まれています。
|
||||
* **[`framework`](./framework)**: Olares システムサービスが含まれています。
|
||||
* **[`framework`](./framework)**: beOS Pro システムサービスが含まれています。
|
||||
* **[`infrastructure`](./infrastructure)**: コンピューティング、ストレージ、ネットワーキング、GPU などのインフラストラクチャコンポーネントに関連するコードが含まれています。
|
||||
* **[`platform`](./platform)**: データベースやメッセージキューなどのクラウドネイティブコンポーネントのコードが含まれています。
|
||||
* **`vendor`**: サードパーティのハードウェアベンダーからのコードが含まれています。
|
||||
|
||||
## Olaresへの貢献
|
||||
## beOS Proへの貢献
|
||||
|
||||
あらゆる形での貢献を歓迎します：
|
||||
|
||||
- Olaresで独自のアプリケーションを開発したい場合は、以下を参照してください：<br>
|
||||
https://docs.olares.com/developer/develop/
|
||||
- beOS Proで独自のアプリケーションを開発したい場合は、以下を参照してください：<br>
|
||||
https://docs.beos.local/developer/develop/
|
||||
|
||||
|
||||
- Olaresの改善に協力したい場合は、以下を参照してください：<br>
|
||||
https://docs.olares.com/developer/contribute/olares.html
|
||||
- beOS Proの改善に協力したい場合は、以下を参照してください：<br>
|
||||
https://docs.beos.local/developer/contribute/olares.html
|
||||
|
||||
## コミュニティと連絡先
|
||||
|
||||
* [**GitHub Discussion**](https://github.com/beclab/olares/discussions). フィードバックの共有や質問に最適です。
|
||||
* [**GitHub Issues**](https://github.com/beclab/olares/issues). Olaresの使用中に遭遇したバグの報告や機能提案の提出に最適です。
|
||||
* [**Discord**](https://discord.gg/olares). Olaresに関するあらゆることを共有するのに最適です。
|
||||
* [**GitHub Issues**](https://github.com/beclab/olares/issues). beOS Proの使用中に遭遇したバグの報告や機能提案の提出に最適です。
|
||||
* [**Discord**](https://discord.gg/olares). beOS Proに関するあらゆることを共有するのに最適です。
|
||||
|
||||
## 特別な感謝
|
||||
|
||||
Olaresプロジェクトは、次のような多数のサードパーティオープンソースプロジェクトを統合しています：[Kubernetes](https://kubernetes.io/)、[Kubesphere](https://github.com/kubesphere/kubesphere)、[Padloc](https://padloc.app/)、[K3S](https://k3s.io/)、[JuiceFS](https://github.com/juicedata/juicefs)、[MinIO](https://github.com/minio/minio)、[Envoy](https://github.com/envoyproxy/envoy)、[Authelia](https://github.com/authelia/authelia)、[Infisical](https://github.com/Infisical/infisical)、[Dify](https://github.com/langgenius/dify)、[Seafile](https://github.com/haiwen/seafile)、[HeadScale](https://headscale.net/)、 [tailscale](https://tailscale.com/)、[Redis Operator](https://github.com/spotahome/redis-operator)、[Nitro](https://nitro.jan.ai/)、[RssHub](http://rsshub.app/)、[predixy](https://github.com/joyieldInc/predixy)、[nvshare](https://github.com/grgalex/nvshare)、[LangChain](https://www.langchain.com/)、[Quasar](https://quasar.dev/)、[TrustWallet](https://trustwallet.com/)、[Restic](https://restic.net/)、[ZincSearch](https://zincsearch-docs.zinc.dev/)、[filebrowser](https://filebrowser.org/)、[lego](https://go-acme.github.io/lego/)、[Velero](https://velero.io/)、[s3rver](https://github.com/jamhall/s3rver)、[Citusdata](https://www.citusdata.com/)。
|
||||
beOS Proプロジェクトは、次のような多数のサードパーティオープンソースプロジェクトを統合しています：[Kubernetes](https://kubernetes.io/)、[Kubesphere](https://github.com/kubesphere/kubesphere)、[Padloc](https://padloc.app/)、[K3S](https://k3s.io/)、[JuiceFS](https://github.com/juicedata/juicefs)、[MinIO](https://github.com/minio/minio)、[Envoy](https://github.com/envoyproxy/envoy)、[Authelia](https://github.com/authelia/authelia)、[Infisical](https://github.com/Infisical/infisical)、[Dify](https://github.com/langgenius/dify)、[Seafile](https://github.com/haiwen/seafile)、[HeadScale](https://headscale.net/)、 [tailscale](https://tailscale.com/)、[Redis Operator](https://github.com/spotahome/redis-operator)、[Nitro](https://nitro.jan.ai/)、[RssHub](http://rsshub.app/)、[predixy](https://github.com/joyieldInc/predixy)、[nvshare](https://github.com/grgalex/nvshare)、[LangChain](https://www.langchain.com/)、[Quasar](https://quasar.dev/)、[TrustWallet](https://trustwallet.com/)、[Restic](https://restic.net/)、[ZincSearch](https://zincsearch-docs.zinc.dev/)、[filebrowser](https://filebrowser.org/)、[lego](https://go-acme.github.io/lego/)、[Velero](https://velero.io/)、[s3rver](https://github.com/jamhall/s3rver)、[Citusdata](https://www.citusdata.com/)。
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
# Olares documentation
|
||||
# beOS Pro documentation
|
||||
|
||||
Welcome to the source repository for the official Olares documentation!
|
||||
Welcome to the source repository for the official beOS Pro documentation!
|
||||
|
||||
This directory includes the source files for the Olares documentation website, instructions for setting up the project locally, Markdown references, and style guides to ensure consistency and quality across all documentation.
|
||||
This directory includes the source files for the beOS Pro documentation website, instructions for setting up the project locally, Markdown references, and style guides to ensure consistency and quality across all documentation.
|
||||
|
||||
## Quick links
|
||||
|
||||
* **Published documentation site**: https://docs.olares.com
|
||||
* **Olares official website**: https://www.olares.com
|
||||
* **Olares project on GitHub**: https://github.com/beclab/Olares
|
||||
* **Published documentation site**: https://docs.beos.local
|
||||
* **beOS Pro official website**: https://www.beos.local
|
||||
* **beOS Pro project on GitHub**: https://github.com/beclab/beOS Pro
|
||||
|
||||
## Getting started with Olares documentation
|
||||
## Getting started with beOS Pro documentation
|
||||
|
||||
We welcome community contributions! Follow these steps to preview, develop, and build the documentation locally.
|
||||
|
||||
@@ -47,13 +47,13 @@ This command will build the static site into the `dist` directory.
|
||||
To manage documentation for different product versions effectively, we use the following branching strategy:
|
||||
|
||||
* **`main` branch**:
|
||||
This branch contains the latest documentation for the **next, in-development version** of Olares. All documentation for new features should be submitted here.
|
||||
This branch contains the latest documentation for the **next, in-development version** of beOS Pro. All documentation for new features should be submitted here.
|
||||
|
||||
* **`release-{version}` branch**:
|
||||
These branches hold the documentation for **recent, stable versions**. For example, the `release-1.11` branch corresponds to the `Olares 1.11` documentation. Fixes or clarifications for a specific stable version should be submitted to its corresponding release branch.
|
||||
These branches hold the documentation for **recent, stable versions**. For example, the `release-1.11` branch corresponds to the `beOS Pro 1.11` documentation. Fixes or clarifications for a specific stable version should be submitted to its corresponding release branch.
|
||||
|
||||
Creating a PR to a corresponding branch will automatically trigger the documentation build for that version.
|
||||
|
||||
## Style guide
|
||||
|
||||
To ensure clarity, accuracy, and a consistent tone, please read our **[Content and style guide](https://github.com/beclab/Olares/wiki/General-style-reference)** before contributing.
|
||||
To ensure clarity, accuracy, and a consistent tone, please read our **[Content and style guide](https://github.com/beclab/beOS Pro/wiki/General-style-reference)** before contributing.
|
||||
@@ -1,45 +1,45 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Core principles of Olares account system, including synchronization mechanisms, account stages and unified authentication. Covers multi-factor authentication and multi-device sync fundamentals.
|
||||
description: Core principles of beOS Pro account system, including synchronization mechanisms, account stages and unified authentication. Covers multi-factor authentication and multi-device sync fundamentals.
|
||||
---
|
||||
|
||||
# Olares account
|
||||
# beOS Pro account
|
||||
|
||||
This document covers concepts and designs related to account system in Olares.
|
||||
This document covers concepts and designs related to account system in beOS Pro.
|
||||
|
||||
## Account synchronization
|
||||
|
||||
Accounts in LarePass, Olares, and Olares Space stay synchronized as described below:
|
||||
Accounts in beOS Pro app, beOS Pro, and Remote Space stay synchronized as described below:
|
||||
|
||||
- Creating an Olares requires providing an Olares ID and activate it using the LarePass logged in with that Olares ID.
|
||||
- To log into Olares Space, you need to scan a QR code with LarePass.
|
||||
- Creating an beOS Pro requires providing an beOS ID and activate it using the beOS Pro app logged in with that beOS ID.
|
||||
- To log into Remote Space, you need to scan a QR code with beOS Pro app.
|
||||
|
||||
## Understand the stage of account
|
||||
|
||||
Each account has three stages.
|
||||
|
||||
### Not bound to an Olares ID (DID stage)
|
||||
An unbound account represents the initial stage where you have basic credentials created locally. This includes your mnemonic phrase, private key, and DID, but no Olares ID yet.
|
||||
### Not bound to an beOS ID (DID stage)
|
||||
An unbound account represents the initial stage where you have basic credentials created locally. This includes your mnemonic phrase, private key, and DID, but no beOS ID yet.
|
||||
|
||||
During this stage, you can export and back up your mnemonic phrase and access Olares Space to request an organization domain name.
|
||||
During this stage, you can export and back up your mnemonic phrase and access Remote Space to request an organization domain name.
|
||||
|
||||
However, importing to other LarePass clients isn't possible at this point.
|
||||
However, importing to other beOS Pro app clients isn't possible at this point.
|
||||
:::tip
|
||||
In the LarePass app, when you tap **Create an account**, your account enters the DID stage.
|
||||
In the beOS Pro app app, when you tap **Create an account**, your account enters the DID stage.
|
||||
:::
|
||||
### Bound to an Olares ID
|
||||
When your account is bound to an Olares ID, the system records the connection between your Olares ID and DID on the blockchain.
|
||||
### Bound to an beOS ID
|
||||
When your account is bound to an beOS ID, the system records the connection between your beOS ID and DID on the blockchain.
|
||||
|
||||
This enables you to request and activate an Olares through Olares Space.
|
||||
This enables you to request and activate an beOS Pro through Remote Space.
|
||||
|
||||
At this stage, you gain the ability to import your account to other devices using your exported mnemonic phrase, supporting unified authentication across applications.
|
||||
|
||||
### Bound to an Olares
|
||||
The final stage occurs when your account is linked to an Olares device. This enables full participation in the Olares ecosystem, including monitoring system resources for your device.
|
||||
### Bound to an beOS Pro
|
||||
The final stage occurs when your account is linked to an beOS Pro device. This enables full participation in the beOS Pro ecosystem, including monitoring system resources for your device.
|
||||
|
||||
## Unified account system
|
||||
|
||||
Olares supports unified authentication for a multi-user system.
|
||||
beOS Pro supports unified authentication for a multi-user system.
|
||||
|
||||
1. After the user logs in on the login page, all future requests automatically include authentication details.
|
||||
2. Each user request first goes through the Authelia service for authentication.
|
||||
@@ -49,21 +49,21 @@ Olares supports unified authentication for a multi-user system.
|
||||
|
||||
## Multi-factor authentication (MFA)
|
||||
|
||||
Olares integrates a variety of authentication factors with different security levels to ensure the security of user identity authentication in the system.
|
||||
beOS Pro integrates a variety of authentication factors with different security levels to ensure the security of user identity authentication in the system.
|
||||
|
||||
### Password
|
||||
|
||||
When a user is first created, Olares generates a random password for initial setup. After completing identity verification, the user is prompted to replace this initial password with a stronger, custom password.
|
||||
When a user is first created, beOS Pro generates a random password for initial setup. After completing identity verification, the user is prompted to replace this initial password with a stronger, custom password.
|
||||
|
||||
### One-time password
|
||||
|
||||
When users perform sensitive operations such as login, Olares requires users to enter the one-time two-factor authentication code generated in LarePass.
|
||||
When users perform sensitive operations such as login, beOS Pro requires users to enter the one-time two-factor authentication code generated in beOS Pro app.
|
||||
|
||||
## Learn more
|
||||
|
||||
### Users
|
||||
|
||||
- [Create Olares ID](../../manual/get-started/create-olares-id.md)
|
||||
- [Create beOS ID](../../manual/get-started/create-olares-id.md)
|
||||
- [User roles and permissions](../../manual/olares/settings/roles-permissions.md)
|
||||
|
||||
### Developers
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Fundamental concepts of Olares application system, explaining application identifiers and characteristics of four application types such as cluster-scoped applications. Includes service provider mechanisms and application dependencies.
|
||||
description: Fundamental concepts of beOS Pro application system, explaining application identifiers and characteristics of four application types such as cluster-scoped applications. Includes service provider mechanisms and application dependencies.
|
||||
---
|
||||
|
||||
# Applications
|
||||
|
||||
This documents covers essential concepts for managing application identifiers, types, permissions, and Market integrations within Olares.
|
||||
This documents covers essential concepts for managing application identifiers, types, permissions, and Market integrations within beOS Pro.
|
||||
|
||||
## Application identifier
|
||||
|
||||
In Olares, each application is assigned two identifiers: an application name and an application ID.
|
||||
In beOS Pro, each application is assigned two identifiers: an application name and an application ID.
|
||||
|
||||
### Application name
|
||||
|
||||
Application names are assigned by Indexers. The official Indexer address maintained by Olares is [apps](https://github.com/beclab/apps). The directory name of an application within this repository serves as the application name.
|
||||
Application names are assigned by Indexers. The official Indexer address maintained by beOS Pro is [apps](https://github.com/beclab/apps). The directory name of an application within this repository serves as the application name.
|
||||
|
||||
### Application ID
|
||||
|
||||
@@ -23,11 +23,11 @@ Application IDs are utilized in endpoints.
|
||||
|
||||
## Application types
|
||||
|
||||
There are multiple types of applications in Olares. You can distinguish a specific application type according to the namespace shown in Control Hub.
|
||||
There are multiple types of applications in beOS Pro. You can distinguish a specific application type according to the namespace shown in Control Hub.
|
||||
|
||||
### System applications
|
||||
|
||||
System applications encompass Kubernetes, Kubesphere, Olares components, and essential hardware drivers. The system-level namespaces include:
|
||||
System applications encompass Kubernetes, Kubesphere, beOS Pro components, and essential hardware drivers. The system-level namespaces include:
|
||||
|
||||
```
|
||||
os-system
|
||||
@@ -42,11 +42,11 @@ kube-public
|
||||
kube-node-lease
|
||||
gpu-system
|
||||
```
|
||||
`os-system` is a component developed by Olares team. Cluster-level applications and various database middleware provided by the system are installed under this namespace.
|
||||
`os-system` is a component developed by beOS Pro team. Cluster-level applications and various database middleware provided by the system are installed under this namespace.
|
||||
|
||||
### User system applications
|
||||
|
||||
Olares supports multiple users and provides two distinct namespaces for system applications accessible to Admin and Member users:
|
||||
beOS Pro supports multiple users and provides two distinct namespaces for system applications accessible to Admin and Member users:
|
||||
|
||||
- **user-space-{Local Name}**
|
||||
|
||||
@@ -59,7 +59,7 @@ Olares supports multiple users and provides two distinct namespaces for system a
|
||||
- Profile
|
||||
- Vault
|
||||
|
||||
These applications interact with each other while also calling system-level interfaces (such as Kubernetes' `api-server` interface). To ensure system security, Olares deploys them in isolated user-space namespaces and uses sandbox mechanisms to prevent malicious program attacks and unauthorized access.
|
||||
These applications interact with each other while also calling system-level interfaces (such as Kubernetes' `api-server` interface). To ensure system security, beOS Pro deploys them in isolated user-space namespaces and uses sandbox mechanisms to prevent malicious program attacks and unauthorized access.
|
||||
|
||||
- **user-system-{Local Name}**
|
||||
|
||||
@@ -82,14 +82,14 @@ gitlab-client-bob
|
||||
|
||||
### Shared applications
|
||||
|
||||
A **shared application** is a special category of community applications on Olares designed to provide unified, shared resources or services to all users within an Olares cluster.
|
||||
A **shared application** is a special category of community applications on beOS Pro designed to provide unified, shared resources or services to all users within an beOS Pro cluster.
|
||||
|
||||
Key characteristics of shared applications include:
|
||||
|
||||
* **Centralized management**: Only administrators can install the core service of a shared application. Administrators are responsible for installing, configuring, and hosting the app's service, resources, and runtime environment within the cluster.
|
||||
* **Easy identification**: In Olares Market, shared applications are typically marked with a "Shared" label for easy identification.
|
||||
* **Easy identification**: In beOS Pro Market, shared applications are typically marked with a "Shared" label for easy identification.
|
||||
* **Flexible access**: The method for accessing a shared application depends on the app's form:
|
||||
* **Headless backend service**: For shared applications that typically run as a background service without a graphical UI (e.g., Ollama), no dedicated reference application is required. The service exposes standard APIs and shared entrances that can be directly consumed by any compatible third‑party client such as LobeChat and Open WebUI. Users install the client and point it to the shared app’s API endpoint found in the Olares **Settings** > **Applications** > **Entrances**.
|
||||
* **Headless backend service**: For shared applications that typically run as a background service without a graphical UI (e.g., Ollama), no dedicated reference application is required. The service exposes standard APIs and shared entrances that can be directly consumed by any compatible third‑party client such as LobeChat and Open WebUI. Users install the client and point it to the shared app’s API endpoint found in the beOS Pro **Settings** > **Applications** > **Entrances**.
|
||||
* **Complete application with built-in UI**: For shared applications that include a complete user interface and backend service themselves (e.g., ComfyUI Shared or Dify Shared), administrators and other users in the cluster can obtain the service access point by directly installing the shared application itself.
|
||||
|
||||
### Dependencies
|
||||
@@ -120,4 +120,4 @@ The mechanism consists of three procedures：
|
||||
|
||||
- Developer
|
||||
|
||||
[Learn to develop applications on Olares](../develop/index.md)<br>
|
||||
[Learn to develop applications on beOS Pro](../develop/index.md)<br>
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
description: Overview of Olares BEC architecture, explaining distributed node implementation for data storage and security. Details three core components Olares ID, Olares OS and LarePass.
|
||||
description: Overview of beOS Pro BEC architecture, explaining distributed node implementation for data storage and security. Details three core components beOS ID, beOS Pro and beOS Pro app.
|
||||
---
|
||||
# Architecture of Olares
|
||||
# Architecture of beOS Pro
|
||||
|
||||
Olares introduces a next-generation decentralized Internet framework through its Blockchain-Edge-Client (BEC) architecture. BEC decentralizes data storage and enhances security by distributing information across suitable platforms.
|
||||
beOS Pro introduces a next-generation decentralized Internet framework through its Blockchain-Edge-Client (BEC) architecture. BEC decentralizes data storage and enhances security by distributing information across suitable platforms.
|
||||
|
||||
|
||||
|
||||
@@ -11,13 +11,13 @@ Olares introduces a next-generation decentralized Internet framework through its
|
||||
- **Edge**: The decentralized web node for users, hosting personal data such as documents, chat logs, and photos on private edge servers. Data remains within the user’s control on the edge, ensuring privacy and local data sovereignty.
|
||||
- **Client**: The identity wallet app that ensures users can securely manage their identities and interact with their self-hosted systems while maintaining ownership and privacy over their digital credentials.
|
||||
|
||||
## Core components of Olares
|
||||
## Core components of beOS Pro
|
||||
|
||||
Corresponding to the BEC architecture, Olares comprises the following core components:
|
||||
Corresponding to the BEC architecture, beOS Pro comprises the following core components:
|
||||
|
||||
- [**Olares ID**](https://docs.snowinning.com/protocol/overview.html): A decentralized identity and reputation system that integrates decentralized identifiers (DIDs), verifiable credentials (VCs), and reputation data. It enhances trust by enabling transparent and verifiable interactions within decentralized environments.
|
||||
- [**Olares OS**](https://github.com/beclab/Olares): A comprehensive, self-hosted operating system designed for edge devices. It allows users to host and manage their own data and applications, transforming personal edge devices into robust, sovereign cloud systems.
|
||||
- [**LarePass**](https://www.olares.com/larepass): A secure, unified interface software that connects users to their Olares systems. It offers key functionalities, including identity management, remote access, device management, and data storage, ensuring seamless interactions with Olares.
|
||||
- [**beOS ID**](https://docs.snowinning.com/protocol/overview.html): A decentralized identity and reputation system that integrates decentralized identifiers (DIDs), verifiable credentials (VCs), and reputation data. It enhances trust by enabling transparent and verifiable interactions within decentralized environments.
|
||||
- [**beOS Pro**](https://github.com/beclab/beOS Pro): A comprehensive, self-hosted operating system designed for edge devices. It allows users to host and manage their own data and applications, transforming personal edge devices into robust, sovereign cloud systems.
|
||||
- [**beOS Pro app**](https://www.beos.local/larepass): A secure, unified interface software that connects users to their beOS Pro systems. It offers key functionalities, including identity management, remote access, device management, and data storage, ensuring seamless interactions with beOS Pro.
|
||||
|
||||
## Learn more
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Olares data management architecture, explaining file system types, application storage paths and database support. Covers technical specifications of JuiceFS, PostgreSQL, MongoDB and Redis.
|
||||
description: beOS Pro data management architecture, explaining file system types, application storage paths and database support. Covers technical specifications of JuiceFS, PostgreSQL, MongoDB and Redis.
|
||||
---
|
||||
|
||||
# Data
|
||||
@@ -9,7 +9,7 @@ User data is usually stored in file systems and databases. Of the two, databases
|
||||
|
||||
**For file systems**:
|
||||
|
||||
Olares is designed for multi-node clusters. Therefore, developers need to consider the access to the file system when the program is scheduled to different nodes when developing applications. We want to shield these details from developers.
|
||||
beOS Pro is designed for multi-node clusters. Therefore, developers need to consider the access to the file system when the program is scheduled to different nodes when developing applications. We want to shield these details from developers.
|
||||
|
||||
**For databases**:
|
||||
|
||||
@@ -26,17 +26,17 @@ User data is usually stored in file systems and databases. Of the two, databases
|
||||
|
||||
### JuiceFS
|
||||
|
||||
Olares OS uses [JuiceFS](https://juicefs.com) as the underlying multi-physical node shared file system solution. In this way, applications can obtain cross-node file access using the simplest HostPath PV method. This allows Pods to be freely scheduled in the cluster.
|
||||
beOS Pro uses [JuiceFS](https://juicefs.com) as the underlying multi-physical node shared file system solution. In this way, applications can obtain cross-node file access using the simplest HostPath PV method. This allows Pods to be freely scheduled in the cluster.
|
||||
|
||||
As for the back-end object storage solution of JuiceFS, we also provide two solutions: S3 and MinIO.
|
||||
|
||||
By default, Olares uses the local file system (FS) when installed locally. However, if the `--with-juicefs=true` option is specified when running the [`olares-cli prepare`](../install/cli/prepare.md) command, JuiceFS will be installed and used. Additionally, a MinIO instance will be set up as the backend storage.
|
||||
By default, beOS Pro uses the local file system (FS) when installed locally. However, if the `--with-juicefs=true` option is specified when running the [`olares-cli prepare`](../install/cli/prepare.md) command, JuiceFS will be installed and used. Additionally, a MinIO instance will be set up as the backend storage.
|
||||
|
||||
### Local disk
|
||||
|
||||
In some application systems, intensive file system read and write operations may occur. These intensive file system read and write operations are often fragmented random reads and writes. In various existing distributed storage cluster solutions, for such intensive fragmented random read and write operations, it is very likely that I/O or CPU consumption will be too high (usually due to high I/O Wait).
|
||||
|
||||
The best practice provided by Olares is to make full use of the node's local hard disk as a file buffer. Although the local hard disk of the node has limited capacity, it has high-speed read and write performance because it basically uses SSD hard disk. If the application reads and writes files, it will be buffered on the local hard disk of the node, and then written asynchronously to the distributed file system in batches. This can turn most of the fragmented random reads and writes into a few sequential reads and writes. This greatly improves system I/O efficiency.
|
||||
The best practice provided by beOS Pro is to make full use of the node's local hard disk as a file buffer. Although the local hard disk of the node has limited capacity, it has high-speed read and write performance because it basically uses SSD hard disk. If the application reads and writes files, it will be buffered on the local hard disk of the node, and then written asynchronously to the distributed file system in batches. This can turn most of the fragmented random reads and writes into a few sequential reads and writes. This greatly improves system I/O efficiency.
|
||||
|
||||
## Application Storage Path
|
||||
|
||||
@@ -46,39 +46,39 @@ For applications, there are 3 different storage paths to deal with different usa
|
||||
|
||||
The `UserData` storage path stores files that change infrequently but require cross-application access, such as documents, photos, and videos.
|
||||
|
||||
Applications can obtain access permissions to a directory under the Home directory by applying for [UserData](../develop/package/manifest.md#userdata) permissions in `OlaresManifest.yaml`. For example, you can request permissions to the Picture directory for PhotoPrism, and permissions to the Downloads directory for qBittorrent and Jellyfin.
|
||||
Applications can obtain access permissions to a directory under the Home directory by applying for [UserData](../develop/package/manifest.md#userdata) permissions in `beOS ProManifest.yaml`. For example, you can request permissions to the Picture directory for PhotoPrism, and permissions to the Downloads directory for qBittorrent and Jellyfin.
|
||||
|
||||
### AppData
|
||||
|
||||
The `AppData` storage path stores data that does not change frequently but needs to span across nodes. For example, configuration files.
|
||||
|
||||
Applications can apply for [AppData](../develop/package/manifest.md#appdata) permissions in `OlaresManifest.yaml`.
|
||||
Applications can apply for [AppData](../develop/package/manifest.md#appdata) permissions in `beOS ProManifest.yaml`.
|
||||
|
||||
### AppCache
|
||||
|
||||
The `AppCache` storage path is allocated for applications that directly operate the disk with good performance. The disadvantage is that it cannot be accessed across nodes. For example, the system database, application log, and cache.
|
||||
|
||||
Applications can apply for [AppCache](../develop/package/manifest.md#appcache) permissions in `OlaresManifest.yaml`.
|
||||
Applications can apply for [AppCache](../develop/package/manifest.md#appcache) permissions in `beOS ProManifest.yaml`.
|
||||
|
||||
## [PostgreSQL](../develop/advanced/database.md#rds)
|
||||
|
||||
As one of the most popular open-source relational databases, PostgreSQL has excellent performance and rich plug-in functions. Olares OS deploys PostgreSQL on the system along with the popular Citus distributed database plug-in. At the same time, its cluster is managed through the PG Operator in the TAPR component. Users can easily expand the number of PostgreSQL nodes, and back up or restore data along with the entire Olares system.
|
||||
As one of the most popular open-source relational databases, PostgreSQL has excellent performance and rich plug-in functions. beOS Pro deploys PostgreSQL on the system along with the popular Citus distributed database plug-in. At the same time, its cluster is managed through the PG Operator in the TAPR component. Users can easily expand the number of PostgreSQL nodes, and back up or restore data along with the entire beOS Pro system.
|
||||
|
||||
If the PostgreSQL database application declared by the developer in the application is Distributed, then Olares will build its database on Citus, allowing the application to fully utilize the capabilities of the distributed PG database.
|
||||
If the PostgreSQL database application declared by the developer in the application is Distributed, then beOS Pro will build its database on Citus, allowing the application to fully utilize the capabilities of the distributed PG database.
|
||||
|
||||
## [MongoDB](../develop/advanced/database.md#nosql)
|
||||
|
||||
MongoDB, as a representative of NoSQL, has a wide range of application scenarios in the Internet of Things field. By deploying [Percona Operator for MongoDB](https://github.com/percona/percona-server-mongodb-operator), developers have a cloud-native version of MongoDB cluster in Olares.
|
||||
MongoDB, as a representative of NoSQL, has a wide range of application scenarios in the Internet of Things field. By deploying [Percona Operator for MongoDB](https://github.com/percona/percona-server-mongodb-operator), developers have a cloud-native version of MongoDB cluster in beOS Pro.
|
||||
|
||||
Like PostgreSQL, Olares also manages MongoDB backup and restore in a unified manner. Users do not need to have any DBA technical capabilities to easily implement functions such as scheduled backup, incremental backup, and fixed-point restore.
|
||||
Like PostgreSQL, beOS Pro also manages MongoDB backup and restore in a unified manner. Users do not need to have any DBA technical capabilities to easily implement functions such as scheduled backup, incremental backup, and fixed-point restore.
|
||||
|
||||
## [Redis](../develop/advanced/database.md#cache)
|
||||
|
||||
There is no doubt that Redis can be regarded as the most popular memory cache software currently. It has rich instructions and derives a variety of data types based on Key-Value data. Many systems even use it as KV data storage. Olares OS also deploys a customized [Redis Cluster Operator](https://github.com/beclab/redis-cluster-operator) in the system, providing a cloud-native version of Redis Cluster.
|
||||
There is no doubt that Redis can be regarded as the most popular memory cache software currently. It has rich instructions and derives a variety of data types based on Key-Value data. Many systems even use it as KV data storage. beOS Pro also deploys a customized [Redis Cluster Operator](https://github.com/beclab/redis-cluster-operator) in the system, providing a cloud-native version of Redis Cluster.
|
||||
|
||||
Olares also takes over the backup and restore of Redis Cluster. There is no need for users to provide any separate operation and maintenance operations for Redis Cluster.
|
||||
beOS Pro also takes over the backup and restore of Redis Cluster. There is no need for users to provide any separate operation and maintenance operations for Redis Cluster.
|
||||
|
||||
In addition, since Redis Cluster itself lacks a data isolation mechanism, Olares OS has also developed a proxy layer tool to implement the `namespace` mechanism of data. This isolation mechanism is completely transparent to developers. Developers do not need to do any special processing of data keys in their code. Data isolation between multiple applications and multiple users can be achieved with simple configuration in application chart.
|
||||
In addition, since Redis Cluster itself lacks a data isolation mechanism, beOS Pro has also developed a proxy layer tool to implement the `namespace` mechanism of data. This isolation mechanism is completely transparent to developers. Developers do not need to do any special processing of data keys in their code. Data isolation between multiple applications and multiple users can be achieved with simple configuration in application chart.
|
||||
|
||||
:::tip
|
||||
The system uses the Redis Cluster version, which is different from the stand-alone version of Redis. It is recommended to read the official Redis documentation for reference.
|
||||
@@ -86,9 +86,9 @@ The system uses the Redis Cluster version, which is different from the stand-alo
|
||||
|
||||
## Backup
|
||||
|
||||
Backup is the backup and restore module of Olares OS.
|
||||
Backup is the backup and restore module of beOS Pro.
|
||||
|
||||
It helps users backup the entire Olares to Olares Space, and also supports user-defined storage locations.
|
||||
It helps users backup the entire beOS Pro to Remote Space, and also supports user-defined storage locations.
|
||||
|
||||
Backup operations can be performed daily and weekly. The first backup of each backup plan is a full backup and serves as the first snapshot of the backup plan. Subsequent snapshots are incremental backups.
|
||||
|
||||
@@ -98,7 +98,7 @@ Backup objects include:
|
||||
- Database data, such as Redis, MongoDB, PostgreSQL, etc.
|
||||
- File system data, such as videos, pictures, and various documents uploaded by users through the Files application
|
||||
|
||||
The Backup component also has data restoration capabilities. You can download a backup snapshot to a local server or Olares Space to restore a complete Olares by rebuilding Kubernetes, databases, and user personal information.
|
||||
The Backup component also has data restoration capabilities. You can download a backup snapshot to a local server or Remote Space to restore a complete beOS Pro by rebuilding Kubernetes, databases, and user personal information.
|
||||
|
||||
## Learn more
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ A DID is structured as a text string that comprises three distinct components:
|
||||
|
||||
## DID derivation
|
||||
|
||||
In the context of the Olares ID, DIDs are self-generated using a mnemonic-based algorithm similar to blockchain addresses. The derivation process follows this sequence:
|
||||
In the context of the beOS ID, DIDs are self-generated using a mnemonic-based algorithm similar to blockchain addresses. The derivation process follows this sequence:
|
||||
|
||||
> Mnemonic -> Private Key -> Public Key -> Blockchain Address on DID
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ outline: [2, 3]
|
||||
|
||||
World ID is a privacy-preserving proof of personhood. It is issued by the **Worldcoin protocol**, allowing individuals to prove they are human to any verifier (including Web2 applications) while maintaining privacy through **zero-knowledge proofs**.
|
||||
|
||||
From the perspective of the **Olares ID**, World ID is a type of **Verifiable Credential (VC)** that proves the holder is a "natural person." We plan to introduce World ID into **LarePass** in the future. For more details, please refer to the [Worldcoin website](https://worldcoin.org/).
|
||||
From the perspective of the **beOS ID**, World ID is a type of **Verifiable Credential (VC)** that proves the holder is a "natural person." We plan to introduce World ID into **beOS Pro app** in the future. For more details, please refer to the [Worldcoin website](https://worldcoin.org/).
|
||||
|
||||
## What are the differences among DID Metadata, VC, and Reputation?
|
||||
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
---
|
||||
description: Core concepts documentation of Olares system, covering architecture design, identity authentication, application management, network configuration and data security fundamentals for developers.
|
||||
description: Core concepts documentation of beOS Pro system, covering architecture design, identity authentication, application management, network configuration and data security fundamentals for developers.
|
||||
---
|
||||
# Overview
|
||||
|
||||
The Concepts section helps you learn about the parts of the Olares system and obtain a deeper understanding of how Olares works. Read this section as needed to:
|
||||
The Concepts section helps you learn about the parts of the beOS Pro system and obtain a deeper understanding of how beOS Pro works. Read this section as needed to:
|
||||
|
||||
- Develop applications for Olares
|
||||
- Develop applications for beOS Pro
|
||||
- Manage system deployments
|
||||
- Troubleshoot issues
|
||||
- Optimize system performance
|
||||
|
||||
Understand Olares with the following concepts:
|
||||
Understand beOS Pro with the following concepts:
|
||||
|
||||
- [Architectural components](system-architecture.md)
|
||||
- [Olares ID](olares-id.md)
|
||||
- [beOS ID](olares-id.md)
|
||||
- [Account](account.md)
|
||||
- [Application](application.md)
|
||||
- [Network](network.md)
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Olares network architecture principles, covering application entrance types, local access mechanisms, endpoint configurations and internal network security policies.
|
||||
description: beOS Pro network architecture principles, covering application entrance types, local access mechanisms, endpoint configurations and internal network security policies.
|
||||
---
|
||||
# Network
|
||||
|
||||
Olares provides users with a barrier-free but secure and versatile network solutions. This documents covers the key networking concepts related to application access.
|
||||
beOS Pro provides users with a barrier-free but secure and versatile network solutions. This documents covers the key networking concepts related to application access.
|
||||
|
||||
## Entrance
|
||||
|
||||
Each Olares application can have one or more entrances that serve as access points. There are three types of entrances:
|
||||
Each beOS Pro application can have one or more entrances that serve as access points. There are three types of entrances:
|
||||
|
||||
### Public entrance
|
||||
|
||||
@@ -24,20 +24,20 @@ Each Olares application can have one or more entrances that serve as access poin
|
||||
|
||||
### Internal entrance
|
||||
- Functions similarly to private entrance
|
||||
- No authentication required when accessing applications through LarePass VPN
|
||||
- No authentication required when accessing applications through beOS Pro app VPN
|
||||
|
||||
## Endpoints
|
||||
|
||||
An endpoint is the access address or point where users interact with an application. Simply put, it's the URL you enter in your browser's address bar to access a specific Olares application or its features.
|
||||
An endpoint is the access address or point where users interact with an application. Simply put, it's the URL you enter in your browser's address bar to access a specific beOS Pro application or its features.
|
||||
|
||||
A typical Olares application endpoint follows this format:
|
||||
A typical beOS Pro application endpoint follows this format:
|
||||
|
||||
https://{routeID}.{domain}
|
||||
|
||||
For example: `https://vault.alice123.olares.com`, where
|
||||
For example: `https://vault.alice123.beos.local`, where
|
||||
|
||||
- `vault` is the route ID for a system application.
|
||||
- `alice123.olares.com` is derived from the Olares ID `alice123@olares.com`.
|
||||
- `alice123.beos.local` is derived from the beOS ID `alice123@beos.local`.
|
||||
|
||||
## Route ID
|
||||
|
||||
@@ -48,23 +48,23 @@ A route ID is a unique identifier used to identify specific applications or appl
|
||||
- Examples: `desktop` (for Desktop), `market` (for Market)
|
||||
- Community applications
|
||||
- Use an 8-character random string + entrance index (starting from 0)
|
||||
- Example: For an application with Route ID 92d76a13 and two entrances, the first entrance is `92d76a130`, and the access URL is `92d76a130.bob.olares.com`
|
||||
- Example: For an application with Route ID 92d76a13 and two entrances, the first entrance is `92d76a130`, and the access URL is `92d76a130.bob.beos.local`
|
||||
|
||||
::: tip Note
|
||||
|
||||
- The URL of the application is derived from Olares ID.
|
||||
- Entrance index refers to the position of entrance in multiple entrances defined in [`OlaresManifest.yaml`](../develop/package/manifest.md).
|
||||
- The URL of the application is derived from beOS ID.
|
||||
- Entrance index refers to the position of entrance in multiple entrances defined in [`beOS ProManifest.yaml`](../develop/package/manifest.md).
|
||||
:::
|
||||
|
||||
## Olares internal network
|
||||
## beOS Pro internal network
|
||||
|
||||
Olares implements a layered proxy routing design in its gateway architecture. Traffic flows through multiple layers:
|
||||
beOS Pro implements a layered proxy routing design in its gateway architecture. Traffic flows through multiple layers:
|
||||
|
||||
`cluster` -> `user` -> `application` -> `service component`.
|
||||
|
||||
|
||||
|
||||
Inside the application, Olares has multiple layers of security.
|
||||
Inside the application, beOS Pro has multiple layers of security.
|
||||
|
||||
- **Namespace isolation**
|
||||
|
||||
@@ -87,4 +87,4 @@ Inside the application, Olares has multiple layers of security.
|
||||
## Learn more
|
||||
|
||||
- [Set up custom domain name for application](../../manual/olares/settings/custom-app-domain.md#custom-domain-name)
|
||||
- [Access Olares via VPN](/manual/larepass/private-network.md)
|
||||
- [Access beOS Pro via VPN](/manual/larepass/private-network.md)
|
||||
|
||||
@@ -1,75 +1,75 @@
|
||||
---
|
||||
description: Definition, structure and purpose of Olares ID system. Covers personal ID types, domain categories and relationship principles with decentralized identifiers (DID).
|
||||
description: Definition, structure and purpose of beOS ID system. Covers personal ID types, domain categories and relationship principles with decentralized identifiers (DID).
|
||||
---
|
||||
# Olares ID
|
||||
# beOS ID
|
||||
|
||||
This document introduces Olares ID, the foundation of identity and trust in the Olares ecosystem.
|
||||
This document introduces beOS ID, the foundation of identity and trust in the beOS Pro ecosystem.
|
||||
|
||||
## What is an Olares ID?
|
||||
## What is an beOS ID?
|
||||
|
||||
An Olares ID is a decentralized identity and credit system that facilitates secure, trustless exchanges of information and value. It serves as your digital identity across the Olares ecosystem, enabling individuals and organizations to manage their identities independently—without reliance on third-party intermediaries.
|
||||
An beOS ID is a decentralized identity and credit system that facilitates secure, trustless exchanges of information and value. It serves as your digital identity across the beOS Pro ecosystem, enabling individuals and organizations to manage their identities independently—without reliance on third-party intermediaries.
|
||||
|
||||
Each Olares ID is:
|
||||
Each beOS ID is:
|
||||
|
||||
- Unique, like an email address (e.g., alice123@olares.com).
|
||||
- Unique, like an email address (e.g., alice123@beos.local).
|
||||
|
||||
- Human-friendly, making it easy to remember and share.
|
||||
|
||||
- Bound to a DID, ensuring cryptographic security and verifiability.
|
||||
|
||||
## Why do you need an Olares ID?
|
||||
## Why do you need an beOS ID?
|
||||
|
||||
Your Olares ID powers seamless access, enhanced security, and a personalized experience within the Olares system. Key benefits include:
|
||||
Your beOS ID powers seamless access, enhanced security, and a personalized experience within the beOS Pro system. Key benefits include:
|
||||
|
||||
* **Ease of access**: The system automatically provisions subdomains and access policies for your applications within Olares. You can use the domain name as your personal web address for seamlessly access from anywhere.
|
||||
* **Free HTTPS certificate**: Olares domain name comes with a free HTTPS certificate, ensuring secure and encrypted communication for all your digital interactions.
|
||||
* **Easy to remember and personalized**: Olares ID and the corresponding domain name are easy to remember, share, and personalized for your distinct online identity.
|
||||
* **Ease of access**: The system automatically provisions subdomains and access policies for your applications within beOS Pro. You can use the domain name as your personal web address for seamlessly access from anywhere.
|
||||
* **Free HTTPS certificate**: beOS Pro domain name comes with a free HTTPS certificate, ensuring secure and encrypted communication for all your digital interactions.
|
||||
* **Easy to remember and personalized**: beOS ID and the corresponding domain name are easy to remember, share, and personalized for your distinct online identity.
|
||||
|
||||
For example, if your Olares ID is `alice123@olares.com`, Olares automatically assigns the following URLs:
|
||||
- `alice123.olares.com`: Your personal homepage.
|
||||
- `desktop.alice123.olares.com`: Access to your Olares Desktop.
|
||||
- `files.alice123.olares.com`: Access to the Files app.
|
||||
For example, if your beOS ID is `alice123@beos.local`, beOS Pro automatically assigns the following URLs:
|
||||
- `alice123.beos.local`: Your personal homepage.
|
||||
- `desktop.alice123.beos.local`: Access to your beOS Pro Desktop.
|
||||
- `files.alice123.beos.local`: Access to the Files app.
|
||||
|
||||
## Olares ID structure
|
||||
The format of an Olares ID is the same as an email address, consisting of two parts:
|
||||
## beOS ID structure
|
||||
The format of an beOS ID is the same as an email address, consisting of two parts:
|
||||
- A local name (prefix)
|
||||
- A domain name (suffix)
|
||||
|
||||
For example, in `alice123@olares.com`, *`alice123`* is the local name, and *`olares.com`* is the domain.
|
||||
For example, in `alice123@beos.local`, *`alice123`* is the local name, and *`beos.local`* is the domain.
|
||||
|
||||
Local names are unique within each domain, ensuring that each Olares ID is unique.
|
||||
Local names are unique within each domain, ensuring that each beOS ID is unique.
|
||||
|
||||
### Domain types
|
||||
Within Olares, there are three types of Domains:
|
||||
Within beOS Pro, there are three types of Domains:
|
||||
|
||||
* Individual domain: For personal use, similar to personal email. Currently, Olares provides default domain `olares.com` for individual users.
|
||||
* Organizational domain: For organizational use, like company email addresses. After joining an organization, users can apply for an Olares ID under that organization's domain. The administrator can revoke this Olares ID when the user leaves the organization.
|
||||
* Individual domain: For personal use, similar to personal email. Currently, beOS Pro provides default domain `beos.local` for individual users.
|
||||
* Organizational domain: For organizational use, like company email addresses. After joining an organization, users can apply for an beOS ID under that organization's domain. The administrator can revoke this beOS ID when the user leaves the organization.
|
||||
* Entity domain: For applications and other entities that cannot be classified as either personal or organizational.
|
||||
|
||||
### Olares ID creation for individuals
|
||||
Olares offers two approaches to create an individual Olares ID:
|
||||
- **Quick creation**<br>You can create an Olares ID by choosing an available name that meets the requirements.
|
||||
### beOS ID creation for individuals
|
||||
beOS Pro offers two approaches to create an individual beOS ID:
|
||||
- **Quick creation**<br>You can create an beOS ID by choosing an available name that meets the requirements.
|
||||
- **Advanced creation**<br>
|
||||
This approach uses Verification Credentials (VC) to connect an existing trusted identity (such as email accounts) with the Olares ID.
|
||||
When creating a verified identity, Olares:
|
||||
This approach uses Verification Credentials (VC) to connect an existing trusted identity (such as email accounts) with the beOS ID.
|
||||
When creating a verified identity, beOS Pro:
|
||||
* Authenticates the user through established OAuth providers
|
||||
* Creates cryptographic links between the social identity and Olares DID
|
||||
* Creates cryptographic links between the social identity and beOS Pro DID
|
||||
|
||||
:::tip Create an Olares ID with Verifiable Credential (VC)
|
||||
On the LarePass app, click <i class="material-symbols-outlined">display_settings</i>, then select **Individual Olares ID**.
|
||||
:::tip Create an beOS ID with Verifiable Credential (VC)
|
||||
On the beOS Pro app app, click <i class="material-symbols-outlined">display_settings</i>, then select **Individual beOS ID**.
|
||||
|
||||
Currently, verification is available through Google OAuth.
|
||||
:::
|
||||
|
||||
## What's Olares ID's relationship with DID
|
||||
## What's beOS ID's relationship with DID
|
||||
A Decentralized Identifier (DID) is a unique, cryptographically verifiable identifier that doesn't rely on any centralized authority. While DIDs solve the issue of identity in a decentralized network, they are typically difficult for humans to remember or use in daily situations. Learn more in [DID](did.md).
|
||||
|
||||
Olares IDs makes DIDs more user-friendly. It provides a familiar, easy-to-remember format similar to email addresses, while still leveraging the power and security of DIDs.
|
||||
beOS IDs makes DIDs more user-friendly. It provides a familiar, easy-to-remember format similar to email addresses, while still leveraging the power and security of DIDs.
|
||||
|
||||
Each Olares ID is bound to a DID. When a user creates an account using Olares, a DID is created at the same time. Learn more about their relationship in [Stage of Olares account](./account#understand-the-stage-of-account).
|
||||
Each beOS ID is bound to a DID. When a user creates an account using beOS Pro, a DID is created at the same time. Learn more about their relationship in [Stage of beOS Pro account](./account#understand-the-stage-of-account).
|
||||
|
||||
## Learn more
|
||||
|
||||
* [Create an Olares ID](../../manual/get-started/create-olares-id)
|
||||
* [Create an beOS ID](../../manual/get-started/create-olares-id)
|
||||
* [Decentralized identifier (DID)](did.md)
|
||||
* [Gmail issuer service](/developer/contribute/olares-id/verifiable-credential/olares.md#gmail-issuer-service)
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
# DID Registry on Blockchains
|
||||
|
||||
Once a DID is generated, users need to register their ownership in a **DID Registry**. Although the W3C standards do not prescribe a specific implementation for this registry, Olares ID utilizes [Smart Contracts](/developer/contribute/olares-id/contract/contract.md#smart-contract.md) to facilitate the registration process. This approach offers several advantages:
|
||||
Once a DID is generated, users need to register their ownership in a **DID Registry**. Although the W3C standards do not prescribe a specific implementation for this registry, beOS ID utilizes [Smart Contracts](/developer/contribute/olares-id/contract/contract.md#smart-contract.md) to facilitate the registration process. This approach offers several advantages:
|
||||
|
||||
- **Decentralization**: There is no reliance on centralized providers or authorities.
|
||||
- **Censorship resistance**: The structure is robust against censorship and interference.
|
||||
- **Universal discoverability**: DIDs can be easily discovered by users across the network.
|
||||
|
||||
Issuers can upload essential DID metadata to the Registry, including the DID itself, [Olares ID](olares-id.md), RSA public keys, and other relevant information.
|
||||
Issuers can upload essential DID metadata to the Registry, including the DID itself, [beOS ID](olares-id.md), RSA public keys, and other relevant information.
|
||||
|
||||
DID metadata require minimal storage and infrequent updates. This allows existing mainstream blockchain technologies to manage these efficiently. Storing and retrieving DID metadata on blockchain results in low overhead and system efficiency.
|
||||
|
||||
Currently, Olares ID's smart contracts are deployed on [OPTIMISTIC ROLLUPS](https://optimism.io/), an Ethereum Layer 2 blockchain.
|
||||
Currently, beOS ID's smart contracts are deployed on [OPTIMISTIC ROLLUPS](https://optimism.io/), an Ethereum Layer 2 blockchain.
|
||||
|
||||
::: info
|
||||
It is noteworthy that the Web5 development team has transitioned from utilizing ION as their registry mechanism to adopting a Distributed Hash Table (DHT) network. DHT networks provide a greater degree of decentralization compared to Layer 2 blockchain solutions. However, managing DHT networks involves complexities in maintaining efficiency and stability, as well as ensuring data integrity across a vast number of nodes.
|
||||
|
||||
@@ -13,9 +13,9 @@ Reputation systems are designed to allow participants to assess the credibility
|
||||
- **Customization limitations**: Users cannot adjust how reputation metrics are calculated or select the reputation algorithms as needed.
|
||||
- **Manipulation risk:** Some entities can exploit the system by paying for higher scores or better rankings, potentially distorting the reliability of these ratings.
|
||||
|
||||
## Olares ID's decentralized approach
|
||||
## beOS ID's decentralized approach
|
||||
|
||||
The **Olares ID** aims to build a decentralized reputation system based on **DIDs** and **VCs**, ensuring transparency, control, and trust:
|
||||
The **beOS ID** aims to build a decentralized reputation system based on **DIDs** and **VCs**, ensuring transparency, control, and trust:
|
||||
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ The **Olares ID** aims to build a decentralized reputation system based on **DID
|
||||
|
||||
- **Open Algorithms:**
|
||||
|
||||
Unlike traditional systems, Olares ID allows reputation algorithms to be transparent. Algorithm providers openly publish their methods, giving users the option to choose which algorithms they trust for generating scores or rankings.
|
||||
Unlike traditional systems, beOS ID allows reputation algorithms to be transparent. Algorithm providers openly publish their methods, giving users the option to choose which algorithms they trust for generating scores or rankings.
|
||||
|
||||
- **Customized reputation processing:**
|
||||
|
||||
@@ -37,7 +37,7 @@ The **Olares ID** aims to build a decentralized reputation system based on **DID
|
||||
|
||||
## Entity domains for a autonomous reputation system
|
||||
|
||||
In Olares ID, abstract entities don’t fall under traditional categories such as individuals or organizations but still need representation through DIDs. This is where entity domain comes into play. It enables abstract entities, such as movies, applications, or market makers, to have decentralized identities.
|
||||
In beOS ID, abstract entities don’t fall under traditional categories such as individuals or organizations but still need representation through DIDs. This is where entity domain comes into play. It enables abstract entities, such as movies, applications, or market makers, to have decentralized identities.
|
||||
|
||||
The primary goal of entity domains is to support protocols in creating reputation systems for these abstract entities. With this feature, we envision the development of Web3 versions of platforms like IMDb, Yelp, and LinkedIn, fostering a true decentralized autonomous and dependable reputation system.
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
description: Olares secrets management system principles, detailing vault items, credentials, secrets and integration credentials classification. Explains sensitive data storage strategies.
|
||||
description: beOS Pro secrets management system principles, detailing vault items, credentials, secrets and integration credentials classification. Explains sensitive data storage strategies.
|
||||
---
|
||||
# Secrets
|
||||
|
||||
Olares categorizes secrets based on usage scenarios and employs various management techniques.
|
||||
beOS Pro categorizes secrets based on usage scenarios and employs various management techniques.
|
||||
|
||||
| | Data Type | Storage Location | Leak Risk | Usage |
|
||||
|-------------|----------------------------------------------------------------------------------------------------------|-------------------------------------|---------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
|
||||
| Vault items | Includes website and <br/>database passwords, <br/>blockchain private <br/>keys, etc. | Vault | Encrypted data in Olares ensures that third parties cannot view even upon logging in | Each use requires a signature from LarePass |
|
||||
| Credentials | System access <br/>credentials obtained<br/> post-secure<br/> authentication:<br/> Tokens, Cookies, etc. | [Infisical](https://infisical.com/) | Viewable by third parties post-authentication in Olares by following specific steps | Available to applications through an API after obtaining Provider permissions |
|
||||
| Vault items | Includes website and <br/>database passwords, <br/>blockchain private <br/>keys, etc. | Vault | Encrypted data in beOS Pro ensures that third parties cannot view even upon logging in | Each use requires a signature from beOS Pro app |
|
||||
| Credentials | System access <br/>credentials obtained<br/> post-secure<br/> authentication:<br/> Tokens, Cookies, etc. | [Infisical](https://infisical.com/) | Viewable by third parties post-authentication in beOS Pro by following specific steps | Available to applications through an API after obtaining Provider permissions |
|
||||
| Secret | Sensitive data used<br/> in Pod containers,<br/> like database <br/>connections and <br/> admin accounts | ETCD | Directly visible in [Control Hub](../../manual/olares/controlhub/manage-workload) | Used in Helm deployment templates; secret values are injected into environment variables via valueFrom -> secretKeyRef |
|
||||
|
||||
## Integration credential
|
||||
|
||||
Users can enable applications within Olares to access external service credentials by logging into third-party service accounts through Settings. Examples include:
|
||||
Users can enable applications within beOS Pro to access external service credentials by logging into third-party service accounts through Settings. Examples include:
|
||||
|
||||
- Logging in to Olares Space allows the backup service to request tokens for automated backend backups.
|
||||
- Logging in to Remote Space allows the backup service to request tokens for automated backend backups.
|
||||
- Logging into Google enables Files to synchronize with data from Google Drive.
|
||||
|
||||
Applications in Olares can retrieve these third-party service credentials via the [Service Provider](../develop/advanced/provider.md).
|
||||
Applications in beOS Pro can retrieve these third-party service credentials via the [Service Provider](../develop/advanced/provider.md).
|
||||
|
||||
## Application credential
|
||||
|
||||
- Applications within Olares can manage and utilize [credentials](../develop/advanced/secret.md) via system-provided interfaces.
|
||||
- Applications within beOS Pro can manage and utilize [credentials](../develop/advanced/secret.md) via system-provided interfaces.
|
||||
- Credentials generated by an application are exclusively restricted to that application's use.
|
||||
@@ -6,11 +6,11 @@ Leveraging [**DID**](did.md) and [**Blockchain Registry**](registry.md), we have
|
||||
|
||||
The BEC framework decentralizes data storage by distributing it across the appropriate locations. It is built on three pillars:
|
||||
|
||||
- **Edge**: Users store personal data (e.g., documents, chat logs, photos) on their private edge servers. All user interactions, whether with other individuals or services, are facilitated through this server. Our instantiation of this component is Olares, the open source self-hosted operating system running on edge devices.
|
||||
- **Edge**: Users store personal data (e.g., documents, chat logs, photos) on their private edge servers. All user interactions, whether with other individuals or services, are facilitated through this server. Our instantiation of this component is beOS Pro, the open source self-hosted operating system running on edge devices.
|
||||
|
||||
- **Blockchain**: High-value data like DIDs and transactions are stored on the blockchain for transparency, security, and discoverability. Olares ID stores the DID Registry on Ethereum Virtual Machine (EVM) supported blockchains via smart contracts.
|
||||
- **Blockchain**: High-value data like DIDs and transactions are stored on the blockchain for transparency, security, and discoverability. beOS ID stores the DID Registry on Ethereum Virtual Machine (EVM) supported blockchains via smart contracts.
|
||||
|
||||
- **Client**: The identity wallet app that enable users to maintain full control of their private keys stored on mobile devices. Our instantiation of this component is LarePass, the comprehensive client app of Olares.
|
||||
- **Client**: The identity wallet app that enable users to maintain full control of their private keys stored on mobile devices. Our instantiation of this component is beOS Pro app, the comprehensive client app of beOS Pro.
|
||||
|
||||
## Direct trustless information exchange through BEC
|
||||
|
||||
@@ -27,7 +27,7 @@ Here are the steps when Alice sends a message to Bob through the BEC framework:
|
||||
|
||||
## Trustless value exchange via Otmoic
|
||||
|
||||
The **Otmoic** protocol is a trustless automatic value-exchange protocol built on the **Olares ID**.
|
||||
The **Otmoic** protocol is a trustless automatic value-exchange protocol built on the **beOS ID**.
|
||||
It is designed to provide **public goods** with a fair price, ensuring transparency and decentralized value exchange. Key features include:
|
||||
|
||||
|
||||
@@ -36,6 +36,6 @@ It is designed to provide **public goods** with a fair price, ensuring transpare
|
||||
- **KYC Support via Verifiable Credentials**: Ensures identity verification without compromising decentralization.
|
||||
- **RFQ-Based Price Discovery**: Allows for efficient **Request-for-Quote** (RFQ) driven price discovery.
|
||||
- **Atomic Swap Support**: Facilitates trustless, on-chain atomic swap transactions.
|
||||
- **Automatic Market Making**: Liquidity providers can engage in automatic market-making by installing applications on **Olares**.
|
||||
- **Automatic Market Making**: Liquidity providers can engage in automatic market-making by installing applications on **beOS Pro**.
|
||||
|
||||
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Comprehensive guide to Olares architecture covering infrastructure, platform services, and application framework. Learn about container orchestration, storage, networking, and system components.
|
||||
description: Comprehensive guide to beOS Pro architecture covering infrastructure, platform services, and application framework. Learn about container orchestration, storage, networking, and system components.
|
||||
---
|
||||
|
||||
# Olares architecture
|
||||
# beOS Pro architecture
|
||||
|
||||
This document provides a comprehensive explanation of the Olares architecture, outlining the purpose and functionality of each layer and its components.
|
||||
This document provides a comprehensive explanation of the beOS Pro architecture, outlining the purpose and functionality of each layer and its components.
|
||||
|
||||
|
||||
|
||||
|
||||
## Infrastructure
|
||||
|
||||
@@ -15,11 +15,11 @@ The infrastructure layer provides essential infrastructure services such as cont
|
||||
|
||||
### Container orchestration
|
||||
|
||||
Olares supports different Kubernetes distributions depending on the underlying environment:
|
||||
beOS Pro supports different Kubernetes distributions depending on the underlying environment:
|
||||
- Linux environments (including WSL, PVE, LXC, Raspberry Pi): Users can choose to install [Kubernetes](https://kubernetes.io/) or the lightweight [K3s](https://k3s.io/), with K3s being the default for its better performance and resource efficiency on local hardware.
|
||||
- macOS: [minikube](https://minikube.sigs.k8s.io/) 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.
|
||||
Regardless of the chosen Kubernetes distribution, users get consistent core capabilities and experience with beOS Pro.
|
||||
|
||||
### Networking
|
||||
|
||||
@@ -29,46 +29,46 @@ The networking stack ensures seamless communication between containers, nodes, a
|
||||
- [Calico](https://www.tigera.io/project-calico/): A container networking interface (CNI) that facilitates communication between containers and virtual machines while offering advanced network policy controls.
|
||||
- [Envoy](https://www.envoyproxy.io/): 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.
|
||||
These components collectively ensure robust, scalable, and secure networking within beOS Pro.
|
||||
|
||||
### Distributed storage
|
||||
|
||||
Olares provides flexibility in storage solutions tailored to both single-node and multi-node setups:
|
||||
beOS Pro 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](https://aws.amazon.com/s3/): A cloud-based storage option. Ideal for cloud deployment via S3 or any S3-compatible service.
|
||||
- [MinIO](https://min.io/): A distributed storage solution for self-hosted deployment. Users can either set up a MinIO cluster through Olares or mount an existing one.
|
||||
- [MinIO](https://min.io/): A distributed storage solution for self-hosted deployment. Users can either set up a MinIO cluster through beOS Pro 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
|
||||
|
||||
Olares uses [etcd](https://etcd.io/) as its distributed key-value store. etcd is integral for storing and managing all cluster data for Kubernetes.
|
||||
beOS Pro uses [etcd](https://etcd.io/) as its distributed key-value store. etcd is integral for storing and managing all cluster data for Kubernetes.
|
||||
|
||||
### GPU management
|
||||
|
||||
Olares leverages components like CUDA driver, NVIDIA device plugin, and nvShare, which work in conjunction to manage and provision GPU resources effectively:
|
||||
beOS Pro 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](https://github.com/grgalex/nvshare): Allows multiple containers or pods to share a single GPU, enabling both shared and exclusive GPU usage in Olares for better GPU utilization.
|
||||
- [nvshare](https://github.com/grgalex/nvshare): Allows multiple containers or pods to share a single GPU, enabling both shared and exclusive GPU usage in beOS Pro for better GPU utilization.
|
||||
|
||||
:::info
|
||||
Currently, Olares GPU support is restricted to deployments with one GPU per node.
|
||||
Currently, beOS Pro GPU support is restricted to deployments with one GPU per node.
|
||||
:::
|
||||
Starting with Olares v1.11, [CUDA](https://developer.nvidia.com/cuda-toolkit) (12.4 and above) is supported. Changes in the host environment's CUDA configuration can be synchronized with the Olares cluster using `olares-cli`.
|
||||
Starting with beOS Pro v1.11, [CUDA](https://developer.nvidia.com/cuda-toolkit) (12.4 and above) is supported. Changes in the host environment's CUDA configuration can be synchronized with the beOS Pro cluster using `olares-cli`.
|
||||
|
||||
### Container management
|
||||
Olares uses [containerd](../install/installation-overview.md#container-runtime-containerd), a lightweight container runtime, for containerized deployments.
|
||||
beOS Pro uses [containerd](../install/installation-overview.md#container-runtime-containerd), a lightweight container runtime, for containerized deployments.
|
||||
|
||||
### Olares Controller Panel
|
||||
### beOS Pro Controller Panel
|
||||
|
||||
The management of Olares is implemented through the following:
|
||||
The management of beOS Pro is implemented through the following:
|
||||
|
||||
- [olares-cli](../install/cli/olares-cli.md): A command-line tool for managing Olares clusters, applications, and hardware nodes.
|
||||
- [olares-cli](../install/cli/olares-cli.md): A command-line tool for managing beOS Pro clusters, applications, and hardware nodes.
|
||||
- [olaresd](../install/installation-overview.md#container-runtime-containerd): 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.
|
||||
These tools streamline installation, maintenance, and scaling for beOS Pro.
|
||||
|
||||
## Platform
|
||||
|
||||
@@ -76,7 +76,7 @@ The platform layer services run in containers with middlewares such as databases
|
||||
|
||||
### Relational database
|
||||
|
||||
Olares uses [PostgreSQL](https://www.postgresql.org/) 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.
|
||||
beOS Pro uses [PostgreSQL](https://www.postgresql.org/) 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](https://github.com/citusdata/citus) is used, though its production readiness is still under evaluation.
|
||||
|
||||
@@ -84,37 +84,37 @@ In the future, PostgreSQL is expected to migrate to the infrastructure layer for
|
||||
|
||||
### Key-value cache
|
||||
|
||||
Olares integrates [KVRocks](https://github.com/apache/incubator-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.
|
||||
beOS Pro integrates [KVRocks](https://github.com/apache/incubator-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
|
||||
|
||||
Olares integrates [NATS](https://nats.io/), a lightweight and high-performance message-oriented middleware, as the messaging system. NATS ensures low resource consumption while delivering reliable message queues.
|
||||
beOS Pro integrates [NATS](https://nats.io/), 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
|
||||
|
||||
Olares employs [JuiceFS](https://juicefs.com/), 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.
|
||||
beOS Pro employs [JuiceFS](https://juicefs.com/), 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
|
||||
|
||||
Olares uses [Argo Workflows](https://argoproj.github.io/) 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.
|
||||
beOS Pro uses [Argo Workflows](https://argoproj.github.io/) for workflow orchestration. This Kubernetes-native tool automates complex tasks, such as those required by beOS Pro' distributed recommendation engine. Currently, this functionality is not available to third-party applications.
|
||||
|
||||
### Secret management
|
||||
|
||||
Two secret management solutions are integrated into Olares:
|
||||
Two secret management solutions are integrated into beOS Pro:
|
||||
|
||||
- [Vault](https://github.com/beclab/olares/tree/main/apps/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](https://padloc.app/).
|
||||
- [Infisical](https://infisical.com/): A tool for managing sensitive information and preventing secret leaks in Olares development.
|
||||
- [Vault](https://github.com/beclab/olares/tree/main/apps/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 beOS Pro team based on [Padloc](https://padloc.app/).
|
||||
- [Infisical](https://infisical.com/): A tool for managing sensitive information and preventing secret leaks in beOS Pro development.
|
||||
|
||||
### Observability
|
||||
|
||||
Olares provides observability through the following:
|
||||
beOS Pro provides observability through the following:
|
||||
|
||||
- [Prometheus](https://prometheus.io/): Used for system monitoring and resource usage tracking. It collects resource metrics for applications like Dashboard and Market.
|
||||
- [OpenTelemetry](https://opentelemetry.io/)*: Enables tracing of request workflows within the Olares system using eBPF-based monitoring. *(In development)*
|
||||
- [OpenTelemetry](https://opentelemetry.io/)*: Enables tracing of request workflows within the beOS Pro system using eBPF-based monitoring. *(In development)*
|
||||
|
||||
### Other middlewares
|
||||
|
||||
The Olares application store includes common middleware such as [Grafana](https://grafana.com/) for visualization, [MongoDB](https://www.mongodb.com/) for document storage, and [Chaos Mesh](https://chaos-mesh.org/) for chaos testing.
|
||||
The beOS Pro application store includes common middleware such as [Grafana](https://grafana.com/) for visualization, [MongoDB](https://www.mongodb.com/) for document storage, and [Chaos Mesh](https://chaos-mesh.org/) for chaos testing.
|
||||
|
||||
## Application framework
|
||||
|
||||
@@ -122,7 +122,7 @@ The application framework layer provides common functionality and interfaces for
|
||||
|
||||
### Authentication and authorization
|
||||
|
||||
Olares uses [LLDAP](https://github.com/lldap/lldap) to manage user accounts and provide LDAP (Lightweight Directory Access Protocol) services for applications.
|
||||
beOS Pro uses [LLDAP](https://github.com/lldap/lldap) to manage user accounts and provide LDAP (Lightweight Directory Access Protocol) services for applications.
|
||||
|
||||
Additionally, [Authelia](https://www.authelia.com/) adds authentication and authorization support, including multi-factor authentication and single sign-on (SSO).
|
||||
|
||||
@@ -131,32 +131,32 @@ Additionally, [Authelia](https://www.authelia.com/) adds authentication and auth
|
||||
Components for application governance include:
|
||||
- [app-service](https://github.com/beclab/app-service): Handles application lifecycle management and resource allocation.
|
||||
- [system-server](https://github.com/beclab/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.
|
||||
- image-server: Works with app-service to manage container images required by beOS Pro applications.
|
||||
- [bfl](https://github.com/beclab/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
|
||||
Olares supports secure and flexible network connectivity through:
|
||||
- Reverse proxy: Options include [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/), Olares Tunnel, and self-built FRP.
|
||||
beOS Pro supports secure and flexible network connectivity through:
|
||||
- Reverse proxy: Options include [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/), beOS Pro Tunnel, and self-built FRP.
|
||||
- [Tailscale](https://tailscale.com/): Enables users to securely access the system from anywhere.
|
||||
- [Headscale](https://github.com/juanfont/headscale): A self-hosted implementation of the Tailscale control server.
|
||||
|
||||
### File service
|
||||
Components for file service include:
|
||||
- File server: Provides essential file management services.
|
||||
- [Seafile](https://www.seafile.com/): 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.
|
||||
- [Seafile](https://www.seafile.com/): An open-source alternative to Dropbox for file synchronization. beOS Pro 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](https://github.com/FFmpeg/FFmpeg).
|
||||
|
||||
### Knowledge service
|
||||
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.
|
||||
- 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 beOS Pro app. This repository is also utilized by the decentralized recommendation engine to store its results.
|
||||
- Download: Uses [aria2](https://aria2.github.io/) and [youtube-dlp](https://github.com/yt-dlp/yt-dlp) to download files, magnet links, and online videos.
|
||||
- Search: Provides full-text search for stored content in Knowledge and Files.
|
||||
- [RSSHub](https://github.com/DIYgod/RSSHub): Generates RSS feeds for easier content subscription.
|
||||
|
||||
### AI service
|
||||
|
||||
Olares empowers AI capabilities with:
|
||||
beOS Pro 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)*
|
||||
@@ -208,13 +208,13 @@ An app for monitoring system resource usage.
|
||||
|
||||
### Control Hub
|
||||
|
||||
The console for Olares, providing precise and autonomous control over the system and its environment.
|
||||
The console for beOS Pro, providing precise and autonomous control over the system and its environment.
|
||||
|
||||
### Studio
|
||||
|
||||
A development tool for building and deploying Olares applications.
|
||||
A development tool for building and deploying beOS Pro applications.
|
||||
|
||||
## Learn more
|
||||
- To get started with Olares, see the [Getting Started guide](../../manual/get-started/index.md).
|
||||
- To learn more about the internals of Olares, see the topics in [Concept](index.md).
|
||||
- For in-depth details about how each component of Olares is orchestrated, see [Olares installation overview](../install/index.md).
|
||||
- To get started with beOS Pro, see the [Getting Started guide](../../manual/get-started/index.md).
|
||||
- To learn more about the internals of beOS Pro, see the topics in [Concept](index.md).
|
||||
- For in-depth details about how each component of beOS Pro is orchestrated, see [beOS Pro installation overview](../install/index.md).
|
||||
@@ -2,27 +2,27 @@
|
||||
|
||||
A Digital Identity Wallet is an essential tool in the self-sovereign identity ecosystem, allowing users to manage their decentralized identifiers (DIDs), credentials, and interactions with digital services, without relying on centralized entities for authentication or data sharing.
|
||||
|
||||
LarePass is the identity wallet app for Olares, the decentralized self-hosted OS based on Olares ID. LarePass allows users easily and securely manage DIDs, Olares IDs, and enables seamless access to Olares.
|
||||
beOS Pro app is the identity wallet app for beOS Pro, the decentralized self-hosted OS based on beOS ID. beOS Pro app allows users easily and securely manage DIDs, beOS IDs, and enables seamless access to beOS Pro.
|
||||
|
||||
## Manage Olares ID
|
||||
## Manage beOS ID
|
||||
|
||||
When users creates a Olares account, a DID is automatically generated in the beginning and then bound to the new Olares ID. LarePass facilitates the Olares ID management with the following functions:
|
||||
When users creates a beOS Pro account, a DID is automatically generated in the beginning and then bound to the new beOS ID. beOS Pro app facilitates the beOS ID management with the following functions:
|
||||
|
||||
|
||||
|
||||
|
||||
- Olares IDs creation
|
||||
- beOS IDs creation
|
||||
- Fast creation without VC binding
|
||||
- Advanced creation with VC binding (via the Gmail Issuer service)
|
||||
- Backup/Import Olares IDs with a mnemonic phrase for quick setup and account recovery
|
||||
- Manage multiple DIDs/Olares IDs
|
||||
- Backup/Import beOS IDs with a mnemonic phrase for quick setup and account recovery
|
||||
- Manage multiple DIDs/beOS IDs
|
||||
|
||||
See [Manage Accounts with LarePass](../../manual/larepass/create-account.md) for more detailed information.
|
||||
See [Manage Accounts with beOS Pro app](../../manual/larepass/create-account.md) for more detailed information.
|
||||
|
||||
## Manage VCs
|
||||
|
||||
LarePass allows users to manage their VCs that are bound to Olares IDs, enabling users to interact with VCs through signing, verification, discovery, and presentation processes.
|
||||
beOS Pro app allows users to manage their VCs that are bound to beOS IDs, enabling users to interact with VCs through signing, verification, discovery, and presentation processes.
|
||||
|
||||
|
||||
|
||||
::: tip NOTE
|
||||
These are just the core implementations of LarePass that are closely related to the identity wallet. For more details on LarePass and its usages, refer to the [LarePass documentation](../../manual/larepass/).
|
||||
These are just the core implementations of beOS Pro app that are closely related to the identity wallet. For more details on beOS Pro app and its usages, refer to the [beOS Pro app documentation](../../manual/larepass/).
|
||||
|
||||
@@ -87,9 +87,9 @@ Considering the complexity and uncertainty of usage scenarios of our contracts,
|
||||
|
||||
We follow EIP-7201 for contract data storage, which makes it easier and safer for contract upgrade and also facilitates granular control of data.
|
||||
|
||||
### Validation of Olares ID
|
||||
### Validation of beOS ID
|
||||
|
||||
Olares ID is submitted as a `string` type during registration. Although it is split by `.` for level separation, this cannot guarantee its correctness and readability. We implemented additional validation in contract code to ensure the submitted names are UTF-8-encoded readable strings.
|
||||
beOS ID is submitted as a `string` type during registration. Although it is split by `.` for level separation, this cannot guarantee its correctness and readability. We implemented additional validation in contract code to ensure the submitted names are UTF-8-encoded readable strings.
|
||||
|
||||
### Field Names of Structs in Tags
|
||||
|
||||
@@ -97,7 +97,7 @@ For gas efficiency, if there are structs in a tag type, their field names are pu
|
||||
|
||||
### Inline Assembly
|
||||
|
||||
We use slice types based on inline assembly to parse and traverse Olares ID levels, which can prevent copying substrings and reduce gas.
|
||||
We use slice types based on inline assembly to parse and traverse beOS ID levels, which can prevent copying substrings and reduce gas.
|
||||
|
||||
## Appendix - Requirements
|
||||
|
||||
@@ -107,9 +107,9 @@ We use slice types based on inline assembly to parse and traverse Olares ID leve
|
||||
- recording IPv4/IPv6, avatar, RSA public key etc. for DIDs
|
||||
- extending stored data for possible new needs in the future
|
||||
|
||||
### Olares ID
|
||||
### beOS ID
|
||||
|
||||
- distinguishing between two kinds of DIDs for Olares ID: Organization or Individual
|
||||
- distinguishing between two kinds of DIDs for beOS ID: Organization or Individual
|
||||
- derived DID management privilege for parent Organization
|
||||
|
||||
### Reputation
|
||||
|
||||
@@ -94,5 +94,5 @@ The Otmoic Reputation contract uses EIP-712 signature of DID owners for authenti
|
||||
|
||||
```
|
||||
|
||||
The Olares App Market Reputation contract also uses EIP-712 signature of DID owners for authentication. Rating data of the contract is stored in the `ratings` tag of Entity `<version>.<appname>.app.myterminus.com`, and comment data is published in the form of Ethereum events instead of storing on-chain.
|
||||
The beOS Pro App Market Reputation contract also uses EIP-712 signature of DID owners for authentication. Rating data of the contract is stored in the `ratings` tag of Entity `<version>.<appname>.app.myterminus.com`, and comment data is published in the form of Ethereum events instead of storing on-chain.
|
||||
:::
|
||||
|
||||
@@ -2,10 +2,10 @@
|
||||
|
||||
## Transaction Fee
|
||||
|
||||
When you apply for an Olares ID, we can afford the transaction fee for calling the contract. The rough process is:
|
||||
When you apply for an beOS ID, we can afford the transaction fee for calling the contract. The rough process is:
|
||||
|
||||
- You provide us the data and signature signed by your private key
|
||||
- We send the transaction to the smart contract
|
||||
- The blockchain records your data after signature verification
|
||||
|
||||
If you need to manage data under your domain in the future, you should call the contract via MetaMask. Alternatively, you can log in to Olares Space using LarePass and pay the the transaction fee by yourself.
|
||||
If you need to manage data under your domain in the future, you should call the contract via MetaMask. Alternatively, you can log in to Remote Space using beOS Pro app and pay the the transaction fee by yourself.
|
||||
|
||||
@@ -40,7 +40,7 @@ The owner of a domain can call `register(owner, MetaData(domain, did, note, allo
|
||||
> [!NOTE]
|
||||
> The first parameter **owner** is the specified owner of the new DID and the second parameter is a struct of metadata containing.
|
||||
>
|
||||
> - domain: the complete domain name of the new DID, which is also a Olares ID
|
||||
> - domain: the complete domain name of the new DID, which is also a beOS ID
|
||||
> - did: the DID derived from the owner's wallet
|
||||
> - note: notes about the new DID, used by off-chain systems for categorization
|
||||
> - allowSubdomain: whether to allow the new DID to register subdomains
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
# Use case with Olares
|
||||
# Use case with beOS Pro
|
||||
|
||||
While DIDs solve the issue of identity in a decentralized network, they are typically difficult for humans to remember or use in daily situations. Olares ID provides a familiar, easy-to-remember format similar to email addresses, while still leveraging the power and security of DIDs. Each Olares ID is bound to a DID.
|
||||
While DIDs solve the issue of identity in a decentralized network, they are typically difficult for humans to remember or use in daily situations. beOS ID provides a familiar, easy-to-remember format similar to email addresses, while still leveraging the power and security of DIDs. Each beOS ID is bound to a DID.
|
||||
|
||||
## Potential fairness issues
|
||||
|
||||
The **first-come, first-served** system in Olares ID registration may present some fairness issues, such as:
|
||||
The **first-come, first-served** system in beOS ID registration may present some fairness issues, such as:
|
||||
|
||||
1. **Fraud:** For instance, the Olares ID `elonmusk@myterminus.com` might be registered by someone who isn't actually Elon Mask.
|
||||
1. **Fraud:** For instance, the beOS ID `elonmusk@myterminus.com` might be registered by someone who isn't actually Elon Mask.
|
||||
2. **Speculation:** Pre-registration of popular names could lead to speculation, potentially boosting early network activity, but at the cost of fairness.
|
||||
|
||||
## VC process for Olares ID
|
||||
## VC process for beOS ID
|
||||
|
||||
To address the potential faireness concerns, we adopted principles from **Self-Sovereign Identity (SSI)** services proposed by the Web5 team, along with the [VC process](/developer/concepts/vc.md#verification-process) of Olares ID. This led us to design an **Issuer and Verifier** process to assist users in applying for a **Olares ID**.
|
||||
To address the potential faireness concerns, we adopted principles from **Self-Sovereign Identity (SSI)** services proposed by the Web5 team, along with the [VC process](/developer/concepts/vc.md#verification-process) of beOS ID. This led us to design an **Issuer and Verifier** process to assist users in applying for a **beOS ID**.
|
||||
|
||||
|
||||
|
||||
@@ -19,28 +19,28 @@ To address the potential faireness concerns, we adopted principles from **Self-S
|
||||
|
||||
We utilize Google's OAuth process to facilitate the issuance of **Verifiable Credentials (VCs)**. The simplified process is as follows:
|
||||
|
||||
1. Alice logs into her Gmail account via OAuth in LarePass, the wallet client.
|
||||
2. Google returns the OAuth credentials to LarePass.
|
||||
3. LarePass submits the OAuth credentials to the Issuer.
|
||||
1. Alice logs into her Gmail account via OAuth in beOS Pro app, the wallet client.
|
||||
2. Google returns the OAuth credentials to beOS Pro app.
|
||||
3. beOS Pro app submits the OAuth credentials to the Issuer.
|
||||
4. The Issuer confirms the validity of the credentials with Google's servers and retrieves basic information (e.g., email name).
|
||||
5. The Issuer issues a VC to Alice that matches the local part of her Gmail address.
|
||||
|
||||
Alice can now store the issued VC in LarePass.
|
||||
Alice can now store the issued VC in beOS Pro app.
|
||||
|
||||
:::tip NOTE
|
||||
- Throughout the process, Alice only reveals basic account data within the scope of the credential authorization to LarePass and the Issuer service, with password and privacy protection ensured by Google's OAuth protocol.
|
||||
- Throughout the process, Alice only reveals basic account data within the scope of the credential authorization to beOS Pro app and the Issuer service, with password and privacy protection ensured by Google's OAuth protocol.
|
||||
- All the code for setting up a Gmail Issuer Service or other Web2 service Issuer Services are open sourced on GitHub.
|
||||
:::
|
||||
|
||||
### Olares ID verifier service
|
||||
### beOS ID verifier service
|
||||
|
||||
Here's how the **Verifier Service** works on the Olares end:
|
||||
Here's how the **Verifier Service** works on the beOS Pro end:
|
||||
|
||||
1. Alice packages her DID, Olares ID, and Gmail VC into a **Verifiable Presentation (VP)** and submits the VP with its signature to the Verifier Service.
|
||||
1. Alice packages her DID, beOS ID, and Gmail VC into a **Verifiable Presentation (VP)** and submits the VP with its signature to the Verifier Service.
|
||||
2. The Verifier Service checks:
|
||||
- The signature's validity.
|
||||
- The validity of the VC in the VP.
|
||||
- Whether the Olares ID can be registered on the blockchain (conflicts may arise if multiple channels, such as Gmail and Twitter, are used for VC information).
|
||||
- Whether the beOS ID can be registered on the blockchain (conflicts may arise if multiple channels, such as Gmail and Twitter, are used for VC information).
|
||||
3. After all checks pass, the Verifier Service submits Alice's information to the blockchain and covers the Gas fees.
|
||||
|
||||
At this point, Alice successfully obtains her **Olares ID**. For example, if you apply with the Gmail address "hello@gmail.com", you'll receive the Olares ID "hello@myterminus.com" once all checks are completed.
|
||||
At this point, Alice successfully obtains her **beOS ID**. For example, if you apply with the Gmail address "hello@gmail.com", you'll receive the beOS ID "hello@myterminus.com" once all checks are completed.
|
||||
@@ -1,4 +1,4 @@
|
||||
# Olares
|
||||
# beOS Pro
|
||||
|
||||
## Directory structure
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Contributing To Olares
|
||||
# Contributing To beOS Pro
|
||||
|
||||
## Olares
|
||||
## beOS Pro
|
||||
|
||||
## TermiPass
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ outline: [2, 3]
|
||||
|
||||
The system application need to be installed under the `user-space` namespace. Therefore, certain modifications are required:
|
||||
|
||||
1. Modify the `deployment.yaml` file in the Olares Application Chart.
|
||||
1. Modify the `deployment.yaml` file in the beOS Pro Application Chart.
|
||||
2. Change the original namespace of `deployment` and `service` to `user-space-{\\{ .Values.bfl.username }}`
|
||||
|
||||
```Yaml
|
||||
@@ -17,7 +17,7 @@ The system application need to be installed under the `user-space` namespace. Th
|
||||
namespace: user-space-{{ .Values.bfl.username }}
|
||||
```
|
||||
|
||||
3. Add `annotations` and `labels` according to the configuration in the `deployment.yaml` file of the app in **Olares**.
|
||||
3. Add `annotations` and `labels` according to the configuration in the `deployment.yaml` file of the app in **beOS Pro**.
|
||||
|
||||
```Yaml
|
||||
metadata:
|
||||
@@ -29,11 +29,11 @@ The system application need to be installed under the `user-space` namespace. Th
|
||||
applications.app.bytetrade.io/owner: {{ .Values.bfl.username }}
|
||||
applications.app.bytetrade.io/author: bytetrade.io
|
||||
annotations:
|
||||
applications.app.bytetrade.io/icon: https://docs-dev.olares.com/icon.png
|
||||
applications.app.bytetrade.io/icon: https://docs-dev.beos.local/icon.png
|
||||
applications.app.bytetrade.io/title: Desktop-dev
|
||||
applications.app.bytetrade.io/version: '0.0.1'
|
||||
|
||||
# Configuration of entrances here should be consistent with the configuration in OlaresManifest.yaml.
|
||||
# Configuration of entrances here should be consistent with the configuration in beOS ProManifest.yaml.
|
||||
applications.app.bytetrade.io/entrances: '[{"name":"desktop-frontend-dev", "host":"desktop-svc-dev", "port":80,"title":"Desktop-dev"}]'
|
||||
```
|
||||
|
||||
@@ -55,14 +55,14 @@ The system application need to be installed under the `user-space` namespace. Th
|
||||
targetPort: 8080 # Please note, the port of the Node.js dev container is 8080. please switch to this port.
|
||||
```
|
||||
|
||||
5. Modify the section of entrances in `OlaresManifest.yaml`
|
||||
5. Modify the section of entrances in `beOS ProManifest.yaml`
|
||||
|
||||
```Yaml
|
||||
entrances:
|
||||
- name: desktop-frontend-dev # Same with annotation in deployment
|
||||
host: desktop-svc-dev # Same with the name in service
|
||||
port: 80
|
||||
icon: https://app.cdn.olares.com/appstore/default/defaulticon.webp
|
||||
icon: https://app.cdn.beos.local/appstore/default/defaulticon.webp
|
||||
title: Desktop-dev
|
||||
authLevel: private
|
||||
openMethod: default
|
||||
@@ -125,7 +125,7 @@ metadata:
|
||||
applications.app.bytetrade.io/owner: {{ .Values.bfl.username }}
|
||||
applications.app.bytetrade.io/author: bytetrade.io
|
||||
annotations:
|
||||
applications.app.bytetrade.io/icon: https://docs-dev.olares.com/icon.png
|
||||
applications.app.bytetrade.io/icon: https://docs-dev.beos.local/icon.png
|
||||
applications.app.bytetrade.io/title: Desktop-dev
|
||||
applications.app.bytetrade.io/version: '0.0.1'
|
||||
applications.app.bytetrade.io/entrances: '[{"name":"desktop-frontend-dev", "host":"desktop-svc-dev", "port":80,"title":"Desktop-dev"}]'
|
||||
|
||||
@@ -92,7 +92,7 @@ npm run dev
|
||||
add_header X-Frame-Options SAMEORIGIN;
|
||||
}
|
||||
```
|
||||
The configuration is exactly the same as when running in Olares, and no further modifications are required.
|
||||
The configuration is exactly the same as when running in beOS Pro, and no further modifications are required.
|
||||
|
||||
- Reload Nginx after modification.
|
||||
|
||||
@@ -234,6 +234,6 @@ The service cannot be started on ports 80, 8080, and 3000.
|
||||
|
||||
## Preview
|
||||
|
||||
After install the application, you can preview it by clicking on the app icon on the Olares.
|
||||
After install the application, you can preview it by clicking on the app icon on the beOS Pro.
|
||||
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# OlaresManifest.yaml
|
||||
# beOS ProManifest.yaml
|
||||
|
||||
## Permission
|
||||
|
||||
If you need to access the interface of `provider`, you can add following content in the `permissions` section of the `OlaresManifest.yaml` file.
|
||||
If you need to access the interface of `provider`, you can add following content in the `permissions` section of the `beOS ProManifest.yaml` file.
|
||||
```Yaml
|
||||
permission:
|
||||
sysData:
|
||||
@@ -28,13 +28,13 @@ env:
|
||||
```
|
||||
|
||||
---
|
||||
:::details Example of a complete `OlaresManifest.yaml` file
|
||||
:::details Example of a complete `beOS ProManifest.yaml` file
|
||||
```Yaml
|
||||
olaresManifest.version: 1
|
||||
olaresManifest.type: app
|
||||
metadata:
|
||||
name: desktop
|
||||
icon: https://app.cdn.olares.com/appstore/default/defaulticon.webp
|
||||
icon: https://app.cdn.beos.local/appstore/default/defaulticon.webp
|
||||
description: app desktop
|
||||
appid: desktop
|
||||
title: desktop
|
||||
@@ -45,7 +45,7 @@ entrances:
|
||||
- name: desktop-frontend-dev
|
||||
host: desktop-svc-dev
|
||||
port: 80
|
||||
icon: https://app.cdn.olares.com/appstore/default/defaulticon.webp
|
||||
icon: https://app.cdn.beos.local/appstore/default/defaulticon.webp
|
||||
title: Desktop-dev
|
||||
authLevel: private
|
||||
openMethod: default
|
||||
|
||||
@@ -1,18 +1,18 @@
|
||||
|
||||
# Develop System Application for Olares
|
||||
# Develop System Application for beOS Pro
|
||||
|
||||
::: tip Prerequisites Knowledge
|
||||
- Debugging third-party applications with **Studio**
|
||||
- Developing applications with **Studio**
|
||||
- Understanding the architecture and mechanisms of **Olares**
|
||||
- Understanding the architecture and mechanisms of **beOS Pro**
|
||||
:::
|
||||
|
||||
After a year and a half of work, the Olares team now uses **Studio** for developing system applications.
|
||||
After a year and a half of work, the beOS Pro team now uses **Studio** for developing system applications.
|
||||
|
||||
We will show you how to debug issues in the frontend code of **Desktop** using **Studio**.
|
||||
1. Create an application in Studio
|
||||
2. Configure [deployment.yaml](./deployment)
|
||||
3. Configure [OlaresManifest.yaml](./olares-manifest)
|
||||
3. Configure [beOS ProManifest.yaml](./olares-manifest)
|
||||
4. Install the application
|
||||
5. Configure [nginx.conf](./install)
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Account
|
||||
|
||||
If an app in Olares wants to use the system user as the app's user, it can obtain the user information by defining a `SysEventRegistry` in application chart to receive system user event callbacks.
|
||||
If an app in beOS Pro wants to use the system user as the app's user, it can obtain the user information by defining a `SysEventRegistry` in application chart to receive system user event callbacks.
|
||||
|
||||
- Define `user create` callback
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ outline: [2, 3]
|
||||
|
||||
## API Prefix
|
||||
|
||||
`agent.{username}.olares.com/api/controllers/console/api`
|
||||
`agent.{username}.beos.local/api/controllers/console/api`
|
||||
|
||||
## Basic Application Management API
|
||||
### Get App List
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# `olares change-ip`
|
||||
:::warning When manually updating IP address is required
|
||||
When Olares is deployed _inside_ a virtualized environment, such as macOS (via Minikube) or Windows (via WSL), a change in the host system's IP address (e.g., due to switching Wi-Fi networks) may cause Olares to become inaccessible. This happens because the NAT gateway and DNS configuration no longer match the new IP. In such cases, you need to manually update the IP address to ensure that Olares can route traffic correctly.
|
||||
When beOS Pro is deployed _inside_ a virtualized environment, such as macOS (via Minikube) or Windows (via WSL), a change in the host system's IP address (e.g., due to switching Wi-Fi networks) may cause beOS Pro to become inaccessible. This happens because the NAT gateway and DNS configuration no longer match the new IP. In such cases, you need to manually update the IP address to ensure that beOS Pro can route traffic correctly.
|
||||
:::
|
||||
|
||||
## Synopsis
|
||||
Change the local IP address for all Olares components.
|
||||
Change the local IP address for all beOS Pro components.
|
||||
|
||||
```bash
|
||||
olares-cli olares change-ip [option]
|
||||
@@ -14,11 +14,11 @@ olares-cli olares change-ip [option]
|
||||
|
||||
| Name | Shorthand | Usage |
|
||||
|------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--distribution` | `-d` | Sets the WSL distribution name. Only applicable on Windows. <br> Defaults to `Ubuntu`. |
|
||||
| `--help` | `-h` | Displays help information. |
|
||||
| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS. <br> Defaults to `olares-0`. |
|
||||
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. |
|
||||
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. |
|
||||
|
||||
## Examples
|
||||
- For macOS:
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
---
|
||||
# Olares CLI
|
||||
# beOS Pro CLI
|
||||
|
||||
Olares provides Olares CLI, a command-line tool for developers and system administrators to customize or troubleshoot the Olares installation process.
|
||||
beOS Pro provides beOS Pro CLI, a command-line tool for developers and system administrators to customize or troubleshoot the beOS Pro installation process.
|
||||
|
||||
The recommended [one-liner installation command](../../../../manual/get-started/install-olares.md) retrieves a shell script from https://olares.sh/ that downloads and installs Olares CLI. Once installed, the CLI orchestrates the remainder of the setup.
|
||||
The recommended [one-liner installation command](../../../../manual/get-started/install-olares.md) retrieves a shell script from https://olares.sh/ that downloads and installs beOS Pro CLI. Once installed, the CLI orchestrates the remainder of the setup.
|
||||
|
||||
In general, Olares CLI manages installation through three main phases:
|
||||
1. **Download**: Olares CLI fetches the necessary components.
|
||||
2. **Prepare**: Olares CLI prepares the environment for installation.
|
||||
3. **Install**: Olares CLI installs the core services of Olares.
|
||||
In general, beOS Pro CLI manages installation through three main phases:
|
||||
1. **Download**: beOS Pro CLI fetches the necessary components.
|
||||
2. **Prepare**: beOS Pro CLI prepares the environment for installation.
|
||||
3. **Install**: beOS Pro CLI installs the core services of beOS Pro.
|
||||
|
||||
This page explains the Olares CLI syntax and describes the command operations.
|
||||
This page explains the beOS Pro CLI syntax and describes the command operations.
|
||||
|
||||
:::info Root privileges required
|
||||
Most `olares-cli` commands require root privileges. Use the root user or prepend commands with `sudo`.
|
||||
:::
|
||||
|
||||
## Syntax
|
||||
The Olares CLI uses the following syntax:
|
||||
The beOS Pro CLI uses the following syntax:
|
||||
|
||||
> `olares-cli command [subcommand] [option]`
|
||||
|
||||
@@ -28,7 +28,7 @@ where
|
||||
- `subcommand`: Further specifies the task of `command`. For example, `wizard` or `component`.
|
||||
- `option`: Optional arguments that modify the behavior of the `command`. Options include flags and options with arguments.
|
||||
|
||||
Olares CLI allows you to temporarily override certain Olares default settings. Each option applies only to the command in which it is used.
|
||||
beOS Pro CLI allows you to temporarily override certain beOS Pro default settings. Each option applies only to the command in which it is used.
|
||||
|
||||
For example, if you use the `--base-dir` option with `olares-cli olares download wizard`, it will only affect the wizard downloading process and will not change the base directory for other commands, such as during the "install" phase.
|
||||
|
||||
@@ -38,13 +38,13 @@ To get detailed help for any command, run `olares-cli help`.
|
||||
|
||||
| Operation | Syntax | Description |
|
||||
|--------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `olares info` | `olares-cli olares info [option]` | Displays general information about the downloaded Olares OS. |
|
||||
| `olares info` | `olares-cli olares info [option]` | Displays general information about the downloaded beOS Pro. |
|
||||
| `olares download` | `olares-cli olares download [subcommand] [option]` | Downloads specific resources. |
|
||||
| `olares prepare` | `olares-cli olares prepare [option]` | Prepares the environment for the installation process, including setting up essential services and configurations of Olares. |
|
||||
| `olares install` | `olares-cli olares install [option]` | Deploys system-level and user-level components of Olares. |
|
||||
| `olares change-ip` | `olares-cli olares change-ip [option]` | Changes the IP address of the Olares OS. |
|
||||
| `olares release` | `olares-cli olares release [option]` | Packages Olares installation resources for distribution or deployment. |
|
||||
| `olares uninstall` | `olares-cli olares uninstall [option]` | Uninstalls Olares completely, or roll back the installation to a specific phase. |
|
||||
| `olares prepare` | `olares-cli olares prepare [option]` | Prepares the environment for the installation process, including setting up essential services and configurations of beOS Pro. |
|
||||
| `olares install` | `olares-cli olares install [option]` | Deploys system-level and user-level components of beOS Pro. |
|
||||
| `olares change-ip` | `olares-cli olares change-ip [option]` | Changes the IP address of the beOS Pro. |
|
||||
| `olares release` | `olares-cli olares release [option]` | Packages beOS Pro installation resources for distribution or deployment. |
|
||||
| `olares uninstall` | `olares-cli olares uninstall [option]` | Uninstalls beOS Pro completely, or roll back the installation to a specific phase. |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# `olares download`
|
||||
|
||||
## Synopsis
|
||||
The `olares download` command downloads the necessary packages and components required to install Olares on your local machine. It supports downloading components, checking the status of installation packages, and fetching the manifest file.
|
||||
The `olares download` command downloads the necessary packages and components required to install beOS Pro on your local machine. It supports downloading components, checking the status of installation packages, and fetching the manifest file.
|
||||
|
||||
```bash
|
||||
olares-cli olares download [subcommand] [option]
|
||||
@@ -11,26 +11,26 @@ olares-cli olares download [subcommand] [option]
|
||||
|
||||
| Name | Shorthand | Usage | Example |
|
||||
|-------------|-----------|-------------------------------------------------------|----------------------------------------|
|
||||
| `check` | | Checks the status of the Olares installation package. | `olares-cli olares download check` |
|
||||
| `component` | `c` | Downloads Olares components. | `olares-cli olares download component` |
|
||||
| `check` | | Checks the status of the beOS Pro installation package. | `olares-cli olares download check` |
|
||||
| `component` | `c` | Downloads beOS Pro components. | `olares-cli olares download component` |
|
||||
| `wizard` | `w` | Downloads the manifest file. | `olares-cli olares download wizard` |
|
||||
|
||||
## Options
|
||||
|
||||
| Name | Shorthand | Usage |
|
||||
|----------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--download-cdn-url` | | Sets the CDN accelerated download URL in the format `https://example.cdn.com`. <br>If not provided, the default URL will be used. |
|
||||
| `--help` | `-h` | Displays help information. |
|
||||
| `--kube` | | Specifies the Kubernetes type. <br>Supported types are `k3s` (default) and `k8s`. |
|
||||
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. |
|
||||
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. |
|
||||
|
||||
## Examples
|
||||
```bash
|
||||
# Specifies the base directory where all downloaded components will be stored.
|
||||
olares-cli olares download component -b /custom/path
|
||||
|
||||
# Specifies a CDN-accelerated URL for downloading Olares components.
|
||||
# Specifies a CDN-accelerated URL for downloading beOS Pro components.
|
||||
olares-cli olares download component --download-cdn-url https://my.cdn.com
|
||||
|
||||
# Specifies the Kubernetes type for the installation.
|
||||
@@ -39,7 +39,7 @@ olares-cli olares download component --kube k8s
|
||||
# Sets the path to the package manifest file.
|
||||
olares-cli olares download component --manifest /custom/path/manifest.json
|
||||
|
||||
# Specifies the version of Olares packages and components to download.
|
||||
# Specifies the version of beOS Pro packages and components to download.
|
||||
olares-cli olares download component -v 1.11.0
|
||||
```
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# `olares info`
|
||||
|
||||
## Synopsis
|
||||
The `olares info` command displays general information about the installed Olares version.
|
||||
The `olares info` command displays general information about the installed beOS Pro version.
|
||||
|
||||
```bash
|
||||
olares-cli olares info
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# `olares install`
|
||||
|
||||
## Synopsis
|
||||
The `olares install` command installs Olares on your system. It supports various options to customize the installation process, such as specifying directories, Kubernetes types, or Minikube profiles.
|
||||
The `olares install` command installs beOS Pro on your system. It supports various options to customize the installation process, such as specifying directories, Kubernetes types, or Minikube profiles.
|
||||
|
||||
```bash
|
||||
olares-cli olares install [option]
|
||||
@@ -11,9 +11,9 @@ olares-cli olares install [option]
|
||||
|
||||
| Name | Shorthand | Usage |
|
||||
|--------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--help` | `-h` | Displays help information. |
|
||||
| `--kube` | | Specifies the Kubernetes type. <br>Supported types are `k3s` (default) and `k8s`. |
|
||||
| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS. <br> Defaults to `olares-0`. |
|
||||
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. |
|
||||
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. |
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# `olares prepare`
|
||||
|
||||
## Synopsis
|
||||
The `olares prepare` command sets up the environment required for Olares to function. This includes installing dependencies, importing container images, and starting the Olares daemon (`olaresd`).
|
||||
The `olares prepare` command sets up the environment required for beOS Pro to function. This includes installing dependencies, importing container images, and starting the beOS Pro daemon (`olaresd`).
|
||||
```bash
|
||||
olares-cli olares prepare [option]
|
||||
```
|
||||
@@ -10,13 +10,13 @@ olares-cli olares prepare [option]
|
||||
|
||||
| Name | Shorthand | Usage |
|
||||
|----------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--help` | `-h` | Displays help information. |
|
||||
| `--kube` | | Specifies the Kubernetes type. <br>Supported types are `k3s` (default) and `k8s`. |
|
||||
| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS. <br> Defaults to `olares-0`. |
|
||||
| `--registry-mirrors` | `-r` | Specifies Docker container registry mirrors. <br> Multiple mirrors should be separated by commas. |
|
||||
| `--with-juicefs` | | Configures JuiceFS as the root filesystem (rootfs) for Olares workloads instead of the local disk. |
|
||||
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. |
|
||||
| `--with-juicefs` | | Configures JuiceFS as the root filesystem (rootfs) for beOS Pro workloads instead of the local disk. |
|
||||
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. |
|
||||
|
||||
## Example
|
||||
```bash
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# `olares release`
|
||||
|
||||
## Synopsis
|
||||
Build a release version based on a local Olares repository. This command should be run in the root directory of the Olares repository.
|
||||
Build a release version based on a local beOS Pro repository. This command should be run in the root directory of the beOS Pro repository.
|
||||
|
||||
```bash
|
||||
olares-cli olares release [option]
|
||||
@@ -11,10 +11,10 @@ olares-cli olares release [option]
|
||||
|
||||
| Name | Shorthand | Usage |
|
||||
|----------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--download-cdn-url` | | Sets the CDN URL used for downloading checksums of dependencies and images. <br> Defaults to `https://dc3p1870nn3cj.cloudfront.net`. |
|
||||
| `--extract` | `-e` | Extracts the release to the `--base-dir` after the build. Set to `false` if only the release file itself is needed. <br> Defaults to `true`. |
|
||||
| `--help` | `-h` | Displays help information. |
|
||||
| `---ignore-missing-images` | | Ignores missing images when downloading checksums from the CDN. <br> Disable this only if no new images are added, as the build may fail if the image is not uploaded to the CDN yet. <br> Defaults to `true`. |
|
||||
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. |
|
||||
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. |
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# `olares uninstall`
|
||||
|
||||
## Synopsis
|
||||
Uninstall Olares from your machine.
|
||||
Uninstall beOS Pro from your machine.
|
||||
|
||||
```bash
|
||||
olares-cli olares uninstall [option]
|
||||
@@ -11,9 +11,9 @@ olares-cli olares uninstall [option]
|
||||
|
||||
| Name | Shorthand | Usage |
|
||||
|--------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `--all` | | Uninstalls Olares completely, including dependencies installed during the "prepare" phase. |
|
||||
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--all` | | Uninstalls beOS Pro completely, including dependencies installed during the "prepare" phase. |
|
||||
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
|
||||
| `--help` | `-h` | Displays help information. |
|
||||
| `--phase` | | Uninstalls Olares from a specific phase and revert to the previous one. <br> For example, `--phase install` removes tasks performed during the "install" phase, reverting the system to the "prepare" stage. <br>Defaults to `install`. |
|
||||
| `--phase` | | Uninstalls beOS Pro from a specific phase and revert to the previous one. <br> For example, `--phase install` removes tasks performed during the "install" phase, reverting the system to the "prepare" stage. <br>Defaults to `install`. |
|
||||
| `--quiet` | | Enables quiet mode (suppress output). <br> Defaults to `false`. |
|
||||
| `--version` | `-v` | Specifies the Olares version to uninstall. <br>Use `olares-cli olares info` to check the downloaded version first. |
|
||||
| `--version` | `-v` | Specifies the beOS Pro version to uninstall. <br>Use `olares-cli olares info` to check the downloaded version first. |
|
||||
|
||||
@@ -1,22 +1,22 @@
|
||||
# Cookie
|
||||
|
||||
**Single Sign-On (SSO)** mode is utilized for authorization and authentication across the **Olares**, including all installed apps. **SSO** authentication is non-intrusive, using cookies as the authentication credential.
|
||||
**Single Sign-On (SSO)** mode is utilized for authorization and authentication across the **beOS Pro**, including all installed apps. **SSO** authentication is non-intrusive, using cookies as the authentication credential.
|
||||
|
||||
The system will set two cookies after login
|
||||
|
||||
- **authelia_session**
|
||||
|
||||
The content of the cookie is the session id of SSO. The scope is the user's Olares domain, `<username>.olares.com`
|
||||
The content of the cookie is the session id of SSO. The scope is the user's beOS Pro domain, `<username>.beos.local`
|
||||
|
||||
- **auth_token**
|
||||
|
||||
The user authenticated authorization token. The scope is the user's Olares domain, `<username>.olares.com`
|
||||
The user authenticated authorization token. The scope is the user's beOS Pro domain, `<username>.beos.local`
|
||||
|
||||
To prevent cookie conflicts, **no application** (whether it's a built-in system app or a third-party app) can set cookies to the user's domain. Cookies can only be set to the domain of the app.
|
||||
|
||||
Every application in **Olares** operates under two domains: <`app id>.<username>.olares.com` and `<app id>.local.<username>.olares.com`. As a result, Olares incorporates a cookie-setting `rewrite` mechanism within the Olares Application Runtime. This ensures that the application automatically assigns cookies for both domains in the Set-`Cookie` field of the **HTTP response**.
|
||||
Every application in **beOS Pro** operates under two domains: <`app id>.<username>.beos.local` and `<app id>.local.<username>.beos.local`. As a result, beOS Pro incorporates a cookie-setting `rewrite` mechanism within the beOS Pro Application Runtime. This ensures that the application automatically assigns cookies for both domains in the Set-`Cookie` field of the **HTTP response**.
|
||||
|
||||
To use this feature, you just need to define it in the application chart's [OlaresManifest.yaml](../package/manifest.md#resetcookie)
|
||||
To use this feature, you just need to define it in the application chart's [beOS ProManifest.yaml](../package/manifest.md#resetcookie)
|
||||
|
||||
```yaml
|
||||
options:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Database
|
||||
|
||||
The Olares system provides three most popular data storage cluster for all APPs, covering `RDS`, `NoSQL`, and `Cache` data storage use cases.
|
||||
The beOS Pro system provides three most popular data storage cluster for all APPs, covering `RDS`, `NoSQL`, and `Cache` data storage use cases.
|
||||
|
||||
## RDS
|
||||
|
||||
@@ -9,7 +9,7 @@ The system has deployed **PostgreSQL** and provides two types of databases.
|
||||
- **Standalone PostgreSQL**, providing the most commonly used `RDS` database layer functions.
|
||||
- **Distributed PostgreSQL** extension, powered by **Citus**. Provides the ability to horizontally scale the database.
|
||||
|
||||
When setting up a **PostgreSQL** database, you can specify the type of database to be used in [OlaresManifest.yaml](../package/manifest.md#middleware).
|
||||
When setting up a **PostgreSQL** database, you can specify the type of database to be used in [beOS ProManifest.yaml](../package/manifest.md#middleware).
|
||||
|
||||
```yaml
|
||||
middleware:
|
||||
@@ -20,13 +20,13 @@ postgres:
|
||||
distributed: true # Whether the database is distributed in the cluster.
|
||||
```
|
||||
|
||||
If you use **Citus**, **Olares** will automatically shard the database tables and perform rebalancing during the horizontal scaling of **PostgreSQL** replicas.
|
||||
If you use **Citus**, **beOS Pro** will automatically shard the database tables and perform rebalancing during the horizontal scaling of **PostgreSQL** replicas.
|
||||
|
||||
## NoSQL
|
||||
|
||||
The NoSQL cluster is not deployed by default in Olares, but it can be easily installed from the Market. To set up a NoSQL cluster, the administrator needs to install the [**MongoDB**](https://market.olares.com/middleware/mongodb) middleware. Once installed, the [Percona Operator for MongoDB](https://github.com/percona/percona-server-mongodb-operator) automatically manages the **MongoDB** cluster. Users can then horizontally scale **MongoDB** cluster replicas, as well as perform backup and restore operations on databases.
|
||||
The NoSQL cluster is not deployed by default in beOS Pro, but it can be easily installed from the Market. To set up a NoSQL cluster, the administrator needs to install the [**MongoDB**](https://market.beos.local/middleware/mongodb) middleware. Once installed, the [Percona Operator for MongoDB](https://github.com/percona/percona-server-mongodb-operator) automatically manages the **MongoDB** cluster. Users can then horizontally scale **MongoDB** cluster replicas, as well as perform backup and restore operations on databases.
|
||||
|
||||
You can specify detailed configuration for MongoDB in [OlaresManifest.yaml](../package/manifest.md#middleware) as follows:
|
||||
You can specify detailed configuration for MongoDB in [beOS ProManifest.yaml](../package/manifest.md#middleware) as follows:
|
||||
|
||||
```yaml
|
||||
middleware:
|
||||
@@ -47,9 +47,9 @@ options:
|
||||
|
||||
## Cache
|
||||
|
||||
In terms of the Cache cluster, Olares uses Redis Cluster. The cluster is managed by a customized [Redis Cluster Operator](https://github.com/beclab/redis-cluster-operator) to achieve cloud nativeness. It enables us to scale replicas horizontally in a convenient and effective manner.
|
||||
In terms of the Cache cluster, beOS Pro uses Redis Cluster. The cluster is managed by a customized [Redis Cluster Operator](https://github.com/beclab/redis-cluster-operator) to achieve cloud nativeness. It enables us to scale replicas horizontally in a convenient and effective manner.
|
||||
|
||||
To ensure **data isolation** between users and apps in the **Redis cluster**, the **Olares** system has added a **Redis cluster proxy**. It isolates data based on the `namespace`. This operation is transparent, meaning app developers typically do not need to be aware of it.
|
||||
To ensure **data isolation** between users and apps in the **Redis cluster**, the **beOS Pro** system has added a **Redis cluster proxy**. It isolates data based on the `namespace`. This operation is transparent, meaning app developers typically do not need to be aware of it.
|
||||
|
||||
Additionally, this proxy simplifies the process of connecting to clusters. It eliminates the need to switch from a **standalone Redis Client** to a **Redis Cluster client** in the app, thus simplifying app code modifications.
|
||||
|
||||
@@ -61,5 +61,5 @@ middleware:
|
||||
```
|
||||
|
||||
:::info NOTE
|
||||
Since Olares uses the Redis Cluster version, developers need to understand the usage restrictions of Redis Cluster in detail when using it.
|
||||
Since beOS Pro uses the Redis Cluster version, developers need to understand the usage restrictions of Redis Cluster in detail when using it.
|
||||
:::
|
||||
|
||||
@@ -4,11 +4,11 @@ outline: [2, 3]
|
||||
|
||||
# File Upload
|
||||
|
||||
There are many situations where you might need to upload local files to your edge when using **Olares**. The `Olares Application Runtime` provides a common file-upload component to simplify this process in app development. Moreover, this file-upload component features **resumable upload**.
|
||||
There are many situations where you might need to upload local files to your edge when using **beOS Pro**. The `beOS Pro Application Runtime` provides a common file-upload component to simplify this process in app development. Moreover, this file-upload component features **resumable upload**.
|
||||
|
||||
## How to install
|
||||
|
||||
To use this feature, simply add the following configuration to the [OlaresManifest.yaml](../package/manifest.md#upload) file in the application chart.
|
||||
To use this feature, simply add the following configuration to the [beOS ProManifest.yaml](../package/manifest.md#upload) file in the application chart.
|
||||
```yaml
|
||||
upload:
|
||||
fileType:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Advanced
|
||||
|
||||
1. [Olares CLI](cli/olares-cli.md)
|
||||
2. [Olares Info](./terminus-info)
|
||||
1. [beOS Pro CLI](cli/olares-cli.md)
|
||||
2. [beOS Pro Info](./terminus-info)
|
||||
3. [Service Provider](./provider.md)
|
||||
4. [AI](./ai.md)
|
||||
5. [Cookie](./cookie.md)
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
# Kubesphere
|
||||
|
||||
Olares has integrated many advanced features of Kubesphere like the multi-user system and cluster data monitoring. To install the official console tool from **Kubesphere**, download and install it from the **Olares** code repository.
|
||||
beOS Pro has integrated many advanced features of Kubesphere like the multi-user system and cluster data monitoring. To install the official console tool from **Kubesphere**, download and install it from the **beOS Pro** code repository.
|
||||
|
||||
```sh
|
||||
curl -LO https://github.com/Above-Os/terminus-os/raw/main/third-party/ks-console/ks-console-v3.3.0.tgz
|
||||
|
||||
# The username is your Olares ID
|
||||
# The username is your beOS ID
|
||||
sudo helm install console ./ks-console-v3.3.0.tgz \
|
||||
-n user-space-<username> \
|
||||
--set username=<username>
|
||||
```
|
||||
|
||||
After you install it, refresh your desktop. You'll then see the Console icon in Olares. Open Console and log in with your Olares ID and password.
|
||||
After you install it, refresh your desktop. You'll then see the Console icon in beOS Pro. Open Console and log in with your beOS ID and password.
|
||||
|
||||
@@ -39,7 +39,7 @@ status:
|
||||
|
||||
## Request Permission to Call Provider
|
||||
|
||||
You can configure it in the [OlaresManifest.yaml](../package/manifest.md#sysdata) as follows:
|
||||
You can configure it in the [beOS ProManifest.yaml](../package/manifest.md#sysdata) as follows:
|
||||
|
||||
```Yaml
|
||||
sysData:
|
||||
|
||||
@@ -4,9 +4,9 @@ outline: [2, 3]
|
||||
|
||||
# Secret
|
||||
|
||||
In an app, it's often necessary to save some important user information, such as `passwords` and `Access Tokens` for external systems. Olares provides a unified Vault, based on Infisical, to securely store various keys.
|
||||
In an app, it's often necessary to save some important user information, such as `passwords` and `Access Tokens` for external systems. beOS Pro provides a unified Vault, based on Infisical, to securely store various keys.
|
||||
|
||||
To retrieve this information, the app only needs a simple application for API access permission. This can be done by adding a `sysData` permission to the [OlaresManifest.yaml](../package/manifest.md#sysdata) in the application chart.
|
||||
To retrieve this information, the app only needs a simple application for API access permission. This can be done by adding a `sysData` permission to the [beOS ProManifest.yaml](../package/manifest.md#sysdata) in the application chart.
|
||||
|
||||
```yaml
|
||||
permission:
|
||||
|
||||
@@ -5,13 +5,13 @@ olares-info is an API without authentication. It displays publicly available sys
|
||||
## API Call
|
||||
|
||||
```
|
||||
https://<username>.olares.com/api/olares-info
|
||||
https://<username>.beos.local/api/olares-info
|
||||
```
|
||||
|
||||
## Data Structure
|
||||
|
||||
```json
|
||||
interface OlaresInfo {
|
||||
interface beOS ProInfo {
|
||||
olaresId: string;
|
||||
wizardStatus: string;
|
||||
enable_reverse_proxy: boolean;
|
||||
@@ -39,11 +39,11 @@ interface OlaresInfo {
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="text-align:left;">olaresId </td>
|
||||
<td style="text-align:left; white-space:normal; word-break:break-word;">The user's Olares ID follows a format like <code>username@domain.com</code>.</td>
|
||||
<td style="text-align:left; white-space:normal; word-break:break-word;">The user's beOS ID follows a format like <code>username@domain.com</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>wizardStatus</td>
|
||||
<td style="white-space:normal; word-break:break-word;">Activation status of Olares, possible statuses includes: <code>wait_activate_vault</code>, <code>vault_activating</code>, <code>vault_activate_failed</code>, <code>wait_activate_system</code>, <code>system_activating</code>, <code>system_activate_failed</code>, <code>wait_activate_network</code>, <code>network_activating</code>, <code>network_activate_failed</code>, <code>wait_reset_password</code>, <code>completed</code>. <br>When the status displays <code>completed</code>, it indicates that the system has been successfully activated. We advise against third-party programs executing excessive business-related logic before the system is fully activated.
|
||||
<td style="white-space:normal; word-break:break-word;">Activation status of beOS Pro, possible statuses includes: <code>wait_activate_vault</code>, <code>vault_activating</code>, <code>vault_activate_failed</code>, <code>wait_activate_system</code>, <code>system_activating</code>, <code>system_activate_failed</code>, <code>wait_activate_network</code>, <code>network_activating</code>, <code>network_activate_failed</code>, <code>wait_reset_password</code>, <code>completed</code>. <br>When the status displays <code>completed</code>, it indicates that the system has been successfully activated. We advise against third-party programs executing excessive business-related logic before the system is fully activated.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -52,11 +52,11 @@ interface OlaresInfo {
|
||||
</tr>
|
||||
<tr>
|
||||
<td>tailScaleEnable </td>
|
||||
<td>Whether the TailScale is activated. If so, all private entrances can only be accessed through the VPN. <br>Note: This field does not affect whether LarePass uses local access when connecting to Olares.</td>
|
||||
<td>Whether the TailScale is activated. If so, all private entrances can only be accessed through the VPN. <br>Note: This field does not affect whether beOS Pro app uses local access when connecting to beOS Pro.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>osVersion </td>
|
||||
<td>Olares version</td>
|
||||
<td>beOS Pro version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>avatar</td>
|
||||
@@ -68,7 +68,7 @@ interface OlaresInfo {
|
||||
</tr>
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>Every time the user activates Olares, a new unique ID is generated.</td>
|
||||
<td>Every time the user activates beOS Pro, a new unique ID is generated.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -4,12 +4,12 @@ outline: [2, 3]
|
||||
|
||||
# Websocket
|
||||
|
||||
**WebSocket** is one of the most widely used technologies in modern front-end development. To simplify its use in **Olares** app development, **Olares Application Runtime (TAPR)** provides a common **WebSocket** component.
|
||||
**WebSocket** is one of the most widely used technologies in modern front-end development. To simplify its use in **beOS Pro** app development, **beOS Pro Application Runtime (TAPR)** provides a common **WebSocket** component.
|
||||
|
||||
## Client
|
||||
|
||||
The Client is developed using `JavaScript/TypeScript` use the **ws** library.
|
||||
The application server provides the WebSocket through a URL formatted as `wss://<appid>.<username>.olares.com/ws`.
|
||||
The application server provides the WebSocket through a URL formatted as `wss://<appid>.<username>.beos.local/ws`.
|
||||
|
||||
### Send Message
|
||||
|
||||
@@ -160,7 +160,7 @@ Cookie: .... // New feature in version v1.0.3
|
||||
|
||||
## Deploy WebSocket Service in App
|
||||
|
||||
To use this feature, simply add the `websocket configuration` to the [OlaresManifest.yaml](../package/manifest.md#websocket) file in the application chart.
|
||||
To use this feature, simply add the `websocket configuration` to the [beOS ProManifest.yaml](../package/manifest.md#websocket) file in the application chart.
|
||||
```yaml
|
||||
options:
|
||||
websocket:
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how variables are injected during Olares app deployment, including declarative environment variables (.Values.olaresEnv) and system-injected runtime Helm values (.Values.*).
|
||||
description: Learn how variables are injected during beOS Pro app deployment, including declarative environment variables (.Values.olaresEnv) and system-injected runtime Helm values (.Values.*).
|
||||
---
|
||||
|
||||
# Environment variables overview
|
||||
|
||||
Olares apps use app-service to inject runtime context and configuration into the app's `values.yaml`. In Helm templates, you can reference these values via `.Values.*`.
|
||||
beOS Pro apps use app-service to inject runtime context and configuration into the app's `values.yaml`. In Helm templates, you can reference these values via `.Values.*`.
|
||||
|
||||
:::info Variables and Helm values
|
||||
In this document, "variables" mainly refer to Helm values. They are not automatically passed into container environment variables. If you need them inside containers, explicitly map them to `env:` in your templates.
|
||||
@@ -13,11 +13,11 @@ In this document, "variables" mainly refer to Helm values. They are not automati
|
||||
|
||||
## How variables are injected
|
||||
|
||||
Olares injects variables through two channels:
|
||||
beOS Pro injects variables through two channels:
|
||||
|
||||
- **Declarative environment variables**: The developer declares variables under `envs` in `OlaresManifest.yaml`. At deployment, app-service resolves and injects the values into `.Values.olaresEnv` in `values.yaml`.
|
||||
- **Declarative environment variables**: The developer declares variables under `envs` in `beOS ProManifest.yaml`. At deployment, app-service resolves and injects the values into `.Values.olaresEnv` in `values.yaml`.
|
||||
|
||||
- **System-injected runtime variables**: Injected automatically by Olares at deployment time. No declaration is required, though some values are only available after you declare the relevant dependency, such as middleware.
|
||||
- **System-injected runtime variables**: Injected automatically by beOS Pro at deployment time. No declaration is required, though some values are only available after you declare the relevant dependency, such as middleware.
|
||||
|
||||
## Next steps
|
||||
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
---
|
||||
outline: [2, 4]
|
||||
description: Declare and validate app configuration via envs in `OlaresManifest.yaml`, and reference values in templates through `.Values.olaresEnv`.
|
||||
description: Declare and validate app configuration via envs in `beOS ProManifest.yaml`, and reference values in templates through `.Values.olaresEnv`.
|
||||
---
|
||||
# Declarative environment variables
|
||||
|
||||
Use `envs` in `OlaresManifest.yaml` to declare the configuration parameters, such as passwords, API endpoints, or feature flags. During deployment, app-service resolves the values and injects them into `.Values.olaresEnv` in `values.yaml`. Reference them in Helm templates as <code v-pre>{{ .Values.olaresEnv.<envName> }}</code>.
|
||||
Use `envs` in `beOS ProManifest.yaml` to declare the configuration parameters, such as passwords, API endpoints, or feature flags. During deployment, app-service resolves the values and injects them into `.Values.olaresEnv` in `values.yaml`. Reference them in Helm templates as <code v-pre>{{ .Values.olaresEnv.<envName> }}</code>.
|
||||
|
||||
## Variable sources
|
||||
|
||||
Declarative variables can obtain values from configurations managed outside the application:
|
||||
|
||||
- **System variables**: Environment variables defined at the Olares cluster level. They are set during system installation or centrally managed by administrators, and are shared by all users within the cluster.
|
||||
- **User variables**: Environment variables defined at the Olares user level. They are managed individually by each user, and are isolated from one another within the same cluster.
|
||||
- **System variables**: Environment variables defined at the beOS Pro cluster level. They are set during system installation or centrally managed by administrators, and are shared by all users within the cluster.
|
||||
- **User variables**: Environment variables defined at the beOS Pro user level. They are managed individually by each user, and are isolated from one another within the same cluster.
|
||||
|
||||
Applications cannot modify these variables directly. To use them, map the variable via the `valueFrom` field.
|
||||
|
||||
@@ -21,7 +21,7 @@ Both system environment variables and user environment variables use the same ma
|
||||
|
||||
The following example maps the system variable `OLARES_SYSTEM_CDN_SERVICE` to an application variable `APP_CDN_ENDPOINT`:
|
||||
|
||||
1. In `OlaresManifest.yaml`, declare an app variable under `envs` and set `valueFrom.envName` to the system variable name.
|
||||
1. In `beOS ProManifest.yaml`, declare an app variable under `envs` and set `valueFrom.envName` to the system variable name.
|
||||
|
||||
```yaml
|
||||
# Map system variable OLARES_SYSTEM_CDN_SERVICE to app variable APP_CDN_ENDPOINT
|
||||
@@ -50,7 +50,7 @@ At deployment, app-service resolves the referenced variable and injects the valu
|
||||
```yaml
|
||||
# Injected by app-service into values.yaml at deployment
|
||||
olaresEnv:
|
||||
APP_CDN_ENDPOINT: "https://cdn.olares.com"
|
||||
APP_CDN_ENDPOINT: "https://cdn.beos.local"
|
||||
```
|
||||
|
||||
For the full list of available environment variables, see [Variable references](#variable-references).
|
||||
@@ -130,12 +130,12 @@ Loads the options list from a URL instead of defining it inline. The response bo
|
||||
# Options list fetched from remote URL at install time
|
||||
envs:
|
||||
- envName: VERSION
|
||||
remoteOptions: https://app.cdn.olares.com/appstore/windows/version_options.json
|
||||
remoteOptions: https://app.cdn.beos.local/appstore/windows/version_options.json
|
||||
```
|
||||
|
||||
### description
|
||||
|
||||
A human-readable description of the variable's purpose and valid values. Displayed in the Olares interface.
|
||||
A human-readable description of the variable's purpose and valid values. Displayed in the beOS Pro interface.
|
||||
|
||||
## Variable references
|
||||
|
||||
@@ -145,11 +145,11 @@ The following table lists system-level environment variables that can be referen
|
||||
|
||||
| Variable | Type | Default | Editable | Required | Description |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `OLARES_SYSTEM_REMOTE_SERVICE` | `url` | `https://api.olares.com` | Yes | Yes | Remote service endpoint for Olares, such as Market and Olares Space. |
|
||||
| `OLARES_SYSTEM_CDN_SERVICE` | `url` | `https://cdn.olares.com` | Yes | Yes | CDN endpoint for system resources. |
|
||||
| `OLARES_SYSTEM_REMOTE_SERVICE` | `url` | `https://api.beos.local` | Yes | Yes | Remote service endpoint for beOS Pro, such as Market and Remote Space. |
|
||||
| `OLARES_SYSTEM_CDN_SERVICE` | `url` | `https://cdn.beos.local` | Yes | Yes | CDN endpoint for system resources. |
|
||||
| `OLARES_SYSTEM_DOCKERHUB_SERVICE` | `url` | None | Yes | No | Docker Hub mirror or accelerator endpoint. |
|
||||
| `OLARES_SYSTEM_ROOT_PATH` | `string` | `/olares` | No | Yes | Olares root directory path. |
|
||||
| `OLARES_SYSTEM_ROOTFS_TYPE` | `string` | `fs` | No | Yes | Olares filesystem type. |
|
||||
| `OLARES_SYSTEM_ROOT_PATH` | `string` | `/olares` | No | Yes | beOS Pro root directory path. |
|
||||
| `OLARES_SYSTEM_ROOTFS_TYPE` | `string` | `fs` | No | Yes | beOS Pro filesystem type. |
|
||||
| `OLARES_SYSTEM_CUDA_VERSION` | `string` | None | No | No | Host CUDA version. |
|
||||
|
||||
### User environment variables
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
outline: [2, 4]
|
||||
description: Reference for runtime values injected into application `values.yaml` during Olares deployment.
|
||||
description: Reference for runtime values injected into application `values.yaml` during beOS Pro deployment.
|
||||
---
|
||||
|
||||
# System-injected runtime values
|
||||
|
||||
At deployment, Olares automatically injects a set of system-managed values into the app's `values.yaml`. These values are read-only and cover user identity, storage paths, cluster metadata, app dependencies, and middleware credentials.
|
||||
At deployment, beOS Pro automatically injects a set of system-managed values into the app's `values.yaml`. These values are read-only and cover user identity, storage paths, cluster metadata, app dependencies, and middleware credentials.
|
||||
|
||||
Because they are Helm values, they are not automatically available inside containers. To pass one into a container, map it explicitly under `env:` in your deployment template.
|
||||
|
||||
@@ -31,7 +31,7 @@ For the full list of available values, see [Value reference](#value-reference).
|
||||
|
||||
## Value references
|
||||
|
||||
The Type column describes the Helm value data type. It does not correspond to the `type` field in `OlaresManifest.yaml`.
|
||||
The Type column describes the Helm value data type. It does not correspond to the `type` field in `beOS ProManifest.yaml`.
|
||||
|
||||
### User and identity
|
||||
|
||||
@@ -46,7 +46,7 @@ The Type column describes the Helm value data type. It does not correspond to th
|
||||
| Value | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| `.Values.domain` | Map\<String,String> | App entrance URLs. Each entry maps an entrance name to its URL. |
|
||||
| `.Values.sysVersion` | String | Current Olares system version. |
|
||||
| `.Values.sysVersion` | String | Current beOS Pro system version. |
|
||||
| `.Values.deviceName` | String | Device name. |
|
||||
| `.Values.downloadCdnURL` | String | CDN address used for system resource downloads. |
|
||||
|
||||
@@ -101,7 +101,7 @@ Each entry in `.Values.nodes` follows this structure:
|
||||
|
||||
### Application dependencies
|
||||
|
||||
When an app declares a dependency in `OlaresManifest.yaml`, Olares injects connection information into `values.yaml`.
|
||||
When an app declares a dependency in `beOS ProManifest.yaml`, beOS Pro injects connection information into `values.yaml`.
|
||||
|
||||
| Value | Type | Description |
|
||||
| --- | --- | --- |
|
||||
@@ -128,7 +128,7 @@ When an app declares a dependency in `OlaresManifest.yaml`, Olares injects conne
|
||||
|
||||
### Middleware values
|
||||
|
||||
Middleware values are injected only after you declare the middleware dependency in the `middleware` section of `OlaresManifest.yaml`.
|
||||
Middleware values are injected only after you declare the middleware dependency in the `middleware` section of `beOS ProManifest.yaml`.
|
||||
|
||||
PostgreSQL and Redis are preinstalled. MongoDB, MinIO, RabbitMQ, MySQL and MariaDB must be installed separately before your app can use them.
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Understand how application distribution works in Olares.
|
||||
description: Understand how application distribution works in beOS Pro.
|
||||
---
|
||||
# Distribute Olares applications
|
||||
# Distribute beOS Pro applications
|
||||
|
||||
Distributing applications on Olares is based on open standards and automated validation.
|
||||
If your application is already packaged as an Olares Application Chart (OAC), you can publish it to Olares Market and make it available to users with minimal friction.
|
||||
Distributing applications on beOS Pro is based on open standards and automated validation.
|
||||
If your application is already packaged as an beOS Pro Application Chart (OAC), you can publish it to beOS Pro Market and make it available to users with minimal friction.
|
||||
|
||||
This guide walks you through the distribution lifecycle of an Olares application, from understanding how Market indexing works to publishing, maintaining, and promoting your app.
|
||||
This guide walks you through the distribution lifecycle of an beOS Pro application, from understanding how Market indexing works to publishing, maintaining, and promoting your app.
|
||||
|
||||
## Before you begin
|
||||
|
||||
Before distributing your application, it helps to understand a few core concepts:
|
||||
|
||||
- **[Olares Application Chart (OAC)](/developer/develop/package/chart.md)**
|
||||
- **[beOS Pro Application Chart (OAC)](/developer/develop/package/chart.md)**
|
||||
|
||||
The packaging format used to describe an Olares application, including metadata, ownership, versioning, and installation configuration.
|
||||
The packaging format used to describe an beOS Pro application, including metadata, ownership, versioning, and installation configuration.
|
||||
|
||||
- **Application index**
|
||||
|
||||
A service that provides application metadata to Olares Market. Olares includes a default public index, and developers can deploy their own.
|
||||
A service that provides application metadata to beOS Pro Market. beOS Pro includes a default public index, and developers can deploy their own.
|
||||
|
||||
- **Terminus-Gitbot**
|
||||
|
||||
@@ -52,18 +52,18 @@ To collaborate as a team:
|
||||
|
||||
### 1. Prepare your app package
|
||||
|
||||
Before an app can be distributed, it must be packaged as an **Olares Application Chart (OAC)**.
|
||||
Before an app can be distributed, it must be packaged as an **beOS Pro Application Chart (OAC)**.
|
||||
|
||||
At this stage, developers typically:
|
||||
- Develop and test the app on an Olares host.
|
||||
- Develop and test the app on an beOS Pro host.
|
||||
- Verify installation and upgrade behavior.
|
||||
- Finalize chart metadata and structure.
|
||||
|
||||
For details, see [Olares Application Chart (OAC)](/developer/develop/package/chart.md).
|
||||
For details, see [beOS Pro Application Chart (OAC)](/developer/develop/package/chart.md).
|
||||
|
||||
### 2. Submit the app to the default index
|
||||
|
||||
Olares Market indexes applications from Git repositories.
|
||||
beOS Pro Market indexes applications from Git repositories.
|
||||
To publish an app to the default public index, developers submit their OAC by opening a PR to the official repository.
|
||||
|
||||
During submission:
|
||||
@@ -78,7 +78,7 @@ For details, see [Submit applications](/developer/develop/submit-apps.md).
|
||||
After a PR is submitted, Terminus-Gitbot performs automated checks to ensure the submission follows distribution rules.
|
||||
|
||||
If all checks pass, the PR is merged automatically.
|
||||
After a short delay, the application becomes visible in Olares Market.
|
||||
After a short delay, the application becomes visible in beOS Pro Market.
|
||||
|
||||
### 4. Manage the application lifecycle
|
||||
|
||||
@@ -95,13 +95,13 @@ For details, see [Manage the app lifecycle](/developer/develop/manage-apps.md).
|
||||
|
||||
### 5. Optimize your Market listing
|
||||
|
||||
Once published, you can improve how your app is presented in Olares Market by adding icons, screenshots, and featured images.
|
||||
Once published, you can improve how your app is presented in beOS Pro Market by adding icons, screenshots, and featured images.
|
||||
|
||||
For details, see [Promote your apps](/developer/develop/promote-apps.md).
|
||||
|
||||
### 6. (Optional) Publish paid applications
|
||||
|
||||
Olares Market also supports paid application distribution.
|
||||
beOS Pro Market also supports paid application distribution.
|
||||
Paid apps require additional identity registration, pricing configuration, and license management.
|
||||
|
||||
For details, see [Publish paid applications](/developer/develop/paid-apps.md).
|
||||
@@ -1,8 +1,8 @@
|
||||
# Develop Olares applications
|
||||
# Develop beOS Pro applications
|
||||
|
||||
Developing applications on Olares leverages standard web technologies and containerization. If you are familiar with building web applications or Docker containers, you already have the skills needed to build for Olares.
|
||||
Developing applications on beOS Pro leverages standard web technologies and containerization. If you are familiar with building web applications or Docker containers, you already have the skills needed to build for beOS Pro.
|
||||
|
||||
This guide takes you through the complete lifecycle of an Olares application, from your first line of code in Studio to publishing on the Market.
|
||||
This guide takes you through the complete lifecycle of an beOS Pro application, from your first line of code in Studio to publishing on the Market.
|
||||
|
||||
## Before you begin
|
||||
Before getting started, it's helpful to review some concepts:
|
||||
@@ -10,21 +10,21 @@ Before getting started, it's helpful to review some concepts:
|
||||
- [Network](../concepts/network.md)
|
||||
|
||||
## Step 1: Develop with Studio
|
||||
Olares Studio is a development platform that accelerates your build cycle. It provides a pre-configured workspace to build, debug, and test your applications directly on the platform.
|
||||
beOS Pro Studio is a development platform that accelerates your build cycle. It provides a pre-configured workspace to build, debug, and test your applications directly on the platform.
|
||||
|
||||
* **[Deploy an app](./tutorial/deploy.md)**: Learn how to quickly deploy an app from an existing Docker image, configure it, and test it in Studio.
|
||||
* **[Develop in a dev container](./tutorial/develop.md)**: Spin up a remote development environment (Dev Container) and connect it to VS Code for a seamless coding experience.
|
||||
* **[Package and upload](./tutorial/package-upload.md)**: Convert your running application into an Olares-compatible package and upload it for testing.
|
||||
* **[Package and upload](./tutorial/package-upload.md)**: Convert your running application into an beOS Pro-compatible package and upload it for testing.
|
||||
* **[Add app assets](./tutorial/assets.md)**: Configure icons, screenshots, and descriptions to make your application store-ready.
|
||||
|
||||
## Step 2: Package your application
|
||||
To publish your application to the Olares Market, you must structure it according to the Olares Application Chart (OAC) specification. This format extends Helm Charts to support Olares-specific features like permission management and sandboxing.
|
||||
To publish your application to the beOS Pro Market, you must structure it according to the beOS Pro Application Chart (OAC) specification. This format extends Helm Charts to support beOS Pro-specific features like permission management and sandboxing.
|
||||
|
||||
* **[Understand the Olares Application Chart](./package/chart.md)**: Understand the file structure and requirements of an application package.
|
||||
* **[Understand `OlaresManifest.yaml`](./package/manifest.md)**: A comprehensive guide to the `OlaresManifest.yaml` file, which defines your app's metadata, permissions, and system integration points.
|
||||
* **[Understand Helm extensions](./package/extension.md)**: Learn about the custom fields and capabilities Olares adds to standard Helm deployments.
|
||||
* **[Understand the beOS Pro Application Chart](./package/chart.md)**: Understand the file structure and requirements of an application package.
|
||||
* **[Understand `beOS ProManifest.yaml`](./package/manifest.md)**: A comprehensive guide to the `beOS ProManifest.yaml` file, which defines your app's metadata, permissions, and system integration points.
|
||||
* **[Understand Helm extensions](./package/extension.md)**: Learn about the custom fields and capabilities beOS Pro adds to standard Helm deployments.
|
||||
|
||||
## Step 3: Submit your application
|
||||
Once your application is built and packaged, the final step is to share it with the Olares community.
|
||||
Once your application is built and packaged, the final step is to share it with the beOS Pro community.
|
||||
|
||||
* **[Submit to Market](/developer/develop/distribute-index.md)**: Learn how to submit your application to the Olares Market for review and distribution.
|
||||
* **[Submit to Market](/developer/develop/distribute-index.md)**: Learn how to submit your application to the beOS Pro Market for review and distribution.
|
||||
@@ -1,15 +1,15 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to update, suspend, or remove your application from Olares Market.
|
||||
description: Learn how to update, suspend, or remove your application from beOS Pro Market.
|
||||
---
|
||||
# Manage the app lifecycle
|
||||
|
||||
This guide explains how to manage an application after it has been published, including updating, suspending, or removing it from Olares Market.
|
||||
This guide explains how to manage an application after it has been published, including updating, suspending, or removing it from beOS Pro Market.
|
||||
|
||||
All actions are performed through Pull Requests (PRs) to the `main` branch. Terminus-Gitbot supports three lifecycle actions after your app is published:
|
||||
|
||||
- **UPDATE**: Keep your app up to date. Release new versions, fix bugs, or adjust configurations.
|
||||
- **SUSPEND**: Pause distribution. Stop new discovery, downloads, and installs in Olares Market without affecting existing users.
|
||||
- **SUSPEND**: Pause distribution. Stop new discovery, downloads, and installs in beOS Pro Market without affecting existing users.
|
||||
- **REMOVE**: Retire the app. Permanently stop distribution and prevent the chart folder name from being reused.
|
||||
|
||||
:::tip Reduce conflicts
|
||||
@@ -18,7 +18,7 @@ Before opening the PR, sync your fork and rebase your branch onto the latest `ma
|
||||
|
||||
## Control files
|
||||
|
||||
Control files are special empty files in the OAC root directory that manage an application's distribution status in Olares Market.
|
||||
Control files are special empty files in the OAC root directory that manage an application's distribution status in beOS Pro Market.
|
||||
|
||||
| File name | Used for | Version rule | Content needed |
|
||||
|--|--|--|--|
|
||||
@@ -38,7 +38,7 @@ The PR must meet the following requirements:
|
||||
- **No conflict**: The PR branch must not conflict with `beclab/apps:main`.
|
||||
|
||||
:::warning No rollbacks
|
||||
Olares Market does not support version rollbacks. If an issue occurs, you must submit a new version to fix it.
|
||||
beOS Pro Market does not support version rollbacks. If an issue occurs, you must submit a new version to fix it.
|
||||
:::
|
||||
|
||||
## Suspend an app (SUSPEND)
|
||||
@@ -50,11 +50,11 @@ The PR must meet the following requirements:
|
||||
- **Control file**: The OAC root directory contains the `.suspend` file and does not contain the `.remove` file.
|
||||
- **No conflict**: The PR branch must not conflict with `beclab/apps:main`.
|
||||
|
||||
After the PR is merged, the application is no longer listed in Olares Market. Users who have already installed the application can continue to use it.
|
||||
After the PR is merged, the application is no longer listed in beOS Pro Market. Users who have already installed the application can continue to use it.
|
||||
|
||||
## Remove an app (REMOVE)
|
||||
|
||||
To permanently remove an application from Olares Market, submit a PR with type `REMOVE`.
|
||||
To permanently remove an application from beOS Pro Market, submit a PR with type `REMOVE`.
|
||||
|
||||
The PR must meet the following requirements:
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to integrate your app with Elasticsearch service in Olares.
|
||||
description: Learn how to integrate your app with Elasticsearch service in beOS Pro.
|
||||
---
|
||||
# Integrate with Elasticsearch
|
||||
|
||||
Use Olares Elasticsearch middleware by declaring it in `OlaresManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
Use beOS Pro Elasticsearch middleware by declaring it in `beOS ProManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
|
||||
## Install Elasticsearch service
|
||||
|
||||
@@ -15,9 +15,9 @@ Install the Elasticsearch service from Market.
|
||||
|
||||
Once installed, the service and its connection details will appear in the Middleware list in Control Hub.
|
||||
|
||||
## Configure `OlaresManifest.yaml`
|
||||
## Configure `beOS ProManifest.yaml`
|
||||
|
||||
In `OlaresManifest.yaml`, add the required middleware configuration.
|
||||
In `beOS ProManifest.yaml`, add the required middleware configuration.
|
||||
|
||||
- Use the `username` field to specify the Elasticsearch user.
|
||||
- Use the `indexes` field to request one or more indexes. Each index name is used as the key in `.Values.elasticsearch.indexes`.
|
||||
@@ -53,7 +53,7 @@ containers:
|
||||
value: "{{ .Values.elasticsearch.password }}"
|
||||
|
||||
# Index name
|
||||
# The index name configured in OlaresManifest (for example, aaa)
|
||||
# The index name configured in beOS ProManifest (for example, aaa)
|
||||
- name: ES_INDEX
|
||||
value: "{{ .Values.elasticsearch.indexes.aaa }}"
|
||||
```
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to integrate your app with MariaDB service in Olares.
|
||||
description: Learn how to integrate your app with MariaDB service in beOS Pro.
|
||||
---
|
||||
# Integrate with MariaDB
|
||||
|
||||
Use Olares MariaDB middleware by declaring it in `OlaresManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
Use beOS Pro MariaDB middleware by declaring it in `beOS ProManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
|
||||
## Install MariaDB service
|
||||
|
||||
@@ -15,9 +15,9 @@ Install the MariaDB service from Market.
|
||||
|
||||
Once installed, the service and its connection details will appear in the Middleware list in Control Hub.
|
||||
|
||||
## Configure `OlaresManifest.yaml`
|
||||
## Configure `beOS ProManifest.yaml`
|
||||
|
||||
In `OlaresManifest.yaml`, add the required middleware configuration.
|
||||
In `beOS ProManifest.yaml`, add the required middleware configuration.
|
||||
|
||||
- Use the `username` field to specify the database username.
|
||||
- Use the `databases` field to request one or more databases. Each database name is used as the key in `.Values.mariadb.databases`.
|
||||
@@ -53,7 +53,7 @@ containers:
|
||||
value: "{{ .Values.mariadb.password }}"
|
||||
|
||||
# Database Name
|
||||
# The database name configured in OlaresManifest (e.g., aaa)
|
||||
# The database name configured in beOS ProManifest (e.g., aaa)
|
||||
- name: MDB_DB
|
||||
value: "{{ .Values.mariadb.databases.aaa }}"
|
||||
```
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to integrate your app with MinIO service in Olares.
|
||||
description: Learn how to integrate your app with MinIO service in beOS Pro.
|
||||
---
|
||||
# Integrate with MinIO
|
||||
|
||||
Use Olares MinIO middleware by declaring it in `OlaresManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
Use beOS Pro MinIO middleware by declaring it in `beOS ProManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
|
||||
## Install MinIO service
|
||||
|
||||
@@ -15,9 +15,9 @@ Install the MinIO service from Market.
|
||||
|
||||
Once installed, the service and its connection details will appear in the Middleware list in Control Hub.
|
||||
|
||||
## Configure `OlaresManifest.yaml`
|
||||
## Configure `beOS ProManifest.yaml`
|
||||
|
||||
In `OlaresManifest.yaml`, add the required middleware configuration.
|
||||
In `beOS ProManifest.yaml`, add the required middleware configuration.
|
||||
|
||||
- Use the `username` field to specify the MinIO access key.
|
||||
- Use the `buckets` field to request one or more buckets. Each bucket name is used as the key in `.Values.minio.buckets`.
|
||||
@@ -54,7 +54,7 @@ containers:
|
||||
value: "{{ .Values.minio.password }}"
|
||||
|
||||
# Bucket name
|
||||
# The bucket name configured in OlaresManifest (e.g., mybucket)
|
||||
# The bucket name configured in beOS ProManifest (e.g., mybucket)
|
||||
- name: MINIO_BUCKET
|
||||
value: "{{ .Values.minio.buckets.mybucket }}"
|
||||
```
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to integrate your app with MongoDB service in Olares.
|
||||
description: Learn how to integrate your app with MongoDB service in beOS Pro.
|
||||
---
|
||||
# Integrate with MongoDB
|
||||
|
||||
Use Olares MongoDB middleware by declaring it in `OlaresManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
Use beOS Pro MongoDB middleware by declaring it in `beOS ProManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
|
||||
## Install MongoDB service
|
||||
|
||||
@@ -15,9 +15,9 @@ Install the MongoDB service from Market.
|
||||
|
||||
Once installed, the service and its connection details will appear in the Middleware list in Control Hub.
|
||||
|
||||
## Configure `OlaresManifest.yaml`
|
||||
## Configure `beOS ProManifest.yaml`
|
||||
|
||||
In `OlaresManifest.yaml`, add the required middleware configuration.
|
||||
In `beOS ProManifest.yaml`, add the required middleware configuration.
|
||||
|
||||
- Use the `username` field to specify the MongoDB database user.
|
||||
- Use the `databases` field to request one or more databases.
|
||||
@@ -58,7 +58,7 @@ containers:
|
||||
value: "{{ .Values.mongodb.password }}"
|
||||
|
||||
# Database name
|
||||
# The database name configured in OlaresManifest (e.g., app_db)
|
||||
# The database name configured in beOS ProManifest (e.g., app_db)
|
||||
- name: MONGODB_DATABASE
|
||||
value: "{{ .Values.mongodb.databases.app_db }}"
|
||||
```
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to integrate your app with MySQL service in Olares.
|
||||
description: Learn how to integrate your app with MySQL service in beOS Pro.
|
||||
---
|
||||
# Integrate with MySQL
|
||||
|
||||
Use Olares MySQL middleware by declaring it in `OlaresManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
Use beOS Pro MySQL middleware by declaring it in `beOS ProManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
|
||||
## Install MySQL service
|
||||
|
||||
@@ -15,9 +15,9 @@ Install the MySQL service from Market.
|
||||
|
||||
Once installed, the service and its connection details will appear in the Middleware list in Control Hub.
|
||||
|
||||
## Configure `OlaresManifest.yaml`
|
||||
## Configure `beOS ProManifest.yaml`
|
||||
|
||||
In `OlaresManifest.yaml`, add the required middleware configuration.
|
||||
In `beOS ProManifest.yaml`, add the required middleware configuration.
|
||||
|
||||
- Use the `username` field to specify the MySQL database user.
|
||||
- Use the `databases` field to request one or more databases. Each database name is used as the key in `.Values.mysql.databases`.
|
||||
@@ -54,7 +54,7 @@ containers:
|
||||
value: "{{ .Values.mysql.password }}"
|
||||
|
||||
# Database name
|
||||
# The database name configured in OlaresManifest (e.g., aaa)
|
||||
# The database name configured in beOS ProManifest (e.g., aaa)
|
||||
- name: MDB_DB
|
||||
value: "{{ .Values.mysql.databases.aaa }}"
|
||||
```
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to integrate your app with the built-in PostgreSQL service in Olares.
|
||||
description: Learn how to integrate your app with the built-in PostgreSQL service in beOS Pro.
|
||||
---
|
||||
# Integrate with PostgreSQL
|
||||
|
||||
Use Olares PostgreSQL middleware by declaring it in `OlaresManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
Use beOS Pro PostgreSQL middleware by declaring it in `beOS ProManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
|
||||
:::info PosgreSQL installed
|
||||
PostgreSQL service has been installed by default.
|
||||
:::
|
||||
|
||||
## Configure `OlaresManifest.yaml`
|
||||
## Configure `beOS ProManifest.yaml`
|
||||
|
||||
In `OlaresManifest.yaml`, add the required middleware configuration.
|
||||
In `beOS ProManifest.yaml`, add the required middleware configuration.
|
||||
|
||||
- Use the `scripts` field to specify scripts that should be executed after the database is created.
|
||||
- Use the `extensions` field to add the corresponding extension in the database.
|
||||
|
||||
:::info Variable injection in scripts
|
||||
The OS provides two variables, `$databasename` and `$dbusername`, which will be replaced by Olares Application Runtime when the command is executed.
|
||||
The OS provides two variables, `$databasename` and `$dbusername`, which will be replaced by beOS Pro Application Runtime when the command is executed.
|
||||
:::
|
||||
|
||||
**Example**
|
||||
@@ -47,7 +47,7 @@ In your deployment YAML, map the injected `.Values.postgres.*` fields to the con
|
||||
containers:
|
||||
- name: my-app
|
||||
env:
|
||||
# The database name configured in OlaresManifest, specified in middleware.postgres.databases[i].name
|
||||
# The database name configured in beOS ProManifest, specified in middleware.postgres.databases[i].name
|
||||
# NOTE: Replace <dbname> with the actual name defined in the Manifest (e.g., immich)
|
||||
- name: DB_POSTGRESDB_DATABASE
|
||||
value: {{ .Values.postgres.databases.<dbname> }}
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to integrate your app with RabbitMQ service in Olares.
|
||||
description: Learn how to integrate your app with RabbitMQ service in beOS Pro.
|
||||
---
|
||||
# Integrate with RabbitMQ
|
||||
|
||||
Use Olares RabbitMQ middleware by declaring it in `OlaresManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
Use beOS Pro RabbitMQ middleware by declaring it in `beOS ProManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
|
||||
## Install RabbitMQ service
|
||||
|
||||
@@ -15,9 +15,9 @@ Install the RabbitMQ service from Market.
|
||||
|
||||
Once installed, the service and its connection details will appear in the Middleware list in Control Hub.
|
||||
|
||||
## Configure `OlaresManifest.yaml`
|
||||
## Configure `beOS ProManifest.yaml`
|
||||
|
||||
In `OlaresManifest.yaml`, add the required middleware configuration.
|
||||
In `beOS ProManifest.yaml`, add the required middleware configuration.
|
||||
|
||||
- Use the `username` field to specify the RabbitMQ user.
|
||||
- Use the `vhosts` field to request one or more virtual hosts (vhosts). Each vhost name is used as the key in `.Values.rabbitmq.vhosts`.
|
||||
@@ -54,7 +54,7 @@ containers:
|
||||
value: "{{ .Values.rabbitmq.password }}"
|
||||
|
||||
# Vhost
|
||||
# The vhost name configured in OlaresManifest (e.g., aaa)
|
||||
# The vhost name configured in beOS ProManifest (e.g., aaa)
|
||||
- name: RABBITMQ_VHOST
|
||||
value: "{{ .Values.rabbitmq.vhosts.aaa }}"
|
||||
```
|
||||
|
||||
@@ -1,18 +1,18 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to integrate your app with the built-in Redis service in Olares.
|
||||
description: Learn how to integrate your app with the built-in Redis service in beOS Pro.
|
||||
---
|
||||
# Integrate with Redis
|
||||
|
||||
Use Olares Redis middleware by declaring it in `OlaresManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
Use beOS Pro Redis middleware by declaring it in `beOS ProManifest.yaml`, then mapping the injected values to your container environment variables.
|
||||
|
||||
:::info Redis installed
|
||||
Redis service has been installed by default.
|
||||
:::
|
||||
|
||||
## Configure `OlaresManifest.yaml`
|
||||
## Configure `beOS ProManifest.yaml`
|
||||
|
||||
In `OlaresManifest.yaml`, add the required Redis middleware configuration.
|
||||
In `beOS ProManifest.yaml`, add the required Redis middleware configuration.
|
||||
|
||||
- Use the `password` field to specify the Redis access password.
|
||||
- Use the `namespace` field to request a Redis namespace.
|
||||
@@ -49,7 +49,7 @@ containers:
|
||||
value: "{{ .Values.redis.password }}"
|
||||
|
||||
# Namespace
|
||||
# NOTE: Replace <namespace> with the actual namespace defined in OlaresManifest (e.g., db0)
|
||||
# NOTE: Replace <namespace> with the actual namespace defined in beOS ProManifest (e.g., db0)
|
||||
- name: REDIS_NAMESPACE
|
||||
value: {{ .Values.redis.namespaces.<namespace> }}
|
||||
```
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn what middleware is in Olares and navigate to access and integration guides for each supported service.
|
||||
description: Learn what middleware is in beOS Pro and navigate to access and integration guides for each supported service.
|
||||
---
|
||||
# Middleware in Olares
|
||||
# Middleware in beOS Pro
|
||||
|
||||
Middleware refers to infrastructure services that sit between your application and the system, providing data storage, messaging, and other common capabilities.
|
||||
|
||||
Our middleware documentation is organized into two types of guides:
|
||||
- **Access and manage data**: Connect to a running service to inspect data and troubleshoot issues.
|
||||
- **App integrate**: Configure your app to use a middleware service in Olares using `OlaresManifest.yaml`.
|
||||
- **App integrate**: Configure your app to use a middleware service in beOS Pro using `beOS ProManifest.yaml`.
|
||||
|
||||
## Document types
|
||||
|
||||
@@ -29,11 +29,11 @@ The access method (e.g., CLI, Dashboard, or Bytebase) depends on the service.
|
||||
App integration guides explain how to connect your application to a middleware service.
|
||||
|
||||
Use these guides when you want your application to:
|
||||
- Declare dependencies in `OlaresManifest.yaml`.
|
||||
- Declare dependencies in `beOS ProManifest.yaml`.
|
||||
- Request service resources.
|
||||
- Read system-injected connection values in your application.
|
||||
|
||||
Integration is declarative and handled by Olares at deployment time.
|
||||
Integration is declarative and handled by beOS Pro at deployment time.
|
||||
|
||||
## Supported services
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to connect to and manage Elasticsearch data in Olares using Bytebase.
|
||||
description: Learn how to connect to and manage Elasticsearch data in beOS Pro using Bytebase.
|
||||
---
|
||||
# View Elasticsearch data
|
||||
|
||||
To use Elasticsearch in Olares, install it from Market first. This guide explains how to access and manage Elasticsearch data using Bytebase.
|
||||
To use Elasticsearch in beOS Pro, install it from Market first. This guide explains how to access and manage Elasticsearch data using Bytebase.
|
||||
|
||||
## Install Elasticsearch service
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to visualize Prometheus metrics in Olares using Grafana dashboards.
|
||||
description: Learn how to visualize Prometheus metrics in beOS Pro using Grafana dashboards.
|
||||
---
|
||||
# Use Grafana dashboards
|
||||
|
||||
To visualize system metrics in Olares, you can run Grafana and connect it to the built-in Prometheus service. This guide explains how to install Grafana, connect the data source, and import a standard dashboard.
|
||||
To visualize system metrics in beOS Pro, you can run Grafana and connect it to the built-in Prometheus service. This guide explains how to install Grafana, connect the data source, and import a standard dashboard.
|
||||
|
||||
## Install Grafana
|
||||
|
||||
@@ -30,7 +30,7 @@ After logging in, you will see the Grafana home page.
|
||||
|
||||
## Add Prometheus data source
|
||||
|
||||
Olares runs a built-in Prometheus service that collects system metrics.
|
||||
beOS Pro runs a built-in Prometheus service that collects system metrics.
|
||||
|
||||
To connect Grafana to this internal service:
|
||||
|
||||
@@ -38,9 +38,9 @@ To connect Grafana to this internal service:
|
||||
2. Click **Add data source**, then select **Prometheus**.
|
||||
3. For the **Prometheus server URL** field, enter:
|
||||
```text
|
||||
http://dashboard.<olaresid>.olares.com
|
||||
http://dashboard.<olaresid>.beos.local
|
||||
```
|
||||
Replace `<olaresid>` with your Olares ID.
|
||||
Replace `<olaresid>` with your beOS ID.
|
||||
4. Click **Save & test** at the bottom of the page. If the connection is successful, you will see the prompt below.
|
||||
{width=90% style="margin-left:0"}
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to connect to and manage MariaDB data in Olares using CLI or Bytebase.
|
||||
description: Learn how to connect to and manage MariaDB data in beOS Pro using CLI or Bytebase.
|
||||
---
|
||||
# View MariaDB data
|
||||
|
||||
To use MariaDB in Olares, install it from Market first. This guide explains how to access and manage MariaDB data using CLI or Bytebase.
|
||||
To use MariaDB in beOS Pro, install it from Market first. This guide explains how to access and manage MariaDB data using CLI or Bytebase.
|
||||
|
||||
## Install MariaDB service
|
||||
|
||||
@@ -30,9 +30,9 @@ Before connecting, obtain MariaDB connection details from Control Hub.
|
||||
|
||||
## Access via CLI
|
||||
|
||||
You can use the Olares terminal to access the MariaDB container for debugging or data operations.
|
||||
You can use the beOS Pro terminal to access the MariaDB container for debugging or data operations.
|
||||
|
||||
1. In Control Hub, open the Olares terminal at the bottom of the left navigation pane.
|
||||
1. In Control Hub, open the beOS Pro terminal at the bottom of the left navigation pane.
|
||||
2. Retrieve the Pod name for the middleware:
|
||||
|
||||
```bash
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to install MinIO and manage object storage in Olares using the MinIO Dashboard.
|
||||
description: Learn how to install MinIO and manage object storage in beOS Pro using the MinIO Dashboard.
|
||||
---
|
||||
# View MinIO data
|
||||
|
||||
This guide explains how to install MinIO and manage object storage using MinIO Dashboard in Olares.
|
||||
This guide explains how to install MinIO and manage object storage using MinIO Dashboard in beOS Pro.
|
||||
|
||||
## Install MinIO service
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to view and manage MongoDB data in Olares using CLI or Bytebase.
|
||||
description: Learn how to view and manage MongoDB data in beOS Pro using CLI or Bytebase.
|
||||
---
|
||||
# View MongoDB data
|
||||
|
||||
To use MongoDB in Olares, install it from Market first. This guide walks you through the installation steps and shows how to access it from Olares.
|
||||
To use MongoDB in beOS Pro, install it from Market first. This guide walks you through the installation steps and shows how to access it from beOS Pro.
|
||||
|
||||
## Install MongoDB service
|
||||
|
||||
@@ -29,9 +29,9 @@ Before connecting, obtain MongoDB connection details from the Control Hub.
|
||||
|
||||
## Access via CLI
|
||||
|
||||
You can use the Olares terminal to access the MongoDB container.
|
||||
You can use the beOS Pro terminal to access the MongoDB container.
|
||||
|
||||
1. In Control Hub, open the Olares terminal at the bottom of the left navigation pane.
|
||||
1. In Control Hub, open the beOS Pro terminal at the bottom of the left navigation pane.
|
||||
2. Retrieve the Pod name for the middleware:
|
||||
|
||||
```bash
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to view and manage MySQL data in Olares using CLI or Bytebase.
|
||||
description: Learn how to view and manage MySQL data in beOS Pro using CLI or Bytebase.
|
||||
---
|
||||
# View MySQL data
|
||||
|
||||
To use MySQL in Olares, install it from Market first. This guide walks you through the installation steps and shows how to access it from Olares.
|
||||
To use MySQL in beOS Pro, install it from Market first. This guide walks you through the installation steps and shows how to access it from beOS Pro.
|
||||
|
||||
## Install MySQL service
|
||||
|
||||
@@ -29,9 +29,9 @@ Before connecting, obtain MySQL connection details from the Control Hub.
|
||||
|
||||
## Access via CLI
|
||||
|
||||
You can use the Olares terminal to access the MySQL container.
|
||||
You can use the beOS Pro terminal to access the MySQL container.
|
||||
|
||||
1. In Control Hub, open the Olares terminal at the bottom of the left navigation pane.
|
||||
1. In Control Hub, open the beOS Pro terminal at the bottom of the left navigation pane.
|
||||
2. Enter the MySQL container. The container name is fixed.
|
||||
|
||||
```bash
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to subscribe to and publish messages in Olares using NATS CLI, and understand the NATS Subject naming rules and permission model.
|
||||
description: Learn how to subscribe to and publish messages in beOS Pro using NATS CLI, and understand the NATS Subject naming rules and permission model.
|
||||
---
|
||||
# Subscribe and publish messages with NATS
|
||||
|
||||
This guide explains how to use the `nats-box` CLI tool to test NATS message subscription and publication within the Olares cluster, and provides an overview of the NATS Subject naming rules and permission model.
|
||||
This guide explains how to use the `nats-box` CLI tool to test NATS message subscription and publication within the beOS Pro cluster, and provides an overview of the NATS Subject naming rules and permission model.
|
||||
|
||||
## Get connection information
|
||||
|
||||
@@ -25,7 +25,7 @@ Before connecting, obtain NATS connection details from the Control Hub.
|
||||
|
||||
### Deploy `nats-box`
|
||||
|
||||
1. Download the example [`nats-box.yaml`](http://cdn.olares.com/common/nats-box.yaml) file, then upload it to the Olares machine.
|
||||
1. Download the example [`nats-box.yaml`](http://cdn.beos.local/common/nats-box.yaml) file, then upload it to the beOS Pro machine.
|
||||
2. Navigate to the directory containing the YAML file and deploy `nats-box`:
|
||||
```bash
|
||||
kubectl apply -f nats-box.yaml
|
||||
@@ -55,7 +55,7 @@ nats pub <subject-from-controlhub> '{"hello":"world"}' --user=<user-from-control
|
||||
|
||||
## Subject naming and permission reference
|
||||
|
||||
This section describes the Subject naming convention and permission model used in Olares.
|
||||
This section describes the Subject naming convention and permission model used in beOS Pro.
|
||||
|
||||
### Subject structure
|
||||
|
||||
@@ -65,7 +65,7 @@ NATS Subjects use a three-level structure separated by dots (.): `<prefix>.<even
|
||||
|--|--|--|
|
||||
| 1st |`<prefix>` | Source Identifier. <ul><li>**System services**: Fixed as `os`.</li><li>**Third-party apps**: Uses the corresponding `appId`. </li></ul>|
|
||||
| 2nd | `<event>` | Event type or Domain. <br>Examples: `users`, `groups`, `files`, `notification`. |
|
||||
| 3rd |`<olaresId>` | Represents the Olares ID of the user space. |
|
||||
| 3rd |`<olaresId>` | Represents the beOS ID of the user space. |
|
||||
|
||||
### Permission model
|
||||
Read and write permissions for Subjects vary depending on the application type.
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to enable OpenTelemetry auto-instrumentation in an Olares cluster and view trace data in Jaeger.
|
||||
description: Learn how to enable OpenTelemetry auto-instrumentation in an beOS Pro cluster and view trace data in Jaeger.
|
||||
---
|
||||
# View OpenTelemetry data
|
||||
|
||||
This guide walks you through enabling OpenTelemetry auto-instrumentation for services running in an Olares cluster and viewing trace data in Jaeger.
|
||||
This guide walks you through enabling OpenTelemetry auto-instrumentation for services running in an beOS Pro cluster and viewing trace data in Jaeger.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Your target service runs as a Kubernetes workload (Deployment, StatefulSet, or DaemonSet).
|
||||
- You have access to run `kubectl` against the Olares cluster.
|
||||
- You have access to run `kubectl` against the beOS Pro cluster.
|
||||
- You can generate some traffic to the target service. Trace data is generated only when traffic exists.
|
||||
|
||||
## Install Jaeger
|
||||
@@ -23,8 +23,8 @@ Jaeger is used to visualize trace data. Install Jaeger from Market.
|
||||
|
||||
Prepare the tracing backend configuration before enabling auto-instrumentation.
|
||||
|
||||
1. Click [`otc.yaml`](https://cdn.olares.com/common/otc.yaml) to download the configuration file.
|
||||
2. Upload the file to your Olares host.
|
||||
1. Click [`otc.yaml`](https://cdn.beos.local/common/otc.yaml) to download the configuration file.
|
||||
2. Upload the file to your beOS Pro host.
|
||||
3. In the directory containing the file, apply it:
|
||||
```bash
|
||||
kubectl apply -f otc.yaml
|
||||
@@ -89,7 +89,7 @@ After you finish editing with `kubectl edit`, save and exit the editor. Kubernet
|
||||
instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/root/app"
|
||||
```
|
||||
|
||||
### Olares app (Deployment)
|
||||
### beOS Pro app (Deployment)
|
||||
|
||||
1. Edit the Deployment:
|
||||
```bash
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to view and manage PostgreSQL data in Olares using CLI or Bytebase.
|
||||
description: Learn how to view and manage PostgreSQL data in beOS Pro using CLI or Bytebase.
|
||||
---
|
||||
# View PostgreSQL data
|
||||
|
||||
PostgreSQL is available by default in Olares. This guide walks you through accessing it from Olares.
|
||||
PostgreSQL is available by default in beOS Pro. This guide walks you through accessing it from beOS Pro.
|
||||
|
||||
## Get connection information
|
||||
|
||||
@@ -21,9 +21,9 @@ Before connecting, obtain PostgreSQL connection details from the Control Hub.
|
||||
|
||||
## Access via CLI
|
||||
|
||||
You can use the Olares terminal to access the database container.
|
||||
You can use the beOS Pro terminal to access the database container.
|
||||
|
||||
1. In Control Hub, open the Olares terminal at the bottom of the left navigation pane.
|
||||
1. In Control Hub, open the beOS Pro terminal at the bottom of the left navigation pane.
|
||||
2. Enter the PostgreSQL container. The container name is fixed.
|
||||
|
||||
```bash
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to install RabbitMQ and manage RabbitMQ resources in Olares using RabbitMQ Dashboard.
|
||||
description: Learn how to install RabbitMQ and manage RabbitMQ resources in beOS Pro using RabbitMQ Dashboard.
|
||||
---
|
||||
# View RabbitMQ data
|
||||
|
||||
This guide explains how to install RabbitMQ and manage data using RabbitMQ Dashboard in Olares.
|
||||
This guide explains how to install RabbitMQ and manage data using RabbitMQ Dashboard in beOS Pro.
|
||||
|
||||
## Install RabbitMQ service
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to view and manage Redis data in Olares using CLI or Bytebase.
|
||||
description: Learn how to view and manage Redis data in beOS Pro using CLI or Bytebase.
|
||||
---
|
||||
# View Redis data
|
||||
|
||||
Redis is available by default in Olares. This guide walks you through accessing it from Olares.
|
||||
Redis is available by default in beOS Pro. This guide walks you through accessing it from beOS Pro.
|
||||
|
||||
## Get connection information
|
||||
|
||||
@@ -20,9 +20,9 @@ Before connecting, obtain Redis connection details from the Control Hub.
|
||||
|
||||
## Access via CLI
|
||||
|
||||
You can use the Olares terminal to access the database container.
|
||||
You can use the beOS Pro terminal to access the database container.
|
||||
|
||||
1. In Control Hub, open the Olares terminal at the bottom of the left navigation pane.
|
||||
1. In Control Hub, open the beOS Pro terminal at the bottom of the left navigation pane.
|
||||
2. Enter the Redis container. The container name is fixed.
|
||||
|
||||
```bash
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# Olares Application Chart Structure
|
||||
# beOS Pro Application Chart Structure
|
||||
|
||||
The Olares Application Chart is built upon the structure of **Helm Chart**, with extensions to accommodate specific **Olares** information. A standard application chart contains the following files:
|
||||
The beOS Pro Application Chart is built upon the structure of **Helm Chart**, with extensions to accommodate specific **beOS Pro** information. A standard application chart contains the following files:
|
||||
```
|
||||
|-- Chart.yaml # chart metadata
|
||||
|-- OlaresManifest.yaml # Olares Application configuration
|
||||
|-- beOS ProManifest.yaml # beOS Pro Application configuration
|
||||
|-- templates/ # chart deployment template files
|
||||
| |-- deployment.yaml # APP deployment script
|
||||
|-- crds/ # OPTIONAL: Custom Resource Definitions
|
||||
@@ -19,7 +19,7 @@ To make the templates directory easier to understand, you can split the deployme
|
||||
```
|
||||
AppName
|
||||
|-- Chart.yaml # Required: YAML file containing chart metadata
|
||||
|-- OlaresManifest.yaml # Required: containing App configuration
|
||||
|-- beOS ProManifest.yaml # Required: containing App configuration
|
||||
|-- values.yaml # Required: default configuration values of the chart
|
||||
|-- templates # Required: template directory, when combined with values, it can generate valid Kubernetes manifest files
|
||||
| |-- NOTES.txt # Optional: plain text file containing brief usage instructions
|
||||
@@ -35,7 +35,7 @@ AppName
|
||||
```
|
||||
RecommendName
|
||||
|-- Chart.yaml # Required: YAML file containing chart metadata
|
||||
|-- OlaresManifest.yaml # Required: containing Recommend configuration
|
||||
|-- beOS ProManifest.yaml # Required: containing Recommend configuration
|
||||
|-- values.yaml # Required: default configuration values of the chart
|
||||
|-- templates # Required: template directory, when combined with values, it can generate valid Kubernetes manifest files
|
||||
| |-- NOTES.txt # Optional: plain text file containing brief usage instructions
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Extensions field to Helm in Olares
|
||||
# Extensions field to Helm in beOS Pro
|
||||
|
||||
During installation, Olares injects extended field into the APP, using the configuration from [OlaresManifest.yaml](manifest.md).
|
||||
During installation, beOS Pro injects extended field into the APP, using the configuration from [beOS ProManifest.yaml](manifest.md).
|
||||
|
||||
The information from these extended fields can be directly referenced in the template without being defined in values.yaml. If there are definitions in values.yaml with the same name, the system value will overwrite them.
|
||||
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
outline: [2, 3]
|
||||
---
|
||||
|
||||
# OlaresManifest Specification
|
||||
# beOS ProManifest Specification
|
||||
|
||||
Every **Olares Application Chart** should include an `OlaresManifest.yaml` file in the root directory. `OlaresManifest.yaml` provides all the essential information about an Olares App. Both the **Olares Market protocol** and the Olares depend on this information to distribute and install applications.
|
||||
Every **beOS Pro Application Chart** should include an `beOS ProManifest.yaml` file in the root directory. `beOS ProManifest.yaml` provides all the essential information about an beOS Pro App. Both the **beOS Pro Market protocol** and the beOS Pro depend on this information to distribute and install applications.
|
||||
|
||||
:::info NOTE
|
||||
Latest Olares Manifest version: `0.11.0`
|
||||
Latest beOS Pro Manifest version: `0.11.0`
|
||||
- Removed deprecated fields of sysData
|
||||
- Updated the example of shared app
|
||||
- Added the apiVersion
|
||||
@@ -46,9 +46,9 @@ Latest Olares Manifest version: `0.11.0`
|
||||
- Change `spec`>`language` to `spec`>`locale` and support i18n
|
||||
:::
|
||||
|
||||
Here's an example of what a `OlaresManifest.yaml` file might look like:
|
||||
Here's an example of what a `beOS ProManifest.yaml` file might look like:
|
||||
|
||||
::: details OlaresManifest.yaml Example
|
||||
::: details beOS ProManifest.yaml Example
|
||||
|
||||
```yaml
|
||||
olaresManifest.version: '0.10.0'
|
||||
@@ -57,7 +57,7 @@ metadata:
|
||||
name: helloworld
|
||||
title: Hello World
|
||||
description: app helloworld
|
||||
icon: https://app.cdn.olares.com/appstore/default/defaulticon.webp
|
||||
icon: https://app.cdn.beos.local/appstore/default/defaulticon.webp
|
||||
version: 0.0.1
|
||||
categories:
|
||||
- Utilities
|
||||
@@ -66,7 +66,7 @@ entrances:
|
||||
port: 8080
|
||||
title: Hello World
|
||||
host: helloworld
|
||||
icon: https://app.cdn.olares.com/appstore/default/defaulticon.webp
|
||||
icon: https://app.cdn.beos.local/appstore/default/defaulticon.webp
|
||||
authLevel: private
|
||||
permission:
|
||||
appCache: true
|
||||
@@ -113,21 +113,21 @@ options:
|
||||
- Type: `string`
|
||||
- Accepted Value: `app`, `recommend`, `middleware`
|
||||
|
||||
Olares currently supports 3 types of applications, each requiring different fields. This document uses `app` as an example to explain each field. For information on other types, please refer to the corresponding configuration guide.
|
||||
beOS Pro currently supports 3 types of applications, each requiring different fields. This document uses `app` as an example to explain each field. For information on other types, please refer to the corresponding configuration guide.
|
||||
- [Recommend Configuration Guide](recommend.md)
|
||||
|
||||
:::info NOTE
|
||||
`recommend` apps will not be listed in the Olares Market, but you can install recommendation algorithms for Wise by uploading a custom Chart.
|
||||
`recommend` apps will not be listed in the beOS Pro Market, but you can install recommendation algorithms for Wise by uploading a custom Chart.
|
||||
:::
|
||||
|
||||
## olaresManifest.version
|
||||
|
||||
- Type: `string`
|
||||
|
||||
As Olares evolves, the configuration specification of `OlaresManifest.yaml` may change. You can identify whether these changes will affect your application by checking the `olaresManifest.version`. The `olaresManifest.version` consists of three integers separated by periods.
|
||||
As beOS Pro evolves, the configuration specification of `beOS ProManifest.yaml` may change. You can identify whether these changes will affect your application by checking the `olaresManifest.version`. The `olaresManifest.version` consists of three integers separated by periods.
|
||||
|
||||
- An increase in the **first digit** indicates the introduction of incompatible configuration items. Applications that haven't updated their `OlaresManifest.yaml` will be unable to distribute or install.
|
||||
- An increase in the **second digit** signifies changes in the mandatory fields for distribution and installation. However, the Olares remains compatible with the application distribution and installation of previous configuration versions. We recommend developers to promptly update and upgrade the application's `OlaresManifest.yaml` file.
|
||||
- An increase in the **first digit** indicates the introduction of incompatible configuration items. Applications that haven't updated their `beOS ProManifest.yaml` will be unable to distribute or install.
|
||||
- An increase in the **second digit** signifies changes in the mandatory fields for distribution and installation. However, the beOS Pro remains compatible with the application distribution and installation of previous configuration versions. We recommend developers to promptly update and upgrade the application's `beOS ProManifest.yaml` file.
|
||||
- A change in the **third digit** does not affect the application's distribution and installation.
|
||||
|
||||
Developers can use 1-3 digit version numbers to indicate the application's configuration version. Here are some examples of valid versions:
|
||||
@@ -147,7 +147,7 @@ For shared applications, use version `v2`, which supports multiple subcharts in
|
||||
|
||||
## Metadata
|
||||
|
||||
Basic information about the app shown in the system and Olares Market.
|
||||
Basic information about the app shown in the system and beOS Pro Market.
|
||||
|
||||
:::info Example
|
||||
```yaml
|
||||
@@ -155,7 +155,7 @@ metadata:
|
||||
name: nextcloud
|
||||
title: Nextcloud
|
||||
description: The productivity platform that keeps you in control
|
||||
icon: https://app.cdn.olares.com/appstore/nextcloud/icon.png
|
||||
icon: https://app.cdn.beos.local/appstore/nextcloud/icon.png
|
||||
version: 0.0.2
|
||||
categories:
|
||||
- Utilities
|
||||
@@ -168,25 +168,25 @@ metadata:
|
||||
- Type: `string`
|
||||
- Accepted Value: `^[a-z][a-z0-9]{0,29}$`
|
||||
|
||||
App’s namespace in Olares, lowercase alphanumeric characters only. It can be up to 30 characters, and needs to be consistent with `FolderName` and `name` field in `Chart.yaml`.
|
||||
App’s namespace in beOS Pro, lowercase alphanumeric characters only. It can be up to 30 characters, and needs to be consistent with `FolderName` and `name` field in `Chart.yaml`.
|
||||
|
||||
### title
|
||||
|
||||
- Type: `string`
|
||||
|
||||
The title of your app shown in the Olares Market. Must be within `30` characters.
|
||||
The title of your app shown in the beOS Pro Market. Must be within `30` characters.
|
||||
|
||||
### description
|
||||
|
||||
- Type: `string`
|
||||
|
||||
A short description appears below app title in the Olares Market.
|
||||
A short description appears below app title in the beOS Pro Market.
|
||||
|
||||
### icon
|
||||
|
||||
- Type: `url`
|
||||
|
||||
Your app icon that appears in the Olares Market.
|
||||
Your app icon that appears in the beOS Pro Market.
|
||||
|
||||
The app's icon must be a `PNG` or `WEBP` format file, up to `512 KB`, with a size of `256x256 px`.
|
||||
|
||||
@@ -200,7 +200,7 @@ The **Chart Version** of the application. It should be incremented each time the
|
||||
|
||||
- Type: `list<string>`
|
||||
|
||||
Used to display your app on different category page in Olares Market.
|
||||
Used to display your app on different category page in beOS Pro Market.
|
||||
|
||||
Accepted Value for OS 1.11:
|
||||
- `Blockchain`, `Utilities`, `Social Network`, `Entertainment`, `Productivity`
|
||||
@@ -215,7 +215,7 @@ Accepted Value for OS 1.12:
|
||||
- `AI`
|
||||
|
||||
:::info NOTE
|
||||
Olares Market categories were updated in OS 1.12.0. To ensure your app is compatible with both versions 1.11 and 1.12, include category values for both versions in your configuration.
|
||||
beOS Pro Market categories were updated in OS 1.12.0. To ensure your app is compatible with both versions 1.11 and 1.12, include category values for both versions in your configuration.
|
||||
:::
|
||||
|
||||
## Entrances
|
||||
@@ -261,14 +261,14 @@ entrances:
|
||||
|
||||
- Type: `string`
|
||||
|
||||
Title that appears in the Olares desktop after installed. It can be up to `30` characters.
|
||||
Title that appears in the beOS Pro desktop after installed. It can be up to `30` characters.
|
||||
|
||||
### icon
|
||||
|
||||
- Type: `url`
|
||||
- Optional
|
||||
|
||||
Icon that appears in the Olares desktop after installed. The app's icon must be a `PNG` or `WEBP` format file, up to `512 KB`, with a size of `256x256 px`.
|
||||
Icon that appears in the beOS Pro desktop after installed. The app's icon must be a `PNG` or `WEBP` format file, up to `512 KB`, with a size of `256x256 px`.
|
||||
|
||||
### authLevel
|
||||
|
||||
@@ -288,7 +288,7 @@ Specify the authentication level of the entrance.
|
||||
- Default: `false`
|
||||
- Optional
|
||||
|
||||
When `invisible` is `true`, the entrance will not be displayed on the Olares desktop.
|
||||
When `invisible` is `true`, the entrance will not be displayed on the beOS Pro desktop.
|
||||
|
||||
### openMethod
|
||||
|
||||
@@ -346,7 +346,7 @@ sharedEntrances:
|
||||
host: sharedentrances-ollama
|
||||
port: 0
|
||||
title: Ollama API
|
||||
icon: https://app.cdn.olares.com/appstore/ollama/icon.png
|
||||
icon: https://app.cdn.beos.local/appstore/ollama/icon.png
|
||||
invisible: true
|
||||
authLevel: internal
|
||||
```
|
||||
@@ -373,7 +373,7 @@ ports:
|
||||
- Optional
|
||||
- Accepted Value: `0-65535`, except reserved ports `22`, `80`, `81`, `443`, `444`, `2379`, `18088`.
|
||||
|
||||
Olares will expose the ports you specify for an application, which are accessible via the application domain name in the local network, for example: `84864c1f.your_olares_id.olares.com:46879`. For each port you expose, Olares configures both TCP and UDP with the same port number.
|
||||
beOS Pro will expose the ports you specify for an application, which are accessible via the application domain name in the local network, for example: `84864c1f.your_olares_id.beos.local:46879`. For each port you expose, beOS Pro configures both TCP and UDP with the same port number.
|
||||
|
||||
:::info NOTE
|
||||
The exposed ports can only be accessed on the local network or through a VPN.
|
||||
@@ -384,7 +384,7 @@ The exposed ports can only be accessed on the local network or through a VPN.
|
||||
- Optional
|
||||
- Accepted Value: `udp`, `tcp`
|
||||
|
||||
The protocol used for the exposed port. If specified, Olares exposes only the specified protocol. If omitted, Olares exposes both UDP and TCP by default.
|
||||
The protocol used for the exposed port. If specified, beOS Pro exposes only the specified protocol. If omitted, beOS Pro exposes both UDP and TCP by default.
|
||||
|
||||
### addToTailscaleAcl
|
||||
- Type: `boolean`
|
||||
@@ -482,7 +482,7 @@ provider:
|
||||
:::
|
||||
|
||||
## Spec
|
||||
Additional information about the application, primarily used for display in the Olares Market.
|
||||
Additional information about the application, primarily used for display in the beOS Pro Market.
|
||||
|
||||
:::info Example
|
||||
```yaml
|
||||
@@ -490,13 +490,13 @@ spec:
|
||||
versionName: '10.8.11'
|
||||
# The version of the application that this chart contains. It is recommended to enclose the version number in quotes. This value corresponds to the appVersion field in the `Chart.yaml` file. Note that it is not related to the `version` field.
|
||||
|
||||
featuredImage: https://app.cdn.olares.com/appstore/jellyfin/promote_image_1.jpg
|
||||
featuredImage: https://app.cdn.beos.local/appstore/jellyfin/promote_image_1.jpg
|
||||
# The featured image is displayed when the app is featured in the Market.
|
||||
|
||||
promoteImage:
|
||||
- https://app.cdn.olares.com/appstore/jellyfin/promote_image_1.jpg
|
||||
- https://app.cdn.olares.com/appstore/jellyfin/promote_image_2.jpg
|
||||
- https://app.cdn.olares.com/appstore/jellyfin/promote_image_3.jpg
|
||||
- https://app.cdn.beos.local/appstore/jellyfin/promote_image_1.jpg
|
||||
- https://app.cdn.beos.local/appstore/jellyfin/promote_image_2.jpg
|
||||
- https://app.cdn.beos.local/appstore/jellyfin/promote_image_3.jpg
|
||||
fullDescription: |
|
||||
Jellyfin is the volunteer-built media solution that puts you in control of your media. Stream to any device from your own server, with no strings attached. Your media, your server, your way.
|
||||
upgradeDescription: |
|
||||
@@ -505,7 +505,7 @@ spec:
|
||||
website: https://jellyfin.org/
|
||||
doc: https://jellyfin.org/docs/
|
||||
sourceCode: https://github.com/jellyfin/jellyfin
|
||||
submitter: Olares
|
||||
submitter: beOS Pro
|
||||
locale:
|
||||
- en-US
|
||||
- zh-CN
|
||||
@@ -537,24 +537,24 @@ spec:
|
||||
|
||||
### i18n
|
||||
|
||||
To add multi-language support for your app in Olares Market:
|
||||
To add multi-language support for your app in beOS Pro Market:
|
||||
|
||||
1. Create an `i18n` folder in the Olares Application Chart root directory.
|
||||
1. Create an `i18n` folder in the beOS Pro Application Chart root directory.
|
||||
2. In the `i18n` folder, create separate subdirectories for each supported locale.
|
||||
3. In each locale subdirectory, place a localized version of the `OlaresManifest.yaml` file.
|
||||
3. In each locale subdirectory, place a localized version of the `beOS ProManifest.yaml` file.
|
||||
|
||||
Olares Market will automatically display the content of the corresponding "OlaresManifest.yaml" file based on users' locale settings.
|
||||
beOS Pro Market will automatically display the content of the corresponding "beOS ProManifest.yaml" file based on users' locale settings.
|
||||
:::info Example
|
||||
```
|
||||
.
|
||||
├── Chart.yaml
|
||||
├── README.md
|
||||
├── OlaresManifest.yaml
|
||||
├── beOS ProManifest.yaml
|
||||
├── i18n
|
||||
│ ├── en-US
|
||||
│ │ └── OlaresManifest.yaml
|
||||
│ │ └── beOS ProManifest.yaml
|
||||
│ └── zh-CN
|
||||
│ └── OlaresManifest.yaml
|
||||
│ └── beOS ProManifest.yaml
|
||||
├── owners
|
||||
├── templates
|
||||
│ └── deployment.yaml
|
||||
@@ -588,7 +588,7 @@ spec:
|
||||
:::
|
||||
|
||||
:::info NOTE
|
||||
Olares does not support mixed-architecture clusters for now.
|
||||
beOS Pro does not support mixed-architecture clusters for now.
|
||||
:::
|
||||
|
||||
### onlyAdmin
|
||||
@@ -602,13 +602,13 @@ When set to `true`, only the admin can install this app.
|
||||
- Type: `boolean`
|
||||
- Optional
|
||||
|
||||
When set to `true`, Olares forces the application to run under user ID `1000` (as a non-root user).
|
||||
When set to `true`, beOS Pro forces the application to run under user ID `1000` (as a non-root user).
|
||||
|
||||
## Middleware
|
||||
- Type: `map`
|
||||
- Optional
|
||||
|
||||
Olares provides highly available middleware services. Developers do not need to install middleware repeatedly. Add the required middleware here, then use the corresponding middleware values in the application's deployment YAML file.
|
||||
beOS Pro provides highly available middleware services. Developers do not need to install middleware repeatedly. Add the required middleware here, then use the corresponding middleware values in the application's deployment YAML file.
|
||||
|
||||
Use the `scripts` field to specify scripts that should be executed after the database is created. Additionally, use the `extension` field to add the corresponding extension in the database.
|
||||
|
||||
@@ -633,13 +633,13 @@ middleware:
|
||||
- ALTER DATABASE $databasename SET search_path TO "$user", public, vectors;
|
||||
- ALTER SCHEMA vectors OWNER TO $dbusername;
|
||||
- COMMIT;
|
||||
# The OS provides two variables, $databasename and $dbusername, which will be replaced by Olares Application Runtime when the command is executed.
|
||||
# The OS provides two variables, $databasename and $dbusername, which will be replaced by beOS Pro Application Runtime when the command is executed.
|
||||
```
|
||||
:::
|
||||
Use the middleware information in deployment YAML
|
||||
```yaml
|
||||
# For PostgreSQL, the corresponding value is as follows
|
||||
- name: DB_POSTGRESDB_DATABASE # The database name you configured in OlaresManifest, specified in middleware.postgres.databases[i].name
|
||||
- name: DB_POSTGRESDB_DATABASE # The database name you configured in beOS ProManifest, specified in middleware.postgres.databases[i].name
|
||||
value: {{ .Values.postgres.databases.<dbname> }}
|
||||
- name: DB_POSTGRESDB_HOST
|
||||
value: {{ .Values.postgres.host }}
|
||||
@@ -688,7 +688,7 @@ host --> {{ .Values.mongodb.host }}
|
||||
port --> "{{ .Values.mongodb.port }}" # The port and password in the yaml file need to be enclosed in double quotes.
|
||||
username --> {{ .Values.mongodb.username }}
|
||||
password --> "{{ .Values.mongodb.password }}" # The port and password in the yaml file need to be enclosed in double quotes.
|
||||
databases --> "{{ .Values.mongodb.databases }}" # The value type of database is a map. You can get the database using {{ .Values.mongodb.databases.<dbname> }}. The <dbname> is the name you configured in OlaresManifest, specified in middleware.mongodb.databases[i].name
|
||||
databases --> "{{ .Values.mongodb.databases }}" # The value type of database is a map. You can get the database using {{ .Values.mongodb.databases.<dbname> }}. The <dbname> is the name you configured in beOS ProManifest, specified in middleware.mongodb.databases[i].name
|
||||
```
|
||||
|
||||
|
||||
@@ -804,7 +804,7 @@ Use the middleware information in deployment YAML
|
||||
|
||||
## Options
|
||||
|
||||
Configure Olares OS related options here.
|
||||
Configure beOS Pro related options here.
|
||||
|
||||
### policies
|
||||
- Type: `list<map>`
|
||||
@@ -828,7 +828,7 @@ options:
|
||||
- Type: `map`
|
||||
- Optional
|
||||
|
||||
Specifies whether the app should be installed for all users in the Olares cluster. For shared apps, set `clusterScoped` to `true` and provide the current app's name in the `appRef` field.
|
||||
Specifies whether the app should be installed for all users in the beOS Pro cluster. For shared apps, set `clusterScoped` to `true` and provide the current app's name in the `appRef` field.
|
||||
|
||||
:::info Example of ollamav2
|
||||
```yaml
|
||||
@@ -901,7 +901,7 @@ options:
|
||||
- Default: `false`
|
||||
- Optional
|
||||
|
||||
Determine whether the application is compatible with mobile web browsers and can be displayed on the mobile version of Olares Desktop. Enable this option if the app is optimized for mobile web browsers. This will make the app visible and accessible on the mobile version of Olares Desktop.
|
||||
Determine whether the application is compatible with mobile web browsers and can be displayed on the mobile version of beOS Pro Desktop. Enable this option if the app is optimized for mobile web browsers. This will make the app visible and accessible on the mobile version of beOS Pro Desktop.
|
||||
|
||||
:::info Example
|
||||
```yaml
|
||||
@@ -913,7 +913,7 @@ mobileSupported: true
|
||||
- Type: `map`
|
||||
- Optional
|
||||
|
||||
The Olares includes a built-in OpenID Connect authentication component to simplify identity verification of users. Enable this option to use OpenID in your app.
|
||||
The beOS Pro includes a built-in OpenID Connect authentication component to simplify identity verification of users. Enable this option to use OpenID in your app.
|
||||
```yaml
|
||||
# OpenID related variables in yaml
|
||||
{{ .Values.oidc.client.id }}
|
||||
@@ -962,14 +962,14 @@ allowedOutboundPorts:
|
||||
- Default: `false`
|
||||
- Optional
|
||||
|
||||
This application supports deploying multiple independent instances within the same Olares cluster. This setting does not apply to paid applications or clients of shared applications.
|
||||
This application supports deploying multiple independent instances within the same beOS Pro cluster. This setting does not apply to paid applications or clients of shared applications.
|
||||
|
||||
## Envs
|
||||
|
||||
Declare the environment variables required for your application to run here. You can allow users to manually enter these values or reference existing system environment variables directly.
|
||||
|
||||
:::info NOTE
|
||||
This configuration requires Olares OS version 1.12.2 or later to take effect.
|
||||
This configuration requires beOS Pro version 1.12.2 or later to take effect.
|
||||
:::
|
||||
|
||||
:::info Example
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to publish paid apps in Olares Market and manage sales using the Merchant app.
|
||||
description: Learn how to publish paid apps in beOS Pro Market and manage sales using the Merchant app.
|
||||
---
|
||||
# Publish paid applications
|
||||
|
||||
Starting from Olares v1.12.3, Olares Market supports paid application distribution. To sell apps, developers must register their Olares ID (DID) on the blockchain and install the Merchant app to manage licenses, orders, and payout records.
|
||||
Starting from beOS Pro v1.12.3, beOS Pro Market supports paid application distribution. To sell apps, developers must register their beOS ID (DID) on the blockchain and install the Merchant app to manage licenses, orders, and payout records.
|
||||
|
||||
:::info Closed Beta
|
||||
This feature is currently in Closed Beta. To publish paid apps, please contact us at [hi@olares.com](mailto:hi@olares.com) to apply for access.
|
||||
This feature is currently in Closed Beta. To publish paid apps, please contact us at [hi@beos.local](mailto:hi@beos.local) to apply for access.
|
||||
|
||||
Currently, only paid applications (pay-to-download) are supported. In-app purchases and subscriptions are under development.
|
||||
:::
|
||||
@@ -17,26 +17,26 @@ This guide explains how to publish paid applications and configure Merchant.
|
||||
## Prerequisites
|
||||
|
||||
Before starting, ensure that you have:
|
||||
- Olares ID: A valid Olares ID (e.g., `alice123@olares.com`).
|
||||
- Olares OS: A working Olares host running v1.12.3 or later.
|
||||
- beOS ID: A valid beOS ID (e.g., `alice123@beos.local`).
|
||||
- beOS Pro: A working beOS Pro host running v1.12.3 or later.
|
||||
- Developer access: Approved developer status (apply via email).
|
||||
- Environment: A local computer with Node.js installed.
|
||||
|
||||
## Set up a wallet and fund gas fees
|
||||
|
||||
To enable payments, you must register your Olares ID (DID) on the blockchain. This is an on-chain interaction and requires a small Gas Fee.
|
||||
To enable payments, you must register your beOS ID (DID) on the blockchain. This is an on-chain interaction and requires a small Gas Fee.
|
||||
|
||||
### Set up a crypto wallet
|
||||
|
||||
This guide uses MetaMask as an example. You may use other wallet apps.
|
||||
|
||||
1. Open LarePass on your phone.
|
||||
1. Open beOS Pro app on your phone.
|
||||
2. Go to **Settings** > **Safety** > **Mnemonic phrase** to view your mnemonic phrase.
|
||||
:::warning Security alert
|
||||
Your mnemonic phrase is a high-privilege credential for your account. Never share it or upload it to a public code repository. Perform the following steps in a secure local environment.
|
||||
:::
|
||||
3. Install the MetaMask extension in your browser.
|
||||
4. In MetaMask, select **Add wallet** > **Import a wallet**, and enter your Olares mnemonic phrase.
|
||||
4. In MetaMask, select **Add wallet** > **Import a wallet**, and enter your beOS Pro mnemonic phrase.
|
||||
|
||||
### Fund your wallet
|
||||
|
||||
@@ -49,7 +49,7 @@ Registration consumes a small amount of ETH on the Optimism network as gas fees.
|
||||
|
||||
## Generate and register RSA keys
|
||||
|
||||
To ensure transaction security and license uniqueness, generate an RSA key pair and register the public key on-chain under your Olares ID.
|
||||
To ensure transaction security and license uniqueness, generate an RSA key pair and register the public key on-chain under your beOS ID.
|
||||
|
||||
### Generate an RSA key pair
|
||||
|
||||
@@ -73,16 +73,16 @@ To ensure transaction security and license uniqueness, generate an RSA key pair
|
||||
:::
|
||||
### Register the RSA public key
|
||||
|
||||
Bind the generated public key to your Olares ID. It requires signing with your mnemonic phrase and will consume gas.
|
||||
Bind the generated public key to your beOS ID. It requires signing with your mnemonic phrase and will consume gas.
|
||||
|
||||
1. Export your mnemonic as a temporary environment variable and wrap the value in double quotes:
|
||||
```bash
|
||||
export PRIVATE_KEY_OR_MNEMONIC="xx xxx xx ..."
|
||||
echo $PRIVATE_KEY_OR_MNEMONIC
|
||||
```
|
||||
2. Check whether your Olares ID already has an RSA public key:
|
||||
2. Check whether your beOS ID already has an RSA public key:
|
||||
```bash
|
||||
did-cli rsa get alice123@olares.com --network mainnet
|
||||
did-cli rsa get alice123@beos.local --network mainnet
|
||||
```
|
||||
If you see the following message, you can continue:
|
||||
|
||||
@@ -92,7 +92,7 @@ Bind the generated public key to your Olares ID. It requires signing with your m
|
||||
3. Verify the owner wallet address and make sure it matches the wallet you funded previously:
|
||||
|
||||
```bash
|
||||
did-cli owner alice123@olares.com --network mainnet
|
||||
did-cli owner alice123@beos.local --network mainnet
|
||||
```
|
||||
|
||||
Example output:
|
||||
@@ -103,11 +103,11 @@ Bind the generated public key to your Olares ID. It requires signing with your m
|
||||
4. Register the RSA public key on-chain:
|
||||
|
||||
```bash
|
||||
did-cli rsa set alice123@olares.com ./rsa-public.pem --network mainnet
|
||||
did-cli rsa set alice123@beos.local ./rsa-public.pem --network mainnet
|
||||
```
|
||||
5. Verify registration:
|
||||
```bash
|
||||
did-cli rsa get alice123@olares.com --network mainnet
|
||||
did-cli rsa get alice123@beos.local --network mainnet
|
||||
```
|
||||
6. Clear the mnemonic phrase from your environment:
|
||||
```bash
|
||||
@@ -125,8 +125,8 @@ A paid app is almost the same as a free app. You only need two additional items:
|
||||
### Add pricing configuration
|
||||
Create `price.yaml` at the chart root:
|
||||
```yaml
|
||||
# Developer's Olares instance address
|
||||
developer: alice123.olares.com
|
||||
# Developer's beOS Pro instance address
|
||||
developer: alice123.beos.local
|
||||
|
||||
# Paid app
|
||||
paid:
|
||||
@@ -155,7 +155,7 @@ Add the env var in the pod template where you need purchase enforcement:
|
||||
value: "{{ .Values.olaresEnv.VERIFIABLE_CREDENTIAL }}"
|
||||
```
|
||||
|
||||
Declare the variable in `OlaresManifest.yaml`:
|
||||
Declare the variable in `beOS ProManifest.yaml`:
|
||||
```yaml
|
||||
envs:
|
||||
- envName: VERIFIABLE_CREDENTIAL
|
||||
@@ -164,7 +164,7 @@ envs:
|
||||
editable: false
|
||||
applyOnChange: true
|
||||
```
|
||||
For detailed environment variable behavior, see [environment variables in `OlaresManifest.yaml`](/developer/develop/package/manifest.md#envs).
|
||||
For detailed environment variable behavior, see [environment variables in `beOS ProManifest.yaml`](/developer/develop/package/manifest.md#envs).
|
||||
|
||||
### Submit your app
|
||||
|
||||
@@ -178,18 +178,18 @@ The Merchant app is your checkout and management panel. It allows you to:
|
||||
- Verify licenses when apps start.
|
||||
|
||||
:::info Keep Merchant online
|
||||
Purchase requests require real-time callbacks to your Olares host for verification. Keep the host running Merchant online 24/7 with a stable, fast network connection. Host offline or unstable network may directly prevent users from completing purchases.
|
||||
Purchase requests require real-time callbacks to your beOS Pro host for verification. Keep the host running Merchant online 24/7 with a stable, fast network connection. Host offline or unstable network may directly prevent users from completing purchases.
|
||||
:::
|
||||
|
||||
### Install Merchant
|
||||
|
||||
1. Open Olares Market and search for "Merchant".
|
||||
1. Open beOS Pro Market and search for "Merchant".
|
||||
2. Click **Get**, then **Install**.
|
||||
|
||||
### Initial setup
|
||||
|
||||
After installation completes, open Merchant from Launchpad.
|
||||
1. On the login screen, enter your developer Olares ID and click **Import Developer**.
|
||||
1. On the login screen, enter your developer beOS ID and click **Import Developer**.
|
||||
2. Merchant automatically loads your on-chain product info and RSA public key.
|
||||
3. Open your private key file:
|
||||
```bash
|
||||
@@ -224,7 +224,7 @@ The status indicator above the transaction list supports manual refresh:
|
||||
| Contract | Token contract address, indicating the asset type and source involved in <br>the transaction.<ul><li>**Native**: native ETH transfer with no contract interaction </li><li>**[Contract address]**: ERC-20 token smart contract address</li></ul> |
|
||||
| Amount | Transaction amount, denominated in the token specified by the Contract.|
|
||||
| Time | The timestamp when the transaction is confirmed and recorded on-chain.|
|
||||
| Product | <ul><li>**Product ID**: a transaction related to an Olares app purchase</li><li>**-**: a regular transfer not associated with app sales</li></ul> |
|
||||
| Product | <ul><li>**Product ID**: a transaction related to an beOS Pro app purchase</li><li>**-**: a regular transfer not associated with app sales</li></ul> |
|
||||
|
||||
### Update developer information
|
||||
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Optimize your app listing with images and icons in Olares Market.
|
||||
description: Optimize your app listing with images and icons in beOS Pro Market.
|
||||
---
|
||||
# Promote your apps
|
||||
|
||||
High-quality visuals help your application stand out in Olares Market. This guide covers asset specifications and how to generate image URLs for your app listing.
|
||||
High-quality visuals help your application stand out in beOS Pro Market. This guide covers asset specifications and how to generate image URLs for your app listing.
|
||||
|
||||
## Application assets
|
||||
|
||||
Configure these assets in your [`OlaresManifest.yaml`](/developer/develop/package/manifest.md).
|
||||
Configure these assets in your [`beOS ProManifest.yaml`](/developer/develop/package/manifest.md).
|
||||
|
||||
### Application icon
|
||||
|
||||
**Required**. Displayed on the Launchpad and in the Market list.
|
||||
- **Location**: Configure the icon URL in the icon field under `metadata` or `entrances` in `OlaresManifest.yaml`.
|
||||
- **Location**: Configure the icon URL in the icon field under `metadata` or `entrances` in `beOS ProManifest.yaml`.
|
||||
- **Format**: PNG or WEBP
|
||||
- **Dimensions**: 256 × 256 pixels
|
||||
- **Size**: No larger than 512 KB
|
||||
@@ -21,7 +21,7 @@ Configure these assets in your [`OlaresManifest.yaml`](/developer/develop/packag
|
||||
### Promote images
|
||||
|
||||
**Recommended**. Displayed on the application details page. We recommend uploading at least 2 images.
|
||||
- **Location**: Configure image URLs in the `promoteImage` field under `spec` in `OlaresManifest.yaml`.
|
||||
- **Location**: Configure image URLs in the `promoteImage` field under `spec` in `beOS ProManifest.yaml`.
|
||||
- **Format**: JPEG, PNG, or WEBP
|
||||
- **Dimensions**: 1440 × 900 pixels
|
||||
- **Size**: No larger than 8 MB per image
|
||||
@@ -29,8 +29,8 @@ Configure these assets in your [`OlaresManifest.yaml`](/developer/develop/packag
|
||||
|
||||
### Featured image
|
||||
|
||||
**Optional**. Used for recommendations in Olares Market or displayed on the "My Olares" section.
|
||||
- **Location**: Configure the image URL in the `featuredImage` field under `spec` in `OlaresManifest.yaml`.
|
||||
**Optional**. Used for recommendations in beOS Pro Market or displayed on the "My beOS Pro" section.
|
||||
- **Location**: Configure the image URL in the `featuredImage` field under `spec` in `beOS ProManifest.yaml`.
|
||||
- **Format**: JPEG, PNG, or WEBP
|
||||
- **Dimensions**: 1440 × 900 pixels
|
||||
- **Size**: No larger than 8 MB
|
||||
@@ -38,9 +38,9 @@ Configure these assets in your [`OlaresManifest.yaml`](/developer/develop/packag
|
||||
|
||||
### Image hosting service
|
||||
|
||||
You can also host images on your own server or use the Olares image hosting service:
|
||||
You can also host images on your own server or use the beOS Pro image hosting service:
|
||||
|
||||
1. Open [Olares Market image hosting](https://imghost.olares.com/).
|
||||
1. Open [beOS Pro Market image hosting](https://imghost.beos.local/).
|
||||
2. Select the image type: **app icon**, **featured image** or **promotional image**.
|
||||
3. Upload and preview the image.
|
||||
4. Copy the generated URL and paste it into your `OlaresManifest.yaml`.
|
||||
4. Copy the generated URL and paste it into your `beOS ProManifest.yaml`.
|
||||
@@ -1,28 +1,28 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Learn how to submit applications in Olares Market.
|
||||
description: Learn how to submit applications in beOS Pro Market.
|
||||
---
|
||||
# Submit applications
|
||||
|
||||
This guide explains how to submit a new Olares application to the default index by creating a Pull Request (PR) against `beclab/apps:main`.
|
||||
This guide explains how to submit a new beOS Pro application to the default index by creating a Pull Request (PR) against `beclab/apps:main`.
|
||||
|
||||
Terminus-Gitbot validates your PR based on the title, file scope, and ownership rules, and automatically close invalid PRs.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before submitting, make sure your application has been fully tested on Olares.
|
||||
Before submitting, make sure your application has been fully tested on beOS Pro.
|
||||
|
||||
Recommended workflow:
|
||||
|
||||
- Use [Studio](/developer/develop/tutorial/develop.md) development container to test and debug in a real online environment.
|
||||
- [Install the app via Olares Market](/developer/develop/tutorial/package-upload.md) to test installation and upgrades as a user would.
|
||||
- [Install the app via beOS Pro Market](/developer/develop/tutorial/package-upload.md) to test installation and upgrades as a user would.
|
||||
|
||||
## Submit a new application
|
||||
|
||||
### Step 1: Add your OAC to your fork
|
||||
|
||||
1. Fork the [official repository](https://github.com/beclab/apps) `beclab/apps`.
|
||||
2. In your fork, add your [Olares Application Chart (OAC)](/developer/develop/package/chart.md) under a new folder.
|
||||
2. In your fork, add your [beOS Pro Application Chart (OAC)](/developer/develop/package/chart.md) under a new folder.
|
||||
3. Create an [`owners` file](/developer/develop/distribute-index.md#before-you-begin) (no extension) in your OAC root directory. Ensure your GitHub username is included.
|
||||
|
||||
:::info Folder naming convention
|
||||
@@ -48,7 +48,7 @@ To pass the Terminus-Gitbot automated checks, your PR must strictly follow these
|
||||
|--|--|
|
||||
| PR type | <ul><li>**NEW**: Submit a new application. </li><li>**UPDATE**: Update an already successfully merged application.</li><li>**REMOVE**: Remove an already successfully merged application.<br></li><li>**SUSPEND**: Suspend an already successfully merged application from<br> distribution through the application store.</li></ul> |
|
||||
| Chart folder name | The directory name of your OAC. Must match the naming convention. |
|
||||
| Version | Chart version of your app. It must match:<ul><li>`version` in `Chart.yaml`</li><li>`version` under `metadata` in `OlaresManifest.yaml`</li></ul> |
|
||||
| Version | Chart version of your app. It must match:<ul><li>`version` in `Chart.yaml`</li><li>`version` under `metadata` in `beOS ProManifest.yaml`</li></ul> |
|
||||
| Title content | A brief summary of your PR. |
|
||||
|
||||
2. **File scope**: The PR only adds or modifies content under the chart folder name declared in the title.
|
||||
@@ -68,7 +68,7 @@ When everything is ready, click **Ready for review**.
|
||||
After you submit, Terminus-Gitbot automatically validates the PR.
|
||||
|
||||
- If all checks pass, Terminus-Gitbot automatically merges the PR into `beclab/apps:main`.
|
||||
- After a short delay, your application appears in Olares Market.
|
||||
- After a short delay, your application appears in beOS Pro Market.
|
||||
|
||||
## Track PR status
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Understand how application distribution works in Olares.
|
||||
description: Understand how application distribution works in beOS Pro.
|
||||
---
|
||||
# Distribute Olares applications
|
||||
# Distribute beOS Pro applications
|
||||
|
||||
Distributing applications on Olares is based on open standards and automated validation.
|
||||
If your application is already packaged as an Olares Application Chart (OAC), you can publish it to Olares Market and make it available to users with minimal friction.
|
||||
Distributing applications on beOS Pro is based on open standards and automated validation.
|
||||
If your application is already packaged as an beOS Pro Application Chart (OAC), you can publish it to beOS Pro Market and make it available to users with minimal friction.
|
||||
|
||||
This guide walks you through the distribution lifecycle of an Olares application, from understanding how Market indexing works to publishing, maintaining, and promoting your app.
|
||||
This guide walks you through the distribution lifecycle of an beOS Pro application, from understanding how Market indexing works to publishing, maintaining, and promoting your app.
|
||||
|
||||
## Before you begin
|
||||
|
||||
Before distributing your application, it helps to understand a few core concepts:
|
||||
|
||||
- **[Olares Application Chart (OAC)](/developer/develop/package/chart.md)**
|
||||
- **[beOS Pro Application Chart (OAC)](/developer/develop/package/chart.md)**
|
||||
|
||||
The packaging format used to describe an Olares application, including metadata, ownership, versioning, and installation configuration.
|
||||
The packaging format used to describe an beOS Pro application, including metadata, ownership, versioning, and installation configuration.
|
||||
|
||||
- **Application index**
|
||||
|
||||
A service that provides application metadata to Olares Market. Olares includes a default public index, and developers can deploy their own.
|
||||
A service that provides application metadata to beOS Pro Market. beOS Pro includes a default public index, and developers can deploy their own.
|
||||
|
||||
- **Terminus-Gitbot**
|
||||
|
||||
@@ -29,19 +29,19 @@ Before distributing your application, it helps to understand a few core concepts
|
||||
|
||||
### 1. Prepare your app package
|
||||
|
||||
Before an app can be distributed, it must be packaged as an **Olares Application Chart (OAC)**.
|
||||
Before an app can be distributed, it must be packaged as an **beOS Pro Application Chart (OAC)**.
|
||||
|
||||
At this stage, developers typically:
|
||||
- Develop and test the app on an Olares host.
|
||||
- Develop and test the app on an beOS Pro host.
|
||||
- Verify installation and upgrade behavior.
|
||||
- Finalize chart metadata and structure.
|
||||
|
||||
For details on packaging and chart structure, see:
|
||||
- [Olares Application Chart (OAC)](/developer/develop/package/chart.md)
|
||||
- [beOS Pro Application Chart (OAC)](/developer/develop/package/chart.md)
|
||||
|
||||
### 2. Submit the app to the default index
|
||||
|
||||
Olares Market indexes applications from Git repositories.
|
||||
beOS Pro Market indexes applications from Git repositories.
|
||||
To publish an app to the default public index, developers submit their OAC by opening a Pull Request (PR) to the official repository.
|
||||
|
||||
During submission:
|
||||
@@ -54,7 +54,7 @@ During submission:
|
||||
After a PR is submitted, **Terminus-Gitbot** performs automated checks to ensure the submission follows distribution rules.
|
||||
|
||||
If all checks pass, the PR is merged automatically.
|
||||
After a short delay, the application becomes visible in Olares Market.
|
||||
After a short delay, the application becomes visible in beOS Pro Market.
|
||||
|
||||
### 4. Manage the application lifecycle
|
||||
|
||||
@@ -70,12 +70,12 @@ These actions are controlled using PR types and special control files in the OAC
|
||||
|
||||
### 5. Optimize your Market listing
|
||||
|
||||
Once published, you can improve how your app is presented in Olares Market by adding icons, screenshots, and featured images.
|
||||
Once published, you can improve how your app is presented in beOS Pro Market by adding icons, screenshots, and featured images.
|
||||
|
||||
|
||||
|
||||
### 6. (Optional) Publish paid applications
|
||||
|
||||
Olares Market also supports paid application distribution.
|
||||
beOS Pro Market also supports paid application distribution.
|
||||
Paid apps require additional identity registration, pricing configuration, and license management.
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
description: Learn how to prepare and upload icons, feature image, and promotional images for your Olares apps.
|
||||
description: Learn how to prepare and upload icons, feature image, and promotional images for your beOS Pro apps.
|
||||
---
|
||||
# Add icons, feature image, and promotional images
|
||||
|
||||
A great-looking app needs high-quality assets. This guide covers the specifications for your app's icon, feature image, and screenshots, and how to upload them to Olares.
|
||||
A great-looking app needs high-quality assets. This guide covers the specifications for your app's icon, feature image, and screenshots, and how to upload them to beOS Pro.
|
||||
|
||||
## Asset specifications
|
||||
Before uploading, ensure your images are in the correct format.
|
||||
|
||||
| Type | Format | Max size | Dimensions (px) | Description |
|
||||
|:----------------------|:----------------|:------------|:----------------|:----------------------------------------------------------------------------------------------------------------------|
|
||||
| **App icon** | PNG, WEBP | 512 KB | 256x256 | Your app's most common visual symbol, used on the Olares desktop and throughout the system. |
|
||||
| **Feature image** | JPEG, PNG, WEBP | 8 MB | 1440x900 | Displayed on your app's page in **Market** > **My Olares**. |
|
||||
| **App icon** | PNG, WEBP | 512 KB | 256x256 | Your app's most common visual symbol, used on the beOS Pro desktop and throughout the system. |
|
||||
| **Feature image** | JPEG, PNG, WEBP | 8 MB | 1440x900 | Displayed on your app's page in **Market** > **My beOS Pro**. |
|
||||
| **Promotional image** | JPEG, PNG, WEBP | 8 MB (each) | 1440x900 | If you plan to submit your app to the public Market, you must upload at least two. You can upload a maximum of eight. |
|
||||
|
||||
## Upload and link assets
|
||||
|
||||
1. Navigate to the [Olares Market Image Hosting service](https://imghost.olares.com/).
|
||||
1. Navigate to the [beOS Pro Market Image Hosting service](https://imghost.beos.local/).
|
||||
2. Select the type of asset you are uploading (e.g., Icon).
|
||||
3. Drag and drop your prepared file into the upload area, or click to select it.
|
||||
4. Click the image thumbnail to make simple edits if necessary.
|
||||
5. When you are ready, click **Upload**.
|
||||
6. After the upload, the service will provide a direct URL for the image. Click <span class="material-symbols-outlined">content_copy</span> to copy the URL to your clipboard.
|
||||
7. Open your app project in **Studio**.
|
||||
8. Paste the URL into the corresponding field in your `OlaresManifest.yaml` file.
|
||||
8. Paste the URL into the corresponding field in your `beOS ProManifest.yaml` file.
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
outline: [2, 3]
|
||||
description: Deploy a single-container Docker app to Olares using Studio.
|
||||
description: Deploy a single-container Docker app to beOS Pro using Studio.
|
||||
---
|
||||
# Deploy an app from Docker image
|
||||
This guide explains how to deploy a single-container Docker app to Olares using Studio.
|
||||
This guide explains how to deploy a single-container Docker app to beOS Pro using Studio.
|
||||
|
||||
:::info For single-container apps
|
||||
This method supports apps that run from a single container image.
|
||||
@@ -13,8 +13,8 @@ Studio-created deployments are best suited for development, testing, or temporar
|
||||
:::
|
||||
|
||||
## Prerequisites
|
||||
- Olares version 1.12.2 or later.
|
||||
- A container image for the app exists and is accessible from the Olares host.
|
||||
- beOS Pro version 1.12.2 or later.
|
||||
- A container image for the app exists and is accessible from the beOS Pro host.
|
||||
- The app's `docker run` command or `docker-compose.yaml` is available to reference configuration (ports, environment variables, volumes).
|
||||
|
||||
## Create and configure your app
|
||||
@@ -54,8 +54,8 @@ services:
|
||||
|
||||
1. Open Studio and select **Create a new application**.
|
||||
2. Enter an **App name**, for example: `wallos`, and click **Confirm**.
|
||||
3. Select **Port your own container to Olares**.
|
||||
|
||||
3. Select **Port your own container to beOS Pro**.
|
||||
|
||||
|
||||
### Configure image, port, and instance spec
|
||||
These fields define the app's core components. You can find this information as the main image name and the `-p` flag in a `docker run` command, or under the `image:` and `ports:` keys in a `docker-compose.yaml` file.
|
||||
@@ -79,10 +79,10 @@ Environment variables are used to pass configuration settings to your app. In th
|
||||
|
||||
|
||||
### Add storage volumes
|
||||
Volumes connect storage on your Olares device to a path inside the app's container, which is essential for saving data permanently. These are defined using the `-v` flag or in the `volumes:` section.
|
||||
Volumes connect storage on your beOS Pro device to a path inside the app's container, which is essential for saving data permanently. These are defined using the `-v` flag or in the `volumes:` section.
|
||||
|
||||
:::info Host path options
|
||||
The host path is where Olares stores the data, and the mount path is the path inside the container. Studio provides three managed host path prefixes:
|
||||
The host path is where beOS Pro stores the data, and the mount path is the path inside the container. Studio provides three managed host path prefixes:
|
||||
|
||||
- `/app/data`: App data directory. Data can be accessed across nodes and is not deleted when the app is uninstalled. Appears under `/Data/studio` in Files.
|
||||
- `/app/cache`: App cache directory. Data is stored in the node's local disk and is deleted when the app is uninstalled. Appears under `/Cache/<device-name>/studio` in Files.
|
||||
@@ -154,13 +154,13 @@ When enabled, Studio provides dynamic variables. You must use these variables in
|
||||
Apps deployed from Studio include a `-dev` suffix in the title to distinguish them from Market installations.
|
||||
|
||||
|
||||
You can click on files like `OlaresManifest.yaml` to review and make changes. For example, to change the app's display name and logo:
|
||||
You can click on files like `beOS ProManifest.yaml` to review and make changes. For example, to change the app's display name and logo:
|
||||
|
||||
1. Click **<span class="material-symbols-outlined">box_edit</span>Edit** in the top-right to open the editor.
|
||||
2. Click `OlaresManifest.yaml` to view the content.
|
||||
2. Click `beOS ProManifest.yaml` to view the content.
|
||||
3. Change the `title` field under `entrance` and `metadata`. For example, change `wallos` to `Wallos`.
|
||||
4. Replace the default icon image address under `entrance` and `metadata`.
|
||||
|
||||
|
||||
|
||||
5. Click <span class="material-symbols-outlined">save</span> in the top-right to save changes.
|
||||
6. Click **Apply** to reinstall with the updated package.
|
||||
@@ -174,7 +174,7 @@ You can click on files like `OlaresManifest.yaml` to review and make changes. Fo
|
||||
If you no longer need the app, you can remove it.
|
||||
1. Click <span class="material-symbols-outlined">more_vert</span> in the top-right corner.
|
||||
2. You can choose to:
|
||||
- **Uninstall**: Removes the running app from Olares, but keeps the project in Studio so you can continue editing the package.
|
||||
- **Uninstall**: Removes the running app from beOS Pro, but keeps the project in Studio so you can continue editing the package.
|
||||
- **Delete**: Uninstalls the app and removes the project from Studio. This action is irreversible.
|
||||
|
||||
## Troubleshoot a deployment
|
||||
|
||||
@@ -3,19 +3,19 @@ outline: [2, 3]
|
||||
description: Learn how to use Studio to set up a dev container, access it via VS Code, and configure port forwarding.
|
||||
---
|
||||
# Develop in a dev container
|
||||
Olares Studio allows you to spin up a pre-configured dev container to write and debug code (such as Node.js scripts or CUDA programs) without managing local infrastructure. This provides an isolated environment identical to the production runtime.
|
||||
beOS Pro Studio allows you to spin up a pre-configured dev container to write and debug code (such as Node.js scripts or CUDA programs) without managing local infrastructure. This provides an isolated environment identical to the production runtime.
|
||||
|
||||
The following guide shows the development and setup workflow using a Node.js project as an example.
|
||||
|
||||
## Prerequisite
|
||||
- Olares version 1.12.2 or later.
|
||||
- beOS Pro version 1.12.2 or later.
|
||||
|
||||
## 1. Initialize the container
|
||||
To start coding, you must provision the container resources and select your runtime environment.
|
||||
1. Open Studio and select **Create a new application**.
|
||||
2. Enter an **App name**, for example: `My Web`, and click **Confirm**.
|
||||
3. Select **Coding on Olares** as the creation method.
|
||||
|
||||
3. Select **Coding on beOS Pro** as the creation method.
|
||||
|
||||
|
||||
4. Configure the **Dev Env**:
|
||||
|
||||
@@ -110,7 +110,7 @@ This example demonstrates creating a basic web page manually.
|
||||
</head>
|
||||
<body>
|
||||
<h1>Hello World</h1>
|
||||
<h1>Hello Olares</h1>
|
||||
<h1>Hello beOS Pro</h1>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
@@ -125,18 +125,18 @@ This example demonstrates creating a basic web page manually.
|
||||
## 4. Configure port forwarding
|
||||
If you need to expose additional ports after the container is created (e.g., adding port `8081`), you must manually edit the container configuration manifests.
|
||||
:::tip
|
||||
You can follow the same steps to modify `OlaresManifest.yaml` and `deployment.yaml` to change the port number.
|
||||
You can follow the same steps to modify `beOS ProManifest.yaml` and `deployment.yaml` to change the port number.
|
||||
:::
|
||||
### Modify configuration manifests
|
||||
1. In Studio, click **<span class="material-symbols-outlined">box_edit</span>Edit** in the top-right to open the editor.
|
||||
2. Edit `OlaresManifest.yaml`.
|
||||
2. Edit `beOS ProManifest.yaml`.
|
||||
|
||||
a. Append the new port to the `entrances` list:
|
||||
```yaml
|
||||
entrances:
|
||||
- authLevel: private
|
||||
host: myweb
|
||||
icon: https://app.cdn.olares.com/appstore/default/defaulticon.webp
|
||||
icon: https://app.cdn.beos.local/appstore/default/defaulticon.webp
|
||||
invisible: true
|
||||
name: myweb-dev-8080
|
||||
openMethod: ""
|
||||
@@ -146,7 +146,7 @@ You can follow the same steps to modify `OlaresManifest.yaml` and `deployment.ya
|
||||
# Add the following
|
||||
- authLevel: private
|
||||
host: myweb # Must match Service metadata name
|
||||
icon: https://app.cdn.olares.com/appstore/default/defaulticon.webp
|
||||
icon: https://app.cdn.beos.local/appstore/default/defaulticon.webp
|
||||
invisible: true
|
||||
name: myweb-dev-8081 # Unique identifier
|
||||
openMethod: ""
|
||||
@@ -162,7 +162,7 @@ You can follow the same steps to modify `OlaresManifest.yaml` and `deployment.ya
|
||||
annotations:
|
||||
applications.app.bytetrade.io/default-thirdlevel-domains:
|
||||
'[{"appName":"myweb","entranceName":"myweb-dev-8080"},{"appName":"myweb","entranceName":"myweb-dev-8081"}]'
|
||||
# entranceName must match the name used in OlaresManifest.yaml
|
||||
# entranceName must match the name used in beOS ProManifest.yaml
|
||||
```
|
||||
b. Update the `studio-expose-ports` annotation under `spec` > `template` > `metadata`:
|
||||
```yaml
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
description: Get started with Studio to deploy Docker-based apps, develop new apps, package and upload locally, and manage assets on your Olares device.
|
||||
description: Get started with Studio to deploy Docker-based apps, develop new apps, package and upload locally, and manage assets on your beOS Pro device.
|
||||
---
|
||||
# Deploy and develop apps in Olares
|
||||
# Deploy and develop apps in beOS Pro
|
||||
|
||||
Studio provides a real Olares environment for building, porting, and testing apps when cloud features and the sandbox system are hard to simulate locally. With Studio you can:
|
||||
- Create a new Olares app in an online development container.
|
||||
Studio provides a real beOS Pro environment for building, porting, and testing apps when cloud features and the sandbox system are hard to simulate locally. With Studio you can:
|
||||
- Create a new beOS Pro app in an online development container.
|
||||
- Port an existing app, adjust its configurations, and test the installation flow.
|
||||
- Package your app into a chart and download it when your app is ready.
|
||||
|
||||
|
||||
@@ -6,15 +6,15 @@ outline: [2, 3]
|
||||
|
||||
## Install and Launch Studio
|
||||
|
||||
1. Install [Studio](https://market.olares.com/app/studio) from the Olares Market.
|
||||
2. Find the Studio icon in the launcher panel on the Olares Desktop.
|
||||
1. Install [Studio](https://market.beos.local/app/studio) from the beOS Pro Market.
|
||||
2. Find the Studio icon in the launcher panel on the beOS Pro Desktop.
|
||||
3. Click on the icon to launch the application.
|
||||
|
||||
|
||||
|
||||
## Create Your App
|
||||
|
||||
Click the **Create a new application** to create a blank Olares application from a template.
|
||||
Click the **Create a new application** to create a blank beOS Pro application from a template.
|
||||
|
||||
- In the **App Name** field, enter your application name.
|
||||
- Set the **APP type** to **app**.
|
||||
@@ -25,7 +25,7 @@ Click the **Create a new application** to create a blank Olares application from
|
||||
|
||||
## Setup App Config
|
||||
|
||||
After creating the application, you can see the Olares Application Chart files generated by Studio under the **Files** Tab. You can add, delete, or rename various configuration files as needed.
|
||||
After creating the application, you can see the beOS Pro Application Chart files generated by Studio under the **Files** Tab. You can add, delete, or rename various configuration files as needed.
|
||||
|
||||
|
||||
|
||||
@@ -33,9 +33,9 @@ After creating the application, you can see the Olares Application Chart files g
|
||||
|
||||
The `Chart.yaml` file is a required file in the Helm Chart specification. It contains the application's `Name` and `Chart Version`. You can [learn more here](https://helm.sh/docs/topics/charts/). For now, we're not going to change the default `Chart.yaml` yet.
|
||||
|
||||
### OlaresManifest.yaml
|
||||
### beOS ProManifest.yaml
|
||||
|
||||
In the `OlaresManifest.yaml `file, you can change many configurations. This includes but is not limited to:
|
||||
In the `beOS ProManifest.yaml `file, you can change many configurations. This includes but is not limited to:
|
||||
|
||||
- Changing the app's title, icon, and other details
|
||||
- Adding system `middleware`
|
||||
@@ -87,7 +87,7 @@ These parameters should not be hardcoded, they must reference the variables pass
|
||||
|
||||
#### Adding [Access Permissions to the File System](../../package/manifest.md#permission)
|
||||
|
||||
To read and save files in the Olares system, we need to configure Access Permissions for certain file directories. These directories can be specified in the `Permissions` section of the `OlaresManifest.yaml` file:
|
||||
To read and save files in the beOS Pro system, we need to configure Access Permissions for certain file directories. These directories can be specified in the `Permissions` section of the `beOS ProManifest.yaml` file:
|
||||
|
||||
- `appData`: This applies for independent cloud storage space for the app.
|
||||
- `appCache`: This applies for local disk data cache space, usually on an SSD disk, for the app.
|
||||
|
||||
@@ -50,7 +50,7 @@ After cloning the code, if you are working on a Node project, you might need to
|
||||
nginx -s reload
|
||||
```
|
||||
## Run Dev Mode
|
||||
After completing the **Nginx** configuration, you can start your frontend program in dev mode and preview your APP in Olares.
|
||||
After completing the **Nginx** configuration, you can start your frontend program in dev mode and preview your APP in beOS Pro.
|
||||
|
||||
```sh
|
||||
npm run dev
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
# Create Your First Olares App
|
||||
# Create Your First beOS Pro App
|
||||
|
||||
You can learn how to develop an Olares app using Studio through this tutorial.
|
||||
You can learn how to develop an beOS Pro app using Studio through this tutorial.
|
||||
|
||||
The tutorial shows how to make a simple [Note](https://github.com/beclab/olares-app-demo) tool. It demonstrates how to start from scratch and develop a complete Olares App.
|
||||
The tutorial shows how to make a simple [Note](https://github.com/beclab/olares-app-demo) tool. It demonstrates how to start from scratch and develop a complete beOS Pro App.
|
||||
|
||||
The tutorial includes three parts:
|
||||
|
||||
1. [Create an App](./create.md)<br>
|
||||
This section provides a step-by-step guide on how to create an Olares App and set up the initial development environment.
|
||||
This section provides a step-by-step guide on how to create an beOS Pro App and set up the initial development environment.
|
||||
|
||||
2. [Backend Development](./backend.md)<br>
|
||||
In this section, you'll learn how to use Studio's IDE to develop the backend programs in `Golang` and provide API interfaces for the frontend.
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
description: Download an app package from Studio and install it in the Olares Market for stable, long-term use.
|
||||
description: Download an app package from Studio and install it in the beOS Pro Market for stable, long-term use.
|
||||
---
|
||||
|
||||
# Package and upload your app to Market
|
||||
|
||||
Apps created in Studio are ideal for development and testing. For stable, long-term use, it is best to install them through the Olares Market.
|
||||
Apps created in Studio are ideal for development and testing. For stable, long-term use, it is best to install them through the beOS Pro Market.
|
||||
|
||||
## Download the App package from Studio
|
||||
|
||||
@@ -17,11 +17,11 @@ After confirming that your app works as expected, you can download its complete
|
||||
## Install the App via the Market
|
||||
|
||||
1. Open the **Market** app.
|
||||
2. Navigate to the **My Olares** section and select **Upload custom chart**.
|
||||
2. Navigate to the **My beOS Pro** section and select **Upload custom chart**.
|
||||
3. Select the app package file (`.tgz`) you downloaded from Studio. Wait for the upload to complete.
|
||||
4. A pop-up will appear confirming the app was successfully added. Click **Install now**.
|
||||
|
||||
|
||||
Once finished, you can click **Open** to launch it.
|
||||
|
||||
All custom-installed apps will appear under the **My Olares** > **Upload** tab.
|
||||
All custom-installed apps will appear under the **My beOS Pro** > **Upload** tab.
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
search: false
|
||||
---
|
||||
## Activate Olares
|
||||
## Activate beOS Pro
|
||||
|
||||
Use the Wizard URL and initial one-time password to activate. This process connects the Olares device with your Olares ID using LarePass.
|
||||
Use the Wizard URL and initial one-time password to activate. This process connects the beOS Pro device with your beOS ID using beOS Pro app.
|
||||
|
||||
1. Enter the Wizard URL in your browser. You will be directed to the welcome page. Press any key to continue.
|
||||
|
||||
@@ -14,25 +14,25 @@ Use the Wizard URL and initial one-time password to activate. This process conne
|
||||
3. Select the system language.
|
||||
|
||||
|
||||
4. Activate Olares using LarePass app.
|
||||
4. Activate beOS Pro using beOS Pro app app.
|
||||
|
||||
a. Open LarePass app, and tap **Scan QR code** to scan the QR code on the Wizard page and complete the activation.
|
||||
a. Open beOS Pro app 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.
|
||||
To avoid activation failures, ensure that both your phone and the beOS Pro device are connected to the same network.
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
b. Reset the login password for Olares by following the on-screen instructions on LarePass.
|
||||
b. Reset the login password for beOS Pro by following the on-screen instructions on beOS Pro app.
|
||||
|
||||
::: tip Reactivate Olares with the same Olares ID
|
||||
::: tip Reactivate beOS Pro with the same beOS ID
|
||||
|
||||
If you have reinstalled Olares, the original instance becomes unavailable. To reactivate Olares with the same Olares ID:
|
||||
If you have reinstalled beOS Pro, the original instance becomes unavailable. To reactivate beOS Pro with the same beOS ID:
|
||||
|
||||
1. Open LarePass on your phone, and you can see a red prompt: "No active Olares found".
|
||||
1. Open beOS Pro app on your phone, and you can see a red prompt: "No active beOS Pro 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.
|
||||
3. Tap **Scan QR code** to scan the QR code on the wizard page and activate beOS Pro.
|
||||
:::
|
||||
|
||||
|
||||
After successful setup, the LarePass app will automatically go to the home screen, and the Wizard will redirect you to the login page.
|
||||
After successful setup, the beOS Pro app app will automatically go to the home screen, and the Wizard will redirect you to the login page.
|
||||
@@ -50,15 +50,15 @@ These options apply to all backends:
|
||||
|
||||
| Option | Shorthand | Usage | Required | Default |
|
||||
|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|------------|
|
||||
| `--access-token` <sup>1</sup> | | Specifies the access token for Olares Space. | No | N/A |
|
||||
| `--access-token` <sup>1</sup> | | Specifies the access token for Remote Space. | No | N/A |
|
||||
| `--cloud-api-mirror` | | Specifies the cloud API mirror. | No | N/A |
|
||||
| `--cloud-name` | | Specifies the cloud name of the Olares Space instance. <br/> The cloud name can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
| `--cloud-name` | | Specifies the cloud name of the Remote Space instance. <br/> The cloud name can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
| `--cluster-id` <sup>2</sup> | | Specifies the cluster ID where the backup will be stored. | No | N/A |
|
||||
| `--limit-upload-rate` | | Limits the upload speed to a maximum rate in KiB/s. | No | unlimited |
|
||||
| `--olares-did` <sup>1</sup> | | Specifies the Olares DID. | No | N/A |
|
||||
| `--region-id` | | Specifies the region ID of the Olares Space instance. <br/> The region ID can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
| `--olares-did` <sup>1</sup> | | Specifies the beOS Pro DID. | No | N/A |
|
||||
| `--region-id` | | Specifies the region ID of the Remote Space instance. <br/> The region ID can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
|
||||
1. To retrieve the access token and Olares DID, inspect the payload of the network requests made by the Olares Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the Olares DID.
|
||||
1. To retrieve the access token and beOS Pro DID, inspect the payload of the network requests made by the Remote Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the beOS Pro DID.
|
||||
|
||||
2. To retrieve the cluster ID, use the following command:
|
||||
```bash
|
||||
@@ -73,7 +73,7 @@ olares-cli backups backup cos --path /data --repo-name my_repo \
|
||||
--secret-access-key YOUR_SECRET \
|
||||
--endpoint https://cos.region.myqcloud.com/bucket/prefix
|
||||
|
||||
# Backup to Olares Space
|
||||
# Backup to Remote Space
|
||||
olares-cli backups backup space --path /data --repo-name my_repo \
|
||||
--access-token YOUR_ACCESS_TOKEN \
|
||||
--cloud-api-mirror https://api-mirror.example.com \
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# `region`
|
||||
|
||||
## Synopsis
|
||||
The `region` subcommand is used to retrieve the cloud name and region ID. It is specifically used when the storage backend is Olares Space.
|
||||
The `region` subcommand is used to retrieve the cloud name and region ID. It is specifically used when the storage backend is Remote Space.
|
||||
```bash
|
||||
olares-cli backups region space [options]
|
||||
```
|
||||
@@ -10,12 +10,12 @@ olares-cli backups region space [options]
|
||||
|
||||
| Option | Shorthand | Usage | Required | Default |
|
||||
|-------------------------------|-----------|----------------------------------------------|-------------------------|---------|
|
||||
| `--access-token` <sup>1</sup> | | Specifies the access token for Olares Space. | No | N/A |
|
||||
| `--access-token` <sup>1</sup> | | Specifies the access token for Remote Space. | No | N/A |
|
||||
| `--cloud-api-mirror` | | Specifies the cloud API mirror. | No | N/A |
|
||||
| `--help` | `-h` | Displays help information. | No | N/A |
|
||||
| `--olares-did` <sup>1</sup> | | Specifies the Olares DID. | No | N/A |
|
||||
| `--olares-did` <sup>1</sup> | | Specifies the beOS Pro DID. | No | N/A |
|
||||
|
||||
1. To retrieve the access token and Olares DID, inspect the payload of the network requests made by the Olares Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the Olares DID.
|
||||
1. To retrieve the access token and beOS Pro DID, inspect the payload of the network requests made by the Remote Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the beOS Pro DID.
|
||||
|
||||
## Examples
|
||||
```bash
|
||||
|
||||
@@ -39,7 +39,7 @@ These options apply to all backends:
|
||||
| Option | Shorthand | Usage | Required | Default |
|
||||
|-------------|-----------|-----------------------------------------------------------|-------------------------|---------|
|
||||
| `--endpoint` | | Specifies the local directory where the backup is stored. | No | N/A |
|
||||
| `--olares-id` | | Specifies the Olares ID. | No | N/A |
|
||||
| `--olares-id` | | Specifies the beOS ID. | No | N/A |
|
||||
|
||||
### Options for `s3`
|
||||
|
||||
@@ -54,15 +54,15 @@ These options apply to all backends:
|
||||
|
||||
| Option | Shorthand | Usage | Required | Default |
|
||||
|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|------------|
|
||||
| `--access-token` <sup>1</sup> | | Specifies the access token for Olares Space. | No | N/A |
|
||||
| `--access-token` <sup>1</sup> | | Specifies the access token for Remote Space. | No | N/A |
|
||||
| `--cloud-api-mirror` | | Specifies the cloud API mirror. | No | N/A |
|
||||
| `--cloud-name` | | Specifies the cloud name of the Olares Space instance. <br/> The cloud name can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
| `--cloud-name` | | Specifies the cloud name of the Remote Space instance. <br/> The cloud name can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
| `--cluster-id` <sup>2</sup> | | Specifies the cluster ID where the backup will be stored. | No | N/A |
|
||||
| `--limit-download-rate` | | Limits the download speed to a maximum rate in KiB/s. | No | unlimited |
|
||||
| `--olares-did` <sup>1</sup> | | Specifies the Olares DID. | No | N/A |
|
||||
| `--region-id` | | Specifies the region ID of the Olares Space instance. <br/> The region ID can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
| `--olares-did` <sup>1</sup> | | Specifies the beOS Pro DID. | No | N/A |
|
||||
| `--region-id` | | Specifies the region ID of the Remote Space instance. <br/> The region ID can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
|
||||
1. To retrieve the access token and Olares DID, inspect the payload of the network requests made by the Olares Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the Olares DID.
|
||||
1. To retrieve the access token and beOS Pro DID, inspect the payload of the network requests made by the Remote Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the beOS Pro DID.
|
||||
|
||||
2. To retrieve the cluster ID, use the following command:
|
||||
```bash
|
||||
|
||||
@@ -47,14 +47,14 @@ These options apply to all backends:
|
||||
|
||||
| Option | Shorthand | Usage | Required | Default |
|
||||
|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---------|
|
||||
| `--access-token` <sup>1</sup> | | Specifies the access token for Olares Space. | No | N/A |
|
||||
| `--access-token` <sup>1</sup> | | Specifies the access token for Remote Space. | No | N/A |
|
||||
| `--cloud-api-mirror` | | Specifies the cloud API mirror. | No | N/A |
|
||||
| `--cloud-name` | | Specifies the cloud name of the Olares Space instance. <br/> The cloud name can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
| `--cloud-name` | | Specifies the cloud name of the Remote Space instance. <br/> The cloud name can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
| `--cluster-id` <sup>2</sup> | | Specifies the cluster ID where the backup will be stored. | No | N/A |
|
||||
| `--olares-did` <sup>1</sup> | | Specifies the Olares DID. | No | N/A |
|
||||
| `--region-id` | | Specifies the region ID of the Olares Space instance. <br/> The region ID can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
| `--olares-did` <sup>1</sup> | | Specifies the beOS Pro DID. | No | N/A |
|
||||
| `--region-id` | | Specifies the region ID of the Remote Space instance. <br/> The region ID can be retrieved using the [`region`](./backups-region.md) subcommand. | No | N/A |
|
||||
|
||||
1. To retrieve the access token and Olares DID, inspect the payload of the network requests made by the Olares Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the Olares DID.
|
||||
1. To retrieve the access token and beOS Pro DID, inspect the payload of the network requests made by the Remote Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the beOS Pro DID.
|
||||
|
||||
2. To retrieve the cluster ID, use the following command:
|
||||
```bash
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
# `backups`
|
||||
The `backups` command provides a set of tools to manage data backups, restores, and snapshots. It supports multiple storage backends, including Tencent COS, Amazon S3, the local filesystem, and Olares Space.
|
||||
The `backups` command provides a set of tools to manage data backups, restores, and snapshots. It supports multiple storage backends, including Tencent COS, Amazon S3, the local filesystem, and Remote Space.
|
||||
|
||||
## Subcommands
|
||||
|
||||
| Subcommand | Description |
|
||||
|-------------|----------------------------------------------------------------------------------------------------------|
|
||||
| `download` | Downloads the Restic dependency tool. |
|
||||
| `region` | Retrieves the cloud name and region ID. Specifically used only when the storage backend is Olares Space. |
|
||||
| `region` | Retrieves the cloud name and region ID. Specifically used only when the storage backend is Remote Space. |
|
||||
| `backup` | Backups data to a specified storage backend. |
|
||||
| `restore` | Restores data from a specified storage backend. |
|
||||
| `snapshots` | Manages and views backup snapshots. |
|
||||
|
||||
## Available backends
|
||||
|
||||
The `<backend>` parameter specifies the storage backend for the `backup` and `restore` commands. Olares CLI supports the following backends:
|
||||
The `<backend>` parameter specifies the storage backend for the `backup` and `restore` commands. beOS Pro CLI supports the following backends:
|
||||
|
||||
| Backend | Description |
|
||||
|---------|---------------------------------------------------------------------------------------|
|
||||
| `cos` | Tencent Cloud Object Storage (COS). Requires an access key, secret key, and endpoint. |
|
||||
| `s3` | Amazon Simple Storage Service (S3). Requires an access key, secret key, and endpoint. |
|
||||
| `fs` | Local filesystem. No credentials required. |
|
||||
| `space` | Olares Space. Requires an access token. |
|
||||
| `space` | Remote Space. Requires an access token. |
|
||||
@@ -1,10 +1,10 @@
|
||||
# `change-ip`
|
||||
:::warning When manually updating IP address is required
|
||||
When Olares is deployed _inside_ a virtualized environment, such as macOS (via Minikube) or Windows (via WSL), a change in the host system's IP address (e.g., due to switching Wi-Fi networks) may cause Olares to become inaccessible. This happens because the NAT gateway and DNS configuration no longer match the new IP. In such cases, you need to manually update the IP address to ensure that Olares can route traffic correctly.
|
||||
When beOS Pro is deployed _inside_ a virtualized environment, such as macOS (via Minikube) or Windows (via WSL), a change in the host system's IP address (e.g., due to switching Wi-Fi networks) may cause beOS Pro to become inaccessible. This happens because the NAT gateway and DNS configuration no longer match the new IP. In such cases, you need to manually update the IP address to ensure that beOS Pro can route traffic correctly.
|
||||
:::
|
||||
|
||||
## Synopsis
|
||||
Change the local IP address for all Olares components.
|
||||
Change the local IP address for all beOS Pro components.
|
||||
|
||||
```bash
|
||||
olares-cli change-ip [option]
|
||||
@@ -14,12 +14,12 @@ olares-cli change-ip [option]
|
||||
|
||||
| Option | Shorthand | Usage | Required | Default |
|
||||
|---------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------|
|
||||
| `--base-dir` | `-b` | Sets the base directory for Olares. | No | `$HOME/.olares` |
|
||||
| `--base-dir` | `-b` | Sets the base directory for beOS Pro. | No | `$HOME/.olares` |
|
||||
| `--distribution` | `-d` | Sets the WSL distribution name. Only applicable on Windows. | No | `Ubuntu` |
|
||||
| `--help` | `-h` | Displays help information. | No | N/A |
|
||||
| `--new-master-host` | | Specifies the new IP address of the master node on the worker node.<br> Only applicable for a multi-node Olares cluster. | No | N/A |
|
||||
| `--new-master-host` | | Specifies the new IP address of the master node on the worker node.<br> Only applicable for a multi-node beOS Pro cluster. | No | N/A |
|
||||
| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS. | No | `olares-0` |
|
||||
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Current version |
|
||||
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. | No | Current version |
|
||||
|
||||
## Examples
|
||||
- For macOS:
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Synopsis
|
||||
|
||||
The `disk` command provides a set of tools to manage storage resources in the Olares system. It is specifically used for managing LVM-based storage configurations.
|
||||
The `disk` command provides a set of tools to manage storage resources in the beOS Pro system. It is specifically used for managing LVM-based storage configurations.
|
||||
|
||||
|
||||
```bash
|
||||
@@ -13,7 +13,7 @@ olares-cli disk <subcommand>
|
||||
|
||||
| Subcommand | Description |
|
||||
|--|--|
|
||||
| `extend` | Extends Olares storage capacity on LVM-based installations. |
|
||||
| `extend` | Extends beOS Pro storage capacity on LVM-based installations. |
|
||||
| `list-unmounted` | Lists unmounted disks. |
|
||||
|
||||
## Options
|
||||
@@ -28,6 +28,6 @@ olares-cli disk <subcommand>
|
||||
# List all disks that are connected but not mounted
|
||||
olares-cli disk list-unmounted
|
||||
|
||||
# Extend Olares storage by adding newly detected unmounted disks
|
||||
# Extend beOS Pro storage by adding newly detected unmounted disks
|
||||
olares-cli disk extend
|
||||
```
|
||||
@@ -1,7 +1,7 @@
|
||||
# `download`
|
||||
|
||||
## Synopsis
|
||||
The `download` command downloads the necessary packages and components required to install Olares on your local machine. It supports downloading components, checking the status of installation packages, and fetching the manifest file.
|
||||
The `download` command downloads the necessary packages and components required to install beOS Pro on your local machine. It supports downloading components, checking the status of installation packages, and fetching the manifest file.
|
||||
|
||||
```bash
|
||||
olares-cli download <subcommand> [option]
|
||||
@@ -11,26 +11,26 @@ olares-cli download <subcommand> [option]
|
||||
|
||||
| Name | Shorthand | Usage | Example |
|
||||
|-------------|-----------|-------------------------------------------------------|----------------------------------------|
|
||||
| `check` | | Checks the status of the Olares installation package. | `olares-cli download check` |
|
||||
| `component` | `c` | Downloads Olares components. | `olares-cli download component` |
|
||||
| `check` | | Checks the status of the beOS Pro installation package. | `olares-cli download check` |
|
||||
| `component` | `c` | Downloads beOS Pro components. | `olares-cli download component` |
|
||||
| `wizard` | `w` | Downloads the manifest file. | `olares-cli download wizard` |
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Shorthand | Usage | Required | Default |
|
||||
|--------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------|
|
||||
| `--base-dir` | `-b` | Sets the base directory for Olares. | No | `$HOME/.olares` |
|
||||
| `--base-dir` | `-b` | Sets the base directory for beOS Pro. | No | `$HOME/.olares` |
|
||||
| `--download-cdn-url`| | Sets the CDN accelerated download URL in the format `https://example.cdn.com`. | No | System default URL |
|
||||
| `--help` | `-h` | Displays help information. | No | N/A |
|
||||
| `--kube` | | Specifies the Kubernetes type. <br>Supported types are `k3s` and `k8s`. | No | `k3s` |
|
||||
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`). Defaults to the current version.<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Current version |
|
||||
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`). Defaults to the current version.<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. | No | Current version |
|
||||
|
||||
## Examples
|
||||
```bash
|
||||
# Specifies the base directory where all downloaded components will be stored.
|
||||
olares-cli download component -b /custom/path
|
||||
|
||||
# Specifies a CDN-accelerated URL for downloading Olares components.
|
||||
# Specifies a CDN-accelerated URL for downloading beOS Pro components.
|
||||
olares-cli download component --download-cdn-url https://my.cdn.com
|
||||
|
||||
# Specifies the Kubernetes type for the installation.
|
||||
@@ -39,7 +39,7 @@ olares-cli download component --kube k8s
|
||||
# Sets the path to the package manifest file.
|
||||
olares-cli download component --manifest /custom/path/manifest.json
|
||||
|
||||
# Specifies the version of Olares packages and components to download.
|
||||
# Specifies the version of beOS Pro packages and components to download.
|
||||
olares-cli download component -v 1.11.0
|
||||
```
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ olares-cli gpu <subcommand> [options]
|
||||
```
|
||||
|
||||
:::info
|
||||
- By default, the Olares installation script detects your GPU hardware and CUDA drivers, then configures and enables the GPU components and services automatically.
|
||||
- By default, the beOS Pro installation script detects your GPU hardware and CUDA drivers, then configures and enables the GPU components and services automatically.
|
||||
- Currently, only NVIDIA GPUs are supported.
|
||||
:::
|
||||
|
||||
@@ -29,7 +29,7 @@ olares-cli gpu <subcommand> [options]
|
||||
| Option | Shorthand | Usage | Required | Default |
|
||||
|------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------|
|
||||
| `--base-dir`| `-b` | Specifies the base installation directory for the GPU components. | No | `$HOME/.olares` |
|
||||
| `--version`| `-v` | Specifies the Olares version for GPU drivers and components. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Current version |
|
||||
| `--version`| `-v` | Specifies the beOS Pro version for GPU drivers and components. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. | No | Current version |
|
||||
| `--help` | `-h` | Displays help information. | No | N/A |
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# `info`
|
||||
|
||||
## Synopsis
|
||||
The `info` command displays general information about the installed Olares version.
|
||||
The `info` command displays general information about the installed beOS Pro version.
|
||||
|
||||
```bash
|
||||
olares-cli info
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user