mirror of
https://github.com/Lissy93/dashy.git
synced 2025-04-08 17:06:18 +02:00
17 lines
12 KiB
HTML
17 lines
12 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">
|
|
<title data-react-helmet="true">readme | Dashy</title><meta data-react-helmet="true" property="og:url" content="https://dashy.to/docs/readme"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="readme | Dashy"><meta data-react-helmet="true" name="description" content="Dashy Docs"><meta data-react-helmet="true" property="og:description" content="Dashy Docs"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://dashy.to/docs/readme"><link data-react-helmet="true" rel="alternate" href="https://dashy.to/docs/readme" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://dashy.to/docs/readme" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.dd50695d.css">
|
|
<link rel="preload" href="/assets/js/runtime~main.e7540d76.js" as="script">
|
|
<link rel="preload" href="/assets/js/main.e0f631c7.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:"light")}()</script><div id="__docusaurus">
|
|
<div><a href="#main" class="skipToContent_1oUP">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><a class="navbar__brand" href="/"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><b class="navbar__title">Dashy</b></a></div><div class="navbar__items navbar__items--right"><div class="react-toggle displayOnlyInLargeViewport_GrZ2 react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_71bT">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_71bT">🌞</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></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_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><b class="navbar__title">Dashy</b></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"></ul></div></div></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_31aa"><main class="docMainContainer_3ufF docMainContainerEnhanced_3NYZ"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_3FnS"><div class="docItemContainer_33ec"><article><div class="markdown"><header><h1 class="h1Heading_27L5">readme</h1></header><p><img src="https://i.ibb.co/4mdNf7M/heading-docs.png" alt="Dashy Docs"></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="running-dashy"></a>Running Dashy<a class="hash-link" href="#running-dashy" title="Direct link to heading">#</a></h3><ul><li><a href="/docs/quick-start">Quick Start</a> - TDLR guide on getting Dashy up and running</li><li><a href="/docs/deployment">Deployment</a> - Full guide on deploying Dashy either locally or online</li><li><a href="/docs/configuring">Configuring</a> - Complete list of all available options in the config file</li><li><a href="/docs/management">App Management</a> - Managing your app, updating, security, web server configuration, etc</li><li><a href="/docs/troubleshooting">Troubleshooting</a> - Common errors and problems, and how to fix them</li></ul><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="development-and-contributing"></a>Development and Contributing<a class="hash-link" href="#development-and-contributing" title="Direct link to heading">#</a></h3><ul><li><a href="/docs/developing">Developing</a> - Running Dashy development server locally, and general workflow</li><li><a href="/docs/development-guides">Development Guides</a> - Common development tasks, to help new contributors</li><li><a href="/docs/contributing">Contributing</a> - How you can help keep Dashy alive</li><li><a href="/docs/showcase">Showcase</a> - See how others are using Dashy, and share your dashboard</li><li><a href="/docs/credits">Credits</a> - List of people and projects that have made Dashy possible</li></ul><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="feature-docs"></a>Feature Docs<a class="hash-link" href="#feature-docs" title="Direct link to heading">#</a></h3><ul><li><a href="/docs/authentication">Authentication</a> - Guide to setting up authentication to protect your dashboard</li><li><a href="/docs/alternate-views">Alternate Views</a> - Outline of available pages / views and item opening methods</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">Language Switching</a> - Details on how to switch language, or add a new locale</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">Searching & Shortcuts</a> - Finding and launching your apps, and using keyboard shortcuts</li><li><a href="/docs/theming">Theming</a> - Complete guide to applying, writing and modifying themes and styles</li></ul><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="misc"></a>Misc<a class="hash-link" href="#misc" title="Direct link to heading">#</a></h3><ul><li><a href="/docs/privacy">Privacy & Security</a> - List of requests, potential issues, and security resources</li><li><a href="/docs/license">License</a> - Copy of the MIT License</li><li><a href="https://github.com/Lissy93/dashy/blob/master/.github/LEGAL.md" target="_blank" rel="noopener noreferrer">Legal</a> - Licenses of direct dependencies</li><li><a href="/docs/code-of-conduct">Code of Conduct</a> - Contributor Covenant Code of Conduct</li><li><a href="/docs/changelog">Changelog</a> - Details of recent changes, and historical versions</li></ul></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/readme.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_2_ui" 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_3DPF"></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"></div></nav></div></div><div class="col col--3"><div class="tableOfContents_35-E thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#running-dashy" class="table-of-contents__link">Running Dashy</a></li><li><a href="#development-and-contributing" class="table-of-contents__link">Development and Contributing</a></li><li><a href="#feature-docs" class="table-of-contents__link">Feature Docs</a></li><li><a href="#misc" class="table-of-contents__link">Misc</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 © 2021 <a href="https://aliciasykes.com">Alicia Sykes</a></div></div></div></footer></div>
|
|
<script src="/assets/js/runtime~main.e7540d76.js"></script>
|
|
<script src="/assets/js/main.e0f631c7.js"></script>
|
|
</body>
|
|
</html> |