Lissy93/dashy
1
1
Fork 0
mirror of https://github.com/Lissy93/dashy.git synced 2024-12-26 02:14:27 +03:00
Code Issues Packages Projects Releases Wiki Activity
2792c83358
dashy/README.md
Alicia Sykes fca9162f02 Adds option for a section to have an icon
2021-06-02 19:06:28 +01:00

14 KiB
Raw Blame History

Dashy

Dashy helps you organise your self-hosted services, by making them all accessible from a single place

Features 🌈

  • Instant search by name, domain and tags - just start typing
  • Full keyboard shortcuts for navigation, searching and launching
  • Multiple color themes, with easy method for adding more
  • Customizable layout options, and item sizes
  • Quickly preview a website, by holding down the Alt key while clicking, to open it in a resizable pop-up modal
  • Many options for icons, including full Font-Awesome support and the ability to auto-fetch icon from URLs favicon
  • Additional info for each item visible on hover (including opening method icon and description as a tooltip)
  • Option for full-screen background image, custom nav-bar links, and custom footer text
  • User settings stored in local storage and applied on load
  • Encrypted cloud backup and restore feature available
  • Easy single-file YAML-based configuration
  • Small bundle size, fully responsive UI and PWA makes the app easy to use on any device
  • Plus lots more...

Live Demos: Demo 1 ┆ Demo 2 ┆ Demo 3

Screenshots Screenshots

Recording

Demo

More themes and screens

Running the App 🏃‍♂️

Deploying 🚀

  • 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

Deploying with Docker from Source 🛳️

  • Get Code: git clone git@github.com:Lissy93/dashy.git and cd dashy
  • Configuration: Fill in you're settings in ./public/conf.yml
  • Build: docker build -t lissy93/dashy .
  • Start: docker run -p 8080:80 --name my-dashboard lissy93/dashy

Deploying from Docker Hub 🐳

  • Get the Image: docker pull lissy93/dashy
  • Start the Container: docker run -d -p 8080:80 --name my-dashboard lissy93/dashy

Developing 🧱

  • Get Code: git clone git@github.com:Lissy93/dashy.git and cd dashy
  • Install dependencies: yarn
  • Start dev server: yarn dev

Note that although recommended, it is not required to use the conf.yml file- all settings can be specified through the UI, and backed up on the cloud.

Configuring 🔧

Config Locations 📍

Configuration files are located in ./public/.

  • ./public/conf.yml - This is the main site configuration file, and is required for the app to work
  • ./public/item-icons - If you're using your own icons, you can choose to store them locally for better load time. You can also use sub-folders to keep things organized

Also within ./public you'll find normal website assets, including favicon.ico, manifest.json, robots.txt and web-icons/*. There's no need to modify these, but you can do so if you wish.

The Conf File 📄

All app config is specified in /public/conf.yml (in YAML Format). All fields are optional, unless otherwise stated.

Example Configs: https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10

pageInfo

  • title - String: The page title and heading
  • description - String: Short description visible under the heading
  • navLinks - Array: Links to display in the nav bar, an array or objects containing a title and link:
    • title - String: Text to display
    • path - String: URL or relative link
  • footerText - String: Text to display in the footer

appConfig (optional)

  • backgroundImg - String: Path to an optional full-screen app background image. This can be either remote (http) or local (/). Note that this will slow down initial load
  • enableFontAwesome - Boolean: Where true is enabled, if left blank font-awesome will be enabled only if required by 1 or more icons
  • fontAwesomeKey - String: If you have a font-awesome key, then you can use it here and make use of premium icons. It is a 10-digit alpha-numeric string from you're FA kit URL (e.g. 13014ae648)
  • theme- String: The default theme for first load (you can change this later from the UI)
  • cssThemes - String[]: An array of custom theme names which can be used in the theme switcher dropdown - See theming below
  • externalStyleSheet - String or String[] - Either a URL to an external stylesheet or an array or URLs, which can be applied as themes within the UI
  • customCss - String: Raw CSS that will be applied to the page. Please minify it first.

sections - Section[]: (required) An array of sections - See section below

