mirror of https://github.com/Lissy93/dashy.git
590 lines
33 KiB
Markdown
590 lines
33 KiB
Markdown
|
|
<h1 align="center">Dashy</h1>
|
|
<p align="center"><i>Dashy helps you organize your self-hosted services, by making them all accessible from a single place</i></p>
|
|
|
|
<p align="center">
|
|
<img width="220" src="https://i.ibb.co/yhbt6CY/dashy.png" />
|
|
</p>
|
|
|
|
[](https://github.com/awesome-selfhosted/awesome-selfhosted#personal-dashboards)
|
|
|
|
|
|
|
|
|
|
|
|
[](https://snyk.io/test/github/lissy93/dashy)
|
|
|
|
<details>
|
|
<summary><b>Contents</b></summary>
|
|
<p>
|
|
<ul>
|
|
<li><b>Getting Started</b></li>
|
|
<ul>
|
|
<li><a href="#features-">🌈 Features</a></li>
|
|
<li><a href="#demo-">⚡Demo</a></li>
|
|
<li><a href="#getting-started-">🚀 Getting Started</a></li>
|
|
<li><a href="#configuring-">🔧 Configuring</a></li>
|
|
</ul>
|
|
<li><b>Feature Overview</b></li>
|
|
<ul>
|
|
<li><a href="#theming-">🎨 Theming</a></li>
|
|
<li><a href="#icons-">🧸 Icons</a></li>
|
|
<li><a href="#cloud-backup--sync-">☁ Cloud Backup & Sync</a></li>
|
|
<li><a href="#authentication-">💂 Authentication</a></li>
|
|
<li><a href="#status-indicators-">🚦 Status Indicators</a></li>
|
|
<li><a href="#opening-methods-%EF%B8%8F">🖱️ Opening Methods</a></li>
|
|
<li><a href="#searching-and-shortcuts-">🔎 Searching and Shortcuts</a></li>
|
|
<li><a href="#config-editor-%EF%B8%8F">⚙️ Config Editor</a></li>
|
|
<li><a href="#language-switching-">🌎 Language Switching</a></li>
|
|
<li><a href="#setting-dashboard-info-">🌳 Dashboard Info</a></li>
|
|
</ul>
|
|
<li><b>Community</b></li>
|
|
<ul>
|
|
<li><a href="#getting-help-">🙋♀️ Getting Help</a></li>
|
|
<li><a href="#raising-issues-">🐛 Raising Issues</a></li>
|
|
<li><a href="#supporting-dashy-">💖 Supporting Dashy</a></li>
|
|
<li><a href="#credits-">🏆 Credits</a></li>
|
|
<li><a href="#developing-">🧱 Developing</a></li>
|
|
<li><a href="#documentation-">📘 Documentation</a></li>
|
|
<li><a href="#roadmap-">🛣️ Roadmap</a></li>
|
|
<li><a href="#alternatives-">🙌 Alternatives</a></li>
|
|
<li><a href="#license-">📜 License</a></li>
|
|
</ul>
|
|
</ul>
|
|
</p>
|
|
</details>
|
|
|
|
## Features 🌈
|
|
|
|
- Instant search by name, domain and tags - just start typing
|
|
- Full customizable keyboard shortcuts for navigation, filtering and launching apps
|
|
- Multiple built-in color themes, with UI color configurator and support for custom CSS
|
|
- Easy to customize every part of your dashboard, layout, icon sizes, behavior and colors etc
|
|
- Many options for icons, including Font-Awesome support, auto-fetching service favicon, images and emojis
|
|
- Option to show service status for each of your apps / links, for basic availability and uptime monitoring
|
|
- Multiple ways of opening apps, either in your browser, a pop-up modal or workspace view
|
|
- Option for full-screen background image, custom nav-bar links, html footer, title, and more
|
|
- Encrypted cloud backup and restore feature available
|
|
- Optional authentication, requiring admins and non-privileged users to log in
|
|
- Easy single-file YAML-based configuration, which can also be configured directly through the UI
|
|
- Small bundle size, fully responsive UI and PWA makes the app easy to use on any device
|
|
- Easy to setup with Docker, or on bare metal, or with 1-Click cloud deployment
|
|
- Multi-language support, with additional languages coming soon
|
|
- Plus lots more...
|
|
|
|
## Demo ⚡
|
|
|
|
> For more examples of Dashy in action, see: [**The Showcase**](./docs/showcase.md)
|
|
|
|
#### Live Demos
|
|
[Demo 1](https://dashy-demo-1.as93.net) ┆ [Demo 2](https://dashy-demo-2.as93.net) ┆ [Demo 3](https://dashy-demo-3.as93.net)
|
|
|
|
#### Spin up your own Demo
|
|
- 1-Click Deploy: [](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
|
- Or on your own machine: `docker run -p 8080:80 lissy93/dashy`
|
|
|
|
#### Recording
|
|
<p align="center">
|
|
<img width="800" src="https://i.ibb.co/L8YbNNc/dashy-demo2.gif" alt="Demo" />
|
|
</p>
|
|
|
|
#### User Showcase
|
|
Are using Dashy? Want to share your dashboard here too - [Submit your Screenshots to the Showcase](./docs/showcase.md#submitting-your-dashboard)!
|
|
|
|
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Getting Started 🛫
|
|
|
|
> For full setup instructions, see: [**Deployment**](./docs/deployment.md)
|
|
|
|
#### Deploying from Docker Hub 🐳
|
|
|
|
You will need [Docker](https://docs.docker.com/get-docker/) installed on your system
|
|
|
|
```
|
|
docker run -p 8080:80 lissy93/dashy
|
|
```
|
|
|
|
Or
|
|
|
|
```docker
|
|
docker run -d \
|
|
-p 4000:80 \
|
|
-v /root/my-local-conf.yml:/app/public/conf.yml \
|
|
--name my-dashboard \
|
|
--restart=always \
|
|
lissy93/dashy:latest
|
|
```
|
|
|
|
If you prefer to use Docker Compose, [here is an example](./docs/deployment.md#using-docker-compose).
|
|
You can also build the Docker container from source, by cloning the repo, cd'ing into it and running `docker build .` and `docker compose up`.
|
|
|
|
> Once you've got Dashy running, you can take a look at [App Management Docs](./docs/management.md), for info on using health checks, provisioning assets, configuring web servers, securing your app, logs, performance and more.
|
|
|
|
#### Deploying from Source 🚀
|
|
|
|
You will need both [git](https://git-scm.com/downloads) and the latest or LTS version of [Node.js](https://nodejs.org/) installed on your system
|
|
|
|
- Get Code: `git clone git@github.com:Lissy93/dashy.git` and `cd dashy`
|
|
- Configuration: Fill in you're 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)
|
|
|
|
#### 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:
|
|
- [<img src="https://i.ibb.co/ZxtzrP3/netlify.png" width="18"/> Deploy to Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy)
|
|
- [<img src="https://i.ibb.co/d2P1WZ7/heroku.png" width="18"/> Deploy to Heroku](https://heroku.com/deploy?template=https://github.com/Lissy93/dashy)
|
|
- [<img src="https://i.ibb.co/Ld2FZzb/vercel.png" width="18"/> Deploy to Vercel](https://vercel.com/new/project?template=https://github.com/lissy93/dashy)
|
|
- [<img src="https://i.ibb.co/xCHtzgh/render.png" width="18"/> Deploy to Render](https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render)
|
|
- [<img src="https://i.ibb.co/J7MGymY/googlecloud.png" width="18"/> Deploy to GCP](https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git)
|
|
- [<img src="https://i.ibb.co/HVWVYF7/docker.png" width="18"/> Deploy to PWD](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
|
|
|
> For more 1-click cloud deployments, see [Cloud Deployment](./docs/deployment.md#deploy-to-cloud-service)
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Configuring 🔧
|
|
|
|
> For full configuration documentation, see: [**Configuring**](./docs/configuring.md)
|
|
|
|
All of Dashy's configuration is specified in a single [YAML](https://yaml.org/) file, located at `./public/conf.yml` (or `./app/public/conf.yml` for Docker). You can find a complete list of available options in th [Configuring Docs](/docs/configuring.md). If you're using Docker, you'll probably want to pass this file in as a Docker volume (e.g. `-v /root/my-local-conf.yml:/app/public/conf.yml`).
|
|
|
|
The config can also be edited directly through the UI, with changes written to your conf.yml file. After making any modifications the app does need to be rebuilt, this should happen automatically but you can also trigger a build with `yarn build`, `docker exec -it [container-id] yarn build`, or directly through the UI.
|
|
|
|
You can check that your config is correct and valid, by running: `yarn validate-config`. This will validate that your configuration matches Dashy's [schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json).
|
|
|
|
Finally, you may find these [example config](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10) helpful for getting you started.
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Theming 🎨
|
|
|
|
> For full theming documentation, see: [**Theming**](./docs/theming.md)
|
|
|
|
<p align="center">
|
|
<a href="https://i.ibb.co/BVSHV1v/dashy-themes-slideshow.gif">
|
|
<img alt="Example Themes" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/theme-slideshow.gif" width="400" />
|
|
</a>
|
|
</p>
|
|
|
|
Dashy comes with a number of built-in themes, but it's also easy to make you're own. You can either use the color editor, or you're own custom CSS. All colors, and most other CSS properties are specified using CSS variables, which are [documented here](./docs/theming.md#css-variables), so customizing the look and feel of Dashy very easy. Learn more about adding your own theme in the [docs](https://github.com/Lissy93/dashy/blob/master/docs/theming.md#adding-your-own-theme).
|
|
|
|
<p align="center">
|
|
<a href="https://i.ibb.co/cLDXj1R/dashy-theme-configurator.gif">
|
|
<img alt="Example Themes" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/theme-config-demo.gif" width="400" />
|
|
</a>
|
|
</p>
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Icons 🧸
|
|
|
|
> For full iconography documentation, see: [**Icons**](./docs/icons.md)
|
|
|
|
Both sections and items can have an icon associated with them, and defined under the `icon` attribute. There are many options for icons, including Font Awesome support, automatic fetching from favicon, programmatically generated icons and direct local or remote URLs.
|
|
|
|
<p align="center">
|
|
<img width="400" src="https://i.ibb.co/GTVmZnc/dashy-example-icons.png" />
|
|
</p>
|
|
|
|
- **Favicon**: Set `icon: favicon` to fetch a services icon automatically from the URL of the corresponding application
|
|
- **Font-Awesome**: To use any font-awesome icon, specify the category, followed by the icon name, e.g. `fas fa-rocket` or `fab fa-monero`. You can also use Pro icons if you have a license key, just set it under `appConfig.fontAwesomeKey`
|
|
- **Generative**: Setting `icon: generative`, will generate a unique for a given service, based on it's URL or IP
|
|
- **Emoji**: Use an emoji as a tile icon, by putting the emoji's code as the icon attribute. Emojis can be specified either as emojis (`🚀`), unicode (`'U+1F680'`) or shortcode (`':rocket:'`).
|
|
- **URL**: You can also pass in a URL to an icon asset, hosted either locally or using any CDN service. E.g. `icon: https://i.ibb.co/710B3Yc/space-invader-x256.png`.
|
|
- **Local Image**: To use a local image, store it in `./public/item-icons/` (or create a volume in Docker: `-v /local/image/directory:/app/public/item-icons/`) , and reference it by name and extension - e.g. set `icon: image.png` to use `./public/item-icon/image.png`. You can also use sub-folders here if you have a lot of icons, to keep them organized.
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Cloud Backup & Sync ☁
|
|
|
|
> For full backup documentation, see: [**Cloud Backup & Sync**](./docs/backup-restore.md)
|
|
|
|
Dashy 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 feature is totally optional, and if you do not enable it, then Dashy will not make any external network requests.
|
|
|
|
This is useful not only for backing up your configuration off-site, but it also enables Dashy to be used without having write a YAML config file, and makes it possible to use a public hosted instance, without the need to self-host.
|
|
|
|
All data is encrypted before being sent to the backend. In Dashy, this is 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, using the users chosen password as the key. The data is then sent to a [Cloudflare worker](https://developers.cloudflare.com/workers/learning/how-workers-works) (a platform for running serverless functions), and stored in a [KV](https://developers.cloudflare.com/workers/learning/how-kv-works) data store.
|
|
|
|
<p align="center">
|
|
<img width="400" src="https://i.ibb.co/yBrVN4N/dashy-cloud-sync.png" />
|
|
</p>
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Authentication 💂
|
|
|
|
> For full authentication documentation, see: [**Authentication**](./docs/authentication.md)
|
|
|
|
Dashy has a built-in login feature, which can be used for basic access control. To enable this feature, add an `auth` attribute under `appConfig`, containing an array of users, each with a username, SHA-256 hashed password and optional user type.
|
|
|
|
```yaml
|
|
appConfig:
|
|
auth:
|
|
- user: alicia
|
|
hash: 4D1E58C90B3B94BCAD9848ECCACD6D2A8C9FBC5CA913304BBA5CDEAB36FEEFA3
|
|
```
|
|
At present, access control is handled on the frontend, and therefore in security-critical situations, it is recommended to use an alternate method for authentication, such as [Authelia](https://www.authelia.com/), a VPN or web server and firewall rules.
|
|
|
|
<p align="center">
|
|
<img
|
|
title="Example login screen, using Vapourwave theme"
|
|
alt="Example login screen, using Vapourwave theme"
|
|
src="https://i.ibb.co/K52YL1g/dashy-login-form.png"
|
|
width="400"
|
|
/>
|
|
</p>
|
|
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Status Indicators 🚦
|
|
|
|
> For full monitoring documentation, see: [**Status Indicators**](./docs/status-indicators.md)
|
|
|
|
Dashy has an optional feature that can display a small icon next to each of your running services, indicating it's current status. This is useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. Hovering over the indicator will show additional information, including average response time and an error message for services which are down.
|
|
|
|
By default, this feature is off, but you can enable it globally by setting `appConfig.statusCheck: true`, or enable/ disable it for an individual item, with `item[n].statusCheck`.
|
|
|
|
You can also specify an time interval in seconds under `appConfig.statusCheckInterval`, between checks, if this value is `0`, then status is only checked on initial page load, which is the default behavior. Status checks use the `url` attribute, but to call a different endpoint instead, you can set `statusCheckUrl`. Custom headers can also be specified using `statusCheckHeaders`.
|
|
|
|
<p align="center">
|
|
<img alt="Status Checks demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/status-check-demo.gif" width="600" />
|
|
</p>
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Opening Methods 🖱️
|
|
|
|
> For full documentation on views and opening methods, see: [**Alternate Views**](./docs/alternate-views.md)
|
|
|
|
One of the primary purposes of Dashy is to make launching commonly used apps and services as quick as possible. To aid in this, there are several different options on how items can be opened. You can configure your preference by setting the `target` property of any item, to one of the following values:
|
|
- `sametab` - The app will be launched in the current tab
|
|
- `newtab` - The app will be launched in a new tab
|
|
- `modal` - Launch app in a resizable/ movable popup modal on the current page
|
|
- `workspace` - Changes to Workspace view, and launches app
|
|
|
|
Even if the target is not set (or is set to `sametab`), you can still launch any given app in an alternative method: Alt + Click will open the modal, and Ctrl + Click will open in a new tab. You can also right-click on any item to see all options (as seen in the screenshot below). This custom context menu can be disabled by setting `appConfig.disableContextMenu: true`.
|
|
|
|
<p align="center">
|
|
<img width="500" src="https://i.ibb.co/vmZdSRt/dashy-context-menu-2.png" />
|
|
</p>
|
|
|
|
The modal and workspace views work by rendering the target application in an iframe. For this to work, the HTTP response header [`X-Frame-Options`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) for a given application needs to be set to `ALLOW`. If you are getting a `Refused to Connect` error then this header is set to `DENY` (or `SAMEORIGIN` and it's on a different host).
|
|
|
|
Here's a quick demo of the workspace view:
|
|
<p align="center">
|
|
<img alt="Workspace view demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/workspace-demo.gif" width="600" />
|
|
</p>
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Searching and Shortcuts 🔎
|
|
|
|
Quickly finding and launching applications is the primary aim of Dashy. To that end instant search and customizable keyboard shortcuts are built-in.
|
|
|
|
To start filtering, just start typing. No need to select the search bar or use any special key. You can then use either the tab key or arrow keys to select and move between results, and hit enter to launch the currently selected application. You can also use `Alt + Enter` on a selected app to launch it in a popup modal, `Ctrl + Enter` to open in new tab, or right-click on it to see all opening methods.
|
|
|
|
For 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, which is very useful for services you use frequently.
|
|
|
|
Example:
|
|
|
|
```yaml
|
|
- title: Bookstack
|
|
icon: far fa-books
|
|
url: https://bookstack.local/
|
|
hotkey: 8
|
|
```
|
|
|
|
Hit `Esc` at anytime to close any open apps, clear the search field, or hide any modals.
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Config Editor ⚙️
|
|
> For full config documentation, see: [**Configuring**](./docs/configuring.md)
|
|
|
|
From the Settings Menu in Dashy, you can download, backup, edit and rest your config. An interactive editor makes editing the config file easy, it will tell you if you've got any errors. After making your changes, you can either apply them locally, or export into your main config file. After saving to the config file to the disk, the app will be rebuilt automatically, you can also manually trigger a rebuild from the Settings Menu.
|
|
|
|
A full list of available config options can be found [here](./docs/configuring.md). It's recommend to make a backup of your configuration, as you can then restore it into a new instance of Dashy, without having to set it up again. [json2yaml](https://www.json2yaml.com/) is very useful for converting between YAML to JSON and visa versa.
|
|
|
|
<p align="center">
|
|
<img alt="Workspace view demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/config-editor-demo.gif" width="600" />
|
|
</p>
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Language Switching 🌎
|
|
> For full internationalization documentation, see: [**Multi-Language Support**](./docs/multi-language-support.md)
|
|
|
|
Dashy has the ability to support multiple languages and locales. When available, you're language should be automatically detected and applied on load, based on your browser or systems settings. But you can also select a language through the UI, under Config --> 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)).
|
|
|
|
#### Supported Languages
|
|
- 🇬🇧 **English**: `en`
|
|
- 🇩🇪 **German**: `de`
|
|
|
|
#### Add your Language
|
|
It would be awesome for open source projects to be available to everyone, without language being a barrier to entry for non-native English speakers. If you have a few minutes to sapir, you're help with translating it would be very much appreciated.
|
|
There's not too much text to cover, and it's all located in [a single JSON file](https://github.com/Lissy93/dashy/tree/master/src/assets/locales), and you don't have to translate it all, as any missing items will just fallback to English. For more info, see the [Adding a New Language Docs](./docs/multi-language-support.md#adding-a-new-language), and feel free to reach out if you need any support.
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Setting Dashboard Info 🌳
|
|
|
|
Page settings are defined under [`pageInfo`](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#pageinfo). Here you can set things like title, sub-title, navigation links, footer text, etc
|
|
|
|
- `title` - Your dashboard title, displayed in the header and browser tab
|
|
- `description` - Description of your dashboard, also displayed as a subtitle
|
|
- `logo` - The path to an image to display in the header (to the right of the title). This can be either local, where `/` is the root of `./public`, or any remote image, such as `https://i.ibb.co/yhbt6CY/dashy.png`
|
|
- `navLinks` - Optional list of a maximum of 6 links, which will be displayed in the navigation bar, see [`pageInfo.navLinks`](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#pageinfonavlinks-optional) for structure
|
|
- `footerText` - Text to display in the footer (note that this will override the default footer content). This can also include HTML and inline CSS
|
|
|
|
For example, a `pageInfo` section might look something like this:
|
|
|
|
```yaml
|
|
pageInfo:
|
|
title: Home Lab
|
|
description: Dashy
|
|
navLinks:
|
|
- title: Home
|
|
path: /
|
|
- title: Server Monitoring
|
|
path: https://server-start.local
|
|
- title: Start Page
|
|
path: https://start-page.local
|
|
footerText: 'My <b>Awesome</b> Dashboard. Built with <a href="https://dashy.to">Dashy</a>'
|
|
```
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Getting Help 🙋♀️
|
|
|
|
> For general discussions, check out the **[Discussions Board](https://github.com/Lissy93/dashy/discussions)**
|
|
|
|
If you're having trouble getting things up and running, feel free to ask a question. The best way to do so is in the [discussion](https://github.com/Lissy93/dashy/discussions), or if you think you think the issue is on Dashy's side, you can [raise a ticket](https://github.com/Lissy93/dashy/issues/new/choose). It's best to check the [docs](./docs) and [previous questions](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+) first, as you'll likley find the solution there.
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
## Raising Issues 🐛
|
|
|
|
Found a bug, or something that isn't working as you'd expect? Please raise it as an issue so that it can be resolved. Feature requests are also welcome. Similarlty, feedback is very useful, as it helps me know what areas of Dashy need some improvement.
|
|
|
|
- [Raise a Bug 🐛](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%90%9B+Bug&template=bug-report---.md&title=%5BBUG%5D)
|
|
- [Submit a Feature Request 🦄](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%A6%84+Feature+Request&template=feature-request---.md&title=%5BFEATURE_REQUEST%5D)
|
|
- [Share Feedback 🌈](https://github.com/Lissy93/dashy/issues/new?assignees=&labels=%F0%9F%8C%88+Feedback&template=share-feedback---.md&title=%5BFEEDBACK%5D)
|
|
|
|
**Issue Status** [  ](https://isitmaintained.com/project/lissy93/dashy)
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
## Supporting Dashy 💖
|
|
|
|
> For full details, and other ways you can help out, see: [**Contributing**](./docs/contributing.md)
|
|
|
|
If you're using Dashy, and would like to help support it's development, then that would be awesome! Contributions of any type, however small are always very much appreciated, and you will be appropriately credited for your effort.
|
|
|
|
Several areas that we need a bit of help with at the moment are:
|
|
- Adding translations - Help make Dashy available to non-native English speakers by adding text for you're language
|
|
- Donate a small amount, by [Sponsoring @Lissy93 on GitHub](https://github.com/sponsors/Lissy93) (only if you can afford to), and you'll also receive some extra perks!
|
|
- Community Engagement: Join the [discussion](https://github.com/Lissy93/dashy/discussions), and help answer other users questions, or spread the word by sharing Dashy online
|
|
- Share your dashboard in the [Showcase](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#dashy-showcase-), to help provide inspiration for others
|
|
- Submit a PR, to add a new feature, fix a bug, update the docs, add a theme or something else
|
|
|
|
[](https://github.com/sponsors/Lissy93)
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
## Credits 🏆
|
|
|
|
> For a full list of credits, and attributions to packages used within Dashy, see: [**Credits**](./docs/credits.md)
|
|
|
|
Thank you so much to everyone who has helped with Dashy so far, every contribution is very much appreciated.
|
|
|
|
#### Sponsors
|
|
|
|
Huge thanks to the sponsors helping to support Dashy's development!
|
|
<!-- sponsors --><!-- sponsors -->
|
|
|
|
#### Contributors
|
|
|
|
|
|
#### Packages
|
|
Dashy was made possible thanks to the following packages and components. For more details on each, see [Dependency Credits](./docs/credits.md#dependencies-). Full credit to their respective authors.
|
|
- Utils: [`crypto-js`](https://github.com/brix/crypto-js), [`axios`](https://github.com/axios/axios), [`ajv`](https://github.com/ajv-validator/ajv)
|
|
- Components: [`vue-select`](https://github.com/sagalbot/vue-select) by @sagalbot, [`vue-js-modal`](https://github.com/euvl/vue-js-modal) by @euvl, [`v-tooltip`](https://github.com/Akryum/v-tooltip) by @Akryum, [`vue-material-tabs`](https://github.com/jairoblatt/vue-material-tabs) by @jairoblatt, [`JsonEditor`](https://github.com/josdejong/jsoneditor) by @josdejong, [`vue-toasted`](https://github.com/shakee93/vue-toasted) by @shakee93
|
|
[`prism.js`](https://github.com/PrismJS/prism)
|
|
- Core: Vue.js, TypeScript, SCSS, Node.js, ESLint
|
|
- The backup & sync server uses [Cloudflare workers](https://workers.cloudflare.com/) plus [KV](https://developers.cloudflare.com/workers/runtime-apis/kv) and [web crypto](https://developers.cloudflare.com/workers/runtime-apis/web-crypto)
|
|
- Services: The 1-Click demo uses [Play-with-Docker Labs](https://play-with-docker.com/). Code is hosted on [GitHub](https://github.com), Docker image is hosted on [DockerHub](https://hub.docker.com/), and the demos are hosted on [Netlify](https://www.netlify.com/).
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
## Developing 🧱
|
|
|
|
> For full development documentation, see: [**Developing**](./docs/developing.md)
|
|
|
|
To set up the development environment:
|
|
1. Get Code: `git clone git@github.com:Lissy93/dashy.git` and `cd dashy`
|
|
2. Install dependencies: `yarn`
|
|
3. Start dev server: `yarn dev`
|
|
|
|
Hot reload is enabled, so changes will be automatically detected, compiled and refreshed.
|
|
|
|
Like most Git repos, we are following the [Github Flow](https://guides.github.com/introduction/flow) standard.
|
|
1. Create a branch (or fork if you're not a collaborator)
|
|
2. Code some awesome stuff, then add and commit your changes
|
|
3. Create a Pull Request, complete the checklist and ensure the build succeeds
|
|
4. Follow up with any reviews on your code
|
|
5. Merge 🎉
|
|
|
|
Branch names are specified in the following format: `[TYPE]/[TICKET]_[TITLE]`. E.g. `FEATURE/420_Awesome-feature` or `FIX/690_login-server-error`.
|
|
|
|
Most commits have been using git commit emojis, see [gitmoji.dev](https://gitmoji.dev/) for what each emoji indicates.
|
|
|
|
Before you submit your pull request, please ensure you've checked off all the boxes in the template. For your PR to be merged, it must:
|
|
- Must be backwards compatible
|
|
- The build, lint and tests (run by GH actions) must pass
|
|
- There must not be any merge conflicts
|
|
|
|
If 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
|
|
|
|
**Repo Status**:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
## Documentation 📘
|
|
> For full docs, see: **[Documentation Contents](./docs/readme.md)**
|
|
#### Running Dashy
|
|
- 🚀 [Deployment](/docs/deployment.md) - Getting Dashy up and running
|
|
- 🔧 [Configuring](/docs/configuring.md) - Complete list of all available options in the config file
|
|
- 💻 [Management](/docs/management.md) - Managing your app, updating, security, web server configuration, etc
|
|
- 🚒 [Troubleshooting](/docs/troubleshooting.md) - Common errors and problems, and how to fix them
|
|
|
|
#### Development and Contributing
|
|
- 🧱 [Developing](/docs/developing.md) - Running Dashy development server locally, and general workflow
|
|
- 🛎️ [Development Guides](/docs/development-guides.md) - Common development tasks, to help new contributors
|
|
- 💖 [Contributing](/docs/contributing.md) - How to contribute to Dashy
|
|
- 🌟 [Showcase](/docs/showcase.md) - See how others are using Dashy, and share your dashboard
|
|
- 🏆 [Credits](/docs/credits.md) - Shout out to the amazing people who have contributed so far
|
|
|
|
#### Feature Docs
|
|
- 🛡️ [Authentication](/docs/authentication.md) - Guide to setting up authentication to protect your dashboard
|
|
- 💾 [Backup & Restore](/docs/backup-restore.md) - Guide to Dashy's cloud sync feature
|
|
- 🚦 [Status Indicators](/docs/status-indicators.md) - Using Dashy to monitor uptime and status of your apps
|
|
- 🧸 [Icons](/docs/icons.md) - Outline of all available icon types for sections and items
|
|
- 🌐 [Language Switching](/docs/multi-language-support.md) - How to change language, add a language, or update text
|
|
- 🎨 [Theming](/docs/theming.md) - Complete guide to applying, writing and modifying themes and styles
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## 🛣️ Roadmap
|
|
|
|
> For past and future app updates, see: [**Changelog**](./docs/changelog.md)
|
|
|
|
|
|
The following features and tasks are planned for the near future.
|
|
- Widget support- cards showing live stats and interactive content from your self-hosted services
|
|
- UI Drag & Drop editor and visual configurator
|
|
- Conversion to TypeScript
|
|
- Improved test coverage
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
## Alternatives 🙌
|
|
|
|
There are a few self-hosted web apps, that 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!
|
|
[HomeDash2](https://lamarios.github.io/Homedash2), [Homer](https://github.com/bastienwirtz/homer) (`Apache License 2.0`), [Organizr](https://organizr.app/) (`GPL-3.0 License`) and [Heimdall](https://github.com/linuxserver/Heimdall) (`MIT License`)
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
## License 📜
|
|
|
|
Dashy is License under [MIT X11](https://en.wikipedia.org/wiki/MIT_License)
|
|
|
|
```
|
|
Copyright © 2021 Alicia Sykes <https://aliciasykes.com>
|
|
|
|
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
|
|
without restriction, including without limitation the rights to use, copy, modify, merge,
|
|
publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
|
persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all copies or
|
|
substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
|
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
|
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWAREOR THE USE
|
|
OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
Except as contained in this notice, Dashy shall not be used in advertising or otherwise
|
|
to promote the sale, use or other dealings in this Software without prior written
|
|
authorization from the repo owner.
|
|
```
|
|
|
|
**TDLR;** _You can do whatever you like with Dashy: use it in private or commercial settings,_
|
|
_redistribute and modify it. But you must display this license and credit the author._
|
|
_There is no warranty that this app will work as expected, and the author cannot be held_
|
|
_liable for anything that goes wrong._
|
|
For more info, see TLDR Legal's [Explanation of MIT](https://tldrlegal.com/license/mit-license)
|
|
|
|
[](https://app.fossa.com/projects/git%2Bgithub.com%2FLissy93%2Fdashy?ref=badge_large)
|
|
|
|
**[⬆️ Back to Top](#dashy)**
|
|
|
|
---
|
|
|
|
|
|
<p align="center">
|
|
Thank you for Visiting<br>
|
|
<a href="https://github.com/Lissy93/dashy">
|
|
<img src="https://github.githubassets.com/images/icons/emoji/octocat.png" />
|
|
</a>
|
|
</p>
|
|
|