mirror of
https://github.com/Lissy93/dashy.git
synced 2024-12-23 17:03:59 +03:00
🚀 A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
awesomedashboarddockerhacktoberfesthomelabhomepagemitnodejsorganizationproductivitypwaself-hostedstarred-lissy93-repostarred-repostartpagevue
public | ||
src | ||
.editorconfig | ||
.env | ||
.gitignore | ||
Dockerfile | ||
package.json | ||
README.md | ||
server.js | ||
vue.config.js | ||
yarn.lock |
Dashy
A static site linking to all running services for networking, management and monitoring
Features 🌈
- Instant search and full keyboard shortcuts
- Multiple color themes, layout options and item sizes all configurable and saved directly through the browser
- Quickly check a website, by holding down the Alt key while clicking, to open it in a resizable pop-up modal
- Instant search- just start typing to filter items, tab to cycle through, enter or Alt + enter to open, and Esc to clear
- Additional info for each item visible on hover (including opening method icon, description as a tooltip and domain info)
- Small bundle size and a fully responsive UI makes the app easy to use on any device
- Many options for icons, including full Font-Awesome support and the ability to auto-fetch icon from URLs favicon
- Plus lots more...
Running the App 🏃♂️
Deploying 🚀
- Get Code:
git clone git@github.com:Lissy93/dashy.git
andcd dashy
- Configuration: Fill in you're settings in
./public/conf.yml
- Install dependencies:
yarn
- Build:
yarn build
- Run:
yarn start
Deploying with Docker 🐳
- Get Code:
git clone git@github.com:Lissy93/dashy.git
andcd dashy
- Configuration: Fill in you're settings in
./public/conf.yml
- Build:
docker build -t lissy93/dashy .
- Start:
docker run -it -p 8080:80 --rm --name my-dashboard lissy93/dashy
Developing 🧱
- Get Code:
git clone git@github.com:Lissy93/dashy.git
andcd dashy
- Install dependencies:
yarn
- Start dev server:
yarn dev
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 custom icons for your items, then store these here. You can use sub-folders to keep things organised./public/logo.png
- Optionally add a logo image for you're website, which will show in the top left
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.
pageInfo
title
- String: The page title and headingdescription
- String: Short description visible under the heading
appConfig
(optional)
enableFontAwesome
- Boolean: Wheretrue
is enabled, if left blank font-awesome will be enabled only if required by 1 or more iconsfontAwesomeKey
- 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 loadcssThemes
- String[]: An array of theme names which can be used in the theme switcher dropdownexternalStyleSheet
- String or String[] - Either a URL to an external stylesheet or an array or URLs, which can be applied as themes within the UI
sections
- Section[]: (required) An array of sections - See section
below
section
name
- String: (required) The title of that sectionitems
- Item[]: (required) An array of items - Seeitem
belowdisplayData
: An object with the following fields (all optional)collapsed
- Boolean: If true, the section will be collapsed (defaults tofalse
)rows
- Int: Number of rows the section should span vertically, e.g. 2 (defaults to1
)cols
- Int: Number of columns the section should span horizontally, e.g. 2 (defaults to1
)color
- String: A custom background 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, eithersmall
,medium
orlarge
item
title
- String: The text to display on the itemdescription
- String: Additional info which is shown in the tooltip on hovericon
- String: Icons can be either a local image, remote image, or a Font Awesome icon, see below for more infourl
- 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, eithernewtab
,sametab
oriframe
color
- String: A custom background color the the item, as a hex code or HTML color (e.g.#fff
)
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/
or./public/my-category/item-icons
and specify the image asimage.png
ormy-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 thenfa-
and the icon name. For example:fas fa-rocket
,fab fa-monero
,fal fa-duck
orfad 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 underappConfig.fontAwesomeKey
.
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.