CasaOS - A simple, easy-to-use, elegant open-source home server system.

CasaOS - A simple, easy-to-use, elegant open-source home server system.

CasaOS

Version Pull Requests Issues GitHub Stars Discord

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.

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.

Key Features

  • UI designed for home scenarios - simple, elegant, and easy-to-use
  • Quick Docker app installation with only three steps, plus automatic management
  • App Store for private cloud 🚧
  • Home data/digital asset management 🚧
  • Smart home manager 🚧

🚧 is under development.

We are actively moving forward with development, and you are more than welcome to share any idea with us!

Community

The word Casa comes from the Spanish word for "home". Project CasaOS originated as a pre-installed system for 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.

A warm welcome for you to share and discuss your great ideas in the Discord server!

Discord Card

Getting Started

⚠️ Note:

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!

System Compatibility

  • Ubuntu Server 20.04 amd64 ( βœ… Recommend, Tested)
  • Debian 11 amd64 ( ⚠️ Not Fully Tested Yet)
  • OpenWrt 21.02 amd64 ( ⚠️ Not Fully Tested Yet)
  • Raspberry Pi OS aarch64/arm64 ( 🚧 Under Planning)
  • OpenWrt 21.02 aarch64/arm64 ( 🚧 Under Planning)

Quick Setup CasaOS

Fresh install a system from the above list and run the below command:

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

To Do

v 0.1.x

  • An elegant UI for home scenarios
  • Custom installation of Docker Apps
  • Update, stop, uninstall, restart, etc. of Docker apps
  • Docker CLI parser
  • System Update
  • Getting Started tutorial
  • Docker Compose parser
  • App config file import and export
  • macvlan network mode

Maintainers

  • Jerry Liu
  • Link Liang
  • Ober Zhang
  • Zyaire Ann
  • John Guan
  • Right here, waiting for YOU!
