-
+
-
+
@@ -28,7 +28,7 @@
- **Getting Started**
@@ -41,18 +41,16 @@
- [🧸 Icons](#icons-)
- [🚦 Status Indicators](#status-indicators-)
- [📊 Widgets](#widgets-)
- - [💂 Authentication](#authentication-)
- - [🖱️ Opening Methods](#opening-methods-%EF%B8%8F)
+ - [🔐 Authentication](#authentication-)
- [👓 Alternate Views](#alternate-views-)
+ - [🖱️ Opening Methods](#opening-methods-)
- [🔎 Searching and Shortcuts](#searching-and-shortcuts-)
- - [⚙️ Config Editor](#config-editor-%EF%B8%8F)
+ - [⚙️ Config Editor](#config-editor-)
- [☁ Cloud Backup & Sync](#cloud-backup--sync-)
- [🌎 Language Switching](#language-switching-)
- - [🌳 Dashboard Info](#setting-dashboard-info-)
- **Community**
- [📊 System Requirements](#system-requirements-)
- - [🙋♀️ Getting Help](#getting-help-%EF%B8%8F)
- - [🐛 Raising Issues](#raising-issues-)
+ - [🙋♀️ Support](#support-)
- [💖 Supporting Dashy](#supporting-dashy-)
- [🏆 Credits](#credits-)
- [🧱 Developing](#developing-)
@@ -68,7 +66,7 @@
## Features 🌈
- 🔎 Instant search by name, domain, or tags + customizable hotkeys & keyboard shortcuts
-- 🎨 Multiple built-in color themes, with UI color editor and support for custom CSS
+- 🎨 Many built-in color themes, with UI color editor and support for custom CSS
- 🧸 Many icon options - Font-Awesome, homelab icons, auto-fetching Favicon, images, emojis, etc.
- 🚦 Status monitoring for each of your apps/links for basic availability and uptime checking
- 📊 Use widgets to display info and dynamic content from self-hosted services
@@ -88,6 +86,8 @@
- 🔐 Strong focus on privacy
- 🌈 And loads more...
+**[⬆️ Back to Top](#dashy)**
+
## Demo ⚡
**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)
@@ -106,7 +106,7 @@
---
-## Getting Started 🛫
+## Getting Started 🚀
> For full setup instructions, see: [**Deployment**](./docs/deployment.md)
@@ -130,25 +130,25 @@ docker run -d \
```
[](https://hub.docker.com/r/lissy93/dashy)
-See 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
+See 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
> 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.
-### Deploying from Source 🚀
+### Deploying from Source 🔨
-You 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.
+You 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.
-- Get Code: `git clone https://github.com/Lissy93/dashy.git` and `cd dashy`
+- Clone the Repo: `git clone https://github.com/Lissy93/dashy.git` and `cd dashy`
- Configuration: Fill in your settings in `./public/conf.yml`
- Install dependencies: `yarn`
- Build: `yarn build`
- Run: `yarn start`
-> See docs [Full list of Dashy's commands](./docs/management.md#basic-commands)
+> See docs: [Full list of Dashy's commands](./docs/management.md#basic-commands)
### Deploy to the Cloud ☁️
-Dashy supports 1-Click deployments on several popular cloud platforms. To spin up a new instance, just click a link below:
+Dashy supports **1-Click deployments** on several popular cloud platforms. To spin up a new instance, just click a link below:
- [
Deploy to Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy)
- [
Deploy to Heroku](https://heroku.com/deploy?template=https://github.com/Lissy93/dashy)
- [
Deploy to Vercel](https://vercel.com/new/project?template=https://github.com/lissy93/dashy)
@@ -166,7 +166,7 @@ Dashy supports 1-Click deployments on several popular cloud platforms. To spin u
> For full configuration documentation, see: [**Configuring**](./docs/configuring.md)
-Dashy is configured through a YAML file, located at `./public/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.
+Dashy is configured through a YAML file, located at `./public/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.
**[⬆️ Back to Top](#dashy)**
@@ -176,7 +176,7 @@ Dashy is configured through a YAML file, located at `./public/conf.yml`. In addi
> For full theming documentation, see: [**Theming**](./docs/theming.md)
-Dashy comes pre-bundled with several built-in themes, which you can preview, applied and edit through the UI. With the theme configurator and support for custom CSS, everything is in place to quickly develop your unique-looking dashboard.
+Dashy 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.
 @@ -315,6 +315,8 @@ There are several different ways you can launch apps. You can specify the defaul - `clipboard` - Copy the app's URL to your system clipboard - `top` - Opens in the top-most browsing context, useful if you're accessing Dashy through an iframe +**[⬆️ Back to Top](#dashy)** + --- ## Searching and Shortcuts 🔎 @@ -441,6 +443,8 @@ Dashy also wells run on low-powered ARM-based single board computers, such as a --- | --- | --- | --- | --- | Latest ✔ | Latest ✔ | 10+ ✔ | Latest ✔ | 6.1+ ❌ | +**[⬆️ Back to Top](#dashy)** + --- ## Support 🙋♀️ @@ -673,7 +677,7 @@ A few self-hosted web apps serve a similar purpose to Dashy. If you're looking f Dashy is Licensed under [MIT X11](https://en.wikipedia.org/wiki/MIT_License) ``` -Copyright © 2021 Alicia Sykes +Copyright © 2021-2022 Alicia Sykes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software](https://i.ibb.co/BVSHV1v/dashy-themes-slideshow.gif){kind=link}