Umbrel

A beautiful personal server OS for self-hosting
umbrel.com »

Install on
Raspberry Pi · Ubuntu · Debian

At Umbrel, we believe that everyone should be able to enjoy the convenience and benefits of the cloud, without giving up ownership and control of their data.

To achieve our vision, we're building a new kind of personal server OS. Instead of paying ransoms for storing your data on someone else's computer while they auction it off to advertisers — you can now easily spin up a server and self-host your data and services at home.

Just like the cloud, but one that you own and control.

umbrel.mp4

Installing Umbrel

Umbrel is currently in beta and should not be considered secure. See SECURITY.md for more details.

The easiest way to get started is by running Umbrel OS on a Raspberry Pi 4. Step-by-step installation intructions can be found here.

Alternatively you can install Umbrel on any Ubuntu or Debian system (both x86 and arm64) with:

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

Umbrel App Store

umbrel-app-store.mp4

Here are some of the apps available in the Umbrel App Store. For the complete list of apps, please see the umbrel-apps repository.

Bitcoin Node — Run your personal node powered by Bitcoin Core
Bitfeed — A beautiful mempool visualizer and block explorer
BTCPay Server — Accept Bitcoin payments with zero fees & no 3rd party
Calibre Web — A clean web app for your eBooks
Code Server — Run VS Code on your Umbrel
Core LN — Run your personal Core Lightning node
Electrs — A simple and efficient Electrum Server
Element — A glossy Matrix client compatible with Synapse
Gitea — A painless self-hosted Git service
Home Assistant — Home automation that puts local control & privacy first
Invidious — Browse YouTube without tracking or ads
Jam — Your sats. Your privacy. Your profit.
Jellyfin — The Free Software Media System
LibReddit — An alternative private front-end to Reddit
Lidarr — Looks and smells like Sonarr but made for music
Lightning Node — Run your personal Lightning Network node
Lightning Terminal — The easiest way to manage channel liquidity
LNBits — Multi-user wallet management system
Mempool — A self-hosted explorer for the Bitcoin community
Nextcloud — Productivity platform that keeps you in control
Nitter — Browse Twitter without tracking or ads
Node-RED — Wire together the Internet of Things
PhotoPrism — Self-host your photo and video library
Pi-hole — Block ads on your entire network
Plex — Stream Movies & TV Shows
Prowlarr — Indexer manager/proxy for Sonarr, Radarr, and Lidarr
Radarr — Your movie collection manager
Ride The Lightning — A powerful dashboard for the Lightning Network
RoboSats — Simple and Private Bitcoin P2P Exchange
Samourai Server — Your private backing server for Samourai Wallet
Sonarr — Smart PVR for newsgroup and bittorrent users
Synapse — Matrix reference homeserver
SyncThing — Peer-to-peer file synchronization between your devices
Tailscale — Zero config VPN to access your Umbrel from anywhere
ThunderHub — Take full control of your Lightning node
Transmission — A fast, easy and free BitTorrent client
Uptime Kuma — Self-hosted uptime monitoring tool
Urbit — Run Urbit on your Umbrel
Vaultwarden — Unofficial Bitwarden® compatible server
Whoogle Search — A self-hosted, ad-free, privacy-respecting metasearch engine

If an app you're looking for isn't available on our app store yet, feel free to open an issue on the umbrel-apps respository to request it.

Building apps for Umbrel

If you're interested in building an Umbrel app or packaging an existing one, please refer to the Umbrel App Framework documentation.

Setting up a development environment

With the release of Umbrel 0.5, a lot of the underlying architecture of the project has changed. This section will be re-written with up-to-date development instructions.

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 partner@umbrel.com.

umbrel.com

Asone/umbrel