Comments
  • Add contributors

    Add contributors

    Comment on Issue or Pull Request, asking @all-contributors to add a contributor:

    @all-contributors please add @<username> for <contributions>
    

    <contribution>: See the Emoji Key (Contribution Types Reference) for a list of valid contribution types.

    The bot will then create a Pull Request to add the contributor, then reply with the pull request details.

  • sha256 App apeared after update to 0.3.4

    sha256 App apeared after update to 0.3.4

    Describe the bug After update from 0.3.3 to 0.3.4, an sha256 app appeared in dashboard.

    • this app dont open configuration screen
    • this app dont uninstall
    • this app dont start

    To Reproduce Steps to reproduce the behavior:

    1. Have a production 0.3.3 system version
    2. Update using dropdown menu to 0.3.4 system version
    3. See error

    Expected behavior After update, only my apps and CasaOS native apps appear on dashboard.

    Screenshots image

    Desktop (please complete the following information):

    • OS: CasaOS 0.3.4
    • Browser: Chrome
    • Version: 103.0.5060.134 (oficial version) 64 bits
  • [Bug] Casaos-gateway command using 100% cpu constantly

    [Bug] Casaos-gateway command using 100% cpu constantly

    I log into CasaOS and the CPU is always nearly at 100%

    Describe the bug I log into CasaOS and the CPU is always nearly at 100%

    To Reproduce

    1. Log into CasaOS
    2. Check CPU utilization which is always at 100%
    3. Did a TOP command run via SSH to CasaOS to verify.
    4. Verified - PID 580, User root, cammand casaos-gateway utilizaing 100% of CPU

    Expected behavior If I reboot the Raspberry its stops but the next day it starts again and just goes on for hours. Not sure how long it takes as I reboot the Pi to get things back to normal. Expected behaviour is not this to happen. Using latest version o CasaOS v0.3.7. On version v0.3.6 this did not happen.

    Screenshots If applicable, add screenshots to help explain your problem.

    Desktop (please complete the following information):

    • OS: Raspbian GNU/Linux 11 (bullseye)
    • Browser [chrome]
    • Version [11]

    Additional context Running CASAOS on raspberry Pi 4 with 4 GB RAM

  • [Bug] Issue script install

    [Bug] Issue script install

    Hello all,

    I am currently having a problem installing CasaOS on my raspberry. I followed the installation instructions by doing the following command:

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

    But nothing happens, no action starts even with or without sudo or with wget or curl :

    Capture d’écran 2022-12-20 aΜ€ 01 42 00

    I have checked the required packages and I have: bash, mv, rm, tr, grep, sed, curl/wget, tar, smartmontools, parted, ntfs-3g, net-tools

    Do you have any solutions ?

    Thanks by advance

  • [FAILED] Dependency smartmontools  installation failed, please try again manually!

    [FAILED] Dependency smartmontools installation failed, please try again manually!

    Installer fails on "[FAILED] Dependency smartmontools installation failed, please try again manually!" with Debian 11.4.0 fresh install running on Hyper-V

    Have removed and reinstalled smartmontools manually through apt, but this doesn't work

  • Version displays V0 and USB drive doesn't mount correctly

    Version displays V0 and USB drive doesn't mount correctly

    Came down to it and noticed my containers weren't working. The version is listed as V0 and my USB drive shows up, but doesn't show any data on storage and isn't mounted on the file system.

  • RPI OS fails to boot

    RPI OS fails to boot

    Bug OS fails to boot because of a failed start job trying to mount the SSD where CasaOS is installed.

    Steps to reproduce the behaviour:

    1. Install CasaOS on a newly flashed Raspberry Pi OS Lite or Desktop on an external HDD/SSD.
    2. Do the basic setup of setting up a user.
    3. Do a reboot.
    4. See error "Timed out waiting for device /dev/disk/by-partuuid/<uuid_of_SSD/HDD>".

    Expected behavior A fresh OS image with just CasaOS should reboot just fine. I faced this issue with both Raspberry Pi OS Lite and Desktop. Also I tried flashing the OS on an SD card then installing CasaOS. But, as soon as you attach an external drive and reboot, it fails.

    Addtional ERROR Messages:

    [TIME] Timed out waiting for device /dev/disk/by-partuuid/<uuid_of_SSD/HDD>
    [DEPEND] Dependency failed for /boot.
    [DEPEND] Dependency failed for Local File Systems.
    [DEPEND] Dependency failed for File System Check on /dev/disk/by-partuuid/<uuid_of_SSD/HDD>
    

    System Information:

    • OS: Raspberry Pi OS Lite (32-bit)
    • Hardware: Raspberry Pi-4 4GB RAM
    • CasaOS Version: v0.2.3
  • APP Store is not loading

    APP Store is not loading

    Describe the bug

    Hello, I am unable to open app store, already ran following command, systemctl restart casaos.service. casaos is install on a zimaboard. Thanks

    System infomation

     - OS: linux
     - CasaOS Version: 0.3.1.1
     - Disk Total: 27712 
     - Disk Used: 12291 
     - Sync State: Sync img: true
    linuxserver/syncthing:latest,
    Sync Key length: 32
     - System Info: [Debian GNU/Linux 11   \l Bit:64 Mem:7801M Core:4 Linux CasaOS 5.10.0-10-amd64 #1 SMP Debian 5.10.84-1 (2021-12-08) x86_64 GNU/Linux]
     - Browser: Edge 
     - Version: 102.0.1245.30
    
  • Create Storage  failed + All files deleted

    Create Storage failed + All files deleted

    Describe the bug

    A new 1TB SSD is detected by CasaOS, when I try to create a new 'storage', a window opens during 2 seconds 'storage creation in progress', and closes. Nothing else happens, and no storage created

    System infomation

     - OS: linux
     - CasaOS Version: 0.2.9
     - Disk Total: 13105 
     - Disk Used: 5585 
     - Sync State: Sync img: true
    linuxserver/syncthing,
    Sync Key length: 32
     - System Info: [Debian GNU/Linux 11   \l Bit:64 Mem:1826M Core:4 Linux CasaOS 5.10.0-9-amd64 #1 SMP Debian 5.10.70-1 (2021-09-30) x86_64 GNU/Linux]
     - Browser: Chrome 
     - Version: 98.0.4758.102
    
  • [Bug] during install of casaos apps or docker compose apps, it will just show

    [Bug] during install of casaos apps or docker compose apps, it will just show "Start Installation" during the whole process

    Describe the bug during install of casaos apps or docker compose apps, it will just show "Start Installation" during the whole process

    To Reproduce Steps to reproduce the behavior:

    1. i tried a few times to reformat my raspberry pi cm4 OS system and reinstall casaos, but a few times it will show install failed on smarttools, is it this one ?
    2. then when try to install new apps in the "App Store" or in docker-compose text file
    3. it will just show "Start Installation" during the whole downloading and installation process

    Expected behavior it will just show "Start Installation" during the whole downloading and installation process

    Screenshots Here is the shot screenshot video file image

    https://user-images.githubusercontent.com/110435214/187037582-21e3bbaf-d6dd-414a-8531-50ba66ac366e.mp4

    Desktop (please complete the following information):

    • OS: Windows 10 Pro
    • Browser Mozilla Firefox

    Additional context Add any other context about the problem here.

  • Show recommended apps toggle button missing in v 0.3.8

    Show recommended apps toggle button missing in v 0.3.8

    Dear all, I'm just setting up a new CasaOS v0.3.8 instance and found that the option to show/hide recommended apps has been removed. It was really useful, specially when accessing the GUI from a mobile phone. I'd love to have this feature back as it is on v0.3.7.1 Thanks for this great tool !

  • [App Request] filedrop-v2

    [App Request] filedrop-v2

    App Information

    • Name: FileDrop

    • Short Description: A web app to drop files from a server to clients

    • GitHub Repository: https://github.com/Noe-Favier/filedrop-v2

    • Docker Image: https://hub.docker.com/r/noecl/filedrop

    Why do you want this app?

    I was looking for a light application to provide a web link to share a very large file (sharing a .zip family photo file...) Anyway I found ZendTo which interested me but I didn't succeed to install it (it requires docker compose installed in the system... not present...) Finally while searching on Github I discovered a light application written under Rust the filedrop-v2 was easily installed and does perfectly what I wanted to do, if I use it behind a domain name managed by Nginx Proxy Manager... Simple and efficient, so I share.

    Additional information?

    πŸš€ πŸš€ πŸš€

  • [Bug] n8n default configuration persists the wrong folder, causing data loss

    [Bug] n8n default configuration persists the wrong folder, causing data loss

    Describe the bug When installing n8n from the app store the container is created with this path: host: /DATA/AppData/n8n/.n8n container: .n8n This is wrong, it results in losing data, I lost my data multiple times when changing environment variables. The correct directory to persist is: /home/node/.n8n This is were the data is actually stored.

    To Reproduce Steps to reproduce the behavior:

    1. Go to 'App Store'
    2. Click on 'n8n'
    3. Install it
    4. Look at the settings in the mounts section

    Expected behavior /home/node/.n8n should be in the container path instead of just .n8n

    Desktop (please complete the following information):

    • OS: [e.g. iOS] Windows 11
    • Browser [e.g. chrome, safari] Firefox
    • Version [e.g. 22] 109.0b7
  • [Bug] NetBIOS abused for DDos

    [Bug] NetBIOS abused for DDos

    Hello I installed CasaOS and since when installing it there are dependencies like smbd and nmbd, which are problematic on cloud/server/VPS level, I suggest adding an option part to the installer script for not installing them, or even disabling and removing them from UI because one might not want nor use them at all and having them installed on the machine might be problematic.

    photo_2023-01-02_12-30-27

    photo_2023-01-02_12-30-32

  • [Bug] Issue : Can't add network storage

    [Bug] Issue : Can't add network storage

    Description

    Can't add network storage to Casa OS, it failed with an error

    Additional Information

     - OS: linux
     - CasaOS Version: 0.4.0
     - Disk Total: 7963 
     - Disk Used: 1677 
     - System Info: [Debian GNU/Linux 11   \l Bit:64 Mem:2048M Core:2 Linux casaos 5.15.74-1-pve #1 SMP PVE 5.15.74-1 (Mon, 14 Nov 2022 20:17:15 +0100) x86_64 GNU/Linux]
     - Remote Version: 0.4.0
     - Browser: Safari 
     - Version: 16.2
    
  • [Feature] App segments for many apps in dashboard

    [Feature] App segments for many apps in dashboard

    Is your feature request related to a problem? Please describe. When the number of apps increases it becomes difficult to navigate the UI.

    Describe the solution you'd like App drawers or app sections in UI, something like stardock fences.

    Describe alternatives you've considered Manually scrolling an endless array of apps

    Additional context image

RoadRunner: an open-source high-performance PHP application server, load balancer, and process manager
RoadRunner: an open-source high-performance PHP application server, load balancer, and process manager

RoadRunner is an open-source (MIT licensed) high-performance PHP application server, load balancer, and process manager. It supports running as a serv

Jan 13, 2022
An open-source, on-prem feature flag solution
An open-source, on-prem feature flag solution

An open-source, on-prem feature flag solution Documentation | Features | Values | Examples | Enterprise Flipt is an open source, on-prem feature flag

Dec 24, 2022
Flagr is an open source Go service that delivers the right experience to the right entity and monitors the impact.
Flagr is an open source Go service that delivers the right experience to the right entity and monitors the impact.

Flagr is an open source Go service that delivers the right experience to the right entity and monitors the impact. It provides feature flags, experimentation (A/B testing), and dynamic configuration. It has clear swagger REST APIs for flags management and flag evaluation.

Dec 25, 2022
The Zuri Core is an open-source API that serves as the backend and backbone of Zuri Chat
The Zuri Core is an open-source API that serves as the backend and backbone of Zuri Chat

The Zuri Core is an open-source API that serves as the backend and backbone of Zuri Chat

Dec 26, 2022
Go package for the BeagleBone open source hardware

go-beaglebone Go package for the BeagleBone open source hardware Also check out https://github.com/SpaceLeap/go-embedded This package builds on top of

Jul 6, 2019
a simple http server as replacement of python -m http.server

ser a simple http server as replacement of python -m http.server

Dec 5, 2022
A feature flag solution, with only a YAML file in the backend (S3, GitHub, HTTP, local file ...), no server to install, just add a file in a central system and refer to it. πŸŽ›οΈ
A feature flag solution, with only a YAML file in the backend (S3, GitHub, HTTP, local file ...), no server to install, just add a file in a central system and refer to it. πŸŽ›οΈ

??️ go-feature-flag A feature flag solution, with YAML file in the backend (S3, GitHub, HTTP, local file ...). No server to install, just add a file i

Dec 29, 2022
ready-to-use RTSP / RTMP server and proxy that allows to read, publish and proxy video and audio streams
ready-to-use RTSP / RTMP server and proxy that allows to read, publish and proxy video and audio streams

rtsp-simple-server is a simple, ready-to-use and zero-dependency RTSP / RTMP server and proxy, a software that allows users to publish, read and proxy live video and audio streams. RTSP is a specification that describes how to perform these operations with the help of a server, that is contacted by both publishers and readers and relays the publisher's streams to the readers.

Dec 31, 2022
A simple http-web server logging incoming requests to stdout with simple http-interface.
A simple http-web server logging incoming requests to stdout with simple http-interface.

http-cli-echo-logger A simple http-web server logging incoming requests to stdout with simple http-interface. Run locally go run ./cmd/main.go Default

Jul 18, 2022
Simple webhook delivery system powered by Golang and PostgreSQL

postmand Simple webhook delivery system powered by Golang and PostgreSQL. Features Simple rest api with only three endpoints (webhooks/deliveries/deli

Dec 22, 2022
OpenAPI specs for your Go server, generated at server runtime. No CLI, no code generation, and no HTTP

Overview "oas" is short for "OpenAPI Spec". Go package for generating OpenAPI docs at runtime. Non-features: No code generation. No CLI. No magic comm

Dec 3, 2021
A Language Server Protocol (LSP) server for Jsonnet

Jsonnet Language Server A Language Server Protocol (LSP) server for Jsonnet. Features Jump to definition self-support.mp4 dollar-support.mp4 Error/War

Dec 14, 2022
Go web server - A web server that can accept a GET request and serve a response.

go_web_server A web server that can accept a GET request and serve a response. Go is a great language for creating simple yet efficient web servers an

Jan 3, 2022
Open platform to collect and prioritize product feedback
Open platform to collect and prioritize product feedback

Fider A platform to collect and organize customer feedback. Let your customers share, vote and discuss on suggestions they have to make your product e

Jan 1, 2023
A simple SHOUTcast server.

DudelDu DudelDu is a simple audio/video streaming server using the SHOUTcast protocol. Features Supports various streaming clients: VLC, ServeStream,

Nov 20, 2022
Heart πŸ’œA high performance Lua web server with a simple, powerful API
Heart πŸ’œA high performance Lua web server with a simple, powerful API

Heart ?? A high performance Lua web server with a simple, powerful API. See the full documentation here. Overview Heart combines Go's fasthttp with Lu

Aug 31, 2022
KissLists is a very simple shared lists server
KissLists is a very simple shared lists server

KissLists is a very simple shared lists server. with mobile optimised design basic theme support websockets messages sqlite database but no

Nov 30, 2022
A simple HTTP Server to share files over WiFi via Qr Code
A simple HTTP Server to share files over WiFi via Qr Code

go-fileserver A simple HTTP server to share files over WiFi via QRCode Installation You can download compressed version from

Oct 8, 2022
Oogway is a simple web server with dynamic content generation and extendability in mind supporting a Git based workflow.

Oogway Oogway is a simple web server with dynamic content generation and extendability in mind supporting a Git based workflow. It's somewhere in betw

Nov 9, 2022