Awesome
<p align="center"> <a href="https://umbrel.com"> <img src="https://i.imgur.com/b8IeGru.jpeg" alt="Logo"> </a> <h1 align="center">umbrelOS</h1> <p align="center"> A beautiful home server OS for self-hosting <br /> <a href="https://umbrel.com"><strong>umbrel.com »</strong></a> <br /> <br /> <br /> Pre order an <a href="https://umbrel.com">Umbrel Home</a> or install on: <br /> <a href="https://umbrel.com/#start">Raspberry Pi</a> · <a href="#installing-umbrel">Ubuntu</a> · <a href="#installing-umbrel">Debian</a> <br /> <br /> <a href="https://twitter.com/umbrel"> <img src="https://img.shields.io/twitter/follow/umbrel?style=social" /> </a> <a href="https://t.me/getumbrel"> <img src="https://img.shields.io/badge/community-chat-%235351FB"> </a> <a href="https://reddit.com/r/getumbrel"> <img src="https://img.shields.io/reddit/subreddit-subscribers/getumbrel?style=social"> </a> <a href="https://community.getumbrel.com"> <img src="https://img.shields.io/badge/community-forum-%235351FB"> </a> </p> </p> <br /> <br /> <p align="center"> 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. </p> <p align="center"> 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. </p> <p align="center"> Just like the cloud, but one that you own and control. </p> <br /> <br />Installing umbrelOS
umbrelOS is currently in beta and should not be considered secure. See SECURITY.md for more details.
The easiest way to get started on a custom (non Umbrel Home) system is by running umbrelOS for Raspberry Pi 4. Step-by-step installation intructions can be found here.
Alternatively you can install umbrelOS on any Ubuntu or Debian system (both x86 and arm64) with:
curl -L https://umbrel.sh | bash
Umbrel App Store
<br />Here are some of the apps available in the Umbrel App Store. For the complete list of apps, visit apps.umbrel.com.
Bitcoin & Finance
- Bitcoin Node — Run your personal node powered by Bitcoin Core
- Electrs — A simple and efficient Electrum Server
- Mempool — A self-hosted explorer for the Bitcoin community
- Bitfeed — A beautiful mempool visualizer and block explorer
- BTCPay Server — Accept Bitcoin payments with zero fees & no 3rd party
- RoboSats — Simple and Private Bitcoin P2P Exchange
- Jam — Your sats. Your privacy. Your profit.
- Samourai Server — Your private backing server for Samourai Wallet
- Lightning Node — Run your personal Lightning Network node
- Core Lightning — Run your personal Core Lightning node
- Lightning Terminal — The easiest way to manage channel liquidity
- LNBits — Multi-user wallet management system
- Ride The Lightning — A powerful dashboard for the Lightning Network
- ThunderHub — Take full control of your Lightning node
- Invoice Ninja - We'll help with the invoicing
Files & Productivity
- Calibre Web — A clean web app for your eBooks
- Nextcloud — Productivity platform that keeps you in control
- Immich - High performance photo and video backup solution
- PhotoPrism — Self-host your photo and video library
- SyncThing — Peer-to-peer file synchronization between your devices
- Vaultwarden — Unofficial Bitwarden® compatible server
Media
- Jellyfin — The Free Software Media System
- Lidarr — Looks and smells like Sonarr but made for music
- Plex — Stream Movies & TV Shows
- Prowlarr — Indexer manager/proxy for Sonarr, Radarr, and Lidarr
- Radarr — Your movie collection manager
- Sonarr — Smart PVR for newsgroup and bittorrent users
Networking
- Pi-hole — Block ads on your entire network
- Tailscale — Zero config VPN to access your Umbrel from anywhere
- Transmission — A fast, easy and free BitTorrent client
- Uptime Kuma — Self-hosted uptime monitoring tool
- Urbit — Run Urbit on your Umbrel
- Whoogle Search — A self-hosted, ad-free, privacy-respecting metasearch engine
Social
- Element — A glossy Matrix client compatible with Synapse
- Invidious — Browse YouTube without tracking or ads
- LibReddit — An alternative private front-end to Reddit
- Nitter — Browse Twitter without tracking or ads
- Nostr Relay - Backup all your Nostr activity with your private relay
- Synapse — Matrix reference homeserver
Automation
- Home Assistant — Home automation that puts local control & privacy first
- n8n - Build complex workflows, really fast
- Node-RED — Wire together the Internet of Things
Developer Tools
- Code Server — Run VS Code on your Umbrel
- Gitea — A painless self-hosted Git service
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 umbrelOS
If you're interested in building an app for umbrelOS or packaging an existing one, please refer to the Umbrel App Framework documentation.
Setting up a development environment
With the release of umbrelOS 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
umbrelOS is licensed under the PolyForm Noncommercial 1.0.0 license. TL;DR — You're free to use, fork, modify, and redistribute Umbrel for personal and nonprofit use under the same license. If you're interested in using umbrelOS for commercial purposes, such as selling plug-and-play home servers with umbrelOS, etc — please reach out to us at partner@umbrel.com.
