CasaOS

command module
v0.4.12-alpha1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 14, 2024 License: Apache-2.0 Imports: 24 Imported by: 0

README ยถ

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
Website | Demo | GitHub

CasaOS Snapshot

Why do you need Personal Cloud?

In 2020, the team noticed three important trends:

  • The cost of computing power and storage was decreasing fast.
  • A part of cloud computing was moving towards edge computing.
  • The issue of consumer data asset ownership and attribution had been ignored.

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

  • Friendly UI designed for home scenarios
    • No code, no forms, intuitive, design for humanity
  • Multiple hardware and base system support
    • ZimaBoard, NUC, RPi, old computers, whatever is available.
  • Selected apps in the app store, one-click installation
    • Nextcloud, HomeAssistant, AdGuard, Jellyfin, *arr and more!
  • Easily install numerous Docker apps
    • Over 100,000 apps from the Docker ecosystem can be easily installed
  • Elegant drive and file management
    • What you see is what you get. No technical background required.
  • Well-designed system/app widgets
    • What you care about, at a glance. Resource usage, app status, and more!

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
  • amd64 / x86-64
  • arm64
  • armv7
System Compatibility

Official Support

  • Debian 12 (โœ… Tested, Recommended)
  • Ubuntu Server 20.04 (โœ… Tested)
  • Raspberry Pi OS (โœ… Tested)

Community Support

  • Elementary 6.1 (โœ… Tested)
  • Armbian 22.04 (โœ… Tested)
  • Alpine (๐Ÿšง Not Fully Tested Yet)
  • OpenWrt (๐Ÿšง Not Fully Tested Yet)
  • ArchLinux (๐Ÿšง Not Fully Tested Yet)
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!

Donate

bappi2097

Credits

Many thanks to everyone who has helped CasaOS so far!

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


่€็ซญๅŠ›

๐Ÿ’ป ๐Ÿ“– ๐Ÿค” ๐Ÿš‡ ๐Ÿšง ๐Ÿ“ฆ ๐Ÿ’ฌ ๐Ÿ‘€

link

๐Ÿ’ป ๐Ÿ“– ๐Ÿค” ๐Ÿš‡ ๐Ÿšง ๐Ÿ’ฌ ๐Ÿ‘€

Tiger Wang (็Ž‹่ฑซ)

๐Ÿ’ป ๐Ÿ“– ๐Ÿค” ๐Ÿš‡ ๐Ÿšง ๐Ÿง‘โ€๐Ÿซ ๐Ÿ›ก๏ธ ๐Ÿ’ฌ ๐Ÿ‘€

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

Documentation ยถ

The Go Gopher

There is no documentation for this package.

Directories ยถ

