Skip to main content

Welcome to Dashy.NET

Dashy.NET is a self-hosted, personal dashboard application built entirely on the .NET platform. This project is a modern, performant .NET-based clone inspired by the original Dashy by Lissy93.

🚀 Key Features​

  • ✨ Customizable UI - Easily change layouts, item sizes, and themes directly from the user interface
  • 🎨 Theming - Beautiful dark and light themes out of the box
  • 🧩 Widget System - Display dynamic information with widgets like real-time clocks, weather forecasts, and more
  • 🔧 UI Editor - Configure everything directly through the UI with an intuitive editing experience
  • 🚀 Built with .NET - Modern, performant, and cross-platform backend and frontend powered by .NET and Blazor
  • ☁️ .NET Aspire Orchestration - Simplified development and deployment using .NET Aspire framework

Quick Start​

Ready to get started? Choose your preferred method:

🏠 Local Development​

For developers who want to run Dashy.NET locally or contribute to the project. → Go to Installation Guide

🐳 Docker Deployment​

The easiest way to get Dashy.NET running in production. → Go to Docker Guide

Kubernetes​

No offical documentation is planned for Dashy.NET. However you can use the official M$ documentation to guide you in the right direction; https://learn.microsoft.com/en-us/dotnet/aspire/deployment/overview#deploy-to-kubernetes

IAC Options​

🧙‍♂️ Azure Developer CLI​

AZD provides a really simple way to deploy aspire applications to azure. It generates the bicep code based on Dashy.NET.AppHost For guide on how to install the azd cli go to the offical M$ docs(covers Windows, Linux and Mac): https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd?tabs=winget-windows%2Cbrew-mac%2Cscript-linux&pivots=os-windows

For AZD we have 3 options in total where as 1 will be fully documented and the other two will mainly refer to the offical documentation.

Deploy Dashy.NET to azure with AZD (Option 1):​

  1. Clone the repo (git clone https://github.com/Zalmez/Dashy.NET.git or gh repo clone Zalmez/Dashy.NET)
  2. Navigate to the AppHost project folder: cd .\Dashy.Net.AppHost\
  3. Run the following command: dotnet run --project Dashy.Net.AppHost.csproj --output-path manifest.json --publisher manifest This builds the manifest AZD will basing the deployment of.
  4. Initalize the azd env: azd init the cli will ask you to name your environment. Take note that this will be the prefix of any resources created with azd
  5. Followed by azd up (⚠️NOTE:⚠️ Ensure you have signed in with an azure/entra id account that has contributor or owner access on a subscription as you will be prompted to select a subscription where the resources will be deployed)

Deploy using github actions (Option 2)​

You can also fork the repo and have Dashy.NET be deployed with github actions. Please refer to the offical documentation on how you can do that

Deploy using bicep generated by AZD (Option 3):​

  1. Clone the repo (git clone https://github.com/Zalmez/Dashy.NET.git or gh repo clone Zalmez/Dashy.NET)
  2. Navigate to the AppHost project folder: cd .\Dashy.Net.AppHost\
  3. Run the following command: dotnet run --project Dashy.Net.AppHost.csproj --output-path manifest.json --publisher manifest This builds the manifest AZD will basing the deployment of.
  4. Generate the bicep code by running azd infra gen

Terraform (Azure) Terraform Deployment​

Documentation planned, not yet created

⚙️ Configuration​

Learn how to customize your dashboard and add your services. → Go to Configuration Guide

What You'll Need​

  • .NET 9 SDK for local development
  • Docker for containerized deployment (recommended)

License​

Dashy.NET is free and open-source software licensed under the GNU AGPLv3. This ensures that the project and any derivatives will always remain free and open for the community to use, modify, and contribute to.