Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.

Latest commit

 

History

History
111 lines (69 loc) · 6.57 KB

README.md

File metadata and controls

111 lines (69 loc) · 6.57 KB
Raw

Umbrel OS

Version Automated builds Community Chat Developer Chat

Twitter Reddit

☂️ OS

Umbrel OS is the operating system of Umbrel Bitcoin and Lightning node. It's based on Raspberry Pi OS (formerly Raspbian) and uses pi-gen for customization.

🚀 Getting started

To run Umbrel on:

Instructions:

  1. Make sure you've everything ready:

    1. Raspberry Pi 4 with 4GB or 8GB RAM
    2. 1TB SSD
    3. SSD Enclosure
    4. 16GB+ microSD Card
    5. microSD Card Reader
    6. Ethernet Cable
    7. Case

  2. Download the latest release of Umbrel OS, or build the image from source.

  3. Use an image flasher such as Balena 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.

If you're running Umbrel OS on Bitcoin mainnet (default), the external SSD or HDD should be at least 750 GB in size (we recommend 1 TB+) so it can store the whole Bitcoin blockchain.

💻 SSH

SSH is enabled by default and you can use the following credentials to login to your Umbrel node.

  • Hostname: umbrel.local
  • User: umbrel
  • Password: The same password you use to log in to the Umbrel dashboard

If you haven't yet run through the setup process, the password will be set to moneyprintergobrrr.

🛠 Build Umbrel OS from source

Don't trust. Verify.

Step 1. Clone this repo

git clone https://github.com/getumbrel/umbrel-os.git

Step 2. Switch to repo's directory

cd umbrel-os

Step 3. BUIDL!

sudo ./build.sh

After the build completes (it can take a looooooong time), the image will be inside deploy/ directory.

🔧 Advanced

Config variables

The config file has system defaults which are used when building the image and for automated builds.

  • UMBREL_VERSION - To install the specific Umbrel version.

  • 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 which is still applicable.

⚡️ Don't be too reckless

Umbrel is still in an early stage and things are expected to break every now and then. We DO NOT recommend running it on mainnet with real money just yet, unless you want to be really #reckless.

❤️ 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.

"Being open source means anyone can independently review the code. If it was closed source, nobody could verify the security. I think it's essential for a program of this nature to be open source." — Satoshi Nakamoto

License

getumbrel.com