{"id":13406975,"url":"https://github.com/Lissy93/dashy","last_synced_at":"2025-03-14T11:30:56.758Z","repository":{"id":36998343,"uuid":"343078060","full_name":"Lissy93/dashy","owner":"Lissy93","description":"🚀 A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!","archived":false,"fork":false,"pushed_at":"2024-10-06T01:29:18.000Z","size":718706,"stargazers_count":17156,"open_issues_count":96,"forks_count":1310,"subscribers_count":65,"default_branch":"master","last_synced_at":"2024-10-09T18:01:11.490Z","etag":null,"topics":["awesome","dashboard","docker","hacktoberfest","homelab","homepage","mit","nodejs","organization","productivity","pwa","self-hosted","startpage","vue"],"latest_commit_sha":null,"homepage":"https://dashy.to","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Lissy93.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"lissy93","custom":["https://notes.aliciasykes.com/tip"]}},"created_at":"2021-02-28T10:35:44.000Z","updated_at":"2024-10-09T17:38:27.000Z","dependencies_parsed_at":"2024-09-21T05:02:26.615Z","dependency_job_id":"116543dd-9afc-42c5-8e30-abcfde47b431","html_url":"https://github.com/Lissy93/dashy","commit_stats":null,"previous_names":[],"tags_count":47,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Fdashy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Fdashy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Fdashy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Fdashy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Lissy93","download_url":"https://codeload.github.com/Lissy93/dashy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243569211,"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":["awesome","dashboard","docker","hacktoberfest","homelab","homepage","mit","nodejs","organization","productivity","pwa","self-hosted","startpage","vue"],"created_at":"2024-07-30T19:02:44.632Z","updated_at":"2025-03-14T11:30:51.746Z","avatar_url":"https://github.com/Lissy93.png","language":"Vue","readme":"\n\u003ch1 align=\"center\"\u003eDashy\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003ci\u003eDashy helps you organize your self-hosted services by making them accessible from a single place\u003c/i\u003e\n   \u003cbr/\u003e\n  \u003cimg width=\"120\" src=\"https://i.ibb.co/yhbt6CY/dashy.png\" /\u003e\n  \u003cbr/\u003e\n  \u003cb\u003e\u003ca href=\"./docs/showcase.md\"\u003eUser Showcase\u003c/a\u003e\u003c/b\u003e | \u003cb\u003e\u003ca href=\"https://demo.dashy.to\"\u003eLive Demo\u003c/a\u003e\u003c/b\u003e | \u003cb\u003e\u003ca href=\"./docs/quick-start.md\"\u003eGetting Started\u003c/a\u003e\u003c/b\u003e | \u003cb\u003e\u003ca href=\"https://dashy.to/docs\"\u003eDocumentation\u003c/a\u003e\u003c/b\u003e | \u003cb\u003e\u003ca href=\"https://github.com/Lissy93/dashy\"\u003eGitHub\u003c/a\u003e\u003c/b\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cbr\u003e\n\u003csup\u003eDashy is kindly sponsored by \u003ca href=\"https://umbrel.com?ref=dashy\"\u003eUmbrel\u003c/a\u003e - the personal home cloud and OS for self-hosting\u003c/sup\u003e\u003cbr\u003e\n\u003ca href=\"https://umbrel.com?ref=dashy\"\u003e\n\u003cimg width=\"400\" src=\"https://github.com/Lissy93/dashy/blob/WEBSITE/docs-site-source/static/umbrel-banner.jpg?raw=true\" /\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n\u003e [!NOTE]\n\u003e Version [3.0.0](https://github.com/Lissy93/dashy/releases/tag/3.0.0) has been released, and requires some changes to your setup, see [#1529](https://github.com/Lissy93/dashy/discussions/1529) for details.\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cb\u003eTable of Contents\u003c/b\u003e\u003c/summary\u003e\n  \u003cp\u003e\n  \n- **Getting Started**\n  - [🌈 Features](#features-)\n  - [⚡Demo](#demo-)\n  - [🚀 Getting Started](#getting-started-)\n  - [🔧 Configuring](#configuring-)\n- **Feature Overview**\n  - [🎨 Theming](#theming-)\n  - [🧸 Icons](#icons-)\n  - [🚦 Status Indicators](#status-indicators-)\n  - [📊 Widgets](#widgets-)\n  - [🔐 Authentication](#authentication-)\n  - [👓 Alternate Views](#alternate-views-)\n  - [🖱️ Opening Methods](#opening-methods-)\n  - [🔎 Searching and Shortcuts](#searching-and-shortcuts-)\n  - [⚙️ Config Editor](#config-editor-)\n  - [☁ Cloud Backup \u0026 Sync](#cloud-backup--sync-)\n  - [🌎 Language Switching](#language-switching-)\n  - [📃 Multi-Page Support](#multi-page-support-)\n- **Community**\n  - [📊 System Requirements](#system-requirements-)\n  - [🙋‍♀️ Support](#support-)\n  - [💖 Supporting Dashy](#supporting-dashy-)\n  - [🏆 Credits](#credits-)\n  - [🧱 Developing](#developing-)\n  - [🗞️ Release Schedule](#release-schedule-)\n  - [📘 Documentation](#documentation-)\n  - [🛣️ Roadmap](#roadmap-)\n  - [🙌 Alternatives](#alternatives-)\n  - [📜 License](#license-)\n    \n  \u003c/p\u003e\n\u003c/details\u003e\n\n## Features 🌈\n- 📃 Support for multiple pages\n- 🚦 Real-time status monitoring for each of your apps/links\n- 📊 Use widgets to display info and dynamic content from self-hosted services\n- 🔎 Instant search by name, domain, or tags + customizable hotkeys \u0026 keyboard shortcuts\n- 🎨 Many built-in color themes, with UI color editor and support for custom CSS\n- 🧸 Many icon options - Font-Awesome, homelab icons, auto-fetching Favicon, images, emojis, etc.\n- 💂 Optional authentication with multi-user access, configurable privileges, and SSO support\n- 🌎 Multi-language support, with 10+ human-translated languages, and more on the way\n- ☁ Optional, encrypted, free off-site cloud backup and restore feature available\n- 💼 A workspace view, for easily switching between multiple apps simultaneously\n- 🛩️ A minimal view, for use as a fast-loading browser Startpage\n- 🖱️ Choose app launch methods: new tab, same tab, clipboard, pop-up modal, or open in workspace view\n- 📏 Customizable layout, sizes, text, component visibility, sort order, behavior, etc.\n- 🖼️ Options for a full-screen background image, custom nav-bar links, HTML footer, title, etc.\n- 🚀 Easy to setup with Docker, or on bare metal, or with 1-Click cloud deployment\n- ⚙️ Easy single-file YAML-based configuration, and option to configure app through the UI\n- ✨ Under active development with improvements and new features added regularly \n- 🤏 Small bundle size, fully responsive UI, and PWA for basic offline access\n- 🆓 100% free and open-source\n- 🔐 Strong focus on privacy\n- 🌈 And loads more...\n\n**[⬆️ Back to Top](#dashy)**\n\n## Demo ⚡\n\n**Live Instances**: [Demo 1](https://demo.dashy.to) (Live Demo) ┆ [Demo 2](https://live.dashy.to) (Dashy Links) ┆ [Demo 3](https://dev.dashy.to) (Dev Preview)\n\n**Screenshots**: Checkout the [Showcase](./docs/showcase.md), to see example dashboards from the community\n\n**Spin up your own demo**: [![One-Click Deploy with PWD](https://img.shields.io/badge/Play--with--Docker-Deploy-2496ed?style=flat-square\u0026logo=docker)](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml) or [`docker run -p 8080:8080 lissy93/dashy`](./docs/quick-start.md)\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"800\" src=\"https://i.ibb.co/L8YbNNc/dashy-demo2.gif\" alt=\"Demo\" /\u003e\n\u003c/p\u003e\n\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Getting Started 🚀\n\n\u003e For full setup instructions, see: [**Deployment**](./docs/deployment.md)\n\n### Deploying from Docker Hub 🐳\n\nYou will need [Docker](https://docs.docker.com/get-docker/) installed on your system\n\n```\ndocker run -p 8080:8080 lissy93/dashy\n```\n\nOr\n\n```docker\ndocker run -d \\\n  -p 4000:8080 \\\n  -v /root/my-local-conf.yml:/app/user-data/conf.yml \\\n  --name my-dashboard \\\n  --restart=always \\\n  lissy93/dashy:latest\n```\n[![Dashy on Docker Hub](https://dockeri.co/image/lissy93/dashy)](https://hub.docker.com/r/lissy93/dashy)\n\nSee also: [examples with Docker Compose](./docs/deployment.md#using-docker-compose). Dashy is also available via GHCR, and tags for other architectures (`arm32v7`, `arm64v8`, etc.) and set versions are supported\n\n\u003e Once you've got Dashy running, see [App Management Docs](./docs/management.md) for info on using health checks, updating, backups, web-server configs, logs, performance, security, and more.\n\n### Deploying from Source 🔨\n\nYou will need [git](https://git-scm.com/downloads), the latest or LTS version of [Node.js](https://nodejs.org/) and _(optionally)_ [Yarn](https://yarnpkg.com/) installed on your system.\n\n- Clone the Repo: `git clone https://github.com/Lissy93/dashy.git` and `cd dashy`\n- Configuration: Fill in your settings in `./user-data/conf.yml`\n- Install dependencies: `yarn`\n- Build: `yarn build`\n- Run: `yarn start`\n\n\u003e See docs: [Full list of Dashy's commands](./docs/management.md#basic-commands)\n\n### Deploy to the Cloud ☁️\n\nDashy supports **1-Click deployments** on several popular cloud platforms. To spin up a new instance, just click a link below:\n- [\u003cimg src=\"https://i.ibb.co/ZxtzrP3/netlify.png\" width=\"18\"/\u003e Deploy to Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy)\n- [\u003cimg src=\"https://i.ibb.co/d2P1WZ7/heroku.png\" width=\"18\"/\u003e Deploy to Heroku](https://heroku.com/deploy?template=https://github.com/Lissy93/dashy)\n- [\u003cimg src=\"https://i.ibb.co/Ld2FZzb/vercel.png\" width=\"18\"/\u003e Deploy to Vercel](https://vercel.com/new/project?template=https://github.com/lissy93/dashy)\n- [\u003cimg src=\"https://i.ibb.co/xCHtzgh/render.png\" width=\"18\"/\u003e Deploy to Render](https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render)\n- [\u003cimg src=\"https://railway.app/brand/logo-light.png\" width=\"18\"/\u003e Deploy to Railway](https://railway.app/template/MtdjAQ?referralCode=app)\n- [\u003cimg src=\"https://i.ibb.co/J7MGymY/googlecloud.png\" width=\"18\"/\u003e Deploy to GCP](https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git)\n- [\u003cimg src=\"https://i.ibb.co/HVWVYF7/docker.png\" width=\"18\"/\u003e Deploy to PWD](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)\n- [\u003cimg src=\"https://i.ibb.co/7NxnM2P/easypanel.png\" width=\"18\"/\u003e Deploy to Easypanel](https://easypanel.io/docs/templates/dashy)\n\n\u003e For more 1-click cloud deployments, see [Cloud Deployment](./docs/deployment.md#deploy-to-cloud-service)\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Configuring 🔧\n\n\u003e For full configuration documentation, see: [**Configuring**](./docs/configuring.md)\n\nDashy is configured through a YAML file, located at `./user-data/conf.yml`. In addition, you can find a complete list of available options in the [Configuring Docs](./docs/configuring.md). The config can also be edited and saved directly through the UI.\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Theming 🎨\n\n\u003e For full theming documentation, see: [**Theming**](./docs/theming.md)\n\nDashy comes pre-bundled with several built-in themes, which you can preview, apply and edit through the UI. With the theme configurator and support for custom CSS, everything is in place to quickly develop your own unique-looking dashboard.\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://i.ibb.co/BVSHV1v/dashy-themes-slideshow.gif\"\u003e\n    \u003cimg alt=\"Example Themes\" src=\"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/theme-slideshow.gif\" width=\"400\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://i.ibb.co/cLDXj1R/dashy-theme-configurator.gif\"\u003e\n    \u003cimg alt=\"Example Themes\" src=\"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/theme-config-demo.gif\" width=\"400\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Icons 🧸\n\n\u003e For full iconography documentation, see: [**Icons**](./docs/icons.md)\n\nBoth sections and items can have an icon associated with them, defined under the `icon` attribute. With several different icon packs supported, you'll be able to find the perfect thumbnail for any app or service.\n\nThe following icon types are supported:\n- **Favicon** - Automatically fetch an apps icon from its Favicon or logo image\n- **Icon Packs** - Use any icon from [font-awesome], [simple-icons] or [material icons]\n- **Emoji** - Any valid emoji can be used as an icon\n- **Generative** - Unique, auto-generated images for easily identifying services\n- **URL** - Pass the URL of any valid image in to have it fetched and rendered\n- **Local** - Store custom images locally and reference by filename\n- **Homelab Icons** - Using [dashboard-icons] for logos of commonly self-hosted services\n\n\n[font-awesome]: https://fontawesome.com/icons\n[simple-icons]: https://simpleicons.org/\n[material icons]: https://github.com/Templarian/MaterialDesign\n[dashboard-icons]: https://github.com/WalkxCode/dashboard-icons\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"400\" src=\"https://i.ibb.co/GTVmZnc/dashy-example-icons.png\" /\u003e\n\u003c/p\u003e\n\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Status Indicators 🚦\n\n\u003e For full monitoring documentation, see: [**Status Indicators**](./docs/status-indicators.md)\n\nDashy has an optional feature to check if each app/ service is up and responding, then display a small status indicator icon. Hovering over it will show additional stats like response time and status code.\n\nStatus indicators can be globally enabled by setting `appConfig.statusCheck: true` or enabled/ disabled on a per-item basis. Status is checked on page load, but you can allow continuous polling by specifying a time interval between checks, in seconds under `appConfig.statusCheckInterval`. You can also use a different endpoint for status checking, with `statusCheckUrl`, and if needed, pass in custom headers under `statusCheckHeaders`.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Status Checks demo\" src=\"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/status-check-demo.gif\" width=\"600\" /\u003e\n\u003c/p\u003e\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Widgets 📊\n\n\u003e For full widget documentation, see: [**Widgets**](./docs/widgets.md)\n\nYou can display dynamic content from services in the form of widgets. There are several pre-built widgets availible for showing useful info, and integrations with commonly self-hosted services, but you can also easily create your own for almost any app.\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"600\" src=\"https://i.ibb.co/GFjXVHy/dashy-widgets.png\" /\u003e\n\u003c/p\u003e\n\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Authentication 🔐\n\n\u003e For full authentication documentation, see: [**Authentication**](./docs/authentication.md)\n\nDashy has full support for secure single-sign-on using [Keycloak](https://www.keycloak.org/) for secure, easy authentication, see [setup docs](/docs/authentication.md#keycloak) for a full usage guide.\n\nThere is also a basic auth feature, which doesn't require additional setup. To enable this, add an `auth` attribute under `appConfig`, containing an array of `users`, each with a username, SHA-256 hashed password and optional user type. Basic auth also supports several access control features, including read-only guest access and granular controls.\n\n\n```yaml\nappConfig:\n  auth:\n    users:\n    - user: alicia\n      hash: 4D1E58C90B3B94BCAD9848ECCACD6D2A8C9FBC5CA913304BBA5CDEAB36FEEFA3\n      type: admin\n```\n\nOther access control systems are also supported, see the [Alternative Auth Methods](./docs/authentication.md#alternative-authentication-methods) docs.\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Alternate Views 👓\n\nAs well as the default homepage, there is also:\n- A minimal view, valid for use as a browser start page\n- A workspace view, useful for visiting many apps simultaneously\n\t\nYou can change the view from the UI, using the switch icon in the top-right corner, or select a default view in the config under `appConfig.startingView` attribute.\n\n\u003cp align=\"center\"\u003e\n  \u003cb\u003eExample of Workspace View\u003c/b\u003e\u003cbr\u003e\n  \u003cimg alt=\"Workspace view demo\" src=\"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/workspace-demo.gif\" width=\"600\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cb\u003eExample of Minimal View\u003c/b\u003e\u003cbr\u003e\n  \u003cimg alt=\"Workspace view demo\" src=\"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/minimal-view-demo.gif\" width=\"600\" /\u003e\n\u003c/p\u003e\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Opening Methods 🖱️\n\n\u003e For full documentation on views and opening methods, see: [**Alternate Views**](./docs/alternate-views.md)\n\nThere are several different ways you can launch apps. You can specify the default opening method for any given item under the `target` attribute or set a site-wide default under `appConfig.defaultOpeningMethod`. Right-click on an item to item for all options. The following options are supported:\n- `sametab` - The app will be launched in the current tab\n- `newtab` - The app will be launched in a new tab (or use Ctrl + Click)\n- `modal` - Launch app in a resizable/ movable popup modal on the current page (or use Alt + Click)\n- `workspace` - Changes to Workspace view and launches app\n- `clipboard` - Copy the app's URL to your system clipboard\n- `top` - Opens in the top-most browsing context, useful if you're accessing Dashy through an iframe\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Searching and Shortcuts 🔎\n\n\u003e For full documentation on searching, see: [**Searching \u0026 Shortcuts**](./docs/searching.md)\n\nQuickly finding and launching applications is the primary aim of Dashy. To that end, instant search and customizable keyboard shortcuts are built-in.\n\nTo start filtering, start typing—no need to select the search bar or use any special key. Then use either the tab key or arrow keys to select and move between results, and hit enter to launch the currently selected application.\n\nFor apps that you use regularly, you can set a custom keybinding. Use the `hotkey` parameter on a certain item to specify a numeric key between `0 - 9`. You can then launch that app by just pressing that key.\n\nYou can also add custom tags to a given item to make finding them based on keywords easier. For example, in the following example, searching for 'Movies' will show 'Plex'\n\n```yaml\n  items:\n  - title: Plex\n    hotkey: 8\n    icon: favicon\n    description: Media library\n    url: https://plex.lab.local\n    tags: [ movies, videos, music ]\n```\n\nTo search the web directly through Dashy, just press enter after typing your query. Options for web search are set under `appConfig.webSearch`. There is built-in support for [10+ search engines](./docs/searching.md#setting-search-engine), or [use your own custom provider](./docs/searching.md#using-custom-search-engine) or self-hosted instance. With the web search, you can also define your bangs to redirect results to any given app, website, or search engine, when the query is preceded with a certain character sequence (usually beginning in `/`, `!` or `:`).\n\n```yaml\nwebSearch:\n  searchEngine: duckduckgo\n  openingMethod: newtab\n  searchBangs:\n    /r: reddit\n    /w: wikipedia\n    /s: https://whoogle.local/search?q=\n    ':wolf': wolframalpha\n    ':so': stackoverflow\n    ':git': github\n```\n\nHit `Esc` at any time to close any open apps, clear the search field, or hide any modals.\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Config Editor ⚙️\n\u003e For full config documentation, see: [**Configuring**](./docs/configuring.md)\n\nAs well as passing in a YAML config file, you can also configure the app directly through the UI and preview changes live.\n\nTo edit any section or item, right-click on it, and select \"Edit\", or enter the Edit Mode (using the Pen icon in the top-right), then click any part of the page to edit. Changes will be visible immediately but will not be saved until clicking \"Save to Disk\" or \"Save Locally\".\n\nUnder the config menu, you can export, view, backup, or reset app config and edit the raw config file in a text editor with built-in schema validation. It's recommended to keep a backup of your config.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Interactive Editor demo\" src=\"https://user-images.githubusercontent.com/1862727/139543020-b0576d28-0830-476f-afc8-a815d4de6def.gif\" width=\"600\" /\u003e\n\u003c/p\u003e\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Config Editor demo\" src=\"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/config-editor-demo.gif\" width=\"600\" /\u003e\n\u003c/p\u003e\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Cloud Backup \u0026 Sync ☁\n\n\u003e For full backup documentation, see: [**Cloud Backup \u0026 Sync**](./docs/backup-restore.md)\n\nDashy has an **optional** built-in feature for securely backing up your config to a hosted cloud service and then restoring it on another instance. This is useful not only for backing up your configuration off-site but also enables Dashy to be used without having to write a YAML config file.\n\nAll data is fully E2E encrypted before being sent to the backend (done in [`CloudBackup.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/CloudBackup.js) using [crypto.js](https://github.com/brix/crypto-js) 's AES method). The data is then sent to a [Cloudflare worker](https://developers.cloudflare.com/workers/learning/how-workers-works) and stored in a [KV](https://developers.cloudflare.com/workers/learning/how-kv-works) data store.\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Language Switching 🌎\n\u003e For full internationalization documentation, see: [**Multi-Language Support**](./docs/multi-language-support.md)\n\nDashy supports multiple languages and locales. When available, your language should be automatically detected and applied on load. But you can also select a language through the UI (under config --\u003e Switch Language) or set `appConfig.language` to your language (specified as a 2-digit [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)), as seen below, e.g. `language: de`.\n\n#### Supported Languages\n- 🇬🇧 **English**: `en` - _Default_\n- 🇦🇪 **Arabic**: `ar` - _Auto-generated_\n- 🇧🇩 **Bengali**: `bn` - Contributed by **[@soaibsafi](https://github.com/soaibsafi)**\n- 🇧🇬 **Bulgarian**: `bg` - Contributed by **[@asenov](https://github.com/asenov)**\n- 🇨🇳 **Chinese**: `cn` - Contributed by **[@FormatToday](https://github.com/FormatToday)**\n- 🇨🇿 **Czech**: `cs` - Contributed by **[@Tuzi555](https://github.com/Tuzi555)**\n- 🇩🇰 **Danish**: `da` - Contributed by **[@lordpansar](https://github.com/lordpansar)**\n- 🇳🇱 **Dutch**: `nl` - Contributed by **[@evroon](https://github.com/evroon)**\n- 🇫🇷 **French**: `fr` - Contributed by **[@EVOTk](https://github.com/EVOTk)**\n- 🇩🇪 **German**: `de` - Contributed by **[@Niklashere](https://github.com/Niklashere)**\n- 🇬🇷 **Greek**: `el` - Contributed by **[@aviolaris](https://github.com/aviolaris)**\n- 🇮🇳 **Hindi**: `hi` - _Auto-generated_\n- 🇮🇹 **Italian**: `it` - Contributed by **[@alexdelprete](https://github.com/alexdelprete)**\n- 🇯🇵 **Japanese**: `ja` - _Auto-generated_\n- 🇰🇷 **Korean**: `ko` - Contributed by **[@boggy-cs](https://github.com/boggy-cs)**\n- 🇳🇴 **Norwegian Bokmål**: `nb` - Contributed by **[@rubjo](https://github.com/rubjo)**\n- 🇵🇱 **Polish**: `pl` - Contributed by **[@skaarj1989](https://github.com/skaarj1989)**\n- 🇵🇹 **Portuguese**: `pt` - Contributed by **[@LeoColman](https://github.com/LeoColman)**\n- 🛰️ **Galician**: `gl` - Contributed by **[@pvillaverde](https://github.com/pvillaverde)**\n- 🇷🇺 **Russian**: `ru` - _Auto-generated_\n- 🇸🇰 **Slovak**: `sk` - Contributed by **[@Smexhy](https://github.com/Smexhy)**\n- 🇸🇮 **Slovenian**: `sl` - Contributed by **[@UrekD](https://github.com/UrekD)**\n- 🇪🇸 **Spanish**: `es` - Contributed by **[@lu4t](https://github.com/lu4t)**\n- 🇸🇪 **Swedish**: `sv` - Contributed by **[@BOZG](https://github.com/BOZG)**\n- 🇹🇼 **Traditional Chinese**: `zh-TW` - Contributed by **[@stanly0726](https://github.com/stanly0726)**\n- 🇹🇷 **Turkish**: `tr` - Contributed by **[@imsakg](https://github.com/imsakg)**\n- 🏴‍☠️ **Pirate**: `pirate` - Contributed by **[@Lissy93](https://github.com/lissy93)**\n\n#### Add your Language\nI would love Dashy to be available to everyone without language being a barrier to entry. If you've got a few minutes to spare, consider adding translations for your language. It's a quick task, and all text is in [a single JSON file](https://github.com/Lissy93/dashy/tree/master/src/assets/locales). Since any missing text will fall back to English, you don't need to translate it all.\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Multi-Page Support 📃\n\n\u003e For full multi-page documentation, see: [**Pages \u0026 Sections**](./docs/pages-and-sections.md)\n\nWithin your dashboard, you can have as many sub-pages as you require. To load additional pages, specify a name, and path to a config file under `pages`. The config file can be either local (stored in `/public`), or remote (located anywhere accessible).\n\n```yaml\npages:\n- name: Networking Services\n  path: 'networking.yml'\n- name: Work Stuff\n  path: 'work.yml'\n```\n\nOr\n\n```yaml\npages:\n- name: Getting Started\n  path: 'https://snippet.host/tvcw/raw'\n- name: Homelab\n  path: 'https://snippet.host/tetp/raw'\n- name: Browser Startpage\n  path: 'https://snippet.host/zcom/raw'\n```\n\n---\n\n## System Requirements 📊\n\nIf running on bare metal, Dashy requires [Node](https://nodejs.org/en/) V 16.0.0 or later, LTS (16.13.2) is recommended.\n\nIf running in Docker container, the recommended base image is Alpine (3.15)\n\nThe hardware requirements vary depending on where and how you are running Dashy. Generally speaking, on a bare-metal system or Docker container, 1GB of memory should be more than enough, and depending on whether you are using your own assets, then 1GB of disk space should be sufficient. \n\nIf you are using one of the 1-click cloud deployment methods, serving the app through a CDN or using a static hosting provider, then there are no specific requirements, as the built app is just a series of static JS files, and so is very light-weight.\n\nDashy also wells run on low-powered ARM-based single board computers, such as a Raspberry Pi (tested on Pi 3)\n\n**Browser Support**\n![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![IE](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![Opera](https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png) | ![Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png)\n--- | --- | --- | --- | --- |\nLatest ✔ | Latest ✔ | 10+ ✔ | Latest ✔ | 6.1+ ❌ |\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Support 🙋‍♀️\n\nIf you're having trouble getting Dashy up and running, or have a question about usage or configuration, feel free to ask. The best place to do this is via [the Discussions](https://github.com/Lissy93/dashy/discussions).\n\nIf you've found something which isn't working as it should, please raise a bug by [opening a ticket](https://github.com/Lissy93/dashy/issues/new/choose).\n\nIt's best to check the [docs](./docs), [previous issues](https://github.com/Lissy93/dashy/issues?q=label%3A%22%F0%9F%A4%B7%E2%80%8D%E2%99%82%EF%B8%8F+Question%22+) and [troubleshooting guide](./docs/troubleshooting.md) first.\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Supporting Dashy 💖\n\n\u003e For full details and other ways you can help out, see: [**Contributing**](./docs/contributing.md)\n\nIf you're using Dashy and would like to help support its development, then that would be awesome! Contributions of any type, any size, are always very much appreciated, and we will appropriately credit you for your effort.\n\nSeveral areas that we need a bit of help with at the moment are:\n- Translating - Help make Dashy available to non-native English speakers by [adding your language](./docs/multi-language-support.md#adding-a-new-language)\n- Donate a small amount by [Sponsoring @Lissy93 on GitHub](https://github.com/sponsors/Lissy93) and receive some extra perks!\n- Complete a [short survey](https://survey.typeform.com/to/gl0L68ou) to have your say about future features\n- Share your dashboard in the [Showcase](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#dashy-showcase-), to inspire others\n- Spread the word by sharing Dashy or a screenshot of your dashboard to help new users discover it\n- Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget or something else\n- Star Dashy on GitHub/ DockerHub or leave an upvote / review on [these platforms](https://github.com/Lissy93/dashy/blob/master/docs/contributing.md#star-upvote-or-leave-a-review)\n\n[![Sponsor Lissy93 on GitHub](./docs/assets/sponsor-button.svg)](https://github.com/sponsors/Lissy93)\n\n**[⬆️ Back to Top](#dashy)**\n\n## Credits 🏆\n\n\u003e For a complete list of credits, and attributions to packages used within Dashy, see: [**Credits**](./docs/credits.md)\n\nThank you so much to everyone who has helped with Dashy so far; every contribution is very much appreciated.\n\n#### Sponsors\n\nHuge thanks to the sponsors helping to support Dashy's development!\n\u003c!-- readme: sponsors -start --\u003e\n\u003ctable\u003e\n\u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/koconder\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/25068?u=582657b23622aaa3dfe68bd028a780f272f456fa\u0026v=4\" width=\"80;\" alt=\"koconder\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eVincent Koc\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/tbjers\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/1117052?v=4\" width=\"80;\" alt=\"tbjers\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eTorgny Bjers\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/AnandChowdhary\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/2841780?u=747e554b3a7f12eb20b7910e1c87d817844f714f\u0026v=4\" width=\"80;\" alt=\"AnandChowdhary\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eAnand Chowdhary\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/shrippen\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/2873570?v=4\" width=\"80;\" alt=\"shrippen\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eShrippen\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/bile0026\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/5022496?u=aec96ad173c0ea9baaba93807efa8a848af6595c\u0026v=4\" width=\"80;\" alt=\"bile0026\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eZach Biles\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/UlisesGascon\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/5110813?u=3c41facd8aa26154b9451de237c34b0f78d672a5\u0026v=4\" width=\"80;\" alt=\"UlisesGascon\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eUlises Gascón\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/digitalarche\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/6546135?u=564756d7f44ab2206819eb3148f6d822673f5066\u0026v=4\" width=\"80;\" alt=\"digitalarche\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eDigital Archeology\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/InDieTasten\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/7047377?u=8d8f8017628b38bc46dcbf3620e194b01d3fb2d1\u0026v=4\" width=\"80;\" alt=\"InDieTasten\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eInDieTasten\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/araguaci\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/7318668?v=4\" width=\"80;\" alt=\"araguaci\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eAraguaci\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/bmcgonag\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/7346620?u=2a0f9284f3e12ac1cc15288c254d1ec68a5081e8\u0026v=4\" width=\"80;\" alt=\"bmcgonag\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eBrian McGonagill\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/vlad-tim\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/11474041?u=eee43705b54d2ec9f51fc4fcce5ad18dd17c87e4\u0026v=4\" width=\"80;\" alt=\"vlad-tim\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eVlad\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/helixzz\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/12218889?u=d06d0c103dfbdb99450623064f7da3c5a3675fb6\u0026v=4\" width=\"80;\" alt=\"helixzz\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eHeliXZz\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/patvdv\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/12430107?u=e8911c2fb91af4d30432f76da8c40927b2830bd7\u0026v=4\" width=\"80;\" alt=\"patvdv\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003ePatrick Van Der Veken\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/mryesiller\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/24632172?u=0d20f2d615158f87cd60a3398d3efb026c32f291\u0026v=4\" width=\"80;\" alt=\"mryesiller\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eGöksel Yeşiller\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/undefined\"\u003e\n            \u003cimg src=\"\" width=\"80;\" alt=\"undefined\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eUndefined\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/Bastii717\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/53431819?u=604977bed6ad6875ada890d0d3765a4cacc2fa14\u0026v=4\" width=\"80;\" alt=\"Bastii717\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eBastii717\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/frankdez93\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/87549420?v=4\" width=\"80;\" alt=\"frankdez93\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eFrankdez93\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/nrvo\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/151435968?u=e1dcb307fd0efdc45cddbe9490a7b956e4da6835\u0026v=4\" width=\"80;\" alt=\"nrvo\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eNrvo\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/hudsonrock-partnerships\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/163282900?v=4\" width=\"80;\" alt=\"hudsonrock-partnerships\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003ehudsonrock-partnerships\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\u003c/tr\u003e\n\u003c/table\u003e\n\u003c!-- readme: sponsors -end --\u003e\n\n#### Contributors\n[![Auto-generated contributors](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg)](./docs/credits.md)\n\n#### Stats\n[![Stats](https://repobeats.axiom.co/api/embed/48546e3c768d38c450ba136e32c0992bcf58ad73.svg \"Repobeats analytics image\")](https://github.com/Lissy93/dashy/blob/master/docs/credits.md)\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Developing 🧱\n\n\u003e For full development documentation, see: [**Developing**](./docs/developing.md)\n\n[![Open Project in VS Code](https://img.shields.io/badge/Open_in-VS_Code-863cfc?style=flat-square\u0026logo=visualstudiocode)](https://open.vscode.dev/Lissy93/Dashy)\n[![Open in GitPod](https://img.shields.io/badge/Open_in-GitPod-ffae33?style=flat-square\u0026logo=gitpod)](https://gitpod.io/#github.com/lissy93/dashy.git)\n[![Open in GitHub Code Spaces](https://img.shields.io/badge/Open_in-Code%20Spaces-131313?style=flat-square\u0026logo=github)](https://github.dev/Lissy93/dashy)\n\nBefore getting started, you'll need [Git](https://git-scm.com/downloads), [Node](https://nodejs.org/en/download/) and optionally [Yarn](https://yarnpkg.com/) (run `npm i -g yarn`) installed.\n\nTo set up the development environment:\n1. Get Code: `git clone https://github.com/Lissy93/dashy.git`  and `cd dashy`\n2. Install dependencies: `yarn`\n3. Start dev server: `yarn dev`\n4. Open the browser: `http://localhost:8080`\n\nWhen you're ready, you can build the production app with `yarn build`, and then run it with `yarn start`\n\nIf you're new to web development, I've put together a short [list of resources](https://github.com/Lissy93/dashy/blob/master/docs/developing.md#resources-for-beginners) to help beginners get started\n\n**Repo Status**:\n[![Open PRs](https://flat.badgen.net/github/open-prs/lissy93/dashy?icon=github)](https://github.com/Lissy93/dashy/pulls)\n[![Total PRs](https://flat.badgen.net/github/prs/lissy93/dashy?icon=github)](https://github.com/Lissy93/dashy/pulls?q=)\n[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/lissy93/dashy?style=flat-square)](https://github.com/Lissy93/dashy/commits/master)\n[![Last Commit](https://flat.badgen.net/github/last-commit/lissy93/dashy?icon=github)](https://github.com/Lissy93/dashy/commits/master)\n[![Contributors](https://flat.badgen.net/github/contributors/lissy93/dashy?icon=github)](https://github.com/Lissy93/dashy/graphs/contributors)\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Documentation 📘\n\u003e For full docs, see: **[Documentation Contents](./docs/readme.md)**\n#### Running Dashy\n- 💨 [Quick Start](/docs/quick-start.md) - TDLR guide on getting Dashy up and running in under 5 minutes\n- 🚀 [Deployment](/docs/deployment.md) - Full guide on setting up Dashy on various different environments\n- 🔧 [Configuring](/docs/configuring.md) - Complete list of all available options in the config file\n- 💻 [Management](/docs/management.md) - Managing your app, updating, security, web server configuration, etc\n- 🚒 [Troubleshooting](/docs/troubleshooting.md) - Common errors and problems, and how to fix them\n\n#### Feature Docs\n- 🛡️ [Authentication](/docs/authentication.md) - Guide to setting up authentication to protect your dashboard\n- 🌈 [Alternate Views](/docs/alternate-views.md) - Outline of available pages / views and item opening methods\n- 💾 [Backup \u0026 Restore](/docs/backup-restore.md) - Guide to backing up config with Dashy's cloud sync feature\n- 🧸 [Icons](/docs/icons.md) - Outline of all available icon types for sections and items, with examples\n- 🌐 [Multi-Language Support](/docs/multi-language-support.md) - Switching languages, and adding a new locales\n- 🚦 [Status Indicators](/docs/status-indicators.md) - Using Dashy to monitor uptime and status of your apps\n- 🔍 [Searching  \u0026 Shortcuts](/docs/searching.md) - Searching, launching methods + keyboard shortcuts\n- 🎨 [Theming](/docs/theming.md) - Complete guide to applying, writing and modifying themes + styles\n- 📊 [Widgets](/docs/widgets.md) - List of all dynamic content widgets, with usage guides and examples\n\n#### Development and Contributing\n- 🧱 [Developing](/docs/developing.md) - Running Dashy development server locally, and general workflow\n- 🛎️ [Development Guides](/docs/development-guides.md) - Common development tasks, to help new contributors\n- 💖 [Contributing](/docs/contributing.md) - How to contribute to Dashy\n- 🌟 [Showcase](/docs/showcase.md) - See how others are using Dashy, and share your dashboard\n- 🏆 [Credits](/docs/credits.md) - Shout out to the amazing people who have contributed so far\n- 🗞️ [Release Workflow](/docs/release-workflow.md) - Info about releases, CI and automated tasks\n\n#### Misc\n- 🔐 [Privacy \u0026 Security](/docs/privacy.md) - List of requests, potential issues, and security resources\n- 📄 [License](/LICENSE) - Copy of the MIT License\n- ⚖️ [Legal](/.github/LEGAL.md) - Licenses of direct dependencies\n- 📏 [Code of Conduct](/.github/CODE_OF_CONDUCT.md) - Contributor Covenant Code of Conduct\n- 🌳 [Changelog](/.github/CHANGELOG.md) - Details of recent changes, and historical versions\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Roadmap 🛣️\n\nFor upcoming features that will be released in the near future, see the [**Current Roadmap**](https://github.com/Lissy93/dashy/discussions/405)\n\nFor past updates, see the [**Changelog**](/.github/CHANGELOG.md)\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n## Alternatives 🙌\n\nA few self-hosted web apps serve a similar purpose to Dashy. If you're looking for a dashboard, and Dashy doesn't meet your needs, I highly recommend you check these projects out! \n- [Flame](https://github.com/pawelmalak/flame) by @pawelmalak (`MIT`)\n- [HomeDash2](https://lamarios.github.io/Homedash2)\n- [Homer](https://github.com/bastienwirtz/homer) (`Apache License 2.0`)\n- [Organizr](https://organizr.app/) (`GPL-3.0 License`)\n- [Heimdall](https://github.com/linuxserver/Heimdall) (`MIT`)\n- [Smashing](https://github.com/Smashing/smashing) (`MIT`)\n- See more 👉 [Awesome Self-Hosted](https://github.com/awesome-selfhosted/awesome-selfhosted#personal-dashboards)\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n## License 📜\n\nDashy is Licensed under [MIT X11](https://en.wikipedia.org/wiki/MIT_License)\n\n```\nCopyright © 2021-2024 Alicia Sykes \u003chttps://aliciasykes.com\u003e\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this\nsoftware and associated documentation files (the \"Software\"), to deal in the Software\nwithout restriction, including without limitation the rights to use, copy, modify, merge,\npublish, distribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or\nsubstantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,\nINCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR\nPURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE\nOR OTHER DEALINGS IN THE SOFTWARE.\n\nExcept as contained in this notice, Dashy shall not be used in advertising or otherwise\nto promote the sale, use, or other dealings in this Software without prior written\nauthorization from the repo owner.\n```\n\n**TDLR;** _You can do whatever you like with Dashy: use it in private or commercial settings,_\n_redistribute and modify it. But you must display this license and credit the author._\n_There is no warranty that this app will work as expected, and the author cannot be held_\n_liable for anything that goes wrong._\nFor more info, see TLDR Legal's [Explanation of MIT](https://tldrlegal.com/license/mit-license)\n\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FLissy93%2Fdashy.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FLissy93%2Fdashy?ref=badge_large)\n\n**[⬆️ Back to Top](#dashy)**\n\n---\n\n\u003c!-- License + Copyright --\u003e\n\u003cp  align=\"center\"\u003e\n  \u003ci\u003e© \u003ca href=\"https://aliciasykes.com\"\u003eAlicia Sykes\u003c/a\u003e 2024\u003c/i\u003e\u003cbr\u003e\n  \u003ci\u003eLicensed under \u003ca href=\"https://gist.github.com/Lissy93/143d2ee01ccc5c052a17\"\u003eMIT\u003c/a\u003e\u003c/i\u003e\u003cbr\u003e\n  \u003ca href=\"https://github.com/lissy93\"\u003e\u003cimg src=\"https://i.ibb.co/4KtpYxb/octocat-clean-mini.png\" /\u003e\u003c/a\u003e\u003cbr\u003e\n  \u003csup\u003eThanks for visiting :)\u003c/sup\u003e\n\u003c/p\u003e\n\n\u003c!-- Dinosaurs are Awesome --\u003e\n\u003c!-- \n                        . - ~ ~ ~ - .\n      ..     _      .-~               ~-.\n     //|     \\ `..~                      `.\n    || |      }  }              /       \\  \\\n(\\   \\\\ \\~^..'                 |         }  \\\n \\`.-~  o      /       }       |        /    \\\n (__          |       /        |       /      `.\n  `- - ~ ~ -._|      /_ - ~ ~ ^|      /- _      `.\n              |     /          |     /     ~-.     ~- _\n              |_____|          |_____|         ~ - . _ _~_-_\n--\u003e\n\n","funding_links":["https://github.com/sponsors/lissy93","https://notes.aliciasykes.com/tip","https://github.com/sponsors/Lissy93"],"categories":["Vue","HarmonyOS","置顶","🌐 Web Development - Frontend","Projects","Self Hosted","前端开发框架及项目","Other Lists","docker","awesome","vue","Table of Contents","Dashboards"],"sub_categories":["Windows Manager","9、效率工具集合","Hosted","Windows Specific","管理面板","TeX Lists","Dashboard"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLissy93%2Fdashy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FLissy93%2Fdashy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLissy93%2Fdashy/lists"}