discover · compare · collections · requirements · contribute · feed · watching · stats · help with your tokens
beclab/Olares · source
Snapshot 0 · 2026-11-04T12:47:27Z · Go · AGPL-3.0
Content fingerprint
808ca31ad1e42de98d3aaf77cb2f597cd82dd2f2d5de5c95fb9dfb2e081b2408GitHub description at capture
Open-Source Personal Cloud OS for Always-On Agents
README at capture
<h1 align="center">Olares</h1> <p align="center"><strong>Your AI Agent. Your Data. Your Hardware.</strong></p> <p align="center"> <a href="#get-started">Install Olares</a> · <a href="https://www.olares.com/docs/one/olares-onboarding">Manage Olares with AI</a> · <a href="#contributing">Contribute</a> </p> <div align="center"> [](https://github.com/beclab/olares/releases) [](https://github.com/beclab/Olares/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> <p> <a href="./README.md"><img alt="Readme in English" src="https://img.shields.io/badge/English-FFFFFF"></a> <a href="./README_CN.md"><img alt="Readme in Chinese" src="https://img.shields.io/badge/简体中文-FFFFFF"></a> <a href="./README_JP.md"><img alt="Readme in Japanese" src="https://img.shields.io/badge/日本語-FFFFFF"></a> </p> </div> **Olares is an open-source personal cloud OS you operate in plain language, built to run AI agents and LLMs on hardware you own.** Powered by Kubernetes, it turns your machines into a self-hosted AI platform accessible from any browser, giving everyone from individual users to small teams a unified place for compute, storage, networking, and apps. https://github.com/user-attachments/assets/3e4b0c5d-dcbe-47eb-8628-88b062411fa0 > 🌟 *If Olares is useful to you, consider giving the project a star. Your support encourages us to keep improving it.* ## Release highlights - **[Olares 1.12.7](https://www.olares.com/blog/olares-1-12-7/):** Router, Lares, and a broader local AI model catalog. - **[Olares 1.12.6](https://www.olares.com/blog/olares-1-12-6/):** Agent Skills, Model Console for local LLMs, and more reliable shared apps. ## Why Olares Great AI needs to know you. That requires access to your files, messages, and history. Many cloud AI services store this sensitive data on third-party servers and charge based on usage. Olares brings AI home, so you can use [Lares](https://www.olares.com/docs/use-cases/lares), the official Olares AI assistant, or agents like [OpenClaw](https://www.olares.com/docs/use-cases/openclaw) with local LLMs on hardware you own while still enjoying the access and convenience of the cloud.  Features include: - **One-click local AI:** Install open-source AI apps and models from [Olares Market](https://www.olares.com/market/) with one click. - **Accelerated computing management:** Pool GPUs and other accelerators across nodes, with time-slicing, memory-slicing, and exclusive GPU modes for AI, media, and gaming workloads. - **[Files and storage management](https://www.olares.com/docs/manual/olares/files/):** Access local files, synced data, connected cloud storage, and external SMB/NFS shares through the built-in Files app, with [configurable backups](https://www.olares.com/docs/manual/olares/settings/backup). - **[Private networking and access controls](https://www.olares.com/docs/developer/concepts/network):** Use a private VPN, reverse proxy, and public, private, or internal entrances to give apps HTTPS endpoints without manually exposing individual ports. - **Anytime, anywhere access:** Access your apps and files from your phone, desktop, or browser. - **A suite of system apps:** Files, Vault, Market, Dashboard, Control Hub, and more, ready the moment you log in. ## Get started ### Linux script requirements To install Olares on an existing Linux system using the script below, your machine needs: - **CPU:** At least 4 cores - **RAM:** At least 8 GB of available memory - **Storage:** At least 150 GB of available SSD storage; installation will fail on an HDD - **OS:** Ubuntu 22.04 to 25.04, or Debian 12 or 13 A dedicated GPU is optional and enables local AI acceleration. ### Install on Linux On your Ubuntu or Debian host, run the following command from an account with `sudo` access: ```bash curl -fsSL https://olares.sh | bash - ``` This command downloads the official installer from `olares.sh` and runs it with Bash. See the [Linux script installation guide](https://www.olares.com/docs/manual/get-started/install-linux-script) for the full setup steps and troubleshooting. For a fresh installation on an Intel or AMD x86-64 machine, use the [ISO image](https://www.olares.com/docs/manual/get-started/install-linux-iso). For a containerized installation on Linux, see the [Docker Compose guide](https://www.olares.com/docs/manual/get-started/install-linux-docker). Once setup is complete, open your Olares desktop in a browser at its address, for example, `https://desktop.marvin123.olares.com`. ### Try your first AI task Follow the [AI onboarding guide](https://www.olares.com/docs/one/olares-onboarding) to set up Router, Lares, and a local model, then start your first conversation. Try asking Lares: "Check this device's configuration." ## Key use cases - **Use a personal AI agent.** Delegate research, file management, and routine automation to [Lares](https://www.olares.com/docs/use-cases/lares) through plain language, or use your preferred agent for coding and other tasks. - **Run generative AI locally.** Chat with open models, generate images and video, and connect local models to other apps, all from your own hardware. - **Manage smart home devices and media.** Connect home automation tools and stream your personal music and video libraries. - **Build and host agentic apps.** Develop, test, and run apps and workflows in isolated environments on Olares. - **Process audio locally.** Transcribe meetings, translate recordings, and generate speech without uploading audio to a third-party service. - **Create a self-hosted workspace.** Give your family or team tools for documents, automation, project management, and communication. - **Manage your personal data.** Store, sync, back up, and access files, photos, and documents across your devices. ## System architecture Just as public clouds offer IaaS, PaaS, and SaaS layers, Olares provides open-source alternatives to each of these layers.  For a detailed description of each component, refer to [Olares architecture](https://www.olares.com/docs/developer/concepts/system-architecture). > 🔍 **How is Olares different from traditional NAS?** > > Olares focuses on building an all-in-one self-hosted personal cloud experience. Its core features and target users differ significantly from Network Attached Storage (NAS) systems, which primarily focus on network storage. For more details, see [Compare Olares and NAS](https://www.olares.com/blog/compare-olares-and-nas/). ## Project navigation The main directories in the Olares repository: ``` Olares/ ├── apps/ # Built-in Olares system applications ├── cli/ # olares-cli: agent-native CLI with Agent Skills to install and operate Olares ├── daemon/ # olaresd, the system daemon process ├── docs/ # Project documentation ├── framework/ # Olares system services ├── infrastructure/ # Computing, storage, networking, and GPU components ├── platform/ # Cloud-native components like databases and message queues └── vendor/ # Hardware-specific code for Olares devices ``` ## Contributing Olares welcomes contributions across the project. Choose the path that best matches what you want to improve: - **Core development:** Browse [open issues](https://github.com/beclab/Olares/issues), or open an issue to discuss your proposal before starting a substantial change. - **Documentation:** Improve the guides in [`docs/`](./docs). See the [documentation contributor guide](./docs/README.md) and [content and style guide](https://github.com/beclab/Olares/wiki/General-style-reference). - **App distribution:** [Package and submit](https://www.olares.com/docs/developer/develop/distribute-index) an app to Olares Market. - **Bug reports and feature requests:** Open a [GitHub issue](https://github.com/beclab/Olares/issues) with enough context for the team to investigate or evaluate it. - **Security reporting:** Follow our [security policy](./SECURITY.md). Please do not report vulnerabilities through public issues, discussions, or community channels. ## Learn more - **[Installation guide](https://www.olares.com/docs/manual/get-started/install-olares):** Choose an installation method and activate Olares. - **[Use cases](https://www.olares.com/docs/use-cases/):** Explore local AI, media, productivity, and self-hosted workflows. - **[CLI guide](https://www.olares.com/docs/developer/cli-overview):** Install, manage, and diagnose Olares from the command line. - **[Agent Skills](https://www.olares.com/docs/developer/cli-agent-skills):** Let AI agents operate Olares through `olares-cli`. ## Community - **[Discord](https://discord.gg/olares):** Get community support and discuss deployments and agent workflows. - **[Olares Forum](https://www.olares.com/forum/):** Share product feedback and join longer-form discussions. - Follow Olares on [X](https://x.com/Olares_OS) and [YouTube](https://www.youtube.com/@OlaresOS). ## Acknowledgements The Olares project has incorporated numerous third-party open-source projects, including: [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/).