2021-09-27 10:41:15 +00:00
# CasaOS - A simple, easy-to-use, elegant open-source home server system.
2021-09-26 02:35:02 +00:00
2021-09-27 08:19:45 +00:00
2021-09-27 07:27:05 +00:00
2021-09-27 11:27:16 +00:00
[](https://github.com/IceWhaleTech/CasaOS)
2021-09-27 07:27:05 +00:00
[](https://github.com/IceWhaleTech/CasaOS/pulls)
[](https://github.com/IceWhaleTech/CasaOS/issues)
2021-09-27 09:31:30 +00:00
[](https://github.com/IceWhaleTech/CasaOS/stargazers)
2021-09-27 07:27:05 +00:00
[](https://discord.gg/Gx4BCEtHjx)
2021-09-27 10:42:37 +00:00
CasaOS is an open-source home server system based on the Docker ecosystem and designed for home scenarios. It is committed to building the world's most simple, easy-to-use, and elegant home server system.
2021-09-27 07:27:05 +00:00
2021-09-27 10:41:15 +00:00
IceWhale team believes that through community-driven collaborative innovation and open communication with global developers, we can reshape the digital home experience like never before.
2021-09-27 07:27:05 +00:00
## Features
2021-09-27 10:41:15 +00:00
- UI designed for home scenarios - simple, elegant, and easy-to-use
- Quick Docker app installation with only three steps
2021-09-27 07:27:05 +00:00
- Automatic Docker application management
2021-09-27 10:41:15 +00:00
- App Store for private cloud 🚧
- Home data/digital asset management 🚧
- Smart home manager 🚧
2021-09-27 07:27:05 +00:00
2021-09-27 10:41:15 +00:00
🚧 is under development.
2021-09-27 07:27:05 +00:00
2021-09-27 10:41:15 +00:00
We are actively moving forward with development, and you are more than welcome to share any idea in the [Discord server ](https://discord.gg/Gx4BCEtHjx )!
2021-09-27 07:27:05 +00:00
2021-09-27 08:10:41 +00:00
## Community
2021-09-27 07:27:05 +00:00
2021-09-27 10:41:15 +00:00
The word Casa comes from the Spanish word for "home". Project CasaOS originated as a pre-installed system for crowdfunded product [ZimaBoard ](https://www.zimaboard.com ) on Kickstarter.
2021-09-27 07:27:05 +00:00
2021-09-27 10:41:15 +00:00
After looking at many systems and software on the market, the team found no server system designed for home scenarios, sadly true.
2021-09-27 07:27:05 +00:00
2021-09-27 10:41:15 +00:00
So, we set out to build this open source project to develop CasaOS with our own hands, everyone in the community, and you.
2021-09-27 07:27:05 +00:00
2021-09-27 10:41:15 +00:00
> A warm welcome for you to share and discuss your great ideas in the [Discord server](https://discord.gg/Gx4BCEtHjx)!
2021-09-27 07:27:05 +00:00
[](https://discord.gg/Gx4BCEtHjx)
## Getting Started
> ⚠️ Note:
>
2021-09-27 10:41:15 +00:00
> CasaOS is still in the early development stage and may vary significantly with the final release. Feel free to test run and share your feedback in the [Discord server](https://discord.gg/Gx4BCEtHjx)!
2021-09-27 07:27:05 +00:00
### System Compatibility
- Ubuntu Server 20.04 amd64 (✅ Recommend, Tested)
2021-09-27 07:54:07 +00:00
- Debian 11 amd64 (⚠️ Not Fully Tested Yet)
- OpenWrt 21.02 amd64 (⚠️ Not Fully Tested Yet)
2021-09-27 07:27:05 +00:00
- Raspberry Pi OS aarch64/arm64 (🚧 Under Planning)
- OpenWrt 21.02 aarch64/arm64 (🚧 Under Planning)
### Quick Setup CasaOS
2021-09-27 10:41:15 +00:00
Fresh install a system from the above list and run the below command:
2021-09-27 07:27:05 +00:00
```sh
curl -fsSL https://get.icewhale.io/casaos.sh | bash
```
## To Do
**v 0.1.x**
2021-09-27 10:41:15 +00:00
- [x] An elegant UI for home scenarios
2021-09-27 07:27:05 +00:00
- [x] Custom installation of Docker Apps
2021-09-27 10:41:15 +00:00
- [x] Update, stop, uninstall, restart, etc. of Docker apps
2021-09-27 07:27:05 +00:00
- [x] Docker CLI parser
- [x] System Update
- [ ] Getting Started tutorial
- [ ] Docker Compose parser
- [ ] App config file import and export
- [ ] macvlan network mode
2021-09-27 11:08:39 +00:00
## Maintainers
- Jerry Liu
- Link Liang
- Ober Zhang
- Zyaire Ann
- John Guan
- More seats vacant for the right person
