mirror of
https://github.com/Lissy93/dashy.git
synced 2026-03-17 18:22:28 +01:00
102 lines
No EOL
44 KiB
HTML
102 lines
No EOL
44 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-contributing" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">Contributing | Dashy</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="dashy, dashboard, homelab, self-hosted, docker, homepage"><meta data-rh="true" property="og:type" content="website"><meta data-rh="true" property="og:url" content="https://dashy.to"><meta data-rh="true" property="og:image" content="https://dashy.to/img/dashy.png"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" name="twitter:title" content="Dashy — The Ultimate Homepage for your Homelab"><meta data-rh="true" name="twitter:description" content="Dashy is a self-hosted dashboard app for your homelab. Manage all your services, with status checks, widgets, themes and more."><meta data-rh="true" name="twitter:image" content="https://dashy.to/img/dashy.png"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Contributing | Dashy"><meta data-rh="true" name="description" content="First off, thank you for considering contributing towards Dashy! 🙌"><meta data-rh="true" property="og:description" content="First off, thank you for considering contributing towards Dashy! 🙌"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://dashy.to/docs/contributing"><link data-rh="true" rel="alternate" href="https://dashy.to/docs/contributing" hreflang="en"><link data-rh="true" rel="alternate" href="https://dashy.to/docs/contributing" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Contributing","item":"https://dashy.to/docs/contributing"}]}</script><link rel="preconnect" href="https://pixelflare.cc">
|
||
<link rel="preconnect" href="https://cdn.as93.net">
|
||
<link rel="dns-prefetch" href="https://api.github.com">
|
||
<link rel="dns-prefetch" href="https://no-track.as93.net">
|
||
<script type="application/ld+json">{"@context":"https://schema.org","@type":"WebSite","name":"Dashy","url":"https://dashy.to","description":"The Ultimate Homepage for your Homelab","publisher":{"@type":"Person","name":"Alicia Sykes","url":"https://aliciasykes.com"}}</script>
|
||
<link rel="manifest" href="/manifest.json">
|
||
<meta name="theme-color" content="#54bff7">
|
||
<script src="https://no-track.as93.net/js/script.js" defer="defer" data-domain="dashy.to"></script><link rel="stylesheet" href="/assets/css/styles.643115f2.css">
|
||
<script src="/assets/js/runtime~main.e7aa91cf.js" defer="defer"></script>
|
||
<script src="/assets/js/main.c9f7c5e0.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div class="banner_woPo"><a class="link_ecgS" title="View the changelog, to see what's new!" href="/updates">Dashy <!-- -->V3.1.9<!-- --> is now live 🚀</a><a class="link2_y3x6" title="View the changelog, to see what's new!" href="/updates">See what's new…</a><button class="closeBtn_fC0A" title="Dismiss update, and don't show again" aria-label="Dismiss update, and don't show again">×</button></div><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/dashy.png" alt="Dashy Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/dashy.png" alt="Dashy Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Dashy</b></a><a href="https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><a href="https://demo.dashy.to" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Live Demo<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><a class="navbar__item navbar__link" href="/docs/quick-start">Quick Start</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs">Documentation</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><div class="navbar__search searchBarContainer_NW3z" dir="ltr"><input placeholder="Search" aria-label="Search" class="navbar__search-input searchInput_YFbd" value=""><div class="loadingRing_RJI3 searchBarLoadingRing_YnHq"><div></div><div></div><div></div><div></div></div></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/quick-start"><span title="Running Dashy" class="categoryLinkLabel_W154">Running Dashy</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/icons"><span title="Feature Docs" class="categoryLinkLabel_W154">Feature Docs</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/docs/showcase"><span title="Community" class="categoryLinkLabel_W154">Community</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/showcase"><span title="*Dashy Showcase* 🌟" class="linkLabel_WmDU">*Dashy Showcase* 🌟</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/contributing"><span title="Contributing" class="linkLabel_WmDU">Contributing</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/developing"><span title="Developing" class="linkLabel_WmDU">Developing</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/development-guides"><span title="Development Guides" class="linkLabel_WmDU">Development Guides</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/privacy"><span title="Misc" class="categoryLinkLabel_W154">Misc</span></a></div></li></ul></nav></div><div class="sidebar-ad"><script async="" src="//cdn.carbonads.com/carbon.js?serve=CWYIC53L&placement=dashyto" id="_carbonads_js"></script></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Community</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Contributing</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Contributing</h1></header>
|
||
<p>First off, thank you for considering contributing towards Dashy! 🙌
|
||
There are several ways that you can help out, and any contributions, however small will always be very much appreciated.
|
||
You will be appropriately credited in the readme - huge thank you to <a class="" href="/docs/credits">everyone who has helped</a> so far 💞</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="take-a-2-minute-survey">Take a 2-minute survey<a href="#take-a-2-minute-survey" class="hash-link" aria-label="Direct link to Take a 2-minute survey" title="Direct link to Take a 2-minute survey" translate="no"></a></h2>
|
||
<p>Help improve Dashy by taking a very short, 6-question survey. This will give me a better understanding of what is important to you, so that I can make Dashy better in the future :)</p>
|
||
<p><a href="https://survey.typeform.com/to/gl0L68ou" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Take_the-Survey-%231a86fd?style=for-the-badge&logo=buddy" alt="Take the Survey" class="img_ev3q"></a></p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="share-your-dashboard">Share your dashboard<a href="#share-your-dashboard" class="hash-link" aria-label="Direct link to Share your dashboard" title="Direct link to Share your dashboard" translate="no"></a></h2>
|
||
<p>Dashy now has a <a class="" href="/docs/showcase#dashy-showcase-">Showcase</a> where you can show off a screenshot of your dashboard, and get inspiration from other users (and I really love seeing how people are using Dashy). To <a class="" href="/docs/showcase#submitting-your-dashboard">submit your dashboard</a>, either open a PR or raise an issue.</p>
|
||
<p><a href="https://github.com/Lissy93/dashy/issues/new?assignees=&labels=%F0%9F%92%AF+Showcase&template=showcase-addition.yml&title=%5BSHOWCASE%5D+%3Ctitle%3E" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Add_your_Dashboard-Showcase-%238616ee?style=for-the-badge&logo=feathub&logoColor=8616ee" alt="Add your Dashboard to the Showcase" class="img_ev3q"></a></p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="make-a-small-donation">Make a small donation<a href="#make-a-small-donation" class="hash-link" aria-label="Direct link to Make a small donation" title="Direct link to Make a small donation" translate="no"></a></h2>
|
||
<p>Donations help to cover server costs, development time and caffeine ;)
|
||
Don't feel any pressure to donate anything, as Dashy and my other projects will always be 100% free, for everyone, for ever.</p>
|
||
<p><a href="https://github.com/sponsors/Lissy93" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Sponsor_on_GitHub-Lissy93-%23ff4dda?style=for-the-badge&logo=githubsponsors&logoColor=ff4dda" alt="Sponsor Lissy93 on GitHub" class="img_ev3q"></a></p>
|
||
<p>Sponsoring will give you several perks - for $1 / £0.75 per month, you'll get a sponsor badge on your profile, be credited on the Dashy's readme, with a link to your website/ profile/ socials, get priority support, have your feature ideas implemented, plus lots more. For more info, see <a href="https://github.com/sponsors/Lissy93" target="_blank" rel="noopener noreferrer" class="">@Lissy93's Sponsor Page</a>.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="you-can-also-send-a-one-off-small-contribution-using-crypto">You can also send a one-off small contribution using crypto<a href="#you-can-also-send-a-one-off-small-contribution-using-crypto" class="hash-link" aria-label="Direct link to You can also send a one-off small contribution using crypto" title="Direct link to You can also send a one-off small contribution using crypto" translate="no"></a></h3>
|
||
<p><a href="https://en.cryptobadges.io/donate/3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://en.cryptobadges.io/badge/big/3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC" alt="Donate with BTC" class="img_ev3q"></a><a href="https://en.cryptobadges.io/donate/0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://en.cryptobadges.io/badge/big/0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017" alt="Donate with Ethereum" class="img_ev3q"></a></p>
|
||
<ul>
|
||
<li class=""><strong>BTC</strong>: <code>3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC</code></li>
|
||
<li class=""><strong>ETH</strong>: <code>0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017</code> / <code>aliciasykes.eth</code></li>
|
||
<li class=""><strong>XMR</strong>: <code>471KZdxb6N63aABR4WYwMRjTVkc1p1x7wGsUTEF7AMYzL8L94A5pCuYWkosgJQ5Ze8Y2PscVCGZFJa3hDPg6MaDq47GUm8r</code></li>
|
||
<li class=""><strong>LTC</strong>: <code>MAuck6Ea1qaNihwKfXutkR1R6BorMth86H</code></li>
|
||
<li class=""><strong>ZEC</strong>: <code>t1bw1SefijsXRDQVxC9w64XsRK8hBhtQohQ</code></li>
|
||
</ul>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="enable-anonymous-bug-reports">Enable Anonymous Bug Reports<a href="#enable-anonymous-bug-reports" class="hash-link" aria-label="Direct link to Enable Anonymous Bug Reports" title="Direct link to Enable Anonymous Bug Reports" translate="no"></a></h2>
|
||
<p>Bug reports helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. This is a simple, yet really helpful step you can take to help improve Dashy. <a href="https://github.com/getsentry/sentry" target="_blank" rel="noopener noreferrer" class="">Sentry</a> is an open source error tracking and performance monitoring tool, which enables the identification any errors which occur in the production app (only if you enable it).</p>
|
||
<p>To enable error reporting:</p>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token key atrule">appConfig</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">enableErrorReporting</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> </span><span class="token boolean important">true</span><br></span></code></pre></div></div>
|
||
<p>All reporting is <strong>disabled</strong> by default, and no data will ever be sent to any external endpoint without your explicit consent. All statistics are anonymized and stored securely. For more about privacy and security, see the <a href="https://sentry.io/security/" target="_blank" rel="noopener noreferrer" class="">Sentry Security Docs</a>.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="add-translations">Add Translations<a href="#add-translations" class="hash-link" aria-label="Direct link to Add Translations" title="Direct link to Add Translations" translate="no"></a></h2>
|
||
<p>If you speak another language, then adding translations will help make Dashy available to non-native English speakers. This is a very quick and easy task, as all application text is located in <a href="https://github.com/Lissy93/dashy/blob/master/src/assets/locales/en.json" target="_blank" rel="noopener noreferrer" class=""><code>locales/en.json</code></a>, so adding a new language is as simple as copying this file and translating the values. You don't have to translate it all, as any missing attributes will just fallback to English. For a full tutorial, see the <a class="" href="/docs/multi-language-support">Multi-Language Support Docs</a>.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="submit-a-pr">Submit a PR<a href="#submit-a-pr" class="hash-link" aria-label="Direct link to Submit a PR" title="Direct link to Submit a PR" translate="no"></a></h2>
|
||
<p>Contributing to the code or docs is super helpful. You can fix a bug, add a new feature or improve an existing one. If you've built your own custom widget, theme or view, consider sharing it in a PR. I've written <a class="" href="/docs/development-guides">several guides</a> to help you get started, and the steps for setting up the development environment are outlined in the <a class="" href="/docs/developing">Development Docs</a>. Feel free to ask if you have any questions.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="improve-the-docs">Improve the Docs<a href="#improve-the-docs" class="hash-link" aria-label="Direct link to Improve the Docs" title="Direct link to Improve the Docs" translate="no"></a></h2>
|
||
<p>Found a typo, or something that isn't as clear as it could be? Maybe I've missed something off altogether, or you hit a roadblock that took you a while to figure out. Submitting a pull request to add to or improve the documentation will help future users get Dashy up and running more easily.
|
||
All content is located either in the <a class="" href="/README"><code>./README.md</code></a> or <a class="" href="/docs"><code>/docs/</code></a> directory, and synced to the Wiki and website using a GH <a class="" href="/actions/workflows/wiki-sync.yml">action</a>.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="raise-a-bug">Raise a bug<a href="#raise-a-bug" class="hash-link" aria-label="Direct link to Raise a bug" title="Direct link to Raise a bug" translate="no"></a></h2>
|
||
<p>If you've found a bug, then please do raise it as an issue. This will help me know if there's something that needs fixing. Try and include as much detail as possible, such as your environment, steps to reproduce, any console output and maybe an example screenshot or recording if necessary.</p>
|
||
<p><a href="https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Raise_a-Bug-%23dc2d76?style=for-the-badge&logo=dependabot" alt="Raise a Bug" class="img_ev3q"></a></p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="join-the-discussion">Join the discussion<a href="#join-the-discussion" class="hash-link" aria-label="Direct link to Join the discussion" title="Direct link to Join the discussion" translate="no"></a></h2>
|
||
<p>I've enabled the discussion feature on GitHub, here you can share tips and tricks, useful information, or your dashboard. You can also ask questions, and offer basic support to other users.</p>
|
||
<p><a href="https://github.com/Lissy93/dashy/discussions" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Join_the-Discussion-%23ffd000?style=for-the-badge&logo=livechat" alt="Join the Discussion on GitHub" class="img_ev3q"></a></p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="request-a-feature-via-bountysource">Request a feature via BountySource<a href="#request-a-feature-via-bountysource" class="hash-link" aria-label="Direct link to Request a feature via BountySource" title="Direct link to Request a feature via BountySource" translate="no"></a></h2>
|
||
<p>BountySource is a platform for sponsoring the development of certain features on open source projects. If there is a feature you'd like implemented into Dashy, but either isn't high enough priority or is deemed to be more work than it's worth, then you can instead contribute a bounty towards it's development. You won't pay a penny until your proposal is fully built, and you are satisfied with the result. This helps support the developers, and makes Dashy better for everyone.</p>
|
||
<p><a href="https://www.bountysource.com/teams/dashy" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/BountySource-Dashy-%23F67909?style=for-the-badge&logo=openbugbounty" alt="Request a Feature on BountySource" class="img_ev3q"></a></p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="spread-the-word">Spread the word<a href="#spread-the-word" class="hash-link" aria-label="Direct link to Spread the word" title="Direct link to Spread the word" translate="no"></a></h2>
|
||
<p>Dashy is still a relatively young project, and as such not many people know of it. It would be great to see more users, and so it would be awesome if you could consider sharing with your friends or on social platforms.</p>
|
||
<p><a href="https://mastodon.social/?text=Check%20out%20Dashy%2C%20the%20privacy-friendly%2C%20self-hosted%20startpage%20for%20organizing%20your%20life%3A%20https%3A%2F%2Fgithub.com%2FLissy93%2Fdashy%20-%20By%20%40lissy93%40mastodon.social" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Share-Mastodon-%232b90d9?style=flat-square&logo=mastodon" alt="Share Dashy on Mastodon" class="img_ev3q"></a>
|
||
<a href="http://www.reddit.com/submit?url=https://github.com/Lissy93/dashy&title=Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Share-Reddit-%23FF5700?style=flat-square&logo=reddit" alt="Share Dashy on Reddit" class="img_ev3q"></a>
|
||
<a href="https://twitter.com/intent/tweet?url=https://github.com/lissy93/dashy&text=Check%20out%20Dashy%20by%20@Lissy_Sykes,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Share-Twitter-%231DA1F2?style=flat-square&logo=twitter" alt="Share Dashy on Twitter" class="img_ev3q"></a>
|
||
<a href="https://www.facebook.com/sharer/sharer.php?u=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Share-Facebook-%234267B2?style=flat-square&logo=facebook" alt="Share Dashy on Facebook" class="img_ev3q"></a>
|
||
<a href="https://www.linkedin.com/shareArticle?mini=true&url=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Share-LinkedIn-%230077b5?style=flat-square&logo=linkedin" alt="Share Dashy on LinkedIn" class="img_ev3q"></a>
|
||
<a href="https://pinterest.com/pin/create/button/?url=https://github.com/lissy93/dashy&media=https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png&description=Check%20out%20Dashy,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Share-Pinterest-%23E60023?style=flat-square&logo=pinterest" alt="Share Dashy on Pinterest" class="img_ev3q"></a>
|
||
<a href="https://vk.com/share.php?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%2F&title=Check%20out%20Dashy%20-%20The%20Self-Hosted%20Dashboard%20for%20your%20Homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Share-VK-%234C75A3?style=flat-square&logo=vk" alt="Share Dashy on VK" class="img_ev3q"></a>
|
||
<a href="viber://forward?text=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%0ACheck%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Share-Viber-%238176d6?style=flat-square&logo=viber" alt="Share Dashy via Viber" class="img_ev3q"></a>
|
||
<a href="https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy&text=Check%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Share-Telegram-%230088cc?style=flat-square&logo=telegram" alt="Share Dashy via Telegram" class="img_ev3q"></a>
|
||
<a href="mailto:info@example.com?&subject=Check%20out%20Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80&cc=&bcc=&body=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Share-Email-%238A90C7?style=flat-square&logo=protonmail" alt="Share Dashy via Email" class="img_ev3q"></a></p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="star-upvote-or-leave-a-review">Star, Upvote or Leave a Review<a href="#star-upvote-or-leave-a-review" class="hash-link" aria-label="Direct link to Star, Upvote or Leave a Review" title="Direct link to Star, Upvote or Leave a Review" translate="no"></a></h2>
|
||
<p>Dashy is on the following platforms, and if you could spare a few seconds to give it an upvote or review, this will also help new users discover Dashy</p>
|
||
<p><a href="https://www.producthunt.com/posts/dashy" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Review-ProductHunt-%23b74424?style=flat-square&logo=producthunt" alt="ProductHunt" class="img_ev3q"></a>
|
||
<a href="https://alternativeto.net/software/dashy/about/" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Review-AlternativeTo-%235581a6?style=flat-square&logo=abletonlive" alt="AlternativeTo" class="img_ev3q"></a>
|
||
<a href="https://www.slant.co/improve/topics/27783/viewpoints/1/~self-hosted-homelab-startpage~dashy" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Review-Slant-%2346a1df?style=flat-square&logo=capacitor" alt="Slant" class="img_ev3q"></a>
|
||
<a href="https://github.com/Lissy93/dashy/stargazers" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/github/stars/Lissy93/Dashy?color=ba96d6&label=Star%20-%20GitHub&logo=github&style=flat-square" alt="Star on GitHub" class="img_ev3q"></a>
|
||
<a href="https://hub.docker.com/r/lissy93/dashy" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/docker/stars/lissy93/dashy?color=4cb6e0&label=Star%20-%20Docker&logo=docker&style=flat-square" alt="Star on DockerHub" class="img_ev3q"></a></p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="follow-for-more">Follow for More<a href="#follow-for-more" class="hash-link" aria-label="Direct link to Follow for More" title="Direct link to Follow for More" translate="no"></a></h2>
|
||
<p>If you've enjoyed Dashy, you can follow the me to get updates about other projects that I am working on.</p>
|
||
<p><a href="https://twitter.com/Lissy_Sykes" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/twitter/follow/Lissy_Sykes?style=social&logo=twitter" alt="Alicia Sykes on Twitter" class="img_ev3q"></a>
|
||
<a href="https://github.com/Lissy93" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/github/followers/lissy93?label=Lissy93&style=social" alt="Alicia Sykes on GitHub" class="img_ev3q"></a>
|
||
<a href="https://mastodon.social/web/accounts/1032965" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/mastodon/follow/1032965?domain=https%3A%2F%2Fmastodon.social" alt="Alicia Sykes on Mastodon" class="img_ev3q"></a>
|
||
<a href="https://keybase.io/aliciasykes" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/aliciasykes--lightgrey?style=social&logo=Keybase" alt="Alicia Sykes on Keybase" class="img_ev3q"></a>
|
||
<a href="https://aliciasykes.com" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/aliciasykes.com--lightgrey?style=social&logo=Tencent%20QQ" alt="Alicia Sykes's Website" class="img_ev3q"></a>
|
||
<a href="https://notes.aliciasykes.com/" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/Blog--lightgrey?style=social&logo=micro.blog" alt="Alicia Sykes's Blog" class="img_ev3q"></a>
|
||
<a href="https://keybase.io/aliciasykes/pgp_keys.asc" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://img.shields.io/badge/PGP--lightgrey?style=social&logo=Let%E2%80%99s%20Encrypt" alt="Alicia Sykes's PGP" class="img_ev3q"></a></p>
|
||
<p>If you like, you could also consider <a href="https://notes.aliciasykes.com/subscribe" target="_blank" rel="noopener noreferrer" class="">subscribing to my mailing list</a> for occasional blog post updates.</p>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="contributors">Contributors<a href="#contributors" class="hash-link" aria-label="Direct link to Contributors" title="Direct link to Contributors" translate="no"></a></h3>
|
||
<p>For a full list of Dashy's contributors, see the <a class="" href="/docs/credits">Credits Page</a></p>
|
||
<p><a class="" href="/docs/credits"><img decoding="async" loading="lazy" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg" alt="Auto-generated contributors" class="img_ev3q"></a></p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="star-gazers-over-time">Star-Gazers Over Time<a href="#star-gazers-over-time" class="hash-link" aria-label="Direct link to Star-Gazers Over Time" title="Direct link to Star-Gazers Over Time" translate="no"></a></h3>
|
||
<p>](<a href="https://seladb.github.io/StarTrack-js/#/preload?r=Lissy93,dashy" target="_blank" rel="noopener noreferrer" class="">https://seladb.github.io/StarTrack-js/#/preload?r=Lissy93,dashy</a>)</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/contributing.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2026-03-13T09:25:41.000Z" itemprop="dateModified">Mar 13, 2026</time></b></span></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/showcase"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">*Dashy Showcase* 🌟</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/developing"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Developing</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#take-a-2-minute-survey" class="table-of-contents__link toc-highlight">Take a 2-minute survey</a></li><li><a href="#share-your-dashboard" class="table-of-contents__link toc-highlight">Share your dashboard</a></li><li><a href="#make-a-small-donation" class="table-of-contents__link toc-highlight">Make a small donation</a><ul><li><a href="#you-can-also-send-a-one-off-small-contribution-using-crypto" class="table-of-contents__link toc-highlight">You can also send a one-off small contribution using crypto</a></li></ul></li><li><a href="#enable-anonymous-bug-reports" class="table-of-contents__link toc-highlight">Enable Anonymous Bug Reports</a></li><li><a href="#add-translations" class="table-of-contents__link toc-highlight">Add Translations</a></li><li><a href="#submit-a-pr" class="table-of-contents__link toc-highlight">Submit a PR</a></li><li><a href="#improve-the-docs" class="table-of-contents__link toc-highlight">Improve the Docs</a></li><li><a href="#raise-a-bug" class="table-of-contents__link toc-highlight">Raise a bug</a></li><li><a href="#join-the-discussion" class="table-of-contents__link toc-highlight">Join the discussion</a></li><li><a href="#request-a-feature-via-bountysource" class="table-of-contents__link toc-highlight">Request a feature via BountySource</a></li><li><a href="#spread-the-word" class="table-of-contents__link toc-highlight">Spread the word</a></li><li><a href="#star-upvote-or-leave-a-review" class="table-of-contents__link toc-highlight">Star, Upvote or Leave a Review</a></li><li><a href="#follow-for-more" class="table-of-contents__link toc-highlight">Follow for More</a><ul><li><a href="#contributors" class="table-of-contents__link toc-highlight">Contributors</a></li><li><a href="#star-gazers-over-time" class="table-of-contents__link toc-highlight">Star-Gazers Over Time</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Intro</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://demo.dashy.to" target="_blank" rel="noopener noreferrer" class="footer__link-item">Live Demo<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/quick-start">Quick Start</a></li><li class="footer__item"><a class="footer__link-item" href="/docs">Documentation</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Setup Guide</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/deployment">Deploying</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/configuring">Configuring</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/management">Management</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/troubleshooting">Troubleshooting</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Feature Docs Pt 1</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/authentication">Authentication</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/alternate-views">Alternate Views</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/backup-restore">Backup & Restore</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/icons">Icons</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Feature Docs Pt 2</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/multi-language-support">Language Switching</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/status-indicators">Status Indicators</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/searching">Searching & Shortcuts</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/theming">Theming</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/developing">Developing</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/development-guides">Development Guides</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contributing">Contributing</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/showcase">Showcase</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/credits">Credits</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Misc</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/privacy">Privacy & Security</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/license">License</a></li><li class="footer__item"><a href="https://github.com/Lissy93/dashy/blob/master/.github/LEGAL.md" target="_blank" rel="noopener noreferrer" class="footer__link-item">Legal<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT.md" target="_blank" rel="noopener noreferrer" class="footer__link-item">Code of Conduct<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/Lissy93/dashy/blob/master/.github/CHANGELOG.md" target="_blank" rel="noopener noreferrer" class="footer__link-item">Changelog<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright"><a href="https://dashy.to">Dashy</a> - The Self-Hosted Dashboard for your Homelab<br>License under <a href="https://github.com/Lissy93/dashy/blob/master/LICENSE">MIT</a>. Copyright © 2026 <a href="https://aliciasykes.com">Alicia Sykes</a></div></div></div></footer></div>
|
||
</body>
|
||
</html> |