search

andrewmkrug / dashy

MIT License
0 stars 0 forks source link

readme

Dashy

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

User Showcase | Live Demo | Getting Started | Documentation | GitHub

Awesome Self-Hosted License MIT Current Version Docker Pulls GitHub Status Known Vulnerabilities

Table of Contents

- **Getting Started** - [🌈 Features](#features-) - [⚡Demo](#demo-) - [🚀 Getting Started](#getting-started-) - [🔧 Configuring](#configuring-) - **Feature Overview** - [🎨 Theming](#theming-) - [🧸 Icons](#icons-) - [🚦 Status Indicators](#status-indicators-) - [📊 Widgets](#widgets-) - [🔐 Authentication](#authentication-) - [👓 Alternate Views](#alternate-views-) - [🖱️ Opening Methods](#opening-methods-) - [🔎 Searching and Shortcuts](#searching-and-shortcuts-) - [⚙️ Config Editor](#config-editor-) - [☁ Cloud Backup & Sync](#cloud-backup--sync-) - [🌎 Language Switching](#language-switching-) - [📃 Multi-Page Support](#multi-page-support-) - **Community** - [📊 System Requirements](#system-requirements-) - [🙋‍♀️ Support](#support-) - [💖 Supporting Dashy](#supporting-dashy-) - [🏆 Credits](#credits-) - [🧱 Developing](#developing-) - [🗞️ Release Schedule](#release-schedule-) - [📘 Documentation](#documentation-) - [🛣️ Roadmap](#roadmap-) - [🙌 Alternatives](#alternatives-) - [📜 License](#license-)

Features 🌈

⬆️ Back to Top

Demo ⚡

Live Instances: Demo 1 (Live Demo) ┆ Demo 2 (Dashy Links) ┆ Demo 3 (Dev Preview)

Screenshots: Checkout the Showcase, to see example dashboards from the community

Spin up your own demo: One-Click Deploy with PWD or docker run -p 8080:80 lissy93/dashy

Demo

⬆️ Back to Top

Getting Started 🚀

For full setup instructions, see: Deployment

Deploying from Docker Hub 🐳

You will need Docker installed on your system

docker run -p 8080:80 lissy93/dashy

Or

docker run -d \
  -p 4000:80 \
  -v /root/my-local-conf.yml:/app/public/conf.yml \
  --name my-dashboard \
  --restart=always \
  lissy93/dashy:latest

Dashy on Docker Hub

See also: examples with 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 for info on using health checks, updating, backups, web-server configs, logs, performance, security, and more.

Deploying from Source 🔨

You will need git, the latest or LTS version of Node.js and (optionally) Yarn installed on your system.

See docs: Full list of Dashy's 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:

For more 1-click cloud deployments, see Cloud Deployment

⬆️ Back to Top

Configuring 🔧

For full configuration documentation, see: Configuring

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. The config can also be edited and saved directly through the UI.

⬆️ Back to Top

Theming 🎨

For full theming documentation, see: Theming

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.

Example Themes

Example Themes

⬆️ Back to Top

Icons 🧸

For full iconography documentation, see: Icons

Both 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.

The following icon types are supported:

⬆️ Back to Top

Status Indicators 🚦

For full monitoring documentation, see: Status Indicators

Dashy 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.

Status 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.

Status Checks demo

⬆️ Back to Top

Widgets 📊

For full widget documentation, see: Widgets

You 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.

⬆️ Back to Top

Authentication 🔐

For full authentication documentation, see: Authentication

Dashy has full support for secure single-sign-on using Keycloak for secure, easy authentication, see setup docs for a full usage guide.

There 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.

appConfig:
  auth:
    users:
    - user: alicia
      hash: 4D1E58C90B3B94BCAD9848ECCACD6D2A8C9FBC5CA913304BBA5CDEAB36FEEFA3
      type: admin

Other access control systems are also supported, see the Alternative Auth Methods docs.

⬆️ Back to Top

Alternate Views 👓

As well as the default homepage, there is also:

You 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.

Example of Workspace View
Workspace view demo

Example of Minimal View
Workspace view demo

⬆️ Back to Top

Opening Methods 🖱️

For full documentation on views and opening methods, see: Alternate Views

There 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:

⬆️ Back to Top

Searching and Shortcuts 🔎

For full documentation on searching, see: Searching & 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, 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.

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.

You 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'

  items:
  - title: Plex
    hotkey: 8
    icon: favicon
    description: Media library
    url: https://plex.lab.local
    tags: [ movies, videos, music ]

To 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, or use your own custom provider 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 :).

