{"id":13406958,"url":"https://github.com/getumbrel/umbrel-dashboard","last_synced_at":"2025-03-14T11:30:57.715Z","repository":{"id":39709166,"uuid":"236140354","full_name":"getumbrel/umbrel-dashboard","owner":"getumbrel","description":"[Deprecated] Moved to https://github.com/getumbrel/umbrel/tree/master/packages/dashboard. Web-based dashboard to interact with your Umbrel.","archived":true,"fork":false,"pushed_at":"2023-03-31T19:10:51.000Z","size":15923,"stargazers_count":134,"open_issues_count":92,"forks_count":66,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-10T06:11:32.713Z","etag":null,"topics":["bitcoin","bitcoin-node","full-node","lightning","lightning-network","lightning-node","lnd","umbrel","vuejs"],"latest_commit_sha":null,"homepage":"https://github.com/getumbrel/umbrel/tree/master/packages/dashboard","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getumbrel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-01-25T07:41:42.000Z","updated_at":"2025-03-07T17:30:55.000Z","dependencies_parsed_at":"2024-01-18T23:05:43.704Z","dependency_job_id":"c2277862-82a2-450d-8b7d-32769b5dc7f2","html_url":"https://github.com/getumbrel/umbrel-dashboard","commit_stats":null,"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getumbrel%2Fumbrel-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getumbrel%2Fumbrel-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getumbrel%2Fumbrel-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getumbrel%2Fumbrel-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getumbrel","download_url":"https://codeload.github.com/getumbrel/umbrel-dashboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243569238,"owners_count":20312373,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","bitcoin-node","full-node","lightning","lightning-network","lightning-node","lnd","umbrel","vuejs"],"created_at":"2024-07-30T19:02:44.139Z","updated_at":"2025-03-14T11:30:52.704Z","avatar_url":"https://github.com/getumbrel.png","language":"Vue","funding_links":[],"categories":["Vue"],"sub_categories":[],"readme":"[![Umbrel Dashboard](https://static.getumbrel.com/github/github-banner-umbrel-dashboard.svg)](https://github.com/getumbrel/umbrel-dashboard)\n\n[![Version](https://img.shields.io/github/v/release/getumbrel/umbrel-dashboard?color=%235351FB\u0026label=version)](https://github.com/getumbrel/umbrel-dashboard/releases)\n[![Docker Build](https://img.shields.io/github/workflow/status/getumbrel/umbrel-dashboard/Docker%20build%20on%20push?color=%235351FB)](https://github.com/getumbrel/umbrel-dashboard/actions?query=workflow%3A\"Docker+build+on+push\")\n[![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)\n[![Community Chat](https://img.shields.io/badge/community%20chat-telegram-%235351FB)](https://t.me/getumbrel)\n[![Developer Chat](https://img.shields.io/badge/dev%20chat-keybase-%235351FB)](https://keybase.io/team/getumbrel)\n\n[![Twitter](https://img.shields.io/twitter/follow/getumbrel?style=social)](https://twitter.com/getumbrel)\n[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/getumbrel?label=Subscribe%20%2Fr%2Fgetumbrel\u0026style=social)](https://reddit.com/r/getumbrel)\n\n\n# ☂️ dashboard\n\nDashboard 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.\n\n## 🚀 Getting started\n\nIf 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.\n\n## 🛠 Running dashboard\n\nMake 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`.\n\n### Step 1. Install dependencies\n```sh\nyarn\n```\n\n### Step 2. Set environment variables\nThe following environment variables are set in `.env` file of the project's root:\n\n| Variable | Description | Default |\n| ------------- | ------------- | ------------- |\n| `VUE_APP_MANAGER_API_URL` | URL of [`umbrel-manager`](https://github.com/getumbrel/umbrel-manager) API | `http://localhost:3006` |\n\nIf you want to change the local development environment (e.g. to use your local Umbrel instance), create the `.env.development` with the following content:\n\n```sh\nVUE_APP_MANAGER_API_URL=http://umbrel.local/manager-api\n```\n\n### Step 3. Run dashboard\n```sh\nyarn serve\n```\n\nDashboard should now be accessible at `http://localhost:8080`.\n\n\u003e 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).\n\n## Building dashboard\nTo build dashboard for production, run:\n```sh\nyarn build\n```\nBuilt code will be inside `/dist`.\n\n---\n\n### ⚡️ Don't be too reckless\n\n\u003e 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*.\n\n## ❤️ Contributing\n\nWe welcome and appreciate new contributions!\n\nIf 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.\n\nIf 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.\n\n## 📜 License\n\nUmbrel (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 partner@getumbrel.com.\n\n[![License](https://img.shields.io/badge/license-PolyForm%20Noncommercial%201.0.0-%235351FB)](https://github.com/getumbrel/umbrel/blob/master/LICENSE.md)\n\n[getumbrel.com](https://getumbrel.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetumbrel%2Fumbrel-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetumbrel%2Fumbrel-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetumbrel%2Fumbrel-dashboard/lists"}