Path Synopsis
cmd
migration-tool
* @Author: LinkLeong link@icewhale.org * @Date: 2022-08-23 18:09:11 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-31 14:17:51 * @FilePath: /CasaOS/cmd/migration-tool/main.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.org * @Date: 2022-08-23 18:09:11 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-31 14:17:51 * @FilePath: /CasaOS/cmd/migration-tool/main.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.org * @Date: 2022-08-24 17:37:36 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-24 17:38:48 * @FilePath: /CasaOS/interfaces/migrationTool.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.org * @Date: 2022-08-24 17:37:36 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-24 17:38:48 * @FilePath: /CasaOS/interfaces/migrationTool.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
internal
driver
* @Author: a624669980@163.com a624669980@163.com * @Date: 2022-12-13 11:05:05 * @LastEditors: a624669980@163.com a624669980@163.com * @LastEditTime: 2022-12-13 11:05:13 * @FilePath: /drive/internal/driver/config.go * @Description: ่ฟ™ๆ˜ฏ้ป˜่ฎค่ฎพ็ฝฎ,่ฏท่ฎพ็ฝฎ`customMade`, ๆ‰“ๅผ€koroFileHeaderๆŸฅ็œ‹้…็ฝฎ ่ฟ›่กŒ่ฎพ็ฝฎ: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE
* @Author: a624669980@163.com a624669980@163.com * @Date: 2022-12-13 11:05:05 * @LastEditors: a624669980@163.com a624669980@163.com * @LastEditTime: 2022-12-13 11:05:13 * @FilePath: /drive/internal/driver/config.go * @Description: ่ฟ™ๆ˜ฏ้ป˜่ฎค่ฎพ็ฝฎ,่ฏท่ฎพ็ฝฎ`customMade`, ๆ‰“ๅผ€koroFileHeaderๆŸฅ็œ‹้…็ฝฎ ่ฟ›่กŒ่ฎพ็ฝฎ: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE
op
* @Author: LinkLeong link@icewhale.org * @Date: 2022-07-27 10:30:43 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-04 20:06:04 * @FilePath: /CasaOS/model/connections.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.org * @Date: 2022-07-27 10:30:43 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-04 20:06:04 * @FilePath: /CasaOS/model/connections.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
notify
* @Author: LinkLeong link@icewhale.com * @Date: 2022-05-26 14:21:57 * @LastEditors: LinkLeong * @LastEditTime: 2022-06-02 11:14:15 * @FilePath: /CasaOS/model/notify/file.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.com * @Date: 2022-05-26 14:21:57 * @LastEditors: LinkLeong * @LastEditTime: 2022-06-02 11:14:15 * @FilePath: /CasaOS/model/notify/file.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
system_model
* @Author: LinkLeong link@icewhale.com * @Date: 2022-06-15 11:30:47 * @LastEditors: LinkLeong * @LastEditTime: 2022-06-23 18:40:40 * @FilePath: /CasaOS/model/system_model/verify_information.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.com * @Date: 2022-06-15 11:30:47 * @LastEditors: LinkLeong * @LastEditTime: 2022-06-23 18:40:40 * @FilePath: /CasaOS/model/system_model/verify_information.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
pkg
config
* @Author: LinkLeong link@icewhale.com * @Date: 2021-09-30 18:18:14 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-31 17:04:02 * @FilePath: /CasaOS/pkg/config/config.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.com * @Date: 2021-09-30 18:18:14 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-31 17:04:02 * @FilePath: /CasaOS/pkg/config/config.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
fs
samba
* @Author: LinkLeong link@icewhale.org * @Date: 2022-07-27 10:35:29 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-01 13:56:44 * @FilePath: /CasaOS/pkg/samba/smaba.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.org * @Date: 2022-07-27 10:35:29 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-01 13:56:44 * @FilePath: /CasaOS/pkg/samba/smaba.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
singleflight
Package singleflight provides a duplicate function call suppression mechanism.
Package singleflight provides a duplicate function call suppression mechanism.
sqlite
* @Author: LinkLeong link@icewhale.com * @Date: 2022-05-13 18:15:46 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-31 13:39:24 * @FilePath: /CasaOS/pkg/sqlite/db.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.com * @Date: 2022-05-13 18:15:46 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-31 13:39:24 * @FilePath: /CasaOS/pkg/sqlite/db.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
utils
* @Author: LinkLeong a624669980@163.com * @Date: 2022-05-08 14:58:46 * @LastEditors: LinkLeong a624669980@163.com * @LastEditTime: 2022-05-09 13:42:26 * @FilePath: /CasaOS/pkg/utils/network_detection.go * @Description: * * Copyright (c) 2022 by LinkLeong a624669980@163.com, All Rights Reserved.
* @Author: LinkLeong a624669980@163.com * @Date: 2022-05-08 14:58:46 * @LastEditors: LinkLeong a624669980@163.com * @LastEditTime: 2022-05-09 13:42:26 * @FilePath: /CasaOS/pkg/utils/network_detection.go * @Description: * * Copyright (c) 2022 by LinkLeong a624669980@163.com, All Rights Reserved.
utils/encryption
* @Author: LinkLeong link@icewhale.com * @Date: 2022-06-14 14:33:25 * @LastEditors: LinkLeong * @LastEditTime: 2022-06-14 14:33:49 * @FilePath: /CasaOS/pkg/utils/encryption/md5_helper.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.com * @Date: 2022-06-14 14:33:25 * @LastEditors: LinkLeong * @LastEditTime: 2022-06-14 14:33:49 * @FilePath: /CasaOS/pkg/utils/encryption/md5_helper.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
utils/version
* @Author: LinkLeong link@icewhale.com * @Date: 2022-05-13 18:15:46 * @LastEditors: LinkLeong * @LastEditTime: 2022-07-21 15:27:53 * @FilePath: /CasaOS/pkg/utils/version/version.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.com * @Date: 2022-05-13 18:15:46 * @LastEditors: LinkLeong * @LastEditTime: 2022-07-21 15:27:53 * @FilePath: /CasaOS/pkg/utils/version/version.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.org * @Date: 2022-11-15 15:51:44 * @LastEditors: LinkLeong * @LastEditTime: 2022-11-15 15:55:16 * @FilePath: /CasaOS/route/init.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.org * @Date: 2022-11-15 15:51:44 * @LastEditors: LinkLeong * @LastEditTime: 2022-11-15 15:55:16 * @FilePath: /CasaOS/route/init.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
v1
* @Author: LinkLeong link@icewhale.com * @Date: 2022-07-26 11:08:48 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-17 18:25:42 * @FilePath: /CasaOS/route/v1/samba.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.com * @Date: 2022-07-26 11:08:48 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-17 18:25:42 * @FilePath: /CasaOS/route/v1/samba.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
v2
* @Author: LinkLeong link@icewhale.org * @Date: 2022-07-26 18:13:22 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-04 20:10:31 * @FilePath: /CasaOS/service/connections.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.org * @Date: 2022-07-26 18:13:22 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-04 20:10:31 * @FilePath: /CasaOS/service/connections.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
model
* @Author: LinkLeong link@icewhale.org * @Date: 2022-07-26 17:17:57 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-01 17:08:08 * @FilePath: /CasaOS/service/model/o_connections.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.
* @Author: LinkLeong link@icewhale.org * @Date: 2022-07-26 17:17:57 * @LastEditors: LinkLeong * @LastEditTime: 2022-08-01 17:08:08 * @FilePath: /CasaOS/service/model/o_connections.go * @Description: * @Website: https://www.casaos.io * Copyright (c) 2022 by icewhale, All Rights Reserved.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL