explaingit

getumbrel/umbrel

★ 11,243TypeScriptAudience · generalComplexity · 3/5LicenseSetup · easy

TLDR

A personal home server operating system for Raspberry Pi or Ubuntu/Debian PCs that gives you a dashboard to manage files, photos, and 300+ self-hosted apps, from Bitcoin nodes to media servers, so your data stays on your own hardware.

Mindmap

mindmap
  root((umbrelOS))
    What it does
      Personal server
      App store
      Data privacy
    App categories
      Bitcoin and finance
      Files and photos
      Media streaming
      Networking tools
    Hardware
      Raspberry Pi 4
      Ubuntu Debian PC
      Umbrel Home device
    Audience
      Privacy-focused users
      Self-hosters
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Install on a Raspberry Pi 4 to run Nextcloud, Immich, and Jellyfin as replacements for Google Drive, Google Photos, and streaming subscriptions.

USE CASE 2

Run a Bitcoin full node and Lightning Network node from your home network using apps from the built-in app store.

USE CASE 3

Block ads across your entire home network by installing the Pi-hole app on your Umbrel server.

USE CASE 4

Access your home server securely from anywhere without opening firewall ports by installing the built-in Tailscale app.

Tech stack

TypeScriptDocker

Getting it running

Difficulty · easy Time to first run · 30min

Install with a single terminal command on Raspberry Pi 4 or Ubuntu/Debian, software is currently in beta and not fully hardened for security.

Open-source software, free to use, modify, and contribute to under the terms in the repository.

In plain English

umbrelOS is an operating system designed to run on home hardware, such as a Raspberry Pi or a standard PC running Ubuntu or Debian. It gives you a personal server that behaves like cloud storage and services, except that you own and control the hardware. The project is built on the idea that your data should stay with you, not on a third-party company's computers. Once installed, you get a dashboard where you can manage files, photos, and a collection of over 300 optional apps through the Umbrel App Store. The app store is organized into categories: Bitcoin and finance tools, files and productivity apps, media servers, networking utilities, social platforms, home automation, and developer tools. Apps run in isolated containers, so adding or removing one does not affect the rest of the system. Some of the available apps are well-known open-source projects. In the Bitcoin category, you can run a full Bitcoin node or a Lightning Network node directly from your home network. In the files category, options include Nextcloud (a self-hosted alternative to Google Drive) and Immich (photo backup similar to Google Photos). Media options include Plex and Jellyfin for streaming video. Networking apps include Pi-hole for blocking ads across your whole network and Tailscale for accessing your server remotely without exposing it directly to the internet. umbrelOS can be installed on a Raspberry Pi 4, or on any Ubuntu or Debian machine, by running a single command in a terminal. There is also a dedicated hardware device called the Umbrel Home for those who want a pre-configured unit. The project notes that the software is currently in beta and should not be treated as fully secure. The codebase is written primarily in TypeScript and is open to community contributions. The development environment documentation is noted as a work in progress following a recent architecture change.

Copy-paste prompts

Prompt 1
Help me install umbrelOS on a Raspberry Pi 4 and set up Nextcloud so I can replace Google Drive with my own self-hosted file storage.
Prompt 2
I want to run a Bitcoin full node on my Umbrel server. Walk me through installing the Bitcoin app from the Umbrel App Store and syncing the blockchain.
Prompt 3
Show me how to install Immich on Umbrel so my phone automatically backs up photos to my home server instead of iCloud or Google Photos.
Prompt 4
Help me set up Pi-hole on my Umbrel server and configure my home router to use it as a DNS server to block ads on every device.
Open on GitHub → Explain another repo

← getumbrel on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.