section

  • name - String: (required) The title of that section
  • items - Item[]: (required) An array of items - See item below
  • icon - String: (optional) An single icon to be displayed next to the title See icon below
  • displayData: An object with the following fields (all optional)
    • collapsed - Boolean: If true, the section will be collapsed initially (defaults to false)
    • color - String: A custom accent color for the section, as a hex code or HTML color (e.g. #fff)
    • customStyles - String: Custom CSS properties that should be applied to that section, e.g. border: 2px dashed #ff0000;
    • itemSize - String: Specify the size for items within this group, either small, medium or large
    • rows - Int: Number of rows the section should span vertically, e.g. 2 (defaults to 1)
    • cols - Int: Number of columns the section should span horizontally, e.g. 2 (defaults to 1)
    • layout - Enum: auto or grid. If grid is selected, then the number of items per row can be set
    • itemCountX - Int: Number of items horizontally (for layout: grid)
    • itemCountY - Int: Number of items vertically (for layout: grid)

Note about rows and cols: These are defined as a proportion of the screen (rather than by number of child items), and is built using grid-layout. For more info, see this example. In order to set the number of items that will display horizontally or vertically within a section, first set display: grid, and then specify values for itemCountX, and optionally itemCountY.

item

  • title - String: The text to display on the item
  • description - String: Additional info which is shown in the tooltip on hover
  • icon - String: Icons can be either a local image, remote image, or a Font Awesome icon, see below for more info
  • url - String: The full path to be opened on click (e.g. https://example.com)
  • target - String: The method in which the item will be opened, either newtab, sametab or iframe
  • color - String: A custom color the the item, as a hex code or HTML color (e.g. #fff)
  • backgroundColor - String: A custom fill color for the the item's background, also as a hex code

icon Examples:

  • To use use a remote image, just use it's full URL, e.g. https://i.ibb.co/710B3Yc/space-invader-x256.png
  • To use a local image, save it in ./public/item-icons/image.png or ./public/my-category/item-icons/image.png and specify the image as image.png or my-category/image.png. For best results, use either png or svg formats.
  • To automatically fetch an icon from items URL, just set icon field to favicon
  • To use a Font-Awesome icon, specify the category (fas, fab, far, fal orfad), followed by a space then fa- and the icon name. For example: fas fa-rocket, fab fa-monero, fal fa-duck or fad fa-glass-whiskey-rocks. Note that light (fal) and duotone (fad) icons are only available with Font Awesome Pro, to use this, you need to set you're kit ID under appConfig.fontAwesomeKey.

Theming 🎨

The app comes with a number of built-in themes, but it's also easy to write you're own. Once you've done so you can select you're theme fro the dropdown menu, and like other visual settings, you're chosen theme is saved in local storage, so will load automatically when you next visit the page.

The theme switching is done by simply changing the data-theme attribute on the root DOM element, which can then be targeted by CSS. First off, in order for the theme to show up in the theme switcher, it needs to be added to the config file, under appConfig.cssThemes, either as a string, or an array of strings for multiple themes. For example:

appConfig:
  cssThemes: ['tiger', 'another-theme']

You can now create a block to target you're theme with html[data-theme='my-theme']{} and set some styles. The easiest method is by setting CSS variables, but you can also directly override elements by their selector. As an example, see the built-in CSS themes.

html[data-theme='tiger'] {
  --primary: #f58233;
  --item-group-background: #0b1021;
}

Alternatively, you can load an external stylesheet. Pass either a URL to a .css file, or an array or URLs to appConfig.externalStyleSheet. The stylesheet will then be pre-loaded, and can then be enabled from the UI using the theme switcher.

appConfig:
  externalStyleSheet: 'https://example.com/my-stylesheet.css'

Notes

Roadmap 🛣

  • Allow users to import / export configuration through the UI
  • Improve deployment process (with a one-liner Docker run command)
  • Add support for custom widgets
  • Convert JavaScript to TypeScript

Alternatives 🙌

There are a few self-hosted web apps, that serve a similar purpose to Dashy. Including, but not limited to: HomeDash2, Homer (Apache License 2.0), Organizr (GPL-3.0 License) and Heimdall (MIT License).

Credits 🏆

This wouldn't have been quite so possible without the following components, kudos to their respective authors

Utils:

  • crypto-js - Encryption implementations by @evanvosberg and community MIT
  • axios - Promise based HTTP client by @mzabriskie and community MIT

And the app itself is built with Vue.js vue-logo

Although the app is purely frontend, there is an optional cloud backup and restore feature. This is built as a serverless function on Cloudflare workers using KV and web crypto

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.

Dashy - A feature-rich dashboard for your homelab 🚀 | Product Hunt