<scriptsrc="https://no-track.as93.net/js/script.js"defer="defer"data-domain="dashy.to"></script><titledata-react-helmet="true">Contributing | Dashy</title><metadata-react-helmet="true"property="og:url"content="https://dashy.to/docs/contributing"><metadata-react-helmet="true"name="docsearch:language"content="en"><metadata-react-helmet="true"name="docsearch:version"content="current"><metadata-react-helmet="true"name="docsearch:docusaurus_tag"content="docs-default-current"><metadata-react-helmet="true"property="og:title"content="Contributing | Dashy"><metadata-react-helmet="true"name="description"content="First off, thank you for considering contributing towards Dashy! 🙌"><metadata-react-helmet="true"property="og:description"content="First off, thank you for considering contributing towards Dashy! 🙌"><linkdata-react-helmet="true"rel="shortcut icon"href="/img/favicon.ico"><linkdata-react-helmet="true"rel="canonical"href="https://dashy.to/docs/contributing"><linkdata-react-helmet="true"rel="alternate"href="https://dashy.to/docs/contributing"hreflang="en"><linkdata-react-helmet="true"rel="alternate"href="https://dashy.to/docs/contributing"hreflang="x-default"><linkdata-react-helmet="true"rel="preconnect"href="https://BH4D9OD16A-dsn.algolia.net"crossorigin="anonymous"><linkrel="stylesheet"href="/assets/css/styles.de060916.css">
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 <ahref="/docs/credits">everyone who has helped</a> so far 💞</p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="take-a-2-minute-survey"></a>Take a 2-minute survey<aclass="hash-link"href="#take-a-2-minute-survey"title="Direct link to heading">#</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><ahref="https://survey.typeform.com/to/gl0L68ou"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/badge/Take_the-Survey-%231a86fd?style=for-the-badge&logo=buddy"alt="Take the Survey"></a></p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="share-your-dashboard"></a>Share your dashboard<aclass="hash-link"href="#share-your-dashboard"title="Direct link to heading">#</a></h2><p>Dashy now has a <ahref="https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#dashy-showcase-"target="_blank"rel="noopener noreferrer">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 <ahref="https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#submitting-your-dashboard"target="_blank"rel="noopener noreferrer">submit your dashboard</a>, either open a PR or raise an issue.</p><p><ahref="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"><imgsrc="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"></a></p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="make-a-small-donation"></a>Make a small donation<aclass="hash-link"href="#make-a-small-donation"title="Direct link to heading">#</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><ahref="https://github.com/sponsors/Lissy93"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/badge/Sponsor_on_GitHub-Lissy93-%23ff4dda?style=for-the-badge&logo=githubsponsors&logoColor=ff4dda"alt="Sponsor Lissy93 on GitHub"></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 <ahref="https://github.com/sponsors/Lissy93"target="_blank"rel="noopener noreferrer">@Lissy93's Sponsor Page</a>.</p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="enable-anonymous-bug-reports"></a>Enable Anonymous Bug Reports<aclass="hash-link"href="#enable-anonymous-bug-reports"title="Direct link to heading">#</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. <ahref="https://github.com/getsentry/sentry"target="_blank"rel="noopener noreferrer">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><divclass="codeBlockContainer_J+bg"><divclass="codeBlockContent_csEI yaml"><pretabindex="0"class="prism-code language-yaml codeBlock_rtdJ thin-scrollbar"style="color:#F8F8F2;background-color:#282A36"><codeclass="codeBlockLines_1zSZ"><spanclass="token-line"style="color:#F8F8F2"><spanclass="token key atrule">appConfig</span><spanclass="token punctuation"style="color:rgb(248, 248, 242)">:</span><spanclass="token plain"></span></span><spanclass="token-line"style="color:#F8F8F2"><spanclass="token plain"></span><spanclass="token key atrule">enableErrorReporting</span><spanclass="token punctuation"style="color:rgb(248, 248, 242)">:</span><spanclass="token plain"></span><spanclass="token boolean important">true</span></span></code></pre><buttontype="button"aria-label="Copy code to clipboard"class="copyButton_M3SB clean-btn">Copy</button></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 <ahref="https://sentry.io/security/"target="_blank"rel="noopener noreferrer">Sentry Security Docs</a>.</p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="add-translations"></a>Add Translations<aclass="hash-link"href="#add-translations"title="Direct link to heading">#</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 <ahref="https://github.com/Lissy93/dashy/blob/master/src/assets/locales/en.json"target="_blank"rel="noopener noreferrer"><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 <ahref="https://github.com/Lissy93/dashy/blob/master/docs/multi-language-support.md"target="_blank"rel="noopener noreferrer">Multi-Language Support Docs</a>.</p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="submit-a-pr"></a>Submit a PR<aclass="hash-link"href="#submit-a-pr"title="Direct link to heading">#</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
All content is located either in the <ahref="/README"><code>./README.md</code></a> or <ahref="/docs"><code>/docs/</code></a> directory, and synced to the Wiki and website using a GH <ahref="/actions/workflows/wiki-sync.yml">action</a>.</p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="raise-a-bug"></a>Raise a bug<aclass="hash-link"href="#raise-a-bug"title="Direct link to heading">#</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><ahref="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"><imgsrc="https://img.shields.io/badge/Raise_a-Bug-%23dc2d76?style=for-the-badge&logo=dependabot"alt="Raise a Bug"></a></p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="join-the-discussion"></a>Join the discussion<aclass="hash-link"href="#join-the-discussion"title="Direct link to heading">#</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><ahref="https://github.com/Lissy93/dashy/discussions"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/badge/Join_the-Discussion-%23ffd000?style=for-the-badge&logo=livechat"alt="Join the Discussion on GitHub"></a></p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="request-a-feature-via-bountysource"></a>Request a feature via BountySource<aclass="hash-link"href="#request-a-feature-via-bountysource"title="Direct link to heading">#</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><ahref="https://www.bountysource.com/teams/dashy"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/badge/BountySource-Dashy-%23F67909?style=for-the-badge&logo=openbugbounty"alt="Request a Feature on BountySource"></a></p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="spread-the-word"></a>Spread the word<aclass="hash-link"href="#spread-the-word"title="Direct link to heading">#</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><ahref="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"><imgsrc="https://img.shields.io/badge/Share-Mastodon-%232b90d9?style=flat-square&logo=mastodon"alt="Share Dashy on Mastodon"></a>
<ahref="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"><imgsrc="https://img.shields.io/badge/Share-Reddit-%23FF5700?style=flat-square&logo=reddit"alt="Share Dashy on Reddit"></a>
<ahref="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"><imgsrc="https://img.shields.io/badge/Share-Twitter-%231DA1F2?style=flat-square&logo=twitter"alt="Share Dashy on Twitter"></a>
<ahref="https://www.facebook.com/sharer/sharer.php?u=https://github.com/lissy93/dashy"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/badge/Share-Facebook-%234267B2?style=flat-square&logo=facebook"alt="Share Dashy on Facebook"></a>
<ahref="https://www.linkedin.com/shareArticle?mini=true&url=https://github.com/lissy93/dashy"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/badge/Share-LinkedIn-%230077b5?style=flat-square&logo=linkedin"alt="Share Dashy on LinkedIn"></a>
<ahref="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"><imgsrc="https://img.shields.io/badge/Share-Pinterest-%23E60023?style=flat-square&logo=pinterest"alt="Share Dashy on Pinterest"></a>
<ahref="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"><imgsrc="https://img.shields.io/badge/Share-VK-%234C75A3?style=flat-square&logo=vk"alt="Share Dashy on VK"></a>
<ahref="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"><imgsrc="https://img.shields.io/badge/Share-Viber-%238176d6?style=flat-square&logo=viber"alt="Share Dashy via Viber"></a>
<ahref="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"><imgsrc="https://img.shields.io/badge/Share-Telegram-%230088cc?style=flat-square&logo=telegram"alt="Share Dashy via Telegram"></a>
<ahref="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"><imgsrc="https://img.shields.io/badge/Share-Email-%238A90C7?style=flat-square&logo=protonmail"alt="Share Dashy via Email"></a></p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="star-upvote-or-leave-a-review"></a>Star, Upvote or Leave a Review<aclass="hash-link"href="#star-upvote-or-leave-a-review"title="Direct link to heading">#</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><ahref="https://www.producthunt.com/posts/dashy"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/badge/Review-ProductHunt-%23b74424?style=flat-square&logo=producthunt"alt="ProductHunt"></a>
<ahref="https://github.com/Lissy93/dashy/stargazers"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/github/stars/Lissy93/Dashy?color=ba96d6&label=Star%20-%20GitHub&logo=github&style=flat-square"alt="Star on GitHub"></a>
<ahref="https://hub.docker.com/r/lissy93/dashy"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/docker/stars/lissy93/dashy?color=4cb6e0&label=Star%20-%20Docker&logo=docker&style=flat-square"alt="Star on DockerHub"></a></p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="follow-for-more"></a>Follow for More<aclass="hash-link"href="#follow-for-more"title="Direct link to heading">#</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><ahref="https://twitter.com/Lissy_Sykes"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/twitter/follow/Lissy_Sykes?style=social&logo=twitter"alt="Alicia Sykes on Twitter"></a>
<ahref="https://github.com/Lissy93"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/github/followers/lissy93?label=Lissy93&style=social"alt="Alicia Sykes on GitHub"></a>
<ahref="https://mastodon.social/web/accounts/1032965"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/mastodon/follow/1032965?domain=https%3A%2F%2Fmastodon.social"alt="Alicia Sykes on Mastodon"></a>
<ahref="https://keybase.io/aliciasykes"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/badge/aliciasykes--lightgrey?style=social&logo=Keybase"alt="Alicia Sykes on Keybase"></a>
<ahref="https://keybase.io/aliciasykes/pgp_keys.asc"target="_blank"rel="noopener noreferrer"><imgsrc="https://img.shields.io/badge/PGP--lightgrey?style=social&logo=Let%E2%80%99s%20Encrypt"alt="Alicia Sykes's PGP"></a></p><p>If you like, you could also consider <ahref="https://notes.aliciasykes.com/subscribe"target="_blank"rel="noopener noreferrer">subscribing to my mailing list</a> for occasional blog post updates.</p><hr><h3><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="contributors"></a>Contributors<aclass="hash-link"href="#contributors"title="Direct link to heading">#</a></h3><p>For a full list of Dashy's contributors, see the <ahref="/docs/credits">Credits Page</a></p><p><ahref="https://github.com/Lissy93/dashy/blob/master/docs/credits.md"target="_blank"rel="noopener noreferrer"><imgsrc="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg"alt="Auto-generated contributors"></a></p><h3><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_WiXH"id="star-gazers-over-time"></a>Star-Gazers Over Time<aclass="hash-link"href="#star-gazers-over-time"title="Direct link to heading">#</a></h3><p><ahref="https://seladb.github.io/StarTrack-js/#/preload?r=Lissy93,dashy"target="_blank"rel="noopener noreferrer"><imgsrc="https://starchart.cc/Lissy93/dashy.svg"alt="Stargazers"></a></p></div><footerclass="row docusaurus-mt-lg"><divclass="col"><ahref="https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/contributing.md"target="_blank"rel="noreferrer noopener"><svgfill="currentColor"height="20"width="20"viewBox="0 0 40 40"class="iconEdit_mS5F"aria-hidden="true"><g><pathd="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><divclass="col lastUpdated_wj+Z"></div></footer></article><navclass="pagination-nav docusaurus-mt-lg"aria-label="Docs pages navigation"><divclass="pagination-nav__item"><aclass="pagination-nav__link"href="/docs/showcase"><divclass="pagination-nav__sublabel">Previous</div><divclass="pagination-nav__label">« *Dashy Showcase* 🌟</div></a></div><divclass="pagination-nav__item pagination-nav__item--next"><aclass="pagination-nav__link"href="/docs/developing"><divclass="pagination-nav__sublabel">Next</div><divclass="pagination-nav__label">Developing »</div></a></div></nav></div></div><divclass="col col--3"><divclass="tableOfContents_vrFS thin-scrollbar"><ulclass="table-of-contents table-of-contents__left-border"><li><ahref="#take-a-2-minute-survey"class="table-of-contents__link">Take a 2-minute survey</a></li><li><ahref="#share-your-dashboard"class="table-of-contents__link">Share your dashboard</a></li><li><ahref="#make-a-small-donation"class="table-of-contents__link">Make a small donation</a></li><li><ahref="#enable-anonymous-bug-reports"class="table-of-contents__link">Enable Anonymous Bug Reports</a></li><li><ahref="#add-translations"class="table-of-contents__link">Add Translations</a></li><li><ahref="#submit-a-pr"class="table-of-contents__link">Submit a PR</a></li><li><ahref="#improve-the-docs"class="table-of-contents__link">Improve the Docs</a></li><li><ahref="#raise-a-bug"class="table-of-contents__link">Raise a bug</a></li><li><ahref="#join-the-discussion"class="table-of-contents__link">Join the discussion</a></li><li><ahref="#request-a-feature-via-bountysource"class="table-of-contents__link">Request a feature via BountySource</a></li><li><ahref="#spread-the-word"class="table-of-contents__link">Spread the word</a></li><li><ahref="#star-upvote-or-leave-a-review"class="table-of-contents__link">Star, Upvote or Leave a Review</a></li><li><ahref="#follow-for-more"class="table-of-contents__link">Follow for More</a><ul><li><ahref="#contributors"class="table-of-contents__link">Contributors</a></li><li><ahref="#star-gazers-over-time"class="table-of-contents__link">Star-Gazers Over Time</a></li></ul></li></ul></div></div></div><