Skip to content

getumbrel/umbrel

master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.

Logo

Umbrel

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


Install on
Raspberry Pi · Ubuntu · Debian

Installing Umbrel

Umbrel is currently in beta and not considered secure. Please 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 based system with:

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

Setting up a development environment

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

Building apps for Umbrel

If you're interested in packaging or building Umbrel apps, please refer to our documentation here.

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.

License

umbrel.com