9.0 KiB

Raw Blame History

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

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 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
📊 Widgets for displaying info and dynamic content from your self-hosted services
💂 Optional authentication with multi-user access, configurable privileges, and SSO support
🌎 Multi-language support, with 10+ human-translated languages, and more on the way
☁ Optional, encrypted, free off-site cloud backup and restore feature available
💼 A workspace view, for easily switching between multiple apps simultaneously
🛩️ A minimal view, for use as a fast-loading browser Startpage
🖱️ Choose app launch method, either new tab, same tab, a pop-up modal, or in the workspace view
📏 Customizable layout, sizes, text, component visibility, sort order, behavior, etc.
🖼️ Options for a full-screen background image, custom nav-bar links, HTML footer, title, etc.
🚀 Easy to setup with Docker, or on bare metal, or with 1-Click cloud deployment
⚙️ Easy configuration, either through the UI, or using a YAML file
✨ Under active development with improvements and new features added regularly
🤏 Small bundle size, fully responsive UI, and PWA for basic offline access
🆓 100% free and open-source
🔐 Strong focus on privacy
🌈 And loads more...

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: or docker run -p 8080:8080 lissy93/dashy

Demo

⬆️ Back to Top

Getting Started 🛫

To deploy Dashy with Docker, just run docker run -p 8080:8080 lissy93/dashy, then open http://localhost:8080

For full list of options and a Docker compose file, see the Deployment Docs.

Dashy can also be run on bare metal using Node.js, or deployed to a cloud service, using the 1-Click deploy script.

Documentation 📝

Running Dashy

Quick Start - TDLR guide on getting Dashy up and running
Deployment - Full guide on deploying Dashy either locally or online
Configuring - Complete list of all available options in the config file
App Management - Managing your app, updating, security, web server configuration, etc
Troubleshooting - Common errors and problems, and how to fix them

Feature Docs

Authentication - Guide to setting up authentication to protect your dashboard
Alternate Views - Outline of available pages / views and item opening methods
Backup & Restore - Guide to backing up config with Dashy's cloud sync feature
Icons - Outline of all available icon types for sections and items, with examples
Language Switching - Details on how to switch language, or add a new locale
Status Indicators - Using Dashy to monitor uptime and status of your apps
Searching & Shortcuts - Searching, launching methods + keyboard shortcuts
Theming - Complete guide to applying, writing and modifying themes + styles
Widgets - List of all dynamic content widgets, with usage guides and examples

Development and Contributing

Developing - Running Dashy development server locally, and general workflow
Development Guides - Common development tasks, to help new contributors
Contributing - How you can help keep Dashy alive
Showcase - See how others are using Dashy, and share your dashboard
Credits - List of people and projects that have made Dashy possible
Release Workflow - Info about releases, CI and automated tasks

License 📜

Dashy is Licensed under MIT X11

Copyright © 2024 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.

9.0 KiB Raw Blame History