mirror of
https://github.com/Lissy93/dashy.git
synced 2026-03-20 03:31:57 +01:00
126 lines
No EOL
44 KiB
HTML
126 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-quick-start" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">Quick Start | 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="Quick Start | Dashy"><meta data-rh="true" name="description" content="Welcome to Dashy! So glad you're here 😊 In a couple of minutes, you'll have your new dashboard up and running 🚀"><meta data-rh="true" property="og:description" content="Welcome to Dashy! So glad you're here 😊 In a couple of minutes, you'll have your new dashboard up and running 🚀"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://dashy.to/docs/quick-start"><link data-rh="true" rel="alternate" href="https://dashy.to/docs/quick-start" hreflang="en"><link data-rh="true" rel="alternate" href="https://dashy.to/docs/quick-start" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Quick Start","item":"https://dashy.to/docs/quick-start"}]}</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.5c78453d.css">
|
||
<script src="/assets/js/runtime~main.ede6bdc2.js" defer="defer"></script>
|
||
<script src="/assets/js/main.47394154.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.12<!-- --> 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 aria-current="page" class="navbar__item navbar__link navbar__link--active" 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"><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/quick-start"><span title="Running Dashy" class="categoryLinkLabel_W154">Running Dashy</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 menu__link--active" aria-current="page" tabindex="0" href="/docs/quick-start"><span title="Quick Start" class="linkLabel_WmDU">Quick Start</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/deployment"><span title="Deployment" class="linkLabel_WmDU">Deployment</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/configuring"><span title="Configuring" class="linkLabel_WmDU">Configuring</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/management"><span title="App Management" class="linkLabel_WmDU">App Management</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/troubleshooting"><span title="Troubleshooting" class="linkLabel_WmDU">Troubleshooting</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/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 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/showcase"><span title="Community" class="categoryLinkLabel_W154">Community</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/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">Running Dashy</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Quick Start</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>Quick Start</h1></header>
|
||
<p>Welcome to Dashy! So glad you're here 😊 In a couple of minutes, you'll have your new dashboard up and running 🚀</p>
|
||
<p><strong>TLDR;</strong> Run <code>docker run -p 8080:8080 lissy93/dashy</code>, then open <code>http://localhost:8080</code></p>
|
||
<hr>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="1-prerequisites">1. Prerequisites<a href="#1-prerequisites" class="hash-link" aria-label="Direct link to 1. Prerequisites" title="Direct link to 1. Prerequisites" translate="no"></a></h2>
|
||
<p>The quickest and easiest method of running Dashy is using Docker (or another container engine). You can find installation instructions for your system in the <a href="https://docs.docker.com/get-docker/" target="_blank" rel="noopener noreferrer" class="">Docker Documentation</a>.
|
||
If you don't want to use Docker, then you can use one of Dashy's other supported installation methods instead, all of which are outlined in the <a class="" href="/docs/deployment">Deployment Docs</a>.</p>
|
||
<hr>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="2-installation">2. Installation<a href="#2-installation" class="hash-link" aria-label="Direct link to 2. Installation" title="Direct link to 2. Installation" translate="no"></a></h2>
|
||
<p>To pull the latest image, and build and start the app run:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">docker run -d \</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> -p 8080:8080 \</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> -v ~/my-conf.yml:/app/user-data/conf.yml \</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> --name my-dashboard \</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> --restart=always \</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> lissy93/dashy:latest</span><br></span></code></pre></div></div>
|
||
<p>Either replace the -v path to point to your config file, or leave it out. For a full list of available options, then see <a class="" href="/docs/deployment#deploy-with-docker">Dashy with Docker</a> Docs. If you'd prefer to use Docker Compose, then see <a class="" href="/docs/deployment#using-docker-compose">Dashy with Docker Compose</a> Docs. Alternate registries, architectures and pinned versions are also supported.</p>
|
||
<p>Your dashboard should now be up and running at <code>http://localhost:8080</code> (or your servers IP address/ domain, and the port that you chose). The first time you build, it may take a few minutes.</p>
|
||
<hr>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="3-user-data-directory">3. User Data Directory<a href="#3-user-data-directory" class="hash-link" aria-label="Direct link to 3. User Data Directory" title="Direct link to 3. User Data Directory" translate="no"></a></h2>
|
||
<p>Your config file should be placed inside <code>user-data/</code> (in Docker, that's <code>/app/user-data/</code>).</p>
|
||
<p>This directory can also contain some optional assets you wish to use within your dashboard, like icons, fonts, styles, scripts, etc.</p>
|
||
<p>Any files placed here will be served up to the root of the domain, and override the contents of <code>public/</code>.
|
||
For example, if you had <code>user-data/favicon.ico</code> this would be accessible at <code>http://my-dashy-instance.local/favicon.ico</code></p>
|
||
<p>Example Files in <code>user-data</code>:</p>
|
||
<ul>
|
||
<li class=""><code>conf.yml</code> - This is the only file that is compulsory, it's your main Dashy config</li>
|
||
<li class=""><code>**.yml</code> - Include more config files, if you'd like to have multiple pages, see <a class="" href="/docs/pages-and-sections#multi-page-support">Multi-page support</a> for docs</li>
|
||
<li class=""><code>favicon.ico</code> - The default favicon, shown in the browser's tab title</li>
|
||
<li class=""><code>initialization.html</code> - Static HTML page displayed before the app has finished compiling, see <a href="https://github.com/Lissy93/dashy/blob/master/public/initialization.html" target="_blank" rel="noopener noreferrer" class=""><code>public/initialization.html</code></a></li>
|
||
<li class=""><code>robots.txt</code> - Search engine crawl rules, override this if you want your dashboard to be indexable</li>
|
||
<li class=""><code>manifest.json</code> - PWA configuration file, for installing Dashy on mobile devices</li>
|
||
<li class=""><code>index.html</code> - The main index page which initializes the client-side app, copy it from <a href="https://github.com/Lissy93/dashy/blob/master/public/index.html" target="_blank" rel="noopener noreferrer" class=""><code>/public/index.html</code></a></li>
|
||
<li class=""><code>**.html</code> - Write your own HTML pages, and access them at <code>http://my-dashy-instance.local/my-page.html</code></li>
|
||
<li class=""><code>fonts/</code> - Custom fonts (be sure to include the ones already in <a href="https://github.com/Lissy93/dashy/tree/master/public/fonts" target="_blank" rel="noopener noreferrer" class=""><code>public/fonts</code></a></li>
|
||
<li class=""><code>item-icons/</code> - To use your own icons for items on your dashboard, see <a class="" href="/docs/icons#local-icons">Icons --> Local Icons</a></li>
|
||
<li class=""><code>web-icons/</code> - Override Dashy logo</li>
|
||
<li class=""><code>widget-resources/</code> - Fonts, icons and assets for custom widgets</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="4-configure">4. Configure<a href="#4-configure" class="hash-link" aria-label="Direct link to 4. Configure" title="Direct link to 4. Configure" translate="no"></a></h2>
|
||
<p>Now that you've got Dashy running, you are going to want to set it up with your own content.
|
||
Config is written in <a href="https://yaml.org/" target="_blank" rel="noopener noreferrer" class="">YAML Format</a>, and saved in <a href="https://github.com/Lissy93/dashy/blob/master/user-data/conf.yml" target="_blank" rel="noopener noreferrer" class=""><code>/user-data/conf.yml</code></a>.
|
||
The format on the config file is pretty straight forward. There are four root attributes:</p>
|
||
<ul>
|
||
<li class=""><a class="" href="/docs/configuring#pageinfo"><code>pageInfo</code></a> - Dashboard meta data, like title, description, nav bar links and footer text</li>
|
||
<li class=""><a class="" href="/docs/configuring#appconfig-optional"><code>appConfig</code></a> - Dashboard settings, like themes, authentication, language and customization</li>
|
||
<li class=""><a class="" href="/docs/configuring#section"><code>sections</code></a> - An array of sections, each including an array of items</li>
|
||
<li class=""><a class="" href="/docs/configuring#pages-optional"><code>pages</code></a> - Have multiples pages in your dashboard</li>
|
||
</ul>
|
||
<p>You can view a full list of all available config options in the <a class="" href="/docs/configuring">Configuring Docs</a>.</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">pageInfo</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">title</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> Home Lab</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token key atrule">sections</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> </span><span class="token comment" style="color:rgb(98, 114, 164)"># An array of sections</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">name</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> Example Section</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">icon</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> far fa</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">rocket</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">items</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 punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">title</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> GitHub</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">description</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> Dashy source code and docs</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">icon</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> fab fa</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">github</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">url</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> https</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain">//github.com/Lissy93/dashy</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">title</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> Issues</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">description</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> View open issues</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"> or raise a new one</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">icon</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> fas fa</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">bug</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">url</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> https</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain">//github.com/Lissy93/dashy/issues</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">name</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> Local Services</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">items</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 punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">title</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> Firewall</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">icon</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> favicon</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">url</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> http</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain">//192.168.1.1/</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">title</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> Game Server</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">icon</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> https</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain">//i.ibb.co/710B3Yc/space</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">invader</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">x256.png</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">url</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> http</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain">//192.168.130.1/</span><br></span></code></pre></div></div>
|
||
<p>Notes:</p>
|
||
<ul>
|
||
<li class="">You can use a Docker volume to pass a config file from your host system to the container
|
||
<ul>
|
||
<li class="">E.g. <code>-v ./host-system/my-local-conf.yml:/app/user-data/conf.yml</code></li>
|
||
</ul>
|
||
</li>
|
||
<li class="">It's also possible to edit your config directly through the UI, and changes will be saved in this file</li>
|
||
<li class="">Check your config against Dashy's schema, with <code>docker exec -it [container-id] yarn validate-config</code></li>
|
||
<li class="">You might find it helpful to look at some examples, a collection of which can be <a href="https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10" target="_blank" rel="noopener noreferrer" class="">found here</a></li>
|
||
<li class="">It's also possible to load a remote config, e.g. from a GitHub Gist</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="5-further-customisation">5. Further Customisation<a href="#5-further-customisation" class="hash-link" aria-label="Direct link to 5. Further Customisation" title="Direct link to 5. Further Customisation" translate="no"></a></h2>
|
||
<p>Once you've got Dashy setup, you'll want to ensure the container is properly healthy, secured, backed up and kept up-to-date. All this is covered in the <a class="" href="/docs/management">Management Docs</a>.</p>
|
||
<p>You might also want to check out the docs for specific features you'd like to use:</p>
|
||
<ul>
|
||
<li class=""><a class="" href="/docs/authentication">Authentication</a> - Setting up authentication to protect your dashboard</li>
|
||
<li class=""><a class="" href="/docs/alternate-views">Alternate Views</a> - Using the startpage and workspace view</li>
|
||
<li class=""><a class="" href="/docs/backup-restore">Backup & Restore</a> - Guide to Dashy's cloud sync feature</li>
|
||
<li class=""><a class="" href="/docs/icons">Icons</a> - Outline of all available icon types for sections and items</li>
|
||
<li class=""><a class="" href="/docs/multi-language-support">Localisation</a> - How to change language, or add your own</li>
|
||
<li class=""><a class="" href="/docs/status-indicators">Status Indicators</a> - Using Dashy to monitor uptime and status of your apps</li>
|
||
<li class=""><a class="" href="/docs/searching">Search & Shortcuts</a> - Using instant filter, web search and custom hotkeys</li>
|
||
<li class=""><a class="" href="/docs/theming">Theming</a> - Complete guide to applying, writing and modifying themes and styles</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="6-final-note">6. Final Note<a href="#6-final-note" class="hash-link" aria-label="Direct link to 6. Final Note" title="Direct link to 6. Final Note" translate="no"></a></h2>
|
||
<p>If you need any help or support in getting Dashy running, head over to the <a href="https://github.com/Lissy93/dashy/discussions" target="_blank" rel="noopener noreferrer" class="">Discussions</a> page. If you think you've found a bug, please do <a href="https://github.com/Lissy93/dashy/issues/new/choose" target="_blank" rel="noopener noreferrer" class="">raise it</a> so it can be fixed. For contact options, see the <a href="https://github.com/Lissy93/dashy/blob/master/.github/SUPPORT" target="_blank" rel="noopener noreferrer" class="">Support Page</a>.</p>
|
||
<p>If you're enjoying Dashy, and have a few minutes to spare, please do take a moment to look at the <a class="" href="/docs/contributing">Contributing Page</a>. Huge thanks to <a class="" href="/docs/credits">everyone</a> who has already helped out!</p>
|
||
<p>Enjoy your dashboard :)</p>
|
||
<hr>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="alternative-deployment-method-1---from-source">Alternative Deployment Method 1 - From Source<a href="#alternative-deployment-method-1---from-source" class="hash-link" aria-label="Direct link to Alternative Deployment Method 1 - From Source" title="Direct link to Alternative Deployment Method 1 - From Source" translate="no"></a></h2>
|
||
<p>You can also easily run the app on your system without Docker. For this <a href="https://git-scm.com/downloads" target="_blank" rel="noopener noreferrer" class="">Git</a>, <a href="https://nodejs.org/" target="_blank" rel="noopener noreferrer" class="">Node.js</a>, and <a href="https://yarnpkg.com/" target="_blank" rel="noopener noreferrer" class="">Yarn</a> are required.</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">git clone https://github.com/Lissy93/dashy.git && cd dashy</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">yarn # Install dependencies</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">yarn build # Build the app</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">yarn start # Start the app</span><br></span></code></pre></div></div>
|
||
<p>Then edit <code>./user-data/conf.yml</code></p>
|
||
<hr>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="alternative-deployment-method-2---netlify">Alternative Deployment Method 2 - Netlify<a href="#alternative-deployment-method-2---netlify" class="hash-link" aria-label="Direct link to Alternative Deployment Method 2 - Netlify" title="Direct link to Alternative Deployment Method 2 - Netlify" translate="no"></a></h2>
|
||
<p>Don't have a server? No problem! You can run Dashy for free on Netlify (as well as many <a class="" href="/docs/deployment#deploy-to-cloud-service">other cloud providers</a>). All you need it a GitHub account.</p>
|
||
<ol>
|
||
<li class="">Fork Dashy's repository on GitHub</li>
|
||
<li class=""><a class="" href="/docs/app.netlify.com/login/">Log in</a> to Netlify with GitHub</li>
|
||
<li class="">Click "New site from Git" and select your forked repo, then click <strong>Deploy</strong>!</li>
|
||
<li class="">You can then edit the config in <code>./user-data/conf.yml</code> in your repo, and Netlify will rebuild the app</li>
|
||
</ol>
|
||
<hr>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="alternative-deployment-method-3---cloud-services">Alternative Deployment Method 3 - Cloud Services<a href="#alternative-deployment-method-3---cloud-services" class="hash-link" aria-label="Direct link to Alternative Deployment Method 3 - Cloud Services" title="Direct link to Alternative Deployment Method 3 - Cloud Services" translate="no"></a></h2>
|
||
<p>Dashy supports 1-Click deployments on several popular cloud platforms. To spin up a new instance, just click a link below:</p>
|
||
<ul>
|
||
<li class=""><a href="https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://i.ibb.co/ZxtzrP3/netlify.png" width="18" class="img_ev3q"> Deploy to Netlify</a></li>
|
||
<li class=""><a href="https://heroku.com/deploy?template=https://github.com/Lissy93/dashy" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://i.ibb.co/d2P1WZ7/heroku.png" width="18" class="img_ev3q"> Deploy to Heroku</a></li>
|
||
<li class=""><a href="https://vercel.com/new/project?template=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://i.ibb.co/Ld2FZzb/vercel.png" width="18" class="img_ev3q"> Deploy to Vercel</a></li>
|
||
<li class=""><a href="https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://i.ibb.co/xCHtzgh/render.png" width="18" class="img_ev3q"> Deploy to Render</a></li>
|
||
<li class=""><a href="https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://i.ibb.co/J7MGymY/googlecloud.png" width="18" class="img_ev3q"> Deploy to GCP</a></li>
|
||
<li class=""><a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://i.ibb.co/HVWVYF7/docker.png" width="18" class="img_ev3q"> Deploy to PWD</a></li>
|
||
<li class=""><a href="https://easypanel.io/docs/templates/dashy" target="_blank" rel="noopener noreferrer" class=""><img decoding="async" loading="lazy" src="https://i.ibb.co/7NxnM2P/easypanel.png" width="18" class="img_ev3q"> Deploy to Easypanel</a></li>
|
||
</ul></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/quick-start.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-17T11:25:06.000Z" itemprop="dateModified">Mar 17, 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--next" href="/docs/deployment"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Deployment</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="#1-prerequisites" class="table-of-contents__link toc-highlight">1. Prerequisites</a></li><li><a href="#2-installation" class="table-of-contents__link toc-highlight">2. Installation</a></li><li><a href="#3-user-data-directory" class="table-of-contents__link toc-highlight">3. User Data Directory</a></li><li><a href="#4-configure" class="table-of-contents__link toc-highlight">4. Configure</a></li><li><a href="#5-further-customisation" class="table-of-contents__link toc-highlight">5. Further Customisation</a></li><li><a href="#6-final-note" class="table-of-contents__link toc-highlight">6. Final Note</a></li><li><a href="#alternative-deployment-method-1---from-source" class="table-of-contents__link toc-highlight">Alternative Deployment Method 1 - From Source</a></li><li><a href="#alternative-deployment-method-2---netlify" class="table-of-contents__link toc-highlight">Alternative Deployment Method 2 - Netlify</a></li><li><a href="#alternative-deployment-method-3---cloud-services" class="table-of-contents__link toc-highlight">Alternative Deployment Method 3 - Cloud Services</a></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> |