CasaOS README

The project's README from github.com/IceWhaleTech/CasaOS. As one markdown file: README.md.

CasaOS - Your Personal Cloud

CasaOS
Connect with the community, establish autonomy, reduce the cost of SaaS, and MAXIMIZE the potential for a personalized copilot.

CasaOS Version CasaOS License CasaOS Pull Requests CasaOS Issues CasaOS Stargazers
IceWhale Discord CasaOS GitHub Discussions All Contributors YouTube Tutorial Views
twitter ZimaSpace facebook ZimaSpace
Website | Demo | GitHub

CasaOS Snapshot

Why do you need Personal Cloud?

In 2020, the team noticed three important trends:

Based on these trends, the team proposed a thought experiment internally: what if personal clouds were available under $100 in next five years? This personal cloud would provide a low-cost data collaboration solution as a personal data center, storing and managing data for creators and small organizations. A distributed collaborative computing network can be formed by personal servers located around the world. It could also control and connect all smart devices, providing cross-ecosystem local intelligent services.

Furthermore, the personal cloud could combine personal data to train personalized AI assistants. The idea is that this technology would be an effective way to solve the issue of consumer data asset ownership and , as well as provide a more affordable and efficient computing solution for individuals and small organizations.

If you think what we are doing is valuable. Please give us a star ⭐ and fork it 🤞!

Features

Getting Started

CasaOS fully supports ZimaBoard, Intel NUC, and Raspberry Pi. Also, more computers and development boards and fully compatible with Ubuntu, Debian, Raspberry Pi OS, and CentOS with one-liner installation.

Hardware Compatibility

System Compatibility

Official Support

Community Support

Quick Setup CasaOS

Freshly install a system from the list above and run this command:

wget -qO- https://get.casaos.io | sudo bash

or

curl -fsSL https://get.casaos.io | sudo bash

Update CasaOS

CasaOS can be updated from the User Interface (UI), via Settings ... Update.

Alternatively it can be updated from a terminal session. To update from a terminal session, it must be done either from a secure shell (ssh) session to the device or from a directly attached terminal and keyboard to the device running CasaOS, this cannot be done from the terminal via the CasaOS User Interface (UI). To update to the latest release of CasaOS from a terminal session run this command:

wget -qO- https://get.casaos.io/update | sudo bash

or

curl -fsSL https://get.casaos.io/update | sudo bash

To determine version of CasaOS from a terminal session run this command:

casaos -v

Uninstall CasaOS

v0.3.3 or newer

casaos-uninstall

Before v0.3.3

curl -fsSL https://get.icewhale.io/casaos-uninstall.sh | sudo bash

Community

The word Casa comes from the Spanish word for "home". Project CasaOS originated as a pre-installed system for the crowdfunded product ZimaBoard on Kickstarter.

After looking at many systems and software on the market, the team found no server system designed for home scenarios, sadly true.

So, we set out to build this open-source project to develop CasaOS with our own hands, everyone in the community, and you.

We believe that through community-driven collaborative innovation and open communication with global developers, we can reshape the digital home experience like never before.

A warm welcome for you to get help or share great ideas in the Discord!

Discord Card

Contributing

CasaOS is a community-driven open source project and the people involved are CasaOS users. That means CasaOS will always need contributions from community members just like you!

Credits

Many thanks to everyone who has helped CasaOS so far!

Everyone's contribution is greatly appreciated. (Emoji Key)


老竭力
💻 📖 🤔 🚇 🚧 📦 💬 👀
link
💻 📖 🤔 🚇 🚧 💬 👀
太戈
💻 📖 🤔 🚇 🚧 🧑‍🏫 🛡️ 💬 👀
Lauren
🤔 🔍 📆 💬 ⚠️
John Guan
📝 🖋 📖 🤔 📋 🧑‍🏫 💬 👀
David Tippett
📖 🤔 💬
Skaya
🧑‍🏫 💬 ✅ 🌍

AuthorShin
⚠️ 🐛 💬 🤔
baptiste313
🌍
DrMxrcy
⚠️ 🤔 💬
Joooost
🤔
Vitaly Potyarkin
🤔
Bjørn Friese
🤔
Protektor
🐛 🤔 💬

llwaini
📆 ⚠️ ✅
CorrectRoadH
💻 📖
zhanghengxin
💻 📖

This project follows the all-contributors specification. Contributions of any kind are welcome!

Changelog

Detailed changes for each release are documented in the release notes.

trackgit-views

CasaOS (IceWhaleTech/CasaOS)

Searching Database…

37.3K ·GitHub
CasaOS
What is this?CasaOS is an open-source personal cloud operating system that turns a small computer (ZimaBoard, NUC, Raspberry Pi, or an old PC) into a home server with a friendly web UI for files, apps, and devices.
Is this an app I install, or a whole operating system?It's installed on top of an existing Linux distro (Debian, Ubuntu Server, Raspberry Pi OS, etc.) via a one-liner script, turning that machine into a personal cloud server with a web dashboard — it's not a standalone OS image you flash.
How do I get it running?Freshly install one of the supported Linux systems on your hardware, then run the official one-line install command from the terminal. Updates and some settings can later be managed from the CasaOS web UI itself.
Do I need Docker or anything else installed first?CasaOS relies on the Docker ecosystem to run apps — it lets you install apps from its curated app store or pull in any of over 100,000 Docker images directly.
Will it work on any Linux system, or just the recommended ones?Full testing and official support cover Debian 12, Ubuntu Server 20.04, and Raspberry Pi OS; community-supported systems like Armbian, Alpine, OpenWrt, and ArchLinux exist but some are explicitly marked as not fully tested yet.
What hardware does it actually run on?It targets home-server hardware: ZimaBoard, Intel NUC, Raspberry Pi, and repurposed old computers, on amd64/x86-64, arm64, or armv7 architectures.
What apps come preinstalled or easy to add?The app store includes one-click installs for popular self-hosted apps like Nextcloud, Home Assistant, AdGuard, Jellyfin, and various 'arr' media apps, alongside any Docker image you want.
Why is it called CasaOS?‘Casa’ is Spanish for ‘home’; the project started as the pre-installed software for the Kickstarter-funded ZimaBoard home server.
How do I update or uninstall it?CasaOS can be updated from its own web UI (Settings > Update) or via a terminal command for the latest release; uninstall steps differ slightly depending on whether your version is before or after v0.3.3.
Does it require technical skills to manage files and apps?No — it's designed with a no-code, intuitive UI so file management and app installation need no technical background, following a 'what you see is what you get' approach.
What are similar projects?awesome-raspberry-pi, navidrome, labtether, core, umbrel, dockge, EchoMuse, MagicMirror
Which topics is it in?home-automation, file-manager, vuejs, homelab, iot, raspberry-pi, golang, dashboard, go, productivity, gui, terminal
Creator
IceWhaleTech
Size
176.8 MB
Stars
37.3K
Updated
CommitAug 06Releasev0.4.15Dec 19
Age
5y
Commits · 90 Days