webSearch:
  searchEngine: duckduckgo
  openingMethod: newtab
  searchBangs:
    /r: reddit
    /w: wikipedia
    /s: https://whoogle.local/search?q=
    ':wolf': wolframalpha
    ':so': stackoverflow
    ':git': github

Hit Esc at any time to close any open apps, clear the search field, or hide any modals.

⬆️ Back to Top

Config Editor ⚙️

For full config documentation, see: Configuring

As well as passing in a YAML config file, you can also configure the app directly through the UI and preview changes live.

To 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".

Under 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.

Interactive Editor demo

Config Editor demo

⬆️ Back to Top

Cloud Backup & Sync ☁

For full backup documentation, see: Cloud Backup & Sync

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 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.

All data is fully E2E encrypted before being sent to the backend (done in CloudBackup.js using crypto.js 's AES method). The data is then sent to a Cloudflare worker and stored in a KV data store.

⬆️ Back to Top

Language Switching 🌎

For full internationalization documentation, see: Multi-Language Support

Dashy 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 --> Switch Language) or set appConfig.language to your language (specified as a 2-digit ISO 639-1 code).

Supported Languages

Add your Language

I 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. Since any missing text will fall back to English, you don't need to translate it all.

⬆️ Back to Top

Multi-Page Support 📃

For full multi-page documentation, see: Pages & Sections

Within 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).

pages:
- name: Networking Services
  path: 'networking.yml'
- name: Work Stuff
  path: 'work.yml'

Or

pages:
- name: Getting Started
  path: 'https://snippet.host/tvcw/raw'
- name: Homelab
  path: 'https://snippet.host/tetp/raw'
- name: Browser Startpage
  path: 'https://snippet.host/zcom/raw'

System Requirements 📊

If running on bare metal, Dashy requires Node V 16.0.0 or later, LTS (16.13.2) is recommended.

If running in Docker container, the recommended base image is Alpine (3.15)

The 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.

If 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.

Dashy also wells run on low-powered ARM-based single board computers, such as a Raspberry Pi (tested on Pi 3)

Browser Support Chrome Firefox IE Opera Safari
Latest ✔ Latest ✔ 10+ ✔ Latest ✔ 6.1+ ❌

⬆️ Back to Top

Support 🙋‍♀️

If 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.

If you've found something which isn't working as it should, please raise a bug by opening a ticket.

It's best to check the docs, previous issues and troubleshooting guide first.

⬆️ Back to Top

Supporting Dashy 💖

For full details and other ways you can help out, see: Contributing

If 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.

Several areas that we need a bit of help with at the moment are:

Sponsor Lissy93 on GitHub

⬆️ Back to Top

Credits 🏆

For a complete list of credits, and attributions to packages used within Dashy, see: Credits

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!

Contributors

Auto-generated contributors

⬆️ Back to Top

Developing 🧱

For full development documentation, see: Developing

Open Project in VS Code Open in GitPod Open in GitHub Code Spaces

Before getting started, you'll need Git, Node and optionally Yarn (run npm i -g yarn) installed.

To set up the development environment:

  1. Get Code: git clone https://github.com/Lissy93/dashy.git and cd dashy
  2. Install dependencies: yarn
  3. Start dev server: yarn dev
  4. Open the browser: http://localhost:8080

When you're ready, you can build the production app with yarn build, and then run it with yarn start

If you're new to web development, I've put together a short list of resources to help beginners get started

Repo Status: Open PRs Total PRs GitHub commit activity Last Commit Contributors

⬆️ Back to Top

Documentation 📘

For full docs, see: Documentation Contents

Running Dashy

  • 💨 Quick Start - TDLR guide on getting Dashy up and running in under 5 minutes
  • 🚀 Deployment - Full guide on setting up Dashy on various different environments
  • 🔧 Configuring - Complete list of all available options in the config file
  • 💻 Management - Managing your app, updating, security, web server configuration, etc
  • 🚒 Troubleshooting - Common errors and problems, and how to fix them

Feature Docs

Development and Contributing

Misc

⬆️ Back to Top

Roadmap 🛣️

For upcoming features that will be released in the near future, see the Current Roadmap

For past updates, see the Changelog

⬆️ Back to Top

Alternatives 🙌

A 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!

⬆️ Back to Top

License 📜

Dashy is Licensed under MIT X11

Copyright © 2021-2022 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 SOFTWARE OR 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

FOSSA Status

⬆️ Back to Top






Thank you for Visiting