README

Dashy

  The most customizable dashboard for self-hosters
  Dashy is the homepage for your homelab
   
  
  
  User Showcase | Live Demo | Getting Started | Documentation | GitHub


Kindly sponsored by


  
    
      
        
        Umbrel
      
      Personal home cloud and OS for self-hosting
    
    
      
        
        TestMu AI
      
      Full-stack Agentic AI Quality Engineering platform
    
  



  Table of Contents
  
  
- Getting Started
  - 🌈 Features
  - ⚡ Demo
  - 🚀 Getting Started
  - 🔧 Configuring
- Feature Overview
  - 🎨 Theming
  - 🧸 Icons
  - 🚦 Status Indicators
  - 📊 Widgets
  - 🔐 Authentication
  - 👓 Alternate Views
  - 🖱️ Opening Methods
  - 🔎 Searching and Shortcuts
  - ⚙️ Config Editor
  - ☁ Cloud Backup & Sync
  - 🌎 Language Switching
  - 📃 Multi-Page Support
- Community
  - 📊 System Requirements
  - 🙋‍♀️ Support
  - 💖 Supporting Dashy
  - 🏆 Credits
  - 🧱 Developing
  - 📘 Documentation
  - 🙌 Alternatives
  - 📜 License
    
  


 Features 🌈
- 📃 Support for multiple pages
- 🚦 Real-time status monitoring for each of your apps/links/hosts
- 📊 Use widgets to display info and dynamic content from self-hosted services
- 🔎 Instant search by name, domain, or tags + customizable hotkeys & keyboard shortcuts
- 🎨 Many 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.
- 💂 Optional authentication with multi-user access, configurable privileges, and SSO support
- 🌎 Multi-language support, with 30+ 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 methods: new tab, same tab, clipboard, pop-up modal, or open in 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 single-file YAML-based configuration, and option to configure app through the UI
- ✨ 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...

⬆️ Back to Top

 Demo ⚡

Live Instances: ~~Demo (Live Demo)~~ ┆ Dev Preview (Dev Preview)

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

Try it yourself: docker run -p 8080:8080 lissy93/dashy



  



⬆️ Back to Top

---

 Getting Started 🚀

 For full setup instructions, see: Deployment

 Deploying from Docker Hub 🐳

You will need Docker installed on your system

bash
docker run -p 4000:8080 lissy93/dashy


Or

bash
docker run -d

Top issues

Discussions

Latest release

What's Changed

 ✨ New Features
 Add option to open workspace sidebar items in new tab by @sebastianruff in https://github.com/lissy93/dashy/pull/2363
 Shiny new workspace view by @lissy93 in https://github.com/lissy93/dashy/pull/2404

 🦋 Bug Fixes
 Fix config files being readable without login via encoded URLs by @lissy93 in https://github.com/lissy93/dashy/pull/2387
 Fix Firefix col counting, and rss in sample config by @lissy93 in https://github.com/lissy93/dashy/pull/2405

 🎨 Themes and Styling
 feat(theme): add liquid-glass built-in theme by @KeuqS in https://github.com/lissy93