Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated README.md #1789

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Updated README.md #1789

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4b028f3
Removed nested <p> tags in README.md
highghlow Apr 9, 2024
64a9717
Unified <img> tags in README.md
highghlow Apr 9, 2024
6bc5ed5
Updated Debian installation info in README.md
highghlow Apr 9, 2024
30a04f7
Added installation links in Debian support note
highghlow Apr 9, 2024
d4c94ba
Fixed [!note] in README.md
highghlow Apr 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[![umbrelOS](https://github.com/getumbrel/umbrel/assets/10330103/56be7b95-0c24-4dee-ad3a-e5947bc2ee07)](https://umbrel.com/umbrelos)

<h1 align="center">umbrelOS</h1>
<p align="center">
<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>
Expand All @@ -14,24 +13,24 @@
·
<a href="https://umbrel.com/umbrelos#install">Raspberry Pi 5</a>
·
<a href="#installing-umbrel">Debian</a>
<a href="#Installing-on-Debian">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">
<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">
<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">
<img src="https://img.shields.io/badge/community-forum-%235351FB" />
</a>
</p>
</p>


<br />

[![Watch the umbrelOS 1.0 reveal](https://github.com/getumbrel/umbrel/assets/10330103/0b99b2b5-f090-464d-a865-a2eddb8d85c9)](https://www.youtube.com/watch?v=Q-vmmboobEM)
Expand All @@ -58,7 +57,15 @@ Just like the cloud, but one that you own and control.

The easiest way to get started on a custom (non Umbrel Home) system is by running [umbrelOS for Raspberry Pi 5](https://download.umbrel.com/release/1.0.0/umbrelos-pi5.img.zip) or [Raspberry Pi 4](https://download.umbrel.com/release/1.0.0/umbrelos-pi4.img.zip). Step-by-step installation instructions can be found [here](https://umbrel.com/umbrelos#install).

Support for devices other than Raspberry Pi 4, Pi 5, and the Umbrel Home is arriving in April 2024.
### Installing on Debian
To install Umbrel on a Debian-based system, run:

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

> [!note]
> Currently only UmbrelOS 0.5 is supported on Debian-based systems (1.0 coming this month). To use Umbrel 1.0 buy an [Umbrel Home](https://umbrel.com/umbrel-home) or use a [Raspberry PI](https://umbrel.com/umbrelos#install).

## Umbrel App Store

Expand Down