umbrel README

The project's README from github.com/getumbrel/umbrel. As one markdown file: README.md.

umbrelOS

umbrelOS

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

Get an Umbrel Pro or Umbrel Home, or download umbrelOS for free on an Intel or AMD machine, Raspberry Pi 5, or a virtual machine.


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 a home server OS. Just like the cloud, but one that you own and control.


umbrelOS 2.0

bento 2 0

umbrelOS 2.0 is currently in beta, with the stable release planned for September 22, 2026. Try it out today:

Installing umbrelOS

umbrelOS is free and complete on any hardware. The image you install on your own device is the same umbrelOS that ships on Umbrel Home and Umbrel Pro, with the same features and the same updates.

Supported devices

A few features depend on your hardware. Storage Manager and FailSafe need two or more internal NVMe or SATA drives, and GPU acceleration needs an NVIDIA, AMD, or Intel GPU on an Intel or AMD machine.

Download and install

Head to umbrel.com/downloads for the latest umbrelOS ISO and images, along with step-by-step installation guides for each platform.

[!NOTE] umbrelOS is a standalone operating system that installs directly onto your device. It can't be installed on top of an existing Linux distribution.

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.

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 [email protected].

License

umbrel.com

umbrel (getumbrel/umbrel)

Searching Database…

12.4K ·GitHub
What is this?Umbrel (umbrelOS) is a free, beautiful home server operating system for self-hosting. It lets you run apps like OpenClaw, store your own files, and install over 300 apps from the Umbrel App Store on your own hardware.
Is this an app I install on an existing Linux box, or a full OS?umbrelOS is a standalone operating system that installs directly onto your device, not something you layer on top of an existing Linux distro. The apps inside it run as individually packaged services managed through the Umbrel App Store.
How do I get umbrelOS running?Download the ISO or device image from umbrel.com/downloads and flash/install it directly onto your target hardware (mini PC, Raspberry Pi 5, or VM); the site has step-by-step guides per platform.
What hardware do I need to run it?Any 64-bit Intel/AMD mini PC, laptop, desktop, NAS, or server with a dual-core CPU, at least 4 GB RAM (8 GB+ recommended) and a 32 GB drive, or a Raspberry Pi 5 booting from NVMe/USB, or a VM (Proxmox, VirtualBox, VMware, etc.) with EFI boot support.
Are there any hardware caveats to watch out for?Some features are hardware-gated: Storage Manager and FailSafe require two or more internal NVMe/SATA drives, GPU acceleration needs an NVIDIA, AMD, or Intel GPU, and the Raspberry Pi 5 must boot from NVMe or USB rather than a microSD card.
Can I run it on a Raspberry Pi or only on PC hardware?Both — umbrelOS supports Intel/AMD 64-bit machines (mini PCs, laptops, NAS boxes, servers), the Raspberry Pi 5, and virtual machines like Proxmox, VirtualBox, or VMware.
Does my data stay on my own hardware?Yes, the whole point is cloud-like convenience without giving up ownership and control of your data — everything runs on the device you own.
Is Umbrel really free, including for reselling?umbrelOS is free for personal and nonprofit use under the PolyForm Noncommercial 1.0.0 license, letting you use, fork, modify, and redistribute it; commercial use (e.g. selling pre-loaded servers) requires contacting Umbrel directly.
What is umbrelOS 2.0 and is it stable yet?umbrelOS 2.0 is currently in beta, with the stable release planned for September 22, 2026; it can be tried now via a fresh install or by enabling the beta program from an existing umbrelOS 1.7.4+ install.
Can I build my own app for the Umbrel App Store?Yes, developers can package new or existing apps for umbrelOS by following the Umbrel App Framework documentation.
What can I actually run on it besides file storage?Over 300 apps are available in the Umbrel App Store, including OpenClaw, with built-in support for Bitcoin and Lightning-related apps as well.
Creator
getumbrel
Size
136.7 MB
Stars
12.4K
Age
6y
Commits · 90 Days