Browse Source

Move installation instructions to the top (#173)

update-git
Mayank Chhabra 4 years ago
committed by GitHub
parent
commit
1067ef3e0b
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 80
      README.md

80
README.md

@ -23,6 +23,45 @@ If you're looking to run Umbrel on:
- A Raspberry Pi 3 or 4 (recommended) - [Download Umbrel OS](https://github.com/getumbrel/umbrel-os)
- Anything else (experimental) - [Install Umbrel](#-installation)
## 🛠 Installation
### Requirements
- [Docker](https://docs.docker.com/engine/install)
- [Python 3.0+](https://www.python.org/downloads)
- [Docker Compose](https://docs.docker.com/compose/install)
- [fswatch](https://emcrisostomo.github.io/fswatch/) (`apt-get install fswatch`)
- [jq](https://stedolan.github.io/jq/) (`apt-get install jq`)
Ensure that your account is [correctly permissioned to use docker](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user).
### Step 1. Download
> Run this in an empty directory where you want to install Umbrel
```bash
curl -L https://github.com/getumbrel/umbrel/archive/v0.2.3.tar.gz | tar -xz --strip-components=1
```
### Step 2. Run
```bash
# To use Umbrel on mainnet, run:
sudo ./scripts/start
# For testnet, run:
sudo NETWORK=testnet ./scripts/start
# For regtest, run:
sudo NETWORK=regtest ./scripts/start
```
To stop Umbrel, run:
```bash
sudo ./scripts/stop
```
## 🎹 Services orchestrated
- [`Umbrel Dashboard`](https://github.com/getumbrel/umbrel-dashboard)
@ -32,7 +71,7 @@ If you're looking to run Umbrel on:
- [`LND`](https://github.com/getumbrel/docker-lnd)
- [`Tor`](https://github.com/getumbrel/docker-tor)
- [`Nginx`](https://github.com/nginx/nginx)
- [`LND Neutrino Switch`](https://github.com/lncm/docker-lnd-neutrino-switch)
- [`Neutrino Switcher`](https://github.com/lncm/docker-lnd-neutrino-switch)
**Architecture**
@ -64,45 +103,6 @@ If you're looking to run Umbrel on:
+ ------------- + + ------------- +
```
## 🛠 Installation
### Requirements
- [Docker](https://docs.docker.com/engine/install)
- [Python 3.0+](https://www.python.org/downloads)
- [Docker Compose](https://docs.docker.com/compose/install)
- [fswatch](https://emcrisostomo.github.io/fswatch/) (`apt-get install fswatch`)
- [jq](https://stedolan.github.io/jq/) (`apt-get install jq`)
Ensure that your account is [correctly permissioned to use docker](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user).
### Step 1. Download
> Run this in an empty directory where you want to install Umbrel
```bash
curl -L https://github.com/getumbrel/umbrel/archive/v0.2.3.tar.gz | tar -xz --strip-components=1
```
### Step 2. Run
```bash
# To use Umbrel on mainnet, run:
sudo ./scripts/start
# For testnet, run:
sudo NETWORK=testnet ./scripts/start
# For regtest, run:
sudo NETWORK=regtest ./scripts/start
```
To stop Umbrel, run:
```bash
sudo ./scripts/stop
```
---
## ⚡️ Don't be too reckless

Loading…
Cancel
Save