@ -17,16 +17,25 @@ Umbrel OS is the operating system of Umbrel Bitcoin and Lightning node. It's bas
To run Umbrel on:
- Raspberry Pi 4 (most recommended) — [Download the latest Umbrel OS](https://github.com/getumbrel/umbrel-os/releases/latest)
- Raspberry Pi 3 - [Download Umbrel OS v0.2.10](https://github.com/getumbrel/umbrel-os/releases/tag/v0.2.10)
- Raspberry Pi 4 (recommended) — [Download the latest Umbrel OS](https://github.com/getumbrel/umbrel-os/releases/latest)
- Raspberry Pi 3 (no longer supported) - [Download Umbrel OS v0.2.10](https://github.com/getumbrel/umbrel-os/releases/tag/v0.2.10)
- Any other hardware - [Manually install Umbrel](https://github.com/getumbrel/umbrel#-installation)
### Instructions:
1. Download the [latest release of Umbrel OS](https://github.com/getumbrel/umbrel-os/releases/latest), or [build the image from source](#-build-umbrel-os-from-source).
2. Use an image flasher such as [Balena Etcher](https://github.com/balena-io/etcher) to flash the image to a microSD card.
3. Put the microSD card in your Raspberry Pi, attach an external SSD or HDD (to USB 3 port), connect the Pi to your router with an ethernet cable.
4. Turn on the Pi and open http://umbrel.local from any device connected to the same network (it might take a while for it to be accessible).
1. Make sure you've everything ready:
1. [Raspberry Pi 4 with 4GB or 8GB RAM](https://www.amazon.com/gp/product/B08C4SK5C3/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=B08C4SK5C3&linkCode=as2&tag=umbrel08-20&linkId=d3f17fd4813568c4863d239839311d67)
2. Download the [latest release of Umbrel OS](https://github.com/getumbrel/umbrel-os/releases/latest), or [build the image from source](#-build-umbrel-os-from-source).
3. Use an image flasher such as [Balena Etcher](https://github.com/balena-io/etcher) to flash the image to a microSD card.
4. Put the microSD card in your Raspberry Pi, attach an external SSD or HDD (to USB 3 port), connect the Pi to your router with an ethernet cable.
5. Turn on the Pi and open http://umbrel.local from any device connected to the same network (it might take a while for it to be accessible).
**⚠️ All data on the external hard drive will be erased on first boot.**
@ -71,6 +80,10 @@ The `config` file has system defaults which are used when building the image and
- `GITHUB_USERNAME` - To automatically login to your Umbrel without typing a password.
- `UMBREL_REPO` - A custom git repo used to download Umbrel. `UMBREL_VERSION` is ignored if this is set, but it is required to also set `UMBREL_BRANCH`.
- `UMBREL_BRANCH` - The git branch or commit SHA in the custom repo that should be checked out.
Other Raspbian-related stuff can be found in [Raspbian's documentation](https://github.com/RPi-Distro/pi-gen/blob/master/README.md) which is still applicable.