Awesome
<div align="center">Olares: An Open-Source Sovereign Cloud OS for Local AI<!-- omit in toc -->
https://github.com/user-attachments/assets/3089a524-c135-4f96-ad2b-c66bf4ee7471
Build your local AI assistants, sync data across places, self-host your workspace, stream your own media, and more—all in your sovereign cloud made possible by Olares.
<p align="center"> <a href="https://olares.xyz">Website</a> · <a href="https://docs.olares.xyz">Documentation</a> · <a href="https://olares.xyz/larepass">Download LarePass</a> · <a href="https://github.com/beclab/apps">Olares Apps</a> · <a href="https://space.olares.xyz">Olares Space</a> </p>[!IMPORTANT]
We just finished our rebranding from Terminus to Olares recently. For more information, refer to our rebranding blog.
Convert your hardware into an AI home server with Olares, an open-source sovereign cloud OS built for local AI.
- Run leading AI models on your terms: Effortlessly host powerful open AI models like LLaMA, Stable Diffusion, Whisper, and Flux.1 directly on your hardware, giving you full control over your AI environment.
- Deploy with ease: Discover and install a wide range of open-source AI apps from Olares Market in a few clicks. No more complicated configuration or setup.
- Access anytime, anywhere: Access your AI apps and models through a browser whenever and wherever you need them.
- Integrated AI for smarter AI experience: Using a Model Context Protocol (MCP)-like mechanism, Olares seamlessly connects AI models with AI apps and your private data sets. This creates highly personalized, context-aware AI interactions that adapt to your needs.
🌟 Star us to receive instant notifications about new releases and updates.
Why Olares?
Here is why and where you can count on Olares for private, powerful, and secure sovereign cloud experience:
🤖 Edge AI: Run cutting-edge open AI models locally, including large language models, computer vision, and speech recognition. Create private AI services tailored to your data for enhanced functionality and privacy. <br>
📊 Personal data repository: Securely store, sync, and manage your important files, photos, and documents across devices and locations.<br>
🚀 Self-hosted workspace: Build a free collaborative workspace for your team using secure, open-source SaaS alternatives.<br>
🎥 Private media server: Host your own streaming services with your personal media collections. <br>
🏡 Smart Home Hub: Create a central control point for your IoT devices and home automation. <br>
🤝 User-owned decentralized social media: Easily install decentralized social media apps such as Mastodon, Ghost, and WordPress on Olares, allowing you to build a personal brand without the risk of being banned or paying platform commissions.<br>
📚 Learning platform: Explore self-hosting, container orchestration, and cloud technologies hands-on.
Getting started
System compatibility
Olares is available for Linux, Raspberry Pi, Mac, and Windows. It has been tested and verified on the following systems:
| Platform | Operating system | Notes |
|---|---|---|
| Linux | Ubuntu 20.04 LTS or later <br/> Debian 11 or later | |
| Raspberry Pi | RaspbianOS | Verified on Raspberry Pi 4 Model B and Raspberry Pi 5 |
| Windows | Windows 11 23H2 or later <br/>Windows 10 22H2 or later<br/> WSL2 | |
| Mac | Monterey (12) or later | |
| Proxmox VE (PVE) | Proxmox Virtual Environment 8.0 |
Note
If you successfully install Olares on an operating system that is not listed in the compatibility table, please let us know! You can open an issue or submit a pull request on our GitHub repository.
Set up Olares
To get started with Olares on your own device, follow the Getting Started Guide for step-by-step instructions.
Tech stacks
Public clouds have IaaS, PaaS, and SaaS layers. Olares provides open-source alternatives to these layers.
Features
Olares offers a wide array of features designed to enhance security, ease of use, and development flexibility:
- Enterprise-grade security: Simplified network configuration using Tailscale, Headscale, Cloudflare Tunnel, and FRP.
- Secure and permissionless application ecosystem: Sandboxing ensures application isolation and security.
- Unified file system and database: Automated scaling, backups, and high availability.
- Single sign-on: Log in once to access all applications within Olares with a shared authentication service.
- AI capabilities: Comprehensive solution for GPU management, local AI model hosting, and private knowledge bases while maintaining data privacy.
- Built-in applications: Includes file manager, sync drive, vault, reader, app market, settings, and dashboard.
- Seamless anywhere access: Access your devices from anywhere using dedicated clients for mobile, desktop, and browsers.
- Development tools: Comprehensive development tools for effortless application development and porting.
Comparison with other self-hosting solutions
As an open-source sovereign cloud OS for local AI, Olares reimagines what’s possible in self-hosting. To help you understand how Olares stands out in the landscape, we’ve created a comparison table that highlights its features alongside those of other self-hosting solutions in the market.
Legend:
- 🚀: Auto, indicates that the system completes the task automatically.
- ✅: Yes, indicates that users without a developer background can complete the setup through the product's UI prompts.
- 🛠️: Manual Configuration, indicates that even users with an engineering background need to refer to tutorials to complete the setup.
- ❌: No, indicates that the feature is not supported.
| Olares | Synology | TrueNAS | CasaOS | Unraid | |
|---|---|---|---|---|---|
| Source Code License | Olares License | Closed | GPL 3.0 | Apache 2.0 | Closed |
| Built On | Kubernetes | Linux | Kubernetes | Docker | Docker |
| Local LLM Hosting | 🚀 | 🛠️ | 🛠️ | 🛠️ | 🛠️ |
| Local LLM app development | 🚀 | 🛠️ | 🛠️ | 🛠️ | 🛠️ |
| Multi-Node | ✅ | ❌ | ✅ | ❌ | ❌ |
| Build-in Apps | ✅ (Rich desktop apps) | ✅ (Rich desktop apps) | ❌ (CLI) | ✅ (Simple desktop apps) | ✅ (Dashboard) |
| Free Domain Name | ✅ | ✅ | ❌ | ❌ | ❌ |
| Auto SSL Certificate | 🚀 | ✅ | 🛠️ | 🛠️ | 🛠️ |
| Reverse Proxy | 🚀 | ✅ | 🛠️ | 🛠️ | 🛠️ |
| VPN Management | 🚀 | 🛠️ | 🛠️ | 🛠️ | 🛠️ |
| Graded App Entrance | 🚀 | 🛠️ | 🛠️ | 🛠️ | 🛠️ |
| Multi-User Management | ✅ User management <br>🚀 Resource isolation | ✅ User management<br>🛠️ Resource isolation | ✅ User management<br>🛠️ Resource isolation | ❌ | ✅ User management <br>🛠️ Resource isolation |
| Single Login for All Apps | 🚀 | ❌ | ❌ | ❌ | ❌ |
| Cross-Node Storage | 🚀 (Juicefs+<br>MinIO) | ❌ | ❌ | ❌ | ❌ |
| Database Solution | 🚀 (Built-in cloud-native solution) | 🛠️ | 🛠️ | 🛠️ | 🛠️ |
| Disaster Recovery | 🚀 (MinIO's Erasure Coding) | ✅ RAID | ✅ RAID | ✅ RAID | ✅ Unraid Storage |
| Backup | ✅ App Data <br>✅ User Data | ✅ User Data | ✅ User Data | ✅ User Data | ✅ User Data |
| App Sandboxing | ✅ | ❌ | ❌ (K8S's namespace) | ❌ | ❌ |
| App Ecosystem | ✅ (Official + third-party) | ✅ (Majorly official apps) | ✅ (Official + third-party submissions) | ✅ Majorly official apps | ✅ (Community app market) |
| Developer Friendly | ✅ IDE <br>✅ CLI <br>✅ SDK <br>✅ Doc | ✅ CLI <br>✅ SDK <br>✅ Doc | ✅ CLI <br>✅ Doc | ✅ CLI <br>✅ Doc | ✅ Doc |
| Client Platforms | ✅ Android <br>✅ iOS <br>✅ Windows <br>✅ Mac <br>✅ Chrome Plugin | ✅ Android <br>✅ iOS | ❌ | ❌ | ❌ |
| Client Functionality | ✅ (All-in-one client app) | ✅ (14 separate client apps) | ❌ | ❌ | ❌ |
Project navigation
Olares consists of numerous code repositories publicly available on GitHub. The current repository is responsible for the final compilation, packaging, installation, and upgrade of the operating system, while specific changes mostly take place in their corresponding repositories.
The following table lists the project directories under Olares and their corresponding repositories. Find the one that interests you:
<details> <summary><b>Framework components</b></summary>| Directory | Repository | Description |
|---|---|---|
| frameworks/app-service | https://github.com/beclab/app-service | A system framework component that provides lifecycle management and various security controls for all apps in the system. |
| frameworks/backup-server | https://github.com/beclab/backup-server | A system framework component that provides scheduled full or incremental cluster backup services. |
| frameworks/bfl | https://github.com/beclab/bfl | Backend For Launcher (BFL), a system framework component serving as the user access point and aggregating and proxying interfaces of various backend services. |
| frameworks/GPU | https://github.com/grgalex/nvshare | GPU sharing mechanism that allows multiple processes (or containers running on Kubernetes) to securely run on the same physical GPU concurrently, each having the whole GPU memory available. |
| frameworks/l4-bfl-proxy | https://github.com/beclab/l4-bfl-proxy | Layer 4 network proxy for BFL. By prereading SNI, it provides a dynamic route to pass through into the user's Ingress. |
| frameworks/osnode-init | https://github.com/beclab/osnode-init | A system framework component that initializes node data when a new node joins the cluster. |
| frameworks/system-server | https://github.com/beclab/system-server | As a part of system runtime frameworks, it provides a mechanism for security calls between apps. |
| frameworks/tapr | https://github.com/beclab/tapr | Olares Application Runtime components. |
| Directory | Repository | Description |
|---|---|---|
| apps/analytic | https://github.com/beclab/analytic | Developed based on Umami, Analytic is a simple, fast, privacy-focused alternative to Google Analytics. |
| apps/market | https://github.com/beclab/market | This repository deploys the front-end part of the application market in Olares. |
| apps/market-server | https://github.com/beclab/market | This repository deploys the back-end part of the application market in Olares. |
| apps/argo | https://github.com/argoproj/argo-workflows | A workflow engine for orchestrating container execution of local recommendation algorithms. |
| apps/desktop | https://github.com/beclab/desktop | The built-in desktop application of the system. |
| apps/devbox | https://github.com/beclab/devbox | An IDE for developers to port and develop Olares applications. |
| apps/vault | https://github.com/beclab/termipass | A free alternative to 1Password and Bitwarden for teams and enterprises of any size Developed based on Padloc. It serves as the client that helps you manage DID, Olares ID, and Olares devices. |
| apps/files | https://github.com/beclab/files | A built-in file manager modified from Filebrowser, providing management of files on Drive, Sync, and various Olares physical nodes. |
| apps/notifications | https://github.com/beclab/notifications | The notifications system of Olares |
| apps/profile | https://github.com/beclab/profile | Linktree alternative in Olares |
| apps/rsshub | https://github.com/beclab/rsshub | A RSS subscription manager based on RssHub. |
| apps/settings | https://github.com/beclab/settings | Built-in system settings. |
| apps/system-apps | https://github.com/beclab/system-apps | Built based on the kubesphere/console project, system-service provides a self-hosted cloud platform that helps users understand and control the system's runtime status and resource usage through a visual Dashboard and feature-rich ControlHub. |
| apps/wizard | https://github.com/beclab/wizard | A wizard application to walk users through the system activation process. |
| Directory | Repository | Description |
|---|---|---|
| third-party/authelia | https://github.com/beclab/authelia | An open-source authentication and authorization server providing two-factor authentication and single sign-on (SSO) for your applications via a web portal. |
| third-party/headscale | https://github.com/beclab/headscale | An open source, self-hosted implementation of the Tailscale control server in Olares to manage Tailscale in LarePass across different devices. |
| third-party/infisical | https://github.com/beclab/infisical | An open-source secret management platform that syncs secrets across your teams/infrastructure and prevents secret leaks. |
| third-party/juicefs | https://github.com/beclab/juicefs-ext | A distributed POSIX file system built on top of Redis and S3, allowing apps on different nodes to access the same data via POSIX interface. |
| third-party/ks-console | https://github.com/kubesphere/console | Kubesphere console that allows for cluster management via a Web GUI. |
| third-party/ks-installer | https://github.com/beclab/ks-installer-ext | Kubesphere installer component that automatically creates Kubesphere clusters based on cluster resource definitions. |
| third-party/kube-state-metrics | https://github.com/beclab/kube-state-metrics | kube-state-metrics (KSM) is a simple service that listens to the Kubernetes API server and generates metrics about the state of the objects. |
| third-party/notification-manager | https://github.com/beclab/notification-manager-ext | Kubesphere's notification management component for unified management of multiple notification channels and custom aggregation of notification content. |
| third-party/predixy | https://github.com/beclab/predixy | Redis cluster proxy service that automatically identifies available nodes and adds namespace isolation. |
| third-party/redis-cluster-operator | https://github.com/beclab/redis-cluster-operator | A cloud-native tool for creating and managing Redis clusters based on Kubernetes. |
| third-party/seafile-server | https://github.com/beclab/seafile-server | The backend service of Seafile (Sync Drive) for handling data storage. |
| third-party/seahub | https://github.com/beclab/seahub | The front-end and middleware service of Seafile (Sync Drive) for handling file sharing, data synchronization, etc. |
| third-party/tailscale | https://github.com/tailscale/tailscale | Tailscale has been integrated in LarePass of all platforms. |
| Directory | Repository | Description |
|---|---|---|
| build/installer | The template for generating the installer build. | |
| build/manifest | Installation build image list template. | |
| libs/fs-lib | https://github.com/beclab/fs-lib | The SDK library for the iNotify-compatible interface implemented based on JuiceFS. |
| scripts | Assisting scripts for generating the installer build. |
Contributing to Olares
We are welcoming contributions in any form:
-
If you want to develop your own applications on Olares, refer to:<br> https://docs.olares.xyz/developer/develop/
-
If you want to help improve Olares, refer to:<br> https://docs.olares.xyz/developer/contribute/olares.html
Community & contact
- GitHub Discussion. Best for sharing feedback and asking questions.
- GitHub Issues. Best for filing bugs you encounter using Olares and submitting feature proposals.
- Discord. Best for sharing anything Olares.
Special thanks
The Olares project has incorporated numerous third-party open source projects, including: Kubernetes, Kubesphere, Padloc, K3S, JuiceFS, MinIO, Envoy, Authelia, Infisical, Dify, Seafile,HeadScale, tailscale, Redis Operator, Nitro, RssHub, predixy, nvshare, LangChain, Quasar, TrustWallet, Restic, ZincSearch, filebrowser, lego, Velero, s3rver, Citusdata.