Skip to content

A beautiful personal server OS for self-hosting. Install on a Raspberry Pi 4 or Ubuntu/Debian.

License

Notifications You must be signed in to change notification settings

bitshareslabs/umbrel

Repository files navigation

Umbrel

Version Community Chat Developer Chat

Twitter Reddit

☂️ Umbrel — A beautiful personal server OS for self-hosting

⚠️ Umbrel is currently in beta and is not considered secure. Please see SECURITY.md for more details.

Run a personal server in your home, self-host open source apps like Nextcloud and Bitcoin node, break away from big tech, and take full control of your data. For free.

🚀 Getting started

The easiest way to get started is running Umbrel OS on a Raspberry Pi. We reccomend a Pi with atleast 8GB RAM. [Learn More]

Alternatively you can install Umbrel on an Ubuntu or Debian based system with:

curl -L https://umbrel.sh | bash

⚡️ Don't be too reckless

Umbrel is still in beta development and should not be considered secure. Read our writeup of security tradeoffs that exist today.

It's recommended that you note down your 24 secret words (seed phrase) with a pen and paper, and secure it safely. If you forget your dashboard's password, or in case something goes wrong with your Umbrel, you will need these 24 words to recover your funds in the Bitcoin wallet of your Umbrel.

You're also recommended to download a backup of your payment channels regularly as it'll be required to recover your funds in the Lightning wallet of your Umbrel in case something goes wrong. You should also always download the latest backup file before installing an update.

❤️ Contributing

We welcome and appreciate new contributions.

If you're a developer looking to help but not sure where to begin, check out these issues that have specifically been marked as being friendly to new contributors.

If you're looking for a bigger challenge, before opening a pull request please create an issue or join our community chat to get feedback, discuss the best way to tackle the challenge, and to ensure that there's no duplication of work.

📜 License

Umbrel is licensed under the PolyForm Noncommercial 1.0.0 license. TL;DR — You're free to use, fork, modify, and redestribute Umbrel for personal and nonprofit use under the same license. If you're interested in using Umbrel for commercial purposes, such as selling plug-and-play home servers with Umbrel, etc — please reach out to us at [email protected].

License

umbrel.com

About

A beautiful personal server OS for self-hosting. Install on a Raspberry Pi 4 or Ubuntu/Debian.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 74.2%
  • HTML 14.2%
  • Python 7.9%
  • JavaScript 2.0%
  • CSS 1.7%