mirror of https://github.com/lissy93/dashy
21 lines
37 KiB
HTML
21 lines
37 KiB
HTML
<!doctype html>
|
|
<html lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<meta name="generator" content="Docusaurus v2.0.0-beta.2">
|
|
<link rel="search" type="application/opensearchdescription+xml" title="Dashy" href="/opensearch.xml">
|
|
<script src="https://no-track.as93.net/js/script.js" defer="defer" data-domain="dashy.to"></script><title data-react-helmet="true">Quick Start | Dashy</title><meta data-react-helmet="true" property="og:url" content="https://dashy.to/docs/quick-start"><meta data-react-helmet="true" name="docsearch:language" content="en"><meta data-react-helmet="true" name="docsearch:version" content="current"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Quick Start | Dashy"><meta data-react-helmet="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-react-helmet="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-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://dashy.to/docs/quick-start"><link data-react-helmet="true" rel="alternate" href="https://dashy.to/docs/quick-start" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://dashy.to/docs/quick-start" hreflang="x-default"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/assets/css/styles.de060916.css">
|
|
<link rel="preload" href="/assets/js/runtime~main.ac7349e8.js" as="script">
|
|
<link rel="preload" href="/assets/js/main.d13b237a.js" as="script">
|
|
</head>
|
|
<body>
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
|
|
<div><a href="#main" class="skipToContent_OuoZ">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><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="/"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_TMUO themedImage--light_4Vu1 navbar__logo"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_TMUO themedImage--dark_uzRr navbar__logo"><b class="navbar__title">Dashy</b></a><a href="https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><a href="https://demo.dashy.to" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Live Demo</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="navbar__items navbar__items--right"><div class="react-toggle displayOnlyInLargeViewport_cxYs react-toggle--checked react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_iYfV">🌙</span></div><div class="react-toggle-track-x"><span class="toggle_iYfV">☀️</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" checked="" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div><div class="searchBox_Bc3W"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_TMUO themedImage--light_4Vu1 navbar__logo"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_TMUO themedImage--dark_uzRr navbar__logo"><b class="navbar__title">Dashy</b></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a href="https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li><li class="menu__list-item"><a href="https://demo.dashy.to" target="_blank" rel="noopener noreferrer" class="menu__link">Live Demo</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link navbar__link--active" href="/docs/quick-start">Quick Start</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link navbar__link--active" href="/docs">Documentation</a></li></ul></div></div></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_lDyR"><aside class="docSidebarContainer_0YBq"><div class="sidebar_LIo8"><nav class="menu menu--responsive thin-scrollbar menu_oAhv menuWithAnnouncementBar_IVfW" aria-label="Sidebar navigation"><button aria-label="Open menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg class="sidebarMenuIcon_nrF-" width="24" height="24" 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><ul class="menu__list"><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">Running Dashy</a><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/quick-start">Quick Start</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/deployment">Deployment</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/configuring">Configuring</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/management">App Management</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/troubleshooting">Troubleshooting</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Feature Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/icons">Icons</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/widgets">Widgets</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/theming">Theming</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/status-indicators">Status Indicators</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/authentication">Authentication</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/searching">Keyboard Shortcuts</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/alternate-views">Alternate Views & Opening Methods</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/multi-language-support">Internationalization</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/backup-restore">Cloud Backup and Restore</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/pages-and-sections">Pages and Sections</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Community</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/showcase">*Dashy Showcase* 🌟</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/contributing">Contributing</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/developing">Developing</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/development-guides">Development Guides</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Misc</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/privacy">Privacy & Security</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/changelog">Changelog</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/license">license</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/code-of-conduct">Contributor Covenant Code of Conduct</a></li></ul></li></ul></nav><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_r8cw"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_zHA2"><div class="docItemContainer_oiyr"><article><div class="markdown"><header><h1 class="h1Heading_dC7a">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:80 lissy93/dashy</code>, then open <code>http://localhost:8080</code></p><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="1-prerequisites"></a>1. Prerequisites<a class="hash-link" href="#1-prerequisites" title="Direct link to heading">#</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">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 href="https://github.com/Lissy93/dashy/blob/master/docs/deployment.md" target="_blank" rel="noopener noreferrer">Deployment Docs</a>.</p><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="2-installation"></a>2. Installation<a class="hash-link" href="#2-installation" title="Direct link to heading">#</a></h2><p>To pull the latest image, and build and start the app run:</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI bash"><pre tabindex="0" class="prism-code language-bash codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token function" style="color:rgb(80, 250, 123)">docker</span><span class="token plain"> run -d </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> -p </span><span class="token number">8080</span><span class="token plain">:80 </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> -v ~/my-conf.yml:/app/public/conf.yml </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> --name my-dashboard </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> --restart</span><span class="token operator">=</span><span class="token plain">always </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> lissy93/dashy:latest</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></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 href="https://github.com/Lissy93/dashy/blob/master/docs/deployment.md#deploy-with-docker" target="_blank" rel="noopener noreferrer">Dashy with Docker</a> Docs. If you'd prefer to use Docker Compose, then see <a href="https://github.com/Lissy93/dashy/blob/master/docs/deployment.md#using-docker-compose" target="_blank" rel="noopener noreferrer">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><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="3-configure"></a>3. Configure<a class="hash-link" href="#3-configure" title="Direct link to heading">#</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">YAML Format</a>, and saved in <a href="https://github.com/Lissy93/dashy/blob/master/public/conf.yml" target="_blank" rel="noopener noreferrer"><code>/public/conf.yml</code></a>.
|
|
The format on the config file is pretty straight forward. There are three root attributes:</p><ul><li><a href="https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#pageinfo" target="_blank" rel="noopener noreferrer"><code>pageInfo</code></a> - Dashboard meta data, like title, description, nav bar links and footer text</li><li><a href="https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#appconfig-optional" target="_blank" rel="noopener noreferrer"><code>appConfig</code></a> - Dashboard settings, like themes, authentication, language and customization</li><li><a href="https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#section" target="_blank" rel="noopener noreferrer"><code>sections</code></a> - An array of sections, each including an array of items</li></ul><p>You can view a full list of all available config options in the <a href="https://github.com/Lissy93/dashy/blob/master/docs/configuring.md" target="_blank" rel="noopener noreferrer">Configuring Docs</a>.</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI yaml"><pre tabindex="0" class="prism-code language-yaml codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><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></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></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></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></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></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></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></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></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></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></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></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></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></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></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></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></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></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></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></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></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></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></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>Notes:</p><ul><li>You can use a Docker volume to pass a config file from your host system to the container<ul><li>E.g. <code>-v ./host-system/my-local-conf.yml:/app/public/conf.yml</code></li></ul></li><li>It's also possible to edit your config directly through the UI, and changes will be saved in this file</li><li>Check your config against Dashy's schema, with <code>docker exec -it [container-id] yarn validate-config</code></li><li>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">found here</a></li><li>After editing your config, the app will rebuild in the background, which may take a minute</li></ul><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="4-further-customisation"></a>4. Further Customisation<a class="hash-link" href="#4-further-customisation" title="Direct link to heading">#</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 href="https://github.com/Lissy93/dashy/blob/master/docs/management.md" target="_blank" rel="noopener noreferrer">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><a href="/docs/authentication">Authentication</a> - Setting up authentication to protect your dashboard</li><li><a href="/docs/alternate-views">Alternate Views</a> - Using the startpage and workspace view</li><li><a href="/docs/backup-restore">Backup & Restore</a> - Guide to Dashy's cloud sync feature</li><li><a href="/docs/icons">Icons</a> - Outline of all available icon types for sections and items</li><li><a href="/docs/multi-language-support">Localisation</a> - How to change language, or add your own</li><li><a href="/docs/status-indicators">Status Indicators</a> - Using Dashy to monitor uptime and status of your apps</li><li><a href="/docs/searching">Search & Shortcuts</a> - Using instant filter, web search and custom hotkeys</li><li><a href="/docs/theming">Theming</a> - Complete guide to applying, writing and modifying themes and styles</li></ul><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="5-final-note"></a>5. Final Note<a class="hash-link" href="#5-final-note" title="Direct link to heading">#</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">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">raise it</a> so it can be fixed. For contact options, see the <a href="https://github.com/Lissy93/dashy/blob/master/.github/SUPPORT.md" target="_blank" rel="noopener noreferrer">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 href="https://github.com/Lissy93/dashy/blob/master/docs/contributing.md" target="_blank" rel="noopener noreferrer">Contributing Page</a>. Huge thanks to <a href="https://github.com/Lissy93/dashy/blob/master/docs/credits.md" target="_blank" rel="noopener noreferrer">everyone</a> who has already helped out!</p><p>Enjoy your dashboard :)</p><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="alternative-deployment-method-1---from-source"></a>Alternative Deployment Method 1 - From Source<a class="hash-link" href="#alternative-deployment-method-1---from-source" title="Direct link to heading">#</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">Git</a>, <a href="https://nodejs.org/" target="_blank" rel="noopener noreferrer">Node.js</a>, and <a href="https://yarnpkg.com/" target="_blank" rel="noopener noreferrer">Yarn</a> are required.</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI bash"><pre tabindex="0" class="prism-code language-bash codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token function" style="color:rgb(80, 250, 123)">git</span><span class="token plain"> clone https://github.com/Lissy93/dashy.git </span><span class="token operator">&&</span><span class="token plain"> </span><span class="token builtin class-name" style="color:rgb(189, 147, 249)">cd</span><span class="token plain"> dashy</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token function" style="color:rgb(80, 250, 123)">yarn</span><span class="token plain"> </span><span class="token comment" style="color:rgb(98, 114, 164)"># Install dependencies</span><span class="token plain"></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token function" style="color:rgb(80, 250, 123)">yarn</span><span class="token plain"> build </span><span class="token comment" style="color:rgb(98, 114, 164)"># Build the app</span><span class="token plain"></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token function" style="color:rgb(80, 250, 123)">yarn</span><span class="token plain"> start </span><span class="token comment" style="color:rgb(98, 114, 164)"># Start the app</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>Then edit <code>./public/conf.yml</code> and rebuild the app with <code>yarn build</code></p><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="alternative-deployment-method-2---netlify"></a>Alternative Deployment Method 2 - Netlify<a class="hash-link" href="#alternative-deployment-method-2---netlify" title="Direct link to heading">#</a></h2><p>Don't have a server? No problem! You can run Dashy for free on Netlify (as well as many <a href="/docs/deployment#deploy-to-cloud-service">other cloud providers</a>). All you need it a GitHub account.</p><ol><li>Fork Dashy's repository on GitHub</li><li><a href="/docs/app.netlify.com/login/">Log in</a> to Netlify with GitHub</li><li>Click "New site from Git" and select your forked repo, then click <strong>Deploy</strong>!</li><li>You can then edit the config in <code>./public/conf.yml</code> in your repo, and Netlify will rebuild the app</li></ol><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="alternative-deployment-method-3---cloud-services"></a>Alternative Deployment Method 3 - Cloud Services<a class="hash-link" href="#alternative-deployment-method-3---cloud-services" title="Direct link to heading">#</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><a href="https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer"><img src="https://i.ibb.co/ZxtzrP3/netlify.png" width="18"> Deploy to Netlify</a></li><li><a href="https://heroku.com/deploy?template=https://github.com/Lissy93/dashy" target="_blank" rel="noopener noreferrer"><img src="https://i.ibb.co/d2P1WZ7/heroku.png" width="18"> Deploy to Heroku</a></li><li><a href="https://vercel.com/new/project?template=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer"><img src="https://i.ibb.co/Ld2FZzb/vercel.png" width="18"> Deploy to Vercel</a></li><li><a href="https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render" target="_blank" rel="noopener noreferrer"><img src="https://i.ibb.co/xCHtzgh/render.png" width="18"> Deploy to Render</a></li><li><a href="https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git" target="_blank" rel="noopener noreferrer"><img src="https://i.ibb.co/J7MGymY/googlecloud.png" width="18"> Deploy to GCP</a></li><li><a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml" target="_blank" rel="noopener noreferrer"><img src="https://i.ibb.co/HVWVYF7/docker.png" width="18"> Deploy to PWD</a></li><li><a href="https://easypanel.io/docs/templates/dashy" target="_blank" rel="noopener noreferrer"><img src="https://i.ibb.co/7NxnM2P/easypanel.png" width="18"> Deploy to Easypanel</a></li></ul></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/quick-start.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_mS5F" 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_wj+Z"></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/deployment"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Deployment »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_vrFS thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#1-prerequisites" class="table-of-contents__link">1. Prerequisites</a></li><li><a href="#2-installation" class="table-of-contents__link">2. Installation</a></li><li><a href="#3-configure" class="table-of-contents__link">3. Configure</a></li><li><a href="#4-further-customisation" class="table-of-contents__link">4. Further Customisation</a></li><li><a href="#5-final-note" class="table-of-contents__link">5. Final Note</a></li><li><a href="#alternative-deployment-method-1---from-source" class="table-of-contents__link">Alternative Deployment Method 1 - From Source</a></li><li><a href="#alternative-deployment-method-2---netlify" class="table-of-contents__link">Alternative Deployment Method 2 - Netlify</a></li><li><a href="#alternative-deployment-method-3---cloud-services" class="table-of-contents__link">Alternative Deployment Method 3 - Cloud Services</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Intro</div><ul class="footer__items"><li class="footer__item"><a href="https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li><li class="footer__item"><a href="https://demo.dashy.to" target="_blank" rel="noopener noreferrer" class="footer__link-item">Live Demo</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="col footer__col"><div class="footer__title">Setup Guide</div><ul class="footer__items"><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="col footer__col"><div class="footer__title">Feature Docs Pt 1</div><ul class="footer__items"><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="col footer__col"><div class="footer__title">Feature Docs Pt 2</div><ul class="footer__items"><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="col footer__col"><div class="footer__title">Community</div><ul class="footer__items"><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="col footer__col"><div class="footer__title">Misc</div><ul class="footer__items"><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</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/code-of-conduct">Code of Conduct</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/changelog">Changelog</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 © 2024 <a href="https://aliciasykes.com">Alicia Sykes</a></div></div></div></footer></div>
|
|
<script src="/assets/js/runtime~main.ac7349e8.js"></script>
|
|
<script src="/assets/js/main.d13b237a.js"></script>
|
|
</body>
|
|
</html> |