Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getumbrel/umbrel-dashboard
[Deprecated] Moved to https://github.com/getumbrel/umbrel/tree/master/packages/dashboard. Web-based dashboard to interact with your Umbrel.
https://github.com/getumbrel/umbrel-dashboard
bitcoin bitcoin-node full-node lightning lightning-network lightning-node lnd umbrel vuejs
Last synced: 9 days ago
JSON representation
[Deprecated] Moved to https://github.com/getumbrel/umbrel/tree/master/packages/dashboard. Web-based dashboard to interact with your Umbrel.
- Host: GitHub
- URL: https://github.com/getumbrel/umbrel-dashboard
- Owner: getumbrel
- License: other
- Archived: true
- Created: 2020-01-25T07:41:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-31T19:10:51.000Z (over 1 year ago)
- Last Synced: 2024-07-31T19:55:17.666Z (3 months ago)
- Topics: bitcoin, bitcoin-node, full-node, lightning, lightning-network, lightning-node, lnd, umbrel, vuejs
- Language: Vue
- Homepage: https://github.com/getumbrel/umbrel/tree/master/packages/dashboard
- Size: 15.2 MB
- Stars: 132
- Watchers: 11
- Forks: 69
- Open Issues: 92
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/getumbrel/umbrel-dashboard)
[](https://github.com/getumbrel/umbrel-dashboard/releases)
[](https://github.com/getumbrel/umbrel-dashboard/actions?query=workflow%3A"Docker+build+on+push")
[](https://hub.docker.com/repository/registry-1.docker.io/getumbrel/dashboard/tags?page=1)
[](https://t.me/getumbrel)
[](https://keybase.io/team/getumbrel)
[](https://twitter.com/getumbrel)
[](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
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 [`umbrel-manager`](https://github.com/getumbrel/umbrel-manager) is running and available. Alternatively, if you have an Umbrel running already and you only want to make changes to the dashboard, you can connect to it directly without running `umbrel-manager`.
### Step 1. Install dependencies
```sh
yarn
```
### Step 2. Set environment variables
The following environment variables are set in `.env` file of the project's root:
| Variable | Description | Default |
| ------------- | ------------- | ------------- |
| `VUE_APP_MANAGER_API_URL` | URL of [`umbrel-manager`](https://github.com/getumbrel/umbrel-manager) API | `http://localhost:3006` |
If you want to change the local development environment (e.g. to use your local Umbrel instance), create the `.env.development` with the following content:
```sh
VUE_APP_MANAGER_API_URL=http://umbrel.local/manager-api
```
### Step 3. Run dashboard
```sh
yarn serve
```
Dashboard should now be accessible at `http://localhost:8080`.
> If your local dashboard can't get past loading in the web browser, you will need to install a CORS unblocking extension in your browser to make it work. For example, [here's one for Chrome](https://chrome.google.com/webstore/detail/cors-unblock/lfhmikememgdcahcdlaciloancbhjino?hl=en).
## Building dashboard
To build dashboard for production, run:
```sh
yarn build
```
Built code will be inside `/dist`.
---
### ⚡️ 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
Umbrel (and Umbrel Dashboard) is licensed under the PolyForm Noncommercial 1.0.0 license. TL;DR — You're free to use, fork, modify, and redestribute Umbrel for personal and nonprofit use under the same license. If you're interested to use Umbrel for commercial purposes, such as selling plug-and-play home servers with Umbrel, etc — please reach out to us at [email protected].
[](https://github.com/getumbrel/umbrel/blob/master/LICENSE.md)
[getumbrel.com](https://getumbrel.com)