Mayank Chhabra
4 years ago
committed by
GitHub
1 changed files with 59 additions and 22 deletions
@ -1,32 +1,69 @@ |
|||
# Umbrel Dashboard UI |
|||
![live.getumbrel.com](https://github.com/getumbrel/umbrel-dashboard/workflows/live.getumbrel.com/badge.svg?branch=master) |
|||
[![Umbrel Dashboard](github-umbrel-dashboard.png)](https://github.com/getumbrel/umbrel-dashboard) |
|||
|
|||
## Install Dependencies |
|||
``` |
|||
yarn install |
|||
``` |
|||
[![Version](https://img.shields.io/github/v/release/getumbrel/umbrel-dashboard?color=%235351FB&label=version)](https://github.com/getumbrel/umbrel-dashboard/releases) |
|||
[![Docker Build](https://img.shields.io/github/workflow/status/getumbrel/umbrel-dashboard/Automatically%20Build%20image%20on%20tag?color=%235351FB)](https://github.com/getumbrel/umbrel-dashboard/actions?query=workflow%3A"Automatically+Build+image+on+tag") |
|||
[![Docker Pulls](https://img.shields.io/docker/pulls/getumbrel/dashboard?color=%235351FB)](https://hub.docker.com/repository/registry-1.docker.io/getumbrel/dashboard/tags?page=1) |
|||
[![Chat](https://img.shields.io/badge/chat%20on-telegram-%235351FB)](https://t.me/getumbrel) |
|||
|
|||
[![Twitter](https://img.shields.io/twitter/follow/getumbrel?style=social)](https://twitter.com/getumbrel) |
|||
[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/getumbrel?label=Subscribe%20%2Fr%2Fgetumbrel&style=social)](https://reddit.com/r/getumbrel) |
|||
|
|||
|
|||
# ☂️ dashboard |
|||
|
|||
Dashboard is the web-based user interface of [Umbrel OS](https://github.com/getumbrel/umbrel-os) and is accessible at `http://umbrel.local`. It runs by-default as a containerized service. |
|||
|
|||
## 🚀 Getting started |
|||
|
|||
## Run locally |
|||
1. Run |
|||
If you are looking to run Umbrel on your hardware, you do not need to run this service on it's own. Just download [Umbrel OS](https://github.com/getumbrel/umbrel-os/releases) and you're good to go. |
|||
|
|||
## 🛠 Running dashboard |
|||
|
|||
Make sure both [`umbrel-manager`](https://github.com/getumbrel/umbrel-manager) and [`umbrel-middleware`](https://github.com/lightningnetwork/lnd) are running and available. |
|||
|
|||
### Step 1. Install dependencies |
|||
```sh |
|||
yarn |
|||
``` |
|||
|
|||
### Step 2. Set environment variables |
|||
Set the following environment variables in `.env` file of the project's root. |
|||
|
|||
| Variable | Description | Default | |
|||
| ------------- | ------------- | ------------- | |
|||
| `VUE_APP_MANAGER_API_URL` | Root host+port of [`umbrel-manager`](https://github.com/getumbrel/umbrel-manager) API | `http://localhost:3006` | |
|||
| `VUE_APP_MIDDLEWARE_API_URL` | Root host+port [`umbrel-middleware`](https://github.com/getumbrel/umbrel-middleware) API | `http://localhost:3005` | |
|||
|
|||
### Step 3. Run dashboard |
|||
```sh |
|||
yarn serve |
|||
``` |
|||
2. Open http://localhost:8080/ |
|||
|
|||
## Deploy to a local Umbrel node |
|||
1. Run |
|||
``` |
|||
yarn deploy-local |
|||
``` |
|||
2. Enter SSH password of `umbrel` user |
|||
3. Open http://umbrel.local/ |
|||
Dashboard should now be accessible at `http://localhost:8080`. |
|||
|
|||
## Compile and minify for production |
|||
``` |
|||
## Building dashboard |
|||
To build dashboard for production, run: |
|||
```sh |
|||
yarn build |
|||
``` |
|||
Built code will be inside `/dist`. |
|||
|
|||
## Lint and fix files |
|||
``` |
|||
yarn lint |
|||
``` |
|||
--- |
|||
|
|||
### ⚡️ 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 the 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](https://github.com/getumbrel/umbrel-dashboard/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 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](https://github.com/getumbrel/umbrel-dashboard/issues/new/choose) or [join our community chat](https://t.me/getumbrel) to get feedback, discuss the best way to tackle the challenge, and to ensure that there's no duplication of work. |
|||
|
|||
--- |
|||
|
|||
[![License](https://img.shields.io/badge/license-CC%20BY--NC--ND%204.0-%235351FB)](https://github.com/getumbrel/umbrel-dashboard/blob/master/LICENSE.md) |
|||
|
|||
[getumbrel.com](https://getumbrel.com) |
|||
|
Loading…
Reference in new issue