diff --git a/404.html b/404.html index 17c533ee..2cb26ef2 100644 --- a/404.html +++ b/404.html @@ -10,14 +10,14 @@ - - - + + + -
Skip to main content
404

Page Not Found

The page you're looking for doesn't exist or has been moved. Try navigating back to the docs or homepage.

HomeDocumentationQuick Start
+
Skip to main content
404

Page Not Found

The page you're looking for doesn't exist or has been moved. Try navigating back to the docs or homepage.

HomeDocumentationQuick Start
\ No newline at end of file diff --git a/assets/css/styles.be39311a.css b/assets/css/styles.dcaddff2.css similarity index 65% rename from assets/css/styles.be39311a.css rename to assets/css/styles.dcaddff2.css index 16f90793..2bb0582b 100644 --- a/assets/css/styles.be39311a.css +++ b/assets/css/styles.dcaddff2.css @@ -1 +1 @@ -@import url(https://fonts.googleapis.com/css2?family=Racing+Sans+One&family=Poppins:wght@300&family=Roboto+Mono:wght@500;300&display=swap);.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown li,body{word-wrap:break-word}body,ol ol,ol ul,ul ol,ul ul{margin:0}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}#carbonads .carbon-poweredby,#carbonads a,#carbonads a:hover{color:var(--carbon-text-color)}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}*,.loadingRing_RJI3 div{box-sizing:border-box}.close,.home-page-features-wrapper .feature div.read-the-docs{float:right}.commitMsg_XeKn,.name_mmMI,.text--truncate{text-overflow:ellipsis}.clean-list,.containsTaskList_mC6p,.details_lb9f>summary,.dropdown__menu,.grid_qTnk,.menu__list{list-style:none}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:#0000;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:#0000000d;--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 #0000001a;--ifm-global-shadow-md:0 5px 40px #0003;--ifm-global-shadow-tl:0 12px 28px 0 #0003,0 2px 4px 0 #0000001a;--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:#0000;--ifm-table-stripe-background:#00000008;--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:#0000}html{background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);-webkit-font-smoothing:antialiased;text-rendering:optimizelegibility;-webkit-text-size-adjust:100%;text-size-adjust:100%;--primary:#54bff7;--background:var(--pale-grey);--text-color:var(--black);--hero-background:var(--bright-white);--kinda-transparent:#ffffffd9;--hyperlink:#ff62ce;--feature-img-shadow:4px 4px 6px #a9a9a980,-2px -2px 4px #0006;--footer-color:var(--white);--footer-text-color:var(--black);scroll-behavior:smooth}body{background:var(--background)}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid #0000001a;border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:initial;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}article div.markdown h1,h1{font-size:var(--ifm-h1-font-size)}article div.markdown h2,h2{font-size:var(--ifm-h2-font-size)}article div.markdown h3,h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}.container_lyt7,.container_lyt7>svg,img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){-webkit-text-decoration:none;text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_uzNF .wordWrapButtonIcon_b1P5{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_Gvgb,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;white-space:nowrap}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:#3578e526;--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:#ebedf026;--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:#00a40026;--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:#54c7ec26;--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:#ffba0026;--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:#fa383e26;--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.dropdown>.navbar__link:after,.searchBarContainer_NW3z.searchIndexLoading_EJ1f .searchBarLoadingRing_YnHq{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:any-link:hover,.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);-webkit-text-decoration:none;text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);-webkit-user-select:none;user-select:none;white-space:nowrap}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:#0000;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}#carbonads a,.banner_woPo,.button-link-wrapper:hover,.commitRow_RIZe,.commitRow_RIZe:hover,.dropdown__link--active,.dropdown__link:hover,.link2_y3x6:hover,.link_ecgS:hover,.menu__link:hover,.navLink_KmGT,.navLink_KmGT:hover,.navbar__brand:hover,.navbar__link--active,.navbar__link:hover,.pagination-nav__link:hover,.pagination__link:hover{-webkit-text-decoration:none;text-decoration:none}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);-webkit-text-decoration:none;text-decoration:none}.close{color:var(--ifm-color-black);font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;transform:translateY(-1px);visibility:visible}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;pointer-events:none;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem;white-space:nowrap}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color)}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor #0000;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_BuS1>:last-child,.collapsibleContent_i85q p:last-child,.details_lb9f>summary>p:last-child,.footer__items,.searchResultItem_U687>h2{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title,h2{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;transition-duration:var(--ifm-transition-fast);transition-timing-function:ease-in-out;top:0;left:0;visibility:hidden}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color)}.menu__caret:before,.menu__link--sublist-caret:after{height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem;content:"";filter:var(--ifm-menu-link-sublist-icon-filter)}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;margin-left:auto;min-width:1.25rem}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.navbar--fixed-top{position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color)}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.fetchErrorCard_M8w3 p,.home-page-features-wrapper .feature .feature-title h3,.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}#nprogress,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color)}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:#ffffff1a;--ifm-navbar-search-input-placeholder-color:#ffffff80;color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:#ffffff0d;--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:1rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);position:fixed;transform:translate3d(-100%,0,0);transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:#0009;position:fixed;right:0;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.footer,article div.markdown p img,nav.navbar{box-shadow:var(--feature-img-shadow)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav{display:grid;grid-gap:var(--ifm-spacing-horizontal);gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover)}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto;padding-left:0}.tabs__item{border-bottom:3px solid #0000;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:#ffffff0d;--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:#ffffff1a;--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:#ffffff12;--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec;--primary:#db78fc;--background:var(--dark-grey);--text-color:var(--white);--hero-background:var(--black);--kinda-transparent:#000000d9;--hyperlink:var(--primary);--feature-img-shadow:4px 4px 6px #00000080,-2px -2px 4px #0006;--footer-color:var(--black);--footer-text-color:var(--white);--heading-shadow:-5px 4px 0px #000;--sub-heading-shadow:-3px 3px 1px #000}:root{--docusaurus-progress-bar-color:var(--ifm-color-primary);--bright-white:#fff;--white:#f7f7f7;--pale-grey:#e9e9e8;--mid-grey:#a9a9a9;--dark-grey:#18191a;--black:#121212;--pitch-black:#000;--info:#35c9fa;--success:#8f8;--warning:#ece715;--danger:#f80363;--accent-green:#41ef90;--accent-green-dark:#1e9554;--accent-blue:#5c85f7;--accent-blue-dark:#3d48dd;--accent-purple:#9083ed;--accent-purple-dark:#6b3cd6;--accent-pink:#db78fc;--accent-pink-dark:#b83ddd;--accent-yellow:#dcff5a;--accent-yellow-dark:#ceb73f;--ifm-color-primary:var(--background);--ifm-color-primary-dark:#21af90;--ifm-color-primary-darker:#1fa588;--ifm-color-primary-darkest:#1a8870;--ifm-color-primary-light:#46cbae;--ifm-color-primary-lighter:#66d4bd;--ifm-color-primary-lightest:#92e0d0;--ifm-code-font-size:95%;--ifm-navbar-background-color:var(--hero-background);--ifm-navbar-link-color:var(--text-color);--ifm-breadcrumb-color-active:var(--text-color);--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docusaurus-announcement-bar-height:auto;--docusaurus-collapse-button-bg:#0000;--docusaurus-collapse-button-bg-hover:#0000001a;--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;transform:rotate(3deg) translateY(-4px);width:100px}h1{font-family:Racing Sans One,mono;font-size:4rem}button,h2,h3,h4,h5{font-family:Roboto Mono,monospace}h3{font-size:2rem}button,h4,h5{font-size:1.2rem}a,body,div,p,section,span,ul li{font-family:Poppins,sans-serif;font-size:1.2rem}.link2_y3x6,.link_ecgS,code span{font-family:Roboto Mono,monospace}.hero{--ifm-hero-background-color:var(--hero-background);--ifm-hero-text-color:var(--text-color)}.footer{--ifm-footer-background-color:var(--footer-color);--ifm-footer-color:var(--footer-text-color);--ifm-footer-link-color:var(--footer-text-color);--ifm-footer-title-color:var(--footer-text-color);--ifm-footer-link-hover-color:var(--primary);--ifm-link-color:var(--footer-text-color);--ifm-link-hover-color:var(--primary)}.footer .footer__link-item,.sidebar-ad #carbonads .carbon-text,article div.markdown a,article div.markdown code span,article div.markdown li,article div.markdown ol,article div.markdown p,article div.markdown ul,ul.table-of-contents li a{font-size:1rem}.footer .footer__copyright,.footer .footer__copyright a{font-family:Roboto Mono,monospace;font-size:.9rem;font-weight:700;opacity:.9}.docusaurus-highlight-code-line{background-color:#0000001a;display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}nav.navbar a.navbar__brand .navbar__logo,nav.navbar a.navbar__brand b{transition:.3s}nav.navbar a.navbar__brand:hover .navbar__logo{transform:scale(1.1) rotate(-3deg)}nav.navbar a.navbar__brand:hover b{color:#00eed6}nav.navbar a.navbar__brand b{font-size:1.5rem;font-weight:700}.authorLink_YWtN:hover,nav.navbar .navbar__link--active,nav.navbar .navbar__link:hover{color:var(--primary)}.fetchErrorCard_M8w3 a:hover,.meta_GplF a:hover,.pagination-nav__label,html[data-theme=light] main div.container.padding-top--md.padding-bottom--lg .pagination-nav__label{color:var(--text-color)}li a,li a:hover,p a,p a:hover,ul.table-of-contents li a:hover,ul.table-of-contents li a:hover code{color:var(--hyperlink)}.hitFooter_E9YW a,.suggestion_fB_2.cursor_eG29 mark,li a:hover,p a:hover{-webkit-text-decoration:underline;text-decoration:underline}h1,h2,h3,h4,h5{cursor:default}article div.markdown{--ifm-h1-font-size:3.0rem;--ifm-h2-font-size:2.5rem;--ifm-h3-font-size:1.4rem}article div.markdown p img{border-radius:4px}.sponsor_JDQ1,.sponsor_JDQ1 img,article div.markdown table>tr>td>a>img{border-radius:6px}ul.table-of-contents li a.table-of-contents__link--active,ul.table-of-contents li a.table-of-contents__link--active code{color:var(--hyperlink);font-weight:700}ul.menu__list{margin-bottom:1rem}ul.menu__list li.menu__list-item a.active,ul.menu__list li.menu__list-item a.menu__link--active{color:var(--primary);font-weight:700}code span{font-size:.9rem!important}html[data-theme=light] main div.container.padding-top--md.padding-bottom--lg{padding:0 1rem!important}html[data-theme=light] main div.container.padding-top--md.padding-bottom--lg div>div.col[class*=docItemCol]{background:var(--bright-white);border-right:1px solid var(--ifm-toc-border-color);padding:1rem}html[data-theme=light] main div.container.padding-top--md.padding-bottom--lg div>div.col[class*=docItemCol] ul li a{font-weight:700}html[data-theme=light] main div.container.padding-top--md.padding-bottom--lg .table-of-contents__left-border{border-left:none}#carbonads *{line-height:normal;margin:initial;padding:initial}#carbonads{--carbon-font-family:-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,Oxygen-Sans,Ubuntu,Cantarell,"Helvetica Neue",Helvetica,Arial,sans-serif;--carbon-font-size:14px;--carbon-padding:1.5ch;--carbon-max-char:20ch;--carbon-bg-primary:#fafafa;--carbon-bg-secondary:#ebebeb;--carbon-text-color:#333;font-family:var(--carbon-font-family);font-size:var(--carbon-font-size);margin:0 auto;width:fit-content;z-index:10}#carbonads>span{background-color:var(--carbon-bg-primary);box-shadow:0 0 1px rgba(0,0,0,.085),0 0 2px rgba(0,0,0,.085),0 0 4px rgba(0,0,0,.085),0 0 8px rgba(0,0,0,.085);display:flex;flex-direction:column;gap:var(--carbon-padding);max-inline-size:calc(130px + var(--carbon-max-char) + 8ch);min-inline-size:130px;padding:var(--carbon-padding)}#carbonads .carbon-wrap{display:flex;flex-wrap:wrap;gap:1.5ex}#carbonads .carbon-img{flex:0 0 130px}#carbonads .carbon-img img,.cursor_eG29 .hideAction_vcyE>svg,.tocCollapsibleContent_vkbj a{display:block}#carbonads .carbon-text{flex-basis:var(--carbon-max-char);flex-grow:1;line-height:1.4;text-align:left}#carbonads .carbon-poweredby{background:var(--carbon-bg-secondary);font-size:.6em;font-weight:600;letter-spacing:.2ch;line-height:1.4;padding:6px 8px;text-align:center;text-transform:uppercase}.sidebar-ad{--carbon-bg-primary:var(--background,#18191a);--carbon-bg-secondary:#282a36;--carbon-text-color:#e6e6e6}.sidebar-ad #carbonads{margin:.5rem}.sidebar-ad #carbonads .carbon-img img,.sidebar-ad .avatar__photo-link{border-radius:5px}.mdxPageWrapper_j9I6,.sidebar-ad #carbonads .carbon-wrap{justify-content:center}.banner_woPo,.tagWithCount_h2kH{align-items:center;display:flex}.sidebar-ad #carbonads>span{box-shadow:none}.sidebar-ad #carbonads .carbon-poweredby{border-radius:5px;font-size:.7rem}::selection{background:var(--primary);color:var(--background);text-shadow:none}@keyframes a{0%{opacity:0;transform:translateY(-100%)}to{opacity:1;transform:translateY(0)}}@keyframes b{0%{opacity:1}to{opacity:0;transform:translateY(-100%)}}.banner_woPo{animation:.3s ease-out a;background:var(--accent-green);color:var(--bright-white);flex-wrap:wrap;font-size:.95rem;font-weight:600;gap:.25rem 1.25rem;justify-content:center;padding:.25rem 1rem;position:relative;width:100%;z-index:100}.content_knG7 a,.fetchErrorCard_M8w3 a,.keepReading_G_Ux,.link2_y3x6.link2_y3x6,.link2_y3x6.link2_y3x6:hover,.link_ecgS.link2_y3x6,.link_ecgS.link2_y3x6:hover,.meta_GplF a,main.docs p.see-repo-note a{-webkit-text-decoration:underline;text-decoration:underline}.dismissing_ZrNM{animation:.25s ease-in forwards b}.link2_y3x6,.link_ecgS{color:var(--black);font-size:.95rem;font-weight:400;transition:.2s}.link2_y3x6.link2_y3x6,.link_ecgS.link2_y3x6{opacity:.85}.link2_y3x6.link2_y3x6:hover,.link_ecgS.link2_y3x6:hover{opacity:1;transform:scale(1.03)}.closeBtn_fC0A{background:none;border:none;border-radius:4px;color:var(--black);cursor:pointer;font-size:1.5rem;line-height:1;opacity:.8;padding:0 .25rem .1rem;position:absolute;right:1rem;transition:.2s}.closeBtn_fC0A:hover{background:#1d8c4f;opacity:1}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);-webkit-text-decoration:none;text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{border-left:0;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tags_jXut{display:inline}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;transform:scale(1);visibility:visible}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}#__docusaurus-base-url-issue-banner-container,.docSidebarContainer_YfHR,.hideAction_vcyE>svg,.navbarSearchContainer_Bca1:empty,.sidebarLogo_isFc,.themedComponent_mlkZ,.toggleIcon_g3eP,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}[data-theme-choice=dark] .darkToggleIcon_wfgR,[data-theme-choice=light] .lightToggleIcon_pyhR,[data-theme-choice=system] .systemToggleIcon_QzmC,[data-theme=dark] .themedComponent--dark_xIcU,[data-theme=light] .themedComponent--light_NVdE,html:not([data-theme]) .themedComponent--light_NVdE{display:initial}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}[data-theme=dark]:root{--docusaurus-collapse-button-bg:#ffffff0d;--docusaurus-collapse-button-bg-hover:#ffffff1a}.collapseSidebarButton_PEFL{display:none;margin:0}.categoryLinkLabel_W154,.linkLabel_WmDU{display:-webkit-box;-webkit-box-orient:vertical;overflow:hidden}.iconExternalLink_nPIU{margin-left:.3rem}.linkLabel_WmDU{line-clamp:2;-webkit-line-clamp:2}.categoryLink_byQd{overflow:hidden}.menu__link--sublist-caret:after{margin-left:var(--ifm-menu-link-padding-vertical)}.categoryLinkLabel_W154{flex:1;line-clamp:2;-webkit-line-clamp:2}.docMainContainer_TBSr,.docRoot_UBD9{display:flex;width:100%}.docsWrapper_hBAB{display:flex;flex:1 0 auto}.notFoundPage_Wsy5{align-items:center;background:var(--hero-background);display:flex;justify-content:center;min-height:calc(100vh - 4rem);overflow:hidden;position:relative}.container_a6qs{padding:2rem;position:relative;text-align:center;z-index:2}.glitchCode_Pt6F{animation:3s ease-in-out infinite d;color:var(--primary);font-family:Racing Sans One,monospace;font-size:10rem;font-weight:900;line-height:1;position:relative;text-shadow:0 0 20px color-mix(in srgb,var(--primary) 40%,#0000),0 0 60px color-mix(in srgb,var(--primary) 20%,#0000)}.badge_qP1g,.count_Ad5j,.monthHeader_QFki,.sha_JsPS,.tagCard_SluW .entryTitle_RUqs,.tagPill_IKwa{font-family:Roboto Mono,monospace}.title_B9uO{color:var(--text-color);font-size:2rem;font-weight:700;margin:1rem 0 .5rem}.subtitle_Z226{color:var(--mid-grey);font-size:1.1rem;line-height:1.6;margin-bottom:2.5rem;margin-left:auto;margin-right:auto;max-width:480px}.navLinks_NElv{display:flex;flex-wrap:wrap;gap:1rem;justify-content:center;margin-top:1rem}.navLink_KmGT{align-items:center;border-radius:8px;cursor:pointer;display:inline-flex;font-size:1rem;font-weight:600;gap:.5rem;padding:.75rem 1.5rem;transition:.25s}.navLink_KmGT:hover{transform:translateY(-2px)}.primaryLink_UP3n{background:var(--primary);color:var(--hero-background)}.primaryLink_UP3n:hover{box-shadow:0 4px 20px color-mix(in srgb,var(--primary) 50%,#0000);color:var(--hero-background)}.secondaryLink_VStI{background:#0000;border:2px solid var(--primary);color:var(--primary)}.secondaryLink_VStI:hover{background:color-mix(in srgb,var(--primary) 10%,#0000);color:var(--primary)}.particles_xv3x{inset:0;overflow:hidden;position:absolute;z-index:1}.particle_Q0bD{animation:linear infinite c;background:var(--primary);border-radius:50%;height:4px;opacity:.3;position:absolute;width:4px}.particle_Q0bD:first-child{animation-delay:-2s;animation-duration:16s;height:5px;left:61%;opacity:.38;top:21%;width:6px}.particle_Q0bD:nth-child(2){animation-delay:-4s;animation-duration:18s;height:5px;left:77%;opacity:.24;top:58%;width:5px}.particle_Q0bD:nth-child(3){animation-delay:-3s;animation-duration:19s;height:6px;left:52%;opacity:.16;top:46%;width:3px}.particle_Q0bD:nth-child(4){animation-delay:-5s;animation-duration:17s;height:6px;left:21%;opacity:.22;top:40%;width:5px}.particle_Q0bD:nth-child(5){animation-delay:-1s;animation-duration:10s;height:3px;left:44%;opacity:.29;top:94%;width:3px}.particle_Q0bD:nth-child(6){animation-delay:-1s;animation-duration:15s;height:6px;left:51%;opacity:.35;top:75%;width:6px}.particle_Q0bD:nth-child(7){animation-delay:-1s;animation-duration:16s;height:3px;left:77%;opacity:.3;top:90%;width:3px}.particle_Q0bD:nth-child(8){animation-delay:-4s;animation-duration:10s;height:6px;left:48%;opacity:.29;top:74%;width:6px}.particle_Q0bD:nth-child(9){animation-delay:-4s;animation-duration:18s;height:4px;left:61%;opacity:.15;top:80%;width:4px}.particle_Q0bD:nth-child(10){animation-delay:-1s;animation-duration:19s;height:3px;left:26%;opacity:.38;top:80%;width:3px}.particle_Q0bD:nth-child(11){animation-delay:-4s;animation-duration:13s;height:4px;left:75%;opacity:.34;top:2%;width:6px}.particle_Q0bD:nth-child(12){animation-delay:-1s;animation-duration:9s;height:3px;left:5%;opacity:.33;top:84%;width:3px}.particle_Q0bD:nth-child(13){animation-delay:-3s;animation-duration:20s;height:5px;left:85%;opacity:.32;top:2%;width:5px}.particle_Q0bD:nth-child(14){animation-delay:-1s;animation-duration:19s;height:5px;left:61%;opacity:.11;top:43%;width:3px}.particle_Q0bD:nth-child(15){animation-delay:-5s;animation-duration:20s;height:4px;left:34%;opacity:.28;top:66%;width:5px}.particle_Q0bD:nth-child(16){animation-delay:-1s;animation-duration:18s;height:6px;left:59%;opacity:.23;top:71%;width:6px}.particle_Q0bD:nth-child(17){animation-delay:-5s;animation-duration:13s;height:6px;left:70%;opacity:.17;top:25%;width:5px}.particle_Q0bD:nth-child(18){animation-delay:-3s;animation-duration:18s;height:6px;left:100%;opacity:.14;top:100%;width:4px}.particle_Q0bD:nth-child(19){animation-delay:-3s;animation-duration:9s;height:6px;left:80%;opacity:.24;top:50%;width:3px}.particle_Q0bD:nth-child(20){animation-delay:-5s;animation-duration:15s;height:3px;left:15%;opacity:.23;top:29%;width:4px}@keyframes c{0%,to{opacity:0;transform:translateY(0) translateX(0)}10%,90%{opacity:.3}50%{transform:translateY(-100px) translateX(30px)}}@keyframes d{0%,to{opacity:1}50%{opacity:.85}}.dropdownNavbarItemMobile_J0Sd{cursor:pointer}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.searchBar_RVTs .dropdownMenu_qbY6{background:var(--search-local-modal-background,#f5f6f7);border-radius:6px;box-shadow:var(--search-local-modal-shadow,inset 1px 1px 0 0 #ffffff80,0 3px 8px 0 #555a64);left:auto!important;margin-top:8px;padding:var(--search-local-spacing,12px);position:relative;right:0!important;width:var(--search-local-modal-width,560px)}.searchInput_YFbd:focus{outline:2px solid var(--search-local-input-active-border-color,var(--ifm-color-primary));outline-offset:0}div.ask-ai,html[data-theme=dark] div.ask-ai{--ask-ai-primary:var(--ifm-color-primary);--ask-ai-primary-hover:var(--ifm-color-primary-light);--ask-ai-foreground:var(--ifm-color-content);--ask-ai-border:var(--ifm-color-emphasis-300);--ask-ai-error:var(--ifm-color-danger);--ask-ai-button-bg:var(--ifm-color-emphasis-200)}.ask-ai{--ask-ai-background:var(--search-local-modal-background,#f5f6f7);--ask-ai-muted:var(--search-local-muted-color,#969faf)}html[data-theme=dark] .ask-ai{--ask-ai-background:var(--search-local-modal-background,var(--ifm-background-color));--ask-ai-muted:var(--search-local-muted-color,var(--ifm-color-secondary-darkest))}html[data-theme=dark] .searchBar_RVTs .dropdownMenu_qbY6{background:var(--search-local-modal-background,var(--ifm-background-color));box-shadow:var(--search-local-modal-shadow,inset 1px 1px 0 0 #2c2e40,0 3px 8px 0 #000309)}.searchBar_RVTs .dropdownMenu_qbY6 .suggestion_fB_2{align-items:center;background:var(--search-local-hit-background,#fff);border-radius:4px;box-shadow:var(--search-local-hit-shadow,0 1px 3px 0 #d4d9e1);color:var(--search-local-hit-color,#444950);cursor:pointer;display:flex;flex-direction:row;height:var(--search-local-hit-height,56px);padding:0 var(--search-local-spacing,12px);width:100%}html[data-theme=dark] .dropdownMenu_qbY6 .suggestion_fB_2{background:var(--search-local-hit-background,var(--ifm-color-emphasis-100));box-shadow:var(--search-local-hit-shadow,none);color:var(--search-local-hit-color,var(--ifm-font-color-base))}.searchBar_RVTs .dropdownMenu_qbY6 .suggestion_fB_2:not(:last-child){margin-bottom:4px}.searchBar_RVTs .dropdownMenu_qbY6 .suggestion_fB_2.cursor_eG29{background-color:var(--search-local-highlight-color,var(--ifm-color-primary))}.hitFooter_E9YW a,.hitIcon_a7Zy,.hitPath_ieM4,.hitTree_kk6K,.noResultsIcon_EBY5{color:var(--search-local-muted-color,#969faf)}html[data-theme=dark] .hitIcon_a7Zy,html[data-theme=dark] .hitPath_ieM4,html[data-theme=dark] .hitTree_kk6K,html[data-theme=dark] .noResultsIcon_EBY5{color:var(--search-local-muted-color,var(--ifm-color-secondary-darkest))}.hitTree_kk6K{align-items:center;display:flex}.hitTree_kk6K>svg{height:var(--search-local-hit-height,56px);opacity:.5;width:24px}.hitIcon_a7Zy,.hitTree_kk6K>svg{stroke-width:var(--search-local-icon-stroke-width,1.4)}.hitAction_NqkB,.hitIcon_a7Zy{height:20px;width:20px}.hitWrapper_sAK8{display:flex;flex:1 1 auto;flex-direction:column;font-weight:500;justify-content:center;margin:0 8px;overflow-x:hidden;width:80%}.hitWrapper_sAK8 mark{background:none;color:var(--search-local-highlight-color,var(--ifm-color-primary))}.hitTitle_vyVt{font-size:.9em}.hitPath_ieM4{font-size:.75em}.hitPath_ieM4,.hitTitle_vyVt{overflow-x:hidden;text-overflow:ellipsis;white-space:nowrap}.noResults_l6Q3{align-items:center;display:flex;flex-direction:column;justify-content:center;padding:var(--search-local-spacing,12px) 0}.noResultsIcon_EBY5{margin-bottom:var(--search-local-spacing,12px)}.hitFooter_E9YW{font-size:.85em;margin-top:var(--search-local-spacing,12px);text-align:center}.suggestion_fB_2.cursor_eG29,.suggestion_fB_2.cursor_eG29 .hitIcon_a7Zy,.suggestion_fB_2.cursor_eG29 .hitPath_ieM4,.suggestion_fB_2.cursor_eG29 .hitTree_kk6K,.suggestion_fB_2.cursor_eG29 mark{color:var(--search-local-hit-active-color,var(--ifm-color-white))!important}.searchBarContainer_NW3z{margin-left:16px}.searchBarContainer_NW3z .searchBarLoadingRing_YnHq{display:none;left:10px;position:absolute;top:6px}.searchBarContainer_NW3z .searchClearButton_qk4g{background:none;border:none;line-height:1rem;padding:0;position:absolute;right:.8rem;top:50%;transform:translateY(-50%)}.navbar__search{position:relative}.searchIndexLoading_EJ1f .navbar__search-input{background-image:none}.searchHintContainer_Pkmr{align-items:center;display:flex;gap:4px;height:100%;justify-content:center;pointer-events:none;position:absolute;right:10px;top:0}.searchHint_iIMx{background-color:var(--ifm-navbar-search-input-background-color);border:1px solid var(--ifm-color-emphasis-500);box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-500);color:var(--ifm-navbar-search-input-placeholder-color)}html[dir=rtl] .searchHintContainer_Pkmr{left:10px;right:auto}html[dir=rtl] .searchBarContainer_NW3z .searchClearButton_qk4g{left:.8rem;right:auto}html[dir=rtl] .searchBarContainer_NW3z .searchBarLoadingRing_YnHq{left:auto;right:10px}html[dir=rtl] .navbar__search-input{padding:0 2.25em 0 .5em}.loadingRing_RJI3{display:inline-block;height:20px;opacity:var(--search-local-loading-icon-opacity,.5);position:relative;width:20px}.loadingRing_RJI3 div{animation:1.2s cubic-bezier(.5,0,.5,1) infinite e;border:2px solid var(--search-load-loading-icon-color,var(--ifm-navbar-search-input-color));border-color:var(--search-load-loading-icon-color,var(--ifm-navbar-search-input-color)) #0000 #0000 #0000;border-radius:50%;display:block;height:16px;margin:2px;position:absolute;width:16px}.loadingRing_RJI3 div:first-child{animation-delay:-.45s}.loadingRing_RJI3 div:nth-child(2){animation-delay:-.3s}.loadingRing_RJI3 div:nth-child(3){animation-delay:-.15s}@keyframes e{0%{transform:rotate(0)}to{transform:rotate(1turn)}}.navbarHideable_m1mJ{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}.badge_qP1g,.commitMeta_teNK,.commitMsg_XeKn,.name_mmMI{white-space:nowrap}.errorBoundaryFallback_VBag{color:red;padding:.55rem}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.navbar__items--right>:last-child{padding-right:0}.lastUpdated_JAkA{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link,header.heroBanner_qw_p img.starButton_Vbnu:hover{opacity:1}.anchorTargetStickyNavbar_Vzrq{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorTargetHideOnScrollNavbar_vjPI{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;user-select:none}.hash-link:before{content:"#"}.mainWrapper_z2l0{display:flex;flex:1 0 auto;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.searchContextInput_mXoe,.searchQueryInput_CFBF{background:var(--ifm-background-color);border:var(--ifm-global-border-width) solid var(--ifm-color-content-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-font-color-base);font-size:var(--ifm-font-size-base);margin-bottom:1rem;padding:.5rem;width:100%}.monthHeader_QFki,.updatesPage_z4Av,header.heroBanner_qw_p,main.docs{background:var(--hero-background)}.releaseCard_aa3v,.tagCard_SluW{border-radius:8px;box-shadow:var(--feature-img-shadow)}.searchResultItem_U687{border-bottom:1px solid #dfe3e8;padding:1rem 0}.searchResultItemPath_uIbk{color:var(--ifm-color-content-secondary);font-size:.8rem;margin:.5rem 0 0}.searchResultItemSummary_oZHr{font-style:italic;margin:.5rem 0 0}.updatesPage_z4Av{min-height:80vh;padding:2rem 1rem 4rem}.pageHeader_g4VR{margin-bottom:2.5rem;text-align:center}.pageHeader_g4VR h1{color:var(--text-color);font-family:Racing Sans One,cursive;font-size:2.5rem;margin-bottom:.25rem}.pageHeader_g4VR p{color:var(--mid-grey);font-family:Raleway,sans-serif;font-size:1.1rem;margin:0}.timeline_WTQQ{margin:0 auto;max-width:1000px;padding-left:2.5rem;position:relative;width:80%}.timeline_WTQQ:before{background:var(--mid-grey);bottom:0;content:"";left:0;opacity:.4;position:absolute;top:0;width:2px}.monthHeader_QFki{color:var(--mid-grey);font-size:1rem;margin:0;padding:.75rem 0 .5rem;position:sticky;top:60px;z-index:1}.entry_mTt2{margin-bottom:1rem;position:relative}.entry_mTt2:before{border-radius:50%;content:"";position:absolute;z-index:1}.releaseEntry_ZG2V:before{background:var(--accent-pink);height:14px;left:-2.5rem;margin-left:-6px;top:1rem;width:14px}.tagEntry_ORGt:before{background:var(--accent-blue);height:10px;left:-2.5rem;margin-left:-4px;top:1rem;width:10px}.commitEntry_JtMn:before{background:var(--mid-grey);height:6px;left:-2.5rem;margin-left:-2px;top:.9rem;width:6px}.commitRow_RIZe:hover,.releaseCard_aa3v,.tagCard_SluW{background:var(--background)}.releaseCard_aa3v{border-left:4px solid var(--accent-pink);padding:1.25rem 1.5rem}.releaseCard_aa3v .entryTitle_RUqs{align-items:center;color:var(--text-color);display:flex;flex-wrap:wrap;font-family:Roboto Mono,monospace;font-size:1.3rem;gap:.5rem;margin:0 0 .5rem}.tagCard_SluW{border-left:4px solid var(--accent-blue);padding:1rem 1.25rem}.badgeRelease_agcf,.button.color-btn.btn-pink{background:var(--accent-pink)}.tagCard_SluW .entryTitle_RUqs{font-size:1.1rem;gap:.5rem;margin:0 0 .25rem}.commitRow_RIZe,.tagCard_SluW .entryTitle_RUqs{align-items:center;color:var(--text-color);display:flex}.commitRow_RIZe{border-bottom:1px solid #80808026;gap:.75rem;padding:.5rem 0;transition:background .15s}.commitRow_RIZe:hover{color:var(--text-color)}.badge_qP1g{border-radius:4px;color:#fff;display:inline-block;font-size:.7rem;line-height:1.4;padding:.1rem .5rem}.badgeTag_gC_o{background:var(--accent-blue)}.tagPill_IKwa{border:1px solid var(--mid-grey);border-radius:4px;color:var(--mid-grey);font-size:.8rem;padding:.05rem .4rem}.avatarSmall_luV7,.avatar_Vzby{border-radius:50%;vertical-align:middle}.errorMessage_lztz,.fetchErrorCard_M8w3{box-shadow:var(--feature-img-shadow);padding:1.25rem 1.5rem;text-align:center}.bodyPreview_iKaD{color:var(--mid-grey);display:-webkit-box;font-size:.9rem;-webkit-line-clamp:3;margin:.25rem 0 .5rem;-webkit-box-orient:vertical;line-height:1.5;overflow:hidden}.meta_GplF,.sha_JsPS{color:var(--mid-grey);font-size:.85rem}.meta_GplF{align-items:center;display:flex;flex-wrap:wrap;gap:.75rem}.meta_GplF a{color:var(--mid-grey)}.linksList_CKaa img,.meta_GplF a .providerIcon_NdOm{margin-right:.25rem;vertical-align:middle;width:1.35rem}.avatar_Vzby{height:24px;width:24px}.authorInfo_pi2M{align-items:center;display:flex;gap:.35rem}.sha_JsPS{flex-shrink:0}.commitMsg_XeKn{font-size:.95rem;max-width:500px;overflow:hidden}.authorLink_YWtN{color:var(--text-color);opacity:.75;transition:.2s}.authorLink_YWtN:hover .avatarSmall_luV7{transform:scale(1.08)}.avatarSmall_luV7{height:18px;margin-right:.2rem;transition:.2s;width:18px}.errorMessage_lztz,.fetchErrorCard_M8w3,.skeleton_NVtD{border-radius:8px;background:var(--background)}.commitMeta_teNK{align-items:center;color:var(--mid-grey);display:flex;flex-shrink:0;font-size:.8rem;gap:.3rem;margin-left:auto}.skeleton_NVtD{animation:1.5s ease-in-out infinite f;height:80px;margin-bottom:1rem}@keyframes f{0%,to{opacity:.4}50%{opacity:1}}.loadMore_YatW{display:flex;justify-content:center;margin:2rem auto}.fetchErrorCard_M8w3{color:var(--mid-grey);font-size:.95rem;margin:1.5rem auto;max-width:1000px;width:80%}.fetchErrorCard_M8w3 a{color:var(--accent-blue)}.errorMessage_lztz{color:var(--mid-grey);font-size:1.1rem;margin:0 auto;width:fit-content}.errorMessage_lztz p{margin:.25rem 0}html[data-theme=light]{--heading-shadow:-2px 3px 2px #a2a1a1;--sub-heading-shadow:-1px 1px 1px #a2a1a1}header.heroBanner_qw_p{min-height:calc(100vh - 4rem);overflow:hidden;padding:4rem 1rem 2rem;position:relative;text-align:center}header.heroBanner_qw_p h1.heroTitle_CteR{font-family:Racing Sans One,mono;font-size:8rem;text-shadow:var(--heading-shadow)}header.heroBanner_qw_p h3.heroSubTitle_p8ER{text-shadow:var(--sub-heading-shadow)}header.heroBanner_qw_p img.starButton_Vbnu{opacity:.85;position:absolute;right:1rem;top:1rem;width:12rem}.buttons_LJn2{align-items:center;display:flex;justify-content:center;margin:1.5rem}.dashyDescription_iLL2{font-size:1.2rem;margin:1rem auto;max-width:680px;text-align:left}.dashyDescription_iLL2>p,.dashyDescription_iLL2>span{margin-left:auto;margin-right:auto;max-width:680px}.keepReading_G_Ux{cursor:pointer;font-size:1.2rem;margin-left:.5rem}.scrollDown_cjGa{bottom:0;cursor:pointer;display:flex;left:42%;margin:2rem auto;position:absolute;width:fit-content}.scrollDownText_HIIX{color:var(--text-color);font-size:1.2rem;font-weight:700;margin:0 1rem}.scrollDownIcon_UZ2V{width:2rem}.scrollDownIcon_UZ2V path{fill:var(--text-color)}.sponsorContainer_zSLg{display:flex;flex-direction:column;gap:1rem;margin:1.5rem auto;max-width:680px}.sponsor_JDQ1{background:var(--background);color:var(--text-color);display:flex;flex-direction:column-reverse;gap:.5rem;justify-content:left;padding:.5rem;width:100%}.sponsor_JDQ1 span{font-size:.9rem;text-align:center}.sponsor_JDQ1 span a{color:var(--text-color);font-size:.9rem}.button{border:none;border-radius:4px;color:var(--black);cursor:pointer;display:inline-block;display:flex;font-size:1.3rem;font-weight:700;margin:.5rem;min-width:12rem;padding:.75rem 1rem;position:relative;transition:none}.button svg{margin-right:.5rem;width:1.8rem}.button.btn-small{font-size:1rem;max-width:12rem;min-width:auto;padding:.5rem .75rem;width:100%}.button.btn-small svg{margin-right:.35rem;width:1.2rem}.button.color-btn:hover{color:rgba(0,0,0,.702);top:2px}.button.color-btn:active{box-shadow:none!important;color:rgba(0,0,0,.502);top:4px}.button.color-btn.btn-pink{box-shadow:0 4px var(--accent-pink-dark)}.button.color-btn.btn-pink:hover{box-shadow:0 2px var(--accent-pink-dark)}.button.color-btn.btn-purple{background:var(--accent-purple);box-shadow:0 4px var(--accent-purple-dark)}.button.color-btn.btn-purple:hover{box-shadow:0 2px var(--accent-purple-dark)}.button.color-btn.btn-blue{background:var(--accent-blue);box-shadow:0 4px var(--accent-blue-dark)}.button.color-btn.btn-blue:hover{box-shadow:0 2px var(--accent-blue-dark)}.button.color-btn.btn-green{background:var(--accent-green);box-shadow:0 4px var(--accent-green-dark)}.button.color-btn.btn-green:hover{box-shadow:0 2px var(--accent-green-dark)}.button.color-btn.btn-yellow{background:var(--accent-yellow);box-shadow:0 4px var(--accent-yellow-dark)}.button.color-btn.btn-yellow:hover{box-shadow:0 2px var(--accent-yellow-dark)}.enjoyingWrap_FXPn .enjoyingWrapPart_oGX0,.home-page-features-wrapper .feature .feature-half.assets,.statItem_at6_,.tile_CRAN:hover,main.docs{box-shadow:var(--feature-img-shadow)}main.docs{margin:1rem auto;max-width:1250px;padding:1rem}main.docs h1.docs-title{font-size:5rem;margin:0;text-align:center}main.docs p.see-repo-note{background:rgba(255,255,170,.839);border-radius:3px;display:none;padding:.25rem 1rem;width:fit-content}main.docs p.see-repo-note a,main.docs p.see-repo-note b,main.docs p.see-repo-note span{color:#000;font-size:1rem;font-style:italic}main.docs p.see-repo-note a{color:#000;font-size:1rem;font-weight:700}main.docs div.row1{display:flex;flex-direction:row}main.docs div.docs-links-section{display:flex;flex-wrap:wrap}main.docs div.docs-contents{color:var(--text-color);display:flex;flex-direction:column;justify-content:space-around}main.docs div.docs-contents h3.section-title{margin:1rem .5rem .5rem}main.docs div.docs-contents a{display:flex;flex-direction:column;margin:.5rem .75rem;min-height:5rem;padding:.25rem .5rem;width:calc(33% - 1.5rem)}main.docs div.docs-contents a p.name{font-size:1.4rem;margin:0;text-align:left}main.docs div.docs-contents a span.description{font-size:1rem;text-align:left;white-space:pre-wrap}.color-pink{--feature-color:var(--accent-pink)}.color-blue{--feature-color:var(--accent-blue)}.color-green{--feature-color:var(--accent-green)}.color-yellow{--feature-color:var(--accent-yellow)}.color-white{--feature-color:#fff}html[data-theme=light] .color-pink{--feature-color:var(--accent-pink-dark)}html[data-theme=light] .color-blue{--feature-color:var(--accent-purple-dark)}html[data-theme=light] .color-green{--feature-color:var(--accent-green-dark)}html[data-theme=light] .color-yellow{--feature-color:var(--accent-yellow-dark)}html[data-theme=light] .color-white{--feature-color:#000}.home-page-features-wrapper{display:flex;flex-direction:column;font-size:1.2rem}.home-page-features-wrapper .feature{align-items:center;display:flex;justify-content:center;margin:0;padding:.5rem}.home-page-features-wrapper .feature.align-left{background:var(--background);box-shadow:0 1px 4px #000;flex-direction:row}.home-page-features-wrapper .feature.align-right{background:var(--hero-background);box-shadow:0 -1px 4px rgba(0,0,0,.702);flex-direction:row-reverse}.home-page-features-wrapper .feature .feature-half{margin:1rem;padding:.25rem;width:40%}.home-page-features-wrapper .feature .feature-half.assets{align-items:center;background:var(--feature-color);border-radius:8px;display:flex;height:fit-content;justify-content:center;margin:.5rem}.home-page-features-wrapper .feature .feature-half.assets img.demo,.home-page-features-wrapper .feature .feature-half.assets span.not-demo{background:var(--kinda-transparent);border-radius:8px;box-shadow:var(--feature-img-shadow);height:100%;max-height:36rem;min-height:12rem;object-fit:contain;width:100%}.home-page-features-wrapper .feature .feature-half.assets span.not-demo{align-items:center;display:flex;justify-content:center}.home-page-features-wrapper .feature .feature-title{align-items:flex-end;color:var(--feature-color);display:flex;margin:1rem 0}.home-page-features-wrapper .feature .feature-title svg{margin-right:.5rem;width:2rem}.home-page-features-wrapper .feature div.read-the-docs a.button-link-wrapper{margin:0 1rem 1rem}.home-page-features-wrapper .feature div.read-the-docs small{margin:0 .5rem;opacity:.75}.authorsSection_t3c7{background:var(--hero-background);padding:3rem 1rem}.inner_rVjr{margin:.5rem auto;width:80%}.heading_j3J0{color:var(--text-color);font-size:2rem}.enjoyingWrap_FXPn{display:flex;gap:2rem;margin-bottom:2rem}.enjoyingWrap_FXPn .enjoyingWrapPart_oGX0{background:var(--background);border-radius:8px;padding:.5rem 1rem;width:50%}.enjoyingWrap_FXPn .enjoyingWrapPart_oGX0 p{margin:0 0 .5rem}.enjoyingWrap_FXPn .enjoyingWrapPart_oGX0 .authorInnerWrap_y4gi{align-items:center;display:flex;gap:.75rem}.subHeading_D3Yw{color:var(--text-color);font-size:1.2rem;margin:.25rem 0}.grid_qTnk{display:grid;gap:.75rem;grid-template-columns:repeat(auto-fill,minmax(120px,1fr));margin:0 auto 2rem;max-width:1800px;padding:0}.tile_CRAN{align-items:center;background:var(--background);border-radius:8px;display:flex;flex-direction:column;gap:.4rem;padding:.6rem;position:relative;transition:transform .2s,box-shadow .2s}.ctaSection_oQB2,.statItem_at6_{align-items:center;display:flex}.tile_CRAN,.tile_CRAN:hover{color:var(--text-color);-webkit-text-decoration:none;text-decoration:none}.builtBy_GoGF,.name_mmMI{color:var(--mid-grey);font-size:.9rem}.tile_CRAN:hover{transform:translateY(-2px)}.avatar__HA9{border-radius:50%;height:48px;width:48px}.name_mmMI{max-width:120px;overflow:hidden}.star_JoTu{position:absolute;right:.5rem;top:.5rem}.fallback_O_bA{margin:0 auto;max-width:100%}.fallback_O_bA img{height:auto;max-width:100%}.ctaSection_oQB2{flex-direction:row;gap:.5rem;justify-content:center;margin-top:.25rem}.builtBy_GoGF{margin-bottom:1rem}.statsSection_Rc3S{background:var(--hero-background);padding:.25rem 1rem 3rem}.inner_YtnN{display:flex;flex-wrap:wrap;gap:1.5rem;justify-content:space-around;margin:0 auto;max-width:1000px;width:80%}.statItem_at6_{background:var(--background);border-radius:8px;flex:1 1 180px;flex-direction:column;max-width:240px;padding:1.5rem 2rem;text-align:center}.icon_vhSc{height:3rem;margin-bottom:.25rem;width:3rem}.count_Ad5j,.icon_vhSc{color:var(--stat-color)}.count_Ad5j{font-size:2.8rem;font-weight:400;line-height:1.1}.label_wElN{color:var(--mid-grey);font-size:1rem;margin-top:.25rem}.buttonGroup_M5ko button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}iframe#dashy-survey{border:none;height:92vh;width:100%}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:line-count;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(line-count);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_Vdqa{opacity:1!important}.copyButtonIcons_IEyt{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_TrPX,.copyButtonSuccessIcon_cVMy{fill:currentColor;height:inherit;left:0;opacity:inherit;position:absolute;top:0;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_cVMy{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_Vdqa .copyButtonIcon_TrPX{opacity:0;transform:scale(.33)}.copyButtonCopied_Vdqa .copyButtonSuccessIcon_cVMy{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.wordWrapButtonIcon_b1P5{height:1.2rem;width:1.2rem}.buttonGroup_M5ko{column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup_M5ko button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup_M5ko button:focus-visible,.buttonGroup_M5ko button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup_M5ko button{opacity:.4}.codeBlockContent_QJqH{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_OeMC{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlockTitle_OeMC+.codeBlockContent_QJqH .codeBlock_a8dz{border-top-left-radius:0;border-top-right-radius:0}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:#0000 #0000 #0000 var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.img_ev3q{height:auto}.admonition_xJq3{margin-bottom:1em}.admonitionHeading_Gvgb{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family)}.admonitionHeading_Gvgb:not(:last-child){margin-bottom:.3rem}.admonitionHeading_Gvgb code{text-transform:none}.admonitionIcon_Rf37{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_Rf37 svg{display:inline-block;fill:var(--ifm-alert-foreground-color);height:1.6em;width:1.6em}.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_TmdG{background-color:var(--docusaurus-collapse-button-bg)}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;transform:rotate(180deg)}.expandButtonIcon_i1dp,[dir=rtl] .collapseSidebarButtonIcon_kv0_{transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_TmdG:focus,.expandButton_TmdG:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);-webkit-text-decoration:none!important;text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_TmdG{align-items:center;display:flex;height:100%;justify-content:center;position:absolute;right:0;top:0;transition:background-color var(--ifm-transition-fast) ease;width:100%}[dir=rtl] .expandButtonIcon_i1dp{transform:rotate(180deg)}.docSidebarContainer_YfHR{border-right:1px solid var(--ifm-toc-border-color);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_DPk8{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_aRkj{height:100%;max-height:100vh;position:sticky;top:0}.docMainContainer_TBSr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_lQrH{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_JWYK{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.navbarSearchContainer_Bca1{padding:0 var(--ifm-navbar-item-padding-horizontal)}.lastUpdated_JAkA{text-align:right}.tocMobile_ITEo{display:none}.docItemCol_VOVn{max-width:75%!important}}@media screen and (min-width:1200px){.sponsorContainer_zSLg{flex-direction:row;justify-content:center;max-width:1000px}.sponsor_JDQ1{flex:1 1 0;min-height:100%}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block;width:max-content}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.navbarSearchContainer_Bca1{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media not (max-width:996px){.searchBar_RVTs.searchBarLeft_MXDe .dropdownMenu_qbY6{left:0!important;right:auto!important}}@media only screen and (max-width:996px){.searchQueryColumn_q7nx{max-width:60%!important}.searchContextColumn_oWAF{max-width:40%!important}}@media (max-width:966px){.timeline_WTQQ{padding-left:2rem;width:100%}.commitEntry_JtMn:before,.releaseEntry_ZG2V:before,.tagEntry_ORGt:before{left:-2rem}.commitRow_RIZe{flex-wrap:wrap}.commitMsg_XeKn{max-width:100%}.commitMeta_teNK{margin-left:0}.bodyPreview_iKaD{-webkit-line-clamp:2}header.heroBanner_qw_p h1.heroTitle_CteR{font-size:6rem}header.heroBanner_qw_p h3.heroSubTitle_p8ER{font-size:1.5rem}.scrollDown_cjGa{display:none}.button{width:80%}.ctaSection_oQB2,.enjoyingWrap_FXPn,.home-page-features-wrapper .feature.align-left,.home-page-features-wrapper .feature.align-right{flex-direction:column}.home-page-features-wrapper .feature.align-left .feature-half,.home-page-features-wrapper .feature.align-right .feature-half{width:95%}.enjoyingWrap_FXPn .enjoyingWrapPart_oGX0,.inner_rVjr{width:100%}.grid_qTnk{grid-template-columns:repeat(auto-fill,minmax(100px,1fr))}.inner_YtnN{display:grid;gap:1rem;grid-template-columns:1fr 1fr;width:100%}.statItem_at6_{max-width:none;padding:1.25rem 1rem}.count_Ad5j{font-size:2.2rem}}@media screen and (max-width:966px){header.heroBanner_qw_p{padding:2rem}.buttons_LJn2{flex-direction:column}}@media (max-width:768px){.glitchCode_Pt6F{font-size:6rem}}@media (max-width:600px){.banner_woPo{font-size:.85rem;padding:.4rem .75rem}.closeBtn_fC0A{font-size:1.1rem;right:.5rem}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}.navbar__search-input:not(:focus){width:2rem}.searchBar_RVTs .dropdownMenu_qbY6{max-width:calc(100vw - var(--ifm-navbar-padding-horizontal)*2);width:var(--search-local-modal-width-sm,340px)}.searchBarContainer_NW3z:not(.focused_OWtg) .searchClearButton_qk4g,.searchHintContainer_Pkmr{display:none}}@media screen and (max-width:576px){.searchQueryColumn_q7nx{max-width:100%!important}.searchContextColumn_oWAF{max-width:100%!important;padding-left:var(--ifm-spacing-horizontal)!important}}@media (max-width:500px){main.docs div.docs-contents a{width:100%}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-color-scheme:dark){#carbonads{--carbon-bg-primary:#1f1f1f;--carbon-bg-secondary:#262626;--carbon-text-color:#e6e6e6}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}.skeleton_NVtD{animation:none;opacity:.6}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.noPrint_WFHX,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file +@import url(https://fonts.googleapis.com/css2?family=Racing+Sans+One&family=Poppins:wght@300&family=Roboto+Mono:wght@500;300&display=swap);.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown li,body{word-wrap:break-word}body,ol ol,ol ul,ul ol,ul ul{margin:0}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}#carbonads .carbon-poweredby,#carbonads a,#carbonads a:hover{color:var(--carbon-text-color)}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}*,.loadingRing_RJI3 div{box-sizing:border-box}.close,.home-page-features-wrapper .feature div.read-the-docs{float:right}.commitMsg_XeKn,.name_mmMI,.text--truncate{text-overflow:ellipsis}.clean-list,.containsTaskList_mC6p,.details_lb9f>summary,.dropdown__menu,.grid_qTnk,.menu__list{list-style:none}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:#0000;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:#0000000d;--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 #0000001a;--ifm-global-shadow-md:0 5px 40px #0003;--ifm-global-shadow-tl:0 12px 28px 0 #0003,0 2px 4px 0 #0000001a;--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:#0000;--ifm-table-stripe-background:#00000008;--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:#0000}html{background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);-webkit-font-smoothing:antialiased;text-rendering:optimizelegibility;-webkit-text-size-adjust:100%;text-size-adjust:100%;--primary:#54bff7;--background:var(--pale-grey);--text-color:var(--black);--hero-background:var(--bright-white);--kinda-transparent:#ffffffd9;--hyperlink:#ff62ce;--feature-img-shadow:4px 4px 6px #a9a9a980,-2px -2px 4px #0006;--footer-color:var(--white);--footer-text-color:var(--black);scroll-behavior:smooth}body{background:var(--background)}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid #0000001a;border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:initial;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}article div.markdown h1,h1{font-size:var(--ifm-h1-font-size)}article div.markdown h2,h2{font-size:var(--ifm-h2-font-size)}article div.markdown h3,h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}.container_lyt7,.container_lyt7>svg,img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){-webkit-text-decoration:none;text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_uzNF .wordWrapButtonIcon_b1P5{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_Gvgb,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;white-space:nowrap}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:#3578e526;--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:#ebedf026;--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:#00a40026;--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:#54c7ec26;--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:#ffba0026;--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:#fa383e26;--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.dropdown>.navbar__link:after,.searchBarContainer_NW3z.searchIndexLoading_EJ1f .searchBarLoadingRing_YnHq{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:any-link:hover,.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);-webkit-text-decoration:none;text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);-webkit-user-select:none;user-select:none;white-space:nowrap}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:#0000;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}#carbonads a,.banner_woPo,.button-link-wrapper:hover,.commitRow_RIZe,.commitRow_RIZe:hover,.dropdown__link--active,.dropdown__link:hover,.link2_y3x6:hover,.link_ecgS:hover,.menu__link:hover,.navLink_KmGT,.navLink_KmGT:hover,.navbar__brand:hover,.navbar__link--active,.navbar__link:hover,.pagination-nav__link:hover,.pagination__link:hover{-webkit-text-decoration:none;text-decoration:none}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);-webkit-text-decoration:none;text-decoration:none}.close{color:var(--ifm-color-black);font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;transform:translateY(-1px);visibility:visible}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;pointer-events:none;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem;white-space:nowrap}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color)}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor #0000;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_BuS1>:last-child,.collapsibleContent_i85q p:last-child,.details_lb9f>summary>p:last-child,.footer__items,.searchResultItem_U687>h2{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title,h2{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;transition-duration:var(--ifm-transition-fast);transition-timing-function:ease-in-out;top:0;left:0;visibility:hidden}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color)}.menu__caret:before,.menu__link--sublist-caret:after{height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem;content:"";filter:var(--ifm-menu-link-sublist-icon-filter)}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;margin-left:auto;min-width:1.25rem}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.navbar--fixed-top{position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color)}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.fetchErrorCard_M8w3 p,.home-page-features-wrapper .feature .feature-title h3,.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}#nprogress,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color)}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:#ffffff1a;--ifm-navbar-search-input-placeholder-color:#ffffff80;color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:#ffffff0d;--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:1rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);position:fixed;transform:translate3d(-100%,0,0);transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:#0009;position:fixed;right:0;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.footer,article div.markdown p img,nav.navbar{box-shadow:var(--feature-img-shadow)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav{display:grid;grid-gap:var(--ifm-spacing-horizontal);gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover)}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto;padding-left:0}.tabs__item{border-bottom:3px solid #0000;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:#ffffff0d;--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:#ffffff1a;--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:#ffffff12;--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec;--primary:#db78fc;--background:var(--dark-grey);--text-color:var(--white);--hero-background:var(--black);--kinda-transparent:#000000d9;--hyperlink:var(--primary);--feature-img-shadow:4px 4px 6px #00000080,-2px -2px 4px #0006;--footer-color:var(--black);--footer-text-color:var(--white);--heading-shadow:-5px 4px 0px #000;--sub-heading-shadow:-3px 3px 1px #000}:root{--docusaurus-progress-bar-color:var(--ifm-color-primary);--bright-white:#fff;--white:#f7f7f7;--pale-grey:#e9e9e8;--mid-grey:#a9a9a9;--dark-grey:#18191a;--black:#121212;--pitch-black:#000;--info:#35c9fa;--success:#8f8;--warning:#ece715;--danger:#f80363;--accent-green:#41ef90;--accent-green-dark:#1e9554;--accent-blue:#5c85f7;--accent-blue-dark:#3d48dd;--accent-purple:#9083ed;--accent-purple-dark:#6b3cd6;--accent-pink:#db78fc;--accent-pink-dark:#b83ddd;--accent-yellow:#dcff5a;--accent-yellow-dark:#ceb73f;--ifm-color-primary:var(--background);--ifm-color-primary-dark:#21af90;--ifm-color-primary-darker:#1fa588;--ifm-color-primary-darkest:#1a8870;--ifm-color-primary-light:#46cbae;--ifm-color-primary-lighter:#66d4bd;--ifm-color-primary-lightest:#92e0d0;--ifm-code-font-size:95%;--ifm-navbar-background-color:var(--hero-background);--ifm-navbar-link-color:var(--text-color);--ifm-breadcrumb-color-active:var(--text-color);--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docusaurus-announcement-bar-height:auto;--docusaurus-collapse-button-bg:#0000;--docusaurus-collapse-button-bg-hover:#0000001a;--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;transform:rotate(3deg) translateY(-4px);width:100px}h1{font-family:Racing Sans One,mono;font-size:4rem}button,h2,h3,h4,h5{font-family:Roboto Mono,monospace}h3{font-size:2rem}button,h4,h5{font-size:1.2rem}a,body,div,p,section,span,ul li{font-family:Poppins,sans-serif;font-size:1.2rem}.link2_y3x6,.link_ecgS,code span{font-family:Roboto Mono,monospace}.hero{--ifm-hero-background-color:var(--hero-background);--ifm-hero-text-color:var(--text-color)}.footer{--ifm-footer-background-color:var(--footer-color);--ifm-footer-color:var(--footer-text-color);--ifm-footer-link-color:var(--footer-text-color);--ifm-footer-title-color:var(--footer-text-color);--ifm-footer-link-hover-color:var(--primary);--ifm-link-color:var(--footer-text-color);--ifm-link-hover-color:var(--primary)}.footer .footer__link-item,.sidebar-ad #carbonads .carbon-text,article div.markdown a,article div.markdown code span,article div.markdown li,article div.markdown ol,article div.markdown p,article div.markdown ul,ul.table-of-contents li a{font-size:1rem}.footer .footer__copyright,.footer .footer__copyright a{font-family:Roboto Mono,monospace;font-size:.9rem;font-weight:700;opacity:.9}.docusaurus-highlight-code-line{background-color:#0000001a;display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}nav.navbar a.navbar__brand .navbar__logo,nav.navbar a.navbar__brand b{transition:.3s}nav.navbar a.navbar__brand:hover .navbar__logo{transform:scale(1.1) rotate(-3deg)}nav.navbar a.navbar__brand:hover b{color:#00eed6}nav.navbar a.navbar__brand b{font-size:1.5rem;font-weight:700}.authorLink_YWtN:hover,nav.navbar .navbar__link--active,nav.navbar .navbar__link:hover{color:var(--primary)}.fetchErrorCard_M8w3 a:hover,.meta_GplF a:hover,.pagination-nav__label,html[data-theme=light] main div.container.padding-top--md.padding-bottom--lg .pagination-nav__label{color:var(--text-color)}li a,li a:hover,p a,p a:hover,ul.table-of-contents li a:hover,ul.table-of-contents li a:hover code{color:var(--hyperlink)}.hitFooter_E9YW a,.suggestion_fB_2.cursor_eG29 mark,li a:hover,p a:hover{-webkit-text-decoration:underline;text-decoration:underline}h1,h2,h3,h4,h5{cursor:default}article div.markdown{--ifm-h1-font-size:3.0rem;--ifm-h2-font-size:2.5rem;--ifm-h3-font-size:1.4rem}article div.markdown p img{border-radius:4px}.sponsor_JDQ1,.sponsor_JDQ1 img,article div.markdown table>tr>td>a>img{border-radius:6px}ul.table-of-contents li a.table-of-contents__link--active,ul.table-of-contents li a.table-of-contents__link--active code{color:var(--hyperlink);font-weight:700}ul.menu__list{margin-bottom:1rem}ul.menu__list li.menu__list-item a.active,ul.menu__list li.menu__list-item a.menu__link--active{color:var(--primary);font-weight:700}code span{font-size:.9rem!important}html[data-theme=light] main div.container.padding-top--md.padding-bottom--lg{padding:0 1rem!important}html[data-theme=light] main div.container.padding-top--md.padding-bottom--lg div>div.col[class*=docItemCol]{background:var(--bright-white);border-right:1px solid var(--ifm-toc-border-color);padding:1rem}html[data-theme=light] main div.container.padding-top--md.padding-bottom--lg div>div.col[class*=docItemCol] ul li a{font-weight:700}html[data-theme=light] main div.container.padding-top--md.padding-bottom--lg .table-of-contents__left-border{border-left:none}#carbonads *{line-height:normal;margin:initial;padding:initial}#carbonads{--carbon-font-family:-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,Oxygen-Sans,Ubuntu,Cantarell,"Helvetica Neue",Helvetica,Arial,sans-serif;--carbon-font-size:14px;--carbon-padding:1.5ch;--carbon-max-char:20ch;--carbon-bg-primary:#fafafa;--carbon-bg-secondary:#ebebeb;--carbon-text-color:#333;font-family:var(--carbon-font-family);font-size:var(--carbon-font-size);margin:0 auto;width:fit-content;z-index:10}#carbonads>span{background-color:var(--carbon-bg-primary);box-shadow:0 0 1px rgba(0,0,0,.085),0 0 2px rgba(0,0,0,.085),0 0 4px rgba(0,0,0,.085),0 0 8px rgba(0,0,0,.085);display:flex;flex-direction:column;gap:var(--carbon-padding);max-inline-size:calc(130px + var(--carbon-max-char) + 8ch);min-inline-size:130px;padding:var(--carbon-padding)}#carbonads .carbon-wrap{display:flex;flex-wrap:wrap;gap:1.5ex}#carbonads .carbon-img{flex:0 0 130px}#carbonads .carbon-img img,.cursor_eG29 .hideAction_vcyE>svg,.tocCollapsibleContent_vkbj a{display:block}#carbonads .carbon-text{flex-basis:var(--carbon-max-char);flex-grow:1;line-height:1.4;text-align:left}#carbonads .carbon-poweredby{background:var(--carbon-bg-secondary);font-size:.6em;font-weight:600;letter-spacing:.2ch;line-height:1.4;padding:6px 8px;text-align:center;text-transform:uppercase}.sidebar-ad{--carbon-bg-primary:var(--background,#18191a);--carbon-bg-secondary:#282a36;--carbon-text-color:#e6e6e6}.sidebar-ad #carbonads{margin:.5rem}.sidebar-ad #carbonads .carbon-img img,.sidebar-ad .avatar__photo-link{border-radius:5px}.mdxPageWrapper_j9I6,.sidebar-ad #carbonads .carbon-wrap{justify-content:center}.banner_woPo,.tagWithCount_h2kH{align-items:center;display:flex}.sidebar-ad #carbonads>span{box-shadow:none}.sidebar-ad #carbonads .carbon-poweredby{border-radius:5px;font-size:.7rem}::selection{background:var(--primary);color:var(--background);text-shadow:none}@keyframes a{0%{opacity:0;transform:translateY(-100%)}to{opacity:1;transform:translateY(0)}}@keyframes b{0%{opacity:1}to{opacity:0;transform:translateY(-100%)}}.banner_woPo{animation:.3s ease-out a;background:var(--accent-green);color:var(--bright-white);flex-wrap:wrap;font-size:.95rem;font-weight:600;gap:.25rem 1.25rem;justify-content:center;padding:.25rem 1rem;position:relative;width:100%;z-index:100}.content_knG7 a,.fetchErrorCard_M8w3 a,.keepReading_G_Ux,.link2_y3x6.link2_y3x6,.link2_y3x6.link2_y3x6:hover,.link_ecgS.link2_y3x6,.link_ecgS.link2_y3x6:hover,.meta_GplF a,main.docs p.see-repo-note a{-webkit-text-decoration:underline;text-decoration:underline}.dismissing_ZrNM{animation:.25s ease-in forwards b}.link2_y3x6,.link_ecgS{color:var(--black);font-size:.95rem;font-weight:400;transition:.2s}.link2_y3x6.link2_y3x6,.link_ecgS.link2_y3x6{opacity:.85}.link2_y3x6.link2_y3x6:hover,.link_ecgS.link2_y3x6:hover{opacity:1;transform:scale(1.03)}.closeBtn_fC0A{background:none;border:none;border-radius:4px;color:var(--black);cursor:pointer;font-size:1.5rem;line-height:1;opacity:.8;padding:0 .25rem .1rem;position:absolute;right:1rem;transition:.2s}.closeBtn_fC0A:hover{background:#1d8c4f;opacity:1}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);-webkit-text-decoration:none;text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{border-left:0;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tags_jXut{display:inline}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;transform:scale(1);visibility:visible}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}#__docusaurus-base-url-issue-banner-container,.docSidebarContainer_YfHR,.hideAction_vcyE>svg,.navbarSearchContainer_Bca1:empty,.sidebarLogo_isFc,.themedComponent_mlkZ,.toggleIcon_g3eP,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}[data-theme-choice=dark] .darkToggleIcon_wfgR,[data-theme-choice=light] .lightToggleIcon_pyhR,[data-theme-choice=system] .systemToggleIcon_QzmC,[data-theme=dark] .themedComponent--dark_xIcU,[data-theme=light] .themedComponent--light_NVdE,html:not([data-theme]) .themedComponent--light_NVdE{display:initial}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}[data-theme=dark]:root{--docusaurus-collapse-button-bg:#ffffff0d;--docusaurus-collapse-button-bg-hover:#ffffff1a}.collapseSidebarButton_PEFL{display:none;margin:0}.categoryLinkLabel_W154,.linkLabel_WmDU{display:-webkit-box;-webkit-box-orient:vertical;overflow:hidden}.iconExternalLink_nPIU{margin-left:.3rem}.linkLabel_WmDU{line-clamp:2;-webkit-line-clamp:2}.categoryLink_byQd{overflow:hidden}.menu__link--sublist-caret:after{margin-left:var(--ifm-menu-link-padding-vertical)}.categoryLinkLabel_W154{flex:1;line-clamp:2;-webkit-line-clamp:2}.docMainContainer_TBSr,.docRoot_UBD9{display:flex;width:100%}.docsWrapper_hBAB{display:flex;flex:1 0 auto}.notFoundPage_Wsy5{align-items:center;background:var(--hero-background);display:flex;justify-content:center;min-height:calc(100vh - 4rem);overflow:hidden;position:relative}.container_a6qs{padding:2rem;position:relative;text-align:center;z-index:2}.glitchCode_Pt6F{animation:3s ease-in-out infinite d;color:var(--primary);font-family:Racing Sans One,monospace;font-size:10rem;font-weight:900;line-height:1;position:relative;text-shadow:0 0 20px color-mix(in srgb,var(--primary) 40%,#0000),0 0 60px color-mix(in srgb,var(--primary) 20%,#0000)}.badge_qP1g,.count_Ad5j,.monthHeader_QFki,.sha_JsPS,.tagCard_SluW .entryTitle_RUqs,.tagPill_IKwa{font-family:Roboto Mono,monospace}.title_B9uO{color:var(--text-color);font-size:2rem;font-weight:700;margin:1rem 0 .5rem}.subtitle_Z226{color:var(--mid-grey);font-size:1.1rem;line-height:1.6;margin-bottom:2.5rem;margin-left:auto;margin-right:auto;max-width:480px}.navLinks_NElv{display:flex;flex-wrap:wrap;gap:1rem;justify-content:center;margin-top:1rem}.navLink_KmGT{align-items:center;border-radius:8px;cursor:pointer;display:inline-flex;font-size:1rem;font-weight:600;gap:.5rem;padding:.75rem 1.5rem;transition:.25s}.navLink_KmGT:hover{transform:translateY(-2px)}.primaryLink_UP3n{background:var(--primary);color:var(--hero-background)}.primaryLink_UP3n:hover{box-shadow:0 4px 20px color-mix(in srgb,var(--primary) 50%,#0000);color:var(--hero-background)}.secondaryLink_VStI{background:#0000;border:2px solid var(--primary);color:var(--primary)}.secondaryLink_VStI:hover{background:color-mix(in srgb,var(--primary) 10%,#0000);color:var(--primary)}.particles_xv3x{inset:0;overflow:hidden;position:absolute;z-index:1}.particle_Q0bD{animation:linear infinite c;background:var(--primary);border-radius:50%;height:4px;opacity:.3;position:absolute;width:4px}.particle_Q0bD:first-child{animation-delay:-4s;animation-duration:9s;height:3px;left:41%;opacity:.23;top:67%;width:4px}.particle_Q0bD:nth-child(2){animation-delay:-1s;animation-duration:13s;height:5px;left:45%;opacity:.13;top:86%;width:3px}.particle_Q0bD:nth-child(3){animation-delay:-5s;animation-duration:11s;height:6px;left:52%;opacity:.26;top:3%;width:4px}.particle_Q0bD:nth-child(4){animation-delay:-2s;animation-duration:14s;height:5px;left:60%;opacity:.27;top:76%;width:3px}.particle_Q0bD:nth-child(5){animation-delay:-2s;animation-duration:20s;height:6px;left:60%;opacity:.22;top:53%;width:4px}.particle_Q0bD:nth-child(6){animation-delay:-3s;animation-duration:15s;height:4px;left:19%;opacity:.35;top:47%;width:4px}.particle_Q0bD:nth-child(7){animation-delay:-3s;animation-duration:16s;height:5px;left:14%;opacity:.11;top:52%;width:5px}.particle_Q0bD:nth-child(8){animation-delay:-3s;animation-duration:12s;height:3px;left:55%;opacity:.31;top:44%;width:3px}.particle_Q0bD:nth-child(9){animation-delay:-5s;animation-duration:14s;height:3px;left:67%;opacity:.37;top:40%;width:3px}.particle_Q0bD:nth-child(10){animation-delay:-3s;animation-duration:11s;height:6px;left:98%;opacity:.28;top:86%;width:6px}.particle_Q0bD:nth-child(11){animation-delay:-3s;animation-duration:18s;height:6px;left:83%;opacity:.27;top:21%;width:5px}.particle_Q0bD:nth-child(12){animation-delay:-5s;animation-duration:19s;height:5px;left:8%;opacity:.25;top:44%;width:6px}.particle_Q0bD:nth-child(13){animation-delay:-3s;animation-duration:11s;height:5px;left:13%;opacity:.17;top:61%;width:6px}.particle_Q0bD:nth-child(14){animation-delay:-3s;animation-duration:20s;height:5px;left:93%;opacity:.19;top:70%;width:4px}.particle_Q0bD:nth-child(15){animation-delay:-1s;animation-duration:11s;height:6px;left:69%;opacity:.28;top:62%;width:3px}.particle_Q0bD:nth-child(16){animation-delay:-1s;animation-duration:15s;height:4px;left:61%;opacity:.31;top:86%;width:3px}.particle_Q0bD:nth-child(17){animation-delay:-2s;animation-duration:12s;height:6px;left:89%;opacity:.12;top:70%;width:5px}.particle_Q0bD:nth-child(18){animation-delay:-4s;animation-duration:10s;height:5px;left:58%;opacity:.39;top:87%;width:4px}.particle_Q0bD:nth-child(19){animation-delay:-1s;animation-duration:18s;height:5px;left:80%;opacity:.33;top:52%;width:6px}.particle_Q0bD:nth-child(20){animation-delay:-3s;animation-duration:9s;height:4px;left:13%;opacity:.2;top:64%;width:5px}@keyframes c{0%,to{opacity:0;transform:translateY(0) translateX(0)}10%,90%{opacity:.3}50%{transform:translateY(-100px) translateX(30px)}}@keyframes d{0%,to{opacity:1}50%{opacity:.85}}.dropdownNavbarItemMobile_J0Sd{cursor:pointer}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.searchBar_RVTs .dropdownMenu_qbY6{background:var(--search-local-modal-background,#f5f6f7);border-radius:6px;box-shadow:var(--search-local-modal-shadow,inset 1px 1px 0 0 #ffffff80,0 3px 8px 0 #555a64);left:auto!important;margin-top:8px;padding:var(--search-local-spacing,12px);position:relative;right:0!important;width:var(--search-local-modal-width,560px)}.searchInput_YFbd:focus{outline:2px solid var(--search-local-input-active-border-color,var(--ifm-color-primary));outline-offset:0}div.ask-ai,html[data-theme=dark] div.ask-ai{--ask-ai-primary:var(--ifm-color-primary);--ask-ai-primary-hover:var(--ifm-color-primary-light);--ask-ai-foreground:var(--ifm-color-content);--ask-ai-border:var(--ifm-color-emphasis-300);--ask-ai-error:var(--ifm-color-danger);--ask-ai-button-bg:var(--ifm-color-emphasis-200)}.ask-ai{--ask-ai-background:var(--search-local-modal-background,#f5f6f7);--ask-ai-muted:var(--search-local-muted-color,#969faf)}html[data-theme=dark] .ask-ai{--ask-ai-background:var(--search-local-modal-background,var(--ifm-background-color));--ask-ai-muted:var(--search-local-muted-color,var(--ifm-color-secondary-darkest))}html[data-theme=dark] .searchBar_RVTs .dropdownMenu_qbY6{background:var(--search-local-modal-background,var(--ifm-background-color));box-shadow:var(--search-local-modal-shadow,inset 1px 1px 0 0 #2c2e40,0 3px 8px 0 #000309)}.searchBar_RVTs .dropdownMenu_qbY6 .suggestion_fB_2{align-items:center;background:var(--search-local-hit-background,#fff);border-radius:4px;box-shadow:var(--search-local-hit-shadow,0 1px 3px 0 #d4d9e1);color:var(--search-local-hit-color,#444950);cursor:pointer;display:flex;flex-direction:row;height:var(--search-local-hit-height,56px);padding:0 var(--search-local-spacing,12px);width:100%}html[data-theme=dark] .dropdownMenu_qbY6 .suggestion_fB_2{background:var(--search-local-hit-background,var(--ifm-color-emphasis-100));box-shadow:var(--search-local-hit-shadow,none);color:var(--search-local-hit-color,var(--ifm-font-color-base))}.searchBar_RVTs .dropdownMenu_qbY6 .suggestion_fB_2:not(:last-child){margin-bottom:4px}.searchBar_RVTs .dropdownMenu_qbY6 .suggestion_fB_2.cursor_eG29{background-color:var(--search-local-highlight-color,var(--ifm-color-primary))}.hitFooter_E9YW a,.hitIcon_a7Zy,.hitPath_ieM4,.hitTree_kk6K,.noResultsIcon_EBY5{color:var(--search-local-muted-color,#969faf)}html[data-theme=dark] .hitIcon_a7Zy,html[data-theme=dark] .hitPath_ieM4,html[data-theme=dark] .hitTree_kk6K,html[data-theme=dark] .noResultsIcon_EBY5{color:var(--search-local-muted-color,var(--ifm-color-secondary-darkest))}.hitTree_kk6K{align-items:center;display:flex}.hitTree_kk6K>svg{height:var(--search-local-hit-height,56px);opacity:.5;width:24px}.hitIcon_a7Zy,.hitTree_kk6K>svg{stroke-width:var(--search-local-icon-stroke-width,1.4)}.hitAction_NqkB,.hitIcon_a7Zy{height:20px;width:20px}.hitWrapper_sAK8{display:flex;flex:1 1 auto;flex-direction:column;font-weight:500;justify-content:center;margin:0 8px;overflow-x:hidden;width:80%}.hitWrapper_sAK8 mark{background:none;color:var(--search-local-highlight-color,var(--ifm-color-primary))}.hitTitle_vyVt{font-size:.9em}.hitPath_ieM4{font-size:.75em}.hitPath_ieM4,.hitTitle_vyVt{overflow-x:hidden;text-overflow:ellipsis;white-space:nowrap}.noResults_l6Q3{align-items:center;display:flex;flex-direction:column;justify-content:center;padding:var(--search-local-spacing,12px) 0}.noResultsIcon_EBY5{margin-bottom:var(--search-local-spacing,12px)}.hitFooter_E9YW{font-size:.85em;margin-top:var(--search-local-spacing,12px);text-align:center}.suggestion_fB_2.cursor_eG29,.suggestion_fB_2.cursor_eG29 .hitIcon_a7Zy,.suggestion_fB_2.cursor_eG29 .hitPath_ieM4,.suggestion_fB_2.cursor_eG29 .hitTree_kk6K,.suggestion_fB_2.cursor_eG29 mark{color:var(--search-local-hit-active-color,var(--ifm-color-white))!important}.searchBarContainer_NW3z{margin-left:16px}.searchBarContainer_NW3z .searchBarLoadingRing_YnHq{display:none;left:10px;position:absolute;top:6px}.searchBarContainer_NW3z .searchClearButton_qk4g{background:none;border:none;line-height:1rem;padding:0;position:absolute;right:.8rem;top:50%;transform:translateY(-50%)}.navbar__search{position:relative}.searchIndexLoading_EJ1f .navbar__search-input{background-image:none}.searchHintContainer_Pkmr{align-items:center;display:flex;gap:4px;height:100%;justify-content:center;pointer-events:none;position:absolute;right:10px;top:0}.searchHint_iIMx{background-color:var(--ifm-navbar-search-input-background-color);border:1px solid var(--ifm-color-emphasis-500);box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-500);color:var(--ifm-navbar-search-input-placeholder-color)}html[dir=rtl] .searchHintContainer_Pkmr{left:10px;right:auto}html[dir=rtl] .searchBarContainer_NW3z .searchClearButton_qk4g{left:.8rem;right:auto}html[dir=rtl] .searchBarContainer_NW3z .searchBarLoadingRing_YnHq{left:auto;right:10px}html[dir=rtl] .navbar__search-input{padding:0 2.25em 0 .5em}.loadingRing_RJI3{display:inline-block;height:20px;opacity:var(--search-local-loading-icon-opacity,.5);position:relative;width:20px}.loadingRing_RJI3 div{animation:1.2s cubic-bezier(.5,0,.5,1) infinite e;border:2px solid var(--search-load-loading-icon-color,var(--ifm-navbar-search-input-color));border-color:var(--search-load-loading-icon-color,var(--ifm-navbar-search-input-color)) #0000 #0000 #0000;border-radius:50%;display:block;height:16px;margin:2px;position:absolute;width:16px}.loadingRing_RJI3 div:first-child{animation-delay:-.45s}.loadingRing_RJI3 div:nth-child(2){animation-delay:-.3s}.loadingRing_RJI3 div:nth-child(3){animation-delay:-.15s}@keyframes e{0%{transform:rotate(0)}to{transform:rotate(1turn)}}.navbarHideable_m1mJ{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}.badge_qP1g,.commitMeta_teNK,.commitMsg_XeKn,.name_mmMI{white-space:nowrap}.errorBoundaryFallback_VBag{color:red;padding:.55rem}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.navbar__items--right>:last-child{padding-right:0}.lastUpdated_JAkA{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link,header.heroBanner_qw_p img.starButton_Vbnu:hover{opacity:1}.anchorTargetStickyNavbar_Vzrq{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorTargetHideOnScrollNavbar_vjPI{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;user-select:none}.hash-link:before{content:"#"}.mainWrapper_z2l0{display:flex;flex:1 0 auto;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.searchContextInput_mXoe,.searchQueryInput_CFBF{background:var(--ifm-background-color);border:var(--ifm-global-border-width) solid var(--ifm-color-content-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-font-color-base);font-size:var(--ifm-font-size-base);margin-bottom:1rem;padding:.5rem;width:100%}.monthHeader_QFki,.updatesPage_z4Av,header.heroBanner_qw_p,main.docs{background:var(--hero-background)}.releaseCard_aa3v,.tagCard_SluW{border-radius:8px;box-shadow:var(--feature-img-shadow)}.searchResultItem_U687{border-bottom:1px solid #dfe3e8;padding:1rem 0}.searchResultItemPath_uIbk{color:var(--ifm-color-content-secondary);font-size:.8rem;margin:.5rem 0 0}.searchResultItemSummary_oZHr{font-style:italic;margin:.5rem 0 0}.updatesPage_z4Av{min-height:80vh;padding:2rem 1rem 4rem}.pageHeader_g4VR{margin-bottom:2.5rem;text-align:center}.pageHeader_g4VR h1{color:var(--text-color);font-family:Racing Sans One,cursive;font-size:2.5rem;margin-bottom:.25rem}.pageHeader_g4VR p{color:var(--mid-grey);font-family:Raleway,sans-serif;font-size:1.1rem;margin:0}.timeline_WTQQ{margin:0 auto;max-width:1000px;padding-left:2.5rem;position:relative;width:80%}.timeline_WTQQ:before{background:var(--mid-grey);bottom:0;content:"";left:0;opacity:.4;position:absolute;top:0;width:2px}.monthHeader_QFki{color:var(--mid-grey);font-size:1rem;margin:0;padding:.75rem 0 .5rem;position:sticky;top:60px;z-index:1}.entry_mTt2{margin-bottom:1rem;position:relative}.entry_mTt2:before{border-radius:50%;content:"";position:absolute;z-index:1}.releaseEntry_ZG2V:before{background:var(--accent-pink);height:14px;left:-2.5rem;margin-left:-6px;top:1rem;width:14px}.tagEntry_ORGt:before{background:var(--accent-blue);height:10px;left:-2.5rem;margin-left:-4px;top:1rem;width:10px}.commitEntry_JtMn:before{background:var(--mid-grey);height:6px;left:-2.5rem;margin-left:-2px;top:.9rem;width:6px}.commitRow_RIZe:hover,.releaseCard_aa3v,.tagCard_SluW{background:var(--background)}.releaseCard_aa3v{border-left:4px solid var(--accent-pink);padding:1.25rem 1.5rem}.releaseCard_aa3v .entryTitle_RUqs{align-items:center;color:var(--text-color);display:flex;flex-wrap:wrap;font-family:Roboto Mono,monospace;font-size:1.3rem;gap:.5rem;margin:0 0 .5rem}.tagCard_SluW{border-left:4px solid var(--accent-blue);padding:1rem 1.25rem}.badgeRelease_agcf,.button.color-btn.btn-pink{background:var(--accent-pink)}.tagCard_SluW .entryTitle_RUqs{font-size:1.1rem;gap:.5rem;margin:0 0 .25rem}.commitRow_RIZe,.tagCard_SluW .entryTitle_RUqs{align-items:center;color:var(--text-color);display:flex}.commitRow_RIZe{border-bottom:1px solid #80808026;gap:.75rem;padding:.5rem 0;transition:background .15s}.commitRow_RIZe:hover{color:var(--text-color)}.badge_qP1g{border-radius:4px;color:#fff;display:inline-block;font-size:.7rem;line-height:1.4;padding:.1rem .5rem}.badgeTag_gC_o{background:var(--accent-blue)}.tagPill_IKwa{border:1px solid var(--mid-grey);border-radius:4px;color:var(--mid-grey);font-size:.8rem;padding:.05rem .4rem}.avatarSmall_luV7,.avatar_Vzby{border-radius:50%;vertical-align:middle}.errorMessage_lztz,.fetchErrorCard_M8w3{box-shadow:var(--feature-img-shadow);padding:1.25rem 1.5rem;text-align:center}.bodyPreview_iKaD{color:var(--mid-grey);display:-webkit-box;font-size:.9rem;-webkit-line-clamp:3;margin:.25rem 0 .5rem;-webkit-box-orient:vertical;line-height:1.5;overflow:hidden}.meta_GplF,.sha_JsPS{color:var(--mid-grey);font-size:.85rem}.meta_GplF{align-items:center;display:flex;flex-wrap:wrap;gap:.75rem}.meta_GplF a{color:var(--mid-grey)}.linksList_CKaa img,.meta_GplF a .providerIcon_NdOm{margin-right:.25rem;vertical-align:middle;width:1.35rem}.avatar_Vzby{height:24px;width:24px}.authorInfo_pi2M{align-items:center;display:flex;gap:.35rem}.sha_JsPS{flex-shrink:0}.commitMsg_XeKn{font-size:.95rem;max-width:500px;overflow:hidden}.authorLink_YWtN{color:var(--text-color);opacity:.75;transition:.2s}.authorLink_YWtN:hover .avatarSmall_luV7{transform:scale(1.08)}.avatarSmall_luV7{height:18px;margin-right:.2rem;transition:.2s;width:18px}.errorMessage_lztz,.fetchErrorCard_M8w3,.skeleton_NVtD{border-radius:8px;background:var(--background)}.commitMeta_teNK{align-items:center;color:var(--mid-grey);display:flex;flex-shrink:0;font-size:.8rem;gap:.3rem;margin-left:auto}.skeleton_NVtD{animation:1.5s ease-in-out infinite f;height:80px;margin-bottom:1rem}@keyframes f{0%,to{opacity:.4}50%{opacity:1}}.loadMore_YatW{display:flex;justify-content:center;margin:2rem auto}.fetchErrorCard_M8w3{color:var(--mid-grey);font-size:.95rem;margin:1.5rem auto;max-width:1000px;width:80%}.fetchErrorCard_M8w3 a{color:var(--accent-blue)}.errorMessage_lztz{color:var(--mid-grey);font-size:1.1rem;margin:0 auto;width:fit-content}.errorMessage_lztz p{margin:.25rem 0}html[data-theme=light]{--heading-shadow:-2px 3px 2px #a2a1a1;--sub-heading-shadow:-1px 1px 1px #a2a1a1}header.heroBanner_qw_p{min-height:calc(100vh - 4rem);overflow:hidden;padding:4rem 1rem 2rem;position:relative;text-align:center}header.heroBanner_qw_p h1.heroTitle_CteR{font-family:Racing Sans One,mono;font-size:8rem;text-shadow:var(--heading-shadow)}header.heroBanner_qw_p h3.heroSubTitle_p8ER{text-shadow:var(--sub-heading-shadow)}header.heroBanner_qw_p img.starButton_Vbnu{opacity:.85;position:absolute;right:1rem;top:1rem;width:12rem}.buttons_LJn2{align-items:center;display:flex;justify-content:center;margin:1.5rem}.dashyDescription_iLL2{font-size:1.2rem;margin:1rem auto;max-width:680px;text-align:left}.dashyDescription_iLL2>p,.dashyDescription_iLL2>span{margin-left:auto;margin-right:auto;max-width:680px}.keepReading_G_Ux{cursor:pointer;font-size:1.2rem;margin-left:.5rem}.scrollDown_cjGa{bottom:0;cursor:pointer;display:flex;left:42%;margin:2rem auto;position:absolute;width:fit-content}.scrollDownText_HIIX{color:var(--text-color);font-size:1.2rem;font-weight:700;margin:0 1rem}.scrollDownIcon_UZ2V{width:2rem}.scrollDownIcon_UZ2V path{fill:var(--text-color)}.sponsorContainer_zSLg{display:flex;flex-direction:column;gap:1rem;margin:1.5rem auto;max-width:680px}.sponsor_JDQ1{background:var(--background);color:var(--text-color);display:flex;flex-direction:column-reverse;gap:.5rem;justify-content:left;padding:.5rem;width:100%}.sponsor_JDQ1 span{font-size:.9rem;text-align:center}.sponsor_JDQ1 span a{color:var(--text-color);font-size:.9rem}.button{border:none;border-radius:4px;color:var(--black);cursor:pointer;display:inline-block;display:flex;font-size:1.3rem;font-weight:700;margin:.5rem;min-width:12rem;padding:.75rem 1rem;position:relative;transition:none}.button svg{margin-right:.5rem;width:1.8rem}.button.btn-small{font-size:1rem;max-width:12rem;min-width:auto;padding:.5rem .75rem;width:100%}.button.btn-small svg{margin-right:.35rem;width:1.2rem}.button.color-btn:hover{color:rgba(0,0,0,.702);top:2px}.button.color-btn:active{box-shadow:none!important;color:rgba(0,0,0,.502);top:4px}.button.color-btn.btn-pink{box-shadow:0 4px var(--accent-pink-dark)}.button.color-btn.btn-pink:hover{box-shadow:0 2px var(--accent-pink-dark)}.button.color-btn.btn-purple{background:var(--accent-purple);box-shadow:0 4px var(--accent-purple-dark)}.button.color-btn.btn-purple:hover{box-shadow:0 2px var(--accent-purple-dark)}.button.color-btn.btn-blue{background:var(--accent-blue);box-shadow:0 4px var(--accent-blue-dark)}.button.color-btn.btn-blue:hover{box-shadow:0 2px var(--accent-blue-dark)}.button.color-btn.btn-green{background:var(--accent-green);box-shadow:0 4px var(--accent-green-dark)}.button.color-btn.btn-green:hover{box-shadow:0 2px var(--accent-green-dark)}.button.color-btn.btn-yellow{background:var(--accent-yellow);box-shadow:0 4px var(--accent-yellow-dark)}.button.color-btn.btn-yellow:hover{box-shadow:0 2px var(--accent-yellow-dark)}.enjoyingWrap_FXPn .enjoyingWrapPart_oGX0,.home-page-features-wrapper .feature .feature-half.assets,.statItem_at6_,.tile_CRAN:hover,main.docs{box-shadow:var(--feature-img-shadow)}main.docs{margin:1rem auto;max-width:1250px;padding:1rem}main.docs h1.docs-title{font-size:5rem;margin:0;text-align:center}main.docs p.see-repo-note{background:rgba(255,255,170,.839);border-radius:3px;display:none;padding:.25rem 1rem;width:fit-content}main.docs p.see-repo-note a,main.docs p.see-repo-note b,main.docs p.see-repo-note span{color:#000;font-size:1rem;font-style:italic}main.docs p.see-repo-note a{color:#000;font-size:1rem;font-weight:700}main.docs div.row1{display:flex;flex-direction:row}main.docs div.docs-links-section{display:flex;flex-wrap:wrap}main.docs div.docs-contents{color:var(--text-color);display:flex;flex-direction:column;justify-content:space-around}main.docs div.docs-contents h3.section-title{margin:1rem .5rem .5rem}main.docs div.docs-contents a{display:flex;flex-direction:column;margin:.5rem .75rem;min-height:5rem;padding:.25rem .5rem;width:calc(33% - 1.5rem)}main.docs div.docs-contents a p.name{font-size:1.4rem;margin:0;text-align:left}main.docs div.docs-contents a span.description{font-size:1rem;text-align:left;white-space:pre-wrap}.color-pink{--feature-color:var(--accent-pink)}.color-blue{--feature-color:var(--accent-blue)}.color-green{--feature-color:var(--accent-green)}.color-yellow{--feature-color:var(--accent-yellow)}.color-white{--feature-color:#fff}html[data-theme=light] .color-pink{--feature-color:var(--accent-pink-dark)}html[data-theme=light] .color-blue{--feature-color:var(--accent-purple-dark)}html[data-theme=light] .color-green{--feature-color:var(--accent-green-dark)}html[data-theme=light] .color-yellow{--feature-color:var(--accent-yellow-dark)}html[data-theme=light] .color-white{--feature-color:#000}.home-page-features-wrapper{display:flex;flex-direction:column;font-size:1.2rem}.home-page-features-wrapper .feature{align-items:center;display:flex;justify-content:center;margin:0;padding:.5rem}.home-page-features-wrapper .feature.align-left{background:var(--background);box-shadow:0 1px 4px #000;flex-direction:row}.home-page-features-wrapper .feature.align-right{background:var(--hero-background);box-shadow:0 -1px 4px rgba(0,0,0,.702);flex-direction:row-reverse}.home-page-features-wrapper .feature .feature-half{margin:1rem;padding:.25rem;width:40%}.home-page-features-wrapper .feature .feature-half.assets{align-items:center;background:var(--feature-color);border-radius:8px;display:flex;height:fit-content;justify-content:center;margin:.5rem}.home-page-features-wrapper .feature .feature-half.assets img.demo,.home-page-features-wrapper .feature .feature-half.assets span.not-demo{background:var(--kinda-transparent);border-radius:8px;box-shadow:var(--feature-img-shadow);height:100%;max-height:36rem;min-height:12rem;object-fit:contain;width:100%}.home-page-features-wrapper .feature .feature-half.assets span.not-demo{align-items:center;display:flex;justify-content:center}.home-page-features-wrapper .feature .feature-title{align-items:flex-end;color:var(--feature-color);display:flex;margin:1rem 0}.home-page-features-wrapper .feature .feature-title svg{margin-right:.5rem;width:2rem}.home-page-features-wrapper .feature div.read-the-docs a.button-link-wrapper{margin:0 1rem 1rem}.home-page-features-wrapper .feature div.read-the-docs small{margin:0 .5rem;opacity:.75}.authorsSection_t3c7{background:var(--hero-background);padding:3rem 1rem}.inner_rVjr{margin:.5rem auto;width:80%}.heading_j3J0{color:var(--text-color);font-size:2rem}.enjoyingWrap_FXPn{display:flex;gap:2rem;margin-bottom:2rem}.enjoyingWrap_FXPn .enjoyingWrapPart_oGX0{background:var(--background);border-radius:8px;padding:.5rem 1rem;width:50%}.enjoyingWrap_FXPn .enjoyingWrapPart_oGX0 p{margin:0 0 .5rem}.enjoyingWrap_FXPn .enjoyingWrapPart_oGX0 .authorInnerWrap_y4gi{align-items:center;display:flex;gap:.75rem}.subHeading_D3Yw{color:var(--text-color);font-size:1.2rem;margin:.25rem 0}.grid_qTnk{display:grid;gap:.75rem;grid-template-columns:repeat(auto-fill,minmax(120px,1fr));margin:0 auto 2rem;max-width:1800px;padding:0}.tile_CRAN{align-items:center;background:var(--background);border-radius:8px;display:flex;flex-direction:column;gap:.4rem;padding:.6rem;position:relative;transition:transform .2s,box-shadow .2s}.ctaSection_oQB2,.statItem_at6_{align-items:center;display:flex}.tile_CRAN,.tile_CRAN:hover{color:var(--text-color);-webkit-text-decoration:none;text-decoration:none}.builtBy_GoGF,.name_mmMI{color:var(--mid-grey);font-size:.9rem}.tile_CRAN:hover{transform:translateY(-2px)}.avatar__HA9{border-radius:50%;height:48px;width:48px}.name_mmMI{max-width:120px;overflow:hidden}.star_JoTu{position:absolute;right:.5rem;top:.5rem}.fallback_O_bA{margin:0 auto;max-width:100%}.fallback_O_bA img{height:auto;max-width:100%}.ctaSection_oQB2{flex-direction:row;gap:.5rem;justify-content:center;margin-top:.25rem}.builtBy_GoGF{margin-bottom:1rem}.statsSection_Rc3S{background:var(--hero-background);padding:.25rem 1rem 3rem}.inner_YtnN{display:flex;flex-wrap:wrap;gap:1.5rem;justify-content:space-around;margin:0 auto;max-width:1000px;width:80%}.statItem_at6_{background:var(--background);border-radius:8px;flex:1 1 180px;flex-direction:column;max-width:240px;padding:1.5rem 2rem;text-align:center}.icon_vhSc{height:3rem;margin-bottom:.25rem;width:3rem}.count_Ad5j,.icon_vhSc{color:var(--stat-color)}.count_Ad5j{font-size:2.8rem;font-weight:400;line-height:1.1}.label_wElN{color:var(--mid-grey);font-size:1rem;margin-top:.25rem}.buttonGroup_M5ko button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}iframe#dashy-survey{border:none;height:92vh;width:100%}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:line-count;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(line-count);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_Vdqa{opacity:1!important}.copyButtonIcons_IEyt{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_TrPX,.copyButtonSuccessIcon_cVMy{fill:currentColor;height:inherit;left:0;opacity:inherit;position:absolute;top:0;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_cVMy{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_Vdqa .copyButtonIcon_TrPX{opacity:0;transform:scale(.33)}.copyButtonCopied_Vdqa .copyButtonSuccessIcon_cVMy{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.wordWrapButtonIcon_b1P5{height:1.2rem;width:1.2rem}.buttonGroup_M5ko{column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup_M5ko button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup_M5ko button:focus-visible,.buttonGroup_M5ko button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup_M5ko button{opacity:.4}.codeBlockContent_QJqH{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_OeMC{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlockTitle_OeMC+.codeBlockContent_QJqH .codeBlock_a8dz{border-top-left-radius:0;border-top-right-radius:0}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:#0000 #0000 #0000 var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.img_ev3q{height:auto}.admonition_xJq3{margin-bottom:1em}.admonitionHeading_Gvgb{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family)}.admonitionHeading_Gvgb:not(:last-child){margin-bottom:.3rem}.admonitionHeading_Gvgb code{text-transform:none}.admonitionIcon_Rf37{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_Rf37 svg{display:inline-block;fill:var(--ifm-alert-foreground-color);height:1.6em;width:1.6em}.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_TmdG{background-color:var(--docusaurus-collapse-button-bg)}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;transform:rotate(180deg)}.expandButtonIcon_i1dp,[dir=rtl] .collapseSidebarButtonIcon_kv0_{transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_TmdG:focus,.expandButton_TmdG:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);-webkit-text-decoration:none!important;text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_TmdG{align-items:center;display:flex;height:100%;justify-content:center;position:absolute;right:0;top:0;transition:background-color var(--ifm-transition-fast) ease;width:100%}[dir=rtl] .expandButtonIcon_i1dp{transform:rotate(180deg)}.docSidebarContainer_YfHR{border-right:1px solid var(--ifm-toc-border-color);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_DPk8{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_aRkj{height:100%;max-height:100vh;position:sticky;top:0}.docMainContainer_TBSr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_lQrH{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_JWYK{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.navbarSearchContainer_Bca1{padding:0 var(--ifm-navbar-item-padding-horizontal)}.lastUpdated_JAkA{text-align:right}.tocMobile_ITEo{display:none}.docItemCol_VOVn{max-width:75%!important}}@media screen and (min-width:1200px){.sponsorContainer_zSLg{flex-direction:row;justify-content:center;max-width:1000px}.sponsor_JDQ1{flex:1 1 0;min-height:100%}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block;width:max-content}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.navbarSearchContainer_Bca1{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media not (max-width:996px){.searchBar_RVTs.searchBarLeft_MXDe .dropdownMenu_qbY6{left:0!important;right:auto!important}}@media only screen and (max-width:996px){.searchQueryColumn_q7nx{max-width:60%!important}.searchContextColumn_oWAF{max-width:40%!important}}@media (max-width:966px){.timeline_WTQQ{padding-left:2rem;width:100%}.commitEntry_JtMn:before,.releaseEntry_ZG2V:before,.tagEntry_ORGt:before{left:-2rem}.commitRow_RIZe{flex-wrap:wrap}.commitMsg_XeKn{max-width:100%}.commitMeta_teNK{margin-left:0}.bodyPreview_iKaD{-webkit-line-clamp:2}header.heroBanner_qw_p h1.heroTitle_CteR{font-size:6rem}header.heroBanner_qw_p h3.heroSubTitle_p8ER{font-size:1.5rem}.scrollDown_cjGa{display:none}.button{width:80%}.ctaSection_oQB2,.enjoyingWrap_FXPn,.home-page-features-wrapper .feature.align-left,.home-page-features-wrapper .feature.align-right{flex-direction:column}.home-page-features-wrapper .feature.align-left .feature-half,.home-page-features-wrapper .feature.align-right .feature-half{width:95%}.enjoyingWrap_FXPn .enjoyingWrapPart_oGX0,.inner_rVjr{width:100%}.grid_qTnk{grid-template-columns:repeat(auto-fill,minmax(100px,1fr))}.inner_YtnN{display:grid;gap:1rem;grid-template-columns:1fr 1fr;width:100%}.statItem_at6_{max-width:none;padding:1.25rem 1rem}.count_Ad5j{font-size:2.2rem}}@media screen and (max-width:966px){header.heroBanner_qw_p{padding:2rem}.buttons_LJn2{flex-direction:column}}@media (max-width:768px){.glitchCode_Pt6F{font-size:6rem}}@media (max-width:600px){.banner_woPo{font-size:.85rem;padding:.4rem .75rem}.closeBtn_fC0A{font-size:1.1rem;right:.5rem}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}.navbar__search-input:not(:focus){width:2rem}.searchBar_RVTs .dropdownMenu_qbY6{max-width:calc(100vw - var(--ifm-navbar-padding-horizontal)*2);width:var(--search-local-modal-width-sm,340px)}.searchBarContainer_NW3z:not(.focused_OWtg) .searchClearButton_qk4g,.searchHintContainer_Pkmr{display:none}}@media screen and (max-width:576px){.searchQueryColumn_q7nx{max-width:100%!important}.searchContextColumn_oWAF{max-width:100%!important;padding-left:var(--ifm-spacing-horizontal)!important}}@media (max-width:500px){main.docs div.docs-contents a{width:100%}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-color-scheme:dark){#carbonads{--carbon-bg-primary:#1f1f1f;--carbon-bg-secondary:#262626;--carbon-text-color:#e6e6e6}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}.skeleton_NVtD{animation:none;opacity:.6}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.noPrint_WFHX,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file diff --git a/assets/js/044d5aa6.166df86e.js b/assets/js/044d5aa6.8f97d7fe.js similarity index 99% rename from assets/js/044d5aa6.166df86e.js rename to assets/js/044d5aa6.8f97d7fe.js index 9c3629b5..d73fe600 100644 --- a/assets/js/044d5aa6.166df86e.js +++ b/assets/js/044d5aa6.8f97d7fe.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[5332],{7670(e,n,i){i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>t,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"icons","title":"Icons","description":"Both sections and items can have an icon, which is specified using the icon attribute. Using icons improves the aesthetics of your UI and makes the app more intuitive to use. Dashy supports multiple different icon providers, usage instructions for which are explained here.","source":"@site/docs/icons.md","sourceDirName":".","slug":"/icons","permalink":"/docs/icons","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/icons.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Troubleshooting","permalink":"/docs/troubleshooting"},"next":{"title":"Widgets","permalink":"/docs/widgets"}}');var o=i(4848),c=i(8453);const t={},r="Icons",a={},l=[{value:"Favicons",id:"favicons",level:2},{value:"Font Awesome",id:"font-awesome",level:2},{value:"Simple Icons",id:"simple-icons",level:2},{value:"Generative Icons",id:"generative-icons",level:2},{value:"Emoji Icons",id:"emoji-icons",level:2},{value:"selfh.st Icons",id:"selfhst-icons",level:2},{value:"Home-Lab Icons",id:"home-lab-icons",level:2},{value:"Material Design Icons",id:"material-design-icons",level:2},{value:"Icons by URL",id:"icons-by-url",level:2},{value:"Local Icons",id:"local-icons",level:2},{value:"Default Icon",id:"default-icon",level:2},{value:"No Icon",id:"no-icon",level:2},{value:"Icon Collections and Resources",id:"icon-collections-and-resources",level:2},{value:"Notes",id:"notes",level:2}];function h(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",hr:"hr",img:"img",li:"li",p:"p",pre:"pre",ul:"ul",...(0,c.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"icons",children:"Icons"})}),"\n",(0,o.jsxs)(n.p,{children:["Both sections and items can have an icon, which is specified using the ",(0,o.jsx)(n.code,{children:"icon"})," attribute. Using icons improves the aesthetics of your UI and makes the app more intuitive to use. Dashy supports multiple different icon providers, usage instructions for which are explained here."]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#favicons",children:"Auto-Fetched Favicons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#font-awesome",children:"Font Awesome Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#simple-icons",children:"Simple Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#generative-icons",children:"Generative Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#emoji-icons",children:"Emoji Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#selfhst-icons",children:"selfh.st Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#home-lab-icons",children:"Home-Lab Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#material-design-icons",children:"Material Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#icons-by-url",children:"Icons by URL"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#local-icons",children:"Local Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#default-icon",children:"Using a Default Icon"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#no-icon",children:"No Icon"})}),"\n",(0,o.jsx)(n.img,{width:"500",src:"https://i.ibb.co/GTVmZnc/dashy-example-icons.png"}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"favicons",children:"Favicons"}),"\n",(0,o.jsxs)(n.p,{children:["Dashy can auto-fetch an icon for a given service, using it's favicon. Just set ",(0,o.jsx)(n.code,{children:"icon: favicon"})," to use this feature."]}),"\n ",(0,o.jsx)(n.img,{width:"580",src:"https://i.ibb.co/k6wyhnB/favicon-icons.png"}),"\n",(0,o.jsx)(n.p,{children:"Since different websites host their favicons at different paths, for the best results Dashy can use an API to resolve a websites icon."}),"\n",(0,o.jsxs)(n.p,{children:["The default favicon API is ",(0,o.jsx)(n.a,{href:"https://favicon.allesedv.com/",children:"allesedv.com"}),", but you can change this under ",(0,o.jsx)(n.code,{children:"appConfig.faviconApi"}),". If you'd prefer not to use an API, just set this value to ",(0,o.jsx)(n.code,{children:"local"}),". You can also use different APIs for individual items, by setting ",(0,o.jsx)(n.code,{children:"icon: favicon-[api]"}),", e.g. ",(0,o.jsx)(n.code,{children:"favicon-iconhorse"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"The following favicon APIs are supported:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"allesedv"})," - ",(0,o.jsx)(n.a,{href:"https://favicon.allesedv.com/",children:"allesedv.com"})," is a highly efficient IPv6-enabled service"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"iconhorse"})," - ",(0,o.jsx)(n.a,{href:"https://icon.horse/",children:"Icon.Horse"})," returns quality icons for any site, with caching for speed and fallbacks for sites without an icon"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"faviconkit"})," - ",(0,o.jsx)(n.a,{href:"https://faviconkit.com/",children:"faviconkit.com"})," good quality icons and most sites supported (Note: down as of Nov '21)"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"besticon"})," - ",(0,o.jsx)(n.a,{href:"https://github.com/mat/besticon",children:"BestIcon"})," fetches websites icons from manifest"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"mcapi"})," - ",(0,o.jsx)(n.a,{href:"https://eu.mc-api.net/",children:"MC-API"})," fetches default website favicon, originally a Minecraft util"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"duckduckgo"})," - Returns decent quality website icons, from DuckDuckGo search"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"google"})," - Official Google favicon API service, good support for all sites, but poor quality"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"yandex"})," - Lower quality icons, but useful in some regions where other services are blocked"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"webmasterapi"})," - ",(0,o.jsx)(n.a,{href:"https://www.webmasterapi.com/",children:"WebMasterAPI"})," fetches website favicons via their API"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"local"})," - Set to local to fetch the default icon at /favicon.ico instead of using an API"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["If for a given service none of the APIs work in your situation, and nor does local, then the best option is to find the path of the services logo or favicon, and set the icon to the URL of the raw image. For example, ",(0,o.jsx)(n.code,{children:"icon: https://monitoring.local/faviconx128.png"}),"- you can find this path using the browser dev tools."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"font-awesome",children:"Font Awesome"}),"\n",(0,o.jsxs)(n.p,{children:["You can use any ",(0,o.jsx)(n.a,{href:"https://fontawesome.com/icons",children:"Font Awesome Icon"})," simply by specifying it's identifier. This is in the format of ",(0,o.jsx)(n.code,{children:"[category] [name]"})," and can be found on the page for that icon on the Font Awesome site. For example: ",(0,o.jsx)(n.code,{children:"fas fa-rocket"}),", ",(0,o.jsx)(n.code,{children:"fab fa-monero"})," or ",(0,o.jsx)(n.code,{children:"fas fa-unicorn"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Font-Awesome has a wide variety of free icons, but you can also use their pro icons if you have a membership. To do so, you need to specify your license key under: ",(0,o.jsx)(n.code,{children:"appConfig.fontAwesomeKey"}),". This is usually a 10-digit string, for example ",(0,o.jsx)(n.code,{children:"13014ae648"}),"."]}),"\n ",(0,o.jsx)(n.img,{width:"500",src:"https://i.ibb.co/tMtwNYZ/fontawesome-icons3.png"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"simple-icons",children:"Simple Icons"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.a,{href:"https://simpleicons.org/",children:"SimpleIcons.org"})," is a collection of 2000+ high quality, free and open source brand and logo SVG icons. Usage of which is very similar to font-awesome icons. First find the glyph you want to use on the ",(0,o.jsx)(n.a,{href:"https://simpleicons.org/",children:"website"}),", then just set your icon to the simple icon slug, prefixed with ",(0,o.jsx)(n.code,{children:"si-"}),"."]}),"\n ",(0,o.jsx)(n.img,{width:"580",src:"https://i.ibb.co/MVhkXfC/simple-icons-example.png"}),"\n",(0,o.jsx)(n.p,{children:"For example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"sections:\n- name: Simple Icons Example\n items:\n - title: Portainer\n icon: si-portainer\n - title: FreeNAS\n icon: si-freenas\n - title: NextCloud\n icon: si-nextcloud\n - title: Home Assistant\n icon: si-homeassistant\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"generative-icons",children:"Generative Icons"}),"\n",(0,o.jsxs)(n.p,{children:["To uses a unique and programmatically generated icon for a given service just set ",(0,o.jsx)(n.code,{children:"icon: generative"}),". This is particularly useful when you have a lot of similar services with a different IP or port, and no specific icon. These icons are generated with ",(0,o.jsx)(n.a,{href:"https://api.dicebear.com/",children:"DiceBear"})," (or ",(0,o.jsx)(n.a,{href:"https://evatar.io/",children:"Evatar"})," for fallback), and use a hash of the services domain/ ip for entropy, so each domain will have a unique icon."]}),"\n ",(0,o.jsx)(n.img,{width:"500",src:"https://i.ibb.co/b2pC2CL/generative-icons-2.png"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"emoji-icons",children:"Emoji Icons"}),"\n",(0,o.jsxs)(n.p,{children:["You can use almost any emoji as an icon for items or sections. You can specify the emoji either by pasting it directly, using it's unicode ( e.g. ",(0,o.jsx)(n.code,{children:"'U+1F680'"}),") or shortcode (e.g. ",(0,o.jsx)(n.code,{children:"':rocket:'"}),"). You can find these codes for any emoji using ",(0,o.jsx)(n.a,{href:"https://emojipedia.org/",children:"Emojipedia"})," (near the bottom of emoji each page), or for a quick reference to emoji shortcodes, check out ",(0,o.jsx)(n.a,{href:"https://emojis.ninja/",children:"emojis.ninja"})," by @nomanoff."]}),"\n ",(0,o.jsx)(n.img,{width:"580",src:"https://i.ibb.co/YLwgTf9/emoji-icons-1.png"}),"\n",(0,o.jsxs)(n.p,{children:["For example, these will all render the same rocket (\ud83d\ude80) emoji: ",(0,o.jsx)(n.code,{children:"icon: ':rocket:'"})," or ",(0,o.jsx)(n.code,{children:"icon: 'U+1F680'"})," or ",(0,o.jsx)(n.code,{children:"icon: \ud83d\ude80"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"selfhst-icons",children:"selfh.st Icons"}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.a,{href:"https://selfh.st/",children:"selfh.st"})," project provides a set of icons, originally for self-hosted services, but now expanded to include a wide variety of services. These icons can be used by specifying the icon name (without extension and with all spaces replaced with -) preceded by ",(0,o.jsx)(n.code,{children:"sh-"}),". See ",(0,o.jsx)(n.a,{href:"https://selfh.st/icons/",children:"https://selfh.st/icons/"})," for a full list of all available icons. For example, the Home Assistant icon is ",(0,o.jsx)(n.code,{children:"sh-home-assistant"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Note: These icons are fetched from the jsdelivr CDN, so if you require offline access, the ",(0,o.jsx)(n.a,{href:"#local-icons",children:"Local Icons"})," method may be a better option for you."]}),"\n ",(0,o.jsx)(n.img,{width:"580",src:"https://i.ibb.co/pfy09LH/Screenshot-from-2025-01-08-22-04-21.png"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"home-lab-icons",children:"Home-Lab Icons"}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.a,{href:"https://github.com/walkxcode/Dashboard-Icons",children:"dashboard-icons"})," repo by ",(0,o.jsx)(n.a,{href:"https://github.com/WalkxCode",children:"@WalkxCode"})," provides a comprehensive collection of 360+ high-quality PNG icons for commonly self-hosted services. Dashy natively supports these icons, and you can use them just by specifying the icon name (without extension) preceded by ",(0,o.jsx)(n.code,{children:"hl-"}),". See ",(0,o.jsx)(n.a,{href:"https://github.com/walkxcode/Dashboard-Icons/tree/main/png",children:"here"})," for a full list of all available icons. Note that these are fetched and cached straight from GitHub, so if you require offline access, the ",(0,o.jsx)(n.a,{href:"#local-icons",children:"Local Icons"})," method may be a better option for you."]}),"\n",(0,o.jsx)(n.p,{children:"For example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"sections:\n- name: Home Lab Icons Example\n items:\n - title: AdGuard Home\n icon: hl-adguardhome\n - title: Long Horn\n icon: hl-longhorn\n - title: Nagios\n icon: hl-nagios\n - title: Whoogle Search\n icon: hl-whooglesearch\n"})}),"\n ",(0,o.jsx)(n.img,{width:"580",src:"https://i.ibb.co/PQzYHmD/homelab-icons-2.png"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"material-design-icons",children:"Material Design Icons"}),"\n",(0,o.jsxs)(n.p,{children:["Dashy also supports 5000+ ",(0,o.jsx)(n.a,{href:"https://github.com/Templarian/MaterialDesign",children:"material-design-icons"}),". To use these, first find the name/ slug for your icon ",(0,o.jsx)(n.a,{href:"https://dev.materialdesignicons.com/icons",children:"here"}),", and then prefix is with ",(0,o.jsx)(n.code,{children:"mdi-"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"For example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"sections:\n- name: Material Design Icons Example\n items:\n - title: Alien Icon\n icon: mdi-alien\n - title: Fire Icon\n icon: mdi-fire\n - title: Dino Icon\n icon: mdi-google-downasaur\n"})}),"\n ",(0,o.jsx)(n.img,{width:"500",src:"https://i.ibb.co/fC9B4mq/icons-mdi-example.png"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"icons-by-url",children:"Icons by URL"}),"\n",(0,o.jsxs)(n.p,{children:["You can also set an icon by passing in a valid URL pointing to the icons location. For example ",(0,o.jsx)(n.code,{children:"icon: https://i.ibb.co/710B3Yc/space-invader-x256.png"}),", this can be in .png, .jpg or .svg format, and hosted anywhere (local or remote) - so long as it's accessible from where you are hosting Dashy. The icon will be automatically scaled to fit, however loading in a lot of large icons may have a negative impact on performance, especially if you visit Dashy from new devices often."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"local-icons",children:"Local Icons"}),"\n",(0,o.jsxs)(n.p,{children:["You may also want to store your icons locally, bundled within Dashy so that there is no reliance on outside services. This can be done by putting the icons within Dashy's ",(0,o.jsx)(n.code,{children:"./user-data/item-icons/"})," directory. If you are using Docker, then the easiest option is to map a volume from your host system, for example: ",(0,o.jsx)(n.code,{children:"-v /local/image/directory:/app/user-data/item-icons/"}),". To reference an icon stored locally, just specify it's name and extension. For example, if my icon was stored in ",(0,o.jsx)(n.code,{children:"/app/user-data/item-icons/maltrail.png"}),", then I would just set ",(0,o.jsx)(n.code,{children:"icon: maltrail.png"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["You can also use sub-folders within the ",(0,o.jsx)(n.code,{children:"item-icons"})," directory to keep things organized. You would then specify an icon with it's folder name slash image name. For example: ",(0,o.jsx)(n.code,{children:"networking/monit.png"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"default-icon",children:"Default Icon"}),"\n",(0,o.jsxs)(n.p,{children:["If you'd like to set a default icon, to be applied to any items which don't have an icon already set, then this can be done under ",(0,o.jsx)(n.code,{children:"appConfig.defaultIcon"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"no-icon",children:"No Icon"}),"\n",(0,o.jsxs)(n.p,{children:["If you don't wish for a given item or section to have an icon, just leave out the ",(0,o.jsx)(n.code,{children:"icon"})," attribute."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"icon-collections-and-resources",children:"Icon Collections and Resources"}),"\n",(0,o.jsxs)(n.p,{children:["The following websites provide good-quality, free icon sets. To use any of these icons, either copy the link to the raw icon (it should end in ",(0,o.jsx)(n.code,{children:".svg"})," or ",(0,o.jsx)(n.code,{children:".png"}),") and paste it as your ",(0,o.jsx)(n.code,{children:"icon"}),", or download and save the icons in ",(0,o.jsx)(n.code,{children:"/user-data/item-icons"})," / mapped Docker volume. Full credit to the authors, please see the licenses for each service for usage and copyright information."]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://thehomelab.wiki/books/helpful-tools-resources/page/icons-for-self-hosted-dashboards",children:"Icons for Self-Hosted Apps"})," - 350+ high-quality icons for commonly self-hosted services"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://svgbox.net/iconsets/",children:"SVG Box"})," - Cryptocurrency, social media apps and flag icons"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://simpleicons.org/",children:"Simple Icons"})," - Free SVG brand icons, with easy API access"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://github.com/google/material-design-icons/",children:"Material Design Icons"})," - Hundreds of Open source PNG + SVG icons by Google"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://icons8.com/icons",children:"Icons8"})," - Thousands of icons, all with free versions at 64x64"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://www.flaticon.com/",children:"Flat Icon"})," - Wide variety of icon sets, most of which are free to use"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://www.svgrepo.com/",children:"SVG Repo"})," - 300,000+ Vector Icons"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["If you are a student, then you can get free access to premium icons on ",(0,o.jsx)(n.a,{href:"https://education.github.com/pack/redeem/iconscout-student",children:"Icon Scout"})," or ",(0,o.jsx)(n.a,{href:"https://icons8.com/github-students",children:"Icons8"})," using the ",(0,o.jsx)(n.a,{href:"https://education.github.com/pack",children:"GitHub Student Pack"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"notes",children:"Notes"}),"\n",(0,o.jsx)(n.p,{children:"If you are using icons from an external source, these will be fetched on initial page load automatically, if and when needed. But combining icons from multiple services may have a negative impact on performance."}),"\n",(0,o.jsx)(n.p,{children:"You can improve load speeds, by downloading your required icons, and serving them locally. Scaling icons to the minimum required dimensions (e.g. 128x128 or 64x64) will also greatly improve application load times."}),"\n",(0,o.jsx)(n.p,{children:"For icons from external sources, please see the Privacy Policies and Licenses for that provider."})]})}function d(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453(e,n,i){i.d(n,{R:()=>t,x:()=>r});var s=i(6540);const o={},c=s.createContext(o);function t(e){const n=s.useContext(c);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[5332],{7670(e,n,i){i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>t,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"icons","title":"Icons","description":"Both sections and items can have an icon, which is specified using the icon attribute. Using icons improves the aesthetics of your UI and makes the app more intuitive to use. Dashy supports multiple different icon providers, usage instructions for which are explained here.","source":"@site/docs/icons.md","sourceDirName":".","slug":"/icons","permalink":"/docs/icons","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/icons.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Troubleshooting","permalink":"/docs/troubleshooting"},"next":{"title":"Widgets","permalink":"/docs/widgets"}}');var o=i(4848),c=i(8453);const t={},r="Icons",a={},l=[{value:"Favicons",id:"favicons",level:2},{value:"Font Awesome",id:"font-awesome",level:2},{value:"Simple Icons",id:"simple-icons",level:2},{value:"Generative Icons",id:"generative-icons",level:2},{value:"Emoji Icons",id:"emoji-icons",level:2},{value:"selfh.st Icons",id:"selfhst-icons",level:2},{value:"Home-Lab Icons",id:"home-lab-icons",level:2},{value:"Material Design Icons",id:"material-design-icons",level:2},{value:"Icons by URL",id:"icons-by-url",level:2},{value:"Local Icons",id:"local-icons",level:2},{value:"Default Icon",id:"default-icon",level:2},{value:"No Icon",id:"no-icon",level:2},{value:"Icon Collections and Resources",id:"icon-collections-and-resources",level:2},{value:"Notes",id:"notes",level:2}];function h(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",hr:"hr",img:"img",li:"li",p:"p",pre:"pre",ul:"ul",...(0,c.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"icons",children:"Icons"})}),"\n",(0,o.jsxs)(n.p,{children:["Both sections and items can have an icon, which is specified using the ",(0,o.jsx)(n.code,{children:"icon"})," attribute. Using icons improves the aesthetics of your UI and makes the app more intuitive to use. Dashy supports multiple different icon providers, usage instructions for which are explained here."]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#favicons",children:"Auto-Fetched Favicons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#font-awesome",children:"Font Awesome Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#simple-icons",children:"Simple Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#generative-icons",children:"Generative Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#emoji-icons",children:"Emoji Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#selfhst-icons",children:"selfh.st Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#home-lab-icons",children:"Home-Lab Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#material-design-icons",children:"Material Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#icons-by-url",children:"Icons by URL"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#local-icons",children:"Local Icons"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#default-icon",children:"Using a Default Icon"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"#no-icon",children:"No Icon"})}),"\n",(0,o.jsx)(n.img,{width:"500",src:"https://i.ibb.co/GTVmZnc/dashy-example-icons.png"}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"favicons",children:"Favicons"}),"\n",(0,o.jsxs)(n.p,{children:["Dashy can auto-fetch an icon for a given service, using it's favicon. Just set ",(0,o.jsx)(n.code,{children:"icon: favicon"})," to use this feature."]}),"\n ",(0,o.jsx)(n.img,{width:"580",src:"https://i.ibb.co/k6wyhnB/favicon-icons.png"}),"\n",(0,o.jsx)(n.p,{children:"Since different websites host their favicons at different paths, for the best results Dashy can use an API to resolve a websites icon."}),"\n",(0,o.jsxs)(n.p,{children:["The default favicon API is ",(0,o.jsx)(n.a,{href:"https://favicon.allesedv.com/",children:"allesedv.com"}),", but you can change this under ",(0,o.jsx)(n.code,{children:"appConfig.faviconApi"}),". If you'd prefer not to use an API, just set this value to ",(0,o.jsx)(n.code,{children:"local"}),". You can also use different APIs for individual items, by setting ",(0,o.jsx)(n.code,{children:"icon: favicon-[api]"}),", e.g. ",(0,o.jsx)(n.code,{children:"favicon-iconhorse"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"The following favicon APIs are supported:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"allesedv"})," - ",(0,o.jsx)(n.a,{href:"https://favicon.allesedv.com/",children:"allesedv.com"})," is a highly efficient IPv6-enabled service"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"iconhorse"})," - ",(0,o.jsx)(n.a,{href:"https://icon.horse/",children:"Icon.Horse"})," returns quality icons for any site, with caching for speed and fallbacks for sites without an icon"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"faviconkit"})," - ",(0,o.jsx)(n.a,{href:"https://faviconkit.com/",children:"faviconkit.com"})," good quality icons and most sites supported (Note: down as of Nov '21)"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"besticon"})," - ",(0,o.jsx)(n.a,{href:"https://github.com/mat/besticon",children:"BestIcon"})," fetches websites icons from manifest"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"mcapi"})," - ",(0,o.jsx)(n.a,{href:"https://eu.mc-api.net/",children:"MC-API"})," fetches default website favicon, originally a Minecraft util"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"duckduckgo"})," - Returns decent quality website icons, from DuckDuckGo search"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"google"})," - Official Google favicon API service, good support for all sites, but poor quality"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"yandex"})," - Lower quality icons, but useful in some regions where other services are blocked"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"webmasterapi"})," - ",(0,o.jsx)(n.a,{href:"https://www.webmasterapi.com/",children:"WebMasterAPI"})," fetches website favicons via their API"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"local"})," - Set to local to fetch the default icon at /favicon.ico instead of using an API"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["If for a given service none of the APIs work in your situation, and nor does local, then the best option is to find the path of the services logo or favicon, and set the icon to the URL of the raw image. For example, ",(0,o.jsx)(n.code,{children:"icon: https://monitoring.local/faviconx128.png"}),"- you can find this path using the browser dev tools."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"font-awesome",children:"Font Awesome"}),"\n",(0,o.jsxs)(n.p,{children:["You can use any ",(0,o.jsx)(n.a,{href:"https://fontawesome.com/icons",children:"Font Awesome Icon"})," simply by specifying it's identifier. This is in the format of ",(0,o.jsx)(n.code,{children:"[category] [name]"})," and can be found on the page for that icon on the Font Awesome site. For example: ",(0,o.jsx)(n.code,{children:"fas fa-rocket"}),", ",(0,o.jsx)(n.code,{children:"fab fa-monero"})," or ",(0,o.jsx)(n.code,{children:"fas fa-unicorn"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Font-Awesome has a wide variety of free icons, but you can also use their pro icons if you have a membership. To do so, you need to specify your license key under: ",(0,o.jsx)(n.code,{children:"appConfig.fontAwesomeKey"}),". This is usually a 10-digit string, for example ",(0,o.jsx)(n.code,{children:"13014ae648"}),"."]}),"\n ",(0,o.jsx)(n.img,{width:"500",src:"https://i.ibb.co/tMtwNYZ/fontawesome-icons3.png"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"simple-icons",children:"Simple Icons"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.a,{href:"https://simpleicons.org/",children:"SimpleIcons.org"})," is a collection of 2000+ high quality, free and open source brand and logo SVG icons. Usage of which is very similar to font-awesome icons. First find the glyph you want to use on the ",(0,o.jsx)(n.a,{href:"https://simpleicons.org/",children:"website"}),", then just set your icon to the simple icon slug, prefixed with ",(0,o.jsx)(n.code,{children:"si-"}),"."]}),"\n ",(0,o.jsx)(n.img,{width:"580",src:"https://i.ibb.co/MVhkXfC/simple-icons-example.png"}),"\n",(0,o.jsx)(n.p,{children:"For example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"sections:\n- name: Simple Icons Example\n items:\n - title: Portainer\n icon: si-portainer\n - title: FreeNAS\n icon: si-freenas\n - title: NextCloud\n icon: si-nextcloud\n - title: Home Assistant\n icon: si-homeassistant\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"generative-icons",children:"Generative Icons"}),"\n",(0,o.jsxs)(n.p,{children:["To uses a unique and programmatically generated icon for a given service just set ",(0,o.jsx)(n.code,{children:"icon: generative"}),". This is particularly useful when you have a lot of similar services with a different IP or port, and no specific icon. These icons are generated with ",(0,o.jsx)(n.a,{href:"https://api.dicebear.com/",children:"DiceBear"})," (or ",(0,o.jsx)(n.a,{href:"https://evatar.io/",children:"Evatar"})," for fallback), and use a hash of the services domain/ ip for entropy, so each domain will have a unique icon."]}),"\n ",(0,o.jsx)(n.img,{width:"500",src:"https://i.ibb.co/b2pC2CL/generative-icons-2.png"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"emoji-icons",children:"Emoji Icons"}),"\n",(0,o.jsxs)(n.p,{children:["You can use almost any emoji as an icon for items or sections. You can specify the emoji either by pasting it directly, using it's unicode ( e.g. ",(0,o.jsx)(n.code,{children:"'U+1F680'"}),") or shortcode (e.g. ",(0,o.jsx)(n.code,{children:"':rocket:'"}),"). You can find these codes for any emoji using ",(0,o.jsx)(n.a,{href:"https://emojipedia.org/",children:"Emojipedia"})," (near the bottom of emoji each page), or for a quick reference to emoji shortcodes, check out ",(0,o.jsx)(n.a,{href:"https://emojis.ninja/",children:"emojis.ninja"})," by @nomanoff."]}),"\n ",(0,o.jsx)(n.img,{width:"580",src:"https://i.ibb.co/YLwgTf9/emoji-icons-1.png"}),"\n",(0,o.jsxs)(n.p,{children:["For example, these will all render the same rocket (\ud83d\ude80) emoji: ",(0,o.jsx)(n.code,{children:"icon: ':rocket:'"})," or ",(0,o.jsx)(n.code,{children:"icon: 'U+1F680'"})," or ",(0,o.jsx)(n.code,{children:"icon: \ud83d\ude80"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"selfhst-icons",children:"selfh.st Icons"}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.a,{href:"https://selfh.st/",children:"selfh.st"})," project provides a set of icons, originally for self-hosted services, but now expanded to include a wide variety of services. These icons can be used by specifying the icon name (without extension and with all spaces replaced with -) preceded by ",(0,o.jsx)(n.code,{children:"sh-"}),". See ",(0,o.jsx)(n.a,{href:"https://selfh.st/icons/",children:"https://selfh.st/icons/"})," for a full list of all available icons. For example, the Home Assistant icon is ",(0,o.jsx)(n.code,{children:"sh-home-assistant"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Note: These icons are fetched from the jsdelivr CDN, so if you require offline access, the ",(0,o.jsx)(n.a,{href:"#local-icons",children:"Local Icons"})," method may be a better option for you."]}),"\n ",(0,o.jsx)(n.img,{width:"580",src:"https://i.ibb.co/pfy09LH/Screenshot-from-2025-01-08-22-04-21.png"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"home-lab-icons",children:"Home-Lab Icons"}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.a,{href:"https://github.com/walkxcode/Dashboard-Icons",children:"dashboard-icons"})," repo by ",(0,o.jsx)(n.a,{href:"https://github.com/WalkxCode",children:"@WalkxCode"})," provides a comprehensive collection of 360+ high-quality PNG icons for commonly self-hosted services. Dashy natively supports these icons, and you can use them just by specifying the icon name (without extension) preceded by ",(0,o.jsx)(n.code,{children:"hl-"}),". See ",(0,o.jsx)(n.a,{href:"https://github.com/walkxcode/Dashboard-Icons/tree/main/png",children:"here"})," for a full list of all available icons. Note that these are fetched and cached straight from GitHub, so if you require offline access, the ",(0,o.jsx)(n.a,{href:"#local-icons",children:"Local Icons"})," method may be a better option for you."]}),"\n",(0,o.jsx)(n.p,{children:"For example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"sections:\n- name: Home Lab Icons Example\n items:\n - title: AdGuard Home\n icon: hl-adguardhome\n - title: Long Horn\n icon: hl-longhorn\n - title: Nagios\n icon: hl-nagios\n - title: Whoogle Search\n icon: hl-whooglesearch\n"})}),"\n ",(0,o.jsx)(n.img,{width:"580",src:"https://i.ibb.co/PQzYHmD/homelab-icons-2.png"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"material-design-icons",children:"Material Design Icons"}),"\n",(0,o.jsxs)(n.p,{children:["Dashy also supports 5000+ ",(0,o.jsx)(n.a,{href:"https://github.com/Templarian/MaterialDesign",children:"material-design-icons"}),". To use these, first find the name/ slug for your icon ",(0,o.jsx)(n.a,{href:"https://dev.materialdesignicons.com/icons",children:"here"}),", and then prefix is with ",(0,o.jsx)(n.code,{children:"mdi-"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"For example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"sections:\n- name: Material Design Icons Example\n items:\n - title: Alien Icon\n icon: mdi-alien\n - title: Fire Icon\n icon: mdi-fire\n - title: Dino Icon\n icon: mdi-google-downasaur\n"})}),"\n ",(0,o.jsx)(n.img,{width:"500",src:"https://i.ibb.co/fC9B4mq/icons-mdi-example.png"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"icons-by-url",children:"Icons by URL"}),"\n",(0,o.jsxs)(n.p,{children:["You can also set an icon by passing in a valid URL pointing to the icons location. For example ",(0,o.jsx)(n.code,{children:"icon: https://i.ibb.co/710B3Yc/space-invader-x256.png"}),", this can be in .png, .jpg or .svg format, and hosted anywhere (local or remote) - so long as it's accessible from where you are hosting Dashy. The icon will be automatically scaled to fit, however loading in a lot of large icons may have a negative impact on performance, especially if you visit Dashy from new devices often."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"local-icons",children:"Local Icons"}),"\n",(0,o.jsxs)(n.p,{children:["You may also want to store your icons locally, bundled within Dashy so that there is no reliance on outside services. This can be done by putting the icons within Dashy's ",(0,o.jsx)(n.code,{children:"./user-data/item-icons/"})," directory. If you are using Docker, then the easiest option is to map a volume from your host system, for example: ",(0,o.jsx)(n.code,{children:"-v /local/image/directory:/app/user-data/item-icons/"}),". To reference an icon stored locally, just specify it's name and extension. For example, if my icon was stored in ",(0,o.jsx)(n.code,{children:"/app/user-data/item-icons/maltrail.png"}),", then I would just set ",(0,o.jsx)(n.code,{children:"icon: maltrail.png"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["You can also use sub-folders within the ",(0,o.jsx)(n.code,{children:"item-icons"})," directory to keep things organized. You would then specify an icon with it's folder name slash image name. For example: ",(0,o.jsx)(n.code,{children:"networking/monit.png"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"default-icon",children:"Default Icon"}),"\n",(0,o.jsxs)(n.p,{children:["If you'd like to set a default icon, to be applied to any items which don't have an icon already set, then this can be done under ",(0,o.jsx)(n.code,{children:"appConfig.defaultIcon"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"no-icon",children:"No Icon"}),"\n",(0,o.jsxs)(n.p,{children:["If you don't wish for a given item or section to have an icon, just leave out the ",(0,o.jsx)(n.code,{children:"icon"})," attribute."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"icon-collections-and-resources",children:"Icon Collections and Resources"}),"\n",(0,o.jsxs)(n.p,{children:["The following websites provide good-quality, free icon sets. To use any of these icons, either copy the link to the raw icon (it should end in ",(0,o.jsx)(n.code,{children:".svg"})," or ",(0,o.jsx)(n.code,{children:".png"}),") and paste it as your ",(0,o.jsx)(n.code,{children:"icon"}),", or download and save the icons in ",(0,o.jsx)(n.code,{children:"/user-data/item-icons"})," / mapped Docker volume. Full credit to the authors, please see the licenses for each service for usage and copyright information."]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://thehomelab.wiki/books/helpful-tools-resources/page/icons-for-self-hosted-dashboards",children:"Icons for Self-Hosted Apps"})," - 350+ high-quality icons for commonly self-hosted services"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://svgbox.net/iconsets/",children:"SVG Box"})," - Cryptocurrency, social media apps and flag icons"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://simpleicons.org/",children:"Simple Icons"})," - Free SVG brand icons, with easy API access"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://github.com/google/material-design-icons/",children:"Material Design Icons"})," - Hundreds of Open source PNG + SVG icons by Google"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://icons8.com/icons",children:"Icons8"})," - Thousands of icons, all with free versions at 64x64"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://www.flaticon.com/",children:"Flat Icon"})," - Wide variety of icon sets, most of which are free to use"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://www.svgrepo.com/",children:"SVG Repo"})," - 300,000+ Vector Icons"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["If you are a student, then you can get free access to premium icons on ",(0,o.jsx)(n.a,{href:"https://education.github.com/pack/redeem/iconscout-student",children:"Icon Scout"})," or ",(0,o.jsx)(n.a,{href:"https://icons8.com/github-students",children:"Icons8"})," using the ",(0,o.jsx)(n.a,{href:"https://education.github.com/pack",children:"GitHub Student Pack"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"notes",children:"Notes"}),"\n",(0,o.jsx)(n.p,{children:"If you are using icons from an external source, these will be fetched on initial page load automatically, if and when needed. But combining icons from multiple services may have a negative impact on performance."}),"\n",(0,o.jsx)(n.p,{children:"You can improve load speeds, by downloading your required icons, and serving them locally. Scaling icons to the minimum required dimensions (e.g. 128x128 or 64x64) will also greatly improve application load times."}),"\n",(0,o.jsx)(n.p,{children:"For icons from external sources, please see the Privacy Policies and Licenses for that provider."})]})}function d(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453(e,n,i){i.d(n,{R:()=>t,x:()=>r});var s=i(6540);const o={},c=s.createContext(o);function t(e){const n=s.useContext(c);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0bfe2fe2.e1057b54.js b/assets/js/0bfe2fe2.377813aa.js similarity index 99% rename from assets/js/0bfe2fe2.e1057b54.js rename to assets/js/0bfe2fe2.377813aa.js index fd462186..3842adce 100644 --- a/assets/js/0bfe2fe2.e1057b54.js +++ b/assets/js/0bfe2fe2.377813aa.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[7151],{5230(e,n,s){s.r(n),s.d(n,{assets:()=>h,contentTitle:()=>c,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"searching","title":"Keyboard Shortcuts","description":"Searching","source":"@site/docs/searching.md","sourceDirName":".","slug":"/searching","permalink":"/docs/searching","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/searching.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Authentication","permalink":"/docs/authentication"},"next":{"title":"Alternate Views & Opening Methods","permalink":"/docs/alternate-views"}}');var r=s(4848),t=s(8453);const a={},c="Keyboard Shortcuts",h={},o=[{value:"Searching",id:"searching",level:2},{value:"Navigating",id:"navigating",level:2},{value:"Launching Apps",id:"launching-apps",level:2},{value:"Tags",id:"tags",level:2},{value:"Custom Hotkeys",id:"custom-hotkeys",level:2},{value:"Web Search",id:"web-search",level:2},{value:"Setting Search Engine",id:"setting-search-engine",level:3},{value:"Using Custom Search Engine",id:"using-custom-search-engine",level:3},{value:"Setting Opening Method",id:"setting-opening-method",level:3},{value:"Using Bangs",id:"using-bangs",level:3},{value:"Disabling Web Search",id:"disabling-web-search",level:3},{value:"Opening URLs Directly",id:"opening-urls-directly",level:3},{value:"Clearing Search",id:"clearing-search",level:2}];function l(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",kbd:"kbd",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"keyboard-shortcuts",children:"Keyboard Shortcuts"})}),"\n",(0,r.jsx)(n.h2,{id:"searching",children:"Searching"}),"\n",(0,r.jsx)(n.p,{children:"One of the primary purposes of Dashy is to allow you to quickly find and launch a given app. To make this as quick as possible, there is no need to touch the mouse, or press a certain key to begin searching - just start typing. Results will be filtered in real-time. No need to worry about case, special characters or small typos, these are taken care of, and your results should appear."}),"\n",(0,r.jsx)(n.h2,{id:"navigating",children:"Navigating"}),"\n",(0,r.jsxs)(n.p,{children:["You can navigate through your items or search results using the keyboard. You can use ",(0,r.jsx)(n.kbd,{children:"Tab"})," to cycle through results, and ",(0,r.jsx)(n.kbd,{children:"Shift"})," + ",(0,r.jsx)(n.kbd,{children:"Tab"})," to go backwards. Or use the arrow keys, ",(0,r.jsx)(n.kbd,{children:"\u2191"}),", ",(0,r.jsx)(n.kbd,{children:"\u2192"}),", ",(0,r.jsx)(n.kbd,{children:"\u2193"})," and ",(0,r.jsx)(n.kbd,{children:"\u2190"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"launching-apps",children:"Launching Apps"}),"\n",(0,r.jsxs)(n.p,{children:["You can launch a elected app by hitting ",(0,r.jsx)(n.kbd,{children:"Enter"}),". This will open the app using your default opening method, specified in ",(0,r.jsx)(n.code,{children:"target"})," (either ",(0,r.jsx)(n.code,{children:"newtab"}),", ",(0,r.jsx)(n.code,{children:"sametab"}),", ",(0,r.jsx)(n.code,{children:"modal"}),", ",(0,r.jsx)(n.code,{children:"top"})," or ",(0,r.jsx)(n.code,{children:"workspace"}),"). You can also use ",(0,r.jsx)(n.kbd,{children:"Alt"})," + ",(0,r.jsx)(n.kbd,{children:"Enter"})," to open the app in a pop-up modal, or ",(0,r.jsx)(n.kbd,{children:"Ctrl"})," + ",(0,r.jsx)(n.kbd,{children:"Enter"})," to open it in a new tab. For all available opening methods, just right-click on an item, to bring up the context menu."]}),"\n",(0,r.jsx)(n.h2,{id:"tags",children:"Tags"}),"\n",(0,r.jsxs)(n.p,{children:["By default, items are filtered by the ",(0,r.jsx)(n.code,{children:"title"})," attribute, as well as the hostname (extracted from ",(0,r.jsx)(n.code,{children:"url"}),"), the ",(0,r.jsx)(n.code,{children:"provider"})," and ",(0,r.jsx)(n.code,{children:"description"}),". If you need to find results based on text which isn't included in these attributes, then you can add ",(0,r.jsx)(n.code,{children:"tags"})," to a given item."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" items:\n - title: Plex\n description: Media library\n icon: favicon\n url: https://plex.lab.local\n tags: [ movies, videos, music ]\n - title: FreshRSS\n description: RSS Reader\n icon: favicon\n url: https://freshrss.lab.local\n tags: [ news, updates, blogs ]\n\n"})}),"\n",(0,r.jsx)(n.p,{children:"In the above example, Plex will be visible when searching for 'movies', and FreshRSS with 'news'"}),"\n",(0,r.jsx)(n.h2,{id:"custom-hotkeys",children:"Custom Hotkeys"}),"\n",(0,r.jsxs)(n.p,{children:["For apps that you use regularly, you can set a custom keybinding. Use the ",(0,r.jsx)(n.code,{children:"hotkey"})," parameter on a certain item to specify a numeric key, between ",(0,r.jsx)(n.code,{children:"0 - 9"}),". You can then launch that app, by just pressing that key, which is much quicker than searching for it, if it's an app you use frequently."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- title: Bookstack\n icon: far fa-books\n url: https://bookstack.lab.local/\n hotkey: 2\n- title: Git Tea\n icon: fab fa-git\n url: https://git.lab.local/\n target: workspace\n hotkey: 3\n"})}),"\n",(0,r.jsxs)(n.p,{children:["In the above example, pressing ",(0,r.jsx)(n.kbd,{children:"2"})," will launch Bookstack. Or hitting ",(0,r.jsx)(n.kbd,{children:"3"})," will open Git in the workspace view."]}),"\n",(0,r.jsx)(n.h2,{id:"web-search",children:"Web Search"}),"\n",(0,r.jsxs)(n.p,{children:["It's possible to search the web directly from Dashy, which might be useful if you're using Dashy as your start page. This can be done by typing your query as normal, and then pressing ",(0,r.jsx)(n.kbd,{children:"\u23ce"}),". Web search options are configured under ",(0,r.jsx)(n.code,{children:"appConfig.webSearch"}),"."]}),"\n",(0,r.jsx)(n.h3,{id:"setting-search-engine",children:"Setting Search Engine"}),"\n",(0,r.jsxs)(n.p,{children:["Set your default search engine using the ",(0,r.jsx)(n.code,{children:"webSearch.searchEngine"})," property. This defaults to DuckDuckGo. Search engine must be referenced by their key, the following providers are supported:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.a,{href:"https://duckduckgo.com",children:(0,r.jsx)(n.code,{children:"duckduckgo"})}),", ",(0,r.jsx)(n.a,{href:"https://google.com",children:(0,r.jsx)(n.code,{children:"google"})}),", ",(0,r.jsx)(n.a,{href:"https://whoogle.sdf.org",children:(0,r.jsx)(n.code,{children:"whoogle"})}),", ",(0,r.jsx)(n.a,{href:"https://www.qwant.com",children:(0,r.jsx)(n.code,{children:"qwant"})}),", ",(0,r.jsx)(n.a,{href:"https://www.startpage.com",children:(0,r.jsx)(n.code,{children:"startpage"})}),", ",(0,r.jsx)(n.a,{href:"https://searx.bar",children:(0,r.jsx)(n.code,{children:"searx-bar"})}),", ",(0,r.jsx)(n.a,{href:"https://searx.info",children:(0,r.jsx)(n.code,{children:"searx-info"})})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.a,{href:"https://searx.tiekoetter.com",children:(0,r.jsx)(n.code,{children:"searx-tiekoetter"})}),", ",(0,r.jsx)(n.a,{href:"https://searx.bissisoft.com",children:(0,r.jsx)(n.code,{children:"searx-bissisoft"})}),", ",(0,r.jsx)(n.a,{href:"https://www.ecosia.org",children:(0,r.jsx)(n.code,{children:"ecosia"})}),", ",(0,r.jsx)(n.a,{href:"https://metager.org/meta",children:(0,r.jsx)(n.code,{children:"metager"})}),", ",(0,r.jsx)(n.a,{href:"https://swisscows.com",children:(0,r.jsx)(n.code,{children:"swisscows"})}),", ",(0,r.jsx)(n.a,{href:"https://www.mojeek.com",children:(0,r.jsx)(n.code,{children:"mojeek"})})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.a,{href:"https://en.wikipedia.org",children:(0,r.jsx)(n.code,{children:"wikipedia"})}),", ",(0,r.jsx)(n.a,{href:"https://www.wolframalpha.com",children:(0,r.jsx)(n.code,{children:"wolframalpha"})}),", ",(0,r.jsx)(n.a,{href:"https://stackoverflow.com",children:(0,r.jsx)(n.code,{children:"stackoverflow"})}),", ",(0,r.jsx)(n.a,{href:"https://github.com",children:(0,r.jsx)(n.code,{children:"github"})}),", ",(0,r.jsx)(n.a,{href:"https://www.reddit.com",children:(0,r.jsx)(n.code,{children:"reddit"})}),", ",(0,r.jsx)(n.a,{href:"https://youtube.com",children:(0,r.jsx)(n.code,{children:"youtube"})}),", ",(0,r.jsx)(n.a,{href:"https://www.bbc.co.uk",children:(0,r.jsx)(n.code,{children:"bbc"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"using-custom-search-engine",children:"Using Custom Search Engine"}),"\n",(0,r.jsxs)(n.p,{children:["You can also use a custom search engine, that isn't included in the above list (like a self-hosted instance of ",(0,r.jsx)(n.a,{href:"https://github.com/benbusby/whoogle-search",children:"Whoogle"})," or ",(0,r.jsx)(n.a,{href:"https://searx.github.io/searx/",children:"Searx"}),"). Set ",(0,r.jsx)(n.code,{children:"searchEngine: custom"}),", and then specify the URL (plus query params) to you're search engine under ",(0,r.jsx)(n.code,{children:"customSearchEngine"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n webSearch:\n searchEngine: custom\n customSearchEngine: 'https://searx.local/search?q='\n"})}),"\n",(0,r.jsx)(n.h3,{id:"setting-opening-method",children:"Setting Opening Method"}),"\n",(0,r.jsxs)(n.p,{children:["In a similar way to opening apps, you can specify where you would like search results to be opened. This is done under the ",(0,r.jsx)(n.code,{children:"openingMethod"})," attribute, and can be set to either ",(0,r.jsx)(n.code,{children:"newtab"}),", ",(0,r.jsx)(n.code,{children:"sametab"})," or ",(0,r.jsx)(n.code,{children:"workspace"}),". By default results are opened in a new tab."]}),"\n",(0,r.jsx)(n.h3,{id:"using-bangs",children:"Using Bangs"}),"\n",(0,r.jsxs)(n.p,{children:["An insanely useful feature of DDG is ",(0,r.jsx)(n.a,{href:"https://duckduckgo.com/bang",children:"Bangs"}),", where you type a specific character combination at the start of your search query, and it will be redirected the that website, such as '!w Docker' will display the Docker wikipedia page. Dashy has a similar feature, enabling you to define your own custom bangs to redirect search results to a specific app, website or search engine."]}),"\n",(0,r.jsxs)(n.p,{children:["This is done under the ",(0,r.jsx)(n.code,{children:"searchBangs"})," property, with a list of key value pairs. The key is what you will type, and the value is the destination, either as an identifier or a URL with query parameters."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n webSearch:\n searchEngine: 'duckduckgo'\n openingMethod: 'newtab'\n searchBangs:\n /r: reddit\n /w: wikipedia\n /s: https://whoogle.local/search?q=\n /a: https://www.amazon.co.uk/s?k=\n ':wolf': wolframalpha\n ':so': stackoverflow\n ':git': github\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Note that bangs begging with ",(0,r.jsx)(n.code,{children:"!"})," or ",(0,r.jsx)(n.code,{children:":"})," must be surrounded them in quotes"]}),"\n",(0,r.jsx)(n.h3,{id:"disabling-web-search",children:"Disabling Web Search"}),"\n",(0,r.jsxs)(n.p,{children:["Web search can be disabled, by setting ",(0,r.jsx)(n.code,{children:"disableWebSearch"}),", for example:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n webSearch: { disableWebSearch: true }\n"})}),"\n",(0,r.jsx)(n.h3,{id:"opening-urls-directly",children:"Opening URLs Directly"}),"\n",(0,r.jsxs)(n.p,{children:["When enabled, if your search query looks like a URL (e.g. ",(0,r.jsx)(n.code,{children:"github.com"}),", ",(0,r.jsx)(n.code,{children:"https://example.org/path"}),"), pressing ",(0,r.jsx)(n.kbd,{children:"Enter"})," will navigate directly to that URL instead of searching for it."]}),"\n",(0,r.jsxs)(n.p,{children:["Set ",(0,r.jsx)(n.code,{children:"appConfig.webSearch.openUrlsDirectly"})," to ",(0,r.jsx)(n.code,{children:"true"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n webSearch:\n openUrlsDirectly: true\n"})}),"\n",(0,r.jsx)(n.h2,{id:"clearing-search",children:"Clearing Search"}),"\n",(0,r.jsxs)(n.p,{children:["You can clear your search term at any time, resting the UI to it's initial state, by pressing ",(0,r.jsx)(n.kbd,{children:"Esc"}),".\nThis can also be used to close any open pop-up modals."]})]})}function d(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453(e,n,s){s.d(n,{R:()=>a,x:()=>c});var i=s(6540);const r={},t=i.createContext(r);function a(e){const n=i.useContext(t);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[7151],{5230(e,n,s){s.r(n),s.d(n,{assets:()=>h,contentTitle:()=>c,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"searching","title":"Keyboard Shortcuts","description":"Searching","source":"@site/docs/searching.md","sourceDirName":".","slug":"/searching","permalink":"/docs/searching","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/searching.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Authentication","permalink":"/docs/authentication"},"next":{"title":"Alternate Views & Opening Methods","permalink":"/docs/alternate-views"}}');var r=s(4848),t=s(8453);const a={},c="Keyboard Shortcuts",h={},o=[{value:"Searching",id:"searching",level:2},{value:"Navigating",id:"navigating",level:2},{value:"Launching Apps",id:"launching-apps",level:2},{value:"Tags",id:"tags",level:2},{value:"Custom Hotkeys",id:"custom-hotkeys",level:2},{value:"Web Search",id:"web-search",level:2},{value:"Setting Search Engine",id:"setting-search-engine",level:3},{value:"Using Custom Search Engine",id:"using-custom-search-engine",level:3},{value:"Setting Opening Method",id:"setting-opening-method",level:3},{value:"Using Bangs",id:"using-bangs",level:3},{value:"Disabling Web Search",id:"disabling-web-search",level:3},{value:"Opening URLs Directly",id:"opening-urls-directly",level:3},{value:"Clearing Search",id:"clearing-search",level:2}];function l(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",kbd:"kbd",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"keyboard-shortcuts",children:"Keyboard Shortcuts"})}),"\n",(0,r.jsx)(n.h2,{id:"searching",children:"Searching"}),"\n",(0,r.jsx)(n.p,{children:"One of the primary purposes of Dashy is to allow you to quickly find and launch a given app. To make this as quick as possible, there is no need to touch the mouse, or press a certain key to begin searching - just start typing. Results will be filtered in real-time. No need to worry about case, special characters or small typos, these are taken care of, and your results should appear."}),"\n",(0,r.jsx)(n.h2,{id:"navigating",children:"Navigating"}),"\n",(0,r.jsxs)(n.p,{children:["You can navigate through your items or search results using the keyboard. You can use ",(0,r.jsx)(n.kbd,{children:"Tab"})," to cycle through results, and ",(0,r.jsx)(n.kbd,{children:"Shift"})," + ",(0,r.jsx)(n.kbd,{children:"Tab"})," to go backwards. Or use the arrow keys, ",(0,r.jsx)(n.kbd,{children:"\u2191"}),", ",(0,r.jsx)(n.kbd,{children:"\u2192"}),", ",(0,r.jsx)(n.kbd,{children:"\u2193"})," and ",(0,r.jsx)(n.kbd,{children:"\u2190"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"launching-apps",children:"Launching Apps"}),"\n",(0,r.jsxs)(n.p,{children:["You can launch a elected app by hitting ",(0,r.jsx)(n.kbd,{children:"Enter"}),". This will open the app using your default opening method, specified in ",(0,r.jsx)(n.code,{children:"target"})," (either ",(0,r.jsx)(n.code,{children:"newtab"}),", ",(0,r.jsx)(n.code,{children:"sametab"}),", ",(0,r.jsx)(n.code,{children:"modal"}),", ",(0,r.jsx)(n.code,{children:"top"})," or ",(0,r.jsx)(n.code,{children:"workspace"}),"). You can also use ",(0,r.jsx)(n.kbd,{children:"Alt"})," + ",(0,r.jsx)(n.kbd,{children:"Enter"})," to open the app in a pop-up modal, or ",(0,r.jsx)(n.kbd,{children:"Ctrl"})," + ",(0,r.jsx)(n.kbd,{children:"Enter"})," to open it in a new tab. For all available opening methods, just right-click on an item, to bring up the context menu."]}),"\n",(0,r.jsx)(n.h2,{id:"tags",children:"Tags"}),"\n",(0,r.jsxs)(n.p,{children:["By default, items are filtered by the ",(0,r.jsx)(n.code,{children:"title"})," attribute, as well as the hostname (extracted from ",(0,r.jsx)(n.code,{children:"url"}),"), the ",(0,r.jsx)(n.code,{children:"provider"})," and ",(0,r.jsx)(n.code,{children:"description"}),". If you need to find results based on text which isn't included in these attributes, then you can add ",(0,r.jsx)(n.code,{children:"tags"})," to a given item."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" items:\n - title: Plex\n description: Media library\n icon: favicon\n url: https://plex.lab.local\n tags: [ movies, videos, music ]\n - title: FreshRSS\n description: RSS Reader\n icon: favicon\n url: https://freshrss.lab.local\n tags: [ news, updates, blogs ]\n\n"})}),"\n",(0,r.jsx)(n.p,{children:"In the above example, Plex will be visible when searching for 'movies', and FreshRSS with 'news'"}),"\n",(0,r.jsx)(n.h2,{id:"custom-hotkeys",children:"Custom Hotkeys"}),"\n",(0,r.jsxs)(n.p,{children:["For apps that you use regularly, you can set a custom keybinding. Use the ",(0,r.jsx)(n.code,{children:"hotkey"})," parameter on a certain item to specify a numeric key, between ",(0,r.jsx)(n.code,{children:"0 - 9"}),". You can then launch that app, by just pressing that key, which is much quicker than searching for it, if it's an app you use frequently."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- title: Bookstack\n icon: far fa-books\n url: https://bookstack.lab.local/\n hotkey: 2\n- title: Git Tea\n icon: fab fa-git\n url: https://git.lab.local/\n target: workspace\n hotkey: 3\n"})}),"\n",(0,r.jsxs)(n.p,{children:["In the above example, pressing ",(0,r.jsx)(n.kbd,{children:"2"})," will launch Bookstack. Or hitting ",(0,r.jsx)(n.kbd,{children:"3"})," will open Git in the workspace view."]}),"\n",(0,r.jsx)(n.h2,{id:"web-search",children:"Web Search"}),"\n",(0,r.jsxs)(n.p,{children:["It's possible to search the web directly from Dashy, which might be useful if you're using Dashy as your start page. This can be done by typing your query as normal, and then pressing ",(0,r.jsx)(n.kbd,{children:"\u23ce"}),". Web search options are configured under ",(0,r.jsx)(n.code,{children:"appConfig.webSearch"}),"."]}),"\n",(0,r.jsx)(n.h3,{id:"setting-search-engine",children:"Setting Search Engine"}),"\n",(0,r.jsxs)(n.p,{children:["Set your default search engine using the ",(0,r.jsx)(n.code,{children:"webSearch.searchEngine"})," property. This defaults to DuckDuckGo. Search engine must be referenced by their key, the following providers are supported:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.a,{href:"https://duckduckgo.com",children:(0,r.jsx)(n.code,{children:"duckduckgo"})}),", ",(0,r.jsx)(n.a,{href:"https://google.com",children:(0,r.jsx)(n.code,{children:"google"})}),", ",(0,r.jsx)(n.a,{href:"https://whoogle.sdf.org",children:(0,r.jsx)(n.code,{children:"whoogle"})}),", ",(0,r.jsx)(n.a,{href:"https://www.qwant.com",children:(0,r.jsx)(n.code,{children:"qwant"})}),", ",(0,r.jsx)(n.a,{href:"https://www.startpage.com",children:(0,r.jsx)(n.code,{children:"startpage"})}),", ",(0,r.jsx)(n.a,{href:"https://searx.bar",children:(0,r.jsx)(n.code,{children:"searx-bar"})}),", ",(0,r.jsx)(n.a,{href:"https://searx.info",children:(0,r.jsx)(n.code,{children:"searx-info"})})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.a,{href:"https://searx.tiekoetter.com",children:(0,r.jsx)(n.code,{children:"searx-tiekoetter"})}),", ",(0,r.jsx)(n.a,{href:"https://searx.bissisoft.com",children:(0,r.jsx)(n.code,{children:"searx-bissisoft"})}),", ",(0,r.jsx)(n.a,{href:"https://www.ecosia.org",children:(0,r.jsx)(n.code,{children:"ecosia"})}),", ",(0,r.jsx)(n.a,{href:"https://metager.org/meta",children:(0,r.jsx)(n.code,{children:"metager"})}),", ",(0,r.jsx)(n.a,{href:"https://swisscows.com",children:(0,r.jsx)(n.code,{children:"swisscows"})}),", ",(0,r.jsx)(n.a,{href:"https://www.mojeek.com",children:(0,r.jsx)(n.code,{children:"mojeek"})})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.a,{href:"https://en.wikipedia.org",children:(0,r.jsx)(n.code,{children:"wikipedia"})}),", ",(0,r.jsx)(n.a,{href:"https://www.wolframalpha.com",children:(0,r.jsx)(n.code,{children:"wolframalpha"})}),", ",(0,r.jsx)(n.a,{href:"https://stackoverflow.com",children:(0,r.jsx)(n.code,{children:"stackoverflow"})}),", ",(0,r.jsx)(n.a,{href:"https://github.com",children:(0,r.jsx)(n.code,{children:"github"})}),", ",(0,r.jsx)(n.a,{href:"https://www.reddit.com",children:(0,r.jsx)(n.code,{children:"reddit"})}),", ",(0,r.jsx)(n.a,{href:"https://youtube.com",children:(0,r.jsx)(n.code,{children:"youtube"})}),", ",(0,r.jsx)(n.a,{href:"https://www.bbc.co.uk",children:(0,r.jsx)(n.code,{children:"bbc"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"using-custom-search-engine",children:"Using Custom Search Engine"}),"\n",(0,r.jsxs)(n.p,{children:["You can also use a custom search engine, that isn't included in the above list (like a self-hosted instance of ",(0,r.jsx)(n.a,{href:"https://github.com/benbusby/whoogle-search",children:"Whoogle"})," or ",(0,r.jsx)(n.a,{href:"https://searx.github.io/searx/",children:"Searx"}),"). Set ",(0,r.jsx)(n.code,{children:"searchEngine: custom"}),", and then specify the URL (plus query params) to you're search engine under ",(0,r.jsx)(n.code,{children:"customSearchEngine"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n webSearch:\n searchEngine: custom\n customSearchEngine: 'https://searx.local/search?q='\n"})}),"\n",(0,r.jsx)(n.h3,{id:"setting-opening-method",children:"Setting Opening Method"}),"\n",(0,r.jsxs)(n.p,{children:["In a similar way to opening apps, you can specify where you would like search results to be opened. This is done under the ",(0,r.jsx)(n.code,{children:"openingMethod"})," attribute, and can be set to either ",(0,r.jsx)(n.code,{children:"newtab"}),", ",(0,r.jsx)(n.code,{children:"sametab"})," or ",(0,r.jsx)(n.code,{children:"workspace"}),". By default results are opened in a new tab."]}),"\n",(0,r.jsx)(n.h3,{id:"using-bangs",children:"Using Bangs"}),"\n",(0,r.jsxs)(n.p,{children:["An insanely useful feature of DDG is ",(0,r.jsx)(n.a,{href:"https://duckduckgo.com/bang",children:"Bangs"}),", where you type a specific character combination at the start of your search query, and it will be redirected the that website, such as '!w Docker' will display the Docker wikipedia page. Dashy has a similar feature, enabling you to define your own custom bangs to redirect search results to a specific app, website or search engine."]}),"\n",(0,r.jsxs)(n.p,{children:["This is done under the ",(0,r.jsx)(n.code,{children:"searchBangs"})," property, with a list of key value pairs. The key is what you will type, and the value is the destination, either as an identifier or a URL with query parameters."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n webSearch:\n searchEngine: 'duckduckgo'\n openingMethod: 'newtab'\n searchBangs:\n /r: reddit\n /w: wikipedia\n /s: https://whoogle.local/search?q=\n /a: https://www.amazon.co.uk/s?k=\n ':wolf': wolframalpha\n ':so': stackoverflow\n ':git': github\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Note that bangs begging with ",(0,r.jsx)(n.code,{children:"!"})," or ",(0,r.jsx)(n.code,{children:":"})," must be surrounded them in quotes"]}),"\n",(0,r.jsx)(n.h3,{id:"disabling-web-search",children:"Disabling Web Search"}),"\n",(0,r.jsxs)(n.p,{children:["Web search can be disabled, by setting ",(0,r.jsx)(n.code,{children:"disableWebSearch"}),", for example:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n webSearch: { disableWebSearch: true }\n"})}),"\n",(0,r.jsx)(n.h3,{id:"opening-urls-directly",children:"Opening URLs Directly"}),"\n",(0,r.jsxs)(n.p,{children:["When enabled, if your search query looks like a URL (e.g. ",(0,r.jsx)(n.code,{children:"github.com"}),", ",(0,r.jsx)(n.code,{children:"https://example.org/path"}),"), pressing ",(0,r.jsx)(n.kbd,{children:"Enter"})," will navigate directly to that URL instead of searching for it."]}),"\n",(0,r.jsxs)(n.p,{children:["Set ",(0,r.jsx)(n.code,{children:"appConfig.webSearch.openUrlsDirectly"})," to ",(0,r.jsx)(n.code,{children:"true"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n webSearch:\n openUrlsDirectly: true\n"})}),"\n",(0,r.jsx)(n.h2,{id:"clearing-search",children:"Clearing Search"}),"\n",(0,r.jsxs)(n.p,{children:["You can clear your search term at any time, resting the UI to it's initial state, by pressing ",(0,r.jsx)(n.kbd,{children:"Esc"}),".\nThis can also be used to close any open pop-up modals."]})]})}function d(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453(e,n,s){s.d(n,{R:()=>a,x:()=>c});var i=s(6540);const r={},t=i.createContext(r);function a(e){const n=i.useContext(t);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1745c531.220c23d8.js b/assets/js/1745c531.e9ce1578.js similarity index 94% rename from assets/js/1745c531.220c23d8.js rename to assets/js/1745c531.e9ce1578.js index 17c55eef..f88d96ec 100644 --- a/assets/js/1745c531.220c23d8.js +++ b/assets/js/1745c531.e9ce1578.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[3790],{2092(e,t,s){s.r(t),s.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>i});const o=JSON.parse('{"id":"showcase/readme","title":"readme","description":"See: Showcase.","source":"@site/docs/showcase/readme.md","sourceDirName":"showcase","slug":"/showcase/","permalink":"/docs/showcase/","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/showcase/readme.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{}}');var n=s(4848),c=s(8453);const a={},r=void 0,d={},i=[];function u(e){const t={a:"a",p:"p",...(0,c.R)(),...e.components};return(0,n.jsxs)(t.p,{children:["See: ",(0,n.jsx)(t.a,{href:"/docs/showcase",children:"Showcase"}),"."]})}function h(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},8453(e,t,s){s.d(t,{R:()=>a,x:()=>r});var o=s(6540);const n={},c=o.createContext(n);function a(e){const t=o.useContext(c);return o.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),o.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[3790],{2092(e,t,s){s.r(t),s.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>i});const o=JSON.parse('{"id":"showcase/readme","title":"readme","description":"See: Showcase.","source":"@site/docs/showcase/readme.md","sourceDirName":"showcase","slug":"/showcase/","permalink":"/docs/showcase/","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/showcase/readme.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{}}');var n=s(4848),c=s(8453);const a={},r=void 0,d={},i=[];function u(e){const t={a:"a",p:"p",...(0,c.R)(),...e.components};return(0,n.jsxs)(t.p,{children:["See: ",(0,n.jsx)(t.a,{href:"/docs/showcase",children:"Showcase"}),"."]})}function h(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},8453(e,t,s){s.d(t,{R:()=>a,x:()=>r});var o=s(6540);const n={},c=o.createContext(n);function a(e){const t=o.useContext(c);return o.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),o.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18ba09e8.a30799d0.js b/assets/js/18ba09e8.9f8fb38a.js similarity index 99% rename from assets/js/18ba09e8.a30799d0.js rename to assets/js/18ba09e8.9f8fb38a.js index 87b86b50..4903224b 100644 --- a/assets/js/18ba09e8.a30799d0.js +++ b/assets/js/18ba09e8.9f8fb38a.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[6849],{4580(e,s,t){t.r(s),t.d(s,{assets:()=>h,contentTitle:()=>c,default:()=>a,frontMatter:()=>o,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"id":"credits","title":"Credits","description":"Sponsors","source":"@site/docs/credits.md","sourceDirName":".","slug":"/credits","permalink":"/docs/credits","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/credits.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Privacy & Security","permalink":"/docs/privacy"},"next":{"title":"License","permalink":"/docs/license"}}');var i=t(4848),r=t(8453);const o={},c="Credits",h={},d=[{value:"Sponsors",id:"sponsors",level:2},{value:"Contributors",id:"contributors",level:2},{value:"Newest Stargazers",id:"newest-stargazers",level:2},{value:"Dependencies",id:"dependencies",level:2},{value:"Core",id:"core",level:3},{value:"Utilities",id:"utilities",level:3},{value:"Frontend Components",id:"frontend-components",level:3},{value:"You",id:"you",level:2}];function l(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"credits",children:"Credits"})}),"\n",(0,i.jsx)(s.h2,{id:"sponsors",children:"Sponsors"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.img,{src:"https://readme-contribs.as93.net/sponsors/lissy93",alt:"Sponsors"})}),"\n",(0,i.jsx)(s.h2,{id:"contributors",children:"Contributors"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.img,{src:"https://readme-contribs.as93.net/contributors/lissy93/dashy?perRow=12&limit=96",alt:"Contributors"})}),"\n",(0,i.jsx)(s.h2,{id:"newest-stargazers",children:"Newest Stargazers"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/stargazers",children:(0,i.jsx)(s.img,{src:"https://readme-contribs.as93.net/stargazers/lissy93/dashy?perRow=16&fontSize=10&limit=96",alt:"Stargazers"})})}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/lissy93/dashy/network/members",children:(0,i.jsx)(s.img,{src:"https://readme-contribs.as93.net/forkers/lissy93/dashy?perRow=16&fontSize=10&limit=96",alt:"Forkers"})})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h2,{id:"dependencies",children:"Dependencies"}),"\n",(0,i.jsx)(s.p,{children:"This app definitely wouldn't have been quite so possible without the making use of the following package and components. Full credit and big kudos to their respective authors, who've done an amazing job in building and maintaining them. Full credit and big kudos to their respective authors, who've done an amazing job in building and maintaining them"}),"\n",(0,i.jsx)(s.h3,{id:"core",children:"Core"}),"\n",(0,i.jsxs)(s.p,{children:["At it's core, the application uses ",(0,i.jsx)(s.a,{href:"https://github.com/vuejs/vue",children:(0,i.jsx)(s.strong,{children:"Vue.js"})}),", as well as it's services with ",(0,i.jsx)(s.a,{href:"https://vuex.vuejs.org/",children:(0,i.jsx)(s.strong,{children:"VueX"})})," for state management. Styling is done with ",(0,i.jsx)(s.a,{href:"https://github.com/sass/sass",children:(0,i.jsx)(s.strong,{children:"SCSS"})}),", JavaScript is currently ",(0,i.jsx)(s.a,{href:"https://github.com/babel/babel",children:(0,i.jsx)(s.strong,{children:"Babel"})}),", (but I am in the process of converting to ",(0,i.jsx)(s.a,{href:"https://github.com/Microsoft/TypeScript",children:(0,i.jsx)(s.strong,{children:"TypeScript"})}),"). Linting is done with ",(0,i.jsx)(s.a,{href:"https://github.com/eslint/eslint",children:(0,i.jsx)(s.strong,{children:"ESLint"})})," and ",(0,i.jsx)(s.a,{href:"https://prettier.io/",children:(0,i.jsx)(s.strong,{children:"Prettier"})}),", both following the ",(0,i.jsx)(s.a,{href:"https://github.com/airbnb/javascript",children:(0,i.jsx)(s.strong,{children:"AirBnB Styleguide"})}),". The config is defined in ",(0,i.jsx)(s.a,{href:"https://github.com/yaml/yaml",children:(0,i.jsx)(s.strong,{children:"YAML"})}),", with a simple ",(0,i.jsx)(s.a,{href:"https://github.com/nodejs/node",children:(0,i.jsx)(s.strong,{children:"Node.js"})})," server to serve up the static app and the optional API endpoints, and container deployment is done with ",(0,i.jsx)(s.a,{href:"https://www.docker.com/",children:(0,i.jsx)(s.strong,{children:"Docker"})}),"."]}),"\n",(0,i.jsx)(s.h3,{id:"utilities",children:"Utilities"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/brix/crypto-js",children:(0,i.jsx)(s.code,{children:"crypto-js"})})," - Encryption implementations by @evanvosberg and community ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/axios/axios",children:(0,i.jsx)(s.code,{children:"axios"})})," - Promise based HTTP client by @mzabriskie and community ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/ajv-validator/ajv",children:(0,i.jsx)(s.code,{children:"ajv"})})," - JSON schema Validator by @epoberezkin and community ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/kazupon/vue-i18n",children:(0,i.jsx)(s.code,{children:"i18n"})})," - Internationalization plugin by @kazupon and community ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/frappe/charts",children:(0,i.jsx)(s.code,{children:"frappe-charts"})})," - Lightweight charting library by @frappe ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n"]}),"\n",(0,i.jsx)(s.h3,{id:"frontend-components",children:"Frontend Components"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/sagalbot/vue-select",children:(0,i.jsx)(s.code,{children:"vue-select"})})," - Dropdown component by @sagalbot ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/euvl/vue-js-modal",children:(0,i.jsx)(s.code,{children:"vue-js-modal"})})," - Modal component by @euvl ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/Akryum/v-tooltip",children:(0,i.jsx)(s.code,{children:"v-tooltip"})})," - Tooltip component by @Akryum ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/jairoblatt/vue-material-tabs",children:(0,i.jsx)(s.code,{children:"vue-material-tabs"})})," - Tab view component by @jairoblatt ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/yansenlei/VJsoneditor",children:(0,i.jsx)(s.code,{children:"VJsoneditor"})})," - Interactive JSON editor component by @yansenlei ",(0,i.jsx)(s.code,{children:"MIT"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Forked from ",(0,i.jsx)(s.a,{href:"https://github.com/josdejong/jsoneditor",children:(0,i.jsx)(s.code,{children:"JsonEditor"})})," by @josdejong ",(0,i.jsx)(s.code,{children:"Apache-2.0 License"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/shakee93/vue-toasted",children:(0,i.jsx)(s.code,{children:"vue-toasted"})})," - Toast notification component by @shakee93 ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/saintplay/vue-swatches",children:(0,i.jsx)(s.code,{children:"vue-swatches"})})," - Color palete picker by @saintplay ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h2,{id:"you",children:"You"}),"\n",(0,i.jsxs)(s.p,{children:["Would you like to be listed here? Whatever your skill set, Dashy needs people like you to help support future development. Check out the ",(0,i.jsx)(s.a,{href:"/docs/contributing",children:"Contributing Page"})," for ways that you can get involved. Huge thank you to everyone who has already contributed! \ud83d\udc96"]})]})}function a(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453(e,s,t){t.d(s,{R:()=>o,x:()=>c});var n=t(6540);const i={},r=n.createContext(i);function o(e){const s=n.useContext(r);return n.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[6849],{4580(e,s,t){t.r(s),t.d(s,{assets:()=>h,contentTitle:()=>c,default:()=>a,frontMatter:()=>o,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"id":"credits","title":"Credits","description":"Sponsors","source":"@site/docs/credits.md","sourceDirName":".","slug":"/credits","permalink":"/docs/credits","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/credits.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Privacy & Security","permalink":"/docs/privacy"},"next":{"title":"License","permalink":"/docs/license"}}');var i=t(4848),r=t(8453);const o={},c="Credits",h={},d=[{value:"Sponsors",id:"sponsors",level:2},{value:"Contributors",id:"contributors",level:2},{value:"Newest Stargazers",id:"newest-stargazers",level:2},{value:"Dependencies",id:"dependencies",level:2},{value:"Core",id:"core",level:3},{value:"Utilities",id:"utilities",level:3},{value:"Frontend Components",id:"frontend-components",level:3},{value:"You",id:"you",level:2}];function l(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"credits",children:"Credits"})}),"\n",(0,i.jsx)(s.h2,{id:"sponsors",children:"Sponsors"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.img,{src:"https://readme-contribs.as93.net/sponsors/lissy93",alt:"Sponsors"})}),"\n",(0,i.jsx)(s.h2,{id:"contributors",children:"Contributors"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.img,{src:"https://readme-contribs.as93.net/contributors/lissy93/dashy?perRow=12&limit=96",alt:"Contributors"})}),"\n",(0,i.jsx)(s.h2,{id:"newest-stargazers",children:"Newest Stargazers"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/stargazers",children:(0,i.jsx)(s.img,{src:"https://readme-contribs.as93.net/stargazers/lissy93/dashy?perRow=16&fontSize=10&limit=96",alt:"Stargazers"})})}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/lissy93/dashy/network/members",children:(0,i.jsx)(s.img,{src:"https://readme-contribs.as93.net/forkers/lissy93/dashy?perRow=16&fontSize=10&limit=96",alt:"Forkers"})})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h2,{id:"dependencies",children:"Dependencies"}),"\n",(0,i.jsx)(s.p,{children:"This app definitely wouldn't have been quite so possible without the making use of the following package and components. Full credit and big kudos to their respective authors, who've done an amazing job in building and maintaining them. Full credit and big kudos to their respective authors, who've done an amazing job in building and maintaining them"}),"\n",(0,i.jsx)(s.h3,{id:"core",children:"Core"}),"\n",(0,i.jsxs)(s.p,{children:["At it's core, the application uses ",(0,i.jsx)(s.a,{href:"https://github.com/vuejs/vue",children:(0,i.jsx)(s.strong,{children:"Vue.js"})}),", as well as it's services with ",(0,i.jsx)(s.a,{href:"https://vuex.vuejs.org/",children:(0,i.jsx)(s.strong,{children:"VueX"})})," for state management. Styling is done with ",(0,i.jsx)(s.a,{href:"https://github.com/sass/sass",children:(0,i.jsx)(s.strong,{children:"SCSS"})}),", JavaScript is currently ",(0,i.jsx)(s.a,{href:"https://github.com/babel/babel",children:(0,i.jsx)(s.strong,{children:"Babel"})}),", (but I am in the process of converting to ",(0,i.jsx)(s.a,{href:"https://github.com/Microsoft/TypeScript",children:(0,i.jsx)(s.strong,{children:"TypeScript"})}),"). Linting is done with ",(0,i.jsx)(s.a,{href:"https://github.com/eslint/eslint",children:(0,i.jsx)(s.strong,{children:"ESLint"})})," and ",(0,i.jsx)(s.a,{href:"https://prettier.io/",children:(0,i.jsx)(s.strong,{children:"Prettier"})}),", both following the ",(0,i.jsx)(s.a,{href:"https://github.com/airbnb/javascript",children:(0,i.jsx)(s.strong,{children:"AirBnB Styleguide"})}),". The config is defined in ",(0,i.jsx)(s.a,{href:"https://github.com/yaml/yaml",children:(0,i.jsx)(s.strong,{children:"YAML"})}),", with a simple ",(0,i.jsx)(s.a,{href:"https://github.com/nodejs/node",children:(0,i.jsx)(s.strong,{children:"Node.js"})})," server to serve up the static app and the optional API endpoints, and container deployment is done with ",(0,i.jsx)(s.a,{href:"https://www.docker.com/",children:(0,i.jsx)(s.strong,{children:"Docker"})}),"."]}),"\n",(0,i.jsx)(s.h3,{id:"utilities",children:"Utilities"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/brix/crypto-js",children:(0,i.jsx)(s.code,{children:"crypto-js"})})," - Encryption implementations by @evanvosberg and community ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/axios/axios",children:(0,i.jsx)(s.code,{children:"axios"})})," - Promise based HTTP client by @mzabriskie and community ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/ajv-validator/ajv",children:(0,i.jsx)(s.code,{children:"ajv"})})," - JSON schema Validator by @epoberezkin and community ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/kazupon/vue-i18n",children:(0,i.jsx)(s.code,{children:"i18n"})})," - Internationalization plugin by @kazupon and community ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/frappe/charts",children:(0,i.jsx)(s.code,{children:"frappe-charts"})})," - Lightweight charting library by @frappe ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n"]}),"\n",(0,i.jsx)(s.h3,{id:"frontend-components",children:"Frontend Components"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/sagalbot/vue-select",children:(0,i.jsx)(s.code,{children:"vue-select"})})," - Dropdown component by @sagalbot ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/euvl/vue-js-modal",children:(0,i.jsx)(s.code,{children:"vue-js-modal"})})," - Modal component by @euvl ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/Akryum/v-tooltip",children:(0,i.jsx)(s.code,{children:"v-tooltip"})})," - Tooltip component by @Akryum ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/jairoblatt/vue-material-tabs",children:(0,i.jsx)(s.code,{children:"vue-material-tabs"})})," - Tab view component by @jairoblatt ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/yansenlei/VJsoneditor",children:(0,i.jsx)(s.code,{children:"VJsoneditor"})})," - Interactive JSON editor component by @yansenlei ",(0,i.jsx)(s.code,{children:"MIT"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Forked from ",(0,i.jsx)(s.a,{href:"https://github.com/josdejong/jsoneditor",children:(0,i.jsx)(s.code,{children:"JsonEditor"})})," by @josdejong ",(0,i.jsx)(s.code,{children:"Apache-2.0 License"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/shakee93/vue-toasted",children:(0,i.jsx)(s.code,{children:"vue-toasted"})})," - Toast notification component by @shakee93 ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.a,{href:"https://github.com/saintplay/vue-swatches",children:(0,i.jsx)(s.code,{children:"vue-swatches"})})," - Color palete picker by @saintplay ",(0,i.jsx)(s.code,{children:"MIT"})]}),"\n"]}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h2,{id:"you",children:"You"}),"\n",(0,i.jsxs)(s.p,{children:["Would you like to be listed here? Whatever your skill set, Dashy needs people like you to help support future development. Check out the ",(0,i.jsx)(s.a,{href:"/docs/contributing",children:"Contributing Page"})," for ways that you can get involved. Huge thank you to everyone who has already contributed! \ud83d\udc96"]})]})}function a(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453(e,s,t){t.d(s,{R:()=>o,x:()=>c});var n=t(6540);const i={},r=n.createContext(i);function o(e){const s=n.useContext(r);return n.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1f5fb0df.141f8dbe.js b/assets/js/1f5fb0df.caa03193.js similarity index 99% rename from assets/js/1f5fb0df.141f8dbe.js rename to assets/js/1f5fb0df.caa03193.js index adea0896..17c1d910 100644 --- a/assets/js/1f5fb0df.141f8dbe.js +++ b/assets/js/1f5fb0df.caa03193.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[9695],{6644(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"management","title":"App Management","description":"The following article is a primer on managing self-hosted apps. It covers everything from keeping the Dashy (or any other app) up-to-date, secure, backed up, to other topics like auto-starting, monitoring, log management, web server configuration and using custom domains.","source":"@site/docs/management.md","sourceDirName":".","slug":"/management","permalink":"/docs/management","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/management.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Configuring","permalink":"/docs/configuring"},"next":{"title":"Troubleshooting","permalink":"/docs/troubleshooting"}}');var r=s(4848),o=s(8453);const t={},a="App Management",c={},l=[{value:"Contents",id:"contents",level:2},{value:"Providing Assets",id:"providing-assets",level:2},{value:"Running Commands",id:"running-commands",level:2},{value:"Healthchecks",id:"healthchecks",level:2},{value:"Logs and Performance",id:"logs-and-performance",level:2},{value:"Container Logs",id:"container-logs",level:3},{value:"Container Performance",id:"container-performance",level:3},{value:"Management Apps",id:"management-apps",level:3},{value:"Advanced Logging and Monitoring",id:"advanced-logging-and-monitoring",level:3},{value:"Auto-Starting at System Boot",id:"auto-starting-at-system-boot",level:2},{value:"Updating",id:"updating",level:2},{value:"Updating Docker Container",id:"updating-docker-container",level:3},{value:"Automatic Docker Updates",id:"automatic-docker-updates",level:3},{value:"Updating Dashy from Source",id:"updating-dashy-from-source",level:3},{value:"Backing Up",id:"backing-up",level:2},{value:"Backing Up Containers",id:"backing-up-containers",level:3},{value:"Backing Up Volumes",id:"backing-up-volumes",level:3},{value:"Dashy-Specific Backup",id:"dashy-specific-backup",level:3},{value:"Scheduling",id:"scheduling",level:2},{value:"SSL Certificates",id:"ssl-certificates",level:2},{value:"Auto-SSL",id:"auto-ssl",level:3},{value:"Getting a Self-Signed SSL Certificate",id:"getting-a-self-signed-ssl-certificate",level:3},{value:"Passing a Self-Signed Certificate to Dashy",id:"passing-a-self-signed-certificate-to-dashy",level:3},{value:"Authentication",id:"authentication",level:2},{value:"Managing Containers with Docker Compose",id:"managing-containers-with-docker-compose",level:2},{value:"Passing in Environmental Variables",id:"passing-in-environmental-variables",level:2},{value:"Setting Headers",id:"setting-headers",level:2},{value:"Example Headers",id:"example-headers",level:3},{value:"Caddy",id:"caddy",level:4},{value:"NGINX",id:"nginx",level:4},{value:"Traefik",id:"traefik",level:4},{value:"HAProxy",id:"haproxy",level:4},{value:"Apache",id:"apache",level:4},{value:"Squid",id:"squid",level:4},{value:"Remote Access",id:"remote-access",level:2},{value:"WireGuard",id:"wireguard",level:3},{value:"Example Server Config",id:"example-server-config",level:4},{value:"Example Client Config",id:"example-client-config",level:4},{value:"Reverse SSH Tunnel",id:"reverse-ssh-tunnel",level:3},{value:"TCP Tunnel",id:"tcp-tunnel",level:3},{value:"Custom Domain",id:"custom-domain",level:2},{value:"Using DNS",id:"using-dns",level:3},{value:"Using NGINX",id:"using-nginx",level:3},{value:"Container Security",id:"container-security",level:2},{value:"Keep Docker Up-To-Date",id:"keep-docker-up-to-date",level:3},{value:"Set Resource Quotas",id:"set-resource-quotas",level:3},{value:"Don't Run as Root",id:"dont-run-as-root",level:3},{value:"Specify a User",id:"specify-a-user",level:3},{value:"Limit capabilities",id:"limit-capabilities",level:3},{value:"Prevent new Privileges being Added",id:"prevent-new-privileges-being-added",level:3},{value:"Disable Inter-Container Communication",id:"disable-inter-container-communication",level:3},{value:"Don't Expose the Docker Daemon Socket",id:"dont-expose-the-docker-daemon-socket",level:3},{value:"Use Read-Only Volumes",id:"use-read-only-volumes",level:3},{value:"Set the Logging Level",id:"set-the-logging-level",level:3},{value:"Verify Image before Pulling",id:"verify-image-before-pulling",level:3},{value:"Specify the Tag",id:"specify-the-tag",level:3},{value:"Container Security Scanning",id:"container-security-scanning",level:3},{value:"Registry Security",id:"registry-security",level:3},{value:"Security Modules",id:"security-modules",level:3},{value:"Web Server Configuration",id:"web-server-configuration",level:2},{value:"NGINX",id:"nginx-1",level:3},{value:"Apache",id:"apache-1",level:3},{value:"Caddy",id:"caddy-1",level:3},{value:"Firebase Hosting",id:"firebase-hosting",level:3},{value:"cPanel",id:"cpanel",level:3},{value:"Running a Modified Version of the App",id:"running-a-modified-version-of-the-app",level:2},{value:"Building your Own Container",id:"building-your-own-container",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"app-management",children:"App Management"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"The following article is a primer on managing self-hosted apps. It covers everything from keeping the Dashy (or any other app) up-to-date, secure, backed up, to other topics like auto-starting, monitoring, log management, web server configuration and using custom domains."})}),"\n",(0,r.jsx)(n.h2,{id:"contents",children:"Contents"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#providing-assets",children:"Providing Assets"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#running-commands",children:"Running Commands"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#healthchecks",children:"Healthchecks"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#logs-and-performance",children:"Logs and Performance"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#auto-starting-at-system-boot",children:"Auto-Starting at Boot"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#updating",children:"Updating"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#backing-up",children:"Backing Up"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#scheduling",children:"Scheduling"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#ssl-certificates",children:"SSL Certificates"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#authentication",children:"Authentication"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#managing-containers-with-docker-compose",children:"Managing with Compose"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#passing-in-environmental-variables",children:"Environmental Variables"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#setting-headers",children:"Setting Headers"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#remote-access",children:"Remote Access"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#custom-domain",children:"Custom Domain"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#container-security",children:"Securing Containers"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#web-server-configuration",children:"Web Server Configuration"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#running-a-modified-version-of-the-app",children:"Running a Modified App"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#building-your-own-container",children:"Building your Own Container"})}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"providing-assets",children:"Providing Assets"}),"\n",(0,r.jsx)(n.p,{children:"Although not essential, you will most likely want to provide several assets to your running app."}),"\n",(0,r.jsxs)(n.p,{children:["This is easy to do using ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/storage/volumes/",children:"Docker Volumes"}),", which lets you share a file or directory between your host system, and the container. Volumes are specified in the Docker run command, or Docker compose file, using the ",(0,r.jsx)(n.code,{children:"--volume"})," or ",(0,r.jsx)(n.code,{children:"-v"})," flags. The value of which consists of the path to the file / directory on your host system, followed by the destination path within the container. Fields are separated by a colon (",(0,r.jsx)(n.code,{children:":"}),"), and must be in the correct order. For example: ",(0,r.jsx)(n.code,{children:"-v ~/alicia/my-local-conf.yml:/app/user-data/conf.yml"})]}),"\n",(0,r.jsx)(n.p,{children:"In Dashy, commonly configured resources include:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"./user-data/conf.yml"})," - Your main application config file"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"./public/item-icons"})," - A directory containing your own icons. This allows for offline access, and better performance than fetching from a CDN"]}),"\n",(0,r.jsxs)(n.li,{children:["Also within ",(0,r.jsx)(n.code,{children:"./public"})," you'll find standard website assets, including ",(0,r.jsx)(n.code,{children:"favicon.ico"}),", ",(0,r.jsx)(n.code,{children:"manifest.json"}),", ",(0,r.jsx)(n.code,{children:"robots.txt"}),", etc. There's no need to pass these in, but you can do so if you wish"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"/src/styles/user-defined-themes.scss"})," - A stylesheet for applying custom CSS to your app. You can also write your own themes here."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"running-commands",children:"Running Commands"}),"\n",(0,r.jsxs)(n.p,{children:["If you're running an app in Docker, then commands will need to be passed to the container to be executed. This can be done by preceding each command with ",(0,r.jsx)(n.code,{children:"docker exec -it [container-id]"}),", where container ID can be found by running ",(0,r.jsx)(n.code,{children:"docker ps"}),". For example ",(0,r.jsx)(n.code,{children:"docker exec -it 26c156c467b4 yarn build"}),". You can also enter the container, with ",(0,r.jsx)(n.code,{children:"docker exec -it [container-id] /bin/ash"}),", and navigate around it with normal Linux commands."]}),"\n",(0,r.jsxs)(n.p,{children:["Dashy has several commands that can be used for various tasks, you can find a list of these either in the ",(0,r.jsx)(n.a,{href:"/docs/developing#project-commands",children:"Developing Docs"}),", or by looking at the ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/package.json#l5",children:(0,r.jsx)(n.code,{children:"package.json"})}),". These can be used by running ",(0,r.jsx)(n.code,{children:"yarn [command-name]"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"healthchecks",children:"Healthchecks"}),"\n",(0,r.jsxs)(n.p,{children:["Healthchecks are configured to periodically check that Dashy is up and running correctly on the specified port. By default, the health script is called every 5 minutes, but this can be modified with the ",(0,r.jsx)(n.code,{children:"--health-interval"})," option. You can check the current container health with: ",(0,r.jsx)(n.code,{children:'docker inspect --format "{{json .State.Health }}" [container-id]'}),", and a summary of health status will show up under ",(0,r.jsx)(n.code,{children:"docker ps"}),". You can also manually request the current application status by running ",(0,r.jsx)(n.code,{children:"docker exec -it [container-id] yarn health-check"}),". You can disable healthchecks altogether by adding the ",(0,r.jsx)(n.code,{children:"--no-healthcheck"})," flag to your Docker run command."]}),"\n",(0,r.jsxs)(n.p,{children:["To restart unhealthy containers automatically, check out ",(0,r.jsx)(n.a,{href:"https://hub.docker.com/r/willfarrell/autoheal/",children:"Autoheal"}),". This image watches for unhealthy containers, and automatically triggers a restart. (This is a stand in for Docker's ",(0,r.jsx)(n.code,{children:"--exit-on-unhealthy"})," that was proposed, but ",(0,r.jsx)(n.a,{href:"https://github.com/moby/moby/pull/22719",children:"not merged"}),"). There's also ",(0,r.jsx)(n.a,{href:"https://github.com/qdm12/deunhealth",children:"Deunhealth"}),", which is super light-weight, and doesn't require network access."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run -d \\\n --name autoheal \\\n --restart=always \\\n -e AUTOHEAL_CONTAINER_LABEL=all \\\n -v /var/run/docker.sock:/var/run/docker.sock \\\n willfarrell/autoheal\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"logs-and-performance",children:"Logs and Performance"}),"\n",(0,r.jsx)(n.h3,{id:"container-logs",children:"Container Logs"}),"\n",(0,r.jsxs)(n.p,{children:["You can view logs for a given Docker container with ",(0,r.jsx)(n.code,{children:"docker logs [container-id]"}),", add the ",(0,r.jsx)(n.code,{children:"--follow"})," flag to stream the logs. For more info, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/config/containers/logging/",children:"Logging Documentation"}),". There's also ",(0,r.jsx)(n.a,{href:"https://dozzle.dev/",children:"Dozzle"}),", a useful tool, that provides a web interface where you can stream and query logs from all your running containers from a single web app."]}),"\n",(0,r.jsx)(n.h3,{id:"container-performance",children:"Container Performance"}),"\n",(0,r.jsxs)(n.p,{children:["You can check the resource usage for your running Docker containers with ",(0,r.jsx)(n.code,{children:"docker stats"})," or ",(0,r.jsx)(n.code,{children:"docker stats [container-id]"}),". For more info, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/stats/",children:"Stats Documentation"}),". There's also ",(0,r.jsx)(n.a,{href:"https://github.com/google/cadvisor",children:"cAdvisor"}),", a useful web app for viewing and analyzing resource usage and performance of all your running containers."]}),"\n",(0,r.jsx)(n.h3,{id:"management-apps",children:"Management Apps"}),"\n",(0,r.jsxs)(n.p,{children:["You can also view logs, resource usage and other info as well as manage your entire Docker workflow in third-party Docker management apps. For example ",(0,r.jsx)(n.a,{href:"https://github.com/portainer/portainer",children:"Portainer"})," an all-in-one open source management web UI for Docker and Kubernetes, or ",(0,r.jsx)(n.a,{href:"https://github.com/jesseduffield/lazydocker",children:"LazyDocker"})," a terminal UI for Docker container management and monitoring."]}),"\n",(0,r.jsx)(n.h3,{id:"advanced-logging-and-monitoring",children:"Advanced Logging and Monitoring"}),"\n",(0,r.jsxs)(n.p,{children:["Docker supports using ",(0,r.jsx)(n.a,{href:"https://prometheus.io/",children:"Prometheus"})," to collect logs, which can then be visualized using a platform like ",(0,r.jsx)(n.a,{href:"https://grafana.com/",children:"Grafana"}),". For more info, see ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/config/daemon/prometheus/",children:"this guide"}),". If you need to route your logs to a remote syslog, then consider using ",(0,r.jsx)(n.a,{href:"https://github.com/gliderlabs/logspout",children:"logspout"}),". For enterprise-grade instances, there are managed services, that make monitoring container logs and metrics very easy, such as ",(0,r.jsx)(n.a,{href:"https://sematext.com/blog/docker-container-monitoring-with-sematext/",children:"Sematext"})," with ",(0,r.jsx)(n.a,{href:"https://github.com/sematext/logagent-js",children:"Logagent"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"auto-starting-at-system-boot",children:"Auto-Starting at System Boot"}),"\n",(0,r.jsxs)(n.p,{children:["You can use Docker's ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/run/#restart-policies---restart",children:"restart policies"})," to instruct the container to start after a system reboot, or restart after a crash. Just add the ",(0,r.jsx)(n.code,{children:"--restart=always"})," flag to your Docker compose script or Docker run command. For more information, see the docs on ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/config/containers/start-containers-automatically/",children:"Starting Containers Automatically"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["For Podman, you can use ",(0,r.jsx)(n.code,{children:"systemd"})," to create a service that launches your container, ",(0,r.jsx)(n.a,{href:"https://podman.io/blogs/2018/09/13/systemd.html",children:"the docs"})," explains things further. A similar approach can be used with Docker, if you need to start containers after a reboot, but before any user interaction."]}),"\n",(0,r.jsxs)(n.p,{children:["To restart the container after something within it has crashed, consider using ",(0,r.jsx)(n.a,{href:"https://github.com/willfarrell/docker-autoheal",children:(0,r.jsx)(n.code,{children:"docker-autoheal"})})," by @willfarrell, a service that monitors and restarts unhealthy containers. For more info, see the ",(0,r.jsx)(n.a,{href:"#healthchecks",children:"Healthchecks"})," section above."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"updating",children:"Updating"}),"\n",(0,r.jsx)(n.p,{children:"Dashy is under active development, so to take advantage of the latest features, you may need to update your instance every now and again."}),"\n",(0,r.jsx)(n.h3,{id:"updating-docker-container",children:"Updating Docker Container"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["Pull latest image: ",(0,r.jsx)(n.code,{children:"docker pull lissy93/dashy:latest"})]}),"\n",(0,r.jsxs)(n.li,{children:["Kill off existing container\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Find container ID: ",(0,r.jsx)(n.code,{children:"docker ps"})]}),"\n",(0,r.jsxs)(n.li,{children:["Stop container: ",(0,r.jsx)(n.code,{children:"docker stop [container_id]"})]}),"\n",(0,r.jsxs)(n.li,{children:["Remove container: ",(0,r.jsx)(n.code,{children:"docker rm [container_id]"})]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["Spin up new container: ",(0,r.jsx)(n.code,{children:"docker run [params] lissy93/dashy"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"automatic-docker-updates",children:"Automatic Docker Updates"}),"\n",(0,r.jsxs)(n.p,{children:["You can automate the above process using ",(0,r.jsx)(n.a,{href:"https://github.com/containrrr/watchtower",children:"Watchtower"}),".\nWatchtower will watch for new versions of a given image on Docker Hub, pull down your new image, gracefully shut down your existing container and restart it with the same options that were used when it was deployed initially."]}),"\n",(0,r.jsx)(n.p,{children:"To get started, spin up the watchtower container:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run -d \\\n --name watchtower \\\n -v /var/run/docker.sock:/var/run/docker.sock \\\n containrrr/watchtower\n"})}),"\n",(0,r.jsxs)(n.p,{children:["For more information, see the ",(0,r.jsx)(n.a,{href:"https://containrrr.dev/watchtower/",children:"Watchtower Docs"})]}),"\n",(0,r.jsx)(n.h3,{id:"updating-dashy-from-source",children:"Updating Dashy from Source"}),"\n",(0,r.jsxs)(n.p,{children:["Stop your current instance of Dashy, then navigate into the source directory. Pull down the latest code, with ",(0,r.jsx)(n.code,{children:"git pull origin master"}),", then update dependencies with ",(0,r.jsx)(n.code,{children:"yarn"}),", rebuild with ",(0,r.jsx)(n.code,{children:"yarn build"}),", and start the server again with ",(0,r.jsx)(n.code,{children:"yarn start"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"backing-up",children:"Backing Up"}),"\n",(0,r.jsx)(n.h3,{id:"backing-up-containers",children:"Backing Up Containers"}),"\n",(0,r.jsxs)(n.p,{children:["You can make a backup of any running container really easily, using ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/commit/",children:(0,r.jsx)(n.code,{children:"docker commit"})})," and save it with ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/export/",children:(0,r.jsx)(n.code,{children:"docker export"})}),", to do so:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["First find the container ID, you can do this with ",(0,r.jsx)(n.code,{children:"docker container ls"})]}),"\n",(0,r.jsxs)(n.li,{children:["Now to create the snapshot, just run ",(0,r.jsx)(n.code,{children:"docker commit -p [container-id] my-backup"})]}),"\n",(0,r.jsxs)(n.li,{children:["Finally, to save the backup locally, run ",(0,r.jsx)(n.code,{children:"docker save -o ~/dashy-backup.tar my-backup"})]}),"\n",(0,r.jsxs)(n.li,{children:["If you want to push this to a container registry, run ",(0,r.jsx)(n.code,{children:"docker push my-backup:latest"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Note that this will not include any data in docker volumes, and the process here is a bit different. Since these files exist on your host system, if you have an existing backup solution implemented, you can incorporate and volume files within that system."}),"\n",(0,r.jsx)(n.h3,{id:"backing-up-volumes",children:"Backing Up Volumes"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://github.com/offen/docker-volume-backup",children:"offen/docker-volume-backup"})," is a useful tool for periodic Docker volume backups, to any S3-compatible storage provider. It's run as a light-weight Docker container, and is easy to setup, and also supports GPG-encryption, email notification, and routing away older backups."]}),"\n",(0,r.jsxs)(n.p,{children:["To get started, create a docker-compose similar to the example below, and then start the container. For more info, check out their ",(0,r.jsx)(n.a,{href:"https://github.com/offen/docker-volume-backup",children:"documentation"}),", which is very clear."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"version: '3'\nservices:\n backup:\n image: offen/docker-volume-backup:latest\n environment:\n BACKUP_CRON_EXPRESSION: \"0 * * * *\"\n BACKUP_PRUNING_PREFIX: backup-\n BACKUP_RETENTION_DAYS: 7\n AWS_BUCKET_NAME: backup-bucket\n AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE\n AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\n volumes:\n - data:/backup/my-app-backup:ro\n - /var/run/docker.sock:/var/run/docker.sock:ro\nvolumes:\n data:\n"})}),"\n",(0,r.jsx)(n.p,{children:"It's worth noting that this process can also be done manually, using the following commands:"}),"\n",(0,r.jsx)(n.p,{children:"Backup:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run --rm -v some_volume:/volume -v /tmp:/backup alpine tar -cjf /backup/some_archive.tar.bz2 -C /volume ./\n"})}),"\n",(0,r.jsx)(n.p,{children:"Restore:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:'docker run --rm -v some_volume:/volume -v /tmp:/backup alpine sh -c "rm -rf /volume/* /volume/..?* /volume/.[!.]* ; tar -C /volume/ -xjf /backup/some_archive.tar.bz2"\n'})}),"\n",(0,r.jsx)(n.h3,{id:"dashy-specific-backup",children:"Dashy-Specific Backup"}),"\n",(0,r.jsxs)(n.p,{children:["All configuration and dashboard settings are stored in your ",(0,r.jsx)(n.code,{children:"user-data/conf.yml"})," file. If you provide additional assets (like icons, fonts, themes, etc), these will also live in the ",(0,r.jsx)(n.code,{children:"user-data"})," directory. So to backup all Dashy data, this is the only directory you need to backup."]}),"\n",(0,r.jsx)(n.p,{children:"Since Dashy is open source, there shouldn't be any need to backup the main container."}),"\n",(0,r.jsxs)(n.p,{children:["Dashy also has a built-in cloud backup feature, which is free for personal users, and will let you make and restore fully encrypted backups of your config directly through the UI. To learn more, see the ",(0,r.jsx)(n.a,{href:"/docs/backup-restore",children:"Cloud Backup Docs"})]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"scheduling",children:"Scheduling"}),"\n",(0,r.jsxs)(n.p,{children:["If you need to periodically schedule the running of a given command on Dashy (or any other container), then a useful tool for doing so it ",(0,r.jsx)(n.a,{href:"https://github.com/mcuadros/ofelia",children:"ofelia"}),". This runs as a Docker container and is really useful for things like backups, logging, updating, notifications, etc. Crons are specified using Go's crontab format, and a useful tool for visualizing this is ",(0,r.jsx)(n.a,{href:"https://crontab.guru/",children:"crontab.guru"}),". This can also be done natively with Alpine: ",(0,r.jsx)(n.code,{children:"docker run -it alpine ls /etc/periodic"}),".\nI recommend combining this with ",(0,r.jsx)(n.a,{href:"https://github.com/healthchecks/healthchecks",children:"healthchecks"})," for easy monitoring of jobs, and failure notifications."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"ssl-certificates",children:"SSL Certificates"}),"\n",(0,r.jsx)(n.p,{children:"Enabling HTTPS with an SSL certificate is recommended, especially if you are hosting Dashy anywhere other than your home. This will ensure that all traffic is encrypted in transit."}),"\n",(0,r.jsx)(n.h3,{id:"auto-ssl",children:"Auto-SSL"}),"\n",(0,r.jsxs)(n.p,{children:["If you are using ",(0,r.jsx)(n.a,{href:"https://nginxproxymanager.com/",children:"NGINX Proxy Manager"}),', then SSL is supported out of the box. Once you\'ve added your proxy host and web address, then set the scheme to HTTPS, then under the SSL Tab select "Request a new SSL certificate" and follow the on-screen instructions.']}),"\n",(0,r.jsxs)(n.p,{children:["If you're hosting Dashy behind Cloudflare, then they offer ",(0,r.jsx)(n.a,{href:"https://www.cloudflare.com/en-gb/learning/ssl/what-is-an-ssl-certificate/",children:"free and easy SSL"}),"- all you need to do is enable it under the SSL/TLS tab. Or if you are using shared hosting, you may find ",(0,r.jsx)(n.a,{href:"https://www.sitepoint.com/a-guide-to-setting-up-lets-encrypt-ssl-on-shared-hosting/",children:"this tutorial"})," helpful."]}),"\n",(0,r.jsx)(n.h3,{id:"getting-a-self-signed-ssl-certificate",children:"Getting a Self-Signed SSL Certificate"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://letsencrypt.org/docs/",children:"Let's Encrypt"})," is a global Certificate Authority, providing free SSL/TLS Domain Validation certificates in order to enable secure HTTPS access to your website. They have good browser/ OS ",(0,r.jsx)(n.a,{href:"https://letsencrypt.org/docs/certificate-compatibility/",children:"compatibility"})," with their ISRG X1 and DST CA X3 root certificates, support ",(0,r.jsx)(n.a,{href:"https://community.letsencrypt.org/t/acme-v2-production-environment-wildcards/55578",children:"Wildcard issuance"})," done via ACMEv2 using the DNS-01 and have ",(0,r.jsx)(n.a,{href:"https://letsencrypt.org/2020/02/19/multi-perspective-validation.html",children:"Multi-Perspective Validation"}),". Let's Encrypt provide ",(0,r.jsx)(n.a,{href:"https://certbot.eff.org/",children:"CertBot"})," an easy app for generating and setting up an SSL certificate."]}),"\n",(0,r.jsxs)(n.p,{children:["This process can be automated, using something like the ",(0,r.jsx)(n.a,{href:"https://github.com/Valian/docker-nginx-auto-ssl",children:"Docker-NGINX-Auto-SSL Container"})," to generate and renew certificates when needed."]}),"\n",(0,r.jsxs)(n.p,{children:["If you're not so comfortable on the command line, then you can use a tool like ",(0,r.jsx)(n.a,{href:"https://www.sslforfree.com/",children:"SSL For Free"})," or ",(0,r.jsx)(n.a,{href:"https://zerossl.com/",children:"ZeroSSL"})," to generate your cert. They also provide step-by-step setup instructions for most platforms."]}),"\n",(0,r.jsx)(n.h3,{id:"passing-a-self-signed-certificate-to-dashy",children:"Passing a Self-Signed Certificate to Dashy"}),"\n",(0,r.jsxs)(n.p,{children:["Once you've generated your SSL cert, you'll need to pass it to Dashy. This can be done by specifying the paths to your public and private keys using the ",(0,r.jsx)(n.code,{children:"SSL_PRIV_KEY_PATH"})," and ",(0,r.jsx)(n.code,{children:"SSL_PUB_KEY_PATH"})," environmental variables. Or if you're using Docker, then just pass public + private SSL keys in under ",(0,r.jsx)(n.code,{children:"/etc/ssl/certs/dashy-pub.pem"})," and ",(0,r.jsx)(n.code,{children:"/etc/ssl/certs/dashy-priv.key"})," respectively, e.g:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run -d \\\n -p 8080:8080 \\\n -v ~/my-private-key.key:/etc/ssl/certs/dashy-priv.key:ro \\\n -v ~/my-public-key.pem:/etc/ssl/certs/dashy-pub.pem:ro \\\n lissy93/dashy:latest\n"})}),"\n",(0,r.jsxs)(n.p,{children:["By default the SSL port is ",(0,r.jsx)(n.code,{children:"443"})," within a Docker container, or ",(0,r.jsx)(n.code,{children:"4001"})," if running on bare metal, but you can override this with the ",(0,r.jsx)(n.code,{children:"SSL_PORT"})," environmental variable."]}),"\n",(0,r.jsxs)(n.p,{children:["Once everything is setup, you can verify your site is secured using a tool like ",(0,r.jsx)(n.a,{href:"https://www.sslchecker.com/sslchecker",children:"SSL Checker"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"authentication",children:"Authentication"}),"\n",(0,r.jsxs)(n.p,{children:["Dashy natively supports secure authentication using KeyCloak. There is also a Simple Auth feature that doesn't require any additional setup. Usage instructions for both, as well as alternative auth methods, has now moved to the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/authentication",children:"Authentication Docs"})})," page."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"managing-containers-with-docker-compose",children:"Managing Containers with Docker Compose"}),"\n",(0,r.jsxs)(n.p,{children:["When you have a lot of containers, it quickly becomes hard to manage with ",(0,r.jsx)(n.code,{children:"docker run"})," commands. The solution to this is ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/compose/",children:"docker compose"}),", a handy tool for defining all a containers run settings in a single YAML file, and then spinning up that container with a single short command - ",(0,r.jsx)(n.code,{children:"docker compose up"}),". A good example of which can be seen in ",(0,r.jsx)(n.a,{href:"https://github.com/abhilesh/self-hosted_docker_setups",children:"@abhilesh's docker compose collection"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["You can use Dashy's default ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/docker-compose.yml",children:(0,r.jsx)(n.code,{children:"docker-compose.yml"})})," file as a template, and modify it according to your needs."]}),"\n",(0,r.jsx)(n.p,{children:"An example Docker compose, using the default base image from DockerHub, might look something like this:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"---\nversion: \"3.8\"\nservices:\n dashy:\n container_name: Dashy\n image: lissy93/dashy\n volumes:\n - /root/my-config.yml:/app/user-data/conf.yml\n ports:\n - 4000:8080\n environment:\n - BASE_URL=/my-dashboard\n restart: unless-stopped\n healthcheck:\n test: ['CMD', 'node', '/app/services/healthcheck']\n interval: 1m30s\n timeout: 10s\n retries: 3\n start_period: 40s\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"passing-in-environmental-variables",children:"Passing in Environmental Variables"}),"\n",(0,r.jsxs)(n.p,{children:["With Docker, you can define environmental variables under the ",(0,r.jsx)(n.code,{children:"environment"})," section of your Docker compose file. Environmental variables are used to configure high-level settings, usually before the config file has been read. For a list of all supported env vars in Dashy, see ",(0,r.jsx)(n.a,{href:"/docs/developing#environmental-variables",children:"the developing docs"}),", or the default ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/.env",children:(0,r.jsx)(n.code,{children:".env"})})," file."]}),"\n",(0,r.jsxs)(n.p,{children:["A common use case, is to run Dashy under a sub-page, instead of at the root of a URL (e.g. ",(0,r.jsx)(n.code,{children:"https://my-homelab.local/dashy"})," instead of ",(0,r.jsx)(n.code,{children:"https://dashy.my-homelab.local"}),"). In this use-case, you'd specify the ",(0,r.jsx)(n.code,{children:"BASE_URL"})," variable in your compose file."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"environment:\n - BASE_URL=/dashy\n"})}),"\n",(0,r.jsxs)(n.p,{children:["You can also do the same thing with the docker run command, using the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file",children:(0,r.jsx)(n.code,{children:"--env"})})," flag.\nIf you've got many environmental variables, you might find it useful to put them in a ",(0,r.jsxs)(n.a,{href:"https://docs.docker.com/compose/env-file/",children:[(0,r.jsx)(n.code,{children:".env"})," file"]}),". Similarly, for Docker run you can use ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file",children:(0,r.jsx)(n.code,{children:"--env-file"})})," if you'd like to pass in a file containing all your environmental variables."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"setting-headers",children:"Setting Headers"}),"\n",(0,r.jsxs)(n.p,{children:["Any external requests made to a different origin (app/ service under a different domain) will be blocked if the correct headers are not specified. This is known as ",(0,r.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"Cross-Origin Resource Sharing"})," (CORS) and is a security feature built into modern browsers."]}),"\n",(0,r.jsx)(n.p,{children:"If you see a CORS error in your console, this can be easily fixed by setting the correct headers. This is not a bug with Dashy, so please don't raise it as a bug!"}),"\n",(0,r.jsx)(n.h3,{id:"example-headers",children:"Example Headers"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#caddy",children:"Caddy"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nginx",children:"NGINX"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#traefik",children:"Tr\xe6f\u026ak"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#haproxy",children:"HAProxy"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#apache",children:"Apache"})}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.em,{children:["The following section briefly outlines how you can set headers for common web proxies/ servers. More info can be found in the documentation for the proxy that you are using, or in the ",(0,r.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"MDN Docs"}),"."]})}),"\n",(0,r.jsx)(n.p,{children:"These examples are using:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"Access-Control-Allow-Origin"})," header, but depending on what type of content you are enabling, this will vary. For example, to allow a site to be loaded in an iframe (for the modal or workspace views) you would use ",(0,r.jsx)(n.code,{children:"X-Frame-Options"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:["The domain root (",(0,r.jsx)(n.code,{children:"/"}),"), if your're hosting from a sub-page, replace that with your path."]}),"\n",(0,r.jsxs)(n.li,{children:["A wildcard (",(0,r.jsx)(n.code,{children:"*"}),"), which would allow access from traffic on any domain, this is discouraged, and you should replace it with the URL where you are hosting Dashy. Note that for requests that transport sensitive info, like credentials (e.g. Keycloak login), the wildcard is ",(0,r.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#requests_with_credentials",children:"disallowed all together"})," and will be blocked."]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"caddy",children:"Caddy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsxs)(n.a,{href:"https://caddyserver.com/docs/caddyfile/directives/header",children:["Caddy ",(0,r.jsx)(n.code,{children:"header"})," docs"]})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"headers / {\n Access-Control-Allow-Origin *\n}\n"})}),"\n",(0,r.jsx)(n.h4,{id:"nginx",children:"NGINX"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsxs)(n.a,{href:"https://nginx.org/en/docs/http/ngx_http_headers_module.html",children:["NGINX ",(0,r.jsx)(n.code,{children:"ngx_http_headers_module"})," docs"]})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"location / {\n add_header Access-Control-Allow-Origin *;\n}\n"})}),"\n",(0,r.jsx)(n.p,{children:"Note this can also be done through the UI, using NGINX Proxy Manager."}),"\n",(0,r.jsx)(n.h4,{id:"traefik",children:"Traefik"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsx)(n.a,{href:"https://doc.traefik.io/traefik/middlewares/http/headers/#cors-headers",children:"Tr\xe6f\u026ak CORS headers docs"})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:'labels:\n - "traefik.http.middlewares.testheader.headers.accesscontrolallowmethods=GET,OPTIONS,PUT"\n - "traefik.http.middlewares.testheader.headers.accesscontrolalloworiginlist=https://foo.bar.org,https://example.org"\n - "traefik.http.middlewares.testheader.headers.accesscontrolmaxage=100"\n - "traefik.http.middlewares.testheader.headers.addvaryheader=true"\n'})}),"\n",(0,r.jsx)(n.h4,{id:"haproxy",children:"HAProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.haproxy.com/documentation/hapee/latest/traffic-routing/rewrites/rewrite-responses/",children:"HAProxy Rewrite Response Docs"})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"/\n http-response add-header Access-Control-Allow-Origin *\n"})}),"\n",(0,r.jsx)(n.h4,{id:"apache",children:"Apache"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsxs)(n.a,{href:"https://httpd.apache.org/docs/current/mod/mod_headers.html",children:["Apache ",(0,r.jsx)(n.code,{children:"mode_headers"})," docs"]})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:'Header always set Access-Control-Allow-Origin "*"\n'})}),"\n",(0,r.jsx)(n.h4,{id:"squid",children:"Squid"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsxs)(n.a,{href:"http://www2.gr.squid-cache.org/Doc/config/request_header_access/",children:["Squid ",(0,r.jsx)(n.code,{children:"request_header_access"})," docs"]})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"request_header_access Authorization allow all\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"remote-access",children:"Remote Access"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#wireguard",children:"WireGuard"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#reverse-ssh-tunnel",children:"Reverse SSH Tunnel"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#tcp-tunnel",children:"TCP Tunnel"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"wireguard",children:"WireGuard"}),"\n",(0,r.jsxs)(n.p,{children:["Using a VPN is one of the easiest ways to provide secure, full access to your local network from remote locations. ",(0,r.jsx)(n.a,{href:"https://www.wireguard.com/",children:"WireGuard"})," is a reasonably new open source VPN protocol, that was designed with ease of use, performance and security in mind. Unlike OpenVPN, it doesn't need to recreate the tunnel whenever connection is dropped, and it's also much easier to setup, using shared keys instead."]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Install Wireguard"})," - See the ",(0,r.jsx)(n.a,{href:"https://www.wireguard.com/install/",children:"Install Docs"})," for download links + instructions\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["On Debian-based systems, it's ",(0,r.jsx)(n.code,{children:"sudo apt install wireguard"})]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Generate a Private Key"})," - Run ",(0,r.jsx)(n.code,{children:"wg genkey"})," on the Wireguard server, and copy it to somewhere safe for later"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Create Server Config"})," - Open or create a file at ",(0,r.jsx)(n.code,{children:"/etc/wireguard/wg0.conf"})," and under ",(0,r.jsx)(n.code,{children:"[Interface]"})," add the following (see example below):\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"Address"})," - as a subnet of all desired IPs"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"PrivateKey"})," - that you just generated"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"ListenPort"})," - Default is ",(0,r.jsx)(n.code,{children:"51820"}),", but can be anything"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Get Client App"})," - Download the ",(0,r.jsx)(n.a,{href:"https://www.wireguard.com/install/",children:"WG client app"})," for your platform (Linux, Windows, MacOS, Android or iOS are all supported)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Create new Client Tunnel"})," - On your client app, there should be an option to create a new tunnel, when doing so a client private key will be generated (but if not, use the ",(0,r.jsx)(n.code,{children:"wg genkey"})," command again), and keep it somewhere safe. A public key will also be generated, and this will go in our saver config"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Add Clients to Server Config"})," - Head back to your ",(0,r.jsx)(n.code,{children:"wg0.conf"})," file on the server, create a ",(0,r.jsx)(n.code,{children:"[Peer]"})," section, and populate the following info\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"AllowedIPs"})," - List of IP address inside the subnet, the client should have access to"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"PublicKey"})," - The public key for the client you just generated"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Start the Server"})," - You can now start the WG server, using: ",(0,r.jsx)(n.code,{children:"wg-quick up wg0"})," on your server"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Finish Client Setup"})," - Head back to your client device, and edit the config file, leave the private key as is, and add the following fields:\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"PublicKey"})," - The public key of the server"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"Address"})," - This should match the ",(0,r.jsx)(n.code,{children:"AllowedIPs"})," section on the servers config file"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"DNS"})," - The DNS server that'll be used when accessing the network through the VPN"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"Endpoint"})," - The hostname or IP + Port where your WG server is running (you may need to forward this in your firewall's settings)"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Done"})," - Your clients should now be able to connect to your WG server :) Depending on your networks firewall rules, you may need to port forward the address of your WG server"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"example-server-config",children:(0,r.jsx)(n.strong,{children:"Example Server Config"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ini",children:"# Server file\n[Interface]\n# Which networks does my interface belong to? Notice: /24 and /64\nAddress = 10.5.0.1/24, 2001:470:xxxx:xxxx::1/64\nPrivateKey = xxx\nListenPort = 51820\n\n# Peer 1\n[Peer]\nPublicKey = xxx\n# Which source IPs can I expect from that peer? Notice: /32 and /128\nAllowedIps = 10.5.0.35/32, 2001:470:xxxx:xxxx::746f:786f/128\n\n# Peer 2\n[Peer]\nPublicKey = xxx\n# Which source IPs can I expect from that peer? This one has a LAN which can\n# access hosts/jails without NAT.\n# Peer 2 has a single IP address inside the VPN: it's 10.5.0.25/32\nAllowedIps = 10.5.0.25/32,10.21.10.0/24,10.21.20.0/24,10.21.30.0/24,10.31.0.0/24,2001:470:xxxx:xxxx::ca:571e/128\n"})}),"\n",(0,r.jsx)(n.h4,{id:"example-client-config",children:(0,r.jsx)(n.strong,{children:"Example Client Config"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ini",children:"[Interface]\n# Which networks does my interface belong to? Notice: /24 and /64\nAddress = 10.5.0.35/24, 2001:470:xxxx:xxxx::746f:786f/64\nPrivateKey = xxx\n\n# Server\n[Peer]\nPublicKey = xxx\n# I want to route everything through the server, both IPv4 and IPv6. All IPs are\n# thus available through the Server, and I can expect packets from any IP to\n# come from that peer.\nAllowedIPs = 0.0.0.0/0, ::0/0\n# Where is the server on the internet? This is a public address. The port\n# (:51820) is the same as ListenPort in the [Interface] of the Server file above\nEndpoint = 1.2.3.4:51820\n# Usually, clients are behind NAT. to keep the connection running, keep alive.\nPersistentKeepalive = 15\n"})}),"\n",(0,r.jsxs)(n.p,{children:["A useful tool for getting WG setup is ",(0,r.jsx)(n.a,{href:"https://github.com/trailofbits/algo",children:"Algo"}),". It includes scripts and docs which cover almost all devices, platforms and clients, and has best practices implemented, and security features enabled. All of this is better explained in ",(0,r.jsx)(n.a,{href:"https://blog.trailofbits.com/2016/12/12/meet-algo-the-vpn-that-works/",children:"this blog post"}),"."]}),"\n",(0,r.jsx)(n.h3,{id:"reverse-ssh-tunnel",children:"Reverse SSH Tunnel"}),"\n",(0,r.jsxs)(n.p,{children:["SSH (or ",(0,r.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Secure_Shell",children:"Secure Shell"}),") is a secure tunnel that allows you to connect to a remote host. Unlike the VPN methods, an SSH connection does not require an intermediary, and will not be affected by your IP changing. However it only allows you to access a single service at a time. SSH was really designed for terminal access, but because of the latter mentioned benefits it's useful to setup, as a fallback option."]}),"\n",(0,r.jsx)(n.p,{children:"Directly SSH'ing into your home, would require you to open a port (usually 22), which would be terrible for security, and is not recommended. However a reverse SSH connection is initiated from inside your network. Once the connection is established, the port is redirected, allowing you to use the established connection to SSH into your home network."}),"\n",(0,r.jsxs)(n.p,{children:["The issue you've probably spotted, is that most public, corporate, and institutional networks will block SSH connections. To overcome this, you'd have to establish a server outside of your homelab that your homelab's device could SSH into to establish the reverse SSH connection. You can then connect to that remote server (the ",(0,r.jsx)(n.em,{children:"mothership"}),"), which in turn connects to your home network."]}),"\n",(0,r.jsxs)(n.p,{children:["Now all of this is starting to sound like quite a lot of work, but this is where services like ",(0,r.jsx)(n.a,{href:"https://remote.it/",children:"remot3.it"})," come in. They maintain the intermediary mothership server, and create the tunnel service for you. It's free for personal use, secure and easy. There are several similar services, such as ",(0,r.jsx)(n.a,{href:"https://remoteiot.com/",children:"RemoteIoT"}),", or you could create your own on a cloud VPS (see ",(0,r.jsx)(n.a,{href:"https://gist.github.com/nileshtrivedi/4c615e8d3c1bf053b0d31176b9e69e42",children:"this tutorial"})," for more info on that)."]}),"\n",(0,r.jsxs)(n.p,{children:["Before getting started, you'll need to head over to ",(0,r.jsx)(n.a,{href:"https://app.remote.it/auth/#/sign-up",children:"Remote.it"})," and create an account."]}),"\n",(0,r.jsx)(n.p,{children:"Then setup your local device:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["If you haven't already done so, you'll need to enable and configure SSH.\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["This is out-of-scope of this article, but I've explained it in detail in ",(0,r.jsx)(n.a,{href:"https://notes.aliciasykes.com/22798/my-server-setup#configure-ssh",children:"this post"}),"."]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["Download the Remote.it install script from their ",(0,r.jsx)(n.a,{href:"https://github.com/remoteit/installer",children:"GitHub"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"curl -LkO https://raw.githubusercontent.com/remoteit/installer/master/scripts/auto-install.sh"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["Make it executable, with ",(0,r.jsx)(n.code,{children:"chmod +x ./auto-install.sh"}),", and then run it with ",(0,r.jsx)(n.code,{children:"sudo ./auto-install.sh"})]}),"\n",(0,r.jsxs)(n.li,{children:["Finally, configure your device, by running ",(0,r.jsx)(n.code,{children:"sudo connectd_installer"})," and following the on-screen instructions"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"And when you're ready to connect to it:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["Login to ",(0,r.jsx)(n.a,{href:"https://app.remote.it/",children:"app.remote.it"}),", and select the name of your device"]}),"\n",(0,r.jsx)(n.li,{children:"You should see a list of running services, click SSH"}),"\n",(0,r.jsx)(n.li,{children:"You'll then be presented with some SSH credentials that you can now use to securely connect to your home, via the Remote.it servers"}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Done :)"}),"\n",(0,r.jsx)(n.h3,{id:"tcp-tunnel",children:"TCP Tunnel"}),"\n",(0,r.jsxs)(n.p,{children:["If you're running Dashy on your local network, behind a firewall, but need to temporarily share it with someone external, this can be achieved quickly and securely using ",(0,r.jsx)(n.a,{href:"https://ngrok.com/",children:"Ngrok"}),". It's basically a super slick, encrypted TCP tunnel that provides an internet-accessible address that anyone use to access your local service, from anywhere."]}),"\n",(0,r.jsxs)(n.p,{children:["To get started, ",(0,r.jsx)(n.a,{href:"https://ngrok.com/download",children:"Download"})," and install Ngrok for your system, then just run ",(0,r.jsx)(n.code,{children:"ngrok http [port]"})," (replace the port with the http port where Dashy is running, e.g. 8080). When ",(0,r.jsx)(n.a,{href:"https://ngrok.com/docs#http-local-https",children:"using https"}),", specify the full local url/ ip including the protocol."]}),"\n",(0,r.jsxs)(n.p,{children:["Some Ngrok features require you to be authenticated, you can ",(0,r.jsx)(n.a,{href:"https://dashboard.ngrok.com/signup",children:"create a free account"})," and generate a token in ",(0,r.jsx)(n.a,{href:"https://dashboard.ngrok.com/auth/your-authtoken",children:"your dashboard"}),", then run ",(0,r.jsx)(n.code,{children:"ngrok authtoken [token]"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["It's recommended to use authentication for any publicly accessible service. Dashy has an ",(0,r.jsx)(n.a,{href:"/docs/authentication",children:"Auth"})," feature built in, but an even easier method it to use the ",(0,r.jsx)(n.a,{href:"https://ngrok.com/docs#http-auth",children:(0,r.jsx)(n.code,{children:"-auth"})})," switch. E.g. ",(0,r.jsx)(n.code,{children:'ngrok http -auth="username:password123" 8080'})]}),"\n",(0,r.jsxs)(n.p,{children:["By default, your web app is assigned a randomly generated ngrok domain, but you can also use your own custom domain. Under the ",(0,r.jsx)(n.a,{href:"https://dashboard.ngrok.com/endpoints/domains",children:"Domains Tab"})," of your Ngrok dashboard, add your domain, and follow the CNAME instructions. You can now use your domain, with the ",(0,r.jsx)(n.a,{href:"https://ngrok.com/docs#http-custom-domains",children:(0,r.jsx)(n.code,{children:"-hostname"})})," switch, e.g. ",(0,r.jsx)(n.code,{children:"ngrok http -region=us -hostname=dashy.example.com 8080"}),". If you don't have your own domain name, you can instead use a custom sub-domain (e.g. ",(0,r.jsx)(n.code,{children:"alicia-dashy.ngrok.io"}),"), using the ",(0,r.jsx)(n.a,{href:"https://ngrok.com/docs#custom-subdomain-names",children:(0,r.jsx)(n.code,{children:"-subdomain"})})," switch."]}),"\n",(0,r.jsxs)(n.p,{children:["To integrate this into your docker-compose, take a look at the ",(0,r.jsx)(n.a,{href:"https://github.com/gtriggiano/ngrok-tunnel",children:"gtriggiano/ngrok-tunnel"})," container."]}),"\n",(0,r.jsxs)(n.p,{children:["There's so much more you can do with Ngrok, such as exposing a directory as a file browser, using websockets, relaying requests, rewriting headers, inspecting traffic, TLS and TCP tunnels and lots more. All or which is explained in ",(0,r.jsx)(n.a,{href:"https://ngrok.com/docs",children:"the Documentation"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["It's worth noting that Ngrok isn't the only option here, other options include: ",(0,r.jsx)(n.a,{href:"https://github.com/fatedier/frp",children:"FRP"}),", ",(0,r.jsx)(n.a,{href:"https://inlets.dev",children:"Inlets"}),", ",(0,r.jsx)(n.a,{href:"https://localtunnel.me/",children:"Local Tunnel"}),", ",(0,r.jsx)(n.a,{href:"https://tailscale.com/",children:"TailScale"}),", etc. Check out ",(0,r.jsx)(n.a,{href:"https://github.com/anderspitman/awesome-tunneling",children:"Awesome Tunneling"})," for a list of alternatives."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"custom-domain",children:"Custom Domain"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#using-nginx",children:"Using DNS"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#using-dns",children:"Using NGINX"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"using-dns",children:"Using DNS"}),"\n",(0,r.jsxs)(n.p,{children:["For locally running services, a domain can be set up directly in the DNS records. This method is really quick and easy, and doesn't require you to purchase an actual domain. Just update your networks DNS resolver, to point your desired URL to the local IP where Dashy (or any other app) is running. For example, a line in your hosts file might look something like: ",(0,r.jsx)(n.code,{children:"192.168.0.2 dashy.homelab.local"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["If you're using Pi-Hole, a similar thing can be done in the ",(0,r.jsx)(n.code,{children:"/etc/dnsmasq.d/03-custom-dns.conf"})," file, add a line like: ",(0,r.jsx)(n.code,{children:"address=/dashy.example.com/192.168.2.0"})," for each of your services."]}),"\n",(0,r.jsxs)(n.p,{children:["If you're running OPNSense/ PfSense, then this can be done through the UI with Unbound, it's explained nicely in ",(0,r.jsx)(n.a,{href:"https://homenetworkguy.com/how-to/use-custom-domain-name-in-internal-network/",children:"this article"}),", by Dustin Casto."]}),"\n",(0,r.jsx)(n.h3,{id:"using-nginx",children:"Using NGINX"}),"\n",(0,r.jsx)(n.p,{children:"If you're using NGINX, then you can use your own domain name, with a config similar to the below example."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"upstream dashy {\n server 127.0.0.1:32400;\n}\n\nserver {\n listen 8080;\n server_name dashy.mydomain.com;\n\n # Setup SSL\n ssl_certificate /var/www/mydomain/sslcert.pem;\n ssl_certificate_key /var/www/mydomain/sslkey.pem;\n ssl_protocols TLSv1 TLSv1.1 TLSv1.2;\n ssl_ciphers 'EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH';\n ssl_session_timeout 5m;\n ssl_prefer_server_ciphers on;\n\n location / {\n proxy_pass http://dashy;\n proxy_redirect off;\n proxy_buffering off;\n proxy_set_header host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504;\n }\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Similarly, a basic ",(0,r.jsx)(n.code,{children:"Caddyfile"})," might look like:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"dashy.example.com {\n reverse_proxy / nginx:8080\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["For more info, ",(0,r.jsx)(n.a,{href:"https://thehomelab.wiki/books/dns-reverse-proxy/page/create-domain-records-to-point-to-your-home-server-on-cloudflare-using-nginx-progy-manager",children:"this guide"})," on Setting up Domains with NGINX Proxy Manager and CloudFlare may be useful."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"container-security",children:"Container Security"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#keep-docker-up-to-date",children:"Keep Docker Up-To-Date"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#set-resource-quotas",children:"Set Resource Quotas"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#dont-run-as-root",children:"Don't Run as Root"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#specify-a-user",children:"Specify a User"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#limit-capabilities",children:"Limit Capabilities"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#prevent-new-privileges-being-added",children:"Prevent new Privileges being Added"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#disable-inter-container-communication",children:"Disable Inter-Container Communication"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#dont-expose-the-docker-daemon-socket",children:"Don't Expose the Docker Daemon Socket"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#use-read-only-volumes",children:"Use Read-Only Volumes"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#set-the-logging-level",children:"Set the Logging Level"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#verify-image-before-pulling",children:"Verify Image before Pulling"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#specify-the-tag",children:"Specify the Tag"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#container-security-scanning",children:"Container Security Scanning"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#registry-security",children:"Registry Security"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#security-modules",children:"Security Modules"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"keep-docker-up-to-date",children:"Keep Docker Up-To-Date"}),"\n",(0,r.jsxs)(n.p,{children:["To prevent known container escape vulnerabilities, which typically end in escalating to root/administrator privileges, patching Docker Engine and Docker Machine is crucial. For more info, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/install/",children:"Docker Installation Docs"}),"."]}),"\n",(0,r.jsx)(n.h3,{id:"set-resource-quotas",children:"Set Resource Quotas"}),"\n",(0,r.jsxs)(n.p,{children:["Docker enables you to limit resource consumption (CPU, memory, disk) on a per-container basis. This not only enhances system performance, but also prevents a compromised container from consuming a large amount of resources, in order to disrupt service or perform malicious activities. To learn more, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/config/containers/resource_constraints/",children:"Resource Constraints Docs"})]}),"\n",(0,r.jsxs)(n.p,{children:["For example, to run Dashy with max of 1GB ram, and max of 50% of 1 CP core:\n",(0,r.jsx)(n.code,{children:'docker run -d -p 8080:8080 --cpus=".5" --memory="1024m" lissy93/dashy:latest'})]}),"\n",(0,r.jsx)(n.h3,{id:"dont-run-as-root",children:"Don't Run as Root"}),"\n",(0,r.jsx)(n.p,{children:"Running a container with admin privileges gives it more power than it needs, and can be abused. Dashy does not need any root privileges, and Docker by default doesn't run containers as root, so providing you don't specifically type sudo, you should be all good here."}),"\n",(0,r.jsxs)(n.p,{children:["Note that if you're facing permission issues on Debian-based systems, you may need to add your user to the Docker group. First create the group: ",(0,r.jsx)(n.code,{children:"sudo groupadd docker"}),", then add your (non-root) user: ",(0,r.jsx)(n.code,{children:"sudo usermod \u2212aG docker [my-username]"}),", finally ",(0,r.jsx)(n.code,{children:"newgrp docker"})," to refresh."]}),"\n",(0,r.jsx)(n.h3,{id:"specify-a-user",children:"Specify a User"}),"\n",(0,r.jsx)(n.p,{children:"One of the best ways to prevent privilege escalation attacks, is to configure the container to use an unprivileged user. This also means that any files created by the container and mounted, will be owned by the specified user (and not root), which makes things much easier."}),"\n",(0,r.jsxs)(n.p,{children:["You can specify a user, using the ",(0,r.jsxs)(n.a,{href:"https://docs.docker.com/engine/reference/run/#user",children:[(0,r.jsx)(n.code,{children:"--user"})," param"]}),", and should include the user ID (",(0,r.jsx)(n.code,{children:"UID"}),"), which can be found by running ",(0,r.jsx)(n.code,{children:"id -u"}),", and the and the group ID (",(0,r.jsx)(n.code,{children:"GID"}),"), using ",(0,r.jsx)(n.code,{children:"id -g"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["With Docker run, you specify it like:\n",(0,r.jsx)(n.code,{children:"docker run --user 1000:1000 -p 8080:8080 lissy93/dashy"})]}),"\n",(0,r.jsx)(n.p,{children:"Of if you're using Docker-compose, you could use an environmental variable"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'version: "3.8"\nservices:\n dashy:\n image: lissy93/dashy\n user: ${CURRENT_UID}\n ports: [ 4000:8080 ]\n'})}),"\n",(0,r.jsxs)(n.p,{children:["And then to set the variable, and start the container, run: ",(0,r.jsx)(n.code,{children:"CURRENT_UID=$(id -u):$(id -g) docker-compose up"})]}),"\n",(0,r.jsx)(n.h3,{id:"limit-capabilities",children:"Limit capabilities"}),"\n",(0,r.jsxs)(n.p,{children:["Docker containers run with a subset of ",(0,r.jsx)(n.a,{href:"https://man7.org/linux/man-pages/man7/capabilities.7.html",children:"Linux Kernal's Capabilities"})," by default. It's good practice to drop privilege permissions that are not needed for any given container."]}),"\n",(0,r.jsxs)(n.p,{children:["With Docker run, you can use the ",(0,r.jsx)(n.code,{children:"--cap-drop"})," flag to remove capabilities, you can also use ",(0,r.jsx)(n.code,{children:"--cap-drop=all"})," and then define just the required permissions using the ",(0,r.jsx)(n.code,{children:"--cap-add"})," option. For a list of available capabilities, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities",children:"Privilege Capabilities Docs"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Note that dropping privileges and capabilities on runtime is not fool-proof, and often any leftover privileges can be used to re-escalate, see ",(0,r.jsx)(n.a,{href:"https://wiki.sei.cmu.edu/confluence/display/c/POS36-C.+Observe+correct+revocation+order+while+relinquishing+privileges",children:"POS36-C"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"Here's an example using docker-compose, removing privileges that are not required for Dashy to run:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'version: "3.8"\nservices:\n dashy:\n image: lissy93/dashy\n ports: [ 4000:8080 ]\n cap_drop:\n - ALL\n cap_add:\n - CHOWN\n - SETGID\n - SETUID\n - DAC_OVERRIDE\n - NET_BIND_SERVICE\n'})}),"\n",(0,r.jsx)(n.h3,{id:"prevent-new-privileges-being-added",children:"Prevent new Privileges being Added"}),"\n",(0,r.jsxs)(n.p,{children:["To prevent processes inside the container from getting additional privileges, pass in the ",(0,r.jsx)(n.code,{children:"--security-opt=no-new-privileges:true"})," option to the Docker run command (see ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/run/#security-configuration",children:"docs"}),")."]}),"\n",(0,r.jsxs)(n.p,{children:["Run Command:\n",(0,r.jsx)(n.code,{children:"docker run --security-opt=no-new-privileges:true -p 8080:8080 lissy93/dashy"})]}),"\n",(0,r.jsx)(n.p,{children:"Docker Compose"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"security_opt:\n- no-new-privileges:true\n"})}),"\n",(0,r.jsx)(n.h3,{id:"disable-inter-container-communication",children:"Disable Inter-Container Communication"}),"\n",(0,r.jsxs)(n.p,{children:["By default Docker containers can talk to each other (using ",(0,r.jsxs)(n.a,{href:"https://docs.docker.com/config/containers/container-networking/",children:[(0,r.jsx)(n.code,{children:"docker0"})," bridged network"]}),"). If you don't need this capability, then it should be disabled. This can be done with the ",(0,r.jsx)(n.code,{children:"--icc=false"})," in your run command. You can learn more about how to facilitate secure communication between containers in the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/compose/networking/",children:"Compose Networking docs"}),"."]}),"\n",(0,r.jsx)(n.h3,{id:"dont-expose-the-docker-daemon-socket",children:"Don't Expose the Docker Daemon Socket"}),"\n",(0,r.jsxs)(n.p,{children:["Docker socket ",(0,r.jsx)(n.code,{children:"/var/run/docker.sock"})," is the UNIX socket that Docker is listening to. This is the primary entry point for the Docker API. The owner of this socket is root. Giving someone access to it is equivalent to giving unrestricted root access to your host."]}),"\n",(0,r.jsxs)(n.p,{children:["You should ",(0,r.jsx)(n.strong,{children:"not"})," enable TCP Docker daemon socket (",(0,r.jsx)(n.code,{children:"-H tcp://0.0.0.0:XXX"}),"), as doing so exposes un-encrypted and unauthenticated direct access to the Docker daemon, and if the host is connected to the internet, the daemon on your computer can be used by anyone from the public internet- which is bad. If you need TCP, you should ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-socket-option",children:"see the docs"})," to understand how to do this more securely.\nSimilarly, never expose ",(0,r.jsx)(n.code,{children:"/var/run/docker.sock"})," to other containers as a volume, as it can be exploited."]}),"\n",(0,r.jsx)(n.h3,{id:"use-read-only-volumes",children:"Use Read-Only Volumes"}),"\n",(0,r.jsxs)(n.p,{children:["You can specify that a specific volume should be read-only by appending ",(0,r.jsx)(n.code,{children:":ro"})," to the ",(0,r.jsx)(n.code,{children:"-v"})," switch. For example, while running Dashy, if we want our config to be writable, but keep all other assets protected, we would do:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run -d \\\n -p 8080:8080 \\\n -v ~/dashy-conf.yml:/app/user-data/conf.yml \\\n -v ~/dashy-icons:/app/public/item-icons:ro \\\n -v ~/dashy-theme.scss:/app/src/styles/user-defined-themes.scss:ro \\\n lissy93/dashy:latest\n"})}),"\n",(0,r.jsxs)(n.p,{children:["You can also prevent a container from writing any changes to volumes on your host's disk, using the ",(0,r.jsx)(n.code,{children:"--read-only"})," flag. Although, for Dashy, you will not be able to write config changes to disk, when edited through the UI with this method. You could make this work, by specifying the config directory as a temp write location, with ",(0,r.jsx)(n.code,{children:"--tmpfs /app/user-data/conf.yml"})," - but that this will not write the volume back to your host."]}),"\n",(0,r.jsx)(n.h3,{id:"set-the-logging-level",children:"Set the Logging Level"}),"\n",(0,r.jsxs)(n.p,{children:["Logging is important, as it enables you to review events in the future, and in the case of a compromise this will let get an idea of what may have happened. The default log level is ",(0,r.jsx)(n.code,{children:"INFO"}),", and this is also the recommendation, use ",(0,r.jsx)(n.code,{children:"--log-level info"})," to ensure this is set."]}),"\n",(0,r.jsx)(n.h3,{id:"verify-image-before-pulling",children:"Verify Image before Pulling"}),"\n",(0,r.jsx)(n.p,{children:"Only use trusted images, from verified/ official sources. If an app is open source, it is more likely to be safe, as anyone can verify the code. There are also tools available for scanning containers,"}),"\n",(0,r.jsx)(n.p,{children:"Unless otherwise configured, containers can communicate among each other, so running one bad image may lead to other areas of your setup being compromised. Docker images typically contain both original code, as well as up-stream packages, and even if that image has come from a trusted source, the up-stream packages it includes may not have."}),"\n",(0,r.jsx)(n.h3,{id:"specify-the-tag",children:"Specify the Tag"}),"\n",(0,r.jsxs)(n.p,{children:["Using fixed tags (as opposed to ",(0,r.jsx)(n.code,{children:":latest"})," ) will ensure immutability, meaning the base image will not change between builds. Note that for Dashy, the app is being actively developed, new features, bug fixes and general improvements are merged each week, and if you use a fixed version you will not enjoy these benefits. So it's up to you weather you would prefer a stable and reproducible environment, or the latest features and enhancements."]}),"\n",(0,r.jsx)(n.h3,{id:"container-security-scanning",children:"Container Security Scanning"}),"\n",(0,r.jsxs)(n.p,{children:["It's helpful to be aware of any potential security issues in any of the Docker images you are using. You can run a quick scan using Snyk on any image to output known vulnerabilities using ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/scan/",children:"Docker scan"}),", e.g: ",(0,r.jsx)(n.code,{children:"docker scan lissy93/dashy:latest"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["A similar product is ",(0,r.jsx)(n.a,{href:"https://github.com/aquasecurity/trivy",children:"Trivy"}),", which is free an open source. First install it (with your package manager), then to scan an image, just run: ",(0,r.jsx)(n.code,{children:"trivy image lissy93/dashy:latest"})]}),"\n",(0,r.jsxs)(n.p,{children:["For larger systems, RedHat ",(0,r.jsx)(n.a,{href:"https://www.redhat.com/en/topics/containers/what-is-clair",children:"Clair"})," is an app for parsing image contents and reporting on any found vulnerabilities. You run it locally in a container, and configure it with YAML. It can be integrated with Red Hat Quay, to show results on a dashboard. Most of these use static analysis to find potential issues, and scan included packages for any known security vulnerabilities."]}),"\n",(0,r.jsx)(n.h3,{id:"registry-security",children:"Registry Security"}),"\n",(0,r.jsxs)(n.p,{children:["Although over-kill for most users, you could run your own registry locally which would give you ultimate control over all images, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/registry/deploying/",children:"Deploying a Registry Docs"})," for more info. Another option is ",(0,r.jsx)(n.a,{href:"https://docker-docs.netlify.app/ee/dtr/",children:"Docker Trusted Registry"}),", it's great for enterprise applications, it sits behind your firewall, running on a swarm managed by Docker Universal Control Plane, and lets you securely store and manage your Docker images, mitigating the risk of breaches from the internet."]}),"\n",(0,r.jsx)(n.h3,{id:"security-modules",children:"Security Modules"}),"\n",(0,r.jsx)(n.p,{children:"Docker supports several modules that let you write your own security profiles."}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://www.apparmor.net/",children:"AppArmor"}),"is a kernel module that proactively protects the operating system and applications from external or internal threats, by enabling you to restrict programs' capabilities with per-program profiles. You can specify either a security policy by name, or by file path with the ",(0,r.jsx)(n.code,{children:"apparmor"})," flag in docker run. Learn more about writing profiles, ",(0,r.jsx)(n.a,{href:"https://gitlab.com/apparmor/apparmor/-/wikis/QuickProfileLanguage",children:"here"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Seccomp",children:"Seccomp"})," (Secure Computing Mode) is a sandboxing facility in the Linux kernel that acts like a firewall for system calls (syscalls). It uses Berkeley Packet Filter (BPF) rules to filter syscalls and control how they are handled. These filters can significantly limit a containers access to the Docker Host's Linux kernel - especially for simple containers/applications. It requires a Linux-based Docker host, with secomp enabled, and you can check for this by running ",(0,r.jsx)(n.code,{children:"docker info | grep seccomp"}),". A great resource for learning more about this is ",(0,r.jsx)(n.a,{href:"https://training.play-with-docker.com/security-seccomp/",children:"DockerLabs"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"web-server-configuration",children:"Web Server Configuration"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"The following section only applies if you are not using Docker, and would like to use your own web server"})}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Dashy ships with a pre-configured Node.js server, in ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/server.js",children:(0,r.jsx)(n.code,{children:"server.js"})})," which serves up the contents of the ",(0,r.jsx)(n.code,{children:"./dist"})," directory on a given port. You can start the server by running ",(0,r.jsx)(n.code,{children:"node server"}),". Note that the app must have been build (run ",(0,r.jsx)(n.code,{children:"yarn build"}),"), and you need ",(0,r.jsx)(n.a,{href:"https://nodejs.org",children:"Node.js"})," installed."]}),"\n",(0,r.jsxs)(n.p,{children:["If you wish to run Dashy from a sub page (e.g. ",(0,r.jsx)(n.code,{children:"example.com/dashy"}),"), then just set the ",(0,r.jsx)(n.code,{children:"BASE_URL"})," environmental variable to that page name (in this example, ",(0,r.jsx)(n.code,{children:"/dashy"}),"), before building the app, and the path to all assets will then resolve to the new path, instead of ",(0,r.jsx)(n.code,{children:"./"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"However, since Dashy is just a static web application, it can be served with whatever server you like. The following section outlines how you can configure a web server."}),"\n",(0,r.jsxs)(n.p,{children:["Note, that if you choose not to use ",(0,r.jsx)(n.code,{children:"server.js"})," to serve up the app, you will loose access to the following features:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Loading page, while the app is building"}),"\n",(0,r.jsx)(n.li,{children:"Writing config file to disk from the UI"}),"\n",(0,r.jsx)(n.li,{children:"Website status indicators, and ping checks"}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Example Configs"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nginx",children:"NGINX"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#apache",children:"Apache"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#caddy",children:"Caddy"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#firebase-hosting",children:"Firebase"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cpanel",children:"cPanel"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"nginx-1",children:"NGINX"}),"\n",(0,r.jsxs)(n.p,{children:["Create a new file in ",(0,r.jsx)(n.code,{children:"/etc/nginx/sites-enabled/dashy"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"server {\n\tlisten 8080;\n\tlisten [::]:8080;\n\n\troot /var/www/dashy/html;\n\tindex index.html;\n\n\tserver_name your-domain.com www.your-domain.com;\n\n\tlocation / {\n\t\ttry_files $uri $uri/ =404;\n\t}\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["To use HTML5 history mode (",(0,r.jsx)(n.code,{children:"appConfig.routingMode: history"}),"), replace the inside of the location block with: ",(0,r.jsx)(n.code,{children:"try_files $uri $uri/ /index.html;"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Then upload the build contents of Dashy's dist directory to that location.\nFor example: ",(0,r.jsx)(n.code,{children:"scp -r ./dist/* [username]@[server_ip]:/var/www/dashy/html"})]}),"\n",(0,r.jsx)(n.h3,{id:"apache-1",children:"Apache"}),"\n",(0,r.jsxs)(n.p,{children:["Copy Dashy's dist folder to your apache server, ",(0,r.jsx)(n.code,{children:"sudo cp -r ./dashy/dist /var/www/html/dashy"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["In your Apache config, ",(0,r.jsx)(n.code,{children:"/etc/apche2/apache2.conf"})," add:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"\n\tOptions Indexes FollowSymLinks\n\tAllowOverride All\n\tRequire all granted\n\n\n\n RewriteEngine On\n RewriteBase /\n RewriteRule ^index\\.html$ - [L]\n RewriteCond %{REQUEST_FILENAME} !-f\n RewriteCond %{REQUEST_FILENAME} !-d\n RewriteRule . /index.html [L]\n\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Add a ",(0,r.jsx)(n.code,{children:".htaccess"})," file within ",(0,r.jsx)(n.code,{children:"/var/www/html/dashy/.htaccess"}),", and add:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"Options -MultiViews\nRewriteEngine On\nRewriteCond %{REQUEST_FILENAME} !-f\nRewriteRule ^ index.html [QSA,L]\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Then restart Apache, with ",(0,r.jsx)(n.code,{children:"sudo systemctl restart apache2"})]}),"\n",(0,r.jsx)(n.h3,{id:"caddy-1",children:"Caddy"}),"\n",(0,r.jsx)(n.p,{children:"Caddy v2"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"try_files {path} /\n"})}),"\n",(0,r.jsx)(n.p,{children:"Caddy v1"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"rewrite {\n regexp .*\n to {path} /\n}\n"})}),"\n",(0,r.jsx)(n.h3,{id:"firebase-hosting",children:"Firebase Hosting"}),"\n",(0,r.jsxs)(n.p,{children:["Create a file names ",(0,r.jsx)(n.code,{children:"firebase.json"}),", and populate it with something similar to:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:'{\n "hosting": {\n "public": "dist",\n "rewrites": [\n {\n "source": "**",\n "destination": "/index.html"\n }\n ]\n }\n}\n'})}),"\n",(0,r.jsx)(n.h3,{id:"cpanel",children:"cPanel"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:"Login to your WHM"}),"\n",(0,r.jsx)(n.li,{children:"Open 'Feature Manager' on the left sidebar"}),"\n",(0,r.jsx)(n.li,{children:"Under 'Manage feature list', click 'Edit'"}),"\n",(0,r.jsx)(n.li,{children:"Find 'Application manager' in the list, enable it and hit 'Save'"}),"\n",(0,r.jsx)(n.li,{children:"Log into your users cPanel account, and under 'Software' find 'Application Manager'"}),"\n",(0,r.jsx)(n.li,{children:"Click 'Register Application', fill in the form using the path that Dashy is located, and choose a domain, and hit 'Save'"}),"\n",(0,r.jsx)(n.li,{children:"The application should now show up in the list, click 'Ensure dependencies', and move the toggle switch to 'Enabled'"}),"\n",(0,r.jsx)(n.li,{children:"If you need to change the port, click 'Add environmental variable', give it the name 'PORT', choose a port number and press 'Save'."}),"\n",(0,r.jsx)(n.li,{children:"Dashy should now be running at your selected path an on a given port"}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"running-a-modified-version-of-the-app",children:"Running a Modified Version of the App"}),"\n",(0,r.jsx)(n.p,{children:"If you'd like to make any code changes to the app, and deploy your modified version, this section briefly explains how."}),"\n",(0,r.jsxs)(n.p,{children:["The first step is to fork the project on GitHub, and clone it to your local system. Next, install the dependencies (",(0,r.jsx)(n.code,{children:"yarn"}),"), and start the development server (",(0,r.jsx)(n.code,{children:"yarn dev"}),") and visit ",(0,r.jsx)(n.code,{children:"localhost:8080"})," in your browser. You can then make changes to the codebase, and see the live app update in real-time. Once you've finished, running ",(0,r.jsx)(n.code,{children:"yarn build"})," will build the app for production, and output the assets into ",(0,r.jsx)(n.code,{children:"./dist"})," which can then be deployed using a web server, CDN or the built-in Node server with ",(0,r.jsx)(n.code,{children:"yarn start"}),". For more info on all of this, take a look at the ",(0,r.jsx)(n.a,{href:"/docs/developing",children:"Developing Docs"}),". To build your own Docker container from the modified app, see ",(0,r.jsx)(n.a,{href:"#building-your-own-container",children:"Building your Own Container"})]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"building-your-own-container",children:"Building your Own Container"}),"\n",(0,r.jsx)(n.p,{children:"Similar to above, you'll first need to fork and clone Dashy to your local system, and then install dependencies."}),"\n",(0,r.jsxs)(n.p,{children:["Then, either use Dashy's default ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/Dockerfile",children:(0,r.jsx)(n.code,{children:"Dockerfile"})})," as is, or modify it according to your needs."]}),"\n",(0,r.jsxs)(n.p,{children:["To build and deploy locally, first build the app with: ",(0,r.jsx)(n.code,{children:"docker build -t dashy ."}),", and then start the app with ",(0,r.jsx)(n.code,{children:"docker run -p 8080:8080 --name my-dashboard dashy"}),". Or modify the ",(0,r.jsx)(n.code,{children:"docker-compose.yml"})," file, replacing ",(0,r.jsx)(n.code,{children:"image: lissy93/dashy"})," with ",(0,r.jsx)(n.code,{children:"build: ."})," and run ",(0,r.jsx)(n.code,{children:"docker compose up"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Your container should now be running, and will appear in the list when you run ",(0,r.jsx)(n.code,{children:"docker container ls \u2013a"}),". If you'd like to enter the container, run ",(0,r.jsx)(n.code,{children:"docker exec -it [container-id] /bin/ash"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["You may wish to upload your image to a container registry for easier access. Note that if you choose to do this on a public registry, please name your container something other than just 'dashy', to avoid confusion with the official image.\nYou can push your build image, by running: ",(0,r.jsx)(n.code,{children:"docker push ghcr.io/OWNER/IMAGE_NAME:latest"}),". You will first need to authenticate, this can be done by running ",(0,r.jsx)(n.code,{children:"echo $CR_PAT | docker login ghcr.io -u USERNAME --password-stdin"}),", where ",(0,r.jsx)(n.code,{children:"CR_PAT"})," is an environmental variable containing a token generated from your GitHub account. For more info, see the ",(0,r.jsx)(n.a,{href:"https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry",children:"Container Registry Docs"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453(e,n,s){s.d(n,{R:()=>t,x:()=>a});var i=s(6540);const r={},o=i.createContext(r);function t(e){const n=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[9695],{6644(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"management","title":"App Management","description":"The following article is a primer on managing self-hosted apps. It covers everything from keeping the Dashy (or any other app) up-to-date, secure, backed up, to other topics like auto-starting, monitoring, log management, web server configuration and using custom domains.","source":"@site/docs/management.md","sourceDirName":".","slug":"/management","permalink":"/docs/management","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/management.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Configuring","permalink":"/docs/configuring"},"next":{"title":"Troubleshooting","permalink":"/docs/troubleshooting"}}');var r=s(4848),o=s(8453);const t={},a="App Management",c={},l=[{value:"Contents",id:"contents",level:2},{value:"Providing Assets",id:"providing-assets",level:2},{value:"Running Commands",id:"running-commands",level:2},{value:"Healthchecks",id:"healthchecks",level:2},{value:"Logs and Performance",id:"logs-and-performance",level:2},{value:"Container Logs",id:"container-logs",level:3},{value:"Container Performance",id:"container-performance",level:3},{value:"Management Apps",id:"management-apps",level:3},{value:"Advanced Logging and Monitoring",id:"advanced-logging-and-monitoring",level:3},{value:"Auto-Starting at System Boot",id:"auto-starting-at-system-boot",level:2},{value:"Updating",id:"updating",level:2},{value:"Updating Docker Container",id:"updating-docker-container",level:3},{value:"Automatic Docker Updates",id:"automatic-docker-updates",level:3},{value:"Updating Dashy from Source",id:"updating-dashy-from-source",level:3},{value:"Backing Up",id:"backing-up",level:2},{value:"Backing Up Containers",id:"backing-up-containers",level:3},{value:"Backing Up Volumes",id:"backing-up-volumes",level:3},{value:"Dashy-Specific Backup",id:"dashy-specific-backup",level:3},{value:"Scheduling",id:"scheduling",level:2},{value:"SSL Certificates",id:"ssl-certificates",level:2},{value:"Auto-SSL",id:"auto-ssl",level:3},{value:"Getting a Self-Signed SSL Certificate",id:"getting-a-self-signed-ssl-certificate",level:3},{value:"Passing a Self-Signed Certificate to Dashy",id:"passing-a-self-signed-certificate-to-dashy",level:3},{value:"Authentication",id:"authentication",level:2},{value:"Managing Containers with Docker Compose",id:"managing-containers-with-docker-compose",level:2},{value:"Passing in Environmental Variables",id:"passing-in-environmental-variables",level:2},{value:"Setting Headers",id:"setting-headers",level:2},{value:"Example Headers",id:"example-headers",level:3},{value:"Caddy",id:"caddy",level:4},{value:"NGINX",id:"nginx",level:4},{value:"Traefik",id:"traefik",level:4},{value:"HAProxy",id:"haproxy",level:4},{value:"Apache",id:"apache",level:4},{value:"Squid",id:"squid",level:4},{value:"Remote Access",id:"remote-access",level:2},{value:"WireGuard",id:"wireguard",level:3},{value:"Example Server Config",id:"example-server-config",level:4},{value:"Example Client Config",id:"example-client-config",level:4},{value:"Reverse SSH Tunnel",id:"reverse-ssh-tunnel",level:3},{value:"TCP Tunnel",id:"tcp-tunnel",level:3},{value:"Custom Domain",id:"custom-domain",level:2},{value:"Using DNS",id:"using-dns",level:3},{value:"Using NGINX",id:"using-nginx",level:3},{value:"Container Security",id:"container-security",level:2},{value:"Keep Docker Up-To-Date",id:"keep-docker-up-to-date",level:3},{value:"Set Resource Quotas",id:"set-resource-quotas",level:3},{value:"Don't Run as Root",id:"dont-run-as-root",level:3},{value:"Specify a User",id:"specify-a-user",level:3},{value:"Limit capabilities",id:"limit-capabilities",level:3},{value:"Prevent new Privileges being Added",id:"prevent-new-privileges-being-added",level:3},{value:"Disable Inter-Container Communication",id:"disable-inter-container-communication",level:3},{value:"Don't Expose the Docker Daemon Socket",id:"dont-expose-the-docker-daemon-socket",level:3},{value:"Use Read-Only Volumes",id:"use-read-only-volumes",level:3},{value:"Set the Logging Level",id:"set-the-logging-level",level:3},{value:"Verify Image before Pulling",id:"verify-image-before-pulling",level:3},{value:"Specify the Tag",id:"specify-the-tag",level:3},{value:"Container Security Scanning",id:"container-security-scanning",level:3},{value:"Registry Security",id:"registry-security",level:3},{value:"Security Modules",id:"security-modules",level:3},{value:"Web Server Configuration",id:"web-server-configuration",level:2},{value:"NGINX",id:"nginx-1",level:3},{value:"Apache",id:"apache-1",level:3},{value:"Caddy",id:"caddy-1",level:3},{value:"Firebase Hosting",id:"firebase-hosting",level:3},{value:"cPanel",id:"cpanel",level:3},{value:"Running a Modified Version of the App",id:"running-a-modified-version-of-the-app",level:2},{value:"Building your Own Container",id:"building-your-own-container",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"app-management",children:"App Management"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"The following article is a primer on managing self-hosted apps. It covers everything from keeping the Dashy (or any other app) up-to-date, secure, backed up, to other topics like auto-starting, monitoring, log management, web server configuration and using custom domains."})}),"\n",(0,r.jsx)(n.h2,{id:"contents",children:"Contents"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#providing-assets",children:"Providing Assets"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#running-commands",children:"Running Commands"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#healthchecks",children:"Healthchecks"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#logs-and-performance",children:"Logs and Performance"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#auto-starting-at-system-boot",children:"Auto-Starting at Boot"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#updating",children:"Updating"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#backing-up",children:"Backing Up"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#scheduling",children:"Scheduling"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#ssl-certificates",children:"SSL Certificates"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#authentication",children:"Authentication"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#managing-containers-with-docker-compose",children:"Managing with Compose"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#passing-in-environmental-variables",children:"Environmental Variables"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#setting-headers",children:"Setting Headers"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#remote-access",children:"Remote Access"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#custom-domain",children:"Custom Domain"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#container-security",children:"Securing Containers"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#web-server-configuration",children:"Web Server Configuration"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#running-a-modified-version-of-the-app",children:"Running a Modified App"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#building-your-own-container",children:"Building your Own Container"})}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"providing-assets",children:"Providing Assets"}),"\n",(0,r.jsx)(n.p,{children:"Although not essential, you will most likely want to provide several assets to your running app."}),"\n",(0,r.jsxs)(n.p,{children:["This is easy to do using ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/storage/volumes/",children:"Docker Volumes"}),", which lets you share a file or directory between your host system, and the container. Volumes are specified in the Docker run command, or Docker compose file, using the ",(0,r.jsx)(n.code,{children:"--volume"})," or ",(0,r.jsx)(n.code,{children:"-v"})," flags. The value of which consists of the path to the file / directory on your host system, followed by the destination path within the container. Fields are separated by a colon (",(0,r.jsx)(n.code,{children:":"}),"), and must be in the correct order. For example: ",(0,r.jsx)(n.code,{children:"-v ~/alicia/my-local-conf.yml:/app/user-data/conf.yml"})]}),"\n",(0,r.jsx)(n.p,{children:"In Dashy, commonly configured resources include:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"./user-data/conf.yml"})," - Your main application config file"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"./public/item-icons"})," - A directory containing your own icons. This allows for offline access, and better performance than fetching from a CDN"]}),"\n",(0,r.jsxs)(n.li,{children:["Also within ",(0,r.jsx)(n.code,{children:"./public"})," you'll find standard website assets, including ",(0,r.jsx)(n.code,{children:"favicon.ico"}),", ",(0,r.jsx)(n.code,{children:"manifest.json"}),", ",(0,r.jsx)(n.code,{children:"robots.txt"}),", etc. There's no need to pass these in, but you can do so if you wish"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"/src/styles/user-defined-themes.scss"})," - A stylesheet for applying custom CSS to your app. You can also write your own themes here."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"running-commands",children:"Running Commands"}),"\n",(0,r.jsxs)(n.p,{children:["If you're running an app in Docker, then commands will need to be passed to the container to be executed. This can be done by preceding each command with ",(0,r.jsx)(n.code,{children:"docker exec -it [container-id]"}),", where container ID can be found by running ",(0,r.jsx)(n.code,{children:"docker ps"}),". For example ",(0,r.jsx)(n.code,{children:"docker exec -it 26c156c467b4 yarn build"}),". You can also enter the container, with ",(0,r.jsx)(n.code,{children:"docker exec -it [container-id] /bin/ash"}),", and navigate around it with normal Linux commands."]}),"\n",(0,r.jsxs)(n.p,{children:["Dashy has several commands that can be used for various tasks, you can find a list of these either in the ",(0,r.jsx)(n.a,{href:"/docs/developing#project-commands",children:"Developing Docs"}),", or by looking at the ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/package.json#l5",children:(0,r.jsx)(n.code,{children:"package.json"})}),". These can be used by running ",(0,r.jsx)(n.code,{children:"yarn [command-name]"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"healthchecks",children:"Healthchecks"}),"\n",(0,r.jsxs)(n.p,{children:["Healthchecks are configured to periodically check that Dashy is up and running correctly on the specified port. By default, the health script is called every 5 minutes, but this can be modified with the ",(0,r.jsx)(n.code,{children:"--health-interval"})," option. You can check the current container health with: ",(0,r.jsx)(n.code,{children:'docker inspect --format "{{json .State.Health }}" [container-id]'}),", and a summary of health status will show up under ",(0,r.jsx)(n.code,{children:"docker ps"}),". You can also manually request the current application status by running ",(0,r.jsx)(n.code,{children:"docker exec -it [container-id] yarn health-check"}),". You can disable healthchecks altogether by adding the ",(0,r.jsx)(n.code,{children:"--no-healthcheck"})," flag to your Docker run command."]}),"\n",(0,r.jsxs)(n.p,{children:["To restart unhealthy containers automatically, check out ",(0,r.jsx)(n.a,{href:"https://hub.docker.com/r/willfarrell/autoheal/",children:"Autoheal"}),". This image watches for unhealthy containers, and automatically triggers a restart. (This is a stand in for Docker's ",(0,r.jsx)(n.code,{children:"--exit-on-unhealthy"})," that was proposed, but ",(0,r.jsx)(n.a,{href:"https://github.com/moby/moby/pull/22719",children:"not merged"}),"). There's also ",(0,r.jsx)(n.a,{href:"https://github.com/qdm12/deunhealth",children:"Deunhealth"}),", which is super light-weight, and doesn't require network access."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run -d \\\n --name autoheal \\\n --restart=always \\\n -e AUTOHEAL_CONTAINER_LABEL=all \\\n -v /var/run/docker.sock:/var/run/docker.sock \\\n willfarrell/autoheal\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"logs-and-performance",children:"Logs and Performance"}),"\n",(0,r.jsx)(n.h3,{id:"container-logs",children:"Container Logs"}),"\n",(0,r.jsxs)(n.p,{children:["You can view logs for a given Docker container with ",(0,r.jsx)(n.code,{children:"docker logs [container-id]"}),", add the ",(0,r.jsx)(n.code,{children:"--follow"})," flag to stream the logs. For more info, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/config/containers/logging/",children:"Logging Documentation"}),". There's also ",(0,r.jsx)(n.a,{href:"https://dozzle.dev/",children:"Dozzle"}),", a useful tool, that provides a web interface where you can stream and query logs from all your running containers from a single web app."]}),"\n",(0,r.jsx)(n.h3,{id:"container-performance",children:"Container Performance"}),"\n",(0,r.jsxs)(n.p,{children:["You can check the resource usage for your running Docker containers with ",(0,r.jsx)(n.code,{children:"docker stats"})," or ",(0,r.jsx)(n.code,{children:"docker stats [container-id]"}),". For more info, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/stats/",children:"Stats Documentation"}),". There's also ",(0,r.jsx)(n.a,{href:"https://github.com/google/cadvisor",children:"cAdvisor"}),", a useful web app for viewing and analyzing resource usage and performance of all your running containers."]}),"\n",(0,r.jsx)(n.h3,{id:"management-apps",children:"Management Apps"}),"\n",(0,r.jsxs)(n.p,{children:["You can also view logs, resource usage and other info as well as manage your entire Docker workflow in third-party Docker management apps. For example ",(0,r.jsx)(n.a,{href:"https://github.com/portainer/portainer",children:"Portainer"})," an all-in-one open source management web UI for Docker and Kubernetes, or ",(0,r.jsx)(n.a,{href:"https://github.com/jesseduffield/lazydocker",children:"LazyDocker"})," a terminal UI for Docker container management and monitoring."]}),"\n",(0,r.jsx)(n.h3,{id:"advanced-logging-and-monitoring",children:"Advanced Logging and Monitoring"}),"\n",(0,r.jsxs)(n.p,{children:["Docker supports using ",(0,r.jsx)(n.a,{href:"https://prometheus.io/",children:"Prometheus"})," to collect logs, which can then be visualized using a platform like ",(0,r.jsx)(n.a,{href:"https://grafana.com/",children:"Grafana"}),". For more info, see ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/config/daemon/prometheus/",children:"this guide"}),". If you need to route your logs to a remote syslog, then consider using ",(0,r.jsx)(n.a,{href:"https://github.com/gliderlabs/logspout",children:"logspout"}),". For enterprise-grade instances, there are managed services, that make monitoring container logs and metrics very easy, such as ",(0,r.jsx)(n.a,{href:"https://sematext.com/blog/docker-container-monitoring-with-sematext/",children:"Sematext"})," with ",(0,r.jsx)(n.a,{href:"https://github.com/sematext/logagent-js",children:"Logagent"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"auto-starting-at-system-boot",children:"Auto-Starting at System Boot"}),"\n",(0,r.jsxs)(n.p,{children:["You can use Docker's ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/run/#restart-policies---restart",children:"restart policies"})," to instruct the container to start after a system reboot, or restart after a crash. Just add the ",(0,r.jsx)(n.code,{children:"--restart=always"})," flag to your Docker compose script or Docker run command. For more information, see the docs on ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/config/containers/start-containers-automatically/",children:"Starting Containers Automatically"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["For Podman, you can use ",(0,r.jsx)(n.code,{children:"systemd"})," to create a service that launches your container, ",(0,r.jsx)(n.a,{href:"https://podman.io/blogs/2018/09/13/systemd.html",children:"the docs"})," explains things further. A similar approach can be used with Docker, if you need to start containers after a reboot, but before any user interaction."]}),"\n",(0,r.jsxs)(n.p,{children:["To restart the container after something within it has crashed, consider using ",(0,r.jsx)(n.a,{href:"https://github.com/willfarrell/docker-autoheal",children:(0,r.jsx)(n.code,{children:"docker-autoheal"})})," by @willfarrell, a service that monitors and restarts unhealthy containers. For more info, see the ",(0,r.jsx)(n.a,{href:"#healthchecks",children:"Healthchecks"})," section above."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"updating",children:"Updating"}),"\n",(0,r.jsx)(n.p,{children:"Dashy is under active development, so to take advantage of the latest features, you may need to update your instance every now and again."}),"\n",(0,r.jsx)(n.h3,{id:"updating-docker-container",children:"Updating Docker Container"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["Pull latest image: ",(0,r.jsx)(n.code,{children:"docker pull lissy93/dashy:latest"})]}),"\n",(0,r.jsxs)(n.li,{children:["Kill off existing container\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Find container ID: ",(0,r.jsx)(n.code,{children:"docker ps"})]}),"\n",(0,r.jsxs)(n.li,{children:["Stop container: ",(0,r.jsx)(n.code,{children:"docker stop [container_id]"})]}),"\n",(0,r.jsxs)(n.li,{children:["Remove container: ",(0,r.jsx)(n.code,{children:"docker rm [container_id]"})]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["Spin up new container: ",(0,r.jsx)(n.code,{children:"docker run [params] lissy93/dashy"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"automatic-docker-updates",children:"Automatic Docker Updates"}),"\n",(0,r.jsxs)(n.p,{children:["You can automate the above process using ",(0,r.jsx)(n.a,{href:"https://github.com/containrrr/watchtower",children:"Watchtower"}),".\nWatchtower will watch for new versions of a given image on Docker Hub, pull down your new image, gracefully shut down your existing container and restart it with the same options that were used when it was deployed initially."]}),"\n",(0,r.jsx)(n.p,{children:"To get started, spin up the watchtower container:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run -d \\\n --name watchtower \\\n -v /var/run/docker.sock:/var/run/docker.sock \\\n containrrr/watchtower\n"})}),"\n",(0,r.jsxs)(n.p,{children:["For more information, see the ",(0,r.jsx)(n.a,{href:"https://containrrr.dev/watchtower/",children:"Watchtower Docs"})]}),"\n",(0,r.jsx)(n.h3,{id:"updating-dashy-from-source",children:"Updating Dashy from Source"}),"\n",(0,r.jsxs)(n.p,{children:["Stop your current instance of Dashy, then navigate into the source directory. Pull down the latest code, with ",(0,r.jsx)(n.code,{children:"git pull origin master"}),", then update dependencies with ",(0,r.jsx)(n.code,{children:"yarn"}),", rebuild with ",(0,r.jsx)(n.code,{children:"yarn build"}),", and start the server again with ",(0,r.jsx)(n.code,{children:"yarn start"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"backing-up",children:"Backing Up"}),"\n",(0,r.jsx)(n.h3,{id:"backing-up-containers",children:"Backing Up Containers"}),"\n",(0,r.jsxs)(n.p,{children:["You can make a backup of any running container really easily, using ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/commit/",children:(0,r.jsx)(n.code,{children:"docker commit"})})," and save it with ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/export/",children:(0,r.jsx)(n.code,{children:"docker export"})}),", to do so:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["First find the container ID, you can do this with ",(0,r.jsx)(n.code,{children:"docker container ls"})]}),"\n",(0,r.jsxs)(n.li,{children:["Now to create the snapshot, just run ",(0,r.jsx)(n.code,{children:"docker commit -p [container-id] my-backup"})]}),"\n",(0,r.jsxs)(n.li,{children:["Finally, to save the backup locally, run ",(0,r.jsx)(n.code,{children:"docker save -o ~/dashy-backup.tar my-backup"})]}),"\n",(0,r.jsxs)(n.li,{children:["If you want to push this to a container registry, run ",(0,r.jsx)(n.code,{children:"docker push my-backup:latest"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Note that this will not include any data in docker volumes, and the process here is a bit different. Since these files exist on your host system, if you have an existing backup solution implemented, you can incorporate and volume files within that system."}),"\n",(0,r.jsx)(n.h3,{id:"backing-up-volumes",children:"Backing Up Volumes"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://github.com/offen/docker-volume-backup",children:"offen/docker-volume-backup"})," is a useful tool for periodic Docker volume backups, to any S3-compatible storage provider. It's run as a light-weight Docker container, and is easy to setup, and also supports GPG-encryption, email notification, and routing away older backups."]}),"\n",(0,r.jsxs)(n.p,{children:["To get started, create a docker-compose similar to the example below, and then start the container. For more info, check out their ",(0,r.jsx)(n.a,{href:"https://github.com/offen/docker-volume-backup",children:"documentation"}),", which is very clear."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"version: '3'\nservices:\n backup:\n image: offen/docker-volume-backup:latest\n environment:\n BACKUP_CRON_EXPRESSION: \"0 * * * *\"\n BACKUP_PRUNING_PREFIX: backup-\n BACKUP_RETENTION_DAYS: 7\n AWS_BUCKET_NAME: backup-bucket\n AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE\n AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\n volumes:\n - data:/backup/my-app-backup:ro\n - /var/run/docker.sock:/var/run/docker.sock:ro\nvolumes:\n data:\n"})}),"\n",(0,r.jsx)(n.p,{children:"It's worth noting that this process can also be done manually, using the following commands:"}),"\n",(0,r.jsx)(n.p,{children:"Backup:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run --rm -v some_volume:/volume -v /tmp:/backup alpine tar -cjf /backup/some_archive.tar.bz2 -C /volume ./\n"})}),"\n",(0,r.jsx)(n.p,{children:"Restore:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:'docker run --rm -v some_volume:/volume -v /tmp:/backup alpine sh -c "rm -rf /volume/* /volume/..?* /volume/.[!.]* ; tar -C /volume/ -xjf /backup/some_archive.tar.bz2"\n'})}),"\n",(0,r.jsx)(n.h3,{id:"dashy-specific-backup",children:"Dashy-Specific Backup"}),"\n",(0,r.jsxs)(n.p,{children:["All configuration and dashboard settings are stored in your ",(0,r.jsx)(n.code,{children:"user-data/conf.yml"})," file. If you provide additional assets (like icons, fonts, themes, etc), these will also live in the ",(0,r.jsx)(n.code,{children:"user-data"})," directory. So to backup all Dashy data, this is the only directory you need to backup."]}),"\n",(0,r.jsx)(n.p,{children:"Since Dashy is open source, there shouldn't be any need to backup the main container."}),"\n",(0,r.jsxs)(n.p,{children:["Dashy also has a built-in cloud backup feature, which is free for personal users, and will let you make and restore fully encrypted backups of your config directly through the UI. To learn more, see the ",(0,r.jsx)(n.a,{href:"/docs/backup-restore",children:"Cloud Backup Docs"})]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"scheduling",children:"Scheduling"}),"\n",(0,r.jsxs)(n.p,{children:["If you need to periodically schedule the running of a given command on Dashy (or any other container), then a useful tool for doing so it ",(0,r.jsx)(n.a,{href:"https://github.com/mcuadros/ofelia",children:"ofelia"}),". This runs as a Docker container and is really useful for things like backups, logging, updating, notifications, etc. Crons are specified using Go's crontab format, and a useful tool for visualizing this is ",(0,r.jsx)(n.a,{href:"https://crontab.guru/",children:"crontab.guru"}),". This can also be done natively with Alpine: ",(0,r.jsx)(n.code,{children:"docker run -it alpine ls /etc/periodic"}),".\nI recommend combining this with ",(0,r.jsx)(n.a,{href:"https://github.com/healthchecks/healthchecks",children:"healthchecks"})," for easy monitoring of jobs, and failure notifications."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"ssl-certificates",children:"SSL Certificates"}),"\n",(0,r.jsx)(n.p,{children:"Enabling HTTPS with an SSL certificate is recommended, especially if you are hosting Dashy anywhere other than your home. This will ensure that all traffic is encrypted in transit."}),"\n",(0,r.jsx)(n.h3,{id:"auto-ssl",children:"Auto-SSL"}),"\n",(0,r.jsxs)(n.p,{children:["If you are using ",(0,r.jsx)(n.a,{href:"https://nginxproxymanager.com/",children:"NGINX Proxy Manager"}),', then SSL is supported out of the box. Once you\'ve added your proxy host and web address, then set the scheme to HTTPS, then under the SSL Tab select "Request a new SSL certificate" and follow the on-screen instructions.']}),"\n",(0,r.jsxs)(n.p,{children:["If you're hosting Dashy behind Cloudflare, then they offer ",(0,r.jsx)(n.a,{href:"https://www.cloudflare.com/en-gb/learning/ssl/what-is-an-ssl-certificate/",children:"free and easy SSL"}),"- all you need to do is enable it under the SSL/TLS tab. Or if you are using shared hosting, you may find ",(0,r.jsx)(n.a,{href:"https://www.sitepoint.com/a-guide-to-setting-up-lets-encrypt-ssl-on-shared-hosting/",children:"this tutorial"})," helpful."]}),"\n",(0,r.jsx)(n.h3,{id:"getting-a-self-signed-ssl-certificate",children:"Getting a Self-Signed SSL Certificate"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://letsencrypt.org/docs/",children:"Let's Encrypt"})," is a global Certificate Authority, providing free SSL/TLS Domain Validation certificates in order to enable secure HTTPS access to your website. They have good browser/ OS ",(0,r.jsx)(n.a,{href:"https://letsencrypt.org/docs/certificate-compatibility/",children:"compatibility"})," with their ISRG X1 and DST CA X3 root certificates, support ",(0,r.jsx)(n.a,{href:"https://community.letsencrypt.org/t/acme-v2-production-environment-wildcards/55578",children:"Wildcard issuance"})," done via ACMEv2 using the DNS-01 and have ",(0,r.jsx)(n.a,{href:"https://letsencrypt.org/2020/02/19/multi-perspective-validation.html",children:"Multi-Perspective Validation"}),". Let's Encrypt provide ",(0,r.jsx)(n.a,{href:"https://certbot.eff.org/",children:"CertBot"})," an easy app for generating and setting up an SSL certificate."]}),"\n",(0,r.jsxs)(n.p,{children:["This process can be automated, using something like the ",(0,r.jsx)(n.a,{href:"https://github.com/Valian/docker-nginx-auto-ssl",children:"Docker-NGINX-Auto-SSL Container"})," to generate and renew certificates when needed."]}),"\n",(0,r.jsxs)(n.p,{children:["If you're not so comfortable on the command line, then you can use a tool like ",(0,r.jsx)(n.a,{href:"https://www.sslforfree.com/",children:"SSL For Free"})," or ",(0,r.jsx)(n.a,{href:"https://zerossl.com/",children:"ZeroSSL"})," to generate your cert. They also provide step-by-step setup instructions for most platforms."]}),"\n",(0,r.jsx)(n.h3,{id:"passing-a-self-signed-certificate-to-dashy",children:"Passing a Self-Signed Certificate to Dashy"}),"\n",(0,r.jsxs)(n.p,{children:["Once you've generated your SSL cert, you'll need to pass it to Dashy. This can be done by specifying the paths to your public and private keys using the ",(0,r.jsx)(n.code,{children:"SSL_PRIV_KEY_PATH"})," and ",(0,r.jsx)(n.code,{children:"SSL_PUB_KEY_PATH"})," environmental variables. Or if you're using Docker, then just pass public + private SSL keys in under ",(0,r.jsx)(n.code,{children:"/etc/ssl/certs/dashy-pub.pem"})," and ",(0,r.jsx)(n.code,{children:"/etc/ssl/certs/dashy-priv.key"})," respectively, e.g:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run -d \\\n -p 8080:8080 \\\n -v ~/my-private-key.key:/etc/ssl/certs/dashy-priv.key:ro \\\n -v ~/my-public-key.pem:/etc/ssl/certs/dashy-pub.pem:ro \\\n lissy93/dashy:latest\n"})}),"\n",(0,r.jsxs)(n.p,{children:["By default the SSL port is ",(0,r.jsx)(n.code,{children:"443"})," within a Docker container, or ",(0,r.jsx)(n.code,{children:"4001"})," if running on bare metal, but you can override this with the ",(0,r.jsx)(n.code,{children:"SSL_PORT"})," environmental variable."]}),"\n",(0,r.jsxs)(n.p,{children:["Once everything is setup, you can verify your site is secured using a tool like ",(0,r.jsx)(n.a,{href:"https://www.sslchecker.com/sslchecker",children:"SSL Checker"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"authentication",children:"Authentication"}),"\n",(0,r.jsxs)(n.p,{children:["Dashy natively supports secure authentication using KeyCloak. There is also a Simple Auth feature that doesn't require any additional setup. Usage instructions for both, as well as alternative auth methods, has now moved to the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/authentication",children:"Authentication Docs"})})," page."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"managing-containers-with-docker-compose",children:"Managing Containers with Docker Compose"}),"\n",(0,r.jsxs)(n.p,{children:["When you have a lot of containers, it quickly becomes hard to manage with ",(0,r.jsx)(n.code,{children:"docker run"})," commands. The solution to this is ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/compose/",children:"docker compose"}),", a handy tool for defining all a containers run settings in a single YAML file, and then spinning up that container with a single short command - ",(0,r.jsx)(n.code,{children:"docker compose up"}),". A good example of which can be seen in ",(0,r.jsx)(n.a,{href:"https://github.com/abhilesh/self-hosted_docker_setups",children:"@abhilesh's docker compose collection"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["You can use Dashy's default ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/docker-compose.yml",children:(0,r.jsx)(n.code,{children:"docker-compose.yml"})})," file as a template, and modify it according to your needs."]}),"\n",(0,r.jsx)(n.p,{children:"An example Docker compose, using the default base image from DockerHub, might look something like this:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"---\nversion: \"3.8\"\nservices:\n dashy:\n container_name: Dashy\n image: lissy93/dashy\n volumes:\n - /root/my-config.yml:/app/user-data/conf.yml\n ports:\n - 4000:8080\n environment:\n - BASE_URL=/my-dashboard\n restart: unless-stopped\n healthcheck:\n test: ['CMD', 'node', '/app/services/healthcheck']\n interval: 1m30s\n timeout: 10s\n retries: 3\n start_period: 40s\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"passing-in-environmental-variables",children:"Passing in Environmental Variables"}),"\n",(0,r.jsxs)(n.p,{children:["With Docker, you can define environmental variables under the ",(0,r.jsx)(n.code,{children:"environment"})," section of your Docker compose file. Environmental variables are used to configure high-level settings, usually before the config file has been read. For a list of all supported env vars in Dashy, see ",(0,r.jsx)(n.a,{href:"/docs/developing#environmental-variables",children:"the developing docs"}),", or the default ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/.env",children:(0,r.jsx)(n.code,{children:".env"})})," file."]}),"\n",(0,r.jsxs)(n.p,{children:["A common use case, is to run Dashy under a sub-page, instead of at the root of a URL (e.g. ",(0,r.jsx)(n.code,{children:"https://my-homelab.local/dashy"})," instead of ",(0,r.jsx)(n.code,{children:"https://dashy.my-homelab.local"}),"). In this use-case, you'd specify the ",(0,r.jsx)(n.code,{children:"BASE_URL"})," variable in your compose file."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"environment:\n - BASE_URL=/dashy\n"})}),"\n",(0,r.jsxs)(n.p,{children:["You can also do the same thing with the docker run command, using the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file",children:(0,r.jsx)(n.code,{children:"--env"})})," flag.\nIf you've got many environmental variables, you might find it useful to put them in a ",(0,r.jsxs)(n.a,{href:"https://docs.docker.com/compose/env-file/",children:[(0,r.jsx)(n.code,{children:".env"})," file"]}),". Similarly, for Docker run you can use ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file",children:(0,r.jsx)(n.code,{children:"--env-file"})})," if you'd like to pass in a file containing all your environmental variables."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"setting-headers",children:"Setting Headers"}),"\n",(0,r.jsxs)(n.p,{children:["Any external requests made to a different origin (app/ service under a different domain) will be blocked if the correct headers are not specified. This is known as ",(0,r.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"Cross-Origin Resource Sharing"})," (CORS) and is a security feature built into modern browsers."]}),"\n",(0,r.jsx)(n.p,{children:"If you see a CORS error in your console, this can be easily fixed by setting the correct headers. This is not a bug with Dashy, so please don't raise it as a bug!"}),"\n",(0,r.jsx)(n.h3,{id:"example-headers",children:"Example Headers"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#caddy",children:"Caddy"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nginx",children:"NGINX"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#traefik",children:"Tr\xe6f\u026ak"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#haproxy",children:"HAProxy"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#apache",children:"Apache"})}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.em,{children:["The following section briefly outlines how you can set headers for common web proxies/ servers. More info can be found in the documentation for the proxy that you are using, or in the ",(0,r.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"MDN Docs"}),"."]})}),"\n",(0,r.jsx)(n.p,{children:"These examples are using:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"Access-Control-Allow-Origin"})," header, but depending on what type of content you are enabling, this will vary. For example, to allow a site to be loaded in an iframe (for the modal or workspace views) you would use ",(0,r.jsx)(n.code,{children:"X-Frame-Options"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:["The domain root (",(0,r.jsx)(n.code,{children:"/"}),"), if your're hosting from a sub-page, replace that with your path."]}),"\n",(0,r.jsxs)(n.li,{children:["A wildcard (",(0,r.jsx)(n.code,{children:"*"}),"), which would allow access from traffic on any domain, this is discouraged, and you should replace it with the URL where you are hosting Dashy. Note that for requests that transport sensitive info, like credentials (e.g. Keycloak login), the wildcard is ",(0,r.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#requests_with_credentials",children:"disallowed all together"})," and will be blocked."]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"caddy",children:"Caddy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsxs)(n.a,{href:"https://caddyserver.com/docs/caddyfile/directives/header",children:["Caddy ",(0,r.jsx)(n.code,{children:"header"})," docs"]})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"headers / {\n Access-Control-Allow-Origin *\n}\n"})}),"\n",(0,r.jsx)(n.h4,{id:"nginx",children:"NGINX"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsxs)(n.a,{href:"https://nginx.org/en/docs/http/ngx_http_headers_module.html",children:["NGINX ",(0,r.jsx)(n.code,{children:"ngx_http_headers_module"})," docs"]})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"location / {\n add_header Access-Control-Allow-Origin *;\n}\n"})}),"\n",(0,r.jsx)(n.p,{children:"Note this can also be done through the UI, using NGINX Proxy Manager."}),"\n",(0,r.jsx)(n.h4,{id:"traefik",children:"Traefik"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsx)(n.a,{href:"https://doc.traefik.io/traefik/middlewares/http/headers/#cors-headers",children:"Tr\xe6f\u026ak CORS headers docs"})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:'labels:\n - "traefik.http.middlewares.testheader.headers.accesscontrolallowmethods=GET,OPTIONS,PUT"\n - "traefik.http.middlewares.testheader.headers.accesscontrolalloworiginlist=https://foo.bar.org,https://example.org"\n - "traefik.http.middlewares.testheader.headers.accesscontrolmaxage=100"\n - "traefik.http.middlewares.testheader.headers.addvaryheader=true"\n'})}),"\n",(0,r.jsx)(n.h4,{id:"haproxy",children:"HAProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.haproxy.com/documentation/hapee/latest/traffic-routing/rewrites/rewrite-responses/",children:"HAProxy Rewrite Response Docs"})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"/\n http-response add-header Access-Control-Allow-Origin *\n"})}),"\n",(0,r.jsx)(n.h4,{id:"apache",children:"Apache"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsxs)(n.a,{href:"https://httpd.apache.org/docs/current/mod/mod_headers.html",children:["Apache ",(0,r.jsx)(n.code,{children:"mode_headers"})," docs"]})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:'Header always set Access-Control-Allow-Origin "*"\n'})}),"\n",(0,r.jsx)(n.h4,{id:"squid",children:"Squid"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["See ",(0,r.jsxs)(n.a,{href:"http://www2.gr.squid-cache.org/Doc/config/request_header_access/",children:["Squid ",(0,r.jsx)(n.code,{children:"request_header_access"})," docs"]})," for more info."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"request_header_access Authorization allow all\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"remote-access",children:"Remote Access"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#wireguard",children:"WireGuard"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#reverse-ssh-tunnel",children:"Reverse SSH Tunnel"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#tcp-tunnel",children:"TCP Tunnel"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"wireguard",children:"WireGuard"}),"\n",(0,r.jsxs)(n.p,{children:["Using a VPN is one of the easiest ways to provide secure, full access to your local network from remote locations. ",(0,r.jsx)(n.a,{href:"https://www.wireguard.com/",children:"WireGuard"})," is a reasonably new open source VPN protocol, that was designed with ease of use, performance and security in mind. Unlike OpenVPN, it doesn't need to recreate the tunnel whenever connection is dropped, and it's also much easier to setup, using shared keys instead."]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Install Wireguard"})," - See the ",(0,r.jsx)(n.a,{href:"https://www.wireguard.com/install/",children:"Install Docs"})," for download links + instructions\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["On Debian-based systems, it's ",(0,r.jsx)(n.code,{children:"sudo apt install wireguard"})]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Generate a Private Key"})," - Run ",(0,r.jsx)(n.code,{children:"wg genkey"})," on the Wireguard server, and copy it to somewhere safe for later"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Create Server Config"})," - Open or create a file at ",(0,r.jsx)(n.code,{children:"/etc/wireguard/wg0.conf"})," and under ",(0,r.jsx)(n.code,{children:"[Interface]"})," add the following (see example below):\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"Address"})," - as a subnet of all desired IPs"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"PrivateKey"})," - that you just generated"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"ListenPort"})," - Default is ",(0,r.jsx)(n.code,{children:"51820"}),", but can be anything"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Get Client App"})," - Download the ",(0,r.jsx)(n.a,{href:"https://www.wireguard.com/install/",children:"WG client app"})," for your platform (Linux, Windows, MacOS, Android or iOS are all supported)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Create new Client Tunnel"})," - On your client app, there should be an option to create a new tunnel, when doing so a client private key will be generated (but if not, use the ",(0,r.jsx)(n.code,{children:"wg genkey"})," command again), and keep it somewhere safe. A public key will also be generated, and this will go in our saver config"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Add Clients to Server Config"})," - Head back to your ",(0,r.jsx)(n.code,{children:"wg0.conf"})," file on the server, create a ",(0,r.jsx)(n.code,{children:"[Peer]"})," section, and populate the following info\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"AllowedIPs"})," - List of IP address inside the subnet, the client should have access to"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"PublicKey"})," - The public key for the client you just generated"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Start the Server"})," - You can now start the WG server, using: ",(0,r.jsx)(n.code,{children:"wg-quick up wg0"})," on your server"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Finish Client Setup"})," - Head back to your client device, and edit the config file, leave the private key as is, and add the following fields:\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"PublicKey"})," - The public key of the server"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"Address"})," - This should match the ",(0,r.jsx)(n.code,{children:"AllowedIPs"})," section on the servers config file"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"DNS"})," - The DNS server that'll be used when accessing the network through the VPN"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"Endpoint"})," - The hostname or IP + Port where your WG server is running (you may need to forward this in your firewall's settings)"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Done"})," - Your clients should now be able to connect to your WG server :) Depending on your networks firewall rules, you may need to port forward the address of your WG server"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"example-server-config",children:(0,r.jsx)(n.strong,{children:"Example Server Config"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ini",children:"# Server file\n[Interface]\n# Which networks does my interface belong to? Notice: /24 and /64\nAddress = 10.5.0.1/24, 2001:470:xxxx:xxxx::1/64\nPrivateKey = xxx\nListenPort = 51820\n\n# Peer 1\n[Peer]\nPublicKey = xxx\n# Which source IPs can I expect from that peer? Notice: /32 and /128\nAllowedIps = 10.5.0.35/32, 2001:470:xxxx:xxxx::746f:786f/128\n\n# Peer 2\n[Peer]\nPublicKey = xxx\n# Which source IPs can I expect from that peer? This one has a LAN which can\n# access hosts/jails without NAT.\n# Peer 2 has a single IP address inside the VPN: it's 10.5.0.25/32\nAllowedIps = 10.5.0.25/32,10.21.10.0/24,10.21.20.0/24,10.21.30.0/24,10.31.0.0/24,2001:470:xxxx:xxxx::ca:571e/128\n"})}),"\n",(0,r.jsx)(n.h4,{id:"example-client-config",children:(0,r.jsx)(n.strong,{children:"Example Client Config"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ini",children:"[Interface]\n# Which networks does my interface belong to? Notice: /24 and /64\nAddress = 10.5.0.35/24, 2001:470:xxxx:xxxx::746f:786f/64\nPrivateKey = xxx\n\n# Server\n[Peer]\nPublicKey = xxx\n# I want to route everything through the server, both IPv4 and IPv6. All IPs are\n# thus available through the Server, and I can expect packets from any IP to\n# come from that peer.\nAllowedIPs = 0.0.0.0/0, ::0/0\n# Where is the server on the internet? This is a public address. The port\n# (:51820) is the same as ListenPort in the [Interface] of the Server file above\nEndpoint = 1.2.3.4:51820\n# Usually, clients are behind NAT. to keep the connection running, keep alive.\nPersistentKeepalive = 15\n"})}),"\n",(0,r.jsxs)(n.p,{children:["A useful tool for getting WG setup is ",(0,r.jsx)(n.a,{href:"https://github.com/trailofbits/algo",children:"Algo"}),". It includes scripts and docs which cover almost all devices, platforms and clients, and has best practices implemented, and security features enabled. All of this is better explained in ",(0,r.jsx)(n.a,{href:"https://blog.trailofbits.com/2016/12/12/meet-algo-the-vpn-that-works/",children:"this blog post"}),"."]}),"\n",(0,r.jsx)(n.h3,{id:"reverse-ssh-tunnel",children:"Reverse SSH Tunnel"}),"\n",(0,r.jsxs)(n.p,{children:["SSH (or ",(0,r.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Secure_Shell",children:"Secure Shell"}),") is a secure tunnel that allows you to connect to a remote host. Unlike the VPN methods, an SSH connection does not require an intermediary, and will not be affected by your IP changing. However it only allows you to access a single service at a time. SSH was really designed for terminal access, but because of the latter mentioned benefits it's useful to setup, as a fallback option."]}),"\n",(0,r.jsx)(n.p,{children:"Directly SSH'ing into your home, would require you to open a port (usually 22), which would be terrible for security, and is not recommended. However a reverse SSH connection is initiated from inside your network. Once the connection is established, the port is redirected, allowing you to use the established connection to SSH into your home network."}),"\n",(0,r.jsxs)(n.p,{children:["The issue you've probably spotted, is that most public, corporate, and institutional networks will block SSH connections. To overcome this, you'd have to establish a server outside of your homelab that your homelab's device could SSH into to establish the reverse SSH connection. You can then connect to that remote server (the ",(0,r.jsx)(n.em,{children:"mothership"}),"), which in turn connects to your home network."]}),"\n",(0,r.jsxs)(n.p,{children:["Now all of this is starting to sound like quite a lot of work, but this is where services like ",(0,r.jsx)(n.a,{href:"https://remote.it/",children:"remot3.it"})," come in. They maintain the intermediary mothership server, and create the tunnel service for you. It's free for personal use, secure and easy. There are several similar services, such as ",(0,r.jsx)(n.a,{href:"https://remoteiot.com/",children:"RemoteIoT"}),", or you could create your own on a cloud VPS (see ",(0,r.jsx)(n.a,{href:"https://gist.github.com/nileshtrivedi/4c615e8d3c1bf053b0d31176b9e69e42",children:"this tutorial"})," for more info on that)."]}),"\n",(0,r.jsxs)(n.p,{children:["Before getting started, you'll need to head over to ",(0,r.jsx)(n.a,{href:"https://app.remote.it/auth/#/sign-up",children:"Remote.it"})," and create an account."]}),"\n",(0,r.jsx)(n.p,{children:"Then setup your local device:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["If you haven't already done so, you'll need to enable and configure SSH.\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["This is out-of-scope of this article, but I've explained it in detail in ",(0,r.jsx)(n.a,{href:"https://notes.aliciasykes.com/22798/my-server-setup#configure-ssh",children:"this post"}),"."]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["Download the Remote.it install script from their ",(0,r.jsx)(n.a,{href:"https://github.com/remoteit/installer",children:"GitHub"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"curl -LkO https://raw.githubusercontent.com/remoteit/installer/master/scripts/auto-install.sh"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["Make it executable, with ",(0,r.jsx)(n.code,{children:"chmod +x ./auto-install.sh"}),", and then run it with ",(0,r.jsx)(n.code,{children:"sudo ./auto-install.sh"})]}),"\n",(0,r.jsxs)(n.li,{children:["Finally, configure your device, by running ",(0,r.jsx)(n.code,{children:"sudo connectd_installer"})," and following the on-screen instructions"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"And when you're ready to connect to it:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["Login to ",(0,r.jsx)(n.a,{href:"https://app.remote.it/",children:"app.remote.it"}),", and select the name of your device"]}),"\n",(0,r.jsx)(n.li,{children:"You should see a list of running services, click SSH"}),"\n",(0,r.jsx)(n.li,{children:"You'll then be presented with some SSH credentials that you can now use to securely connect to your home, via the Remote.it servers"}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Done :)"}),"\n",(0,r.jsx)(n.h3,{id:"tcp-tunnel",children:"TCP Tunnel"}),"\n",(0,r.jsxs)(n.p,{children:["If you're running Dashy on your local network, behind a firewall, but need to temporarily share it with someone external, this can be achieved quickly and securely using ",(0,r.jsx)(n.a,{href:"https://ngrok.com/",children:"Ngrok"}),". It's basically a super slick, encrypted TCP tunnel that provides an internet-accessible address that anyone use to access your local service, from anywhere."]}),"\n",(0,r.jsxs)(n.p,{children:["To get started, ",(0,r.jsx)(n.a,{href:"https://ngrok.com/download",children:"Download"})," and install Ngrok for your system, then just run ",(0,r.jsx)(n.code,{children:"ngrok http [port]"})," (replace the port with the http port where Dashy is running, e.g. 8080). When ",(0,r.jsx)(n.a,{href:"https://ngrok.com/docs#http-local-https",children:"using https"}),", specify the full local url/ ip including the protocol."]}),"\n",(0,r.jsxs)(n.p,{children:["Some Ngrok features require you to be authenticated, you can ",(0,r.jsx)(n.a,{href:"https://dashboard.ngrok.com/signup",children:"create a free account"})," and generate a token in ",(0,r.jsx)(n.a,{href:"https://dashboard.ngrok.com/auth/your-authtoken",children:"your dashboard"}),", then run ",(0,r.jsx)(n.code,{children:"ngrok authtoken [token]"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["It's recommended to use authentication for any publicly accessible service. Dashy has an ",(0,r.jsx)(n.a,{href:"/docs/authentication",children:"Auth"})," feature built in, but an even easier method it to use the ",(0,r.jsx)(n.a,{href:"https://ngrok.com/docs#http-auth",children:(0,r.jsx)(n.code,{children:"-auth"})})," switch. E.g. ",(0,r.jsx)(n.code,{children:'ngrok http -auth="username:password123" 8080'})]}),"\n",(0,r.jsxs)(n.p,{children:["By default, your web app is assigned a randomly generated ngrok domain, but you can also use your own custom domain. Under the ",(0,r.jsx)(n.a,{href:"https://dashboard.ngrok.com/endpoints/domains",children:"Domains Tab"})," of your Ngrok dashboard, add your domain, and follow the CNAME instructions. You can now use your domain, with the ",(0,r.jsx)(n.a,{href:"https://ngrok.com/docs#http-custom-domains",children:(0,r.jsx)(n.code,{children:"-hostname"})})," switch, e.g. ",(0,r.jsx)(n.code,{children:"ngrok http -region=us -hostname=dashy.example.com 8080"}),". If you don't have your own domain name, you can instead use a custom sub-domain (e.g. ",(0,r.jsx)(n.code,{children:"alicia-dashy.ngrok.io"}),"), using the ",(0,r.jsx)(n.a,{href:"https://ngrok.com/docs#custom-subdomain-names",children:(0,r.jsx)(n.code,{children:"-subdomain"})})," switch."]}),"\n",(0,r.jsxs)(n.p,{children:["To integrate this into your docker-compose, take a look at the ",(0,r.jsx)(n.a,{href:"https://github.com/gtriggiano/ngrok-tunnel",children:"gtriggiano/ngrok-tunnel"})," container."]}),"\n",(0,r.jsxs)(n.p,{children:["There's so much more you can do with Ngrok, such as exposing a directory as a file browser, using websockets, relaying requests, rewriting headers, inspecting traffic, TLS and TCP tunnels and lots more. All or which is explained in ",(0,r.jsx)(n.a,{href:"https://ngrok.com/docs",children:"the Documentation"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["It's worth noting that Ngrok isn't the only option here, other options include: ",(0,r.jsx)(n.a,{href:"https://github.com/fatedier/frp",children:"FRP"}),", ",(0,r.jsx)(n.a,{href:"https://inlets.dev",children:"Inlets"}),", ",(0,r.jsx)(n.a,{href:"https://localtunnel.me/",children:"Local Tunnel"}),", ",(0,r.jsx)(n.a,{href:"https://tailscale.com/",children:"TailScale"}),", etc. Check out ",(0,r.jsx)(n.a,{href:"https://github.com/anderspitman/awesome-tunneling",children:"Awesome Tunneling"})," for a list of alternatives."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"custom-domain",children:"Custom Domain"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#using-nginx",children:"Using DNS"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#using-dns",children:"Using NGINX"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"using-dns",children:"Using DNS"}),"\n",(0,r.jsxs)(n.p,{children:["For locally running services, a domain can be set up directly in the DNS records. This method is really quick and easy, and doesn't require you to purchase an actual domain. Just update your networks DNS resolver, to point your desired URL to the local IP where Dashy (or any other app) is running. For example, a line in your hosts file might look something like: ",(0,r.jsx)(n.code,{children:"192.168.0.2 dashy.homelab.local"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["If you're using Pi-Hole, a similar thing can be done in the ",(0,r.jsx)(n.code,{children:"/etc/dnsmasq.d/03-custom-dns.conf"})," file, add a line like: ",(0,r.jsx)(n.code,{children:"address=/dashy.example.com/192.168.2.0"})," for each of your services."]}),"\n",(0,r.jsxs)(n.p,{children:["If you're running OPNSense/ PfSense, then this can be done through the UI with Unbound, it's explained nicely in ",(0,r.jsx)(n.a,{href:"https://homenetworkguy.com/how-to/use-custom-domain-name-in-internal-network/",children:"this article"}),", by Dustin Casto."]}),"\n",(0,r.jsx)(n.h3,{id:"using-nginx",children:"Using NGINX"}),"\n",(0,r.jsx)(n.p,{children:"If you're using NGINX, then you can use your own domain name, with a config similar to the below example."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"upstream dashy {\n server 127.0.0.1:32400;\n}\n\nserver {\n listen 8080;\n server_name dashy.mydomain.com;\n\n # Setup SSL\n ssl_certificate /var/www/mydomain/sslcert.pem;\n ssl_certificate_key /var/www/mydomain/sslkey.pem;\n ssl_protocols TLSv1 TLSv1.1 TLSv1.2;\n ssl_ciphers 'EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH';\n ssl_session_timeout 5m;\n ssl_prefer_server_ciphers on;\n\n location / {\n proxy_pass http://dashy;\n proxy_redirect off;\n proxy_buffering off;\n proxy_set_header host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504;\n }\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Similarly, a basic ",(0,r.jsx)(n.code,{children:"Caddyfile"})," might look like:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"dashy.example.com {\n reverse_proxy / nginx:8080\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["For more info, ",(0,r.jsx)(n.a,{href:"https://thehomelab.wiki/books/dns-reverse-proxy/page/create-domain-records-to-point-to-your-home-server-on-cloudflare-using-nginx-progy-manager",children:"this guide"})," on Setting up Domains with NGINX Proxy Manager and CloudFlare may be useful."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"container-security",children:"Container Security"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#keep-docker-up-to-date",children:"Keep Docker Up-To-Date"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#set-resource-quotas",children:"Set Resource Quotas"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#dont-run-as-root",children:"Don't Run as Root"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#specify-a-user",children:"Specify a User"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#limit-capabilities",children:"Limit Capabilities"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#prevent-new-privileges-being-added",children:"Prevent new Privileges being Added"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#disable-inter-container-communication",children:"Disable Inter-Container Communication"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#dont-expose-the-docker-daemon-socket",children:"Don't Expose the Docker Daemon Socket"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#use-read-only-volumes",children:"Use Read-Only Volumes"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#set-the-logging-level",children:"Set the Logging Level"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#verify-image-before-pulling",children:"Verify Image before Pulling"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#specify-the-tag",children:"Specify the Tag"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#container-security-scanning",children:"Container Security Scanning"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#registry-security",children:"Registry Security"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#security-modules",children:"Security Modules"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"keep-docker-up-to-date",children:"Keep Docker Up-To-Date"}),"\n",(0,r.jsxs)(n.p,{children:["To prevent known container escape vulnerabilities, which typically end in escalating to root/administrator privileges, patching Docker Engine and Docker Machine is crucial. For more info, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/install/",children:"Docker Installation Docs"}),"."]}),"\n",(0,r.jsx)(n.h3,{id:"set-resource-quotas",children:"Set Resource Quotas"}),"\n",(0,r.jsxs)(n.p,{children:["Docker enables you to limit resource consumption (CPU, memory, disk) on a per-container basis. This not only enhances system performance, but also prevents a compromised container from consuming a large amount of resources, in order to disrupt service or perform malicious activities. To learn more, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/config/containers/resource_constraints/",children:"Resource Constraints Docs"})]}),"\n",(0,r.jsxs)(n.p,{children:["For example, to run Dashy with max of 1GB ram, and max of 50% of 1 CP core:\n",(0,r.jsx)(n.code,{children:'docker run -d -p 8080:8080 --cpus=".5" --memory="1024m" lissy93/dashy:latest'})]}),"\n",(0,r.jsx)(n.h3,{id:"dont-run-as-root",children:"Don't Run as Root"}),"\n",(0,r.jsx)(n.p,{children:"Running a container with admin privileges gives it more power than it needs, and can be abused. Dashy does not need any root privileges, and Docker by default doesn't run containers as root, so providing you don't specifically type sudo, you should be all good here."}),"\n",(0,r.jsxs)(n.p,{children:["Note that if you're facing permission issues on Debian-based systems, you may need to add your user to the Docker group. First create the group: ",(0,r.jsx)(n.code,{children:"sudo groupadd docker"}),", then add your (non-root) user: ",(0,r.jsx)(n.code,{children:"sudo usermod \u2212aG docker [my-username]"}),", finally ",(0,r.jsx)(n.code,{children:"newgrp docker"})," to refresh."]}),"\n",(0,r.jsx)(n.h3,{id:"specify-a-user",children:"Specify a User"}),"\n",(0,r.jsx)(n.p,{children:"One of the best ways to prevent privilege escalation attacks, is to configure the container to use an unprivileged user. This also means that any files created by the container and mounted, will be owned by the specified user (and not root), which makes things much easier."}),"\n",(0,r.jsxs)(n.p,{children:["You can specify a user, using the ",(0,r.jsxs)(n.a,{href:"https://docs.docker.com/engine/reference/run/#user",children:[(0,r.jsx)(n.code,{children:"--user"})," param"]}),", and should include the user ID (",(0,r.jsx)(n.code,{children:"UID"}),"), which can be found by running ",(0,r.jsx)(n.code,{children:"id -u"}),", and the and the group ID (",(0,r.jsx)(n.code,{children:"GID"}),"), using ",(0,r.jsx)(n.code,{children:"id -g"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["With Docker run, you specify it like:\n",(0,r.jsx)(n.code,{children:"docker run --user 1000:1000 -p 8080:8080 lissy93/dashy"})]}),"\n",(0,r.jsx)(n.p,{children:"Of if you're using Docker-compose, you could use an environmental variable"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'version: "3.8"\nservices:\n dashy:\n image: lissy93/dashy\n user: ${CURRENT_UID}\n ports: [ 4000:8080 ]\n'})}),"\n",(0,r.jsxs)(n.p,{children:["And then to set the variable, and start the container, run: ",(0,r.jsx)(n.code,{children:"CURRENT_UID=$(id -u):$(id -g) docker-compose up"})]}),"\n",(0,r.jsx)(n.h3,{id:"limit-capabilities",children:"Limit capabilities"}),"\n",(0,r.jsxs)(n.p,{children:["Docker containers run with a subset of ",(0,r.jsx)(n.a,{href:"https://man7.org/linux/man-pages/man7/capabilities.7.html",children:"Linux Kernal's Capabilities"})," by default. It's good practice to drop privilege permissions that are not needed for any given container."]}),"\n",(0,r.jsxs)(n.p,{children:["With Docker run, you can use the ",(0,r.jsx)(n.code,{children:"--cap-drop"})," flag to remove capabilities, you can also use ",(0,r.jsx)(n.code,{children:"--cap-drop=all"})," and then define just the required permissions using the ",(0,r.jsx)(n.code,{children:"--cap-add"})," option. For a list of available capabilities, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities",children:"Privilege Capabilities Docs"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Note that dropping privileges and capabilities on runtime is not fool-proof, and often any leftover privileges can be used to re-escalate, see ",(0,r.jsx)(n.a,{href:"https://wiki.sei.cmu.edu/confluence/display/c/POS36-C.+Observe+correct+revocation+order+while+relinquishing+privileges",children:"POS36-C"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"Here's an example using docker-compose, removing privileges that are not required for Dashy to run:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'version: "3.8"\nservices:\n dashy:\n image: lissy93/dashy\n ports: [ 4000:8080 ]\n cap_drop:\n - ALL\n cap_add:\n - CHOWN\n - SETGID\n - SETUID\n - DAC_OVERRIDE\n - NET_BIND_SERVICE\n'})}),"\n",(0,r.jsx)(n.h3,{id:"prevent-new-privileges-being-added",children:"Prevent new Privileges being Added"}),"\n",(0,r.jsxs)(n.p,{children:["To prevent processes inside the container from getting additional privileges, pass in the ",(0,r.jsx)(n.code,{children:"--security-opt=no-new-privileges:true"})," option to the Docker run command (see ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/run/#security-configuration",children:"docs"}),")."]}),"\n",(0,r.jsxs)(n.p,{children:["Run Command:\n",(0,r.jsx)(n.code,{children:"docker run --security-opt=no-new-privileges:true -p 8080:8080 lissy93/dashy"})]}),"\n",(0,r.jsx)(n.p,{children:"Docker Compose"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"security_opt:\n- no-new-privileges:true\n"})}),"\n",(0,r.jsx)(n.h3,{id:"disable-inter-container-communication",children:"Disable Inter-Container Communication"}),"\n",(0,r.jsxs)(n.p,{children:["By default Docker containers can talk to each other (using ",(0,r.jsxs)(n.a,{href:"https://docs.docker.com/config/containers/container-networking/",children:[(0,r.jsx)(n.code,{children:"docker0"})," bridged network"]}),"). If you don't need this capability, then it should be disabled. This can be done with the ",(0,r.jsx)(n.code,{children:"--icc=false"})," in your run command. You can learn more about how to facilitate secure communication between containers in the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/compose/networking/",children:"Compose Networking docs"}),"."]}),"\n",(0,r.jsx)(n.h3,{id:"dont-expose-the-docker-daemon-socket",children:"Don't Expose the Docker Daemon Socket"}),"\n",(0,r.jsxs)(n.p,{children:["Docker socket ",(0,r.jsx)(n.code,{children:"/var/run/docker.sock"})," is the UNIX socket that Docker is listening to. This is the primary entry point for the Docker API. The owner of this socket is root. Giving someone access to it is equivalent to giving unrestricted root access to your host."]}),"\n",(0,r.jsxs)(n.p,{children:["You should ",(0,r.jsx)(n.strong,{children:"not"})," enable TCP Docker daemon socket (",(0,r.jsx)(n.code,{children:"-H tcp://0.0.0.0:XXX"}),"), as doing so exposes un-encrypted and unauthenticated direct access to the Docker daemon, and if the host is connected to the internet, the daemon on your computer can be used by anyone from the public internet- which is bad. If you need TCP, you should ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-socket-option",children:"see the docs"})," to understand how to do this more securely.\nSimilarly, never expose ",(0,r.jsx)(n.code,{children:"/var/run/docker.sock"})," to other containers as a volume, as it can be exploited."]}),"\n",(0,r.jsx)(n.h3,{id:"use-read-only-volumes",children:"Use Read-Only Volumes"}),"\n",(0,r.jsxs)(n.p,{children:["You can specify that a specific volume should be read-only by appending ",(0,r.jsx)(n.code,{children:":ro"})," to the ",(0,r.jsx)(n.code,{children:"-v"})," switch. For example, while running Dashy, if we want our config to be writable, but keep all other assets protected, we would do:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run -d \\\n -p 8080:8080 \\\n -v ~/dashy-conf.yml:/app/user-data/conf.yml \\\n -v ~/dashy-icons:/app/public/item-icons:ro \\\n -v ~/dashy-theme.scss:/app/src/styles/user-defined-themes.scss:ro \\\n lissy93/dashy:latest\n"})}),"\n",(0,r.jsxs)(n.p,{children:["You can also prevent a container from writing any changes to volumes on your host's disk, using the ",(0,r.jsx)(n.code,{children:"--read-only"})," flag. Although, for Dashy, you will not be able to write config changes to disk, when edited through the UI with this method. You could make this work, by specifying the config directory as a temp write location, with ",(0,r.jsx)(n.code,{children:"--tmpfs /app/user-data/conf.yml"})," - but that this will not write the volume back to your host."]}),"\n",(0,r.jsx)(n.h3,{id:"set-the-logging-level",children:"Set the Logging Level"}),"\n",(0,r.jsxs)(n.p,{children:["Logging is important, as it enables you to review events in the future, and in the case of a compromise this will let get an idea of what may have happened. The default log level is ",(0,r.jsx)(n.code,{children:"INFO"}),", and this is also the recommendation, use ",(0,r.jsx)(n.code,{children:"--log-level info"})," to ensure this is set."]}),"\n",(0,r.jsx)(n.h3,{id:"verify-image-before-pulling",children:"Verify Image before Pulling"}),"\n",(0,r.jsx)(n.p,{children:"Only use trusted images, from verified/ official sources. If an app is open source, it is more likely to be safe, as anyone can verify the code. There are also tools available for scanning containers,"}),"\n",(0,r.jsx)(n.p,{children:"Unless otherwise configured, containers can communicate among each other, so running one bad image may lead to other areas of your setup being compromised. Docker images typically contain both original code, as well as up-stream packages, and even if that image has come from a trusted source, the up-stream packages it includes may not have."}),"\n",(0,r.jsx)(n.h3,{id:"specify-the-tag",children:"Specify the Tag"}),"\n",(0,r.jsxs)(n.p,{children:["Using fixed tags (as opposed to ",(0,r.jsx)(n.code,{children:":latest"})," ) will ensure immutability, meaning the base image will not change between builds. Note that for Dashy, the app is being actively developed, new features, bug fixes and general improvements are merged each week, and if you use a fixed version you will not enjoy these benefits. So it's up to you weather you would prefer a stable and reproducible environment, or the latest features and enhancements."]}),"\n",(0,r.jsx)(n.h3,{id:"container-security-scanning",children:"Container Security Scanning"}),"\n",(0,r.jsxs)(n.p,{children:["It's helpful to be aware of any potential security issues in any of the Docker images you are using. You can run a quick scan using Snyk on any image to output known vulnerabilities using ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/scan/",children:"Docker scan"}),", e.g: ",(0,r.jsx)(n.code,{children:"docker scan lissy93/dashy:latest"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["A similar product is ",(0,r.jsx)(n.a,{href:"https://github.com/aquasecurity/trivy",children:"Trivy"}),", which is free an open source. First install it (with your package manager), then to scan an image, just run: ",(0,r.jsx)(n.code,{children:"trivy image lissy93/dashy:latest"})]}),"\n",(0,r.jsxs)(n.p,{children:["For larger systems, RedHat ",(0,r.jsx)(n.a,{href:"https://www.redhat.com/en/topics/containers/what-is-clair",children:"Clair"})," is an app for parsing image contents and reporting on any found vulnerabilities. You run it locally in a container, and configure it with YAML. It can be integrated with Red Hat Quay, to show results on a dashboard. Most of these use static analysis to find potential issues, and scan included packages for any known security vulnerabilities."]}),"\n",(0,r.jsx)(n.h3,{id:"registry-security",children:"Registry Security"}),"\n",(0,r.jsxs)(n.p,{children:["Although over-kill for most users, you could run your own registry locally which would give you ultimate control over all images, see the ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/registry/deploying/",children:"Deploying a Registry Docs"})," for more info. Another option is ",(0,r.jsx)(n.a,{href:"https://docker-docs.netlify.app/ee/dtr/",children:"Docker Trusted Registry"}),", it's great for enterprise applications, it sits behind your firewall, running on a swarm managed by Docker Universal Control Plane, and lets you securely store and manage your Docker images, mitigating the risk of breaches from the internet."]}),"\n",(0,r.jsx)(n.h3,{id:"security-modules",children:"Security Modules"}),"\n",(0,r.jsx)(n.p,{children:"Docker supports several modules that let you write your own security profiles."}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://www.apparmor.net/",children:"AppArmor"}),"is a kernel module that proactively protects the operating system and applications from external or internal threats, by enabling you to restrict programs' capabilities with per-program profiles. You can specify either a security policy by name, or by file path with the ",(0,r.jsx)(n.code,{children:"apparmor"})," flag in docker run. Learn more about writing profiles, ",(0,r.jsx)(n.a,{href:"https://gitlab.com/apparmor/apparmor/-/wikis/QuickProfileLanguage",children:"here"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Seccomp",children:"Seccomp"})," (Secure Computing Mode) is a sandboxing facility in the Linux kernel that acts like a firewall for system calls (syscalls). It uses Berkeley Packet Filter (BPF) rules to filter syscalls and control how they are handled. These filters can significantly limit a containers access to the Docker Host's Linux kernel - especially for simple containers/applications. It requires a Linux-based Docker host, with secomp enabled, and you can check for this by running ",(0,r.jsx)(n.code,{children:"docker info | grep seccomp"}),". A great resource for learning more about this is ",(0,r.jsx)(n.a,{href:"https://training.play-with-docker.com/security-seccomp/",children:"DockerLabs"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"web-server-configuration",children:"Web Server Configuration"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"The following section only applies if you are not using Docker, and would like to use your own web server"})}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Dashy ships with a pre-configured Node.js server, in ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/server.js",children:(0,r.jsx)(n.code,{children:"server.js"})})," which serves up the contents of the ",(0,r.jsx)(n.code,{children:"./dist"})," directory on a given port. You can start the server by running ",(0,r.jsx)(n.code,{children:"node server"}),". Note that the app must have been build (run ",(0,r.jsx)(n.code,{children:"yarn build"}),"), and you need ",(0,r.jsx)(n.a,{href:"https://nodejs.org",children:"Node.js"})," installed."]}),"\n",(0,r.jsxs)(n.p,{children:["If you wish to run Dashy from a sub page (e.g. ",(0,r.jsx)(n.code,{children:"example.com/dashy"}),"), then just set the ",(0,r.jsx)(n.code,{children:"BASE_URL"})," environmental variable to that page name (in this example, ",(0,r.jsx)(n.code,{children:"/dashy"}),"), before building the app, and the path to all assets will then resolve to the new path, instead of ",(0,r.jsx)(n.code,{children:"./"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"However, since Dashy is just a static web application, it can be served with whatever server you like. The following section outlines how you can configure a web server."}),"\n",(0,r.jsxs)(n.p,{children:["Note, that if you choose not to use ",(0,r.jsx)(n.code,{children:"server.js"})," to serve up the app, you will loose access to the following features:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Loading page, while the app is building"}),"\n",(0,r.jsx)(n.li,{children:"Writing config file to disk from the UI"}),"\n",(0,r.jsx)(n.li,{children:"Website status indicators, and ping checks"}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Example Configs"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nginx",children:"NGINX"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#apache",children:"Apache"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#caddy",children:"Caddy"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#firebase-hosting",children:"Firebase"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cpanel",children:"cPanel"})}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"nginx-1",children:"NGINX"}),"\n",(0,r.jsxs)(n.p,{children:["Create a new file in ",(0,r.jsx)(n.code,{children:"/etc/nginx/sites-enabled/dashy"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"server {\n\tlisten 8080;\n\tlisten [::]:8080;\n\n\troot /var/www/dashy/html;\n\tindex index.html;\n\n\tserver_name your-domain.com www.your-domain.com;\n\n\tlocation / {\n\t\ttry_files $uri $uri/ =404;\n\t}\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["To use HTML5 history mode (",(0,r.jsx)(n.code,{children:"appConfig.routingMode: history"}),"), replace the inside of the location block with: ",(0,r.jsx)(n.code,{children:"try_files $uri $uri/ /index.html;"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Then upload the build contents of Dashy's dist directory to that location.\nFor example: ",(0,r.jsx)(n.code,{children:"scp -r ./dist/* [username]@[server_ip]:/var/www/dashy/html"})]}),"\n",(0,r.jsx)(n.h3,{id:"apache-1",children:"Apache"}),"\n",(0,r.jsxs)(n.p,{children:["Copy Dashy's dist folder to your apache server, ",(0,r.jsx)(n.code,{children:"sudo cp -r ./dashy/dist /var/www/html/dashy"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["In your Apache config, ",(0,r.jsx)(n.code,{children:"/etc/apche2/apache2.conf"})," add:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"\n\tOptions Indexes FollowSymLinks\n\tAllowOverride All\n\tRequire all granted\n\n\n\n RewriteEngine On\n RewriteBase /\n RewriteRule ^index\\.html$ - [L]\n RewriteCond %{REQUEST_FILENAME} !-f\n RewriteCond %{REQUEST_FILENAME} !-d\n RewriteRule . /index.html [L]\n\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Add a ",(0,r.jsx)(n.code,{children:".htaccess"})," file within ",(0,r.jsx)(n.code,{children:"/var/www/html/dashy/.htaccess"}),", and add:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"Options -MultiViews\nRewriteEngine On\nRewriteCond %{REQUEST_FILENAME} !-f\nRewriteRule ^ index.html [QSA,L]\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Then restart Apache, with ",(0,r.jsx)(n.code,{children:"sudo systemctl restart apache2"})]}),"\n",(0,r.jsx)(n.h3,{id:"caddy-1",children:"Caddy"}),"\n",(0,r.jsx)(n.p,{children:"Caddy v2"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"try_files {path} /\n"})}),"\n",(0,r.jsx)(n.p,{children:"Caddy v1"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"rewrite {\n regexp .*\n to {path} /\n}\n"})}),"\n",(0,r.jsx)(n.h3,{id:"firebase-hosting",children:"Firebase Hosting"}),"\n",(0,r.jsxs)(n.p,{children:["Create a file names ",(0,r.jsx)(n.code,{children:"firebase.json"}),", and populate it with something similar to:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:'{\n "hosting": {\n "public": "dist",\n "rewrites": [\n {\n "source": "**",\n "destination": "/index.html"\n }\n ]\n }\n}\n'})}),"\n",(0,r.jsx)(n.h3,{id:"cpanel",children:"cPanel"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:"Login to your WHM"}),"\n",(0,r.jsx)(n.li,{children:"Open 'Feature Manager' on the left sidebar"}),"\n",(0,r.jsx)(n.li,{children:"Under 'Manage feature list', click 'Edit'"}),"\n",(0,r.jsx)(n.li,{children:"Find 'Application manager' in the list, enable it and hit 'Save'"}),"\n",(0,r.jsx)(n.li,{children:"Log into your users cPanel account, and under 'Software' find 'Application Manager'"}),"\n",(0,r.jsx)(n.li,{children:"Click 'Register Application', fill in the form using the path that Dashy is located, and choose a domain, and hit 'Save'"}),"\n",(0,r.jsx)(n.li,{children:"The application should now show up in the list, click 'Ensure dependencies', and move the toggle switch to 'Enabled'"}),"\n",(0,r.jsx)(n.li,{children:"If you need to change the port, click 'Add environmental variable', give it the name 'PORT', choose a port number and press 'Save'."}),"\n",(0,r.jsx)(n.li,{children:"Dashy should now be running at your selected path an on a given port"}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"running-a-modified-version-of-the-app",children:"Running a Modified Version of the App"}),"\n",(0,r.jsx)(n.p,{children:"If you'd like to make any code changes to the app, and deploy your modified version, this section briefly explains how."}),"\n",(0,r.jsxs)(n.p,{children:["The first step is to fork the project on GitHub, and clone it to your local system. Next, install the dependencies (",(0,r.jsx)(n.code,{children:"yarn"}),"), and start the development server (",(0,r.jsx)(n.code,{children:"yarn dev"}),") and visit ",(0,r.jsx)(n.code,{children:"localhost:8080"})," in your browser. You can then make changes to the codebase, and see the live app update in real-time. Once you've finished, running ",(0,r.jsx)(n.code,{children:"yarn build"})," will build the app for production, and output the assets into ",(0,r.jsx)(n.code,{children:"./dist"})," which can then be deployed using a web server, CDN or the built-in Node server with ",(0,r.jsx)(n.code,{children:"yarn start"}),". For more info on all of this, take a look at the ",(0,r.jsx)(n.a,{href:"/docs/developing",children:"Developing Docs"}),". To build your own Docker container from the modified app, see ",(0,r.jsx)(n.a,{href:"#building-your-own-container",children:"Building your Own Container"})]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"building-your-own-container",children:"Building your Own Container"}),"\n",(0,r.jsx)(n.p,{children:"Similar to above, you'll first need to fork and clone Dashy to your local system, and then install dependencies."}),"\n",(0,r.jsxs)(n.p,{children:["Then, either use Dashy's default ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/Dockerfile",children:(0,r.jsx)(n.code,{children:"Dockerfile"})})," as is, or modify it according to your needs."]}),"\n",(0,r.jsxs)(n.p,{children:["To build and deploy locally, first build the app with: ",(0,r.jsx)(n.code,{children:"docker build -t dashy ."}),", and then start the app with ",(0,r.jsx)(n.code,{children:"docker run -p 8080:8080 --name my-dashboard dashy"}),". Or modify the ",(0,r.jsx)(n.code,{children:"docker-compose.yml"})," file, replacing ",(0,r.jsx)(n.code,{children:"image: lissy93/dashy"})," with ",(0,r.jsx)(n.code,{children:"build: ."})," and run ",(0,r.jsx)(n.code,{children:"docker compose up"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Your container should now be running, and will appear in the list when you run ",(0,r.jsx)(n.code,{children:"docker container ls \u2013a"}),". If you'd like to enter the container, run ",(0,r.jsx)(n.code,{children:"docker exec -it [container-id] /bin/ash"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["You may wish to upload your image to a container registry for easier access. Note that if you choose to do this on a public registry, please name your container something other than just 'dashy', to avoid confusion with the official image.\nYou can push your build image, by running: ",(0,r.jsx)(n.code,{children:"docker push ghcr.io/OWNER/IMAGE_NAME:latest"}),". You will first need to authenticate, this can be done by running ",(0,r.jsx)(n.code,{children:"echo $CR_PAT | docker login ghcr.io -u USERNAME --password-stdin"}),", where ",(0,r.jsx)(n.code,{children:"CR_PAT"})," is an environmental variable containing a token generated from your GitHub account. For more info, see the ",(0,r.jsx)(n.a,{href:"https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry",children:"Container Registry Docs"}),"."]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,r.jsx)(n.hr,{})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453(e,n,s){s.d(n,{R:()=>t,x:()=>a});var i=s(6540);const r={},o=i.createContext(r);function t(e){const n=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2140bf91.1cea2d64.js b/assets/js/2140bf91.3066fb7b.js similarity index 98% rename from assets/js/2140bf91.1cea2d64.js rename to assets/js/2140bf91.3066fb7b.js index 774abdd2..26ea0001 100644 --- a/assets/js/2140bf91.1cea2d64.js +++ b/assets/js/2140bf91.3066fb7b.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[146],{9327(e,t,n){n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"pages-and-sections","title":"Pages and Sections","description":"Multi-Page Support","source":"@site/docs/pages-and-sections.md","sourceDirName":".","slug":"/pages-and-sections","permalink":"/docs/pages-and-sections","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/pages-and-sections.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Cloud Backup and Restore","permalink":"/docs/backup-restore"},"next":{"title":"*Dashy Showcase* \ud83c\udf1f","permalink":"/docs/showcase"}}');var a=n(4848),i=n(8453);const o={},r="Pages and Sections",l={},c=[{value:"Multi-Page Support",id:"multi-page-support",level:2},{value:"Using Local Sub-Pages",id:"using-local-sub-pages",level:3},{value:"Using Remote Sub-Pages",id:"using-remote-sub-pages",level:3},{value:"Restrictions",id:"restrictions",level:3},{value:"Sub-Items",id:"sub-items",level:2}];function h(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",img:"img",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"pages-and-sections",children:"Pages and Sections"})}),"\n",(0,a.jsx)(t.h2,{id:"multi-page-support",children:"Multi-Page Support"}),"\n",(0,a.jsx)(t.p,{children:"You can have additional pages within your dashboard, with each having it's own config file. The config files for sub-pages can either be stored locally, or hosted separately. A link to each additional page will be displayed in the navigation bar."}),"\n",(0,a.jsx)(t.p,{children:"You can edit additional pages using the interactive editor, exactly the same was as your primary page (so long as it's local). But please save changes to one page, before you start editing the next."}),"\n",(0,a.jsx)(t.h3,{id:"using-local-sub-pages",children:"Using Local Sub-Pages"}),"\n",(0,a.jsxs)(t.p,{children:["To get started, create a new ",(0,a.jsx)(t.code,{children:".yml"})," config file for your sub-page, placing it within ",(0,a.jsx)(t.code,{children:"/app/user-data"}),". Then within your primary ",(0,a.jsx)(t.code,{children:"conf.yml"}),", choose a name, and specify the path to the new file."]}),"\n",(0,a.jsx)(t.p,{children:"This is an example. Make sure to add this to the topmost line above appConfig:, or anywhere else appropriately, to match the yml syntax."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",children:"pages:\n- name: Networking Services\n path: 'networking.yml'\n- name: Work Stuff\n path: 'work.yml'\n"})}),"\n",(0,a.jsxs)(t.p,{children:["The next step is to create the new page, if you mounted ",(0,a.jsx)(t.code,{children:"/app/user-data"})," in the docker command and not a volume, you can simply create the new page into that folder on the host."]}),"\n",(0,a.jsxs)(t.p,{children:["If you mounted ",(0,a.jsx)(t.code,{children:"/app/user-data/conf.yml"})," in docker, you can either switch to the volume or create another bind mount to your new additional page."]}),"\n",(0,a.jsxs)(t.p,{children:["If you're sub-page is located within ",(0,a.jsx)(t.code,{children:"/app/user-data"}),", then you only need to specify the filename, but if it's anywhere else, then the full path is required."]}),"\n",(0,a.jsxs)(t.p,{children:["A default template a page can be found here: ",(0,a.jsx)(t.a,{href:"https://github.com/lissy93/dashy/blob/master/user-data/conf.yml",children:"https://github.com/lissy93/dashy/blob/master/user-data/conf.yml"})," Keep in mind the appConfig cannot be used on subpages and should be removed, for further info see ",(0,a.jsx)(t.a,{href:"#restrictions",children:"Restrictions"})]}),"\n",(0,a.jsx)(t.p,{children:"The last very important step is to rebuild dashy, this can be easily done through to UI, by opening the settings menu on the top right, navigato to update config and then recompile application."}),"\n",(0,a.jsx)(t.p,{children:"Now if you reload the page, on the top right there should be a new button to navigate to the new page. \ud83c\udf89"}),"\n",(0,a.jsx)(t.h3,{id:"using-remote-sub-pages",children:"Using Remote Sub-Pages"}),"\n",(0,a.jsx)(t.p,{children:"Config files don't need to be local, you can store them anywhere, and data will be imported as sub-pages on page load."}),"\n",(0,a.jsx)(t.p,{children:"For example:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",children:"pages:\n- name: Getting Started\n path: 'https://snippet.host/tvcw/raw'\n- name: Homelab\n path: 'https://snippet.host/tetp/raw'\n- name: Browser Startpage\n path: 'https://snippet.host/zcom/raw'\n"})}),"\n",(0,a.jsxs)(t.p,{children:["There are many options of how this can be used. You could store your config within a Git repository, in order to easily track and rollback changes. Or host your config on your NAS, to have it backed up with the rest of your files. Or use a hosted paste service, for example ",(0,a.jsx)(t.a,{href:"https://snippet.host/",children:"snippet.host"}),", which supports never-expiring CORS-enabled pastes, which can also be edited later."]}),"\n",(0,a.jsx)(t.p,{children:"You will obviously not be able to write updates to remote configs directly through the UI editor, but you can still make and preview changes, then use the export menu to get a copy of the new config, which can then be pasted to the remote source manually.\nThe config file must, of course be accessible from within Dashy. If your config contains sensitive info (like API keys, credentials, secret URLs, etc), take care not to expose it to the internet."}),"\n",(0,a.jsxs)(t.p,{children:["The following example shows creating a config, publishing it as a ",(0,a.jsx)(t.a,{href:"https://gist.github.com/",children:"Gist"}),", copying the URL to the raw file, and using it within your dashboard."]}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.img,{width:"700",alt:"Public config in a gist demo",src:"https://i.ibb.co/55jm3LG/how-to-use-remote-config-sub-page.gif"})}),"\n",(0,a.jsx)(t.h3,{id:"restrictions",children:"Restrictions"}),"\n",(0,a.jsxs)(t.p,{children:["Only top-level fields supported by sub-pages are ",(0,a.jsx)(t.code,{children:"pageInfo"})," and ",(0,a.jsx)(t.code,{children:"sections"}),". The ",(0,a.jsx)(t.code,{children:"appConfig"})," and ",(0,a.jsx)(t.code,{children:"pages"})," will always be inherited from your main ",(0,a.jsx)(t.code,{children:"conf.yml"})," file. Other than that, sub-pages behave exactly the same as your default view, and can contain sections, items, widgets and page info like nav links, title and logo."]}),"\n",(0,a.jsxs)(t.p,{children:["Note that since page paths are required by the router, they are set at build-time, not run-time, and so a rebuild (happens automatically) is required for changes to page paths to take effect (this only applies to changes to the ",(0,a.jsx)(t.code,{children:"pages"})," array, rebuild isn't required for editing page content)."]}),"\n",(0,a.jsx)(t.h2,{id:"sub-items",children:"Sub-Items"}),"\n",(0,a.jsx)(t.p,{children:"A normal section will contain zero or more items, for example:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",children:"- name: Coding\n icon: far fa-code\n items:\n - title: GitHub\n url: https://github.com/\n - title: StackOverflow\n url: http://stackoverflow.com/\n"})}),"\n",(0,a.jsx)(t.p,{children:"But items can also be grouped together, referred to as sub-items. This is useful for a group of less frequently used items, which you don't want to take up too much space."}),"\n",(0,a.jsx)(t.p,{children:"Item groups may also have an optional title."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",children:"- name: Coding\n icon: far fa-code\n items:\n - title: Normal Item 1\n - title: Normal Item 2\n - subItems:\n - title: JavaScript\n url: https://developer.mozilla.org\n icon: si-javascript\n - title: TypeScript\n url: https://www.typescriptlang.org/docs\n icon: si-typescript\n - title: Svelt\n url: https://svelte.dev/docs\n icon: si-svelte\n - title: Go\n url: https://go.dev/doc\n icon: si-go\n"})})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}},8453(e,t,n){n.d(t,{R:()=>o,x:()=>r});var s=n(6540);const a={},i=s.createContext(a);function o(e){const t=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[146],{9327(e,t,n){n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"pages-and-sections","title":"Pages and Sections","description":"Multi-Page Support","source":"@site/docs/pages-and-sections.md","sourceDirName":".","slug":"/pages-and-sections","permalink":"/docs/pages-and-sections","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/pages-and-sections.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Cloud Backup and Restore","permalink":"/docs/backup-restore"},"next":{"title":"*Dashy Showcase* \ud83c\udf1f","permalink":"/docs/showcase"}}');var a=n(4848),i=n(8453);const o={},r="Pages and Sections",l={},c=[{value:"Multi-Page Support",id:"multi-page-support",level:2},{value:"Using Local Sub-Pages",id:"using-local-sub-pages",level:3},{value:"Using Remote Sub-Pages",id:"using-remote-sub-pages",level:3},{value:"Restrictions",id:"restrictions",level:3},{value:"Sub-Items",id:"sub-items",level:2}];function h(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",img:"img",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"pages-and-sections",children:"Pages and Sections"})}),"\n",(0,a.jsx)(t.h2,{id:"multi-page-support",children:"Multi-Page Support"}),"\n",(0,a.jsx)(t.p,{children:"You can have additional pages within your dashboard, with each having it's own config file. The config files for sub-pages can either be stored locally, or hosted separately. A link to each additional page will be displayed in the navigation bar."}),"\n",(0,a.jsx)(t.p,{children:"You can edit additional pages using the interactive editor, exactly the same was as your primary page (so long as it's local). But please save changes to one page, before you start editing the next."}),"\n",(0,a.jsx)(t.h3,{id:"using-local-sub-pages",children:"Using Local Sub-Pages"}),"\n",(0,a.jsxs)(t.p,{children:["To get started, create a new ",(0,a.jsx)(t.code,{children:".yml"})," config file for your sub-page, placing it within ",(0,a.jsx)(t.code,{children:"/app/user-data"}),". Then within your primary ",(0,a.jsx)(t.code,{children:"conf.yml"}),", choose a name, and specify the path to the new file."]}),"\n",(0,a.jsx)(t.p,{children:"This is an example. Make sure to add this to the topmost line above appConfig:, or anywhere else appropriately, to match the yml syntax."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",children:"pages:\n- name: Networking Services\n path: 'networking.yml'\n- name: Work Stuff\n path: 'work.yml'\n"})}),"\n",(0,a.jsxs)(t.p,{children:["The next step is to create the new page, if you mounted ",(0,a.jsx)(t.code,{children:"/app/user-data"})," in the docker command and not a volume, you can simply create the new page into that folder on the host."]}),"\n",(0,a.jsxs)(t.p,{children:["If you mounted ",(0,a.jsx)(t.code,{children:"/app/user-data/conf.yml"})," in docker, you can either switch to the volume or create another bind mount to your new additional page."]}),"\n",(0,a.jsxs)(t.p,{children:["If you're sub-page is located within ",(0,a.jsx)(t.code,{children:"/app/user-data"}),", then you only need to specify the filename, but if it's anywhere else, then the full path is required."]}),"\n",(0,a.jsxs)(t.p,{children:["A default template a page can be found here: ",(0,a.jsx)(t.a,{href:"https://github.com/lissy93/dashy/blob/master/user-data/conf.yml",children:"https://github.com/lissy93/dashy/blob/master/user-data/conf.yml"})," Keep in mind the appConfig cannot be used on subpages and should be removed, for further info see ",(0,a.jsx)(t.a,{href:"#restrictions",children:"Restrictions"})]}),"\n",(0,a.jsx)(t.p,{children:"The last very important step is to rebuild dashy, this can be easily done through to UI, by opening the settings menu on the top right, navigato to update config and then recompile application."}),"\n",(0,a.jsx)(t.p,{children:"Now if you reload the page, on the top right there should be a new button to navigate to the new page. \ud83c\udf89"}),"\n",(0,a.jsx)(t.h3,{id:"using-remote-sub-pages",children:"Using Remote Sub-Pages"}),"\n",(0,a.jsx)(t.p,{children:"Config files don't need to be local, you can store them anywhere, and data will be imported as sub-pages on page load."}),"\n",(0,a.jsx)(t.p,{children:"For example:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",children:"pages:\n- name: Getting Started\n path: 'https://snippet.host/tvcw/raw'\n- name: Homelab\n path: 'https://snippet.host/tetp/raw'\n- name: Browser Startpage\n path: 'https://snippet.host/zcom/raw'\n"})}),"\n",(0,a.jsxs)(t.p,{children:["There are many options of how this can be used. You could store your config within a Git repository, in order to easily track and rollback changes. Or host your config on your NAS, to have it backed up with the rest of your files. Or use a hosted paste service, for example ",(0,a.jsx)(t.a,{href:"https://snippet.host/",children:"snippet.host"}),", which supports never-expiring CORS-enabled pastes, which can also be edited later."]}),"\n",(0,a.jsx)(t.p,{children:"You will obviously not be able to write updates to remote configs directly through the UI editor, but you can still make and preview changes, then use the export menu to get a copy of the new config, which can then be pasted to the remote source manually.\nThe config file must, of course be accessible from within Dashy. If your config contains sensitive info (like API keys, credentials, secret URLs, etc), take care not to expose it to the internet."}),"\n",(0,a.jsxs)(t.p,{children:["The following example shows creating a config, publishing it as a ",(0,a.jsx)(t.a,{href:"https://gist.github.com/",children:"Gist"}),", copying the URL to the raw file, and using it within your dashboard."]}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.img,{width:"700",alt:"Public config in a gist demo",src:"https://i.ibb.co/55jm3LG/how-to-use-remote-config-sub-page.gif"})}),"\n",(0,a.jsx)(t.h3,{id:"restrictions",children:"Restrictions"}),"\n",(0,a.jsxs)(t.p,{children:["Only top-level fields supported by sub-pages are ",(0,a.jsx)(t.code,{children:"pageInfo"})," and ",(0,a.jsx)(t.code,{children:"sections"}),". The ",(0,a.jsx)(t.code,{children:"appConfig"})," and ",(0,a.jsx)(t.code,{children:"pages"})," will always be inherited from your main ",(0,a.jsx)(t.code,{children:"conf.yml"})," file. Other than that, sub-pages behave exactly the same as your default view, and can contain sections, items, widgets and page info like nav links, title and logo."]}),"\n",(0,a.jsxs)(t.p,{children:["Note that since page paths are required by the router, they are set at build-time, not run-time, and so a rebuild (happens automatically) is required for changes to page paths to take effect (this only applies to changes to the ",(0,a.jsx)(t.code,{children:"pages"})," array, rebuild isn't required for editing page content)."]}),"\n",(0,a.jsx)(t.h2,{id:"sub-items",children:"Sub-Items"}),"\n",(0,a.jsx)(t.p,{children:"A normal section will contain zero or more items, for example:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",children:"- name: Coding\n icon: far fa-code\n items:\n - title: GitHub\n url: https://github.com/\n - title: StackOverflow\n url: http://stackoverflow.com/\n"})}),"\n",(0,a.jsx)(t.p,{children:"But items can also be grouped together, referred to as sub-items. This is useful for a group of less frequently used items, which you don't want to take up too much space."}),"\n",(0,a.jsx)(t.p,{children:"Item groups may also have an optional title."}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",children:"- name: Coding\n icon: far fa-code\n items:\n - title: Normal Item 1\n - title: Normal Item 2\n - subItems:\n - title: JavaScript\n url: https://developer.mozilla.org\n icon: si-javascript\n - title: TypeScript\n url: https://www.typescriptlang.org/docs\n icon: si-typescript\n - title: Svelt\n url: https://svelte.dev/docs\n icon: si-svelte\n - title: Go\n url: https://go.dev/doc\n icon: si-go\n"})})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}},8453(e,t,n){n.d(t,{R:()=>o,x:()=>r});var s=n(6540);const a={},i=s.createContext(a);function o(e){const t=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/27d9d47d.d2a1ca23.js b/assets/js/27d9d47d.546f465c.js similarity index 99% rename from assets/js/27d9d47d.d2a1ca23.js rename to assets/js/27d9d47d.546f465c.js index 122cf4a9..0e515b2d 100644 --- a/assets/js/27d9d47d.d2a1ca23.js +++ b/assets/js/27d9d47d.546f465c.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[9757],{7177(s,e,n){n.r(e),n.d(e,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"showcase","title":"*Dashy Showcase* \ud83c\udf1f","description":"| \ud83d\udc97 Got a sweet dashboard? Submit it to the showcase! \ud83d\udc49 See How |","source":"@site/docs/showcase.md","sourceDirName":".","slug":"/showcase","permalink":"/docs/showcase","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/showcase.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Pages and Sections","permalink":"/docs/pages-and-sections"},"next":{"title":"Contributing","permalink":"/docs/contributing"}}');var h=n(4848),t=n(8453);const i={},a="Dashy Showcase \ud83c\udf1f",o={},d=[{value:"MNDashboard",id:"mndashboard",level:2},{value:"Home Lab 2.0",id:"home-lab-20",level:2},{value:"Dipan's Dash",id:"dipans-dash",level:2},{value:"Ratty222",id:"ratty222",level:2},{value:"Hugalafutro Dashy",id:"hugalafutro-dashy",level:2},{value:"NAS Home Dashboard",id:"nas-home-dashboard",level:2},{value:"Brewhack",id:"brewhack",level:2},{value:"The Dragons Lair",id:"the-dragons-lair",level:2},{value:"Homelab & VPS dashboard",id:"homelab--vps-dashboard",level:2},{value:"Raspberry PI Docker Dashboard",id:"raspberry-pi-docker-dashboard",level:2},{value:"First Week of Self-Hosting",id:"first-week-of-self-hosting",level:2},{value:"EVO Dashboard",id:"evo-dashboard",level:2},{value:"The Private Dashboard",id:"the-private-dashboard",level:2},{value:"Networking Services",id:"networking-services",level:2},{value:"Dashy Live",id:"dashy-live",level:2},{value:"System Monitor",id:"system-monitor",level:2},{value:"Browser Startpage",id:"browser-startpage",level:2},{value:"CFT Toolbox",id:"cft-toolbox",level:2},{value:"Bookmarks",id:"bookmarks",level:2},{value:"Project Management",id:"project-management",level:2},{value:"Dashy Example",id:"dashy-example",level:2},{value:"HomeLAb 3.0",id:"homelab-30",level:2},{value:"Ground Control",id:"ground-control",level:2},{value:"Croco_Grievous",id:"croco_grievous",level:2},{value:"Crypto Dash",id:"crypto-dash",level:2},{value:"Stefantigro",id:"stefantigro",level:2},{value:"Morning Dashboard",id:"morning-dashboard",level:2},{value:"Yet Another Homelab",id:"yet-another-homelab",level:2},{value:"Submitting your Dashboard",id:"submitting-your-dashboard",level:2},{value:"How to Submit",id:"how-to-submit",level:3},{value:"What to Include",id:"what-to-include",level:3},{value:"Template",id:"template",level:3}];function c(s){const e={a:"a",blockquote:"blockquote",br:"br",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",li:"li",p:"p",pre:"pre",sup:"sup",table:"table",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.R)(),...s.components};return(0,h.jsxs)(h.Fragment,{children:[(0,h.jsx)(e.header,{children:(0,h.jsxs)(e.h1,{id:"dashy-showcase-",children:[(0,h.jsx)(e.em,{children:"Dashy Showcase"})," \ud83c\udf1f"]})}),"\n\n\n\n\n\n\n",(0,h.jsx)(e.table,{children:(0,h.jsx)(e.thead,{children:(0,h.jsx)(e.tr,{children:(0,h.jsxs)(e.th,{children:["\ud83d\udc97 Got a sweet dashboard? Submit it to the showcase! \ud83d\udc49 ",(0,h.jsx)(e.a,{href:"#submitting-your-dashboard",children:"See How"})]})})})}),"\n",(0,h.jsx)(e.h2,{id:"mndashboard",children:"MNDashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/mahrnet",children:"@mahrnet"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/1491",children:"#1491"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/mCJRZgp/d2-At-QO4c-PT4u.png",alt:"screenshot-MNDashboard"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"home-lab-20",children:"Home Lab 2.0"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png",alt:"screenshot-homelab"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"dipans-dash",children:"Dipan's Dash"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/dipanghosh",children:"@Dipanghosh"})," - ",(0,h.jsx)(e.a,{href:"https://dipan.de/",children:"dipan.de"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/discussions/777",children:"#777"})]})]}),"\n"]}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["With the option of embedding iframes, it becomes possible to combine and conquer. I have set up Dashy to include graphs from grafana, and set them so that they update automatically. I also have uptime monitors from uptime Kuma, panels from homeassistant are also possible to be included.",(0,h.jsx)(e.br,{}),"\nDashy is awesome!"]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/bPC6w2n/dipanghosh-dashboard.png",alt:"screenshot-dipanghosh-dashboard"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"ratty222",children:"Ratty222"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/ratty222",children:"@ratty222"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/discussions/384",children:"#384"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://user-images.githubusercontent.com/1862727/147582551-4c655d37-8bcc-4f95-ab41-164a9d0d6a07.png",alt:"screenshot-ratty222-dashy"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"hugalafutro-dashy",children:"Hugalafutro Dashy"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/hugalafutro",children:"@hugalafutro"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/discussions/505",children:"#505"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.a,{href:"https://i.ibb.co/PDpLDKS/hugalafutro-dashy.gif",children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/PDpLDKS/hugalafutro-dashy.gif",alt:"hugalafutro-dashy-screenshot"})})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"nas-home-dashboard",children:"NAS Home Dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/cerealconyogurt",children:"@cerealconyogurt"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/74",children:"#74"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/6-nas-home-dashboard.png",alt:"screenshot-networking-services"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"brewhack",children:"Brewhack"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/brpeterso",children:"@brpeterso"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/680",children:"#680"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/cNjzPT4/brewhack.png",alt:"screenshot-brewhack-dashboard"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"the-dragons-lair",children:"The Dragons Lair"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/dr460nf1r3",children:"dr460nf1r3"})," ",(0,h.jsxs)(e.sup,{children:["via ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/684",children:"#684"})]})]}),"\n"]}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsx)(e.p,{children:"My new startpage featuring the stuff I use most. And of course dragons!"}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/13-dragons-lair.png",alt:"screenshot-dragons-lair"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"homelab--vps-dashboard",children:"Homelab & VPS dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/shadowking001",children:"@shadowking001"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/86",children:"#86"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/8-shadowking001s-dashy.png",alt:"screenshot-shadowking001-dashy"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"raspberry-pi-docker-dashboard",children:"Raspberry PI Docker Dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/henkiewie",children:"@henkiewie"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/622",children:"#622"})]})]}),"\n"]}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["I use this dashboard every day. It now even includes a player for a radio stream which I configured with Logitech media server and icecast. I made an smaller version of the grafana dashboard to fit an iframe in kiosk mode, so it monitors the most important values of my RPI. The PI is in Argon m2 case and used as a NAS. The dashboard is a copy of the adventure theme with some changes saved in ",(0,h.jsx)(e.code,{children:"/app/src/styles/user-defined-themes.scss"})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/jGzPm6b/henkiewie-dashy-showcase.png",alt:"screenshot-henkiewie-dashy"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"first-week-of-self-hosting",children:"First Week of Self-Hosting"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/user/RickyCZ",children:"u//RickyCZ"})," ",(0,h.jsxs)(e.sup,{children:["via ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/r/selfhosted/comments/pose15/just_got_started_a_week_ago_selfhosting_is_very/",children:"Reddit"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/11-ricky-cz.png",alt:"screenshot-week-of-self-hosting"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"evo-dashboard",children:"EVO Dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/EVOTk",children:"@EVOTk"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/pull/316",children:"#316"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/12-evo-dashboard.png",alt:"screenshot-evo-dashboard"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"the-private-dashboard",children:"The Private Dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/DylanBeMe",children:"@DylanBeMe"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/419",children:"#419"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/hKS483T/private-dashboard-Dylan-Be-Me.png",alt:"screenshot-private-dashboard"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"networking-services",children:"Networking Services"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/lissy93",children:"@Lissy93"})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/2-networking-services-minimal-dark.png",alt:"screenshot-networking-services"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"dashy-live",children:"Dashy Live"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/lissy93",children:"@Lissy93"})]}),"\n"]}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["A dashboard I made to manage all project development links from one place. View demo at ",(0,h.jsx)(e.a,{href:"https://live.dashy.to/",children:"live.dashy.to"}),"."]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/10-dashy-live.png",alt:"screenshot-dashy-live"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"system-monitor",children:"System Monitor"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsx)(e.p,{children:"An aggregated board for monitoring system resource usage from a single view"}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/xfK6BGb/system-monitor-board.png",alt:"screenshot-monitor"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"browser-startpage",children:"Browser Startpage"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/rs07dS1/startpage.png",alt:"screenshot-startpage"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"cft-toolbox",children:"CFT Toolbox"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/3-cft-toolbox.png",alt:"screenshot-cft-toolbox"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"bookmarks",children:"Bookmarks"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/4-bookmarks-colourful.png",alt:"screenshot-bookmarks"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"project-management",children:"Project Management"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/5-project-management.png",alt:"screenshot-project-management"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"dashy-example",children:"Dashy Example"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["An example dashboard, by ",(0,h.jsx)(e.a,{href:"https://github.com/lissy93",children:"@Lissy93"}),". View live at ",(0,h.jsx)(e.a,{href:"https://demo.dashy.to/",children:"demo.dashy.to"}),"."]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/YbzqPK7/demo-dashy.png",alt:"screenshot-dashy-example"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"homelab-30",children:"HomeLAb 3.0"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/skoogee",children:"@skoogee"})," (",(0,h.jsx)(e.a,{href:"http://zhrn.cc",children:"http://zhrn.cc"}),") ",(0,h.jsx)(e.sup,{children:(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/279",children:"#279"})})]}),"\n"]}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsx)(e.p,{children:"Dashy, is the most complete dashboard I ever tried, has all the features, and it sets itself apart from the rest. It is my default homepage now. I am thankful to the developer @Lissy93 for sharing such a wonderful creation."}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.a,{href:"https://ibb.co/album/ynSwzm",children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/F5yBTsT/12-skoogee-homelab-3.png?",alt:"screenshot-12-skoogee-homelab-3"})})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"ground-control",children:"Ground Control"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/dtctek",children:"@dtctek"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/83",children:"#83"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://user-images.githubusercontent.com/1862727/149821995-e9b41dab-186c-42e6-b5b3-e233259b241d.png",alt:"screenshot-ground-control"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"croco_grievous",children:"Croco_Grievous"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/user/Croco_Grievous/",children:"u/Croco_Grievous"})," ",(0,h.jsxs)(e.sup,{children:["via ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/r/selfhosted/comments/t4xk3z/everything_started_with_pihole_on_a_raspberry_pi/",children:"reddit"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/59XR8KL/dashy-Croco-Grievous.png",alt:"screenshot-croco-grievous-dashy"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"crypto-dash",children:"Crypto Dash"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["Example usage of widgets to monitor cryptocurrencies news, prices and data. Config is ",(0,h.jsx)(e.a,{href:"https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10#file-example-8-dashy-crypto-widgets-conf-yml",children:"available here"})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://user-images.githubusercontent.com/1862727/147394584-352fe3bf-740d-4624-a01b-9003a97bc832.png",alt:"screenshot-crypto-dash"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"stefantigro",children:"Stefantigro"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/user/stefantigro/",children:"u/stefantigro"})," ",(0,h.jsxs)(e.sup,{children:["via ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/r/selfhosted/comments/t5oril/been_selfhosting_close_to_half_a_year_now_all/",children:"reddit"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/1Kb43Yy/dashy-stefantigro.png",alt:"screenshot-stefantigro-dashy"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"morning-dashboard",children:"Morning Dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsx)(e.p,{children:"Displayed on my smart screen between 05:00 - 08:00, and includes all the info that I usually check before leaving for work"}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/4Wx8zb7/morning-dashboard.png",alt:"screenshot-morning-dash"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"yet-another-homelab",children:"Yet Another Homelab"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/9-home-lab-oblivion.png",alt:"screenshot-yet-another-homelab"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"submitting-your-dashboard",children:"Submitting your Dashboard"}),"\n",(0,h.jsx)(e.h3,{id:"how-to-submit",children:"How to Submit"}),"\n",(0,h.jsxs)(e.ul,{children:["\n",(0,h.jsx)(e.li,{children:(0,h.jsx)(e.a,{href:"https://git.io/JEtgM",children:"Open an Issue"})}),"\n",(0,h.jsx)(e.li,{children:(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/compare",children:"Open a PR"})}),"\n"]}),"\n",(0,h.jsx)(e.h3,{id:"what-to-include",children:"What to Include"}),"\n",(0,h.jsx)(e.p,{children:"Please include the following information:"}),"\n",(0,h.jsxs)(e.ul,{children:["\n",(0,h.jsx)(e.li,{children:"A single high-quality screenshot of your Dashboard"}),"\n",(0,h.jsx)(e.li,{children:"A short title (it doesn't have to be particularly imaginative)"}),"\n",(0,h.jsx)(e.li,{children:"An optional description, you could include details on anything interesting or unique about your dashboard, or say how you use it, and why it's awesome"}),"\n",(0,h.jsx)(e.li,{children:"Optionally leave your name or username, with a link to your GitHub, Twitter or Website"}),"\n"]}),"\n",(0,h.jsx)(e.h3,{id:"template",children:"Template"}),"\n",(0,h.jsx)(e.p,{children:"If you're submitting a pull request, please use a format similar to this:"}),"\n",(0,h.jsx)(e.pre,{children:(0,h.jsx)(e.code,{className:"language-text",children:"### [Dashboard Name] (required)\n\n> Submitted by [@username](https://github.com/user) (optional)\n\n[An optional text description, or any interesting details] (optional)\n\n![dashboard-screenshot](https://example.com/url-to-screenshot.png) (required)\n\n---\n\n"})})]})}function l(s={}){const{wrapper:e}={...(0,t.R)(),...s.components};return e?(0,h.jsx)(e,{...s,children:(0,h.jsx)(c,{...s})}):c(s)}},8453(s,e,n){n.d(e,{R:()=>i,x:()=>a});var r=n(6540);const h={},t=r.createContext(h);function i(s){const e=r.useContext(t);return r.useMemo(function(){return"function"==typeof s?s(e):{...e,...s}},[e,s])}function a(s){let e;return e=s.disableParentContext?"function"==typeof s.components?s.components(h):s.components||h:i(s.components),r.createElement(t.Provider,{value:e},s.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[9757],{7177(s,e,n){n.r(e),n.d(e,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"showcase","title":"*Dashy Showcase* \ud83c\udf1f","description":"| \ud83d\udc97 Got a sweet dashboard? Submit it to the showcase! \ud83d\udc49 See How |","source":"@site/docs/showcase.md","sourceDirName":".","slug":"/showcase","permalink":"/docs/showcase","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/showcase.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Pages and Sections","permalink":"/docs/pages-and-sections"},"next":{"title":"Contributing","permalink":"/docs/contributing"}}');var h=n(4848),t=n(8453);const i={},a="Dashy Showcase \ud83c\udf1f",o={},d=[{value:"MNDashboard",id:"mndashboard",level:2},{value:"Home Lab 2.0",id:"home-lab-20",level:2},{value:"Dipan's Dash",id:"dipans-dash",level:2},{value:"Ratty222",id:"ratty222",level:2},{value:"Hugalafutro Dashy",id:"hugalafutro-dashy",level:2},{value:"NAS Home Dashboard",id:"nas-home-dashboard",level:2},{value:"Brewhack",id:"brewhack",level:2},{value:"The Dragons Lair",id:"the-dragons-lair",level:2},{value:"Homelab & VPS dashboard",id:"homelab--vps-dashboard",level:2},{value:"Raspberry PI Docker Dashboard",id:"raspberry-pi-docker-dashboard",level:2},{value:"First Week of Self-Hosting",id:"first-week-of-self-hosting",level:2},{value:"EVO Dashboard",id:"evo-dashboard",level:2},{value:"The Private Dashboard",id:"the-private-dashboard",level:2},{value:"Networking Services",id:"networking-services",level:2},{value:"Dashy Live",id:"dashy-live",level:2},{value:"System Monitor",id:"system-monitor",level:2},{value:"Browser Startpage",id:"browser-startpage",level:2},{value:"CFT Toolbox",id:"cft-toolbox",level:2},{value:"Bookmarks",id:"bookmarks",level:2},{value:"Project Management",id:"project-management",level:2},{value:"Dashy Example",id:"dashy-example",level:2},{value:"HomeLAb 3.0",id:"homelab-30",level:2},{value:"Ground Control",id:"ground-control",level:2},{value:"Croco_Grievous",id:"croco_grievous",level:2},{value:"Crypto Dash",id:"crypto-dash",level:2},{value:"Stefantigro",id:"stefantigro",level:2},{value:"Morning Dashboard",id:"morning-dashboard",level:2},{value:"Yet Another Homelab",id:"yet-another-homelab",level:2},{value:"Submitting your Dashboard",id:"submitting-your-dashboard",level:2},{value:"How to Submit",id:"how-to-submit",level:3},{value:"What to Include",id:"what-to-include",level:3},{value:"Template",id:"template",level:3}];function c(s){const e={a:"a",blockquote:"blockquote",br:"br",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",li:"li",p:"p",pre:"pre",sup:"sup",table:"table",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.R)(),...s.components};return(0,h.jsxs)(h.Fragment,{children:[(0,h.jsx)(e.header,{children:(0,h.jsxs)(e.h1,{id:"dashy-showcase-",children:[(0,h.jsx)(e.em,{children:"Dashy Showcase"})," \ud83c\udf1f"]})}),"\n\n\n\n\n\n\n",(0,h.jsx)(e.table,{children:(0,h.jsx)(e.thead,{children:(0,h.jsx)(e.tr,{children:(0,h.jsxs)(e.th,{children:["\ud83d\udc97 Got a sweet dashboard? Submit it to the showcase! \ud83d\udc49 ",(0,h.jsx)(e.a,{href:"#submitting-your-dashboard",children:"See How"})]})})})}),"\n",(0,h.jsx)(e.h2,{id:"mndashboard",children:"MNDashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/mahrnet",children:"@mahrnet"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/1491",children:"#1491"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/mCJRZgp/d2-At-QO4c-PT4u.png",alt:"screenshot-MNDashboard"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"home-lab-20",children:"Home Lab 2.0"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png",alt:"screenshot-homelab"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"dipans-dash",children:"Dipan's Dash"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/dipanghosh",children:"@Dipanghosh"})," - ",(0,h.jsx)(e.a,{href:"https://dipan.de/",children:"dipan.de"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/discussions/777",children:"#777"})]})]}),"\n"]}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["With the option of embedding iframes, it becomes possible to combine and conquer. I have set up Dashy to include graphs from grafana, and set them so that they update automatically. I also have uptime monitors from uptime Kuma, panels from homeassistant are also possible to be included.",(0,h.jsx)(e.br,{}),"\nDashy is awesome!"]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/bPC6w2n/dipanghosh-dashboard.png",alt:"screenshot-dipanghosh-dashboard"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"ratty222",children:"Ratty222"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/ratty222",children:"@ratty222"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/discussions/384",children:"#384"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://user-images.githubusercontent.com/1862727/147582551-4c655d37-8bcc-4f95-ab41-164a9d0d6a07.png",alt:"screenshot-ratty222-dashy"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"hugalafutro-dashy",children:"Hugalafutro Dashy"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/hugalafutro",children:"@hugalafutro"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/discussions/505",children:"#505"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.a,{href:"https://i.ibb.co/PDpLDKS/hugalafutro-dashy.gif",children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/PDpLDKS/hugalafutro-dashy.gif",alt:"hugalafutro-dashy-screenshot"})})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"nas-home-dashboard",children:"NAS Home Dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/cerealconyogurt",children:"@cerealconyogurt"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/74",children:"#74"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/6-nas-home-dashboard.png",alt:"screenshot-networking-services"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"brewhack",children:"Brewhack"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/brpeterso",children:"@brpeterso"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/680",children:"#680"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/cNjzPT4/brewhack.png",alt:"screenshot-brewhack-dashboard"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"the-dragons-lair",children:"The Dragons Lair"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/dr460nf1r3",children:"dr460nf1r3"})," ",(0,h.jsxs)(e.sup,{children:["via ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/684",children:"#684"})]})]}),"\n"]}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsx)(e.p,{children:"My new startpage featuring the stuff I use most. And of course dragons!"}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/13-dragons-lair.png",alt:"screenshot-dragons-lair"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"homelab--vps-dashboard",children:"Homelab & VPS dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/shadowking001",children:"@shadowking001"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/86",children:"#86"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/8-shadowking001s-dashy.png",alt:"screenshot-shadowking001-dashy"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"raspberry-pi-docker-dashboard",children:"Raspberry PI Docker Dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/henkiewie",children:"@henkiewie"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/622",children:"#622"})]})]}),"\n"]}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["I use this dashboard every day. It now even includes a player for a radio stream which I configured with Logitech media server and icecast. I made an smaller version of the grafana dashboard to fit an iframe in kiosk mode, so it monitors the most important values of my RPI. The PI is in Argon m2 case and used as a NAS. The dashboard is a copy of the adventure theme with some changes saved in ",(0,h.jsx)(e.code,{children:"/app/src/styles/user-defined-themes.scss"})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/jGzPm6b/henkiewie-dashy-showcase.png",alt:"screenshot-henkiewie-dashy"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"first-week-of-self-hosting",children:"First Week of Self-Hosting"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/user/RickyCZ",children:"u//RickyCZ"})," ",(0,h.jsxs)(e.sup,{children:["via ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/r/selfhosted/comments/pose15/just_got_started_a_week_ago_selfhosting_is_very/",children:"Reddit"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/11-ricky-cz.png",alt:"screenshot-week-of-self-hosting"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"evo-dashboard",children:"EVO Dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/EVOTk",children:"@EVOTk"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/pull/316",children:"#316"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/12-evo-dashboard.png",alt:"screenshot-evo-dashboard"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"the-private-dashboard",children:"The Private Dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/DylanBeMe",children:"@DylanBeMe"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/419",children:"#419"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/hKS483T/private-dashboard-Dylan-Be-Me.png",alt:"screenshot-private-dashboard"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"networking-services",children:"Networking Services"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/lissy93",children:"@Lissy93"})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/2-networking-services-minimal-dark.png",alt:"screenshot-networking-services"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"dashy-live",children:"Dashy Live"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/lissy93",children:"@Lissy93"})]}),"\n"]}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["A dashboard I made to manage all project development links from one place. View demo at ",(0,h.jsx)(e.a,{href:"https://live.dashy.to/",children:"live.dashy.to"}),"."]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/10-dashy-live.png",alt:"screenshot-dashy-live"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"system-monitor",children:"System Monitor"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsx)(e.p,{children:"An aggregated board for monitoring system resource usage from a single view"}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/xfK6BGb/system-monitor-board.png",alt:"screenshot-monitor"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"browser-startpage",children:"Browser Startpage"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/rs07dS1/startpage.png",alt:"screenshot-startpage"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"cft-toolbox",children:"CFT Toolbox"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/3-cft-toolbox.png",alt:"screenshot-cft-toolbox"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"bookmarks",children:"Bookmarks"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/4-bookmarks-colourful.png",alt:"screenshot-bookmarks"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"project-management",children:"Project Management"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/5-project-management.png",alt:"screenshot-project-management"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"dashy-example",children:"Dashy Example"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["An example dashboard, by ",(0,h.jsx)(e.a,{href:"https://github.com/lissy93",children:"@Lissy93"}),". View live at ",(0,h.jsx)(e.a,{href:"https://demo.dashy.to/",children:"demo.dashy.to"}),"."]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/YbzqPK7/demo-dashy.png",alt:"screenshot-dashy-example"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"homelab-30",children:"HomeLAb 3.0"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/skoogee",children:"@skoogee"})," (",(0,h.jsx)(e.a,{href:"http://zhrn.cc",children:"http://zhrn.cc"}),") ",(0,h.jsx)(e.sup,{children:(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/279",children:"#279"})})]}),"\n"]}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsx)(e.p,{children:"Dashy, is the most complete dashboard I ever tried, has all the features, and it sets itself apart from the rest. It is my default homepage now. I am thankful to the developer @Lissy93 for sharing such a wonderful creation."}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.a,{href:"https://ibb.co/album/ynSwzm",children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/F5yBTsT/12-skoogee-homelab-3.png?",alt:"screenshot-12-skoogee-homelab-3"})})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"ground-control",children:"Ground Control"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://github.com/dtctek",children:"@dtctek"})," ",(0,h.jsxs)(e.sup,{children:["Re: ",(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/issues/83",children:"#83"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://user-images.githubusercontent.com/1862727/149821995-e9b41dab-186c-42e6-b5b3-e233259b241d.png",alt:"screenshot-ground-control"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"croco_grievous",children:"Croco_Grievous"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/user/Croco_Grievous/",children:"u/Croco_Grievous"})," ",(0,h.jsxs)(e.sup,{children:["via ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/r/selfhosted/comments/t4xk3z/everything_started_with_pihole_on_a_raspberry_pi/",children:"reddit"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/59XR8KL/dashy-Croco-Grievous.png",alt:"screenshot-croco-grievous-dashy"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"crypto-dash",children:"Crypto Dash"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["Example usage of widgets to monitor cryptocurrencies news, prices and data. Config is ",(0,h.jsx)(e.a,{href:"https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10#file-example-8-dashy-crypto-widgets-conf-yml",children:"available here"})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://user-images.githubusercontent.com/1862727/147394584-352fe3bf-740d-4624-a01b-9003a97bc832.png",alt:"screenshot-crypto-dash"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"stefantigro",children:"Stefantigro"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsxs)(e.p,{children:["By ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/user/stefantigro/",children:"u/stefantigro"})," ",(0,h.jsxs)(e.sup,{children:["via ",(0,h.jsx)(e.a,{href:"https://www.reddit.com/r/selfhosted/comments/t5oril/been_selfhosting_close_to_half_a_year_now_all/",children:"reddit"})]})]}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/1Kb43Yy/dashy-stefantigro.png",alt:"screenshot-stefantigro-dashy"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"morning-dashboard",children:"Morning Dashboard"}),"\n",(0,h.jsxs)(e.blockquote,{children:["\n",(0,h.jsx)(e.p,{children:"Displayed on my smart screen between 05:00 - 08:00, and includes all the info that I usually check before leaving for work"}),"\n"]}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://i.ibb.co/4Wx8zb7/morning-dashboard.png",alt:"screenshot-morning-dash"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"yet-another-homelab",children:"Yet Another Homelab"}),"\n",(0,h.jsx)(e.p,{children:(0,h.jsx)(e.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/9-home-lab-oblivion.png",alt:"screenshot-yet-another-homelab"})}),"\n",(0,h.jsx)(e.hr,{}),"\n",(0,h.jsx)(e.h2,{id:"submitting-your-dashboard",children:"Submitting your Dashboard"}),"\n",(0,h.jsx)(e.h3,{id:"how-to-submit",children:"How to Submit"}),"\n",(0,h.jsxs)(e.ul,{children:["\n",(0,h.jsx)(e.li,{children:(0,h.jsx)(e.a,{href:"https://git.io/JEtgM",children:"Open an Issue"})}),"\n",(0,h.jsx)(e.li,{children:(0,h.jsx)(e.a,{href:"https://github.com/Lissy93/dashy/compare",children:"Open a PR"})}),"\n"]}),"\n",(0,h.jsx)(e.h3,{id:"what-to-include",children:"What to Include"}),"\n",(0,h.jsx)(e.p,{children:"Please include the following information:"}),"\n",(0,h.jsxs)(e.ul,{children:["\n",(0,h.jsx)(e.li,{children:"A single high-quality screenshot of your Dashboard"}),"\n",(0,h.jsx)(e.li,{children:"A short title (it doesn't have to be particularly imaginative)"}),"\n",(0,h.jsx)(e.li,{children:"An optional description, you could include details on anything interesting or unique about your dashboard, or say how you use it, and why it's awesome"}),"\n",(0,h.jsx)(e.li,{children:"Optionally leave your name or username, with a link to your GitHub, Twitter or Website"}),"\n"]}),"\n",(0,h.jsx)(e.h3,{id:"template",children:"Template"}),"\n",(0,h.jsx)(e.p,{children:"If you're submitting a pull request, please use a format similar to this:"}),"\n",(0,h.jsx)(e.pre,{children:(0,h.jsx)(e.code,{className:"language-text",children:"### [Dashboard Name] (required)\n\n> Submitted by [@username](https://github.com/user) (optional)\n\n[An optional text description, or any interesting details] (optional)\n\n![dashboard-screenshot](https://example.com/url-to-screenshot.png) (required)\n\n---\n\n"})})]})}function l(s={}){const{wrapper:e}={...(0,t.R)(),...s.components};return e?(0,h.jsx)(e,{...s,children:(0,h.jsx)(c,{...s})}):c(s)}},8453(s,e,n){n.d(e,{R:()=>i,x:()=>a});var r=n(6540);const h={},t=r.createContext(h);function i(s){const e=r.useContext(t);return r.useMemo(function(){return"function"==typeof s?s(e):{...e,...s}},[e,s])}function a(s){let e;return e=s.disableParentContext?"function"==typeof s.components?s.components(h):s.components||h:i(s.components),r.createElement(t.Provider,{value:e},s.children)}}}]); \ No newline at end of file diff --git a/assets/js/4bdb0d83.c81c4fe7.js b/assets/js/4bdb0d83.cb7325a0.js similarity index 99% rename from assets/js/4bdb0d83.c81c4fe7.js rename to assets/js/4bdb0d83.cb7325a0.js index 2be0ddcd..168a0f38 100644 --- a/assets/js/4bdb0d83.c81c4fe7.js +++ b/assets/js/4bdb0d83.cb7325a0.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[5496],{7395(e,n,s){s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>a,frontMatter:()=>t,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"configuring","title":"Configuring","description":"All app configuration is specified in /user-data/conf.yml which is in YAML Format format. If you\'re using Docker, this file can be passed in as a volume. Changes can either be made directly to this file, or done through the UI. From the UI you can also export, backup, reset, validate and download your configuration file.","source":"@site/docs/configuring.md","sourceDirName":".","slug":"/configuring","permalink":"/docs/configuring","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/configuring.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Deployment","permalink":"/docs/deployment"},"next":{"title":"App Management","permalink":"/docs/management"}}');var d=s(4848),r=s(8453);const t={},c="Configuring",l={},o=[{value:"There are three ways to edit the config",id:"there-are-three-ways-to-edit-the-config",level:2},{value:"Tips",id:"tips",level:2},{value:"Contents",id:"contents",level:2},{value:"Top-Level Fields",id:"top-level-fields",level:2},{value:"PageInfo",id:"pageinfo",level:2},{value:"pageInfo.navLinks (optional)",id:"pageinfonavlinks-optional",level:2},{value:"pages[] (optional)",id:"pages-optional",level:2},{value:"appConfig (optional)",id:"appconfig-optional",level:2},{value:"appConfig.auth (optional)",id:"appconfigauth-optional",level:2},{value:"appConfig.auth.users (optional)",id:"appconfigauthusers-optional",level:2},{value:"appConfig.auth.keycloak (optional)",id:"appconfigauthkeycloak-optional",level:2},{value:"appConfig.auth.headerAuth (optional)",id:"appconfigauthheaderauth-optional",level:2},{value:"appConfig.auth.oidc (optional)",id:"appconfigauthoidc-optional",level:2},{value:"appConfig.webSearch (optional)",id:"appconfigwebsearch-optional",level:2},{value:"appConfig.hideComponents (optional)",id:"appconfighidecomponents-optional",level:2},{value:"section",id:"section",level:2},{value:"section.item",id:"sectionitem",level:2},{value:"item.displayData (optional)",id:"itemdisplaydata-optional",level:2},{value:"section.widgets (optional)",id:"sectionwidgets-optional",level:2},{value:"section.displayData (optional)",id:"sectiondisplaydata-optional",level:2},{value:"section.icon and section.item.icon",id:"sectionicon-and-sectionitemicon",level:2},{value:"section.displayData.hideForKeycloakUsers, section.displayData.showForKeycloakUsers, item.displayData.hideForKeycloakUsers and item.displayData.showForKeycloakUsers",id:"sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers",level:2},{value:"Notes",id:"notes",level:2},{value:"Editing Config through the UI",id:"editing-config-through-the-ui",level:3},{value:"About YAML",id:"about-yaml",level:3},{value:"Config Saving Methods",id:"config-saving-methods",level:3},{value:"Preventing Changes",id:"preventing-changes",level:3},{value:"Example",id:"example",level:3}];function h(e){const n={a:"a",b:"b",blockquote:"blockquote",br:"br",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.header,{children:(0,d.jsx)(n.h1,{id:"configuring",children:"Configuring"})}),"\n",(0,d.jsxs)(n.p,{children:["All app configuration is specified in ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/user-data/conf.yml",children:(0,d.jsx)(n.code,{children:"/user-data/conf.yml"})})," which is in ",(0,d.jsx)(n.a,{href:"https://yaml.org/",children:"YAML Format"})," format. If you're using Docker, this file can be passed in as a volume. Changes can either be made directly to this file, or done ",(0,d.jsx)(n.a,{href:"#editing-config-through-the-ui",children:"through the UI"}),". From the UI you can also export, backup, reset, validate and download your configuration file."]}),"\n",(0,d.jsx)(n.h2,{id:"there-are-three-ways-to-edit-the-config",children:"There are three ways to edit the config"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.strong,{children:"Directly in the YAML file"})," ",(0,d.jsx)(n.em,{children:"(5/5 reliability, 3/5 usability)"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:["Write changes directly to the conf.yml file, optionally using one of the templates provided. This can be done in your favorite editor and uploading to your server, or directly editing the file via SSH, but the easiest method would be to use ",(0,d.jsx)(n.a,{href:"https://github.com/coder/code-server",children:"Code Server"})]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.strong,{children:"UI JSON Editor"})," ",(0,d.jsx)(n.em,{children:"(4/5 reliability, 4/5 usability)"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:"From the UI, under the config menu there is a JSON editor, with built-in validation, documentation and advanced options"}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.strong,{children:"UI Visual Editor"})," ",(0,d.jsx)(n.em,{children:"(3/5 reliability, 5/5 usability)"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:"From the UI, enter the Interactive Edit Mode, then click any part of the page to edit. Changes are previewed live, and then saved to disk"}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.strong,{children:"REST API"})," ",(0,d.jsx)(n.em,{children:"(Coming soon)"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:"Programmatically edit config either through the command line, using a script or a third-party application"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,d.jsx)(n.h2,{id:"tips",children:"Tips"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:["You may find it helpful to look at some sample config files to get you started, a collection of which can be found ",(0,d.jsx)(n.a,{href:"https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10",children:"here"})]}),"\n",(0,d.jsxs)(n.li,{children:["You can check that your config file fits the schema, by running ",(0,d.jsx)(n.code,{children:"yarn validate-config"})]}),"\n",(0,d.jsxs)(n.li,{children:["After modifying your config, the app needs to be recompiled, by running ",(0,d.jsx)(n.code,{children:"yarn build"})," - this happens automatically if you're using Docker"]}),"\n",(0,d.jsxs)(n.li,{children:["It is recommended to keep a backup of your config file. You can download it under Config menu, or use the ",(0,d.jsx)(n.a,{href:"/docs/backup-restore",children:"Cloud Backup"})," feature."]}),"\n",(0,d.jsx)(n.li,{children:"You can make use of YAML features, like anchors, comments, multi-line strings, etc to reuse attributes and keep your config file readable"}),"\n",(0,d.jsxs)(n.li,{children:["Once you have finished configuring your dashboard, you can choose to ",(0,d.jsx)(n.a,{href:"#preventing-changes",children:"disable UI config"})," if you wish"]}),"\n",(0,d.jsx)(n.li,{children:"All fields are optional, unless otherwise stated."}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The following file provides a reference of all supported configuration options."}),"\n",(0,d.jsx)(n.h2,{id:"contents",children:"Contents"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#pageinfo",children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"pageInfo"})})})," - Header text, footer, title, navigation, etc\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#pageinfonavlinks-optional",children:(0,d.jsx)(n.code,{children:"navLinks"})})," - Links to display in the navigation bar"]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#pages-optional",children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"pages"})})})," - List of additional config files, for multi-page dashboards"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfig-optional",children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"appConfig"})})})," - Main application settings\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfigwebsearch-optional",children:(0,d.jsx)(n.code,{children:"webSearch"})})," - Configure web search engine options"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfighidecomponents-optional",children:(0,d.jsx)(n.code,{children:"hideComponents"})})," - Show/ hide page components"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfigauth-optional",children:(0,d.jsx)(n.code,{children:"auth"})})," - Built-in authentication setup\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfigauthusers-optional",children:(0,d.jsx)(n.code,{children:"users"})})," - List or users (for simple auth)"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfigauthkeycloak-optional",children:(0,d.jsx)(n.code,{children:"keycloak"})})," - Auth config for Keycloak"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfigauthheaderauth-optional",children:(0,d.jsx)(n.code,{children:"headerAuth"})})," - Auth config for HeaderAuth"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#section",children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"sections"})})})," - List of sections\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectiondisplaydata-optional",children:(0,d.jsx)(n.code,{children:"displayData"})})," - Section display settings\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers",children:(0,d.jsx)(n.code,{children:"show/hideForKeycloakUsers"})})," - Set user controls"]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectionicon-and-sectionitemicon",children:(0,d.jsx)(n.code,{children:"icon"})})," - Icon for a section"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectionitem",children:(0,d.jsx)(n.code,{children:"items"})})," - List of items\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectionicon-and-sectionitemicon",children:(0,d.jsx)(n.code,{children:"icon"})})," - Icon for an item"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#itemdisplaydata-optional",children:(0,d.jsx)(n.code,{children:"displayData"})})," - Item display settings\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers",children:(0,d.jsx)(n.code,{children:"show/hideForKeycloakUsers"})})," - Set user controls"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectionwidgets-optional",children:(0,d.jsx)(n.code,{children:"widgets"})})," - List of widgets"]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#notes",children:(0,d.jsx)(n.strong,{children:"Notes"})}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"#editing-config-through-the-ui",children:"Editing Config through the UI"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"#about-yaml",children:"About YAML"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"#config-saving-methods",children:"Config Saving Methods"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"#preventing-changes",children:"Preventing Changes"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"#example",children:"Example"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h2,{id:"top-level-fields",children:"Top-Level Fields"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"pageInfo"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["Basic meta data like title, description, nav bar links, footer text. See ",(0,d.jsx)(n.a,{href:"#pageinfo",children:(0,d.jsx)(n.code,{children:"pageInfo"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"appConfig"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Settings related to how the app functions, including API keys and global styles. See ",(0,d.jsx)(n.a,{href:"#appconfig-optional",children:(0,d.jsx)(n.code,{children:"appConfig"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"sections"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["An array of sections, each containing an array of items, which will be displayed as links. See ",(0,d.jsx)(n.a,{href:"#section",children:(0,d.jsx)(n.code,{children:"section"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"pages"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An array additional config files, used for multi-page dashboards. See ",(0,d.jsx)(n.a,{href:"#pages-optional",children:(0,d.jsx)(n.code,{children:"pages"})})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsx)(n.h2,{id:"pageinfo",children:(0,d.jsx)(n.code,{children:"PageInfo"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"title"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"Your dashboard title, displayed in the header and browser tab"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"description"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Description of your dashboard, also displayed as a subtitle"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"navLinks"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Optional list of a maximum of 6 links, which will be displayed in the navigation bar. See ",(0,d.jsx)(n.a,{href:"#pageinfonavlinks-optional",children:(0,d.jsx)(n.code,{children:"navLinks"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"footerText"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Text to display in the footer (note that this will override the default footer content). This can also include HTML and inline CSS"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"logo"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The path to an image to display in the header (to the right of the title). This can be either local, where ",(0,d.jsx)(n.code,{children:"/"})," is the root of ",(0,d.jsx)(n.code,{children:"./public"}),", or any remote image, such as ",(0,d.jsx)(n.code,{children:"https://i.ibb.co/yhbt6CY/dashy.png"}),". It's recommended to scale your image down, so that it doesn't impact load times"]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"pageinfonavlinks-optional",children:[(0,d.jsx)(n.code,{children:"pageInfo.navLinks"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"title"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The text to display on the link button"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"path"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["The URL to navigate to when clicked. Can be relative (e.g. ",(0,d.jsx)(n.code,{children:"/about"}),") or absolute (e.g. ",(0,d.jsx)(n.code,{children:"https://example.com"})," or ",(0,d.jsx)(n.code,{children:"http://192.168.1.1"}),")"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"target"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The opening method (external links only). Can be either ",(0,d.jsx)(n.code,{children:"newtab"}),", ",(0,d.jsx)(n.code,{children:"sametab"}),", ",(0,d.jsx)(n.code,{children:"top"})," or ",(0,d.jsx)(n.code,{children:"parent"}),". Defaults to ",(0,d.jsx)(n.code,{children:"newtab"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"pages-optional",children:[(0,d.jsx)(n.code,{children:"pages[]"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"name"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"A unique name for that page"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"path"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["The path (local or remote) to the config file to use.",(0,d.jsx)(n.br,{}),"For files located within ",(0,d.jsx)(n.code,{children:"/user-data"}),", you only need to specify filename, for externally hosted files you must include the full URL"]})]})]})]}),"\n",(0,d.jsxs)(n.p,{children:["For more info, see the",(0,d.jsx)(n.a,{href:"/docs/pages-and-sections#multi-page-support",children:"Multi-Page docs"})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfig-optional",children:[(0,d.jsx)(n.code,{children:"appConfig"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"language"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The 2 (or 4-digit) ",(0,d.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes",children:"ISO 639-1 code"})," for your language, e.g. ",(0,d.jsx)(n.code,{children:"en"})," or ",(0,d.jsx)(n.code,{children:"en-GB"}),". This must be a language that the app has already been ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/src/assets/locales",children:"translated"})," into. If your language is unavailable, Dashy will fallback to English. By default Dashy will attempt to auto-detect your language, although this may not work on some privacy browsers."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.del,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"startingView"})})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"enum"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Which page to load by default, and on the base page or domain root. You can still switch to different views from within the UI. Can be either ",(0,d.jsx)(n.code,{children:"default"}),", ",(0,d.jsx)(n.code,{children:"minimal"})," or ",(0,d.jsx)(n.code,{children:"workspace"}),". Defaults to ",(0,d.jsx)(n.code,{children:"default"}),". NOTE: This has been replaced by an environmental variable: ",(0,d.jsx)(n.code,{children:"VUE_APP_STARTING_VIEW"})," in V3 onwards"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"defaultOpeningMethod"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"enum"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The default opening method for items, if no ",(0,d.jsx)(n.code,{children:"target"})," is specified for a given item. Can be either ",(0,d.jsx)(n.code,{children:"newtab"}),", ",(0,d.jsx)(n.code,{children:"sametab"}),", ",(0,d.jsx)(n.code,{children:"modal"}),", ",(0,d.jsx)(n.code,{children:"workspace"}),", ",(0,d.jsx)(n.code,{children:"clipboard"}),", ",(0,d.jsx)(n.code,{children:"top"})," or ",(0,d.jsx)(n.code,{children:"parent"}),". Defaults to ",(0,d.jsx)(n.code,{children:"newtab"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheck"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["When set to ",(0,d.jsx)(n.code,{children:"true"}),", Dashy will ping each of your services and display their status as a dot next to each item. This can be overridden by setting ",(0,d.jsx)(n.code,{children:"statusCheck"})," under each item. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckInterval"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The number of seconds between checks. If set to ",(0,d.jsx)(n.code,{children:"0"})," then service will only be checked on initial page load, which is usually the desired functionality. If value is less than ",(0,d.jsx)(n.code,{children:"10"})," you may experience a hit in performance. Defaults to ",(0,d.jsx)(n.code,{children:"0"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"webSearch"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Configuration options for the web search feature, set your default search engine, opening method or disable web search. See ",(0,d.jsx)(n.a,{href:"#appconfigwebsearch-optional",children:(0,d.jsx)(n.code,{children:"webSearch"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"backgroundImg"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Path to an optional full-screen app background image. This can be either remote (http) or local (relative to /app/public/item-icons/ inside the container). Note that this will slow down initial load"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableFontAwesome"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"})," font-awesome will be loaded, if set to ",(0,d.jsx)(n.code,{children:"false"})," they will not be. if left blank font-awesome will be enabled only if required by 1 or more icons"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableMaterialDesignIcons"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"})," mdi icons will be loaded, if set to ",(0,d.jsx)(n.code,{children:"false"})," they will not be. Where ",(0,d.jsx)(n.code,{children:"true"})," is enabled, if left blank material design icons will be enabled only if required by 1 or more icons"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"fontAwesomeKey"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If you have a font-awesome key, then you can use it here and make use of premium icons. It is a 10-digit alpha-numeric string from you're FA kit URL (e.g. ",(0,d.jsx)(n.code,{children:"13014ae648"}),")"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"faviconApi"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"enum"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Only applicable if you are using favicons for item icons. Specifies which service to use to resolve favicons. Set to ",(0,d.jsx)(n.code,{children:"local"})," to do this locally, without using an API. Services running locally will use this option always. Available options are: ",(0,d.jsx)(n.code,{children:"local"}),", ",(0,d.jsx)(n.code,{children:"allesedv"}),", ",(0,d.jsx)(n.code,{children:"iconhorse"}),", ",(0,d.jsx)(n.code,{children:"faviconkit"}),", ",(0,d.jsx)(n.code,{children:"duckduckgo"}),", ",(0,d.jsx)(n.code,{children:"yandex"}),", ",(0,d.jsx)(n.code,{children:"google"}),", ",(0,d.jsx)(n.code,{children:"besticon"}),", ",(0,d.jsx)(n.code,{children:"webmasterapi"})," and ",(0,d.jsx)(n.code,{children:"mcapi"}),". Defaults to ",(0,d.jsx)(n.code,{children:"allesedv"}),". See ",(0,d.jsx)(n.a,{href:"/docs/icons#favicons",children:"Icons"})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"auth"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["All settings relating to user authentication. See ",(0,d.jsx)(n.a,{href:"#appconfigauth-optional",children:(0,d.jsx)(n.code,{children:"auth"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"defaultIcon"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An icon to be applied to any items, which don't already have an icon set. See ",(0,d.jsx)(n.a,{href:"/docs/icons#default-icon",children:"Icon Docs"})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"layout"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"enum"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Layout for homepage, either ",(0,d.jsx)(n.code,{children:"horizontal"}),", ",(0,d.jsx)(n.code,{children:"vertical"})," or ",(0,d.jsx)(n.code,{children:"auto"}),". Defaults to ",(0,d.jsx)(n.code,{children:"auto"}),". This specifies the layout and direction of how sections are positioned on the home screen. This can also be modified and overridden from the UI."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"iconSize"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"enum"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The size of link items / icons. Can be either ",(0,d.jsx)(n.code,{children:"small"}),", ",(0,d.jsx)(n.code,{children:"medium,"})," or ",(0,d.jsx)(n.code,{children:"large"}),". Defaults to ",(0,d.jsx)(n.code,{children:"medium"}),". This can also be set directly from the UI."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"colCount"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The number of columns of sections displayed on the homepage, using the default view. Should be in integer between ",(0,d.jsx)(n.code,{children:"1"})," and ",(0,d.jsx)(n.code,{children:"8"}),". Note that by default this is applied responsively, based on current screen size, and specifying a value here will override this behavior, which may not be desirable."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"theme"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The default theme for first load (you can change this later from the UI)"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"cssThemes"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"An array of custom theme names which can be used in the theme switcher dropdown"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"customColors"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Enables you to apply a custom color palette to any given theme. Use the theme name (lowercase) as the key, for an object including key-value-pairs, with the color variable name as keys, and 6-digit hex code as value. See ",(0,d.jsx)(n.a,{href:"/docs/theming#modifying-theme-colors",children:"Theming"})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"externalStyleSheet"})})}),(0,d.jsxs)(n.td,{children:[(0,d.jsx)(n.code,{children:"string"})," or ",(0,d.jsx)(n.code,{children:"string[]"})]}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Either a URL to an external stylesheet or an array or URLs, which can be applied as themes within the UI"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"customCss"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Raw CSS that will be applied to the page. This can also be set from the UI. Please minify it first."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideComponents"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["A list of key page components (header, footer, search, settings, etc) that are present by default, but can be removed using this option. See ",(0,d.jsx)(n.a,{href:"#appconfighidecomponents-optional",children:(0,d.jsx)(n.code,{children:"appConfig.hideComponents"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"routingMode"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Can be either ",(0,d.jsx)(n.code,{children:"hash"})," or ",(0,d.jsx)(n.code,{children:"history"}),". Determines the URL format for sub-pages, hash mode will look like ",(0,d.jsx)(n.code,{children:"/#/home"})," whereas with history mode available you have nice clean URLs, like ",(0,d.jsx)(n.code,{children:"/home"}),". For more info, see the ",(0,d.jsx)(n.a,{href:"https://router.vuejs.org/guide/essentials/history-mode.html#example-server-configurations",children:"Vue docs"}),". If you're hosting Dashy with a custom BASE_URL, you will find that a bit of extra server config is necessary to get history mode working, so here you may want to instead use ",(0,d.jsx)(n.code,{children:"hash"})," mode.Defaults to ",(0,d.jsx)(n.code,{children:"history"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableMultiTasking"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"If set to true, will keep apps open in the background when in the workspace view. Useful for quickly switching between multiple sites, and preserving their state, but comes at the cost of performance."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"workspaceLandingUrl"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The URL or an app, service or website to launch when the workspace view is opened, before another service has been launched"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"preventWriteToDisk"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", users will be prevented from saving config changes to disk through the UI"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"preventLocalSave"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", users will be prevented from applying config changes to local storage"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableConfiguration"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"If set to true, no users will be able to view or edit the config through the UI"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableConfigurationForNonAdmin"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"If set to true, only admin users will be able to view or edit the config through the UI. disableConfiguration must not be set to true."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"widgetsAlwaysUseProxy"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", requests made by widgets will always be proxied, same as setting ",(0,d.jsx)(n.code,{children:"useProxy: true"})," on each widget. Note that this may break some widgets."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"showSplashScreen"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", a loading screen will be shown. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableErrorReporting"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Enable reporting of unexpected errors and crashes. This is off by default, and ",(0,d.jsx)(n.strong,{children:"no data will ever be captured unless you explicitly enable it"}),". Turning on error reporting helps previously unknown bugs get discovered and fixed. Dashy uses ",(0,d.jsx)(n.a,{href:"https://github.com/getsentry/sentry",children:"Sentry"})," for error reporting. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"sentryDsn"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If you need to monitor errors in your instance, then you can use Sentry to collect and process bug reports. Sentry can be self-hosted, or used as SaaS, once your instance is setup, then all you need to do is pass in the DSN here, and enable error reporting. You can learn more on the ",(0,d.jsx)(n.a,{href:"https://docs.sentry.io/product/sentry-basics/dsn-explainer/",children:"Sentry DSN Docs"}),". Note that this will only ever be used if ",(0,d.jsx)(n.code,{children:"enableErrorReporting"})," is explicitly enabled."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableSmartSort"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["For the most-used and last-used app sort functions to work, a basic open-count is stored in local storage. If you do not want this to happen, then disable smart sort here, but you wil no longer be able to use these sort options. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableUpdateChecks"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to true, Dashy will not check for updates. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableServiceWorker"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Service workers cache web applications to improve load times and offer basic offline functionality, and are disabled by default in Dashy. The service worker can sometimes cause older content to be cached, requiring the app to be hard-refreshed. If you do not want SW functionality, or are having issues with caching, set this property to ",(0,d.jsx)(n.code,{children:"false"})," to disable all service workers."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableContextMenu"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the custom right-click context menu will be disabled. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigauth-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.auth"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:["[!NOTE]\nSince the auth is initiated in the main app entry point (for security), a rebuild is required to apply changes to the auth configuration.\nYou can trigger a rebuild through the UI, under Config --\x3e Rebuild, or by running ",(0,d.jsx)(n.code,{children:"yarn build"})," in the root directory."]}),"\n"]}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:["[!WARNING]\nBuilt-in auth should ",(0,d.jsx)(n.strong,{children:"not be used"})," for security-critical applications, or if your Dashy instance is publicly accessible.\nFor these, it is recommended to use an ",(0,d.jsx)(n.a,{href:"/docs/authentication#alternative-authentication-methods",children:"alternate authentication method"}),"."]}),"\n"]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"users"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An array of objects containing usernames and hashed passwords. If this is not provided, then authentication will be off by default, and you will not need any credentials to access the app. See ",(0,d.jsx)(n.a,{href:"#appconfigauthusers-optional",children:(0,d.jsx)(n.code,{children:"appConfig.auth.users"})}),". ",(0,d.jsx)(n.br,{}),(0,d.jsx)(n.strong,{children:"Note"})," this method of authentication is handled on the client side, so for security critical situations, it is recommended to use an ",(0,d.jsx)(n.a,{href:"/docs/authentication#alternative-authentication-methods",children:"alternate authentication method"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableKeycloak"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", then authentication using Keycloak will be enabled. Note that you need to have an instance running, and have also configured ",(0,d.jsx)(n.code,{children:"auth.keycloak"}),". Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"keycloak"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Config options to point Dashy to your Keycloak server. Requires ",(0,d.jsx)(n.code,{children:"enableKeycloak: true"}),". See ",(0,d.jsx)(n.a,{href:"#appconfigauthkeycloak-optional",children:(0,d.jsx)(n.code,{children:"auth.keycloak"})})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableHeaderAuth"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", then authentication using HeaderAuth will be enabled. Note that you need to have your web server/reverse proxy running, and have also configured ",(0,d.jsx)(n.code,{children:"auth.headerAuth"}),". Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"headerAuth"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Config options to point Dashy to your headers for authentication. Requires ",(0,d.jsx)(n.code,{children:"enableHeaderAuth: true"}),". See ",(0,d.jsx)(n.a,{href:"#appconfigauthheaderauth-optional",children:(0,d.jsx)(n.code,{children:"auth.headerAuth"})})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableOidc"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", then authentication using OIDC will be enabled. Note that you need to have a configured OIDC server and configure it with ",(0,d.jsx)(n.code,{children:"auth.oidc"}),". Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"oidc"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Config options to point Dash to your OIDC configuration. Request ",(0,d.jsx)(n.code,{children:"enableOidc: true"}),". See ",(0,d.jsx)(n.a,{href:"#appconfigauthoidc-optional",children:(0,d.jsx)(n.code,{children:"auth.oidc"})})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableGuestAccess"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["When set to ",(0,d.jsx)(n.code,{children:"true"}),", an unauthenticated user will be able to access the dashboard, with read-only access, without having to login. Requires ",(0,d.jsx)(n.code,{children:"auth.users"})," to be configured. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]})]})]}),"\n",(0,d.jsxs)(n.p,{children:["For more info, see the ",(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"/docs/authentication",children:"Authentication Docs"})})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigauthusers-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.auth.users"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"user"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"Username to log in with"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hash"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"A SHA-256 hashed password"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"type"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The user type, either admin or normal"})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigauthkeycloak-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.auth.keycloak"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"serverUrl"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The URL (or URL/ IP + Port) where your keycloak server is running"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"realm"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The name of the realm (must already be created) that you want to use"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"clientId"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The Client ID of the client you created for use with Dashy"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"legacySupport"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If using Keycloak 17 or older, then set this to ",(0,d.jsx)(n.code,{children:"true"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigauthheaderauth-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.auth.headerAuth"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"userHeader"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The Header name which contains username (default: REMOTE_USER). Case insensitive"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"proxyWhitelist"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"An array of Upstream proxy servers to expect authencticated requests from"})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigauthoidc-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.auth.oidc"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"clientId"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The client id registered in the OIDC server"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"endpoint"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The URL of the OIDC server that should be used."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"adminRole"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The role that will be considered as admin."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"adminGroup"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The group that will be considered as admin."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"scope"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The scope(s) to request from the OIDC provider"})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigwebsearch-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.webSearch"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableWebSearch"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Web search is enabled by default, but can be disabled by setting this property to ",(0,d.jsx)(n.code,{children:"true"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"searchEngine"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Set the key name for your search engine. Can also use a custom engine by setting this property to ",(0,d.jsx)(n.code,{children:"custom"}),". Currently supported: ",(0,d.jsx)(n.code,{children:"duckduckgo"}),", ",(0,d.jsx)(n.code,{children:"google"}),", ",(0,d.jsx)(n.code,{children:"whoogle"}),", ",(0,d.jsx)(n.code,{children:"qwant"}),", ",(0,d.jsx)(n.code,{children:"startpage"}),", ",(0,d.jsx)(n.code,{children:"searx-bar"})," and ",(0,d.jsx)(n.code,{children:"searx-info"}),". Defaults to ",(0,d.jsx)(n.code,{children:"duckduckgo"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"customSearchEngine"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["You can also use a custom search engine, or your own self-hosted instance. This requires ",(0,d.jsx)(n.code,{children:"searchEngine: custom"})," to be set. Then add the URL of your service, with GET query string included here"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"openingMethod"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Set your preferred opening method for search results: ",(0,d.jsx)(n.code,{children:"newtab"}),", ",(0,d.jsx)(n.code,{children:"sametab"}),", ",(0,d.jsx)(n.code,{children:"workspace"}),". Defaults to ",(0,d.jsx)(n.code,{children:"newtab"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"searchBangs"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["A key-value-pair set of custom search ",(0,d.jsx)(n.em,{children:"bangs"})," for redirecting query to a specific app or search engine. The key of each should be the bang you will type (typically starting with ",(0,d.jsx)(n.code,{children:"/"}),", ",(0,d.jsx)(n.code,{children:"!"})," or ",(0,d.jsx)(n.code,{children:":"}),"), and value is the destination, either as a search engine key (e.g. ",(0,d.jsx)(n.code,{children:"reddit"}),") or a URL with search parameters (e.g. ",(0,d.jsx)(n.code,{children:"https://en.wikipedia.org/w/?search="}),")"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"openUrlsDirectly"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If ",(0,d.jsx)(n.code,{children:"true"}),", queries that look like URLs will be opened directly instead of searched. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfighidecomponents-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.hideComponents"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideHeading"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the page title & sub-title will not be visible. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideNav"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the navigation menu will not be visible. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideSearch"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the search bar will not be visible. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideSettings"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the settings menu will be initially collapsed. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideFooter"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the footer will not be visible. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsx)(n.h2,{id:"section",children:(0,d.jsx)(n.code,{children:"section"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"name"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The title for the section"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"icon"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An single icon to be displayed next to the title. See ",(0,d.jsx)(n.a,{href:"#sectionicon-and-sectionitemicon",children:(0,d.jsx)(n.code,{children:"section.icon"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"items"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An array of items to be displayed within the section. See ",(0,d.jsx)(n.a,{href:"#sectionitem",children:(0,d.jsx)(n.code,{children:"item"})}),". Sections must include either 1 or more items, or 1 or more widgets."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"widgets"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An array of widgets to be displayed within the section. See ",(0,d.jsx)(n.a,{href:"#sectionwidgets-optional",children:(0,d.jsx)(n.code,{children:"widget"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"displayData"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Meta-data to optionally override display settings for a given section. See ",(0,d.jsx)(n.a,{href:"#sectiondisplaydata-optional",children:(0,d.jsx)(n.code,{children:"displayData"})})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsx)(n.h2,{id:"sectionitem",children:(0,d.jsx)(n.code,{children:"section.item"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"title"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["The text to display/ title of a given item. Max length ",(0,d.jsx)(n.code,{children:"18"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"description"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Additional info about an item, which is shown in the tooltip on hover, or visible on large tiles"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"url"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The URL / location of web address for when the item is clicked"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"icon"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The icon for a given item. Can be a font-awesome icon, favicon, remote URL or local URL. See ",(0,d.jsx)(n.a,{href:"#sectionicon-and-sectionitemicon",children:(0,d.jsx)(n.code,{children:"item.icon"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"target"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The opening method for when the item is clicked, either ",(0,d.jsx)(n.code,{children:"newtab"}),", ",(0,d.jsx)(n.code,{children:"sametab"}),", ",(0,d.jsx)(n.code,{children:"modal"}),", ",(0,d.jsx)(n.code,{children:"workspace"}),", ",(0,d.jsx)(n.code,{children:"clipboard"}),", ",(0,d.jsx)(n.code,{children:"top"})," or ",(0,d.jsx)(n.code,{children:"parent"}),". Where ",(0,d.jsx)(n.code,{children:"newtab"})," will open the link in a new tab, ",(0,d.jsx)(n.code,{children:"sametab"})," will open it in the current tab, and ",(0,d.jsx)(n.code,{children:"modal"})," will open a pop-up modal, ",(0,d.jsx)(n.code,{children:"workspace"})," will open in the Workspace view and ",(0,d.jsx)(n.code,{children:"clipboard"})," will copy the URL to system clipboard (but not launch app). Defaults to ",(0,d.jsx)(n.code,{children:"newtab"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hotkey"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Give frequently opened applications a numeric hotkey, between ",(0,d.jsx)(n.code,{children:"0 - 9"}),". You can then just press that key to launch that application."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"tags"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"A list of tags, which can be used for improved search"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheck"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["When set to ",(0,d.jsx)(n.code,{children:"true"}),", Dashy will ping the URL associated with the current service, and display its status as a dot next to the item. The value here will override ",(0,d.jsx)(n.code,{children:"appConfig.statusCheck"})," so you can turn off or on checks for a given service. Defaults to ",(0,d.jsx)(n.code,{children:"appConfig.statusCheck"}),", falls back to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckUrl"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If you've enabled ",(0,d.jsx)(n.code,{children:"statusCheck"}),", and want to use a different URL to what is defined under the item, then specify it here"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckHeaders"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"If you're endpoint requires any specific headers for the status checking, then define them here"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckAllowInsecure"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["By default, any request to insecure content will be blocked. Setting this option to ",(0,d.jsx)(n.code,{children:"true"})," will disable the ",(0,d.jsx)(n.code,{children:"rejectUnauthorized"})," option, enabling you to ping non-HTTPS services for the current item. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckAcceptCodes"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If your service's response code is anything other than 2xx, then you can opt to specify an alternative success code. E.g. if you expect your server to return 403, but still want the status indicator to be green, set this value to ",(0,d.jsx)(n.code,{children:"403"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckMaxRedirects"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If your service redirects to another page, and you would like status checks to follow redirects, then specify the maximum number of redirects here. Defaults to ",(0,d.jsx)(n.code,{children:"0"})," / will not follow redirects"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"color"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"An optional color for the text and font-awesome icon to be displayed in. Note that this will override the current theme and so may not display well"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"rel"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The value of the ",(0,d.jsx)(n.code,{children:"rel"})," attribute for the link. Useful for specifying the relationship between the target link/document and Dashy. Defaults to ",(0,d.jsx)(n.code,{children:"noopener noreferrer"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"backgroundColor"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"An optional background fill color for the that given item. Again, this will override the current theme and so might not display well against the background"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"provider"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The name of the provider for a given service, useful for when including hosted apps. In some themes, this is visible under the item name"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"displayData"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Meta-data to optionally override display settings for a given item. See ",(0,d.jsx)(n.a,{href:"#itemdisplaydata-optional",children:(0,d.jsx)(n.code,{children:"displayData"})})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"itemdisplaydata-optional",children:[(0,d.jsx)(n.code,{children:"item.displayData"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current item will be visible to all users, except for those specified in this list"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"showForUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current item will be hidden from all users, except for those specified in this list"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForGuests"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current item will be visible for logged in users, but not for guests (see ",(0,d.jsx)(n.code,{children:"appConfig.enableGuestAccess"}),"). Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForKeycloakUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current item will be visible to all keycloak users, except for those configured via these groups and roles. See ",(0,d.jsx)(n.code,{children:"hideForKeycloakUsers"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"showForKeycloakUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current item will be hidden from all keycloak users, except for those configured via these groups and roles. See ",(0,d.jsx)(n.code,{children:"showForKeycloakUsers"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideFromWorkspace"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current item will be visible in the default view but not in the Workspace view sidebar. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"sectionwidgets-optional",children:[(0,d.jsx)(n.code,{children:"section.widgets"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"type"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["The widget type. See ",(0,d.jsx)(n.a,{href:"/docs/widgets",children:"Widget Docs"})," for full list of supported widgets"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"options"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Some widgets accept either optional or required additional options. Again, see the ",(0,d.jsx)(n.a,{href:"/docs/widgets",children:"Widget Docs"})," for full list of options"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"updateInterval"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["You can keep a widget constantly updated by specifying an update interval, in seconds. See ",(0,d.jsx)(n.a,{href:"/docs/widgets#continuous-updates",children:"Continuous Updates Docs"})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"useProxy"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Some widgets make API requests to services that are not CORS-enabled. For these instances, you will need to route requests through a proxy, Dashy has a built in CORS-proxy, which you can use by setting this option to ",(0,d.jsx)(n.code,{children:"true"}),". Defaults to ",(0,d.jsx)(n.code,{children:"false"}),". See the ",(0,d.jsx)(n.a,{href:"/docs/widgets#proxying-requests",children:"Proxying Requests Docs"})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"timeout"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Request timeout in milliseconds, defaults to \xbd a second (",(0,d.jsx)(n.code,{children:"500"}),")"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"ignoreErrors"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Prevent an error message being displayed, if a network request or something else fails. Useful for false-positives"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"label"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Add custom label to a given widget. Useful for identification, if there are multiple of the same type of widget in a single section"})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"sectiondisplaydata-optional",children:[(0,d.jsx)(n.code,{children:"section.displayData"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"sortBy"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The sort order for items within the current section. By default items are displayed in the order in which they are listed in within the config. The following sort options are supported: ",(0,d.jsx)(n.code,{children:"most-used"})," (most opened apps first), ",(0,d.jsx)(n.code,{children:"last-used"})," (the most recently used apps), ",(0,d.jsx)(n.code,{children:"alphabetical"}),", ",(0,d.jsx)(n.code,{children:"reverse-alphabetical"}),", ",(0,d.jsx)(n.code,{children:"random"})," and ",(0,d.jsx)(n.code,{children:"default"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"collapsed"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If true, the section will be collapsed initially, and will need to be clicked to open. Useful for less regularly used, or very long sections. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"cutToHeight"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"By default, sections will fill available space. Set this option to true to match section height with content height"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"rows"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Height of the section, specified as the number of rows it should span vertically, e.g. ",(0,d.jsx)(n.code,{children:"2"}),". Defaults to ",(0,d.jsx)(n.code,{children:"1"}),". Max is ",(0,d.jsx)(n.code,{children:"5"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"cols"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Width of the section, specified as the number of columns the section should span horizontally, e.g. ",(0,d.jsx)(n.code,{children:"2"}),". Defaults to ",(0,d.jsx)(n.code,{children:"1"}),". Max is ",(0,d.jsx)(n.code,{children:"6"}),". Will be clamped to the page's active column count so that a section never exceeds the available grid width."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"itemSize"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Specify the size for items within this group, either ",(0,d.jsx)(n.code,{children:"small"}),", ",(0,d.jsx)(n.code,{children:"medium"})," or ",(0,d.jsx)(n.code,{children:"large"}),". Note that this will override any settings specified through the UI"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"color"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["A custom accent color for the section, as a hex code or HTML color (e.g. ",(0,d.jsx)(n.code,{children:"#fff"}),")"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"customStyles"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Custom CSS properties that should be applied to that section, e.g. ",(0,d.jsx)(n.code,{children:"border: 2px dashed #ff0000;"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"sectionLayout"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Specify which CSS layout will be used to responsively place items. Can be either ",(0,d.jsx)(n.code,{children:"auto"})," (which uses flex layout), or ",(0,d.jsx)(n.code,{children:"grid"}),". If ",(0,d.jsx)(n.code,{children:"grid"})," is selected, then ",(0,d.jsx)(n.code,{children:"itemCountX"})," and ",(0,d.jsx)(n.code,{children:"itemCountY"})," may also be set. Defaults to ",(0,d.jsx)(n.code,{children:"auto"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"itemCountX"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The number of items to display per row / horizontally. If not set, it will be calculated automatically based on available space. Can only be set if ",(0,d.jsx)(n.code,{children:"sectionLayout"})," is set to ",(0,d.jsx)(n.code,{children:"grid"}),". Must be a whole number between ",(0,d.jsx)(n.code,{children:"1"})," and ",(0,d.jsx)(n.code,{children:"12"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"itemCountY"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The number of items to display per column / vertically. If not set, it will be calculated automatically based on available space. If ",(0,d.jsx)(n.code,{children:"itemCountX"})," is set, then ",(0,d.jsx)(n.code,{children:"itemCountY"})," can be calculated automatically. Can only be set if ",(0,d.jsx)(n.code,{children:"sectionLayout"})," is set to ",(0,d.jsx)(n.code,{children:"grid"}),". Must be a whole number between ",(0,d.jsx)(n.code,{children:"1"})," and ",(0,d.jsx)(n.code,{children:"12"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current section will be visible to all users, except for those specified in this list"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"showForUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current section will be hidden from all users, except for those specified in this list"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForGuests"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current section will be visible for logged in users, but not for guests (see ",(0,d.jsx)(n.code,{children:"appConfig.enableGuestAccess"}),"). Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForKeycloakUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current section will be visible to all keycloak users, except for those configured via these groups and roles. See ",(0,d.jsx)(n.code,{children:"hideForKeycloakUsers"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"showForKeycloakUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current section will be hidden from all keycloak users, except for those configured via these groups and roles. See ",(0,d.jsx)(n.code,{children:"showForKeycloakUsers"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideFromWorkspace"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current section will be visible in the default view but not in the Workspace view sidebar. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"sectionicon-and-sectionitemicon",children:[(0,d.jsx)(n.code,{children:"section.icon"})," and ",(0,d.jsx)(n.code,{children:"section.item.icon"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsx)(n.tbody,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"icon"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The icon for a given item or section. ",(0,d.jsx)(n.br,{}),"See ",(0,d.jsx)(n.a,{href:"/docs/icons",children:"Icon Docs"})," for all available supported icon types, including: auto-fetched favicons, generative icons, emoji icons, home-lab service logos, font-awesome, simple-icons, material icons, selfh.st icons, and icons specified by URL"]})]})})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers",children:[(0,d.jsx)(n.code,{children:"section.displayData.hideForKeycloakUsers"}),", ",(0,d.jsx)(n.code,{children:"section.displayData.showForKeycloakUsers"}),", ",(0,d.jsx)(n.code,{children:"item.displayData.hideForKeycloakUsers"})," and ",(0,d.jsx)(n.code,{children:"item.displayData.showForKeycloakUsers"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"groups"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current Section or Item will be hidden or shown based on the user having any of the groups in this list"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"roles"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current Section or Item will be hidden or shown based on the user having any of the roles in this list"})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h2,{id:"notes",children:"Notes"}),"\n",(0,d.jsx)(n.h3,{id:"editing-config-through-the-ui",children:"Editing Config through the UI"}),"\n",(0,d.jsxs)(n.p,{children:["Config can be modified directly through the UI, and then written to disk, or applied locally. This can be done wither with the raw config editor (introduced in V 0.6.5 / ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/pull/3",children:"#3"}),"), or the interactive editor (introduced in V 1.8.9 / ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/pull/298",children:"#298"}),")."]}),"\n ",(0,d.jsxs)(n.a,{href:"https://ibb.co/CzkyMNb",children:["\n ",(0,d.jsx)(n.b,{children:"Interactive Editor"}),(0,d.jsx)(n.br,{}),"\n ",(0,d.jsx)(n.img,{alt:"Interactive Editor demo",src:"https://user-images.githubusercontent.com/1862727/139543020-b0576d28-0830-476f-afc8-a815d4de6def.gif",width:"600"}),"\n "]}),"\n ",(0,d.jsx)(n.br,{}),"\n ",(0,d.jsxs)(n.a,{href:"https://ibb.co/zRv542H",children:["\n ",(0,d.jsx)(n.b,{children:"JSON Editor"}),(0,d.jsx)(n.br,{}),"\n ",(0,d.jsx)(n.img,{alt:"Config Editor demo",src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/config-editor-demo.gif",width:"600"}),"\n "]}),"\n",(0,d.jsx)(n.h3,{id:"about-yaml",children:"About YAML"}),"\n",(0,d.jsxs)(n.p,{children:["If you're new to YAML, it's pretty straight-forward. The format is exactly the same as that of JSON, but instead of using curly braces, structure is denoted using whitespace. This ",(0,d.jsx)(n.a,{href:"https://linuxhandbook.com/yaml-basics/",children:"quick guide"})," should get you up to speed in a few minutes, for more advanced topics take a look at this ",(0,d.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/YAML",children:"Wikipedia article"}),"."]}),"\n",(0,d.jsx)(n.h3,{id:"config-saving-methods",children:"Config Saving Methods"}),"\n",(0,d.jsxs)(n.p,{children:["When updating the config through the JSON editor in the UI, you have two save options: ",(0,d.jsx)(n.strong,{children:"Local"})," or ",(0,d.jsx)(n.strong,{children:"Write to Disk"}),"."]}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:"Changes saved locally will only be applied to the current user through the browser, and will not apply to other instances - you either need to use the cloud sync feature, or manually update the conf.yml file."}),"\n",(0,d.jsxs)(n.li,{children:["On the other-hand, if you choose to write changes to disk, then your main ",(0,d.jsx)(n.code,{children:"conf.yml"})," file will be updated, and changes will be applied to all users, and visible across all devices. For this functionality to work, you must be running Dashy with using the Docker container, or the Node server. A backup of your current configuration will also be saved in the same directory."]}),"\n"]}),"\n",(0,d.jsx)(n.h3,{id:"preventing-changes",children:"Preventing Changes"}),"\n",(0,d.jsxs)(n.p,{children:["If you have authentication set up, then any user who is not an admin (with ",(0,d.jsx)(n.code,{children:"type: admin"}),") will not be able to write changes to disk."]}),"\n",(0,d.jsxs)(n.p,{children:["You can also prevent changes from any user being written to disk, using ",(0,d.jsx)(n.code,{children:"preventWriteToDisk"}),". Or prevent any changes from being saved locally in browser storage, using ",(0,d.jsx)(n.code,{children:"preventLocalSave"}),"."]}),"\n",(0,d.jsxs)(n.p,{children:["To disable all UI config features, set ",(0,d.jsx)(n.code,{children:"disableConfiguration"}),". Alternatively you can disable UI config features for all non Admin users by setting ",(0,d.jsx)(n.code,{children:"disableConfigurationForNonAdmin"})," to true."]}),"\n",(0,d.jsx)(n.h3,{id:"example",children:"Example"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-yaml",children:"---\npageInfo:\n title: Home Lab\nsections: # An array of sections\n- name: Section 1 - Getting Started\n items: # An array of items\n - title: GitHub\n description: Source code and documentation on GitHub\n icon: fab fa-github\n url: https://github.com/Lissy93/dashy\n - title: Issues\n description: View currently open issues, or raise a new one\n icon: fas fa-bug\n url: https://github.com/Lissy93/dashy/issues\n - title: Demo\n description: A live demo\n icon: far fa-rocket\n url: https://dashy-demo-1.netlify.app\n- name: Section 2 - Local Services\n items:\n - title: Firewall\n icon: favicon\n url: http://192.168.1.1/\n - title: Game Server\n icon: https://i.ibb.co/710B3Yc/space-invader-x256.png\n url: http://192.168.130.1/\n"})}),"\n",(0,d.jsxs)(n.p,{children:["For more example config files, see: ",(0,d.jsx)(n.a,{href:"https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10",children:"this gist"})]}),"\n",(0,d.jsxs)(n.p,{children:["If you need any help, feel free to ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%A4%B7%E2%80%8D%E2%99%82%EF%B8%8F+Question&template=question.md&title=%5BQUESTION%5D",children:"Raise an Issue"})," or ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/discussions",children:"Start a Discussion"})]}),"\n",(0,d.jsx)(n.p,{children:"Happy Configuring \ud83e\udd13\ud83d\udd27"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(h,{...e})}):h(e)}},8453(e,n,s){s.d(n,{R:()=>t,x:()=>c});var i=s(6540);const d={},r=i.createContext(d);function t(e){const n=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[5496],{7395(e,n,s){s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>a,frontMatter:()=>t,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"configuring","title":"Configuring","description":"All app configuration is specified in /user-data/conf.yml which is in YAML Format format. If you\'re using Docker, this file can be passed in as a volume. Changes can either be made directly to this file, or done through the UI. From the UI you can also export, backup, reset, validate and download your configuration file.","source":"@site/docs/configuring.md","sourceDirName":".","slug":"/configuring","permalink":"/docs/configuring","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/configuring.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Deployment","permalink":"/docs/deployment"},"next":{"title":"App Management","permalink":"/docs/management"}}');var d=s(4848),r=s(8453);const t={},c="Configuring",l={},o=[{value:"There are three ways to edit the config",id:"there-are-three-ways-to-edit-the-config",level:2},{value:"Tips",id:"tips",level:2},{value:"Contents",id:"contents",level:2},{value:"Top-Level Fields",id:"top-level-fields",level:2},{value:"PageInfo",id:"pageinfo",level:2},{value:"pageInfo.navLinks (optional)",id:"pageinfonavlinks-optional",level:2},{value:"pages[] (optional)",id:"pages-optional",level:2},{value:"appConfig (optional)",id:"appconfig-optional",level:2},{value:"appConfig.auth (optional)",id:"appconfigauth-optional",level:2},{value:"appConfig.auth.users (optional)",id:"appconfigauthusers-optional",level:2},{value:"appConfig.auth.keycloak (optional)",id:"appconfigauthkeycloak-optional",level:2},{value:"appConfig.auth.headerAuth (optional)",id:"appconfigauthheaderauth-optional",level:2},{value:"appConfig.auth.oidc (optional)",id:"appconfigauthoidc-optional",level:2},{value:"appConfig.webSearch (optional)",id:"appconfigwebsearch-optional",level:2},{value:"appConfig.hideComponents (optional)",id:"appconfighidecomponents-optional",level:2},{value:"section",id:"section",level:2},{value:"section.item",id:"sectionitem",level:2},{value:"item.displayData (optional)",id:"itemdisplaydata-optional",level:2},{value:"section.widgets (optional)",id:"sectionwidgets-optional",level:2},{value:"section.displayData (optional)",id:"sectiondisplaydata-optional",level:2},{value:"section.icon and section.item.icon",id:"sectionicon-and-sectionitemicon",level:2},{value:"section.displayData.hideForKeycloakUsers, section.displayData.showForKeycloakUsers, item.displayData.hideForKeycloakUsers and item.displayData.showForKeycloakUsers",id:"sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers",level:2},{value:"Notes",id:"notes",level:2},{value:"Editing Config through the UI",id:"editing-config-through-the-ui",level:3},{value:"About YAML",id:"about-yaml",level:3},{value:"Config Saving Methods",id:"config-saving-methods",level:3},{value:"Preventing Changes",id:"preventing-changes",level:3},{value:"Example",id:"example",level:3}];function h(e){const n={a:"a",b:"b",blockquote:"blockquote",br:"br",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.header,{children:(0,d.jsx)(n.h1,{id:"configuring",children:"Configuring"})}),"\n",(0,d.jsxs)(n.p,{children:["All app configuration is specified in ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/user-data/conf.yml",children:(0,d.jsx)(n.code,{children:"/user-data/conf.yml"})})," which is in ",(0,d.jsx)(n.a,{href:"https://yaml.org/",children:"YAML Format"})," format. If you're using Docker, this file can be passed in as a volume. Changes can either be made directly to this file, or done ",(0,d.jsx)(n.a,{href:"#editing-config-through-the-ui",children:"through the UI"}),". From the UI you can also export, backup, reset, validate and download your configuration file."]}),"\n",(0,d.jsx)(n.h2,{id:"there-are-three-ways-to-edit-the-config",children:"There are three ways to edit the config"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.strong,{children:"Directly in the YAML file"})," ",(0,d.jsx)(n.em,{children:"(5/5 reliability, 3/5 usability)"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:["Write changes directly to the conf.yml file, optionally using one of the templates provided. This can be done in your favorite editor and uploading to your server, or directly editing the file via SSH, but the easiest method would be to use ",(0,d.jsx)(n.a,{href:"https://github.com/coder/code-server",children:"Code Server"})]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.strong,{children:"UI JSON Editor"})," ",(0,d.jsx)(n.em,{children:"(4/5 reliability, 4/5 usability)"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:"From the UI, under the config menu there is a JSON editor, with built-in validation, documentation and advanced options"}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.strong,{children:"UI Visual Editor"})," ",(0,d.jsx)(n.em,{children:"(3/5 reliability, 5/5 usability)"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:"From the UI, enter the Interactive Edit Mode, then click any part of the page to edit. Changes are previewed live, and then saved to disk"}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.strong,{children:"REST API"})," ",(0,d.jsx)(n.em,{children:"(Coming soon)"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:"Programmatically edit config either through the command line, using a script or a third-party application"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,d.jsx)(n.h2,{id:"tips",children:"Tips"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:["You may find it helpful to look at some sample config files to get you started, a collection of which can be found ",(0,d.jsx)(n.a,{href:"https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10",children:"here"})]}),"\n",(0,d.jsxs)(n.li,{children:["You can check that your config file fits the schema, by running ",(0,d.jsx)(n.code,{children:"yarn validate-config"})]}),"\n",(0,d.jsxs)(n.li,{children:["After modifying your config, the app needs to be recompiled, by running ",(0,d.jsx)(n.code,{children:"yarn build"})," - this happens automatically if you're using Docker"]}),"\n",(0,d.jsxs)(n.li,{children:["It is recommended to keep a backup of your config file. You can download it under Config menu, or use the ",(0,d.jsx)(n.a,{href:"/docs/backup-restore",children:"Cloud Backup"})," feature."]}),"\n",(0,d.jsx)(n.li,{children:"You can make use of YAML features, like anchors, comments, multi-line strings, etc to reuse attributes and keep your config file readable"}),"\n",(0,d.jsxs)(n.li,{children:["Once you have finished configuring your dashboard, you can choose to ",(0,d.jsx)(n.a,{href:"#preventing-changes",children:"disable UI config"})," if you wish"]}),"\n",(0,d.jsx)(n.li,{children:"All fields are optional, unless otherwise stated."}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The following file provides a reference of all supported configuration options."}),"\n",(0,d.jsx)(n.h2,{id:"contents",children:"Contents"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#pageinfo",children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"pageInfo"})})})," - Header text, footer, title, navigation, etc\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#pageinfonavlinks-optional",children:(0,d.jsx)(n.code,{children:"navLinks"})})," - Links to display in the navigation bar"]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#pages-optional",children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"pages"})})})," - List of additional config files, for multi-page dashboards"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfig-optional",children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"appConfig"})})})," - Main application settings\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfigwebsearch-optional",children:(0,d.jsx)(n.code,{children:"webSearch"})})," - Configure web search engine options"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfighidecomponents-optional",children:(0,d.jsx)(n.code,{children:"hideComponents"})})," - Show/ hide page components"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfigauth-optional",children:(0,d.jsx)(n.code,{children:"auth"})})," - Built-in authentication setup\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfigauthusers-optional",children:(0,d.jsx)(n.code,{children:"users"})})," - List or users (for simple auth)"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfigauthkeycloak-optional",children:(0,d.jsx)(n.code,{children:"keycloak"})})," - Auth config for Keycloak"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#appconfigauthheaderauth-optional",children:(0,d.jsx)(n.code,{children:"headerAuth"})})," - Auth config for HeaderAuth"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#section",children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"sections"})})})," - List of sections\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectiondisplaydata-optional",children:(0,d.jsx)(n.code,{children:"displayData"})})," - Section display settings\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers",children:(0,d.jsx)(n.code,{children:"show/hideForKeycloakUsers"})})," - Set user controls"]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectionicon-and-sectionitemicon",children:(0,d.jsx)(n.code,{children:"icon"})})," - Icon for a section"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectionitem",children:(0,d.jsx)(n.code,{children:"items"})})," - List of items\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectionicon-and-sectionitemicon",children:(0,d.jsx)(n.code,{children:"icon"})})," - Icon for an item"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#itemdisplaydata-optional",children:(0,d.jsx)(n.code,{children:"displayData"})})," - Item display settings\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers",children:(0,d.jsx)(n.code,{children:"show/hideForKeycloakUsers"})})," - Set user controls"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#sectionwidgets-optional",children:(0,d.jsx)(n.code,{children:"widgets"})})," - List of widgets"]}),"\n"]}),"\n"]}),"\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.a,{href:"#notes",children:(0,d.jsx)(n.strong,{children:"Notes"})}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"#editing-config-through-the-ui",children:"Editing Config through the UI"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"#about-yaml",children:"About YAML"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"#config-saving-methods",children:"Config Saving Methods"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"#preventing-changes",children:"Preventing Changes"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"#example",children:"Example"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h2,{id:"top-level-fields",children:"Top-Level Fields"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"pageInfo"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["Basic meta data like title, description, nav bar links, footer text. See ",(0,d.jsx)(n.a,{href:"#pageinfo",children:(0,d.jsx)(n.code,{children:"pageInfo"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"appConfig"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Settings related to how the app functions, including API keys and global styles. See ",(0,d.jsx)(n.a,{href:"#appconfig-optional",children:(0,d.jsx)(n.code,{children:"appConfig"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"sections"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["An array of sections, each containing an array of items, which will be displayed as links. See ",(0,d.jsx)(n.a,{href:"#section",children:(0,d.jsx)(n.code,{children:"section"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"pages"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An array additional config files, used for multi-page dashboards. See ",(0,d.jsx)(n.a,{href:"#pages-optional",children:(0,d.jsx)(n.code,{children:"pages"})})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsx)(n.h2,{id:"pageinfo",children:(0,d.jsx)(n.code,{children:"PageInfo"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"title"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"Your dashboard title, displayed in the header and browser tab"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"description"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Description of your dashboard, also displayed as a subtitle"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"navLinks"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Optional list of a maximum of 6 links, which will be displayed in the navigation bar. See ",(0,d.jsx)(n.a,{href:"#pageinfonavlinks-optional",children:(0,d.jsx)(n.code,{children:"navLinks"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"footerText"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Text to display in the footer (note that this will override the default footer content). This can also include HTML and inline CSS"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"logo"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The path to an image to display in the header (to the right of the title). This can be either local, where ",(0,d.jsx)(n.code,{children:"/"})," is the root of ",(0,d.jsx)(n.code,{children:"./public"}),", or any remote image, such as ",(0,d.jsx)(n.code,{children:"https://i.ibb.co/yhbt6CY/dashy.png"}),". It's recommended to scale your image down, so that it doesn't impact load times"]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"pageinfonavlinks-optional",children:[(0,d.jsx)(n.code,{children:"pageInfo.navLinks"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"title"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The text to display on the link button"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"path"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["The URL to navigate to when clicked. Can be relative (e.g. ",(0,d.jsx)(n.code,{children:"/about"}),") or absolute (e.g. ",(0,d.jsx)(n.code,{children:"https://example.com"})," or ",(0,d.jsx)(n.code,{children:"http://192.168.1.1"}),")"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"target"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The opening method (external links only). Can be either ",(0,d.jsx)(n.code,{children:"newtab"}),", ",(0,d.jsx)(n.code,{children:"sametab"}),", ",(0,d.jsx)(n.code,{children:"top"})," or ",(0,d.jsx)(n.code,{children:"parent"}),". Defaults to ",(0,d.jsx)(n.code,{children:"newtab"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"pages-optional",children:[(0,d.jsx)(n.code,{children:"pages[]"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"name"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"A unique name for that page"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"path"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["The path (local or remote) to the config file to use.",(0,d.jsx)(n.br,{}),"For files located within ",(0,d.jsx)(n.code,{children:"/user-data"}),", you only need to specify filename, for externally hosted files you must include the full URL"]})]})]})]}),"\n",(0,d.jsxs)(n.p,{children:["For more info, see the",(0,d.jsx)(n.a,{href:"/docs/pages-and-sections#multi-page-support",children:"Multi-Page docs"})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfig-optional",children:[(0,d.jsx)(n.code,{children:"appConfig"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"language"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The 2 (or 4-digit) ",(0,d.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes",children:"ISO 639-1 code"})," for your language, e.g. ",(0,d.jsx)(n.code,{children:"en"})," or ",(0,d.jsx)(n.code,{children:"en-GB"}),". This must be a language that the app has already been ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/src/assets/locales",children:"translated"})," into. If your language is unavailable, Dashy will fallback to English. By default Dashy will attempt to auto-detect your language, although this may not work on some privacy browsers."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.del,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"startingView"})})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"enum"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Which page to load by default, and on the base page or domain root. You can still switch to different views from within the UI. Can be either ",(0,d.jsx)(n.code,{children:"default"}),", ",(0,d.jsx)(n.code,{children:"minimal"})," or ",(0,d.jsx)(n.code,{children:"workspace"}),". Defaults to ",(0,d.jsx)(n.code,{children:"default"}),". NOTE: This has been replaced by an environmental variable: ",(0,d.jsx)(n.code,{children:"VUE_APP_STARTING_VIEW"})," in V3 onwards"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"defaultOpeningMethod"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"enum"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The default opening method for items, if no ",(0,d.jsx)(n.code,{children:"target"})," is specified for a given item. Can be either ",(0,d.jsx)(n.code,{children:"newtab"}),", ",(0,d.jsx)(n.code,{children:"sametab"}),", ",(0,d.jsx)(n.code,{children:"modal"}),", ",(0,d.jsx)(n.code,{children:"workspace"}),", ",(0,d.jsx)(n.code,{children:"clipboard"}),", ",(0,d.jsx)(n.code,{children:"top"})," or ",(0,d.jsx)(n.code,{children:"parent"}),". Defaults to ",(0,d.jsx)(n.code,{children:"newtab"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheck"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["When set to ",(0,d.jsx)(n.code,{children:"true"}),", Dashy will ping each of your services and display their status as a dot next to each item. This can be overridden by setting ",(0,d.jsx)(n.code,{children:"statusCheck"})," under each item. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckInterval"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The number of seconds between checks. If set to ",(0,d.jsx)(n.code,{children:"0"})," then service will only be checked on initial page load, which is usually the desired functionality. If value is less than ",(0,d.jsx)(n.code,{children:"10"})," you may experience a hit in performance. Defaults to ",(0,d.jsx)(n.code,{children:"0"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"webSearch"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Configuration options for the web search feature, set your default search engine, opening method or disable web search. See ",(0,d.jsx)(n.a,{href:"#appconfigwebsearch-optional",children:(0,d.jsx)(n.code,{children:"webSearch"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"backgroundImg"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Path to an optional full-screen app background image. This can be either remote (http) or local (relative to /app/public/item-icons/ inside the container). Note that this will slow down initial load"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableFontAwesome"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"})," font-awesome will be loaded, if set to ",(0,d.jsx)(n.code,{children:"false"})," they will not be. if left blank font-awesome will be enabled only if required by 1 or more icons"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableMaterialDesignIcons"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"})," mdi icons will be loaded, if set to ",(0,d.jsx)(n.code,{children:"false"})," they will not be. Where ",(0,d.jsx)(n.code,{children:"true"})," is enabled, if left blank material design icons will be enabled only if required by 1 or more icons"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"fontAwesomeKey"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If you have a font-awesome key, then you can use it here and make use of premium icons. It is a 10-digit alpha-numeric string from you're FA kit URL (e.g. ",(0,d.jsx)(n.code,{children:"13014ae648"}),")"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"faviconApi"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"enum"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Only applicable if you are using favicons for item icons. Specifies which service to use to resolve favicons. Set to ",(0,d.jsx)(n.code,{children:"local"})," to do this locally, without using an API. Services running locally will use this option always. Available options are: ",(0,d.jsx)(n.code,{children:"local"}),", ",(0,d.jsx)(n.code,{children:"allesedv"}),", ",(0,d.jsx)(n.code,{children:"iconhorse"}),", ",(0,d.jsx)(n.code,{children:"faviconkit"}),", ",(0,d.jsx)(n.code,{children:"duckduckgo"}),", ",(0,d.jsx)(n.code,{children:"yandex"}),", ",(0,d.jsx)(n.code,{children:"google"}),", ",(0,d.jsx)(n.code,{children:"besticon"}),", ",(0,d.jsx)(n.code,{children:"webmasterapi"})," and ",(0,d.jsx)(n.code,{children:"mcapi"}),". Defaults to ",(0,d.jsx)(n.code,{children:"allesedv"}),". See ",(0,d.jsx)(n.a,{href:"/docs/icons#favicons",children:"Icons"})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"auth"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["All settings relating to user authentication. See ",(0,d.jsx)(n.a,{href:"#appconfigauth-optional",children:(0,d.jsx)(n.code,{children:"auth"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"defaultIcon"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An icon to be applied to any items, which don't already have an icon set. See ",(0,d.jsx)(n.a,{href:"/docs/icons#default-icon",children:"Icon Docs"})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"layout"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"enum"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Layout for homepage, either ",(0,d.jsx)(n.code,{children:"horizontal"}),", ",(0,d.jsx)(n.code,{children:"vertical"})," or ",(0,d.jsx)(n.code,{children:"auto"}),". Defaults to ",(0,d.jsx)(n.code,{children:"auto"}),". This specifies the layout and direction of how sections are positioned on the home screen. This can also be modified and overridden from the UI."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"iconSize"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"enum"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The size of link items / icons. Can be either ",(0,d.jsx)(n.code,{children:"small"}),", ",(0,d.jsx)(n.code,{children:"medium,"})," or ",(0,d.jsx)(n.code,{children:"large"}),". Defaults to ",(0,d.jsx)(n.code,{children:"medium"}),". This can also be set directly from the UI."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"colCount"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The number of columns of sections displayed on the homepage, using the default view. Should be in integer between ",(0,d.jsx)(n.code,{children:"1"})," and ",(0,d.jsx)(n.code,{children:"8"}),". Note that by default this is applied responsively, based on current screen size, and specifying a value here will override this behavior, which may not be desirable."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"theme"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The default theme for first load (you can change this later from the UI)"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"cssThemes"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"An array of custom theme names which can be used in the theme switcher dropdown"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"customColors"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Enables you to apply a custom color palette to any given theme. Use the theme name (lowercase) as the key, for an object including key-value-pairs, with the color variable name as keys, and 6-digit hex code as value. See ",(0,d.jsx)(n.a,{href:"/docs/theming#modifying-theme-colors",children:"Theming"})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"externalStyleSheet"})})}),(0,d.jsxs)(n.td,{children:[(0,d.jsx)(n.code,{children:"string"})," or ",(0,d.jsx)(n.code,{children:"string[]"})]}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Either a URL to an external stylesheet or an array or URLs, which can be applied as themes within the UI"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"customCss"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Raw CSS that will be applied to the page. This can also be set from the UI. Please minify it first."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideComponents"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["A list of key page components (header, footer, search, settings, etc) that are present by default, but can be removed using this option. See ",(0,d.jsx)(n.a,{href:"#appconfighidecomponents-optional",children:(0,d.jsx)(n.code,{children:"appConfig.hideComponents"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"routingMode"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Can be either ",(0,d.jsx)(n.code,{children:"hash"})," or ",(0,d.jsx)(n.code,{children:"history"}),". Determines the URL format for sub-pages, hash mode will look like ",(0,d.jsx)(n.code,{children:"/#/home"})," whereas with history mode available you have nice clean URLs, like ",(0,d.jsx)(n.code,{children:"/home"}),". For more info, see the ",(0,d.jsx)(n.a,{href:"https://router.vuejs.org/guide/essentials/history-mode.html#example-server-configurations",children:"Vue docs"}),". If you're hosting Dashy with a custom BASE_URL, you will find that a bit of extra server config is necessary to get history mode working, so here you may want to instead use ",(0,d.jsx)(n.code,{children:"hash"})," mode.Defaults to ",(0,d.jsx)(n.code,{children:"history"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableMultiTasking"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"If set to true, will keep apps open in the background when in the workspace view. Useful for quickly switching between multiple sites, and preserving their state, but comes at the cost of performance."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"workspaceLandingUrl"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The URL or an app, service or website to launch when the workspace view is opened, before another service has been launched"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"preventWriteToDisk"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", users will be prevented from saving config changes to disk through the UI"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"preventLocalSave"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", users will be prevented from applying config changes to local storage"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableConfiguration"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"If set to true, no users will be able to view or edit the config through the UI"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableConfigurationForNonAdmin"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"If set to true, only admin users will be able to view or edit the config through the UI. disableConfiguration must not be set to true."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"widgetsAlwaysUseProxy"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", requests made by widgets will always be proxied, same as setting ",(0,d.jsx)(n.code,{children:"useProxy: true"})," on each widget. Note that this may break some widgets."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"showSplashScreen"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", a loading screen will be shown. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableErrorReporting"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Enable reporting of unexpected errors and crashes. This is off by default, and ",(0,d.jsx)(n.strong,{children:"no data will ever be captured unless you explicitly enable it"}),". Turning on error reporting helps previously unknown bugs get discovered and fixed. Dashy uses ",(0,d.jsx)(n.a,{href:"https://github.com/getsentry/sentry",children:"Sentry"})," for error reporting. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"sentryDsn"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If you need to monitor errors in your instance, then you can use Sentry to collect and process bug reports. Sentry can be self-hosted, or used as SaaS, once your instance is setup, then all you need to do is pass in the DSN here, and enable error reporting. You can learn more on the ",(0,d.jsx)(n.a,{href:"https://docs.sentry.io/product/sentry-basics/dsn-explainer/",children:"Sentry DSN Docs"}),". Note that this will only ever be used if ",(0,d.jsx)(n.code,{children:"enableErrorReporting"})," is explicitly enabled."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableSmartSort"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["For the most-used and last-used app sort functions to work, a basic open-count is stored in local storage. If you do not want this to happen, then disable smart sort here, but you wil no longer be able to use these sort options. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableUpdateChecks"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to true, Dashy will not check for updates. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableServiceWorker"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Service workers cache web applications to improve load times and offer basic offline functionality, and are disabled by default in Dashy. The service worker can sometimes cause older content to be cached, requiring the app to be hard-refreshed. If you do not want SW functionality, or are having issues with caching, set this property to ",(0,d.jsx)(n.code,{children:"false"})," to disable all service workers."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableContextMenu"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the custom right-click context menu will be disabled. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigauth-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.auth"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:["[!NOTE]\nSince the auth is initiated in the main app entry point (for security), a rebuild is required to apply changes to the auth configuration.\nYou can trigger a rebuild through the UI, under Config --\x3e Rebuild, or by running ",(0,d.jsx)(n.code,{children:"yarn build"})," in the root directory."]}),"\n"]}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:["[!WARNING]\nBuilt-in auth should ",(0,d.jsx)(n.strong,{children:"not be used"})," for security-critical applications, or if your Dashy instance is publicly accessible.\nFor these, it is recommended to use an ",(0,d.jsx)(n.a,{href:"/docs/authentication#alternative-authentication-methods",children:"alternate authentication method"}),"."]}),"\n"]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"users"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An array of objects containing usernames and hashed passwords. If this is not provided, then authentication will be off by default, and you will not need any credentials to access the app. See ",(0,d.jsx)(n.a,{href:"#appconfigauthusers-optional",children:(0,d.jsx)(n.code,{children:"appConfig.auth.users"})}),". ",(0,d.jsx)(n.br,{}),(0,d.jsx)(n.strong,{children:"Note"})," this method of authentication is handled on the client side, so for security critical situations, it is recommended to use an ",(0,d.jsx)(n.a,{href:"/docs/authentication#alternative-authentication-methods",children:"alternate authentication method"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableKeycloak"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", then authentication using Keycloak will be enabled. Note that you need to have an instance running, and have also configured ",(0,d.jsx)(n.code,{children:"auth.keycloak"}),". Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"keycloak"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Config options to point Dashy to your Keycloak server. Requires ",(0,d.jsx)(n.code,{children:"enableKeycloak: true"}),". See ",(0,d.jsx)(n.a,{href:"#appconfigauthkeycloak-optional",children:(0,d.jsx)(n.code,{children:"auth.keycloak"})})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableHeaderAuth"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", then authentication using HeaderAuth will be enabled. Note that you need to have your web server/reverse proxy running, and have also configured ",(0,d.jsx)(n.code,{children:"auth.headerAuth"}),". Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"headerAuth"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Config options to point Dashy to your headers for authentication. Requires ",(0,d.jsx)(n.code,{children:"enableHeaderAuth: true"}),". See ",(0,d.jsx)(n.a,{href:"#appconfigauthheaderauth-optional",children:(0,d.jsx)(n.code,{children:"auth.headerAuth"})})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableOidc"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", then authentication using OIDC will be enabled. Note that you need to have a configured OIDC server and configure it with ",(0,d.jsx)(n.code,{children:"auth.oidc"}),". Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"oidc"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Config options to point Dash to your OIDC configuration. Request ",(0,d.jsx)(n.code,{children:"enableOidc: true"}),". See ",(0,d.jsx)(n.a,{href:"#appconfigauthoidc-optional",children:(0,d.jsx)(n.code,{children:"auth.oidc"})})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"enableGuestAccess"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["When set to ",(0,d.jsx)(n.code,{children:"true"}),", an unauthenticated user will be able to access the dashboard, with read-only access, without having to login. Requires ",(0,d.jsx)(n.code,{children:"auth.users"})," to be configured. Defaults to ",(0,d.jsx)(n.code,{children:"false"}),"."]})]})]})]}),"\n",(0,d.jsxs)(n.p,{children:["For more info, see the ",(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"/docs/authentication",children:"Authentication Docs"})})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigauthusers-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.auth.users"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"user"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"Username to log in with"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hash"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"A SHA-256 hashed password"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"type"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The user type, either admin or normal"})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigauthkeycloak-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.auth.keycloak"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"serverUrl"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The URL (or URL/ IP + Port) where your keycloak server is running"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"realm"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The name of the realm (must already be created) that you want to use"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"clientId"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The Client ID of the client you created for use with Dashy"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"legacySupport"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If using Keycloak 17 or older, then set this to ",(0,d.jsx)(n.code,{children:"true"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigauthheaderauth-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.auth.headerAuth"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"userHeader"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The Header name which contains username (default: REMOTE_USER). Case insensitive"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"proxyWhitelist"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"An array of Upstream proxy servers to expect authencticated requests from"})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigauthoidc-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.auth.oidc"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"clientId"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The client id registered in the OIDC server"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"endpoint"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The URL of the OIDC server that should be used."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"adminRole"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The role that will be considered as admin."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"adminGroup"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The group that will be considered as admin."})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"scope"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The scope(s) to request from the OIDC provider"})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfigwebsearch-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.webSearch"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"disableWebSearch"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Web search is enabled by default, but can be disabled by setting this property to ",(0,d.jsx)(n.code,{children:"true"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"searchEngine"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Set the key name for your search engine. Can also use a custom engine by setting this property to ",(0,d.jsx)(n.code,{children:"custom"}),". Currently supported: ",(0,d.jsx)(n.code,{children:"duckduckgo"}),", ",(0,d.jsx)(n.code,{children:"google"}),", ",(0,d.jsx)(n.code,{children:"whoogle"}),", ",(0,d.jsx)(n.code,{children:"qwant"}),", ",(0,d.jsx)(n.code,{children:"startpage"}),", ",(0,d.jsx)(n.code,{children:"searx-bar"})," and ",(0,d.jsx)(n.code,{children:"searx-info"}),". Defaults to ",(0,d.jsx)(n.code,{children:"duckduckgo"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"customSearchEngine"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["You can also use a custom search engine, or your own self-hosted instance. This requires ",(0,d.jsx)(n.code,{children:"searchEngine: custom"})," to be set. Then add the URL of your service, with GET query string included here"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"openingMethod"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Set your preferred opening method for search results: ",(0,d.jsx)(n.code,{children:"newtab"}),", ",(0,d.jsx)(n.code,{children:"sametab"}),", ",(0,d.jsx)(n.code,{children:"workspace"}),". Defaults to ",(0,d.jsx)(n.code,{children:"newtab"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"searchBangs"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["A key-value-pair set of custom search ",(0,d.jsx)(n.em,{children:"bangs"})," for redirecting query to a specific app or search engine. The key of each should be the bang you will type (typically starting with ",(0,d.jsx)(n.code,{children:"/"}),", ",(0,d.jsx)(n.code,{children:"!"})," or ",(0,d.jsx)(n.code,{children:":"}),"), and value is the destination, either as a search engine key (e.g. ",(0,d.jsx)(n.code,{children:"reddit"}),") or a URL with search parameters (e.g. ",(0,d.jsx)(n.code,{children:"https://en.wikipedia.org/w/?search="}),")"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"openUrlsDirectly"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If ",(0,d.jsx)(n.code,{children:"true"}),", queries that look like URLs will be opened directly instead of searched. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"appconfighidecomponents-optional",children:[(0,d.jsx)(n.code,{children:"appConfig.hideComponents"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideHeading"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the page title & sub-title will not be visible. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideNav"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the navigation menu will not be visible. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideSearch"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the search bar will not be visible. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideSettings"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the settings menu will be initially collapsed. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideFooter"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If set to ",(0,d.jsx)(n.code,{children:"true"}),", the footer will not be visible. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsx)(n.h2,{id:"section",children:(0,d.jsx)(n.code,{children:"section"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"name"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsx)(n.td,{children:"The title for the section"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"icon"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An single icon to be displayed next to the title. See ",(0,d.jsx)(n.a,{href:"#sectionicon-and-sectionitemicon",children:(0,d.jsx)(n.code,{children:"section.icon"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"items"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An array of items to be displayed within the section. See ",(0,d.jsx)(n.a,{href:"#sectionitem",children:(0,d.jsx)(n.code,{children:"item"})}),". Sections must include either 1 or more items, or 1 or more widgets."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"widgets"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"array"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["An array of widgets to be displayed within the section. See ",(0,d.jsx)(n.a,{href:"#sectionwidgets-optional",children:(0,d.jsx)(n.code,{children:"widget"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"displayData"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Meta-data to optionally override display settings for a given section. See ",(0,d.jsx)(n.a,{href:"#sectiondisplaydata-optional",children:(0,d.jsx)(n.code,{children:"displayData"})})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsx)(n.h2,{id:"sectionitem",children:(0,d.jsx)(n.code,{children:"section.item"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"title"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["The text to display/ title of a given item. Max length ",(0,d.jsx)(n.code,{children:"18"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"description"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Additional info about an item, which is shown in the tooltip on hover, or visible on large tiles"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"url"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The URL / location of web address for when the item is clicked"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"icon"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The icon for a given item. Can be a font-awesome icon, favicon, remote URL or local URL. See ",(0,d.jsx)(n.a,{href:"#sectionicon-and-sectionitemicon",children:(0,d.jsx)(n.code,{children:"item.icon"})})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"target"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The opening method for when the item is clicked, either ",(0,d.jsx)(n.code,{children:"newtab"}),", ",(0,d.jsx)(n.code,{children:"sametab"}),", ",(0,d.jsx)(n.code,{children:"modal"}),", ",(0,d.jsx)(n.code,{children:"workspace"}),", ",(0,d.jsx)(n.code,{children:"clipboard"}),", ",(0,d.jsx)(n.code,{children:"top"})," or ",(0,d.jsx)(n.code,{children:"parent"}),". Where ",(0,d.jsx)(n.code,{children:"newtab"})," will open the link in a new tab, ",(0,d.jsx)(n.code,{children:"sametab"})," will open it in the current tab, and ",(0,d.jsx)(n.code,{children:"modal"})," will open a pop-up modal, ",(0,d.jsx)(n.code,{children:"workspace"})," will open in the Workspace view and ",(0,d.jsx)(n.code,{children:"clipboard"})," will copy the URL to system clipboard (but not launch app). Defaults to ",(0,d.jsx)(n.code,{children:"newtab"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hotkey"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Give frequently opened applications a numeric hotkey, between ",(0,d.jsx)(n.code,{children:"0 - 9"}),". You can then just press that key to launch that application."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"tags"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"A list of tags, which can be used for improved search"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheck"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["When set to ",(0,d.jsx)(n.code,{children:"true"}),", Dashy will ping the URL associated with the current service, and display its status as a dot next to the item. The value here will override ",(0,d.jsx)(n.code,{children:"appConfig.statusCheck"})," so you can turn off or on checks for a given service. Defaults to ",(0,d.jsx)(n.code,{children:"appConfig.statusCheck"}),", falls back to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckUrl"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If you've enabled ",(0,d.jsx)(n.code,{children:"statusCheck"}),", and want to use a different URL to what is defined under the item, then specify it here"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckHeaders"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"If you're endpoint requires any specific headers for the status checking, then define them here"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckAllowInsecure"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["By default, any request to insecure content will be blocked. Setting this option to ",(0,d.jsx)(n.code,{children:"true"})," will disable the ",(0,d.jsx)(n.code,{children:"rejectUnauthorized"})," option, enabling you to ping non-HTTPS services for the current item. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckAcceptCodes"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If your service's response code is anything other than 2xx, then you can opt to specify an alternative success code. E.g. if you expect your server to return 403, but still want the status indicator to be green, set this value to ",(0,d.jsx)(n.code,{children:"403"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"statusCheckMaxRedirects"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If your service redirects to another page, and you would like status checks to follow redirects, then specify the maximum number of redirects here. Defaults to ",(0,d.jsx)(n.code,{children:"0"})," / will not follow redirects"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"color"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"An optional color for the text and font-awesome icon to be displayed in. Note that this will override the current theme and so may not display well"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"rel"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The value of the ",(0,d.jsx)(n.code,{children:"rel"})," attribute for the link. Useful for specifying the relationship between the target link/document and Dashy. Defaults to ",(0,d.jsx)(n.code,{children:"noopener noreferrer"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"backgroundColor"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"An optional background fill color for the that given item. Again, this will override the current theme and so might not display well against the background"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"provider"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"The name of the provider for a given service, useful for when including hosted apps. In some themes, this is visible under the item name"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"displayData"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Meta-data to optionally override display settings for a given item. See ",(0,d.jsx)(n.a,{href:"#itemdisplaydata-optional",children:(0,d.jsx)(n.code,{children:"displayData"})})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"itemdisplaydata-optional",children:[(0,d.jsx)(n.code,{children:"item.displayData"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current item will be visible to all users, except for those specified in this list"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"showForUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current item will be hidden from all users, except for those specified in this list"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForGuests"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current item will be visible for logged in users, but not for guests (see ",(0,d.jsx)(n.code,{children:"appConfig.enableGuestAccess"}),"). Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForKeycloakUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current item will be visible to all keycloak users, except for those configured via these groups and roles. See ",(0,d.jsx)(n.code,{children:"hideForKeycloakUsers"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"showForKeycloakUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current item will be hidden from all keycloak users, except for those configured via these groups and roles. See ",(0,d.jsx)(n.code,{children:"showForKeycloakUsers"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideFromWorkspace"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current item will be visible in the default view but not in the Workspace view sidebar. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"sectionwidgets-optional",children:[(0,d.jsx)(n.code,{children:"section.widgets"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"type"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:"Required"}),(0,d.jsxs)(n.td,{children:["The widget type. See ",(0,d.jsx)(n.a,{href:"/docs/widgets",children:"Widget Docs"})," for full list of supported widgets"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"options"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Some widgets accept either optional or required additional options. Again, see the ",(0,d.jsx)(n.a,{href:"/docs/widgets",children:"Widget Docs"})," for full list of options"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"updateInterval"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["You can keep a widget constantly updated by specifying an update interval, in seconds. See ",(0,d.jsx)(n.a,{href:"/docs/widgets#continuous-updates",children:"Continuous Updates Docs"})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"useProxy"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Some widgets make API requests to services that are not CORS-enabled. For these instances, you will need to route requests through a proxy, Dashy has a built in CORS-proxy, which you can use by setting this option to ",(0,d.jsx)(n.code,{children:"true"}),". Defaults to ",(0,d.jsx)(n.code,{children:"false"}),". See the ",(0,d.jsx)(n.a,{href:"/docs/widgets#proxying-requests",children:"Proxying Requests Docs"})," for more info"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"timeout"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Request timeout in milliseconds, defaults to \xbd a second (",(0,d.jsx)(n.code,{children:"500"}),")"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"ignoreErrors"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Prevent an error message being displayed, if a network request or something else fails. Useful for false-positives"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"label"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Add custom label to a given widget. Useful for identification, if there are multiple of the same type of widget in a single section"})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"sectiondisplaydata-optional",children:[(0,d.jsx)(n.code,{children:"section.displayData"})," ",(0,d.jsx)(n.em,{children:"(optional)"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"sortBy"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The sort order for items within the current section. By default items are displayed in the order in which they are listed in within the config. The following sort options are supported: ",(0,d.jsx)(n.code,{children:"most-used"})," (most opened apps first), ",(0,d.jsx)(n.code,{children:"last-used"})," (the most recently used apps), ",(0,d.jsx)(n.code,{children:"alphabetical"}),", ",(0,d.jsx)(n.code,{children:"reverse-alphabetical"}),", ",(0,d.jsx)(n.code,{children:"random"})," and ",(0,d.jsx)(n.code,{children:"default"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"collapsed"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["If true, the section will be collapsed initially, and will need to be clicked to open. Useful for less regularly used, or very long sections. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"cutToHeight"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"By default, sections will fill available space. Set this option to true to match section height with content height"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"rows"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Height of the section, specified as the number of rows it should span vertically, e.g. ",(0,d.jsx)(n.code,{children:"2"}),". Defaults to ",(0,d.jsx)(n.code,{children:"1"}),". Max is ",(0,d.jsx)(n.code,{children:"5"}),"."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"cols"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Width of the section, specified as the number of columns the section should span horizontally, e.g. ",(0,d.jsx)(n.code,{children:"2"}),". Defaults to ",(0,d.jsx)(n.code,{children:"1"}),". Max is ",(0,d.jsx)(n.code,{children:"6"}),". Will be clamped to the page's active column count so that a section never exceeds the available grid width."]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"itemSize"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Specify the size for items within this group, either ",(0,d.jsx)(n.code,{children:"small"}),", ",(0,d.jsx)(n.code,{children:"medium"})," or ",(0,d.jsx)(n.code,{children:"large"}),". Note that this will override any settings specified through the UI"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"color"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["A custom accent color for the section, as a hex code or HTML color (e.g. ",(0,d.jsx)(n.code,{children:"#fff"}),")"]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"customStyles"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Custom CSS properties that should be applied to that section, e.g. ",(0,d.jsx)(n.code,{children:"border: 2px dashed #ff0000;"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"sectionLayout"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Specify which CSS layout will be used to responsively place items. Can be either ",(0,d.jsx)(n.code,{children:"auto"})," (which uses flex layout), or ",(0,d.jsx)(n.code,{children:"grid"}),". If ",(0,d.jsx)(n.code,{children:"grid"})," is selected, then ",(0,d.jsx)(n.code,{children:"itemCountX"})," and ",(0,d.jsx)(n.code,{children:"itemCountY"})," may also be set. Defaults to ",(0,d.jsx)(n.code,{children:"auto"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"itemCountX"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The number of items to display per row / horizontally. If not set, it will be calculated automatically based on available space. Can only be set if ",(0,d.jsx)(n.code,{children:"sectionLayout"})," is set to ",(0,d.jsx)(n.code,{children:"grid"}),". Must be a whole number between ",(0,d.jsx)(n.code,{children:"1"})," and ",(0,d.jsx)(n.code,{children:"12"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"itemCountY"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"number"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The number of items to display per column / vertically. If not set, it will be calculated automatically based on available space. If ",(0,d.jsx)(n.code,{children:"itemCountX"})," is set, then ",(0,d.jsx)(n.code,{children:"itemCountY"})," can be calculated automatically. Can only be set if ",(0,d.jsx)(n.code,{children:"sectionLayout"})," is set to ",(0,d.jsx)(n.code,{children:"grid"}),". Must be a whole number between ",(0,d.jsx)(n.code,{children:"1"})," and ",(0,d.jsx)(n.code,{children:"12"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current section will be visible to all users, except for those specified in this list"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"showForUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current section will be hidden from all users, except for those specified in this list"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForGuests"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current section will be visible for logged in users, but not for guests (see ",(0,d.jsx)(n.code,{children:"appConfig.enableGuestAccess"}),"). Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideForKeycloakUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current section will be visible to all keycloak users, except for those configured via these groups and roles. See ",(0,d.jsx)(n.code,{children:"hideForKeycloakUsers"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"showForKeycloakUsers"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"object"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current section will be hidden from all keycloak users, except for those configured via these groups and roles. See ",(0,d.jsx)(n.code,{children:"showForKeycloakUsers"})]})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"hideFromWorkspace"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"boolean"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["Current section will be visible in the default view but not in the Workspace view sidebar. Defaults to ",(0,d.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"sectionicon-and-sectionitemicon",children:[(0,d.jsx)(n.code,{children:"section.icon"})," and ",(0,d.jsx)(n.code,{children:"section.item.icon"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsx)(n.tbody,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"icon"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsxs)(n.td,{children:["The icon for a given item or section. ",(0,d.jsx)(n.br,{}),"See ",(0,d.jsx)(n.a,{href:"/docs/icons",children:"Icon Docs"})," for all available supported icon types, including: auto-fetched favicons, generative icons, emoji icons, home-lab service logos, font-awesome, simple-icons, material icons, selfh.st icons, and icons specified by URL"]})]})})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsxs)(n.h2,{id:"sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers",children:[(0,d.jsx)(n.code,{children:"section.displayData.hideForKeycloakUsers"}),", ",(0,d.jsx)(n.code,{children:"section.displayData.showForKeycloakUsers"}),", ",(0,d.jsx)(n.code,{children:"item.displayData.hideForKeycloakUsers"})," and ",(0,d.jsx)(n.code,{children:"item.displayData.showForKeycloakUsers"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,d.jsxs)(n.table,{children:[(0,d.jsx)(n.thead,{children:(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Field"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Type"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Required"})}),(0,d.jsx)(n.th,{children:(0,d.jsx)(n.strong,{children:"Description"})})]})}),(0,d.jsxs)(n.tbody,{children:[(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"groups"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current Section or Item will be hidden or shown based on the user having any of the groups in this list"})]}),(0,d.jsxs)(n.tr,{children:[(0,d.jsx)(n.td,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.code,{children:"roles"})})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.code,{children:"string[]"})}),(0,d.jsx)(n.td,{children:(0,d.jsx)(n.em,{children:"Optional"})}),(0,d.jsx)(n.td,{children:"Current Section or Item will be hidden or shown based on the user having any of the roles in this list"})]})]})]}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h2,{id:"notes",children:"Notes"}),"\n",(0,d.jsx)(n.h3,{id:"editing-config-through-the-ui",children:"Editing Config through the UI"}),"\n",(0,d.jsxs)(n.p,{children:["Config can be modified directly through the UI, and then written to disk, or applied locally. This can be done wither with the raw config editor (introduced in V 0.6.5 / ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/pull/3",children:"#3"}),"), or the interactive editor (introduced in V 1.8.9 / ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/pull/298",children:"#298"}),")."]}),"\n ",(0,d.jsxs)(n.a,{href:"https://ibb.co/CzkyMNb",children:["\n ",(0,d.jsx)(n.b,{children:"Interactive Editor"}),(0,d.jsx)(n.br,{}),"\n ",(0,d.jsx)(n.img,{alt:"Interactive Editor demo",src:"https://user-images.githubusercontent.com/1862727/139543020-b0576d28-0830-476f-afc8-a815d4de6def.gif",width:"600"}),"\n "]}),"\n ",(0,d.jsx)(n.br,{}),"\n ",(0,d.jsxs)(n.a,{href:"https://ibb.co/zRv542H",children:["\n ",(0,d.jsx)(n.b,{children:"JSON Editor"}),(0,d.jsx)(n.br,{}),"\n ",(0,d.jsx)(n.img,{alt:"Config Editor demo",src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/config-editor-demo.gif",width:"600"}),"\n "]}),"\n",(0,d.jsx)(n.h3,{id:"about-yaml",children:"About YAML"}),"\n",(0,d.jsxs)(n.p,{children:["If you're new to YAML, it's pretty straight-forward. The format is exactly the same as that of JSON, but instead of using curly braces, structure is denoted using whitespace. This ",(0,d.jsx)(n.a,{href:"https://linuxhandbook.com/yaml-basics/",children:"quick guide"})," should get you up to speed in a few minutes, for more advanced topics take a look at this ",(0,d.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/YAML",children:"Wikipedia article"}),"."]}),"\n",(0,d.jsx)(n.h3,{id:"config-saving-methods",children:"Config Saving Methods"}),"\n",(0,d.jsxs)(n.p,{children:["When updating the config through the JSON editor in the UI, you have two save options: ",(0,d.jsx)(n.strong,{children:"Local"})," or ",(0,d.jsx)(n.strong,{children:"Write to Disk"}),"."]}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:"Changes saved locally will only be applied to the current user through the browser, and will not apply to other instances - you either need to use the cloud sync feature, or manually update the conf.yml file."}),"\n",(0,d.jsxs)(n.li,{children:["On the other-hand, if you choose to write changes to disk, then your main ",(0,d.jsx)(n.code,{children:"conf.yml"})," file will be updated, and changes will be applied to all users, and visible across all devices. For this functionality to work, you must be running Dashy with using the Docker container, or the Node server. A backup of your current configuration will also be saved in the same directory."]}),"\n"]}),"\n",(0,d.jsx)(n.h3,{id:"preventing-changes",children:"Preventing Changes"}),"\n",(0,d.jsxs)(n.p,{children:["If you have authentication set up, then any user who is not an admin (with ",(0,d.jsx)(n.code,{children:"type: admin"}),") will not be able to write changes to disk."]}),"\n",(0,d.jsxs)(n.p,{children:["You can also prevent changes from any user being written to disk, using ",(0,d.jsx)(n.code,{children:"preventWriteToDisk"}),". Or prevent any changes from being saved locally in browser storage, using ",(0,d.jsx)(n.code,{children:"preventLocalSave"}),"."]}),"\n",(0,d.jsxs)(n.p,{children:["To disable all UI config features, set ",(0,d.jsx)(n.code,{children:"disableConfiguration"}),". Alternatively you can disable UI config features for all non Admin users by setting ",(0,d.jsx)(n.code,{children:"disableConfigurationForNonAdmin"})," to true."]}),"\n",(0,d.jsx)(n.h3,{id:"example",children:"Example"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-yaml",children:"---\npageInfo:\n title: Home Lab\nsections: # An array of sections\n- name: Section 1 - Getting Started\n items: # An array of items\n - title: GitHub\n description: Source code and documentation on GitHub\n icon: fab fa-github\n url: https://github.com/Lissy93/dashy\n - title: Issues\n description: View currently open issues, or raise a new one\n icon: fas fa-bug\n url: https://github.com/Lissy93/dashy/issues\n - title: Demo\n description: A live demo\n icon: far fa-rocket\n url: https://dashy-demo-1.netlify.app\n- name: Section 2 - Local Services\n items:\n - title: Firewall\n icon: favicon\n url: http://192.168.1.1/\n - title: Game Server\n icon: https://i.ibb.co/710B3Yc/space-invader-x256.png\n url: http://192.168.130.1/\n"})}),"\n",(0,d.jsxs)(n.p,{children:["For more example config files, see: ",(0,d.jsx)(n.a,{href:"https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10",children:"this gist"})]}),"\n",(0,d.jsxs)(n.p,{children:["If you need any help, feel free to ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%A4%B7%E2%80%8D%E2%99%82%EF%B8%8F+Question&template=question.md&title=%5BQUESTION%5D",children:"Raise an Issue"})," or ",(0,d.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/discussions",children:"Start a Discussion"})]}),"\n",(0,d.jsx)(n.p,{children:"Happy Configuring \ud83e\udd13\ud83d\udd27"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.strong,{children:(0,d.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(h,{...e})}):h(e)}},8453(e,n,s){s.d(n,{R:()=>t,x:()=>c});var i=s(6540);const d={},r=i.createContext(d);function t(e){const n=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4d54d076.91692194.js b/assets/js/4d54d076.abffaadf.js similarity index 99% rename from assets/js/4d54d076.91692194.js rename to assets/js/4d54d076.abffaadf.js index 6867e238..3331d6c7 100644 --- a/assets/js/4d54d076.91692194.js +++ b/assets/js/4d54d076.abffaadf.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[1459],{2199(e,s,t){t.r(s),t.d(s,{assets:()=>l,contentTitle:()=>n,default:()=>c,frontMatter:()=>r,metadata:()=>o,toc:()=>h});const o=JSON.parse('{"id":"contributing","title":"Contributing","description":"First off, thank you for considering contributing towards Dashy! \ud83d\ude4c","source":"@site/docs/contributing.md","sourceDirName":".","slug":"/contributing","permalink":"/docs/contributing","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/contributing.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"*Dashy Showcase* \ud83c\udf1f","permalink":"/docs/showcase"},"next":{"title":"Developing","permalink":"/docs/developing"}}');var a=t(4848),i=t(8453);const r={},n="Contributing",l={},h=[{value:"Take a 2-minute survey",id:"take-a-2-minute-survey",level:2},{value:"Share your dashboard",id:"share-your-dashboard",level:2},{value:"Make a small donation",id:"make-a-small-donation",level:2},{value:"You can also send a one-off small contribution using crypto",id:"you-can-also-send-a-one-off-small-contribution-using-crypto",level:3},{value:"Enable Anonymous Bug Reports",id:"enable-anonymous-bug-reports",level:2},{value:"Add Translations",id:"add-translations",level:2},{value:"Submit a PR",id:"submit-a-pr",level:2},{value:"Improve the Docs",id:"improve-the-docs",level:2},{value:"Raise a bug",id:"raise-a-bug",level:2},{value:"Join the discussion",id:"join-the-discussion",level:2},{value:"Request a feature via BountySource",id:"request-a-feature-via-bountysource",level:2},{value:"Spread the word",id:"spread-the-word",level:2},{value:"Star, Upvote or Leave a Review",id:"star-upvote-or-leave-a-review",level:2},{value:"Follow for More",id:"follow-for-more",level:2},{value:"Contributors",id:"contributors",level:3},{value:"Star-Gazers Over Time",id:"star-gazers-over-time",level:3}];function d(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(s.header,{children:(0,a.jsx)(s.h1,{id:"contributing",children:"Contributing"})}),"\n",(0,a.jsxs)(s.p,{children:["First off, thank you for considering contributing towards Dashy! \ud83d\ude4c\nThere are several ways that you can help out, and any contributions, however small will always be very much appreciated.\nYou will be appropriately credited in the readme - huge thank you to ",(0,a.jsx)(s.a,{href:"/docs/credits",children:"everyone who has helped"})," so far \ud83d\udc9e"]}),"\n",(0,a.jsx)(s.h2,{id:"take-a-2-minute-survey",children:"Take a 2-minute survey"}),"\n",(0,a.jsx)(s.p,{children:"Help improve Dashy by taking a very short, 6-question survey. This will give me a better understanding of what is important to you, so that I can make Dashy better in the future :)"}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://survey.typeform.com/to/gl0L68ou",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Take_the-Survey-%231a86fd?style=for-the-badge&logo=buddy",alt:"Take the Survey"})})}),"\n",(0,a.jsx)(s.h2,{id:"share-your-dashboard",children:"Share your dashboard"}),"\n",(0,a.jsxs)(s.p,{children:["Dashy now has a ",(0,a.jsx)(s.a,{href:"/docs/showcase",children:"Showcase"})," where you can show off a screenshot of your dashboard, and get inspiration from other users (and I really love seeing how people are using Dashy). To ",(0,a.jsx)(s.a,{href:"/docs/showcase#submitting-your-dashboard",children:"submit your dashboard"}),", either open a PR or raise an issue."]}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/issues/new?assignees=&labels=%F0%9F%92%AF+Showcase&template=showcase-addition.yml&title=%5BSHOWCASE%5D+%3Ctitle%3E",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Add_your_Dashboard-Showcase-%238616ee?style=for-the-badge&logo=feathub&logoColor=8616ee",alt:"Add your Dashboard to the Showcase"})})}),"\n",(0,a.jsx)(s.h2,{id:"make-a-small-donation",children:"Make a small donation"}),"\n",(0,a.jsx)(s.p,{children:"Donations help to cover server costs, development time and caffeine ;)\nDon't feel any pressure to donate anything, as Dashy and my other projects will always be 100% free, for everyone, for ever."}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://github.com/sponsors/Lissy93",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Sponsor_on_GitHub-Lissy93-%23ff4dda?style=for-the-badge&logo=githubsponsors&logoColor=ff4dda",alt:"Sponsor Lissy93 on GitHub"})})}),"\n",(0,a.jsxs)(s.p,{children:["Sponsoring will give you several perks - for $1 / \xa30.75 per month, you'll get a sponsor badge on your profile, be credited on the Dashy's readme, with a link to your website/ profile/ socials, get priority support, have your feature ideas implemented, plus lots more. For more info, see ",(0,a.jsx)(s.a,{href:"https://github.com/sponsors/Lissy93",children:"@Lissy93's Sponsor Page"}),"."]}),"\n",(0,a.jsx)(s.h3,{id:"you-can-also-send-a-one-off-small-contribution-using-crypto",children:"You can also send a one-off small contribution using crypto"}),"\n",(0,a.jsxs)(s.p,{children:[(0,a.jsx)(s.a,{href:"https://en.cryptobadges.io/donate/3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC",children:(0,a.jsx)(s.img,{src:"https://en.cryptobadges.io/badge/big/3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC",alt:"Donate with BTC"})}),(0,a.jsx)(s.a,{href:"https://en.cryptobadges.io/donate/0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017",children:(0,a.jsx)(s.img,{src:"https://en.cryptobadges.io/badge/big/0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017",alt:"Donate with Ethereum"})})]}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"BTC"}),": ",(0,a.jsx)(s.code,{children:"3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC"})]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"ETH"}),": ",(0,a.jsx)(s.code,{children:"0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017"})," / ",(0,a.jsx)(s.code,{children:"aliciasykes.eth"})]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"XMR"}),": ",(0,a.jsx)(s.code,{children:"471KZdxb6N63aABR4WYwMRjTVkc1p1x7wGsUTEF7AMYzL8L94A5pCuYWkosgJQ5Ze8Y2PscVCGZFJa3hDPg6MaDq47GUm8r"})]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"LTC"}),": ",(0,a.jsx)(s.code,{children:"MAuck6Ea1qaNihwKfXutkR1R6BorMth86H"})]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"ZEC"}),": ",(0,a.jsx)(s.code,{children:"t1bw1SefijsXRDQVxC9w64XsRK8hBhtQohQ"})]}),"\n"]}),"\n",(0,a.jsx)(s.h2,{id:"enable-anonymous-bug-reports",children:"Enable Anonymous Bug Reports"}),"\n",(0,a.jsxs)(s.p,{children:["Bug reports helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. This is a simple, yet really helpful step you can take to help improve Dashy. ",(0,a.jsx)(s.a,{href:"https://github.com/getsentry/sentry",children:"Sentry"})," is an open source error tracking and performance monitoring tool, which enables the identification any errors which occur in the production app (only if you enable it)."]}),"\n",(0,a.jsx)(s.p,{children:"To enable error reporting:"}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-yaml",children:"appConfig:\n enableErrorReporting: true\n"})}),"\n",(0,a.jsxs)(s.p,{children:["All reporting is ",(0,a.jsx)(s.strong,{children:"disabled"})," by default, and no data will ever be sent to any external endpoint without your explicit consent. All statistics are anonymized and stored securely. For more about privacy and security, see the ",(0,a.jsx)(s.a,{href:"https://sentry.io/security/",children:"Sentry Security Docs"}),"."]}),"\n",(0,a.jsx)(s.h2,{id:"add-translations",children:"Add Translations"}),"\n",(0,a.jsxs)(s.p,{children:["If you speak another language, then adding translations will help make Dashy available to non-native English speakers. This is a very quick and easy task, as all application text is located in ",(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/assets/locales/en.json",children:(0,a.jsx)(s.code,{children:"locales/en.json"})}),", so adding a new language is as simple as copying this file and translating the values. You don't have to translate it all, as any missing attributes will just fallback to English. For a full tutorial, see the ",(0,a.jsx)(s.a,{href:"/docs/multi-language-support",children:"Multi-Language Support Docs"}),"."]}),"\n",(0,a.jsx)(s.h2,{id:"submit-a-pr",children:"Submit a PR"}),"\n",(0,a.jsxs)(s.p,{children:["Contributing to the code or docs is super helpful. You can fix a bug, add a new feature or improve an existing one. If you've built your own custom widget, theme or view, consider sharing it in a PR. I've written ",(0,a.jsx)(s.a,{href:"/docs/development-guides",children:"several guides"})," to help you get started, and the steps for setting up the development environment are outlined in the ",(0,a.jsx)(s.a,{href:"/docs/developing",children:"Development Docs"}),". Feel free to ask if you have any questions."]}),"\n",(0,a.jsx)(s.h2,{id:"improve-the-docs",children:"Improve the Docs"}),"\n",(0,a.jsxs)(s.p,{children:["Found a typo, or something that isn't as clear as it could be? Maybe I've missed something off altogether, or you hit a roadblock that took you a while to figure out. Submitting a pull request to add to or improve the documentation will help future users get Dashy up and running more easily.\nAll content is located either in the ",(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/README",children:(0,a.jsx)(s.code,{children:"./README.md"})})," or ",(0,a.jsx)(s.a,{href:"/docs",children:(0,a.jsx)(s.code,{children:"/docs/"})})," directory, and synced to the Wiki and website using a GH ",(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/actions/workflows/wiki-sync.yml",children:"action"}),"."]}),"\n",(0,a.jsx)(s.h2,{id:"raise-a-bug",children:"Raise a bug"}),"\n",(0,a.jsx)(s.p,{children:"If you've found a bug, then please do raise it as an issue. This will help me know if there's something that needs fixing. Try and include as much detail as possible, such as your environment, steps to reproduce, any console output and maybe an example screenshot or recording if necessary."}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Raise_a-Bug-%23dc2d76?style=for-the-badge&logo=dependabot",alt:"Raise a Bug"})})}),"\n",(0,a.jsx)(s.h2,{id:"join-the-discussion",children:"Join the discussion"}),"\n",(0,a.jsx)(s.p,{children:"I've enabled the discussion feature on GitHub, here you can share tips and tricks, useful information, or your dashboard. You can also ask questions, and offer basic support to other users."}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/discussions",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Join_the-Discussion-%23ffd000?style=for-the-badge&logo=livechat",alt:"Join the Discussion on GitHub"})})}),"\n",(0,a.jsx)(s.h2,{id:"request-a-feature-via-bountysource",children:"Request a feature via BountySource"}),"\n",(0,a.jsx)(s.p,{children:"BountySource is a platform for sponsoring the development of certain features on open source projects. If there is a feature you'd like implemented into Dashy, but either isn't high enough priority or is deemed to be more work than it's worth, then you can instead contribute a bounty towards it's development. You won't pay a penny until your proposal is fully built, and you are satisfied with the result. This helps support the developers, and makes Dashy better for everyone."}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://www.bountysource.com/teams/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/BountySource-Dashy-%23F67909?style=for-the-badge&logo=openbugbounty",alt:"Request a Feature on BountySource"})})}),"\n",(0,a.jsx)(s.h2,{id:"spread-the-word",children:"Spread the word"}),"\n",(0,a.jsx)(s.p,{children:"Dashy is still a relatively young project, and as such not many people know of it. It would be great to see more users, and so it would be awesome if you could consider sharing with your friends or on social platforms."}),"\n",(0,a.jsxs)(s.p,{children:[(0,a.jsx)(s.a,{href:"https://mastodon.social/?text=Check%20out%20Dashy%2C%20the%20privacy-friendly%2C%20self-hosted%20startpage%20for%20organizing%20your%20life%3A%20https%3A%2F%2Fgithub.com%2FLissy93%2Fdashy%20-%20By%20%40lissy93%40mastodon.social",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Mastodon-%232b90d9?style=flat-square&logo=mastodon",alt:"Share Dashy on Mastodon"})}),"\n",(0,a.jsx)(s.a,{href:"http://www.reddit.com/submit?url=https://github.com/Lissy93/dashy&title=Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Reddit-%23FF5700?style=flat-square&logo=reddit",alt:"Share Dashy on Reddit"})}),"\n",(0,a.jsx)(s.a,{href:"https://twitter.com/intent/tweet?url=https://github.com/lissy93/dashy&text=Check%20out%20Dashy%20by%20@Lissy_Sykes,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Twitter-%231DA1F2?style=flat-square&logo=twitter",alt:"Share Dashy on Twitter"})}),"\n",(0,a.jsx)(s.a,{href:"https://www.facebook.com/sharer/sharer.php?u=https://github.com/lissy93/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Facebook-%234267B2?style=flat-square&logo=facebook",alt:"Share Dashy on Facebook"})}),"\n",(0,a.jsx)(s.a,{href:"https://www.linkedin.com/shareArticle?mini=true&url=https://github.com/lissy93/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-LinkedIn-%230077b5?style=flat-square&logo=linkedin",alt:"Share Dashy on LinkedIn"})}),"\n",(0,a.jsx)(s.a,{href:"https://pinterest.com/pin/create/button/?url=https://github.com/lissy93/dashy&media=https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png&description=Check%20out%20Dashy,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Pinterest-%23E60023?style=flat-square&logo=pinterest",alt:"Share Dashy on Pinterest"})}),"\n",(0,a.jsx)(s.a,{href:"https://vk.com/share.php?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%2F&title=Check%20out%20Dashy%20-%20The%20Self-Hosted%20Dashboard%20for%20your%20Homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-VK-%234C75A3?style=flat-square&logo=vk",alt:"Share Dashy on VK"})}),"\n",(0,a.jsx)(s.a,{href:"viber://forward?text=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%0ACheck%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Viber-%238176d6?style=flat-square&logo=viber",alt:"Share Dashy via Viber"})}),"\n",(0,a.jsx)(s.a,{href:"https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy&text=Check%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Telegram-%230088cc?style=flat-square&logo=telegram",alt:"Share Dashy via Telegram"})}),"\n",(0,a.jsx)(s.a,{href:"mailto:info@example.com?&subject=Check%20out%20Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80&cc=&bcc=&body=https://github.com/lissy93/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Email-%238A90C7?style=flat-square&logo=protonmail",alt:"Share Dashy via Email"})})]}),"\n",(0,a.jsx)(s.h2,{id:"star-upvote-or-leave-a-review",children:"Star, Upvote or Leave a Review"}),"\n",(0,a.jsx)(s.p,{children:"Dashy is on the following platforms, and if you could spare a few seconds to give it an upvote or review, this will also help new users discover Dashy"}),"\n",(0,a.jsxs)(s.p,{children:[(0,a.jsx)(s.a,{href:"https://www.producthunt.com/posts/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Review-ProductHunt-%23b74424?style=flat-square&logo=producthunt",alt:"ProductHunt"})}),"\n",(0,a.jsx)(s.a,{href:"https://alternativeto.net/software/dashy/about/",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Review-AlternativeTo-%235581a6?style=flat-square&logo=abletonlive",alt:"AlternativeTo"})}),"\n",(0,a.jsx)(s.a,{href:"https://www.slant.co/improve/topics/27783/viewpoints/1/~self-hosted-homelab-startpage~dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Review-Slant-%2346a1df?style=flat-square&logo=capacitor",alt:"Slant"})}),"\n",(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/stargazers",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/github/stars/Lissy93/Dashy?color=ba96d6&label=Star%20-%20GitHub&logo=github&style=flat-square",alt:"Star on GitHub"})}),"\n",(0,a.jsx)(s.a,{href:"https://hub.docker.com/r/lissy93/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/docker/stars/lissy93/dashy?color=4cb6e0&label=Star%20-%20Docker&logo=docker&style=flat-square",alt:"Star on DockerHub"})})]}),"\n",(0,a.jsx)(s.h2,{id:"follow-for-more",children:"Follow for More"}),"\n",(0,a.jsx)(s.p,{children:"If you've enjoyed Dashy, you can follow the me to get updates about other projects that I am working on."}),"\n",(0,a.jsxs)(s.p,{children:[(0,a.jsx)(s.a,{href:"https://twitter.com/Lissy_Sykes",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/twitter/follow/Lissy_Sykes?style=social&logo=twitter",alt:"Alicia Sykes on Twitter"})}),"\n",(0,a.jsx)(s.a,{href:"https://github.com/Lissy93",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/github/followers/lissy93?label=Lissy93&style=social",alt:"Alicia Sykes on GitHub"})}),"\n",(0,a.jsx)(s.a,{href:"https://mastodon.social/web/accounts/1032965",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/mastodon/follow/1032965?domain=https%3A%2F%2Fmastodon.social",alt:"Alicia Sykes on Mastodon"})}),"\n",(0,a.jsx)(s.a,{href:"https://keybase.io/aliciasykes",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/aliciasykes--lightgrey?style=social&logo=Keybase",alt:"Alicia Sykes on Keybase"})}),"\n",(0,a.jsx)(s.a,{href:"https://aliciasykes.com",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/aliciasykes.com--lightgrey?style=social&logo=Tencent%20QQ",alt:"Alicia Sykes's Website"})}),"\n",(0,a.jsx)(s.a,{href:"https://notes.aliciasykes.com/",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Blog--lightgrey?style=social&logo=micro.blog",alt:"Alicia Sykes's Blog"})}),"\n",(0,a.jsx)(s.a,{href:"https://keybase.io/aliciasykes/pgp_keys.asc",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/PGP--lightgrey?style=social&logo=Let%E2%80%99s%20Encrypt",alt:"Alicia Sykes's PGP"})})]}),"\n",(0,a.jsxs)(s.p,{children:["If you like, you could also consider ",(0,a.jsx)(s.a,{href:"https://notes.aliciasykes.com/subscribe",children:"subscribing to my mailing list"})," for occasional blog post updates."]}),"\n",(0,a.jsx)(s.hr,{}),"\n",(0,a.jsx)(s.h3,{id:"contributors",children:"Contributors"}),"\n",(0,a.jsxs)(s.p,{children:["For a full list of Dashy's contributors, see the ",(0,a.jsx)(s.a,{href:"/docs/credits",children:"Credits Page"})]}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"/docs/credits",children:(0,a.jsx)(s.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg",alt:"Auto-generated contributors"})})}),"\n",(0,a.jsx)(s.h3,{id:"star-gazers-over-time",children:"Star-Gazers Over Time"}),"\n",(0,a.jsxs)(s.p,{children:["](",(0,a.jsx)(s.a,{href:"https://seladb.github.io/StarTrack-js/#/preload?r=lissy93,dashy",children:"https://seladb.github.io/StarTrack-js/#/preload?r=lissy93,dashy"}),")"]})]})}function c(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453(e,s,t){t.d(s,{R:()=>r,x:()=>n});var o=t(6540);const a={},i=o.createContext(a);function r(e){const s=o.useContext(i);return o.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function n(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),o.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[1459],{2199(e,s,t){t.r(s),t.d(s,{assets:()=>l,contentTitle:()=>n,default:()=>c,frontMatter:()=>r,metadata:()=>o,toc:()=>h});const o=JSON.parse('{"id":"contributing","title":"Contributing","description":"First off, thank you for considering contributing towards Dashy! \ud83d\ude4c","source":"@site/docs/contributing.md","sourceDirName":".","slug":"/contributing","permalink":"/docs/contributing","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/contributing.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"*Dashy Showcase* \ud83c\udf1f","permalink":"/docs/showcase"},"next":{"title":"Developing","permalink":"/docs/developing"}}');var a=t(4848),i=t(8453);const r={},n="Contributing",l={},h=[{value:"Take a 2-minute survey",id:"take-a-2-minute-survey",level:2},{value:"Share your dashboard",id:"share-your-dashboard",level:2},{value:"Make a small donation",id:"make-a-small-donation",level:2},{value:"You can also send a one-off small contribution using crypto",id:"you-can-also-send-a-one-off-small-contribution-using-crypto",level:3},{value:"Enable Anonymous Bug Reports",id:"enable-anonymous-bug-reports",level:2},{value:"Add Translations",id:"add-translations",level:2},{value:"Submit a PR",id:"submit-a-pr",level:2},{value:"Improve the Docs",id:"improve-the-docs",level:2},{value:"Raise a bug",id:"raise-a-bug",level:2},{value:"Join the discussion",id:"join-the-discussion",level:2},{value:"Request a feature via BountySource",id:"request-a-feature-via-bountysource",level:2},{value:"Spread the word",id:"spread-the-word",level:2},{value:"Star, Upvote or Leave a Review",id:"star-upvote-or-leave-a-review",level:2},{value:"Follow for More",id:"follow-for-more",level:2},{value:"Contributors",id:"contributors",level:3},{value:"Star-Gazers Over Time",id:"star-gazers-over-time",level:3}];function d(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(s.header,{children:(0,a.jsx)(s.h1,{id:"contributing",children:"Contributing"})}),"\n",(0,a.jsxs)(s.p,{children:["First off, thank you for considering contributing towards Dashy! \ud83d\ude4c\nThere are several ways that you can help out, and any contributions, however small will always be very much appreciated.\nYou will be appropriately credited in the readme - huge thank you to ",(0,a.jsx)(s.a,{href:"/docs/credits",children:"everyone who has helped"})," so far \ud83d\udc9e"]}),"\n",(0,a.jsx)(s.h2,{id:"take-a-2-minute-survey",children:"Take a 2-minute survey"}),"\n",(0,a.jsx)(s.p,{children:"Help improve Dashy by taking a very short, 6-question survey. This will give me a better understanding of what is important to you, so that I can make Dashy better in the future :)"}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://survey.typeform.com/to/gl0L68ou",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Take_the-Survey-%231a86fd?style=for-the-badge&logo=buddy",alt:"Take the Survey"})})}),"\n",(0,a.jsx)(s.h2,{id:"share-your-dashboard",children:"Share your dashboard"}),"\n",(0,a.jsxs)(s.p,{children:["Dashy now has a ",(0,a.jsx)(s.a,{href:"/docs/showcase",children:"Showcase"})," where you can show off a screenshot of your dashboard, and get inspiration from other users (and I really love seeing how people are using Dashy). To ",(0,a.jsx)(s.a,{href:"/docs/showcase#submitting-your-dashboard",children:"submit your dashboard"}),", either open a PR or raise an issue."]}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/issues/new?assignees=&labels=%F0%9F%92%AF+Showcase&template=showcase-addition.yml&title=%5BSHOWCASE%5D+%3Ctitle%3E",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Add_your_Dashboard-Showcase-%238616ee?style=for-the-badge&logo=feathub&logoColor=8616ee",alt:"Add your Dashboard to the Showcase"})})}),"\n",(0,a.jsx)(s.h2,{id:"make-a-small-donation",children:"Make a small donation"}),"\n",(0,a.jsx)(s.p,{children:"Donations help to cover server costs, development time and caffeine ;)\nDon't feel any pressure to donate anything, as Dashy and my other projects will always be 100% free, for everyone, for ever."}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://github.com/sponsors/Lissy93",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Sponsor_on_GitHub-Lissy93-%23ff4dda?style=for-the-badge&logo=githubsponsors&logoColor=ff4dda",alt:"Sponsor Lissy93 on GitHub"})})}),"\n",(0,a.jsxs)(s.p,{children:["Sponsoring will give you several perks - for $1 / \xa30.75 per month, you'll get a sponsor badge on your profile, be credited on the Dashy's readme, with a link to your website/ profile/ socials, get priority support, have your feature ideas implemented, plus lots more. For more info, see ",(0,a.jsx)(s.a,{href:"https://github.com/sponsors/Lissy93",children:"@Lissy93's Sponsor Page"}),"."]}),"\n",(0,a.jsx)(s.h3,{id:"you-can-also-send-a-one-off-small-contribution-using-crypto",children:"You can also send a one-off small contribution using crypto"}),"\n",(0,a.jsxs)(s.p,{children:[(0,a.jsx)(s.a,{href:"https://en.cryptobadges.io/donate/3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC",children:(0,a.jsx)(s.img,{src:"https://en.cryptobadges.io/badge/big/3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC",alt:"Donate with BTC"})}),(0,a.jsx)(s.a,{href:"https://en.cryptobadges.io/donate/0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017",children:(0,a.jsx)(s.img,{src:"https://en.cryptobadges.io/badge/big/0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017",alt:"Donate with Ethereum"})})]}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"BTC"}),": ",(0,a.jsx)(s.code,{children:"3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC"})]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"ETH"}),": ",(0,a.jsx)(s.code,{children:"0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017"})," / ",(0,a.jsx)(s.code,{children:"aliciasykes.eth"})]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"XMR"}),": ",(0,a.jsx)(s.code,{children:"471KZdxb6N63aABR4WYwMRjTVkc1p1x7wGsUTEF7AMYzL8L94A5pCuYWkosgJQ5Ze8Y2PscVCGZFJa3hDPg6MaDq47GUm8r"})]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"LTC"}),": ",(0,a.jsx)(s.code,{children:"MAuck6Ea1qaNihwKfXutkR1R6BorMth86H"})]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"ZEC"}),": ",(0,a.jsx)(s.code,{children:"t1bw1SefijsXRDQVxC9w64XsRK8hBhtQohQ"})]}),"\n"]}),"\n",(0,a.jsx)(s.h2,{id:"enable-anonymous-bug-reports",children:"Enable Anonymous Bug Reports"}),"\n",(0,a.jsxs)(s.p,{children:["Bug reports helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. This is a simple, yet really helpful step you can take to help improve Dashy. ",(0,a.jsx)(s.a,{href:"https://github.com/getsentry/sentry",children:"Sentry"})," is an open source error tracking and performance monitoring tool, which enables the identification any errors which occur in the production app (only if you enable it)."]}),"\n",(0,a.jsx)(s.p,{children:"To enable error reporting:"}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{className:"language-yaml",children:"appConfig:\n enableErrorReporting: true\n"})}),"\n",(0,a.jsxs)(s.p,{children:["All reporting is ",(0,a.jsx)(s.strong,{children:"disabled"})," by default, and no data will ever be sent to any external endpoint without your explicit consent. All statistics are anonymized and stored securely. For more about privacy and security, see the ",(0,a.jsx)(s.a,{href:"https://sentry.io/security/",children:"Sentry Security Docs"}),"."]}),"\n",(0,a.jsx)(s.h2,{id:"add-translations",children:"Add Translations"}),"\n",(0,a.jsxs)(s.p,{children:["If you speak another language, then adding translations will help make Dashy available to non-native English speakers. This is a very quick and easy task, as all application text is located in ",(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/assets/locales/en.json",children:(0,a.jsx)(s.code,{children:"locales/en.json"})}),", so adding a new language is as simple as copying this file and translating the values. You don't have to translate it all, as any missing attributes will just fallback to English. For a full tutorial, see the ",(0,a.jsx)(s.a,{href:"/docs/multi-language-support",children:"Multi-Language Support Docs"}),"."]}),"\n",(0,a.jsx)(s.h2,{id:"submit-a-pr",children:"Submit a PR"}),"\n",(0,a.jsxs)(s.p,{children:["Contributing to the code or docs is super helpful. You can fix a bug, add a new feature or improve an existing one. If you've built your own custom widget, theme or view, consider sharing it in a PR. I've written ",(0,a.jsx)(s.a,{href:"/docs/development-guides",children:"several guides"})," to help you get started, and the steps for setting up the development environment are outlined in the ",(0,a.jsx)(s.a,{href:"/docs/developing",children:"Development Docs"}),". Feel free to ask if you have any questions."]}),"\n",(0,a.jsx)(s.h2,{id:"improve-the-docs",children:"Improve the Docs"}),"\n",(0,a.jsxs)(s.p,{children:["Found a typo, or something that isn't as clear as it could be? Maybe I've missed something off altogether, or you hit a roadblock that took you a while to figure out. Submitting a pull request to add to or improve the documentation will help future users get Dashy up and running more easily.\nAll content is located either in the ",(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/README",children:(0,a.jsx)(s.code,{children:"./README.md"})})," or ",(0,a.jsx)(s.a,{href:"/docs",children:(0,a.jsx)(s.code,{children:"/docs/"})})," directory, and synced to the Wiki and website using a GH ",(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/actions/workflows/wiki-sync.yml",children:"action"}),"."]}),"\n",(0,a.jsx)(s.h2,{id:"raise-a-bug",children:"Raise a bug"}),"\n",(0,a.jsx)(s.p,{children:"If you've found a bug, then please do raise it as an issue. This will help me know if there's something that needs fixing. Try and include as much detail as possible, such as your environment, steps to reproduce, any console output and maybe an example screenshot or recording if necessary."}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Raise_a-Bug-%23dc2d76?style=for-the-badge&logo=dependabot",alt:"Raise a Bug"})})}),"\n",(0,a.jsx)(s.h2,{id:"join-the-discussion",children:"Join the discussion"}),"\n",(0,a.jsx)(s.p,{children:"I've enabled the discussion feature on GitHub, here you can share tips and tricks, useful information, or your dashboard. You can also ask questions, and offer basic support to other users."}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/discussions",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Join_the-Discussion-%23ffd000?style=for-the-badge&logo=livechat",alt:"Join the Discussion on GitHub"})})}),"\n",(0,a.jsx)(s.h2,{id:"request-a-feature-via-bountysource",children:"Request a feature via BountySource"}),"\n",(0,a.jsx)(s.p,{children:"BountySource is a platform for sponsoring the development of certain features on open source projects. If there is a feature you'd like implemented into Dashy, but either isn't high enough priority or is deemed to be more work than it's worth, then you can instead contribute a bounty towards it's development. You won't pay a penny until your proposal is fully built, and you are satisfied with the result. This helps support the developers, and makes Dashy better for everyone."}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"https://www.bountysource.com/teams/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/BountySource-Dashy-%23F67909?style=for-the-badge&logo=openbugbounty",alt:"Request a Feature on BountySource"})})}),"\n",(0,a.jsx)(s.h2,{id:"spread-the-word",children:"Spread the word"}),"\n",(0,a.jsx)(s.p,{children:"Dashy is still a relatively young project, and as such not many people know of it. It would be great to see more users, and so it would be awesome if you could consider sharing with your friends or on social platforms."}),"\n",(0,a.jsxs)(s.p,{children:[(0,a.jsx)(s.a,{href:"https://mastodon.social/?text=Check%20out%20Dashy%2C%20the%20privacy-friendly%2C%20self-hosted%20startpage%20for%20organizing%20your%20life%3A%20https%3A%2F%2Fgithub.com%2FLissy93%2Fdashy%20-%20By%20%40lissy93%40mastodon.social",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Mastodon-%232b90d9?style=flat-square&logo=mastodon",alt:"Share Dashy on Mastodon"})}),"\n",(0,a.jsx)(s.a,{href:"http://www.reddit.com/submit?url=https://github.com/Lissy93/dashy&title=Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Reddit-%23FF5700?style=flat-square&logo=reddit",alt:"Share Dashy on Reddit"})}),"\n",(0,a.jsx)(s.a,{href:"https://twitter.com/intent/tweet?url=https://github.com/lissy93/dashy&text=Check%20out%20Dashy%20by%20@Lissy_Sykes,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Twitter-%231DA1F2?style=flat-square&logo=twitter",alt:"Share Dashy on Twitter"})}),"\n",(0,a.jsx)(s.a,{href:"https://www.facebook.com/sharer/sharer.php?u=https://github.com/lissy93/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Facebook-%234267B2?style=flat-square&logo=facebook",alt:"Share Dashy on Facebook"})}),"\n",(0,a.jsx)(s.a,{href:"https://www.linkedin.com/shareArticle?mini=true&url=https://github.com/lissy93/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-LinkedIn-%230077b5?style=flat-square&logo=linkedin",alt:"Share Dashy on LinkedIn"})}),"\n",(0,a.jsx)(s.a,{href:"https://pinterest.com/pin/create/button/?url=https://github.com/lissy93/dashy&media=https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png&description=Check%20out%20Dashy,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Pinterest-%23E60023?style=flat-square&logo=pinterest",alt:"Share Dashy on Pinterest"})}),"\n",(0,a.jsx)(s.a,{href:"https://vk.com/share.php?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%2F&title=Check%20out%20Dashy%20-%20The%20Self-Hosted%20Dashboard%20for%20your%20Homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-VK-%234C75A3?style=flat-square&logo=vk",alt:"Share Dashy on VK"})}),"\n",(0,a.jsx)(s.a,{href:"viber://forward?text=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%0ACheck%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Viber-%238176d6?style=flat-square&logo=viber",alt:"Share Dashy via Viber"})}),"\n",(0,a.jsx)(s.a,{href:"https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy&text=Check%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Telegram-%230088cc?style=flat-square&logo=telegram",alt:"Share Dashy via Telegram"})}),"\n",(0,a.jsx)(s.a,{href:"mailto:info@example.com?&subject=Check%20out%20Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80&cc=&bcc=&body=https://github.com/lissy93/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Share-Email-%238A90C7?style=flat-square&logo=protonmail",alt:"Share Dashy via Email"})})]}),"\n",(0,a.jsx)(s.h2,{id:"star-upvote-or-leave-a-review",children:"Star, Upvote or Leave a Review"}),"\n",(0,a.jsx)(s.p,{children:"Dashy is on the following platforms, and if you could spare a few seconds to give it an upvote or review, this will also help new users discover Dashy"}),"\n",(0,a.jsxs)(s.p,{children:[(0,a.jsx)(s.a,{href:"https://www.producthunt.com/posts/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Review-ProductHunt-%23b74424?style=flat-square&logo=producthunt",alt:"ProductHunt"})}),"\n",(0,a.jsx)(s.a,{href:"https://alternativeto.net/software/dashy/about/",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Review-AlternativeTo-%235581a6?style=flat-square&logo=abletonlive",alt:"AlternativeTo"})}),"\n",(0,a.jsx)(s.a,{href:"https://www.slant.co/improve/topics/27783/viewpoints/1/~self-hosted-homelab-startpage~dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Review-Slant-%2346a1df?style=flat-square&logo=capacitor",alt:"Slant"})}),"\n",(0,a.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/stargazers",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/github/stars/Lissy93/Dashy?color=ba96d6&label=Star%20-%20GitHub&logo=github&style=flat-square",alt:"Star on GitHub"})}),"\n",(0,a.jsx)(s.a,{href:"https://hub.docker.com/r/lissy93/dashy",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/docker/stars/lissy93/dashy?color=4cb6e0&label=Star%20-%20Docker&logo=docker&style=flat-square",alt:"Star on DockerHub"})})]}),"\n",(0,a.jsx)(s.h2,{id:"follow-for-more",children:"Follow for More"}),"\n",(0,a.jsx)(s.p,{children:"If you've enjoyed Dashy, you can follow the me to get updates about other projects that I am working on."}),"\n",(0,a.jsxs)(s.p,{children:[(0,a.jsx)(s.a,{href:"https://twitter.com/Lissy_Sykes",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/twitter/follow/Lissy_Sykes?style=social&logo=twitter",alt:"Alicia Sykes on Twitter"})}),"\n",(0,a.jsx)(s.a,{href:"https://github.com/Lissy93",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/github/followers/lissy93?label=Lissy93&style=social",alt:"Alicia Sykes on GitHub"})}),"\n",(0,a.jsx)(s.a,{href:"https://mastodon.social/web/accounts/1032965",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/mastodon/follow/1032965?domain=https%3A%2F%2Fmastodon.social",alt:"Alicia Sykes on Mastodon"})}),"\n",(0,a.jsx)(s.a,{href:"https://keybase.io/aliciasykes",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/aliciasykes--lightgrey?style=social&logo=Keybase",alt:"Alicia Sykes on Keybase"})}),"\n",(0,a.jsx)(s.a,{href:"https://aliciasykes.com",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/aliciasykes.com--lightgrey?style=social&logo=Tencent%20QQ",alt:"Alicia Sykes's Website"})}),"\n",(0,a.jsx)(s.a,{href:"https://notes.aliciasykes.com/",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/Blog--lightgrey?style=social&logo=micro.blog",alt:"Alicia Sykes's Blog"})}),"\n",(0,a.jsx)(s.a,{href:"https://keybase.io/aliciasykes/pgp_keys.asc",children:(0,a.jsx)(s.img,{src:"https://img.shields.io/badge/PGP--lightgrey?style=social&logo=Let%E2%80%99s%20Encrypt",alt:"Alicia Sykes's PGP"})})]}),"\n",(0,a.jsxs)(s.p,{children:["If you like, you could also consider ",(0,a.jsx)(s.a,{href:"https://notes.aliciasykes.com/subscribe",children:"subscribing to my mailing list"})," for occasional blog post updates."]}),"\n",(0,a.jsx)(s.hr,{}),"\n",(0,a.jsx)(s.h3,{id:"contributors",children:"Contributors"}),"\n",(0,a.jsxs)(s.p,{children:["For a full list of Dashy's contributors, see the ",(0,a.jsx)(s.a,{href:"/docs/credits",children:"Credits Page"})]}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.a,{href:"/docs/credits",children:(0,a.jsx)(s.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg",alt:"Auto-generated contributors"})})}),"\n",(0,a.jsx)(s.h3,{id:"star-gazers-over-time",children:"Star-Gazers Over Time"}),"\n",(0,a.jsxs)(s.p,{children:["](",(0,a.jsx)(s.a,{href:"https://seladb.github.io/StarTrack-js/#/preload?r=lissy93,dashy",children:"https://seladb.github.io/StarTrack-js/#/preload?r=lissy93,dashy"}),")"]})]})}function c(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453(e,s,t){t.d(s,{R:()=>r,x:()=>n});var o=t(6540);const a={},i=o.createContext(a);function r(e){const s=o.useContext(i);return o.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function n(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),o.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52e2a80b.744632c1.js b/assets/js/52e2a80b.9f0398b0.js similarity index 98% rename from assets/js/52e2a80b.744632c1.js rename to assets/js/52e2a80b.9f0398b0.js index 3d8854ff..3c41c7f8 100644 --- a/assets/js/52e2a80b.744632c1.js +++ b/assets/js/52e2a80b.9f0398b0.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[1306],{1264(e,n,s){s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"readme","title":"![Dashy Docs](https://i.ibb.co/4mdNf7M/heading-docs.png)","description":"Running Dashy","source":"@site/docs/readme.md","sourceDirName":".","slug":"/","permalink":"/docs/","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/readme.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{}}');var t=s(4848),o=s(8453);const r={},a="Dashy Docs",d={},l=[{value:"Running Dashy",id:"running-dashy",level:2},{value:"Development and Contributing",id:"development-and-contributing",level:2},{value:"Feature Docs",id:"feature-docs",level:2},{value:"Misc",id:"misc",level:2}];function c(e){const n={a:"a",h1:"h1",h2:"h2",header:"header",img:"img",li:"li",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"dashy-docs",children:(0,t.jsx)(n.img,{src:"https://i.ibb.co/4mdNf7M/heading-docs.png",alt:"Dashy Docs"})})}),"\n",(0,t.jsx)(n.h2,{id:"running-dashy",children:"Running Dashy"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/quick-start",children:"Quick Start"})," - TLDR guide on getting Dashy up and running"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/deployment",children:"Deployment"})," - Full guide on deploying Dashy either locally or online"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/configuring",children:"Configuring"})," - Complete list of all available options in the config file"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/management",children:"App Management"})," - Managing your app, updating, security, web server configuration, etc"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/troubleshooting",children:"Troubleshooting"})," - Common errors and problems, and how to fix them"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"development-and-contributing",children:"Development and Contributing"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/developing",children:"Developing"})," - Running Dashy development server locally, and general workflow"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/development-guides",children:"Development Guides"})," - Common development tasks, to help new contributors"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/contributing",children:"Contributing"})," - How you can help keep Dashy alive"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/showcase",children:"Showcase"})," - See how others are using Dashy, and share your dashboard"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/credits",children:"Credits"})," - List of people and projects that have made Dashy possible"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/release-workflow",children:"Release Workflow"})," - Info about releases, CI and automated tasks"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"feature-docs",children:"Feature Docs"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/authentication",children:"Authentication"})," - Guide to setting up authentication to protect your dashboard"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/alternate-views",children:"Alternate Views"})," - Outline of available pages / views and item opening methods"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/backup-restore",children:"Backup & Restore"})," - Guide to backing up config with Dashy's cloud sync feature"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/icons",children:"Icons"})," - Outline of all available icon types for sections and items, with examples"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/multi-language-support",children:"Language Switching"})," - Details on how to switch language, or add a new locale"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/pages-and-sections",children:"Pages and Sections"})," - Multi-page support, sections, items and sub-items"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/status-indicators",children:"Status Indicators"})," - Using Dashy to monitor uptime and status of your apps"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/searching",children:"Searching & Shortcuts"})," - Searching, launching methods + keyboard shortcuts"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/theming",children:"Theming"})," - Complete guide to applying, writing and modifying themes + styles"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/widgets",children:"Widgets"})," - List of all dynamic content widgets, with usage guides and examples"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"misc",children:"Misc"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/privacy",children:"Privacy & Security"})," - List of requests, potential issues, and security resources"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/LICENSE",children:"License"})," - Copy of the MIT License"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT",children:"Code of Conduct"})," - Contributor Covenant Code of Conduct"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453(e,n,s){s.d(n,{R:()=>r,x:()=>a});var i=s(6540);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[1306],{1264(e,n,s){s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"readme","title":"![Dashy Docs](https://i.ibb.co/4mdNf7M/heading-docs.png)","description":"Running Dashy","source":"@site/docs/readme.md","sourceDirName":".","slug":"/","permalink":"/docs/","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/readme.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{}}');var t=s(4848),o=s(8453);const r={},a="Dashy Docs",d={},l=[{value:"Running Dashy",id:"running-dashy",level:2},{value:"Development and Contributing",id:"development-and-contributing",level:2},{value:"Feature Docs",id:"feature-docs",level:2},{value:"Misc",id:"misc",level:2}];function c(e){const n={a:"a",h1:"h1",h2:"h2",header:"header",img:"img",li:"li",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"dashy-docs",children:(0,t.jsx)(n.img,{src:"https://i.ibb.co/4mdNf7M/heading-docs.png",alt:"Dashy Docs"})})}),"\n",(0,t.jsx)(n.h2,{id:"running-dashy",children:"Running Dashy"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/quick-start",children:"Quick Start"})," - TLDR guide on getting Dashy up and running"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/deployment",children:"Deployment"})," - Full guide on deploying Dashy either locally or online"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/configuring",children:"Configuring"})," - Complete list of all available options in the config file"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/management",children:"App Management"})," - Managing your app, updating, security, web server configuration, etc"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/troubleshooting",children:"Troubleshooting"})," - Common errors and problems, and how to fix them"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"development-and-contributing",children:"Development and Contributing"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/developing",children:"Developing"})," - Running Dashy development server locally, and general workflow"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/development-guides",children:"Development Guides"})," - Common development tasks, to help new contributors"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/contributing",children:"Contributing"})," - How you can help keep Dashy alive"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/showcase",children:"Showcase"})," - See how others are using Dashy, and share your dashboard"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/credits",children:"Credits"})," - List of people and projects that have made Dashy possible"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/release-workflow",children:"Release Workflow"})," - Info about releases, CI and automated tasks"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"feature-docs",children:"Feature Docs"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/authentication",children:"Authentication"})," - Guide to setting up authentication to protect your dashboard"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/alternate-views",children:"Alternate Views"})," - Outline of available pages / views and item opening methods"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/backup-restore",children:"Backup & Restore"})," - Guide to backing up config with Dashy's cloud sync feature"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/icons",children:"Icons"})," - Outline of all available icon types for sections and items, with examples"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/multi-language-support",children:"Language Switching"})," - Details on how to switch language, or add a new locale"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/pages-and-sections",children:"Pages and Sections"})," - Multi-page support, sections, items and sub-items"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/status-indicators",children:"Status Indicators"})," - Using Dashy to monitor uptime and status of your apps"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/searching",children:"Searching & Shortcuts"})," - Searching, launching methods + keyboard shortcuts"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/theming",children:"Theming"})," - Complete guide to applying, writing and modifying themes + styles"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/widgets",children:"Widgets"})," - List of all dynamic content widgets, with usage guides and examples"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"misc",children:"Misc"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"/docs/privacy",children:"Privacy & Security"})," - List of requests, potential issues, and security resources"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/LICENSE",children:"License"})," - Copy of the MIT License"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT",children:"Code of Conduct"})," - Contributor Covenant Code of Conduct"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453(e,n,s){s.d(n,{R:()=>r,x:()=>a});var i=s(6540);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/54a53fa9.04d6b234.js b/assets/js/54a53fa9.04d6b234.js deleted file mode 100644 index 83a0fcc1..00000000 --- a/assets/js/54a53fa9.04d6b234.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[7535],{7510(e,a,t){t.r(a),t.d(a,{default:()=>y});var s=t(6540),r=t(5048),l=t(5260),n=t(6588);const i={updatesPage:"updatesPage_z4Av",pageHeader:"pageHeader_g4VR",timeline:"timeline_WTQQ",monthHeader:"monthHeader_QFki",entry:"entry_mTt2",releaseEntry:"releaseEntry_ZG2V",tagEntry:"tagEntry_ORGt",commitEntry:"commitEntry_JtMn",releaseCard:"releaseCard_aa3v",entryTitle:"entryTitle_RUqs",tagCard:"tagCard_SluW",commitRow:"commitRow_RIZe",badge:"badge_qP1g",badgeRelease:"badgeRelease_agcf",badgeTag:"badgeTag_gC_o",tagPill:"tagPill_IKwa",bodyPreview:"bodyPreview_iKaD",meta:"meta_GplF",providerIcon:"providerIcon_NdOm",avatar:"avatar_Vzby",authorInfo:"authorInfo_pi2M",sha:"sha_JsPS",commitMsg:"commitMsg_XeKn",authorLink:"authorLink_YWtN",avatarSmall:"avatarSmall_luV7",commitMeta:"commitMeta_teNK",skeleton:"skeleton_NVtD",pulse:"pulse_axI4",loadMore:"loadMore_YatW",fetchErrorCard:"fetchErrorCard_M8w3",errorMessage:"errorMessage_lztz"};var o=t(4848);const c="lissy93/dashy";function h(e){const a=new Date-e,t=Math.floor(a/1e3),s=Math.floor(t/60),r=Math.floor(s/60),l=Math.floor(r/24);return l>30?e.toLocaleDateString("en-US",{month:"short",day:"numeric",year:"numeric"}):l>0?`${l}d ago`:r>0?`${r}h ago`:s>0?`${s}m ago`:"just now"}function m(e){return`${e.getFullYear()}-${String(e.getMonth()+1).padStart(2,"0")}`}function d(e){const[a,t]=e.split("-");return new Date(parseInt(a),parseInt(t)-1).toLocaleDateString("en-US",{month:"long",year:"numeric"})}function u(e){const a=e.body?(t=e.body,t.replace(/#{1,6}\s*/g,"").replace(/[*_~`>]/g,"").replace(/\[([^\]]+)\]\([^)]+\)/g,"$1").replace(/!\[[^\]]*\]\([^)]+\)/g,"").replace(/\n+/g," ").trim()).slice(0,200):"";var t;return{type:"release",date:new Date(e.published_at),title:e.name||e.tag_name,body:a||void 0,url:e.html_url,author:e.author?.login,avatarUrl:e.author?.avatar_url,tagName:e.tag_name}}function g(e,a){return{type:"tag",date:a,title:e.name,url:`https://github.com/${c}/releases/tag/${e.name}`,tagName:e.name}}function p(e){const a=e.commit?.message||"";return{type:"commit",date:new Date(e.commit?.author?.date||e.commit?.committer?.date),title:a.split("\n")[0],url:e.html_url,author:e.author?.login||e.commit?.author?.name,avatarUrl:e.author?.avatar_url,sha:e.sha?.slice(0,7)}}function f({entry:e}){return"release"===e.type?(0,o.jsx)("div",{className:`${i.entry} ${i.releaseEntry}`,role:"article","aria-label":`Release: ${e.title}`,children:(0,o.jsxs)("div",{className:i.releaseCard,children:[(0,o.jsxs)("div",{className:i.entryTitle,children:[e.title,(0,o.jsx)("span",{className:`${i.badge} ${i.badgeRelease}`,children:"Release"}),e.tagName&&(0,o.jsx)("span",{className:i.tagPill,children:e.tagName})]}),e.body&&(0,o.jsx)("p",{className:i.bodyPreview,children:e.body}),(0,o.jsxs)("div",{className:i.meta,children:[e.avatarUrl&&(0,o.jsx)("span",{className:i.authorInfo,children:(0,o.jsxs)("a",{href:`https://github.com/${e.author}`,target:"_blank",rel:"noopener noreferrer",className:i.authorLink,children:[e.avatarUrl&&(0,o.jsx)("img",{src:e.avatarUrl,alt:e.author,className:i.avatarSmall,loading:"lazy"}),e.author&&(0,o.jsx)("span",{children:e.author})]})}),(0,o.jsx)("time",{dateTime:e.date.toISOString(),children:h(e.date)}),(0,o.jsx)("span",{className:i.viewOnLabel,children:"View on:"}),(0,o.jsxs)("a",{href:e.url,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("img",{className:i.providerIcon,src:"https://cdn.as93.net/k1pcts?w=32"}),"GitHub"]}),(0,o.jsxs)("a",{href:`https://hub.docker.com/layers/lissy93/dashy/${e.tagName||e.title}`,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("img",{className:i.providerIcon,src:"https://cdn.as93.net/t2hnw4?w=32"}),"DockerHub"]})]})]})}):"tag"===e.type?(0,o.jsx)("div",{className:`${i.entry} ${i.tagEntry}`,role:"article","aria-label":`Tag: ${e.title}`,children:(0,o.jsxs)("div",{className:i.tagCard,children:[(0,o.jsxs)("div",{className:i.entryTitle,children:[e.title,(0,o.jsx)("span",{className:`${i.badge} ${i.badgeTag}`,children:"Tag"})]}),(0,o.jsxs)("div",{className:i.meta,children:[(0,o.jsx)("time",{dateTime:e.date.toISOString(),children:h(e.date)}),(0,o.jsx)("span",{className:i.viewOnLabel,children:"View on:"}),(0,o.jsxs)("a",{href:e.url,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("img",{className:i.providerIcon,src:"https://cdn.as93.net/k1pcts?w=32"}),"GitHub"]}),(0,o.jsxs)("a",{href:`https://hub.docker.com/layers/lissy93/dashy/${e.title}`,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("img",{className:i.providerIcon,src:"https://cdn.as93.net/t2hnw4?w=32"}),"DockerHub"]})]})]})}):(0,o.jsx)("div",{className:`${i.entry} ${i.commitEntry}`,role:"article","aria-label":`Commit: ${e.title}`,children:(0,o.jsxs)("a",{href:e.url,className:i.commitRow,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("span",{className:i.sha,children:e.sha}),(0,o.jsx)("span",{className:i.commitMsg,children:e.title}),(0,o.jsxs)("span",{className:i.commitMeta,children:[(0,o.jsxs)("a",{href:`https://github.com/${e.author}`,target:"_blank",rel:"noopener noreferrer",className:i.authorLink,children:[e.avatarUrl&&(0,o.jsx)("img",{src:e.avatarUrl,alt:e.author,className:i.avatarSmall,loading:"lazy"}),e.author&&(0,o.jsx)("span",{children:e.author})]}),e.author&&" \xb7 ",(0,o.jsx)("time",{dateTime:e.date.toISOString(),children:h(e.date)})]})]})})}function b(){const e=(0,n.P_)("github-data"),a=(0,s.useMemo)(()=>e?.releases?e.releases.map(e=>u({tag_name:e.tag_name,name:e.name,published_at:e.published_at,body:e.body,html_url:e.html_url,author:e.author_login?{login:e.author_login,avatar_url:e.author_avatar}:null})):[],[e]),t=(0,s.useMemo)(()=>e?.tags?e.tags.map(e=>g({name:e.name},new Date(e.date))):[],[e]),r=(0,s.useMemo)(()=>e?.commits?e.commits.map(e=>p({sha:e.sha,commit:{message:e.message,author:{date:e.date}},author:e.author_login?{login:e.author_login,avatar_url:e.author_avatar}:null,html_url:e.html_url})):[],[e]),l=a.length>0||t.length>0||r.length>0,[h,b]=(0,s.useState)(a),[y,j]=(0,s.useState)(t),[_,v]=(0,s.useState)(r),[x,N]=(0,s.useState)(!l),[$,k]=(0,s.useState)(!1),[w,S]=(0,s.useState)([]),[M,D]=(0,s.useState)(r.length>0?Math.ceil(r.length/30):1),[C,P]=(0,s.useState)(!0),[I,T]=(0,s.useState)(!1),[U,E]=(0,s.useState)(!1),H=(0,s.useMemo)(()=>({"User-Agent":"dashy-docs"}),[]),R=(0,s.useCallback)(async e=>{const a=await fetch(e,{headers:H});if(!a.ok)throw new Error(`${a.status}`);return a.json()},[H]);(0,s.useEffect)(()=>{let e=!1;const s=a.length>0,l=t.length>0,n=r.length>0;return async function(){const a=[R(`https://api.github.com/repos/${c}/releases?per_page=100`),R(`https://api.github.com/repos/${c}/tags?per_page=100`)];n||a.push(R(`https://api.github.com/repos/${c}/commits?per_page=30&page=1`));const t=await Promise.allSettled(a);if(e)return;let r=s||l||n;const i=[];if("fulfilled"===t[0].status){if(r=!0,b(t[0].value.map(u)),"fulfilled"===t[1].status){const a=new Set(t[0].value.map(e=>e.tag_name)),s=t[1].value.filter(e=>!a.has(e.name)).slice(0,20);if(s.length>0){const a=await Promise.allSettled(s.map(e=>R(`https://api.github.com/repos/${c}/commits/${e.commit.sha}`).then(a=>({tag:e,date:new Date(a.commit.author.date)}))));if(!e){const e=a.filter(e=>"fulfilled"===e.status).map(e=>g(e.value.tag,e.value.date));e.length>0&&j(e)}}}}else s||i.push("releases");if("fulfilled"===t[1].status&&"fulfilled"!==t[0].status){r=!0;const a=t[1].value.slice(0,20),s=await Promise.allSettled(a.map(e=>R(`https://api.github.com/repos/${c}/commits/${e.commit.sha}`).then(a=>({tag:e,date:new Date(a.commit.author.date)}))));if(!e){const e=s.filter(e=>"fulfilled"===e.status).map(e=>g(e.value.tag,e.value.date));e.length>0&&j(e)}}if("rejected"!==t[1].status||l||i.push("tags"),t[2])if("fulfilled"===t[2].status){r=!0;const e=t[2].value;v(e.map(p)),e.length<30&&P(!1)}else n||i.push("commits");i.length>0&&r&&S(i),r||k(!0),N(!1)}(),()=>{e=!0}},[R,a,t,r]);const L=(0,s.useCallback)(async()=>{T(!0);const e=M+1;try{const a=await R(`https://api.github.com/repos/${c}/commits?per_page=30&page=${e}`);v(e=>[...e,...a.map(p)]),D(e),a.length<30&&P(!1)}catch{P(!1),E(!0)}T(!1)},[M,R]),V=(0,s.useMemo)(()=>{const e=[...h,...y,..._].filter(e=>e.date instanceof Date&&!isNaN(e.date)).sort((e,a)=>a.date-e.date),a=[];let t=null,s=[];for(const r of e){const e=m(r.date);e!==t&&(t&&a.push({key:t,label:d(t),entries:s}),t=e,s=[]),s.push(r)}return t&&a.push({key:t,label:d(t),entries:s}),a},[h,y,_]);return x?(0,o.jsxs)("div",{className:i.timeline,children:[(0,o.jsx)("div",{className:i.skeleton}),(0,o.jsx)("div",{className:i.skeleton}),(0,o.jsx)("div",{className:i.skeleton})]}):$?(0,o.jsxs)("div",{className:i.errorMessage,children:[(0,o.jsx)("p",{children:"Unable to load project activity right now."}),(0,o.jsxs)("p",{children:["Check out the"," ",(0,o.jsx)("a",{href:`https://github.com/${c}`,target:"_blank",rel:"noopener noreferrer",children:"GitHub repository"})," ","directly."]})]}):(0,o.jsxs)("section",{"aria-label":"Dashy project activity timeline",children:[(0,o.jsx)("div",{className:i.timeline,children:V.map(e=>(0,o.jsxs)("div",{children:[(0,o.jsx)("h2",{className:i.monthHeader,children:e.label}),e.entries.map((e,a)=>(0,o.jsx)(f,{entry:e},`${e.type}-${e.sha||e.tagName||""}-${a}`))]},e.key))}),w.length>0&&(0,o.jsx)("div",{className:i.fetchErrorCard,children:(0,o.jsxs)("p",{children:["Unable to fetch some data dynamically."," ",(0,o.jsx)("a",{href:`https://github.com/${c}`,target:"_blank",rel:"noopener noreferrer",children:"View on GitHub"})," instead."]})}),C&&!U&&(0,o.jsx)("div",{className:i.loadMore,children:(0,o.jsx)("button",{className:"button color-btn btn-blue",onClick:L,disabled:I,children:I?"Loading...":"Load More"})}),U&&(0,o.jsx)("div",{className:i.fetchErrorCard,children:(0,o.jsxs)("p",{children:["Unable to fetch dynamically."," ",(0,o.jsx)("a",{href:`https://github.com/${c}/commits`,target:"_blank",rel:"noopener noreferrer",children:"View on GitHub"})," instead."]})})]})}function y(){return(0,o.jsxs)(r.A,{title:"Updates \u2014 Dashy",description:"Project activity timeline for Dashy \u2014 releases, tags, and commits",children:[(0,o.jsxs)(l.A,{children:[(0,o.jsx)("meta",{property:"og:title",content:"Updates \u2014 Dashy"}),(0,o.jsx)("meta",{property:"og:description",content:"Project activity timeline for Dashy \u2014 releases, tags, and commits"}),(0,o.jsx)("link",{rel:"canonical",href:"https://dashy.to/updates"})]}),(0,o.jsxs)("main",{className:i.updatesPage,children:[(0,o.jsxs)("div",{className:i.pageHeader,children:[(0,o.jsx)("h1",{children:"Project Updates"}),(0,o.jsx)("p",{children:"The latest releases and updates from Dashy"})]}),(0,o.jsx)(b,{})]})]})}}}]); \ No newline at end of file diff --git a/assets/js/54a53fa9.6133f345.js b/assets/js/54a53fa9.6133f345.js new file mode 100644 index 00000000..1daf5c98 --- /dev/null +++ b/assets/js/54a53fa9.6133f345.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[7535],{7510(e,a,t){t.r(a),t.d(a,{default:()=>y});var s=t(6540),r=t(5048),l=t(5260),n=t(6588);const i={updatesPage:"updatesPage_z4Av",pageHeader:"pageHeader_g4VR",timeline:"timeline_WTQQ",monthHeader:"monthHeader_QFki",entry:"entry_mTt2",releaseEntry:"releaseEntry_ZG2V",tagEntry:"tagEntry_ORGt",commitEntry:"commitEntry_JtMn",releaseCard:"releaseCard_aa3v",entryTitle:"entryTitle_RUqs",tagCard:"tagCard_SluW",commitRow:"commitRow_RIZe",badge:"badge_qP1g",badgeRelease:"badgeRelease_agcf",badgeTag:"badgeTag_gC_o",tagPill:"tagPill_IKwa",bodyPreview:"bodyPreview_iKaD",meta:"meta_GplF",providerIcon:"providerIcon_NdOm",avatar:"avatar_Vzby",authorInfo:"authorInfo_pi2M",sha:"sha_JsPS",commitMsg:"commitMsg_XeKn",authorLink:"authorLink_YWtN",avatarSmall:"avatarSmall_luV7",commitMeta:"commitMeta_teNK",skeleton:"skeleton_NVtD",pulse:"pulse_axI4",loadMore:"loadMore_YatW",fetchErrorCard:"fetchErrorCard_M8w3",errorMessage:"errorMessage_lztz"};var o=t(4848);const c="lissy93/dashy";function h(e){const a=new Date-e,t=Math.floor(a/1e3),s=Math.floor(t/60),r=Math.floor(s/60),l=Math.floor(r/24);return l>30?e.toLocaleDateString("en-US",{month:"short",day:"numeric",year:"numeric"}):l>0?`${l}d ago`:r>0?`${r}h ago`:s>0?`${s}m ago`:"just now"}function m(e){return`${e.getFullYear()}-${String(e.getMonth()+1).padStart(2,"0")}`}function d(e){const[a,t]=e.split("-");return new Date(parseInt(a),parseInt(t)-1).toLocaleDateString("en-US",{month:"long",year:"numeric"})}function u(e){const a=e.body?(t=e.body,t.replace(/#{1,6}\s*/g,"").replace(/[*_~`>]/g,"").replace(/\[([^\]]+)\]\([^)]+\)/g,"$1").replace(/!\[[^\]]*\]\([^)]+\)/g,"").replace(/\n+/g," ").trim()).slice(0,200):"";var t;return{type:"release",date:new Date(e.published_at),title:e.name||e.tag_name,body:a||void 0,url:e.html_url,author:e.author?.login,avatarUrl:e.author?.avatar_url,tagName:e.tag_name}}function g(e,a){return{type:"tag",date:a,title:e.name,url:`https://github.com/${c}/releases/tag/${e.name}`,tagName:e.name}}function p(e){const a=e.commit?.message||"";return{type:"commit",date:new Date(e.commit?.author?.date||e.commit?.committer?.date),title:a.split("\n")[0],url:e.html_url,author:e.author?.login||e.commit?.author?.name,avatarUrl:e.author?.avatar_url,sha:e.sha?.slice(0,7)}}function f({entry:e}){return"release"===e.type?(0,o.jsx)("div",{className:`${i.entry} ${i.releaseEntry}`,role:"article","aria-label":`Release: ${e.title}`,children:(0,o.jsxs)("div",{className:i.releaseCard,children:[(0,o.jsxs)("div",{className:i.entryTitle,children:[e.title,(0,o.jsx)("span",{className:`${i.badge} ${i.badgeRelease}`,children:"Release"}),e.tagName&&(0,o.jsx)("span",{className:i.tagPill,children:e.tagName})]}),e.body&&(0,o.jsx)("p",{className:i.bodyPreview,children:e.body}),(0,o.jsxs)("div",{className:i.meta,children:[e.avatarUrl&&(0,o.jsx)("span",{className:i.authorInfo,children:(0,o.jsxs)("a",{href:`https://github.com/${e.author}`,target:"_blank",rel:"noopener noreferrer",className:i.authorLink,children:[e.avatarUrl&&(0,o.jsx)("img",{src:e.avatarUrl,alt:e.author,className:i.avatarSmall,loading:"lazy"}),e.author&&(0,o.jsx)("span",{children:e.author})]})}),(0,o.jsx)("time",{dateTime:e.date.toISOString(),children:h(e.date)}),(0,o.jsx)("span",{className:i.viewOnLabel,children:"View on:"}),(0,o.jsxs)("a",{href:e.url,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("img",{className:i.providerIcon,src:"https://cdn.as93.net/k1pcts?w=32"}),"GitHub"]}),(0,o.jsxs)("a",{href:`https://hub.docker.com/layers/lissy93/dashy/${e.tagName||e.title}`,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("img",{className:i.providerIcon,src:"https://cdn.as93.net/t2hnw4?w=32"}),"DockerHub"]}),Date.now()-e.date>6048e5&&(0,o.jsxs)("a",{href:`https://codeberg.org/alicia/dashy/releases/tag/${e.tagName||e.title}`,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("img",{className:i.providerIcon,src:"https://cdn.as93.net/7c72qs?w=32"}),"Codeberg"]})]})]})}):"tag"===e.type?(0,o.jsx)("div",{className:`${i.entry} ${i.tagEntry}`,role:"article","aria-label":`Tag: ${e.title}`,children:(0,o.jsxs)("div",{className:i.tagCard,children:[(0,o.jsxs)("div",{className:i.entryTitle,children:[e.title,(0,o.jsx)("span",{className:`${i.badge} ${i.badgeTag}`,children:"Tag"})]}),(0,o.jsxs)("div",{className:i.meta,children:[(0,o.jsx)("time",{dateTime:e.date.toISOString(),children:h(e.date)}),(0,o.jsx)("span",{className:i.viewOnLabel,children:"View on:"}),(0,o.jsxs)("a",{href:e.url,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("img",{className:i.providerIcon,src:"https://cdn.as93.net/k1pcts?w=32"}),"GitHub"]}),(0,o.jsxs)("a",{href:`https://hub.docker.com/layers/lissy93/dashy/${e.title}`,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("img",{className:i.providerIcon,src:"https://cdn.as93.net/t2hnw4?w=32"}),"DockerHub"]}),Date.now()-e.date>6048e5&&(0,o.jsxs)("a",{href:`https://codeberg.org/alicia/dashy/releases/tag/${e.title}`,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("img",{className:i.providerIcon,src:"https://cdn.as93.net/7c72qs?w=32"}),"Codeberg"]})]})]})}):(0,o.jsx)("div",{className:`${i.entry} ${i.commitEntry}`,role:"article","aria-label":`Commit: ${e.title}`,children:(0,o.jsxs)("a",{href:e.url,className:i.commitRow,target:"_blank",rel:"noopener noreferrer",children:[(0,o.jsx)("span",{className:i.sha,children:e.sha}),(0,o.jsx)("span",{className:i.commitMsg,children:e.title}),(0,o.jsxs)("span",{className:i.commitMeta,children:[(0,o.jsxs)("a",{href:`https://github.com/${e.author}`,target:"_blank",rel:"noopener noreferrer",className:i.authorLink,children:[e.avatarUrl&&(0,o.jsx)("img",{src:e.avatarUrl,alt:e.author,className:i.avatarSmall,loading:"lazy"}),e.author&&(0,o.jsx)("span",{children:e.author})]}),e.author&&" \xb7 ",(0,o.jsx)("time",{dateTime:e.date.toISOString(),children:h(e.date)})]})]})})}function b(){const e=(0,n.P_)("github-data"),a=(0,s.useMemo)(()=>e?.releases?e.releases.map(e=>u({tag_name:e.tag_name,name:e.name,published_at:e.published_at,body:e.body,html_url:e.html_url,author:e.author_login?{login:e.author_login,avatar_url:e.author_avatar}:null})):[],[e]),t=(0,s.useMemo)(()=>e?.tags?e.tags.map(e=>g({name:e.name},new Date(e.date))):[],[e]),r=(0,s.useMemo)(()=>e?.commits?e.commits.map(e=>p({sha:e.sha,commit:{message:e.message,author:{date:e.date}},author:e.author_login?{login:e.author_login,avatar_url:e.author_avatar}:null,html_url:e.html_url})):[],[e]),l=a.length>0||t.length>0||r.length>0,[h,b]=(0,s.useState)(a),[y,j]=(0,s.useState)(t),[_,x]=(0,s.useState)(r),[v,N]=(0,s.useState)(!l),[w,$]=(0,s.useState)(!1),[k,S]=(0,s.useState)([]),[M,D]=(0,s.useState)(r.length>0?Math.ceil(r.length/30):1),[C,I]=(0,s.useState)(!0),[P,T]=(0,s.useState)(!1),[U,E]=(0,s.useState)(!1),H=(0,s.useMemo)(()=>({"User-Agent":"dashy-docs"}),[]),R=(0,s.useCallback)(async e=>{const a=await fetch(e,{headers:H});if(!a.ok)throw new Error(`${a.status}`);return a.json()},[H]);(0,s.useEffect)(()=>{let e=!1;const s=a.length>0,l=t.length>0,n=r.length>0;return async function(){const a=[R(`https://api.github.com/repos/${c}/releases?per_page=100`),R(`https://api.github.com/repos/${c}/tags?per_page=100`)];n||a.push(R(`https://api.github.com/repos/${c}/commits?per_page=30&page=1`));const t=await Promise.allSettled(a);if(e)return;let r=s||l||n;const i=[];if("fulfilled"===t[0].status){if(r=!0,b(t[0].value.map(u)),"fulfilled"===t[1].status){const a=new Set(t[0].value.map(e=>e.tag_name)),s=t[1].value.filter(e=>!a.has(e.name)).slice(0,20);if(s.length>0){const a=await Promise.allSettled(s.map(e=>R(`https://api.github.com/repos/${c}/commits/${e.commit.sha}`).then(a=>({tag:e,date:new Date(a.commit.author.date)}))));if(!e){const e=a.filter(e=>"fulfilled"===e.status).map(e=>g(e.value.tag,e.value.date));e.length>0&&j(e)}}}}else s||i.push("releases");if("fulfilled"===t[1].status&&"fulfilled"!==t[0].status){r=!0;const a=t[1].value.slice(0,20),s=await Promise.allSettled(a.map(e=>R(`https://api.github.com/repos/${c}/commits/${e.commit.sha}`).then(a=>({tag:e,date:new Date(a.commit.author.date)}))));if(!e){const e=s.filter(e=>"fulfilled"===e.status).map(e=>g(e.value.tag,e.value.date));e.length>0&&j(e)}}if("rejected"!==t[1].status||l||i.push("tags"),t[2])if("fulfilled"===t[2].status){r=!0;const e=t[2].value;x(e.map(p)),e.length<30&&I(!1)}else n||i.push("commits");i.length>0&&r&&S(i),r||$(!0),N(!1)}(),()=>{e=!0}},[R,a,t,r]);const L=(0,s.useCallback)(async()=>{T(!0);const e=M+1;try{const a=await R(`https://api.github.com/repos/${c}/commits?per_page=30&page=${e}`);x(e=>[...e,...a.map(p)]),D(e),a.length<30&&I(!1)}catch{I(!1),E(!0)}T(!1)},[M,R]),V=(0,s.useMemo)(()=>{const e=[...h,...y,..._].filter(e=>e.date instanceof Date&&!isNaN(e.date)).sort((e,a)=>a.date-e.date),a=[];let t=null,s=[];for(const r of e){const e=m(r.date);e!==t&&(t&&a.push({key:t,label:d(t),entries:s}),t=e,s=[]),s.push(r)}return t&&a.push({key:t,label:d(t),entries:s}),a},[h,y,_]);return v?(0,o.jsxs)("div",{className:i.timeline,children:[(0,o.jsx)("div",{className:i.skeleton}),(0,o.jsx)("div",{className:i.skeleton}),(0,o.jsx)("div",{className:i.skeleton})]}):w?(0,o.jsxs)("div",{className:i.errorMessage,children:[(0,o.jsx)("p",{children:"Unable to load project activity right now."}),(0,o.jsxs)("p",{children:["Check out the"," ",(0,o.jsx)("a",{href:`https://github.com/${c}`,target:"_blank",rel:"noopener noreferrer",children:"GitHub repository"})," ","directly."]})]}):(0,o.jsxs)("section",{"aria-label":"Dashy project activity timeline",children:[(0,o.jsx)("div",{className:i.timeline,children:V.map(e=>(0,o.jsxs)("div",{children:[(0,o.jsx)("h2",{className:i.monthHeader,children:e.label}),e.entries.map((e,a)=>(0,o.jsx)(f,{entry:e},`${e.type}-${e.sha||e.tagName||""}-${a}`))]},e.key))}),k.length>0&&(0,o.jsx)("div",{className:i.fetchErrorCard,children:(0,o.jsxs)("p",{children:["Unable to fetch some data dynamically."," ",(0,o.jsx)("a",{href:`https://github.com/${c}`,target:"_blank",rel:"noopener noreferrer",children:"View on GitHub"})," instead."]})}),C&&!U&&(0,o.jsx)("div",{className:i.loadMore,children:(0,o.jsx)("button",{className:"button color-btn btn-blue",onClick:L,disabled:P,children:P?"Loading...":"Load More"})}),U&&(0,o.jsx)("div",{className:i.fetchErrorCard,children:(0,o.jsxs)("p",{children:["Unable to fetch dynamically."," ",(0,o.jsx)("a",{href:`https://github.com/${c}/commits`,target:"_blank",rel:"noopener noreferrer",children:"View on GitHub"})," instead."]})})]})}function y(){return(0,o.jsxs)(r.A,{title:"Updates \u2014 Dashy",description:"Project activity timeline for Dashy \u2014 releases, tags, and commits",children:[(0,o.jsxs)(l.A,{children:[(0,o.jsx)("meta",{property:"og:title",content:"Updates \u2014 Dashy"}),(0,o.jsx)("meta",{property:"og:description",content:"Project activity timeline for Dashy \u2014 releases, tags, and commits"}),(0,o.jsx)("link",{rel:"canonical",href:"https://dashy.to/updates"})]}),(0,o.jsxs)("main",{className:i.updatesPage,children:[(0,o.jsxs)("div",{className:i.pageHeader,children:[(0,o.jsx)("h1",{children:"Project Updates"}),(0,o.jsx)("p",{children:"The latest releases and updates from Dashy"})]}),(0,o.jsx)(b,{})]})]})}}}]); \ No newline at end of file diff --git a/assets/js/625b1ed7.e7cc3fe8.js b/assets/js/625b1ed7.7206c2e4.js similarity index 99% rename from assets/js/625b1ed7.e7cc3fe8.js rename to assets/js/625b1ed7.7206c2e4.js index 673118d6..7d59196d 100644 --- a/assets/js/625b1ed7.e7cc3fe8.js +++ b/assets/js/625b1ed7.7206c2e4.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[1831],{5159(e,n,s){s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"authentication","title":"Authentication","description":"- Basic Auth","source":"@site/docs/authentication.md","sourceDirName":".","slug":"/authentication","permalink":"/docs/authentication","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/authentication.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Status Indicators","permalink":"/docs/status-indicators"},"next":{"title":"Keyboard Shortcuts","permalink":"/docs/searching"}}');var t=s(4848),o=s(8453);const a={},r="Authentication",l={},c=[{value:"Built-In Auth",id:"built-in-auth",level:2},{value:"Setting Up Authentication",id:"setting-up-authentication",level:3},{value:"Hash Password",id:"hash-password",level:3},{value:"Logging In and Out",id:"logging-in-and-out",level:3},{value:"Enabling Guest Access",id:"enabling-guest-access",level:3},{value:"Granular Access",id:"granular-access",level:3},{value:"Permissions",id:"permissions",level:3},{value:"Using Environment Variables for Passwords",id:"using-environment-variables-for-passwords",level:3},{value:"Adding HTTP Auth to Configuration",id:"adding-http-auth-to-configuration",level:3},{value:"Security",id:"security",level:3},{value:"HTTP Auth",id:"http-auth",level:2},{value:"Keycloak",id:"keycloak",level:2},{value:"1. Deploy Keycloak",id:"1-deploy-keycloak",level:3},{value:"2. Setup Keycloak Users",id:"2-setup-keycloak-users",level:3},{value:"3. Enable Keycloak in Dashy Config File",id:"3-enable-keycloak-in-dashy-config-file",level:3},{value:"4. Add groups and roles (Optional)",id:"4-add-groups-and-roles-optional",level:3},{value:"Troubleshooting Keycloak",id:"troubleshooting-keycloak",level:3},{value:"OIDC",id:"oidc",level:2},{value:"authentik",id:"authentik",level:3},{value:"1. Create an OIDC provider",id:"1-create-an-oidc-provider",level:4},{value:"2. Create an application",id:"2-create-an-application",level:4},{value:"3. (Optional) Limiting access via authentik with groups",id:"3-optional-limiting-access-via-authentik-with-groups",level:4},{value:"4. Configure Dashy to use OIDC client",id:"4-configure-dashy-to-use-oidc-client",level:4},{value:"5. (OPTIONAL) Example snippets for dashboard visibility",id:"5-optional-example-snippets-for-dashboard-visibility",level:4},{value:"Alternative Authentication Methods",id:"alternative-authentication-methods",level:2},{value:"Authentication Server",id:"authentication-server",level:3},{value:"Authelia",id:"authelia",level:4},{value:"VPN",id:"vpn",level:3},{value:"IP-Based Access",id:"ip-based-access",level:3},{value:"Apache",id:"apache",level:4},{value:"NGINX",id:"nginx",level:4},{value:"Caddy",id:"caddy",level:4},{value:"Web Server Authentication",id:"web-server-authentication",level:3},{value:"Apache",id:"apache-1",level:4},{value:"NGINX",id:"nginx-1",level:4},{value:"Caddy",id:"caddy-1",level:4},{value:"Lighttpd",id:"lighttpd",level:4},{value:"OAuth Services",id:"oauth-services",level:3},{value:"Static Site Hosting Providers",id:"static-site-hosting-providers",level:3}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"authentication",children:"Authentication"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#built-in-auth",children:"Basic Auth"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#setting-up-authentication",children:"Setting Up Authentication"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#hash-password",children:"Hash Password"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#logging-in-and-out",children:"Logging In and Out"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#enabling-guest-access",children:"Guest Access"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#granular-access",children:"Per-User Access"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#using-environment-variables-for-passwords",children:"Using Environment Variables for Passwords"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#adding-http-auth-to-configuration",children:"Adding HTTP Auth to Configuration"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#security",children:"Security Considerations"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#http-auth",children:"HTTP Auth"})}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#keycloak",children:"Keycloak Auth"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#1-deploy-keycloak",children:"Deploying Keycloak"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#2-setup-keycloak-users",children:"Setting up Keycloak"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#3-enable-keycloak-in-dashy-config-file",children:"Configuring Dashy for Keycloak"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#troubleshooting-keycloak",children:"Troubleshooting Keycloak"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#oidc",children:"OIDC Auth"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#authentik",children:"authentik"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#alternative-authentication-methods",children:"Alternative Authentication Methods"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#vpn",children:"VPN"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#ip-based-access",children:"IP-Based Access"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#web-server-authentication",children:"Web Server Authentication"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#oauth-services",children:"OAuth Services"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#static-site-hosting-providers",children:"Auth on Cloud Hosting Services"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsx)(n.p,{children:"[!IMPORTANT]\nDashy's built-in auth is not intended to protect a publicly hosted instance against unauthorized access. Instead you should use an auth provider compatible with your reverse proxy, or access Dashy via your VPN, or implement your own SSO logic."}),"\n",(0,t.jsx)(n.p,{children:"In cases where Dashy is only accessibly within your home network, and you just want to add a login page, then the built-in auth may be sufficient, but keep in mind that configuration can still be accessed."}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"built-in-auth",children:"Built-In Auth"}),"\n",(0,t.jsxs)(n.p,{children:["Dashy has a basic login page included, and frontend authentication. You can enable this by adding users to the ",(0,t.jsx)(n.code,{children:"auth"})," section under ",(0,t.jsx)(n.code,{children:"appConfig"})," in your ",(0,t.jsx)(n.code,{children:"conf.yml"}),". If this section is not specified, then no authentication will be required to access the app, and the homepage will resolve to your dashboard."]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!NOTE]\nSince the auth is initiated in the main app entry point (for security), a rebuild is required to apply changes to the auth configuration.\nYou can trigger a rebuild through the UI, under Config --\x3e Rebuild, or by running ",(0,t.jsx)(n.code,{children:"yarn build"})," in the root directory."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"setting-up-authentication",children:"Setting Up Authentication"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"auth"})," property takes an array of users. Each user needs to include a username, hash and optional user type (",(0,t.jsx)(n.code,{children:"admin"})," or ",(0,t.jsx)(n.code,{children:"normal"}),"). The hash property is a ",(0,t.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/SHA-2",children:"SHA-256 Hash"})," of your desired password."]}),"\n",(0,t.jsx)(n.p,{children:"For example:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n auth:\n users:\n - user: alicia\n hash: 4D1E58C90B3B94BCAD9848ECCACD6D2A8C9FBC5CA913304BBA5CDEAB36FEEFA3\n type: admin\n - user: bob\n hash: 5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\n"})}),"\n",(0,t.jsx)(n.h3,{id:"hash-password",children:"Hash Password"}),"\n",(0,t.jsxs)(n.p,{children:["Dashy uses ",(0,t.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Sha-256",children:"SHA-256 Hash"}),", a 64-character string, which you can generate using an online tool, such as ",(0,t.jsx)(n.a,{href:"https://passwordsgenerator.net/sha256-hash-generator/",children:"this one"})," or ",(0,t.jsx)(n.a,{href:"https://gchq.github.io/CyberChef/",children:"CyberChef"})," (which can be self-hosted/ ran locally)."]}),"\n",(0,t.jsx)(n.p,{children:"A hash is a one-way cryptographic function, meaning that it is easy to generate a hash for a given password, but very hard to determine the original password for a given hash. This means, that so long as your password is long, strong and unique, it is safe to store its hash in the clear. Having said that, you should never reuse passwords, hashes can be cracked by iterating over known password lists, generating a hash of each."}),"\n",(0,t.jsx)(n.h3,{id:"logging-in-and-out",children:"Logging In and Out"}),"\n",(0,t.jsx)(n.p,{children:"Once authentication is enabled, so long as there is no valid token in cookie storage, the application will redirect the user to the login page. When the user enters credentials in the login page, they will be checked, and if valid, then a token will be generated, and they can be redirected to the home page. If credentials are invalid, then an error message will be shown, and they will remain on the login page. Once in the application, to log out: the user can click the logout button (in the top-right), which will clear cookie storage, causing them to be redirected back to the login page."}),"\n",(0,t.jsx)(n.h3,{id:"enabling-guest-access",children:"Enabling Guest Access"}),"\n",(0,t.jsxs)(n.p,{children:["With authentication set up, by default no access is allowed to your dashboard without first logging in with valid credentials. Guest mode can be enabled to allow for read-only access to a secured dashboard by any user, without the need to log in. A guest user cannot write any changes to the config file, but can apply modifications locally (stored in their browser). You can enable guest access, by setting ",(0,t.jsx)(n.code,{children:"appConfig.auth.enableGuestAccess: true"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"granular-access",children:"Granular Access"}),"\n",(0,t.jsx)(n.p,{children:"You can use the following properties to make certain pages, sections or items only visible to some users, or hide pages, sections and items from guests."}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"hideForUsers"})," - Page, Section or Item will be visible to all users, except for those specified in this list"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"showForUsers"})," - Page, Section or Item will be hidden from all users, except for those specified in this list"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"hideForGuests"})," - Page, Section or Item will be visible for logged in users, but not for guests"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"For Example:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"pages:\n - name: Home Lab\n path: home-lab.yml\n displayData:\n showForUsers: [admin]\n - name: Intranet\n path: intranet.yml\n displayData:\n hideForGuests: true\n hideForUsers: [alicia, bob]\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"- name: Code Analysis & Monitoring\n icon: fas fa-code\n displayData:\n cols: 2\n hideForUsers: [alicia, bob]\n items:\n ...\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"- name: Deployment Pipelines\n icon: fas fa-rocket\n displayData:\n hideForGuests: true\n items:\n - title: Hide Me\n displayData:\n hideForUsers: [alicia, bob]\n"})}),"\n",(0,t.jsx)(n.h3,{id:"permissions",children:"Permissions"}),"\n",(0,t.jsxs)(n.p,{children:["Any user who is not an admin (with ",(0,t.jsx)(n.code,{children:"type: admin"}),") will not be able to write changes to disk."]}),"\n",(0,t.jsxs)(n.p,{children:["You can also prevent any user from writing changes to disk, using ",(0,t.jsx)(n.code,{children:"preventWriteToDisk"}),". Or prevent any changes from being saved locally in browser storage, using ",(0,t.jsx)(n.code,{children:"preventLocalSave"}),". Both properties can be found under ",(0,t.jsx)(n.a,{href:"/docs/configuring#appconfig-optional",children:(0,t.jsx)(n.code,{children:"appConfig"})}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["To disable all UI config features, including View Config, set ",(0,t.jsx)(n.code,{children:"disableConfiguration"}),". Alternatively you can disable UI config features for all non admin users by setting ",(0,t.jsx)(n.code,{children:"disableConfigurationForNonAdmin"})," to true."]}),"\n",(0,t.jsx)(n.h3,{id:"using-environment-variables-for-passwords",children:"Using Environment Variables for Passwords"}),"\n",(0,t.jsxs)(n.p,{children:["If you don't want to hash your password, you can instead leave out the ",(0,t.jsx)(n.code,{children:"hash"})," attribute, and replace it with ",(0,t.jsx)(n.code,{children:"password"})," which should have the value of an environmental variable name you wish to use."]}),"\n",(0,t.jsxs)(n.p,{children:["Note that env var must begin with ",(0,t.jsx)(n.code,{children:"VUE_APP_"}),", and you must set this variable before building the app."]}),"\n",(0,t.jsx)(n.p,{children:"For example:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:" auth:\n users:\n - user: bob\n password: VUE_APP_BOB\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Just be sure to set ",(0,t.jsx)(n.code,{children:"VUE_APP_BOB='my super secret password'"})," before build-time."]}),"\n",(0,t.jsx)(n.h3,{id:"adding-http-auth-to-configuration",children:"Adding HTTP Auth to Configuration"}),"\n",(0,t.jsxs)(n.p,{children:["If you'd also like to prevent direct visit access to your configuration file, you can set the ",(0,t.jsx)(n.code,{children:"ENABLE_HTTP_AUTH"})," environmental variable."]}),"\n",(0,t.jsx)(n.h3,{id:"security",children:"Security"}),"\n",(0,t.jsx)(n.p,{children:"With basic auth, all logic is happening on the client-side, which could mean a skilled user could manipulate the code to view parts of your configuration, including the hash. If the SHA-256 hash is of a common password, it may be possible to determine it, using a lookup table, in order to find the original password. Which can be used to manually generate the auth token, that can then be inserted into session storage, to become a valid logged in user. Therefore, you should always use a long, strong and unique password, and if you instance contains security-critical info and/ or is exposed directly to the internet, and alternative authentication method may be better. The purpose of the login page is merely to prevent immediate unauthorized access to your homepage."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"http-auth",children:"HTTP Auth"}),"\n",(0,t.jsxs)(n.p,{children:["If you'd like to protect all your config files from direct access, you can set the ",(0,t.jsx)(n.code,{children:"BASIC_AUTH_USERNAME"})," and ",(0,t.jsx)(n.code,{children:"BASIC_AUTH_PASSWORD"})," environmental variables. You'll then be prompted to enter these credentials when visiting Dashy."]}),"\n",(0,t.jsxs)(n.p,{children:["Then, if you'd like your frontend to automatically log you in, without prompting you for credentials (insecure, so only use on a trusted environment), then also specify ",(0,t.jsx)(n.code,{children:"VUE_APP_BASIC_AUTH_USERNAME"})," and ",(0,t.jsx)(n.code,{children:"VUE_APP_BASIC_AUTH_PASSWORD"}),". This is useful for when you're hosting Dashy on a private server, and just want to use auth for user management and to prevent direct access to your config files, while still allowing the frontend to access them. Note that a rebuild is required for these changes to take effect."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"keycloak",children:"Keycloak"}),"\n",(0,t.jsxs)(n.p,{children:["Dashy also supports using a ",(0,t.jsx)(n.a,{href:"https://www.keycloak.org/",children:"Keycloak"})," authentication server. The setup for this is a bit more involved, but it gives you greater security overall, useful for if your instance is exposed to the internet."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"https://www.keycloak.org/about.html",children:"Keycloak"})," is a Java-based ",(0,t.jsx)(n.a,{href:"https://github.com/keycloak/keycloak",children:"open source"}),", high-performance, secure authentication system, supported by ",(0,t.jsx)(n.a,{href:"https://www.redhat.com/en",children:"RedHat"}),". It is easy to setup (",(0,t.jsx)(n.a,{href:"https://quay.io/repository/keycloak/keycloak",children:"with Docker"}),"), and enables you to secure multiple self-hosted applications with single-sign-on using standard protocols (OpenID Connect, OAuth 2.0, SAML 2.0 and social login). It's also very customizable, you can write or use custom ",(0,t.jsx)(n.a,{href:"https://wjw465150.gitbooks.io/keycloak-documentation/content/server_development/topics/themes.html",children:"themes"}),", ",(0,t.jsx)(n.a,{href:"https://www.keycloak.org/extensions.html",children:"plugins"}),", ",(0,t.jsx)(n.a,{href:"https://wjw465150.gitbooks.io/keycloak-documentation/content/server_admin/topics/authentication/password-policies.html",children:"password policies"})," and more.\nThe following guide will walk you through setting up Keycloak with Dashy. If you already have a Keycloak instance configured, then skip to Step 3."]}),"\n",(0,t.jsx)(n.h3,{id:"1-deploy-keycloak",children:"1. Deploy Keycloak"}),"\n",(0,t.jsxs)(n.p,{children:["First thing to do is to spin up a new instance of Keycloak. You will need ",(0,t.jsx)(n.a,{href:"https://docs.docker.com/engine/install/",children:"Docker installed"}),", and can then choose a tag, and pull the container from ",(0,t.jsx)(n.a,{href:"https://quay.io/repository/keycloak/keycloak",children:"quay.io/keycloak/keycloak"})]}),"\n",(0,t.jsx)(n.p,{children:"Use the following run command, replacing the attributes (default credentials, port and name), or incorporate this into your docker-compose file."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"docker run -d \\\n -p 8081:8080 \\\n --name auth-server \\\n -e KEYCLOAK_USER=admin \\\n -e KEYCLOAK_PASSWORD=admin \\\n quay.io/keycloak/keycloak:15.0.2\n"})}),"\n",(0,t.jsxs)(n.p,{children:["If you need to pull from DockerHub, a non-official image is available ",(0,t.jsx)(n.a,{href:"https://registry.hub.docker.com/r/jboss/keycloak",children:"here"}),". Or if you would prefer not to use Docker, you can also directly install Keycloak from source, following ",(0,t.jsx)(n.a,{href:"https://www.keycloak.org/docs/latest/getting_started/index.html",children:"this guide"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["You should now be able to access the Keycloak web interface, using the port specified above (e.g. ",(0,t.jsx)(n.code,{children:"http://127.0.0.1:8081"}),"), login with the default credentials, and when prompted create a new password."]}),"\n",(0,t.jsx)(n.h3,{id:"2-setup-keycloak-users",children:"2. Setup Keycloak Users"}),"\n",(0,t.jsx)(n.p,{children:"Before we can use Keycloak, we must first set it up with some users. Keycloak uses Realms (similar to tenants) to create isolated groups of users. You must create a Realm before you will be able to add your first user."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Head over to the admin console"}),"\n",(0,t.jsx)(n.li,{children:"In the top-left corner there is a dropdown called 'Master', hover over it and then click 'Add Realm'"}),"\n",(0,t.jsx)(n.li,{children:"Give your realm a name, and hit 'Create'"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"You can now create your first user."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"In the left-hand menu, click 'Users', then 'Add User'"}),"\n",(0,t.jsx)(n.li,{children:"Fill in the form, including username and hit 'Save'"}),"\n",(0,t.jsx)(n.li,{children:"Under the 'Credentials' tab, give the new user an initial password. They will be prompted to change this after first login"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The last thing we need to do in the Keycloak admin console is to create a new client"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Within your new realm, navigate to 'Clients' on the left-hand side, then click 'Create' in the top-right"}),"\n",(0,t.jsx)(n.li,{children:"Choose a 'Client ID', set 'Client Protocol' to 'openid-connect', and for 'Valid Redirect URIs' put a URL pattern to where you're hosting Dashy (if you're just testing locally, then * is fine), and do the same for the 'Web Origins' field"}),"\n",(0,t.jsx)(n.li,{children:"Make note of your client-id, and click 'Save'"}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"3-enable-keycloak-in-dashy-config-file",children:"3. Enable Keycloak in Dashy Config File"}),"\n",(0,t.jsxs)(n.p,{children:["Now that your Keycloak instance is up and running, all that's left to do is to configure Dashy to use it. Under ",(0,t.jsx)(n.code,{children:"appConfig"}),", set ",(0,t.jsx)(n.code,{children:"auth.enableKeycloak: true"}),", then fill in the details in ",(0,t.jsx)(n.code,{children:"auth.keycloak"}),", including: ",(0,t.jsx)(n.code,{children:"serverUrl"})," - the URL where your Keycloak instance is hosted, ",(0,t.jsx)(n.code,{children:"realm"})," - the name you gave your Realm, and ",(0,t.jsx)(n.code,{children:"clientId"})," - the Client ID you chose.\nFor example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n ...\n auth:\n enableKeycloak: true\n keycloak:\n serverUrl: 'http://localhost:8081'\n realm: 'alicia-homelab'\n clientId: 'dashy'\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Note that if you are using Keycloak V 17 or older, you will also need to set ",(0,t.jsx)(n.code,{children:"legacySupport: true"})," (also under ",(0,t.jsx)(n.code,{children:"appConfig.auth.keycloak"}),"). This is because the API endpoint was updated in later versions."]}),"\n",(0,t.jsxs)(n.p,{children:["If you use Keycloak with an external Identity Provier, you can set the ",(0,t.jsx)(n.code,{children:"idpHint: 'alias-of-kc-idp'"})," option to allow the IdP Hint to be passed to Keycloak. This will cause Keycloak to skip its login page and redirect the user directly to the specified IdP's login page. Set to the value of the 'Alias' field of the desired IdP as defined in Keycloak under 'Identity Providers'."]}),"\n",(0,t.jsx)(n.h3,{id:"4-add-groups-and-roles-optional",children:"4. Add groups and roles (Optional)"}),"\n",(0,t.jsxs)(n.p,{children:["Keycloak allows you to assign users roles and groups. You can use these values to configure who can access various sections or items in Dashy.\nKeycloak server administration and configuration is a deep topic; please refer to the ",(0,t.jsx)(n.a,{href:"https://www.keycloak.org/docs/latest/server_admin/index.html#assigning-permissions-and-access-using-roles-and-groups",children:"server admin guide"})," to see details about creating and assigning roles and groups.\nOnce you have groups or roles assigned to users you can configure access under each section or item ",(0,t.jsx)(n.code,{children:"displayData.showForKeycloakUser"})," and ",(0,t.jsx)(n.code,{children:"displayData.hideForKeycloakUser"}),".\nBoth show and hide configurations accept a list of ",(0,t.jsx)(n.code,{children:"groups"})," and ",(0,t.jsx)(n.code,{children:"roles"})," that limit access. If a users data matches one or more items in these lists they will be allowed or excluded as defined."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"sections:\n - name: DeveloperResources\n displayData:\n showForKeycloakUsers:\n roles: ['canViewDevResources']\n hideForKeycloakUsers:\n groups: ['ProductTeam']\n items:\n - title: Not Visible for developers\n displayData:\n hideForKeycloakUsers:\n groups: ['DevelopmentTeam']\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Depending on how you're hosting Dashy and Keycloak, you may also need to set some HTTP headers, to prevent a CORS error. This would typically be the ",(0,t.jsx)(n.code,{children:"Access-Control-Allow-Origin [URL-of Dashy]"})," on your Keycloak instance. See the ",(0,t.jsx)(n.a,{href:"/docs/management#setting-headers",children:"Setting Headers"})," guide in the management docs for more info."]}),"\n",(0,t.jsx)(n.p,{children:"Your app is now secured :) When you load Dashy, it will redirect to your Keycloak login page, and any user without valid credentials will be prevented from accessing your dashboard."}),"\n",(0,t.jsxs)(n.p,{children:["From within the Keycloak console, you can then configure things like time-outs, password policies, etc. You can also backup your full Keycloak config, and it is recommended to do this, along with your Dashy config. You can spin up both Dashy and Keycloak simultaneously and restore both applications configs using a ",(0,t.jsx)(n.code,{children:"docker-compose.yml"})," file, and this is recommended."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"troubleshooting-keycloak",children:"Troubleshooting Keycloak"}),"\n",(0,t.jsx)(n.p,{children:"If you encounter issues with your Keycloak setup, follow these steps to troubleshoot and resolve common problems."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:'Client Authentication Issue\nProblem: Redirect loop, if client authentication is enabled.\nSolution: Switch off "client authentication" in "TC clients" -> "Advanced" settings.'}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:['Double URL\nProblem: If you get redirected to "',(0,t.jsx)(n.a,{href:"https://dashy.my.domain/#iss=https://keycloak.my.domain/realms/my-realm",children:"https://dashy.my.domain/#iss=https://keycloak.my.domain/realms/my-realm"}),'"\nSolution: Make sure to turn on "Exclude Issuer From Authentication Response" in "TC clients" -> "Advanced" -> "OpenID Connect Compatibility Modes"']}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:['Problems with mutiple Dashy Pages\nProblem: Refreshing or logging out of dashy results in an "invalid_redirect_uri" error.\nSolution: In "TC clients" -> "Access settings" -> "Root URL" ',(0,t.jsx)(n.a,{href:"https://dashy.my.domain/",children:"https://dashy.my.domain/"}),", valid redirect URIs must be /*"]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"oidc",children:"OIDC"}),"\n",(0,t.jsxs)(n.p,{children:["Dashy also supports using a general ",(0,t.jsx)(n.a,{href:"https://openid.net/connect/",children:"OIDC compatible"})," authentication server. In order to use it, the authentication section needs to be configured:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n auth:\n enableOidc: true\n oidc:\n clientId: [registered client id]\n endpoint: [OIDC endpoint]\n scope: [The scope(s) to request from the OIDC provider]\n adminGroup: admin\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Because Dashy is a SPA, a ",(0,t.jsx)(n.a,{href:"https://datatracker.ietf.org/doc/html/rfc6749#section-2.1",children:"public client"})," registration with PKCE is needed."]}),"\n",(0,t.jsx)(n.p,{children:"An example for Authelia is shared below, but other OIDC systems can be used:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"identity_providers:\n oidc:\n clients:\n - client_id: dashy\n client_name: dashy\n public: true\n authorization_policy: 'one_factor'\n require_pkce: true\n pkce_challenge_method: 'S256'\n redirect_uris:\n - https://dashy.local # should point to your dashy endpoint\n grant_types:\n - authorization_code\n scopes:\n - 'openid'\n - 'profile'\n - 'roles'\n - 'email'\n - 'groups'\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Groups and roles will be populated and available for controlling display similar to ",(0,t.jsx)(n.a,{href:"#keycloak",children:"Keycloak"})," above."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"authentik",children:"authentik"}),"\n",(0,t.jsxs)(n.p,{children:["This documentation is specific to ",(0,t.jsx)(n.code,{children:"authentik"}),", however it may be useful in getting other idP's working with ",(0,t.jsx)(n.code,{children:"Dashy"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"This guide will only walk through the following:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Creating and configuring an OIDC provider"}),"\n",(0,t.jsx)(n.li,{children:"Creating and configuring an application"}),"\n",(0,t.jsx)(n.li,{children:"Assigning groups"}),"\n",(0,t.jsxs)(n.li,{children:["Configuring ",(0,t.jsx)(n.code,{children:"Dashy"})," to use the OIDC client"]}),"\n",(0,t.jsxs)(n.li,{children:["Show quick examples of how to hide/show ",(0,t.jsx)(n.code,{children:"pages"}),", ",(0,t.jsx)(n.code,{children:"items"}),", and ",(0,t.jsx)(n.code,{children:"sections"})," using OIDC groups"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"This guide assumes the following:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["You have a working instance of ",(0,t.jsx)(n.code,{children:"authentik"})," terminated with SSL"]}),"\n",(0,t.jsxs)(n.li,{children:["You have a working instance of ",(0,t.jsx)(n.code,{children:"Dashy"})," terminated with SSL"]}),"\n",(0,t.jsx)(n.li,{children:"Users and groups are provisioned"}),"\n",(0,t.jsxs)(n.li,{children:["You are familiar with how ",(0,t.jsx)(n.code,{children:"authentik"})," works in case you need to do further troubleshooting that is outside the scope of this guide."]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!TIP]\nIt it recommended that you create groups specific for ",(0,t.jsx)(n.code,{children:"Dashy"}),". Groups will allow you to display content based on group membership as well as limiting user access to ",(0,t.jsx)(n.code,{children:"Dashy"}),". If you do not need this functionality, then you can forgo creating specific groups."]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsx)(n.p,{children:"[!TIP]\nYou can use the application wizard to create the provider and application at one time. This is the recommended route, but only the manual process will be outlined in this guide."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/72e45162-6c86-4d6f-a1ae-724ac503c00c",alt:"image"})}),"\n",(0,t.jsx)(n.h4,{id:"1-create-an-oidc-provider",children:"1. Create an OIDC provider"}),"\n",(0,t.jsxs)(n.p,{children:["Login to the admin console for ",(0,t.jsx)(n.code,{children:"authentik"}),". Go to ",(0,t.jsx)(n.code,{children:"Applications"})," > ",(0,t.jsx)(n.code,{children:"Providers"}),". Click ",(0,t.jsx)(n.code,{children:"Create"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/c1f7f45d-469c-4bf1-a825-34658341a83e",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["A dialog box will pop-up, select the ",(0,t.jsx)(n.code,{children:"OAuth2/OpenID Provider"}),". Click ",(0,t.jsx)(n.code,{children:"Next"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/ea84fe57-b813-404d-8dad-5e221b440bdb",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["On the next page of the wizard, set the ",(0,t.jsx)(n.code,{children:"Name"}),", ",(0,t.jsx)(n.code,{children:"Authentication flow"}),", and ",(0,t.jsx)(n.code,{children:"Authorization flow"}),". See example below. Using the ",(0,t.jsx)(n.code,{children:"default-provider-authorization-implicit-consent"})," authorization flow on internal services and ",(0,t.jsx)(n.code,{children:"default-provider-authorization-explicit-consent"})," on external services is a common practice. However, it is fully up to you on how you would like to configure this option. ",(0,t.jsx)(n.code,{children:"Implicit"})," will login directly without user consent, ",(0,t.jsx)(n.code,{children:"explicit"})," will ask if the user approves the service being logged into with their user credentials."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/e600aeaf-08d1-49aa-b304-11e90e5c89cd",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Scroll down and configure the ",(0,t.jsx)(n.code,{children:"Protocol settings"}),". Set the ",(0,t.jsx)(n.code,{children:"Client type"})," to ",(0,t.jsx)(n.code,{children:"Public"}),". Add the ",(0,t.jsx)(n.code,{children:"Redirect URIs/Origins (RegEx)"}),". If the site is hosted at ",(0,t.jsx)(n.code,{children:"dashy.lan.domain.com"}),", then you would enter as the example below."]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!NOTE]\nIf you have an internal and external domain for ",(0,t.jsx)(n.code,{children:"Dashy"}),", enter both URI's. Enter each URI on a new line."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/4a289d7e-d7b4-4ff6-af5d-3e5202fae84e",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Scroll down to set the ",(0,t.jsx)(n.code,{children:"Signing Key"}),". It is recommended to use the built in ",(0,t.jsx)(n.code,{children:"authentik Self-signed Certificate"})," here unless you have special needs for your own custom cert."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/386c0750-9d2b-4482-8938-8b301b489b38",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Expand ",(0,t.jsx)(n.code,{children:"Advanced protocol settings"})," then verify the ",(0,t.jsx)(n.code,{children:"Scopes"})," are set to what is highlighted in ",(0,t.jsx)(n.code,{children:"white"})," below. Set the ",(0,t.jsx)(n.code,{children:"Subject mode"})," to ",(0,t.jsx)(n.code,{children:"Based on the Users's Email"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/ae5e87b8-1ad6-41dd-b6e1-9665623f842a",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Lastly, toggle ",(0,t.jsx)(n.code,{children:"Include claims in id_token"})," to on. Click ",(0,t.jsx)(n.code,{children:"Finish"})," to complete creating the provider."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/25353b3c-3f54-47cf-bd47-b5023f86d7cf",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Grab the generated ",(0,t.jsx)(n.code,{children:"Client ID"})," and ",(0,t.jsx)(n.code,{children:"OpenID Configuration Issuer"})," URL by clicking the newly created provider as this will use this later when ",(0,t.jsx)(n.code,{children:"Dashy"})," is configured to use the OIDC auth mechanism. In this tutorial, what was generated is used below. Obviously adjust the ",(0,t.jsx)(n.code,{children:"Client ID"})," that was generated and use your domain here for the ",(0,t.jsx)(n.code,{children:"issuer"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Client ID: pzN9DCMLqHTTatgtYFg50cl0jn1NmCyBC3wreX15\nOpenID Configuration Issuer: https://auth.domain.com/application/o/dashy/\n"})}),"\n",(0,t.jsx)(n.h4,{id:"2-create-an-application",children:"2. Create an application"}),"\n",(0,t.jsxs)(n.p,{children:["Make sure you are still in the ",(0,t.jsx)(n.code,{children:"authentik"})," admin console then go to ",(0,t.jsx)(n.code,{children:"Applications"})," > ",(0,t.jsx)(n.code,{children:"Applications"}),". Click ",(0,t.jsx)(n.code,{children:"Create"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/fd225936-15a1-409f-83c8-e24a43047df0",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Next, it is required to give a user facing ",(0,t.jsx)(n.code,{children:"Name"}),", ",(0,t.jsx)(n.code,{children:"Slug"})," and assign the newly created provider. Use the example below if you have been following the guide. If you have used your own naming, then adjust accordingly. Click ",(0,t.jsx)(n.code,{children:"Create"})," once you are done."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/e6574d7d-6b22-4e7d-b388-45341b98746b",alt:"image"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!TIP]\nOpen the application in a new tab from the ",(0,t.jsx)(n.code,{children:"authentik"})," user portal and upload a custom icon. You can also enter a user facing ",(0,t.jsx)(n.code,{children:"Description"})," that the user would see."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/20561387-549f-49de-98e6-30330dcdc734",alt:"image"})}),"\n",(0,t.jsxs)(n.h4,{id:"3-optional-limiting-access-via-authentik-with-groups",children:["3. ",(0,t.jsx)(n.em,{children:"(Optional)"})," Limiting access via ",(0,t.jsx)(n.code,{children:"authentik"})," with groups"]}),"\n",(0,t.jsxs)(n.p,{children:["If you would like to deny ",(0,t.jsx)(n.code,{children:"Dashy"})," access from specific users who are not within ",(0,t.jsx)(n.code,{children:"authentik"})," based groups, you bind them to the application you just created now. ",(0,t.jsx)(n.code,{children:"authentik"})," will deny access to those who are not members of this group or groups. If you want to allow everyone access from your ",(0,t.jsx)(n.code,{children:"authentik"})," instance, skip this step."]}),"\n",(0,t.jsxs)(n.p,{children:["Make sure you are still in the ",(0,t.jsx)(n.code,{children:"authentik"})," admin console then go to ",(0,t.jsx)(n.code,{children:"Applications"})," > ",(0,t.jsx)(n.code,{children:"Applications"}),". Click the newly created ",(0,t.jsx)(n.code,{children:"Dashy"})," application."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/613fafe7-881f-4664-a903-945854ac65e2",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Click the ",(0,t.jsx)(n.code,{children:"Policy/Group/User Bindings"})," tab at the top, then click ",(0,t.jsx)(n.code,{children:"Bind existing policy"}),". This assumes you have already created the groups you want to use for ",(0,t.jsx)(n.code,{children:"Dashy"})," and populated users in those groups."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/10fca15b-e77d-4624-ae03-0ece3910904c",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Click ",(0,t.jsx)(n.code,{children:"Group"})," for the binding type. Under ",(0,t.jsx)(n.code,{children:"Group"})," select the appropriate group you would like to bind. Make sure ",(0,t.jsx)(n.code,{children:"Enabled"})," is toggeled on. Click ",(0,t.jsx)(n.code,{children:"Create"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/ebf680ab-696f-4c08-ae89-d73fe92b398f",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Dashy"})," will now be scoped only to users within the assigned groups you have bound the application to. Keep adding groups if you would like to adjust the dashboard visibilty based on group membership."]}),"\n",(0,t.jsxs)(n.h4,{id:"4-configure-dashy-to-use-oidc-client",children:["4. Configure ",(0,t.jsx)(n.code,{children:"Dashy"})," to use OIDC client"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!IMPORTANT]\nIt is highly recommended to edit your ",(0,t.jsx)(n.code,{children:"conf.yml"})," directly for this step."]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!CAUTION]\nDo not make the same mistake many have made here by including the fully qualified address for the ",(0,t.jsx)(n.code,{children:"OpenID Configuration URL"}),". ",(0,t.jsx)(n.code,{children:"Dashy"})," will append the ",(0,t.jsx)(n.code,{children:".well-known"})," configuration automatically. If the ",(0,t.jsx)(n.code,{children:".well-known"})," URI is included the app will get redirect loops and ",(0,t.jsx)(n.code,{children:"400"})," errors."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Enter the ",(0,t.jsx)(n.code,{children:"Client ID"})," in the ",(0,t.jsx)(n.code,{children:"clientId"})," field and ",(0,t.jsx)(n.code,{children:"OpenID Configuration Issuer"})," in the ",(0,t.jsx)(n.code,{children:"endpoint"})," field."]}),"\n",(0,t.jsxs)(n.p,{children:["Below is how to configure the ",(0,t.jsx)(n.code,{children:"auth"})," section in the yaml syntax. Once this is enabled, when an attempt to access ",(0,t.jsx)(n.code,{children:"Dashy"})," is made it will now redirect you to the ",(0,t.jsx)(n.code,{children:"authentik"})," login page moving forward."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"appConfig:\n theme: glass\n layout: auto\n iconSize: medium\n auth:\n enableOidc: true\n oidc:\n clientId: pzN9DCMLqHTTatgtYFg50cl0jn1NmCyBC3wreX15\n endpoint: https://auth.domain.com/application/o/dashy/\n"})}),"\n",(0,t.jsxs)(n.h4,{id:"5-optional-example-snippets-for-dashboard-visibility",children:["5. ",(0,t.jsx)(n.em,{children:"(OPTIONAL)"})," Example snippets for dashboard visibility"]}),"\n",(0,t.jsxs)(n.p,{children:["Using the ",(0,t.jsx)(n.code,{children:"hideForKeycloakUsers"})," configuration option is needed to use the ",(0,t.jsx)(n.code,{children:"authentik"})," groups that were created previously."]}),"\n",(0,t.jsxs)(n.p,{children:["Adjusting ",(0,t.jsx)(n.code,{children:"pages"})," visibility:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"pages:\n - name: App Management\n path: appmgmt.yml\n displayData:\n hideForKeycloakUsers:\n groups:\n - Dashy Users\n - name: Network Management\n path: network.yml\n displayData:\n hideForKeycloakUsers:\n groups:\n - Dashy Users\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Adjusting ",(0,t.jsx)(n.code,{children:"items"})," visibility:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:" items:\n - title: Authentik Admin\n icon: authentik.svg\n url: https://auth.domain.com/if/admin/\n target: newtab\n id: 0_1472_authentikadmin\n displayData:\n hideForKeycloakUsers:\n groups:\n - Dashy Users\n - title: Authentik User\n icon: authentik-light.png\n url: https://auth.domain.com/if/user/\n target: newtab\n id: 1_1472_authentikuser\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Adjusting ",(0,t.jsx)(n.code,{children:"sections"})," visibility:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"sections:\n - name: Authentication\n displayData:\n sortBy: default\n rows: 2\n cols: 1\n collapsed: false\n hideForGuests: false\n hideForKeycloakUsers:\n groups: \n - Dashy Users\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"alternative-authentication-methods",children:"Alternative Authentication Methods"}),"\n",(0,t.jsx)(n.p,{children:"If you are self-hosting Dashy, and require secure authentication to prevent unauthorized access, then you can either use Keycloak, or one of the following options:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#authentication-server",children:"Authentication Server"})," - Put Dashy behind a self-hosted auth server"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#vpn",children:"VPN"})," - Use a VPN to tunnel into the network where Dashy is running"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#ip-based-access",children:"IP-Based Access"})," - Disallow access from all IP addresses, except your own"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#web-server-authentication",children:"Web Server Authentication"})," - Enable user control within your web server or proxy"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#oauth-services",children:"OAuth Services"})," - Implement a user management system using a cloud provider"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#static-site-hosting-providers",children:"Password Protection (for cloud providers)"})," - Enable password-protection on your site"]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"authentication-server",children:"Authentication Server"}),"\n",(0,t.jsx)(n.h4,{id:"authelia",children:"Authelia"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"https://www.authelia.com/",children:"Authelia"})," is an open-source full-featured authentication server, which can be self-hosted and either on bare metal, in a Docker container or in a Kubernetes cluster. It allows for fine-grained access control rules based on IP, path, users etc, and supports 2FA, simple password access or bypass policies for your domains."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"git clone https://github.com/authelia/authelia.git"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"cd authelia/examples/compose/lite"})}),"\n",(0,t.jsxs)(n.li,{children:["Modify the ",(0,t.jsx)(n.code,{children:"users_database.yml"})," the default username and password is authelia"]}),"\n",(0,t.jsxs)(n.li,{children:["Modify the ",(0,t.jsx)(n.code,{children:"configuration.yml"})," and ",(0,t.jsx)(n.code,{children:"docker-compose.yml"})," with your respective domains and secrets"]}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"docker-compose up -d"})}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["For more information, see the ",(0,t.jsx)(n.a,{href:"https://www.authelia.com/docs/",children:"Authelia docs"})]}),"\n",(0,t.jsx)(n.h3,{id:"vpn",children:"VPN"}),"\n",(0,t.jsxs)(n.p,{children:["A catch-all solution to accessing services running from your home network remotely is to use a VPN. It means you do not need to worry about implementing complex authentication rules, or trusting the login implementation of individual applications. However it can be inconvenient to use on a day-to-day basis, and some public and corporate WiFi block VPN connections. Two popular VPN protocols are ",(0,t.jsx)(n.a,{href:"https://openvpn.net/",children:"OpenVPN"})," and ",(0,t.jsx)(n.a,{href:"https://www.wireguard.com/",children:"WireGuard"})]}),"\n",(0,t.jsx)(n.h3,{id:"ip-based-access",children:"IP-Based Access"}),"\n",(0,t.jsx)(n.p,{children:"If you have a static IP or use a VPN to access your running services, then you can use conditional access to block access to Dashy from everyone except users of your pre-defined IP address. This feature is offered by most cloud providers, and supported by most web servers."}),"\n",(0,t.jsx)(n.h4,{id:"apache",children:"Apache"}),"\n",(0,t.jsxs)(n.p,{children:["In Apache, this is configured in your ",(0,t.jsx)(n.code,{children:".htaccess"})," file in Dashy's root folder, and should look something like:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"Order Deny,Allow\nDeny from all\nAllow from [your-ip]\n"})}),"\n",(0,t.jsx)(n.h4,{id:"nginx",children:"NGINX"}),"\n",(0,t.jsxs)(n.p,{children:["In NGINX you can specify ",(0,t.jsx)(n.a,{href:"https://docs.nginx.com/nginx/admin-guide/security-controls/controlling-access-proxied-http/",children:"control access"})," rules for a given site in your ",(0,t.jsx)(n.code,{children:"nginx.conf"})," or hosts file. For example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"server {\n\tlisten 8080;\n\tserver_name www.dashy.example.com;\n\tlocation / {\n\t\troot /path/to/dashy/;\n\t\tpassenger_enabled on;\n\t\tallow [your-ip];\n\t\tdeny all;\n }\n }\n"})}),"\n",(0,t.jsx)(n.h4,{id:"caddy",children:"Caddy"}),"\n",(0,t.jsxs)(n.p,{children:["In Caddy, ",(0,t.jsx)(n.a,{href:"https://caddyserver.com/docs/caddyfile/matchers",children:"Request Matchers"})," can be used to filter requests"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:'dashy.site {\n\t@public_networks not remote_ip [your-ip]\n\trespond @public_networks "Access denied" 403\n}\n'})}),"\n",(0,t.jsx)(n.h3,{id:"web-server-authentication",children:"Web Server Authentication"}),"\n",(0,t.jsx)(n.p,{children:"Most web servers make password protecting certain apps very easy. Note that you should also set up HTTPS and have a valid certificate in order for this to be secure."}),"\n",(0,t.jsx)(n.h4,{id:"apache-1",children:"Apache"}),"\n",(0,t.jsxs)(n.p,{children:["First crate a ",(0,t.jsx)(n.code,{children:".htaccess"})," file in Dashy's route directory. Specify the auth type and path to where you want to store the password file (usually the same folder). For example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:'AuthType Basic\nAuthName "Please Sign into Dashy"\nAuthUserFile /path/dashy/.htpasswd\nrequire valid-user\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Then create a ",(0,t.jsx)(n.code,{children:".htpasswd"})," file in the same directory. List users and their hashed passwords here, with one user on each line, and a colon between username and password (e.g. ",(0,t.jsx)(n.code,{children:"[username]:[hashed-password]"}),"). You will need to generate an MD5 hash of your desired password, this can be done with an ",(0,t.jsx)(n.a,{href:"https://www.web2generators.com/apache-tools/htpasswd-generator",children:"online tool"}),". Your file will look something like:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"alicia:$apr1$jv0spemw$RzOX5/GgY69JMkgV6u16l0\n"})}),"\n",(0,t.jsx)(n.h4,{id:"nginx-1",children:"NGINX"}),"\n",(0,t.jsxs)(n.p,{children:["NGINX has an ",(0,t.jsx)(n.a,{href:"https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html",children:"authentication module"})," which can be used to add passwords to given sites, and is fairly simple to set up. Similar to above, you will need to create a ",(0,t.jsx)(n.code,{children:".htpasswd"})," file. Then just enable auth and specify the path to that file, for example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:'location / {\n auth_basic "closed site";\n auth_basic_user_file conf/htpasswd;\n}\n'})}),"\n",(0,t.jsx)(n.h4,{id:"caddy-1",children:"Caddy"}),"\n",(0,t.jsxs)(n.p,{children:["Caddy has a ",(0,t.jsx)(n.a,{href:"https://caddyserver.com/docs/caddyfile/directives/basicauth",children:"basic-auth"})," directive, where you specify a username and hash. The password hash needs to be base-64 encoded, the ",(0,t.jsx)(n.a,{href:"https://caddyserver.com/docs/command-line#caddy-hash-password",children:(0,t.jsx)(n.code,{children:"caddy hash-password"})})," command can help with this. For example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"basicauth /secret/* {\n\talicia JDJhJDEwJEVCNmdaNEg2Ti5iejRMYkF3MFZhZ3VtV3E1SzBWZEZ5Q3VWc0tzOEJwZE9TaFlZdEVkZDhX\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["For more info about implementing a single sign on for all your apps with Caddy, see ",(0,t.jsx)(n.a,{href:"https://joshstrange.com/securing-your-self-hosted-apps-with-single-signon/",children:"this tutorial"})]}),"\n",(0,t.jsx)(n.h4,{id:"lighttpd",children:"Lighttpd"}),"\n",(0,t.jsxs)(n.p,{children:["You can use the ",(0,t.jsx)(n.a,{href:"https://doc.lighttpd.net/lighttpd2/mod_auth.html",children:"mod_auth"})," module to secure your site with Lighttpd. Like with Apache, you need to first create a password file listing your usernames and hashed passwords, but in Lighttpd, it's usually called ",(0,t.jsx)(n.code,{children:".lighttpdpassword"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Then in your ",(0,t.jsx)(n.code,{children:"lighttpd.conf"})," file (usually in the ",(0,t.jsx)(n.code,{children:"/etc/lighttpd/"})," directory), load in the mod_auth module, and configure it's directives. For example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:'server.modules += ( "mod_auth" )\nauth.debug = 2\nauth.backend = "plain"\nauth.backend.plain.userfile = "/home/lighttpd/.lighttpdpassword"\n\n$HTTP["host"] == "dashy.my-domain.net" {\n server.document-root = "/home/lighttpd/dashy.my-domain.net/http"\n server.errorlog = "/var/log/lighttpd/dashy.my-domain.net/error.log"\n accesslog.filename = "/var/log/lighttpd/dashy.my-domain.net/access.log"\n auth.require = (\n "/docs/" => (\n "method" => "basic",\n "realm" => "Password protected area",\n "require" => "user=alicia"\n )\n )\n}\n'})}),"\n",(0,t.jsx)(n.p,{children:"Restart your web server for changes to take effect."}),"\n",(0,t.jsx)(n.h3,{id:"oauth-services",children:"OAuth Services"}),"\n",(0,t.jsxs)(n.p,{children:["There are also authentication services, such as ",(0,t.jsx)(n.a,{href:"https://www.ory.sh/",children:"Ory.sh"}),", ",(0,t.jsx)(n.a,{href:"https://developer.okta.com/",children:"Okta"}),", ",(0,t.jsx)(n.a,{href:"https://auth0.com/",children:"Auth0"}),", ",(0,t.jsx)(n.a,{href:"https://firebase.google.com/docs/auth/",children:"Firebase"}),". Implementing one of these solutions would involve some changes to the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/Auth.js",children:(0,t.jsx)(n.code,{children:"Auth.js"})})," file, but should be fairly straightforward."]}),"\n",(0,t.jsx)(n.h3,{id:"static-site-hosting-providers",children:"Static Site Hosting Providers"}),"\n",(0,t.jsxs)(n.p,{children:["If you are hosting Dashy on a cloud platform, you will probably find that it has built-in support for password protected access to web apps. For more info, see the relevant docs for your provider, for example: ",(0,t.jsx)(n.a,{href:"https://docs.netlify.com/visitor-access/password-protection/",children:"Netlify Password Protection"}),", ",(0,t.jsx)(n.a,{href:"https://www.cloudflare.com/teams/access/",children:"Cloudflare Access"}),", ",(0,t.jsx)(n.a,{href:"https://aws.amazon.com/cognito/",children:"AWS Cognito"}),", ",(0,t.jsx)(n.a,{href:"https://docs.microsoft.com/en-us/azure/app-service/scenario-secure-app-authentication-app-service",children:"Azure Authentication"})," and ",(0,t.jsx)(n.a,{href:"https://vercel.com/docs/platform/projects#password-protection",children:"Vercel Password Protection"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453(e,n,s){s.d(n,{R:()=>a,x:()=>r});var i=s(6540);const t={},o=i.createContext(t);function a(e){const n=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[1831],{5159(e,n,s){s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"authentication","title":"Authentication","description":"- Basic Auth","source":"@site/docs/authentication.md","sourceDirName":".","slug":"/authentication","permalink":"/docs/authentication","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/authentication.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Status Indicators","permalink":"/docs/status-indicators"},"next":{"title":"Keyboard Shortcuts","permalink":"/docs/searching"}}');var t=s(4848),o=s(8453);const a={},r="Authentication",l={},c=[{value:"Built-In Auth",id:"built-in-auth",level:2},{value:"Setting Up Authentication",id:"setting-up-authentication",level:3},{value:"Hash Password",id:"hash-password",level:3},{value:"Logging In and Out",id:"logging-in-and-out",level:3},{value:"Enabling Guest Access",id:"enabling-guest-access",level:3},{value:"Granular Access",id:"granular-access",level:3},{value:"Permissions",id:"permissions",level:3},{value:"Using Environment Variables for Passwords",id:"using-environment-variables-for-passwords",level:3},{value:"Adding HTTP Auth to Configuration",id:"adding-http-auth-to-configuration",level:3},{value:"Security",id:"security",level:3},{value:"HTTP Auth",id:"http-auth",level:2},{value:"Keycloak",id:"keycloak",level:2},{value:"1. Deploy Keycloak",id:"1-deploy-keycloak",level:3},{value:"2. Setup Keycloak Users",id:"2-setup-keycloak-users",level:3},{value:"3. Enable Keycloak in Dashy Config File",id:"3-enable-keycloak-in-dashy-config-file",level:3},{value:"4. Add groups and roles (Optional)",id:"4-add-groups-and-roles-optional",level:3},{value:"Troubleshooting Keycloak",id:"troubleshooting-keycloak",level:3},{value:"OIDC",id:"oidc",level:2},{value:"authentik",id:"authentik",level:3},{value:"1. Create an OIDC provider",id:"1-create-an-oidc-provider",level:4},{value:"2. Create an application",id:"2-create-an-application",level:4},{value:"3. (Optional) Limiting access via authentik with groups",id:"3-optional-limiting-access-via-authentik-with-groups",level:4},{value:"4. Configure Dashy to use OIDC client",id:"4-configure-dashy-to-use-oidc-client",level:4},{value:"5. (OPTIONAL) Example snippets for dashboard visibility",id:"5-optional-example-snippets-for-dashboard-visibility",level:4},{value:"Alternative Authentication Methods",id:"alternative-authentication-methods",level:2},{value:"Authentication Server",id:"authentication-server",level:3},{value:"Authelia",id:"authelia",level:4},{value:"VPN",id:"vpn",level:3},{value:"IP-Based Access",id:"ip-based-access",level:3},{value:"Apache",id:"apache",level:4},{value:"NGINX",id:"nginx",level:4},{value:"Caddy",id:"caddy",level:4},{value:"Web Server Authentication",id:"web-server-authentication",level:3},{value:"Apache",id:"apache-1",level:4},{value:"NGINX",id:"nginx-1",level:4},{value:"Caddy",id:"caddy-1",level:4},{value:"Lighttpd",id:"lighttpd",level:4},{value:"OAuth Services",id:"oauth-services",level:3},{value:"Static Site Hosting Providers",id:"static-site-hosting-providers",level:3}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"authentication",children:"Authentication"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#built-in-auth",children:"Basic Auth"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#setting-up-authentication",children:"Setting Up Authentication"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#hash-password",children:"Hash Password"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#logging-in-and-out",children:"Logging In and Out"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#enabling-guest-access",children:"Guest Access"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#granular-access",children:"Per-User Access"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#using-environment-variables-for-passwords",children:"Using Environment Variables for Passwords"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#adding-http-auth-to-configuration",children:"Adding HTTP Auth to Configuration"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#security",children:"Security Considerations"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#http-auth",children:"HTTP Auth"})}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#keycloak",children:"Keycloak Auth"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#1-deploy-keycloak",children:"Deploying Keycloak"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#2-setup-keycloak-users",children:"Setting up Keycloak"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#3-enable-keycloak-in-dashy-config-file",children:"Configuring Dashy for Keycloak"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#troubleshooting-keycloak",children:"Troubleshooting Keycloak"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#oidc",children:"OIDC Auth"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#authentik",children:"authentik"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#alternative-authentication-methods",children:"Alternative Authentication Methods"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#vpn",children:"VPN"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#ip-based-access",children:"IP-Based Access"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#web-server-authentication",children:"Web Server Authentication"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#oauth-services",children:"OAuth Services"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#static-site-hosting-providers",children:"Auth on Cloud Hosting Services"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsx)(n.p,{children:"[!IMPORTANT]\nDashy's built-in auth is not intended to protect a publicly hosted instance against unauthorized access. Instead you should use an auth provider compatible with your reverse proxy, or access Dashy via your VPN, or implement your own SSO logic."}),"\n",(0,t.jsx)(n.p,{children:"In cases where Dashy is only accessibly within your home network, and you just want to add a login page, then the built-in auth may be sufficient, but keep in mind that configuration can still be accessed."}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"built-in-auth",children:"Built-In Auth"}),"\n",(0,t.jsxs)(n.p,{children:["Dashy has a basic login page included, and frontend authentication. You can enable this by adding users to the ",(0,t.jsx)(n.code,{children:"auth"})," section under ",(0,t.jsx)(n.code,{children:"appConfig"})," in your ",(0,t.jsx)(n.code,{children:"conf.yml"}),". If this section is not specified, then no authentication will be required to access the app, and the homepage will resolve to your dashboard."]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!NOTE]\nSince the auth is initiated in the main app entry point (for security), a rebuild is required to apply changes to the auth configuration.\nYou can trigger a rebuild through the UI, under Config --\x3e Rebuild, or by running ",(0,t.jsx)(n.code,{children:"yarn build"})," in the root directory."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"setting-up-authentication",children:"Setting Up Authentication"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"auth"})," property takes an array of users. Each user needs to include a username, hash and optional user type (",(0,t.jsx)(n.code,{children:"admin"})," or ",(0,t.jsx)(n.code,{children:"normal"}),"). The hash property is a ",(0,t.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/SHA-2",children:"SHA-256 Hash"})," of your desired password."]}),"\n",(0,t.jsx)(n.p,{children:"For example:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n auth:\n users:\n - user: alicia\n hash: 4D1E58C90B3B94BCAD9848ECCACD6D2A8C9FBC5CA913304BBA5CDEAB36FEEFA3\n type: admin\n - user: bob\n hash: 5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\n"})}),"\n",(0,t.jsx)(n.h3,{id:"hash-password",children:"Hash Password"}),"\n",(0,t.jsxs)(n.p,{children:["Dashy uses ",(0,t.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Sha-256",children:"SHA-256 Hash"}),", a 64-character string, which you can generate using an online tool, such as ",(0,t.jsx)(n.a,{href:"https://passwordsgenerator.net/sha256-hash-generator/",children:"this one"})," or ",(0,t.jsx)(n.a,{href:"https://gchq.github.io/CyberChef/",children:"CyberChef"})," (which can be self-hosted/ ran locally)."]}),"\n",(0,t.jsx)(n.p,{children:"A hash is a one-way cryptographic function, meaning that it is easy to generate a hash for a given password, but very hard to determine the original password for a given hash. This means, that so long as your password is long, strong and unique, it is safe to store its hash in the clear. Having said that, you should never reuse passwords, hashes can be cracked by iterating over known password lists, generating a hash of each."}),"\n",(0,t.jsx)(n.h3,{id:"logging-in-and-out",children:"Logging In and Out"}),"\n",(0,t.jsx)(n.p,{children:"Once authentication is enabled, so long as there is no valid token in cookie storage, the application will redirect the user to the login page. When the user enters credentials in the login page, they will be checked, and if valid, then a token will be generated, and they can be redirected to the home page. If credentials are invalid, then an error message will be shown, and they will remain on the login page. Once in the application, to log out: the user can click the logout button (in the top-right), which will clear cookie storage, causing them to be redirected back to the login page."}),"\n",(0,t.jsx)(n.h3,{id:"enabling-guest-access",children:"Enabling Guest Access"}),"\n",(0,t.jsxs)(n.p,{children:["With authentication set up, by default no access is allowed to your dashboard without first logging in with valid credentials. Guest mode can be enabled to allow for read-only access to a secured dashboard by any user, without the need to log in. A guest user cannot write any changes to the config file, but can apply modifications locally (stored in their browser). You can enable guest access, by setting ",(0,t.jsx)(n.code,{children:"appConfig.auth.enableGuestAccess: true"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"granular-access",children:"Granular Access"}),"\n",(0,t.jsx)(n.p,{children:"You can use the following properties to make certain pages, sections or items only visible to some users, or hide pages, sections and items from guests."}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"hideForUsers"})," - Page, Section or Item will be visible to all users, except for those specified in this list"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"showForUsers"})," - Page, Section or Item will be hidden from all users, except for those specified in this list"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"hideForGuests"})," - Page, Section or Item will be visible for logged in users, but not for guests"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"For Example:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"pages:\n - name: Home Lab\n path: home-lab.yml\n displayData:\n showForUsers: [admin]\n - name: Intranet\n path: intranet.yml\n displayData:\n hideForGuests: true\n hideForUsers: [alicia, bob]\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"- name: Code Analysis & Monitoring\n icon: fas fa-code\n displayData:\n cols: 2\n hideForUsers: [alicia, bob]\n items:\n ...\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"- name: Deployment Pipelines\n icon: fas fa-rocket\n displayData:\n hideForGuests: true\n items:\n - title: Hide Me\n displayData:\n hideForUsers: [alicia, bob]\n"})}),"\n",(0,t.jsx)(n.h3,{id:"permissions",children:"Permissions"}),"\n",(0,t.jsxs)(n.p,{children:["Any user who is not an admin (with ",(0,t.jsx)(n.code,{children:"type: admin"}),") will not be able to write changes to disk."]}),"\n",(0,t.jsxs)(n.p,{children:["You can also prevent any user from writing changes to disk, using ",(0,t.jsx)(n.code,{children:"preventWriteToDisk"}),". Or prevent any changes from being saved locally in browser storage, using ",(0,t.jsx)(n.code,{children:"preventLocalSave"}),". Both properties can be found under ",(0,t.jsx)(n.a,{href:"/docs/configuring#appconfig-optional",children:(0,t.jsx)(n.code,{children:"appConfig"})}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["To disable all UI config features, including View Config, set ",(0,t.jsx)(n.code,{children:"disableConfiguration"}),". Alternatively you can disable UI config features for all non admin users by setting ",(0,t.jsx)(n.code,{children:"disableConfigurationForNonAdmin"})," to true."]}),"\n",(0,t.jsx)(n.h3,{id:"using-environment-variables-for-passwords",children:"Using Environment Variables for Passwords"}),"\n",(0,t.jsxs)(n.p,{children:["If you don't want to hash your password, you can instead leave out the ",(0,t.jsx)(n.code,{children:"hash"})," attribute, and replace it with ",(0,t.jsx)(n.code,{children:"password"})," which should have the value of an environmental variable name you wish to use."]}),"\n",(0,t.jsxs)(n.p,{children:["Note that env var must begin with ",(0,t.jsx)(n.code,{children:"VUE_APP_"}),", and you must set this variable before building the app."]}),"\n",(0,t.jsx)(n.p,{children:"For example:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:" auth:\n users:\n - user: bob\n password: VUE_APP_BOB\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Just be sure to set ",(0,t.jsx)(n.code,{children:"VUE_APP_BOB='my super secret password'"})," before build-time."]}),"\n",(0,t.jsx)(n.h3,{id:"adding-http-auth-to-configuration",children:"Adding HTTP Auth to Configuration"}),"\n",(0,t.jsxs)(n.p,{children:["If you'd also like to prevent direct visit access to your configuration file, you can set the ",(0,t.jsx)(n.code,{children:"ENABLE_HTTP_AUTH"})," environmental variable."]}),"\n",(0,t.jsx)(n.h3,{id:"security",children:"Security"}),"\n",(0,t.jsx)(n.p,{children:"With basic auth, all logic is happening on the client-side, which could mean a skilled user could manipulate the code to view parts of your configuration, including the hash. If the SHA-256 hash is of a common password, it may be possible to determine it, using a lookup table, in order to find the original password. Which can be used to manually generate the auth token, that can then be inserted into session storage, to become a valid logged in user. Therefore, you should always use a long, strong and unique password, and if you instance contains security-critical info and/ or is exposed directly to the internet, and alternative authentication method may be better. The purpose of the login page is merely to prevent immediate unauthorized access to your homepage."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"http-auth",children:"HTTP Auth"}),"\n",(0,t.jsxs)(n.p,{children:["If you'd like to protect all your config files from direct access, you can set the ",(0,t.jsx)(n.code,{children:"BASIC_AUTH_USERNAME"})," and ",(0,t.jsx)(n.code,{children:"BASIC_AUTH_PASSWORD"})," environmental variables. You'll then be prompted to enter these credentials when visiting Dashy."]}),"\n",(0,t.jsxs)(n.p,{children:["Then, if you'd like your frontend to automatically log you in, without prompting you for credentials (insecure, so only use on a trusted environment), then also specify ",(0,t.jsx)(n.code,{children:"VUE_APP_BASIC_AUTH_USERNAME"})," and ",(0,t.jsx)(n.code,{children:"VUE_APP_BASIC_AUTH_PASSWORD"}),". This is useful for when you're hosting Dashy on a private server, and just want to use auth for user management and to prevent direct access to your config files, while still allowing the frontend to access them. Note that a rebuild is required for these changes to take effect."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"keycloak",children:"Keycloak"}),"\n",(0,t.jsxs)(n.p,{children:["Dashy also supports using a ",(0,t.jsx)(n.a,{href:"https://www.keycloak.org/",children:"Keycloak"})," authentication server. The setup for this is a bit more involved, but it gives you greater security overall, useful for if your instance is exposed to the internet."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"https://www.keycloak.org/about.html",children:"Keycloak"})," is a Java-based ",(0,t.jsx)(n.a,{href:"https://github.com/keycloak/keycloak",children:"open source"}),", high-performance, secure authentication system, supported by ",(0,t.jsx)(n.a,{href:"https://www.redhat.com/en",children:"RedHat"}),". It is easy to setup (",(0,t.jsx)(n.a,{href:"https://quay.io/repository/keycloak/keycloak",children:"with Docker"}),"), and enables you to secure multiple self-hosted applications with single-sign-on using standard protocols (OpenID Connect, OAuth 2.0, SAML 2.0 and social login). It's also very customizable, you can write or use custom ",(0,t.jsx)(n.a,{href:"https://wjw465150.gitbooks.io/keycloak-documentation/content/server_development/topics/themes.html",children:"themes"}),", ",(0,t.jsx)(n.a,{href:"https://www.keycloak.org/extensions.html",children:"plugins"}),", ",(0,t.jsx)(n.a,{href:"https://wjw465150.gitbooks.io/keycloak-documentation/content/server_admin/topics/authentication/password-policies.html",children:"password policies"})," and more.\nThe following guide will walk you through setting up Keycloak with Dashy. If you already have a Keycloak instance configured, then skip to Step 3."]}),"\n",(0,t.jsx)(n.h3,{id:"1-deploy-keycloak",children:"1. Deploy Keycloak"}),"\n",(0,t.jsxs)(n.p,{children:["First thing to do is to spin up a new instance of Keycloak. You will need ",(0,t.jsx)(n.a,{href:"https://docs.docker.com/engine/install/",children:"Docker installed"}),", and can then choose a tag, and pull the container from ",(0,t.jsx)(n.a,{href:"https://quay.io/repository/keycloak/keycloak",children:"quay.io/keycloak/keycloak"})]}),"\n",(0,t.jsx)(n.p,{children:"Use the following run command, replacing the attributes (default credentials, port and name), or incorporate this into your docker-compose file."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"docker run -d \\\n -p 8081:8080 \\\n --name auth-server \\\n -e KEYCLOAK_USER=admin \\\n -e KEYCLOAK_PASSWORD=admin \\\n quay.io/keycloak/keycloak:15.0.2\n"})}),"\n",(0,t.jsxs)(n.p,{children:["If you need to pull from DockerHub, a non-official image is available ",(0,t.jsx)(n.a,{href:"https://registry.hub.docker.com/r/jboss/keycloak",children:"here"}),". Or if you would prefer not to use Docker, you can also directly install Keycloak from source, following ",(0,t.jsx)(n.a,{href:"https://www.keycloak.org/docs/latest/getting_started/index.html",children:"this guide"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["You should now be able to access the Keycloak web interface, using the port specified above (e.g. ",(0,t.jsx)(n.code,{children:"http://127.0.0.1:8081"}),"), login with the default credentials, and when prompted create a new password."]}),"\n",(0,t.jsx)(n.h3,{id:"2-setup-keycloak-users",children:"2. Setup Keycloak Users"}),"\n",(0,t.jsx)(n.p,{children:"Before we can use Keycloak, we must first set it up with some users. Keycloak uses Realms (similar to tenants) to create isolated groups of users. You must create a Realm before you will be able to add your first user."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Head over to the admin console"}),"\n",(0,t.jsx)(n.li,{children:"In the top-left corner there is a dropdown called 'Master', hover over it and then click 'Add Realm'"}),"\n",(0,t.jsx)(n.li,{children:"Give your realm a name, and hit 'Create'"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"You can now create your first user."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"In the left-hand menu, click 'Users', then 'Add User'"}),"\n",(0,t.jsx)(n.li,{children:"Fill in the form, including username and hit 'Save'"}),"\n",(0,t.jsx)(n.li,{children:"Under the 'Credentials' tab, give the new user an initial password. They will be prompted to change this after first login"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The last thing we need to do in the Keycloak admin console is to create a new client"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Within your new realm, navigate to 'Clients' on the left-hand side, then click 'Create' in the top-right"}),"\n",(0,t.jsx)(n.li,{children:"Choose a 'Client ID', set 'Client Protocol' to 'openid-connect', and for 'Valid Redirect URIs' put a URL pattern to where you're hosting Dashy (if you're just testing locally, then * is fine), and do the same for the 'Web Origins' field"}),"\n",(0,t.jsx)(n.li,{children:"Make note of your client-id, and click 'Save'"}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"3-enable-keycloak-in-dashy-config-file",children:"3. Enable Keycloak in Dashy Config File"}),"\n",(0,t.jsxs)(n.p,{children:["Now that your Keycloak instance is up and running, all that's left to do is to configure Dashy to use it. Under ",(0,t.jsx)(n.code,{children:"appConfig"}),", set ",(0,t.jsx)(n.code,{children:"auth.enableKeycloak: true"}),", then fill in the details in ",(0,t.jsx)(n.code,{children:"auth.keycloak"}),", including: ",(0,t.jsx)(n.code,{children:"serverUrl"})," - the URL where your Keycloak instance is hosted, ",(0,t.jsx)(n.code,{children:"realm"})," - the name you gave your Realm, and ",(0,t.jsx)(n.code,{children:"clientId"})," - the Client ID you chose.\nFor example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n ...\n auth:\n enableKeycloak: true\n keycloak:\n serverUrl: 'http://localhost:8081'\n realm: 'alicia-homelab'\n clientId: 'dashy'\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Note that if you are using Keycloak V 17 or older, you will also need to set ",(0,t.jsx)(n.code,{children:"legacySupport: true"})," (also under ",(0,t.jsx)(n.code,{children:"appConfig.auth.keycloak"}),"). This is because the API endpoint was updated in later versions."]}),"\n",(0,t.jsxs)(n.p,{children:["If you use Keycloak with an external Identity Provier, you can set the ",(0,t.jsx)(n.code,{children:"idpHint: 'alias-of-kc-idp'"})," option to allow the IdP Hint to be passed to Keycloak. This will cause Keycloak to skip its login page and redirect the user directly to the specified IdP's login page. Set to the value of the 'Alias' field of the desired IdP as defined in Keycloak under 'Identity Providers'."]}),"\n",(0,t.jsx)(n.h3,{id:"4-add-groups-and-roles-optional",children:"4. Add groups and roles (Optional)"}),"\n",(0,t.jsxs)(n.p,{children:["Keycloak allows you to assign users roles and groups. You can use these values to configure who can access various sections or items in Dashy.\nKeycloak server administration and configuration is a deep topic; please refer to the ",(0,t.jsx)(n.a,{href:"https://www.keycloak.org/docs/latest/server_admin/index.html#assigning-permissions-and-access-using-roles-and-groups",children:"server admin guide"})," to see details about creating and assigning roles and groups.\nOnce you have groups or roles assigned to users you can configure access under each section or item ",(0,t.jsx)(n.code,{children:"displayData.showForKeycloakUser"})," and ",(0,t.jsx)(n.code,{children:"displayData.hideForKeycloakUser"}),".\nBoth show and hide configurations accept a list of ",(0,t.jsx)(n.code,{children:"groups"})," and ",(0,t.jsx)(n.code,{children:"roles"})," that limit access. If a users data matches one or more items in these lists they will be allowed or excluded as defined."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"sections:\n - name: DeveloperResources\n displayData:\n showForKeycloakUsers:\n roles: ['canViewDevResources']\n hideForKeycloakUsers:\n groups: ['ProductTeam']\n items:\n - title: Not Visible for developers\n displayData:\n hideForKeycloakUsers:\n groups: ['DevelopmentTeam']\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Depending on how you're hosting Dashy and Keycloak, you may also need to set some HTTP headers, to prevent a CORS error. This would typically be the ",(0,t.jsx)(n.code,{children:"Access-Control-Allow-Origin [URL-of Dashy]"})," on your Keycloak instance. See the ",(0,t.jsx)(n.a,{href:"/docs/management#setting-headers",children:"Setting Headers"})," guide in the management docs for more info."]}),"\n",(0,t.jsx)(n.p,{children:"Your app is now secured :) When you load Dashy, it will redirect to your Keycloak login page, and any user without valid credentials will be prevented from accessing your dashboard."}),"\n",(0,t.jsxs)(n.p,{children:["From within the Keycloak console, you can then configure things like time-outs, password policies, etc. You can also backup your full Keycloak config, and it is recommended to do this, along with your Dashy config. You can spin up both Dashy and Keycloak simultaneously and restore both applications configs using a ",(0,t.jsx)(n.code,{children:"docker-compose.yml"})," file, and this is recommended."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"troubleshooting-keycloak",children:"Troubleshooting Keycloak"}),"\n",(0,t.jsx)(n.p,{children:"If you encounter issues with your Keycloak setup, follow these steps to troubleshoot and resolve common problems."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:'Client Authentication Issue\nProblem: Redirect loop, if client authentication is enabled.\nSolution: Switch off "client authentication" in "TC clients" -> "Advanced" settings.'}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:['Double URL\nProblem: If you get redirected to "',(0,t.jsx)(n.a,{href:"https://dashy.my.domain/#iss=https://keycloak.my.domain/realms/my-realm",children:"https://dashy.my.domain/#iss=https://keycloak.my.domain/realms/my-realm"}),'"\nSolution: Make sure to turn on "Exclude Issuer From Authentication Response" in "TC clients" -> "Advanced" -> "OpenID Connect Compatibility Modes"']}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:['Problems with mutiple Dashy Pages\nProblem: Refreshing or logging out of dashy results in an "invalid_redirect_uri" error.\nSolution: In "TC clients" -> "Access settings" -> "Root URL" ',(0,t.jsx)(n.a,{href:"https://dashy.my.domain/",children:"https://dashy.my.domain/"}),", valid redirect URIs must be /*"]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"oidc",children:"OIDC"}),"\n",(0,t.jsxs)(n.p,{children:["Dashy also supports using a general ",(0,t.jsx)(n.a,{href:"https://openid.net/connect/",children:"OIDC compatible"})," authentication server. In order to use it, the authentication section needs to be configured:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"appConfig:\n auth:\n enableOidc: true\n oidc:\n clientId: [registered client id]\n endpoint: [OIDC endpoint]\n scope: [The scope(s) to request from the OIDC provider]\n adminGroup: admin\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Because Dashy is a SPA, a ",(0,t.jsx)(n.a,{href:"https://datatracker.ietf.org/doc/html/rfc6749#section-2.1",children:"public client"})," registration with PKCE is needed."]}),"\n",(0,t.jsx)(n.p,{children:"An example for Authelia is shared below, but other OIDC systems can be used:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:"identity_providers:\n oidc:\n clients:\n - client_id: dashy\n client_name: dashy\n public: true\n authorization_policy: 'one_factor'\n require_pkce: true\n pkce_challenge_method: 'S256'\n redirect_uris:\n - https://dashy.local # should point to your dashy endpoint\n grant_types:\n - authorization_code\n scopes:\n - 'openid'\n - 'profile'\n - 'roles'\n - 'email'\n - 'groups'\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Groups and roles will be populated and available for controlling display similar to ",(0,t.jsx)(n.a,{href:"#keycloak",children:"Keycloak"})," above."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"authentik",children:"authentik"}),"\n",(0,t.jsxs)(n.p,{children:["This documentation is specific to ",(0,t.jsx)(n.code,{children:"authentik"}),", however it may be useful in getting other idP's working with ",(0,t.jsx)(n.code,{children:"Dashy"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"This guide will only walk through the following:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Creating and configuring an OIDC provider"}),"\n",(0,t.jsx)(n.li,{children:"Creating and configuring an application"}),"\n",(0,t.jsx)(n.li,{children:"Assigning groups"}),"\n",(0,t.jsxs)(n.li,{children:["Configuring ",(0,t.jsx)(n.code,{children:"Dashy"})," to use the OIDC client"]}),"\n",(0,t.jsxs)(n.li,{children:["Show quick examples of how to hide/show ",(0,t.jsx)(n.code,{children:"pages"}),", ",(0,t.jsx)(n.code,{children:"items"}),", and ",(0,t.jsx)(n.code,{children:"sections"})," using OIDC groups"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"This guide assumes the following:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["You have a working instance of ",(0,t.jsx)(n.code,{children:"authentik"})," terminated with SSL"]}),"\n",(0,t.jsxs)(n.li,{children:["You have a working instance of ",(0,t.jsx)(n.code,{children:"Dashy"})," terminated with SSL"]}),"\n",(0,t.jsx)(n.li,{children:"Users and groups are provisioned"}),"\n",(0,t.jsxs)(n.li,{children:["You are familiar with how ",(0,t.jsx)(n.code,{children:"authentik"})," works in case you need to do further troubleshooting that is outside the scope of this guide."]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!TIP]\nIt it recommended that you create groups specific for ",(0,t.jsx)(n.code,{children:"Dashy"}),". Groups will allow you to display content based on group membership as well as limiting user access to ",(0,t.jsx)(n.code,{children:"Dashy"}),". If you do not need this functionality, then you can forgo creating specific groups."]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsx)(n.p,{children:"[!TIP]\nYou can use the application wizard to create the provider and application at one time. This is the recommended route, but only the manual process will be outlined in this guide."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/72e45162-6c86-4d6f-a1ae-724ac503c00c",alt:"image"})}),"\n",(0,t.jsx)(n.h4,{id:"1-create-an-oidc-provider",children:"1. Create an OIDC provider"}),"\n",(0,t.jsxs)(n.p,{children:["Login to the admin console for ",(0,t.jsx)(n.code,{children:"authentik"}),". Go to ",(0,t.jsx)(n.code,{children:"Applications"})," > ",(0,t.jsx)(n.code,{children:"Providers"}),". Click ",(0,t.jsx)(n.code,{children:"Create"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/c1f7f45d-469c-4bf1-a825-34658341a83e",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["A dialog box will pop-up, select the ",(0,t.jsx)(n.code,{children:"OAuth2/OpenID Provider"}),". Click ",(0,t.jsx)(n.code,{children:"Next"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/ea84fe57-b813-404d-8dad-5e221b440bdb",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["On the next page of the wizard, set the ",(0,t.jsx)(n.code,{children:"Name"}),", ",(0,t.jsx)(n.code,{children:"Authentication flow"}),", and ",(0,t.jsx)(n.code,{children:"Authorization flow"}),". See example below. Using the ",(0,t.jsx)(n.code,{children:"default-provider-authorization-implicit-consent"})," authorization flow on internal services and ",(0,t.jsx)(n.code,{children:"default-provider-authorization-explicit-consent"})," on external services is a common practice. However, it is fully up to you on how you would like to configure this option. ",(0,t.jsx)(n.code,{children:"Implicit"})," will login directly without user consent, ",(0,t.jsx)(n.code,{children:"explicit"})," will ask if the user approves the service being logged into with their user credentials."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/e600aeaf-08d1-49aa-b304-11e90e5c89cd",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Scroll down and configure the ",(0,t.jsx)(n.code,{children:"Protocol settings"}),". Set the ",(0,t.jsx)(n.code,{children:"Client type"})," to ",(0,t.jsx)(n.code,{children:"Public"}),". Add the ",(0,t.jsx)(n.code,{children:"Redirect URIs/Origins (RegEx)"}),". If the site is hosted at ",(0,t.jsx)(n.code,{children:"dashy.lan.domain.com"}),", then you would enter as the example below."]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!NOTE]\nIf you have an internal and external domain for ",(0,t.jsx)(n.code,{children:"Dashy"}),", enter both URI's. Enter each URI on a new line."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/4a289d7e-d7b4-4ff6-af5d-3e5202fae84e",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Scroll down to set the ",(0,t.jsx)(n.code,{children:"Signing Key"}),". It is recommended to use the built in ",(0,t.jsx)(n.code,{children:"authentik Self-signed Certificate"})," here unless you have special needs for your own custom cert."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/386c0750-9d2b-4482-8938-8b301b489b38",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Expand ",(0,t.jsx)(n.code,{children:"Advanced protocol settings"})," then verify the ",(0,t.jsx)(n.code,{children:"Scopes"})," are set to what is highlighted in ",(0,t.jsx)(n.code,{children:"white"})," below. Set the ",(0,t.jsx)(n.code,{children:"Subject mode"})," to ",(0,t.jsx)(n.code,{children:"Based on the Users's Email"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/ae5e87b8-1ad6-41dd-b6e1-9665623f842a",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Lastly, toggle ",(0,t.jsx)(n.code,{children:"Include claims in id_token"})," to on. Click ",(0,t.jsx)(n.code,{children:"Finish"})," to complete creating the provider."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/25353b3c-3f54-47cf-bd47-b5023f86d7cf",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Grab the generated ",(0,t.jsx)(n.code,{children:"Client ID"})," and ",(0,t.jsx)(n.code,{children:"OpenID Configuration Issuer"})," URL by clicking the newly created provider as this will use this later when ",(0,t.jsx)(n.code,{children:"Dashy"})," is configured to use the OIDC auth mechanism. In this tutorial, what was generated is used below. Obviously adjust the ",(0,t.jsx)(n.code,{children:"Client ID"})," that was generated and use your domain here for the ",(0,t.jsx)(n.code,{children:"issuer"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Client ID: pzN9DCMLqHTTatgtYFg50cl0jn1NmCyBC3wreX15\nOpenID Configuration Issuer: https://auth.domain.com/application/o/dashy/\n"})}),"\n",(0,t.jsx)(n.h4,{id:"2-create-an-application",children:"2. Create an application"}),"\n",(0,t.jsxs)(n.p,{children:["Make sure you are still in the ",(0,t.jsx)(n.code,{children:"authentik"})," admin console then go to ",(0,t.jsx)(n.code,{children:"Applications"})," > ",(0,t.jsx)(n.code,{children:"Applications"}),". Click ",(0,t.jsx)(n.code,{children:"Create"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/fd225936-15a1-409f-83c8-e24a43047df0",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Next, it is required to give a user facing ",(0,t.jsx)(n.code,{children:"Name"}),", ",(0,t.jsx)(n.code,{children:"Slug"})," and assign the newly created provider. Use the example below if you have been following the guide. If you have used your own naming, then adjust accordingly. Click ",(0,t.jsx)(n.code,{children:"Create"})," once you are done."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/e6574d7d-6b22-4e7d-b388-45341b98746b",alt:"image"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!TIP]\nOpen the application in a new tab from the ",(0,t.jsx)(n.code,{children:"authentik"})," user portal and upload a custom icon. You can also enter a user facing ",(0,t.jsx)(n.code,{children:"Description"})," that the user would see."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/20561387-549f-49de-98e6-30330dcdc734",alt:"image"})}),"\n",(0,t.jsxs)(n.h4,{id:"3-optional-limiting-access-via-authentik-with-groups",children:["3. ",(0,t.jsx)(n.em,{children:"(Optional)"})," Limiting access via ",(0,t.jsx)(n.code,{children:"authentik"})," with groups"]}),"\n",(0,t.jsxs)(n.p,{children:["If you would like to deny ",(0,t.jsx)(n.code,{children:"Dashy"})," access from specific users who are not within ",(0,t.jsx)(n.code,{children:"authentik"})," based groups, you bind them to the application you just created now. ",(0,t.jsx)(n.code,{children:"authentik"})," will deny access to those who are not members of this group or groups. If you want to allow everyone access from your ",(0,t.jsx)(n.code,{children:"authentik"})," instance, skip this step."]}),"\n",(0,t.jsxs)(n.p,{children:["Make sure you are still in the ",(0,t.jsx)(n.code,{children:"authentik"})," admin console then go to ",(0,t.jsx)(n.code,{children:"Applications"})," > ",(0,t.jsx)(n.code,{children:"Applications"}),". Click the newly created ",(0,t.jsx)(n.code,{children:"Dashy"})," application."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/613fafe7-881f-4664-a903-945854ac65e2",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Click the ",(0,t.jsx)(n.code,{children:"Policy/Group/User Bindings"})," tab at the top, then click ",(0,t.jsx)(n.code,{children:"Bind existing policy"}),". This assumes you have already created the groups you want to use for ",(0,t.jsx)(n.code,{children:"Dashy"})," and populated users in those groups."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/10fca15b-e77d-4624-ae03-0ece3910904c",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:["Click ",(0,t.jsx)(n.code,{children:"Group"})," for the binding type. Under ",(0,t.jsx)(n.code,{children:"Group"})," select the appropriate group you would like to bind. Make sure ",(0,t.jsx)(n.code,{children:"Enabled"})," is toggeled on. Click ",(0,t.jsx)(n.code,{children:"Create"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/ebf680ab-696f-4c08-ae89-d73fe92b398f",alt:"image"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Dashy"})," will now be scoped only to users within the assigned groups you have bound the application to. Keep adding groups if you would like to adjust the dashboard visibilty based on group membership."]}),"\n",(0,t.jsxs)(n.h4,{id:"4-configure-dashy-to-use-oidc-client",children:["4. Configure ",(0,t.jsx)(n.code,{children:"Dashy"})," to use OIDC client"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!IMPORTANT]\nIt is highly recommended to edit your ",(0,t.jsx)(n.code,{children:"conf.yml"})," directly for this step."]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["[!CAUTION]\nDo not make the same mistake many have made here by including the fully qualified address for the ",(0,t.jsx)(n.code,{children:"OpenID Configuration URL"}),". ",(0,t.jsx)(n.code,{children:"Dashy"})," will append the ",(0,t.jsx)(n.code,{children:".well-known"})," configuration automatically. If the ",(0,t.jsx)(n.code,{children:".well-known"})," URI is included the app will get redirect loops and ",(0,t.jsx)(n.code,{children:"400"})," errors."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Enter the ",(0,t.jsx)(n.code,{children:"Client ID"})," in the ",(0,t.jsx)(n.code,{children:"clientId"})," field and ",(0,t.jsx)(n.code,{children:"OpenID Configuration Issuer"})," in the ",(0,t.jsx)(n.code,{children:"endpoint"})," field."]}),"\n",(0,t.jsxs)(n.p,{children:["Below is how to configure the ",(0,t.jsx)(n.code,{children:"auth"})," section in the yaml syntax. Once this is enabled, when an attempt to access ",(0,t.jsx)(n.code,{children:"Dashy"})," is made it will now redirect you to the ",(0,t.jsx)(n.code,{children:"authentik"})," login page moving forward."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"appConfig:\n theme: glass\n layout: auto\n iconSize: medium\n auth:\n enableOidc: true\n oidc:\n clientId: pzN9DCMLqHTTatgtYFg50cl0jn1NmCyBC3wreX15\n endpoint: https://auth.domain.com/application/o/dashy/\n"})}),"\n",(0,t.jsxs)(n.h4,{id:"5-optional-example-snippets-for-dashboard-visibility",children:["5. ",(0,t.jsx)(n.em,{children:"(OPTIONAL)"})," Example snippets for dashboard visibility"]}),"\n",(0,t.jsxs)(n.p,{children:["Using the ",(0,t.jsx)(n.code,{children:"hideForKeycloakUsers"})," configuration option is needed to use the ",(0,t.jsx)(n.code,{children:"authentik"})," groups that were created previously."]}),"\n",(0,t.jsxs)(n.p,{children:["Adjusting ",(0,t.jsx)(n.code,{children:"pages"})," visibility:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"pages:\n - name: App Management\n path: appmgmt.yml\n displayData:\n hideForKeycloakUsers:\n groups:\n - Dashy Users\n - name: Network Management\n path: network.yml\n displayData:\n hideForKeycloakUsers:\n groups:\n - Dashy Users\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Adjusting ",(0,t.jsx)(n.code,{children:"items"})," visibility:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:" items:\n - title: Authentik Admin\n icon: authentik.svg\n url: https://auth.domain.com/if/admin/\n target: newtab\n id: 0_1472_authentikadmin\n displayData:\n hideForKeycloakUsers:\n groups:\n - Dashy Users\n - title: Authentik User\n icon: authentik-light.png\n url: https://auth.domain.com/if/user/\n target: newtab\n id: 1_1472_authentikuser\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Adjusting ",(0,t.jsx)(n.code,{children:"sections"})," visibility:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"sections:\n - name: Authentication\n displayData:\n sortBy: default\n rows: 2\n cols: 1\n collapsed: false\n hideForGuests: false\n hideForKeycloakUsers:\n groups: \n - Dashy Users\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"alternative-authentication-methods",children:"Alternative Authentication Methods"}),"\n",(0,t.jsx)(n.p,{children:"If you are self-hosting Dashy, and require secure authentication to prevent unauthorized access, then you can either use Keycloak, or one of the following options:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#authentication-server",children:"Authentication Server"})," - Put Dashy behind a self-hosted auth server"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#vpn",children:"VPN"})," - Use a VPN to tunnel into the network where Dashy is running"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#ip-based-access",children:"IP-Based Access"})," - Disallow access from all IP addresses, except your own"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#web-server-authentication",children:"Web Server Authentication"})," - Enable user control within your web server or proxy"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#oauth-services",children:"OAuth Services"})," - Implement a user management system using a cloud provider"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#static-site-hosting-providers",children:"Password Protection (for cloud providers)"})," - Enable password-protection on your site"]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"authentication-server",children:"Authentication Server"}),"\n",(0,t.jsx)(n.h4,{id:"authelia",children:"Authelia"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"https://www.authelia.com/",children:"Authelia"})," is an open-source full-featured authentication server, which can be self-hosted and either on bare metal, in a Docker container or in a Kubernetes cluster. It allows for fine-grained access control rules based on IP, path, users etc, and supports 2FA, simple password access or bypass policies for your domains."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"git clone https://github.com/authelia/authelia.git"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"cd authelia/examples/compose/lite"})}),"\n",(0,t.jsxs)(n.li,{children:["Modify the ",(0,t.jsx)(n.code,{children:"users_database.yml"})," the default username and password is authelia"]}),"\n",(0,t.jsxs)(n.li,{children:["Modify the ",(0,t.jsx)(n.code,{children:"configuration.yml"})," and ",(0,t.jsx)(n.code,{children:"docker-compose.yml"})," with your respective domains and secrets"]}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"docker-compose up -d"})}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["For more information, see the ",(0,t.jsx)(n.a,{href:"https://www.authelia.com/docs/",children:"Authelia docs"})]}),"\n",(0,t.jsx)(n.h3,{id:"vpn",children:"VPN"}),"\n",(0,t.jsxs)(n.p,{children:["A catch-all solution to accessing services running from your home network remotely is to use a VPN. It means you do not need to worry about implementing complex authentication rules, or trusting the login implementation of individual applications. However it can be inconvenient to use on a day-to-day basis, and some public and corporate WiFi block VPN connections. Two popular VPN protocols are ",(0,t.jsx)(n.a,{href:"https://openvpn.net/",children:"OpenVPN"})," and ",(0,t.jsx)(n.a,{href:"https://www.wireguard.com/",children:"WireGuard"})]}),"\n",(0,t.jsx)(n.h3,{id:"ip-based-access",children:"IP-Based Access"}),"\n",(0,t.jsx)(n.p,{children:"If you have a static IP or use a VPN to access your running services, then you can use conditional access to block access to Dashy from everyone except users of your pre-defined IP address. This feature is offered by most cloud providers, and supported by most web servers."}),"\n",(0,t.jsx)(n.h4,{id:"apache",children:"Apache"}),"\n",(0,t.jsxs)(n.p,{children:["In Apache, this is configured in your ",(0,t.jsx)(n.code,{children:".htaccess"})," file in Dashy's root folder, and should look something like:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"Order Deny,Allow\nDeny from all\nAllow from [your-ip]\n"})}),"\n",(0,t.jsx)(n.h4,{id:"nginx",children:"NGINX"}),"\n",(0,t.jsxs)(n.p,{children:["In NGINX you can specify ",(0,t.jsx)(n.a,{href:"https://docs.nginx.com/nginx/admin-guide/security-controls/controlling-access-proxied-http/",children:"control access"})," rules for a given site in your ",(0,t.jsx)(n.code,{children:"nginx.conf"})," or hosts file. For example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"server {\n\tlisten 8080;\n\tserver_name www.dashy.example.com;\n\tlocation / {\n\t\troot /path/to/dashy/;\n\t\tpassenger_enabled on;\n\t\tallow [your-ip];\n\t\tdeny all;\n }\n }\n"})}),"\n",(0,t.jsx)(n.h4,{id:"caddy",children:"Caddy"}),"\n",(0,t.jsxs)(n.p,{children:["In Caddy, ",(0,t.jsx)(n.a,{href:"https://caddyserver.com/docs/caddyfile/matchers",children:"Request Matchers"})," can be used to filter requests"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:'dashy.site {\n\t@public_networks not remote_ip [your-ip]\n\trespond @public_networks "Access denied" 403\n}\n'})}),"\n",(0,t.jsx)(n.h3,{id:"web-server-authentication",children:"Web Server Authentication"}),"\n",(0,t.jsx)(n.p,{children:"Most web servers make password protecting certain apps very easy. Note that you should also set up HTTPS and have a valid certificate in order for this to be secure."}),"\n",(0,t.jsx)(n.h4,{id:"apache-1",children:"Apache"}),"\n",(0,t.jsxs)(n.p,{children:["First crate a ",(0,t.jsx)(n.code,{children:".htaccess"})," file in Dashy's route directory. Specify the auth type and path to where you want to store the password file (usually the same folder). For example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:'AuthType Basic\nAuthName "Please Sign into Dashy"\nAuthUserFile /path/dashy/.htpasswd\nrequire valid-user\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Then create a ",(0,t.jsx)(n.code,{children:".htpasswd"})," file in the same directory. List users and their hashed passwords here, with one user on each line, and a colon between username and password (e.g. ",(0,t.jsx)(n.code,{children:"[username]:[hashed-password]"}),"). You will need to generate an MD5 hash of your desired password, this can be done with an ",(0,t.jsx)(n.a,{href:"https://www.web2generators.com/apache-tools/htpasswd-generator",children:"online tool"}),". Your file will look something like:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"alicia:$apr1$jv0spemw$RzOX5/GgY69JMkgV6u16l0\n"})}),"\n",(0,t.jsx)(n.h4,{id:"nginx-1",children:"NGINX"}),"\n",(0,t.jsxs)(n.p,{children:["NGINX has an ",(0,t.jsx)(n.a,{href:"https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html",children:"authentication module"})," which can be used to add passwords to given sites, and is fairly simple to set up. Similar to above, you will need to create a ",(0,t.jsx)(n.code,{children:".htpasswd"})," file. Then just enable auth and specify the path to that file, for example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:'location / {\n auth_basic "closed site";\n auth_basic_user_file conf/htpasswd;\n}\n'})}),"\n",(0,t.jsx)(n.h4,{id:"caddy-1",children:"Caddy"}),"\n",(0,t.jsxs)(n.p,{children:["Caddy has a ",(0,t.jsx)(n.a,{href:"https://caddyserver.com/docs/caddyfile/directives/basicauth",children:"basic-auth"})," directive, where you specify a username and hash. The password hash needs to be base-64 encoded, the ",(0,t.jsx)(n.a,{href:"https://caddyserver.com/docs/command-line#caddy-hash-password",children:(0,t.jsx)(n.code,{children:"caddy hash-password"})})," command can help with this. For example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"basicauth /secret/* {\n\talicia JDJhJDEwJEVCNmdaNEg2Ti5iejRMYkF3MFZhZ3VtV3E1SzBWZEZ5Q3VWc0tzOEJwZE9TaFlZdEVkZDhX\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["For more info about implementing a single sign on for all your apps with Caddy, see ",(0,t.jsx)(n.a,{href:"https://joshstrange.com/securing-your-self-hosted-apps-with-single-signon/",children:"this tutorial"})]}),"\n",(0,t.jsx)(n.h4,{id:"lighttpd",children:"Lighttpd"}),"\n",(0,t.jsxs)(n.p,{children:["You can use the ",(0,t.jsx)(n.a,{href:"https://doc.lighttpd.net/lighttpd2/mod_auth.html",children:"mod_auth"})," module to secure your site with Lighttpd. Like with Apache, you need to first create a password file listing your usernames and hashed passwords, but in Lighttpd, it's usually called ",(0,t.jsx)(n.code,{children:".lighttpdpassword"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Then in your ",(0,t.jsx)(n.code,{children:"lighttpd.conf"})," file (usually in the ",(0,t.jsx)(n.code,{children:"/etc/lighttpd/"})," directory), load in the mod_auth module, and configure it's directives. For example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:'server.modules += ( "mod_auth" )\nauth.debug = 2\nauth.backend = "plain"\nauth.backend.plain.userfile = "/home/lighttpd/.lighttpdpassword"\n\n$HTTP["host"] == "dashy.my-domain.net" {\n server.document-root = "/home/lighttpd/dashy.my-domain.net/http"\n server.errorlog = "/var/log/lighttpd/dashy.my-domain.net/error.log"\n accesslog.filename = "/var/log/lighttpd/dashy.my-domain.net/access.log"\n auth.require = (\n "/docs/" => (\n "method" => "basic",\n "realm" => "Password protected area",\n "require" => "user=alicia"\n )\n )\n}\n'})}),"\n",(0,t.jsx)(n.p,{children:"Restart your web server for changes to take effect."}),"\n",(0,t.jsx)(n.h3,{id:"oauth-services",children:"OAuth Services"}),"\n",(0,t.jsxs)(n.p,{children:["There are also authentication services, such as ",(0,t.jsx)(n.a,{href:"https://www.ory.sh/",children:"Ory.sh"}),", ",(0,t.jsx)(n.a,{href:"https://developer.okta.com/",children:"Okta"}),", ",(0,t.jsx)(n.a,{href:"https://auth0.com/",children:"Auth0"}),", ",(0,t.jsx)(n.a,{href:"https://firebase.google.com/docs/auth/",children:"Firebase"}),". Implementing one of these solutions would involve some changes to the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/Auth.js",children:(0,t.jsx)(n.code,{children:"Auth.js"})})," file, but should be fairly straightforward."]}),"\n",(0,t.jsx)(n.h3,{id:"static-site-hosting-providers",children:"Static Site Hosting Providers"}),"\n",(0,t.jsxs)(n.p,{children:["If you are hosting Dashy on a cloud platform, you will probably find that it has built-in support for password protected access to web apps. For more info, see the relevant docs for your provider, for example: ",(0,t.jsx)(n.a,{href:"https://docs.netlify.com/visitor-access/password-protection/",children:"Netlify Password Protection"}),", ",(0,t.jsx)(n.a,{href:"https://www.cloudflare.com/teams/access/",children:"Cloudflare Access"}),", ",(0,t.jsx)(n.a,{href:"https://aws.amazon.com/cognito/",children:"AWS Cognito"}),", ",(0,t.jsx)(n.a,{href:"https://docs.microsoft.com/en-us/azure/app-service/scenario-secure-app-authentication-app-service",children:"Azure Authentication"})," and ",(0,t.jsx)(n.a,{href:"https://vercel.com/docs/platform/projects#password-protection",children:"Vercel Password Protection"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"#",children:"\u2b06\ufe0f Back to Top"})})})})})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453(e,n,s){s.d(n,{R:()=>a,x:()=>r});var i=s(6540);const t={},o=i.createContext(t);function a(e){const n=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/68d50eef.7b3d1efe.js b/assets/js/68d50eef.2370dbe0.js similarity index 99% rename from assets/js/68d50eef.7b3d1efe.js rename to assets/js/68d50eef.2370dbe0.js index fb43ec4d..7bb2dd1a 100644 --- a/assets/js/68d50eef.7b3d1efe.js +++ b/assets/js/68d50eef.2370dbe0.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[5992],{2745(e,n,i){i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"developing","title":"Developing","description":"This article outlines how to get Dashy running in a development environment, and outlines the basics of the architecture.","source":"@site/docs/developing.md","sourceDirName":".","slug":"/developing","permalink":"/docs/developing","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/developing.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Contributing","permalink":"/docs/contributing"},"next":{"title":"Development Guides","permalink":"/docs/development-guides"}}');var t=i(4848),o=i(8453);const r={},a="Developing",l={},d=[{value:"Setting up the Dev Environment",id:"setting-up-the-dev-environment",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Running the Project",id:"running-the-project",level:3},{value:"Project Commands",id:"project-commands",level:3},{value:"Basics",id:"basics",level:4},{value:"Development",id:"development",level:4},{value:"Utils and Checks",id:"utils-and-checks",level:4},{value:"Alternate Start Commands",id:"alternate-start-commands",level:4},{value:"Notes",id:"notes",level:4},{value:"Environmental Variables",id:"environmental-variables",level:3},{value:"Environment Modes",id:"environment-modes",level:3},{value:"Git Strategy",id:"git-strategy",level:2},{value:"Git Flow",id:"git-flow",level:3},{value:"Git Branch Naming",id:"git-branch-naming",level:3},{value:"Commit Emojis",id:"commit-emojis",level:3},{value:"PR Guidelines",id:"pr-guidelines",level:3},{value:"Resources for Beginners",id:"resources-for-beginners",level:2},{value:"App Info",id:"app-info",level:2},{value:"Style Guide",id:"style-guide",level:3},{value:"Application Structure",id:"application-structure",level:3},{value:"Files in the Root: ./",id:"files-in-the-root-",level:4},{value:"Frontend Source: ./src/",id:"frontend-source-src",level:4},{value:"Visualisation of Source Directory",id:"visualisation-of-source-directory",level:4},{value:"Development Tools",id:"development-tools",level:2},{value:"Performance - Lighthouse",id:"performance---lighthouse",level:3},{value:"Dependencies - BundlePhobia",id:"dependencies---bundlephobia",level:3},{value:"Notes",id:"notes-1",level:2},{value:"Known Warnings",id:"known-warnings",level:3}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"developing",children:"Developing"})}),"\n",(0,t.jsxs)(n.p,{children:["This article outlines how to get Dashy running in a development environment, and outlines the basics of the architecture.\nIf you're adding new features, you may want to check out the ",(0,t.jsx)(n.a,{href:"/docs/development-guides",children:"Development Guides"})," docs, for tutorials covering basic tasks."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#setting-up-the-dev-environment",children:"Setting up the Development Environment"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#prerequisites",children:"Prerequisites"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#running-the-project",children:"Running the App"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#project-commands",children:"Project Commands"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#environmental-variables",children:"Environmental Variables"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#git-strategy",children:"Git Strategy"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#git-flow",children:"Flow"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#git-branch-naming",children:"Branches"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#commit-emojis",children:"Commit emojis"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#pr-guidelines",children:"PR Guidelines"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#resources-for-beginners",children:"Resources for Beginners"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#app-info",children:"App Info"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#style-guide",children:"Code Style Guide"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#application-structure",children:"Application Structure"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#development-tools",children:"Development Tools"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#notes",children:"Misc / Notes"})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"setting-up-the-dev-environment",children:"Setting up the Dev Environment"}),"\n",(0,t.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,t.jsxs)(n.p,{children:["You will need either the latest or LTS version of ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"https://nodejs.org/",children:"Node.js"})})," to build and serve the application and ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"https://git-scm.com/downloads",children:"Git"})})," to easily fetch the code, and push any changes. If you plan on running or deploying the container, you'll also need ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"https://docs.docker.com/get-docker/",children:"Docker"})}),". To avoid any unexpected issues, ensure you've got at least ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"https://www.npmjs.com/get-npm",children:"NPM"})})," V 7.5 or ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"https://classic.yarnpkg.com/en/docs/install/#windows-stable",children:"Yarn"})})," 1.22 (you may find ",(0,t.jsx)(n.a,{href:"https://github.com/nvm-sh/nvm",children:"NVM"})," helpful for switching/ managing versions)."]}),"\n",(0,t.jsx)(n.h3,{id:"running-the-project",children:"Running the Project"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Get Code: ",(0,t.jsx)(n.code,{children:"git clone https://github.com/Lissy93/dashy.git"})]}),"\n",(0,t.jsxs)(n.li,{children:["Navigate into the directory: ",(0,t.jsx)(n.code,{children:"cd dashy"})]}),"\n",(0,t.jsxs)(n.li,{children:["Install dependencies: ",(0,t.jsx)(n.code,{children:"yarn"})]}),"\n",(0,t.jsxs)(n.li,{children:["Start dev server: ",(0,t.jsx)(n.code,{children:"yarn dev"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Dashy should now be being served on ",(0,t.jsx)(n.a,{href:"http://localhost:8080/",children:"http://localhost:8080/"}),". Hot reload is enabled, so making changes to any of the files will trigger them to be rebuilt and the page refreshed."]}),"\n",(0,t.jsx)(n.h3,{id:"project-commands",children:"Project Commands"}),"\n",(0,t.jsx)(n.h4,{id:"basics",children:"Basics"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn build"})})," - In the interest of speed, the application is pre-compiled, this means that the config file is read during build-time, and therefore the app needs to rebuilt for any new changes to take effect. Luckily this is very straight forward. Just run ",(0,t.jsx)(n.code,{children:"yarn build"})," or ",(0,t.jsx)(n.code,{children:"docker exec -it [container-id] yarn build"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn start"})})," - Starts a web server, and serves up the production site from ",(0,t.jsx)(n.code,{children:"./dist"})," (must run build command first)"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"development",children:"Development"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn dev"})})," - Starts the development server with hot reloading"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn lint"})})," - Lints code to ensure it follows a consistent, neat style"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn test"})})," - Runs tests, and outputs results"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"utils-and-checks",children:"Utils and Checks"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn validate-config"})})," - If you have quite a long configuration file, you may wish to check that it's all good to go, before deploying the app. This can be done with ",(0,t.jsx)(n.code,{children:"yarn validate-config"})," or ",(0,t.jsx)(n.code,{children:"docker exec -it [container-id] yarn validate-config"}),". Your config file needs to be in ",(0,t.jsx)(n.code,{children:"/user-data/conf.yml"})," (or within your Docker container at ",(0,t.jsx)(n.code,{children:"/app/user-data/conf.yml"}),"). This will first check that your YAML is valid, and then validates it against Dashy's ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json",children:"schema"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn health-check"})})," - Checks that the application is up and running on it's specified port, and outputs current status and response times. Useful for integrating into your monitoring service, if you need to maintain high system availability"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"alternate-start-commands",children:"Alternate Start Commands"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn build-and-start"})})," - Builds the app, runs checks and starts the production server. Commands are run in parallel, and so is faster than running them in independently. Uses the ",(0,t.jsx)(n.code,{children:"yarn build"})," and ",(0,t.jsx)(n.code,{children:"yarn start"})," commands"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn build-watch"})})," - If you find yourself making frequent changes to your configuration, and do not want to have to keep manually rebuilding, then this option is for you. It will watch for changes to any files within the projects root, and then trigger a rebuild. Note that if you are developing new features, then ",(0,t.jsx)(n.code,{children:"yarn dev"})," would be more appropriate, as it's significantly faster at recompiling (under 1 second), and has hot reloading, linting and testing integrated"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn pm2-start"})})," - Starts the Node server using ",(0,t.jsx)(n.a,{href:"https://pm2.keymetrics.io/",children:"PM2"}),", a process manager for Node.js applications, that helps them stay alive. PM2 has some built-in basic monitoring features, and an optional ",(0,t.jsx)(n.a,{href:"https://pm2.io/",children:"management solution"}),". If you are running the app on bare metal, it is recommended to use this start command"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"notes",children:"Notes"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["If you are using NPM, replace ",(0,t.jsx)(n.code,{children:"yarn"})," with ",(0,t.jsx)(n.code,{children:"npm run"})]}),"\n",(0,t.jsxs)(n.li,{children:["If you are using Docker, precede each command with ",(0,t.jsx)(n.code,{children:"docker exec -it [container-id]"}),". Container ID can be found by running ",(0,t.jsx)(n.code,{children:"docker ps"})]}),"\n",(0,t.jsxs)(n.li,{children:["You can manage the app using the ",(0,t.jsx)(n.a,{href:"https://cli.vuejs.org/guide/cli-service.html",children:"Vue-CLI Service"}),", with ",(0,t.jsx)(n.code,{children:"npx vue-cli-service [command]"}),". Or to start the Vue Management UI, run ",(0,t.jsx)(n.code,{children:"npx vue ui"}),", and open ",(0,t.jsx)(n.code,{children:"http://localhost:8000"})]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"environmental-variables",children:"Environmental Variables"}),"\n",(0,t.jsxs)(n.p,{children:["All environmental variables are optional. Currently there are not many environmental variables used, as most of the user preferences are stored under ",(0,t.jsx)(n.code,{children:"appConfig"})," in the ",(0,t.jsx)(n.code,{children:"conf.yml"})," file."]}),"\n",(0,t.jsxs)(n.p,{children:["You can set variables either in your environment, or using the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/.env",children:(0,t.jsx)(n.code,{children:".env"})})," file."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"NODE_ENV"})," - Current environment, can be either development, production or test"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"PORT"})," - The port to expose the running application on"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"HOST"})," - The host that Dashy is running on, domain or IP"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"BASE_URL"})," - The default base path for serving up static assets"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"VUE_APP_DOMAIN"})," - Usually the same as BASE_URL, but accessible in frontend"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"INTEGRITY"})," - Should enable SRI for build script and link resources"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"IS_DOCKER"})," - Computed automatically on build. Indicates if running in container"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"VUE_APP_VERSION"})," - Again, set automatically using package.json during build time"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"BACKUP_DIR"})," - Directory for conf.yml backups"]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"environment-modes",children:"Environment Modes"}),"\n",(0,t.jsxs)(n.p,{children:["You can set the environment using the ",(0,t.jsx)(n.code,{children:"NODE_ENV"})," variable. By default, the correct environment should be selected based on the script you run to start the app. The following environments are supported: ",(0,t.jsx)(n.code,{children:"production"}),", ",(0,t.jsx)(n.code,{children:"development"})," and ",(0,t.jsx)(n.code,{children:"test"}),". For more info, see ",(0,t.jsx)(n.a,{href:"https://cli.vuejs.org/guide/mode-and-env.html#modes",children:"Vue CLI Environment Modes"}),"."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"git-strategy",children:"Git Strategy"}),"\n",(0,t.jsx)(n.h3,{id:"git-flow",children:"Git Flow"}),"\n",(0,t.jsxs)(n.p,{children:["Like most Git repos, we are following the ",(0,t.jsx)(n.a,{href:"https://guides.github.com/introduction/flow",children:"Github Flow"})," standard."]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Create a branch (or fork if you don'd have write access)"}),"\n",(0,t.jsx)(n.li,{children:"Code some awesome stuff \ud83e\uddd1\u200d\ud83d\udcbb"}),"\n",(0,t.jsx)(n.li,{children:"Add, commit and push your changes to your branch/ fork"}),"\n",(0,t.jsx)(n.li,{children:"Head over to GitHub and create a Pull Request"}),"\n",(0,t.jsx)(n.li,{children:"Fill in the required sections in the template, and hit submit"}),"\n",(0,t.jsx)(n.li,{children:"Follow up with any reviews on your code"}),"\n",(0,t.jsx)(n.li,{children:"Merge \ud83c\udf89"}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"git-branch-naming",children:"Git Branch Naming"}),"\n",(0,t.jsxs)(n.p,{children:["The format of your branch name should be something similar to: ",(0,t.jsx)(n.code,{children:"[TYPE]/[TICKET]_[TITLE]"}),"\nFor example, ",(0,t.jsx)(n.code,{children:"FEATURE/420_Awesome-feature"})," or ",(0,t.jsx)(n.code,{children:"FIX/690_login-server-error"})]}),"\n",(0,t.jsx)(n.h3,{id:"commit-emojis",children:"Commit Emojis"}),"\n",(0,t.jsx)(n.p,{children:"Using a single emoji at the start of each commit message, to indicate the type task, makes the commit ledger easier to understand, plus it looks cool."}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["\ud83c\udfa8 ",(0,t.jsx)(n.code,{children:":art:"})," - Improve structure / format of the code."]}),"\n",(0,t.jsxs)(n.li,{children:["\u26a1\ufe0f ",(0,t.jsx)(n.code,{children:":zap:"})," - Improve performance."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udd25 ",(0,t.jsx)(n.code,{children:":fire:"})," - Remove code or files."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udc1b ",(0,t.jsx)(n.code,{children:":bug:"})," - Fix a bug."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\ude91\ufe0f ",(0,t.jsx)(n.code,{children:":ambulance:"})," - Critical hotfix"]}),"\n",(0,t.jsxs)(n.li,{children:["\u2728 ",(0,t.jsx)(n.code,{children:":sparkles:"})," - Introduce new features."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udcdd ",(0,t.jsx)(n.code,{children:":memo:"})," - Add or update documentation."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\ude80 ",(0,t.jsx)(n.code,{children:":rocket:"})," - Deploy stuff."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udc84 ",(0,t.jsx)(n.code,{children:":lipstick:"})," - Add or update the UI and style files."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83c\udf89 ",(0,t.jsx)(n.code,{children:":tada:"})," - Begin a project."]}),"\n",(0,t.jsxs)(n.li,{children:["\u2705 ",(0,t.jsx)(n.code,{children:":white_check_mark:"})," - Add, update, or pass tests."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udd12\ufe0f ",(0,t.jsx)(n.code,{children:":lock:"})," - Fix security issues."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udd16 ",(0,t.jsx)(n.code,{children:":bookmark:"})," - Make a Release or Version tag."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udea8 ",(0,t.jsx)(n.code,{children:":rotating_light:"})," - Fix compiler / linter warnings."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udea7 ",(0,t.jsx)(n.code,{children:":construction:"})," - Work in progress."]}),"\n",(0,t.jsxs)(n.li,{children:["\u2b06\ufe0f ",(0,t.jsx)(n.code,{children:":arrow_up:"})," - Upgrade dependencies."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udc77 ",(0,t.jsx)(n.code,{children:":construction_worker:"})," - Add or update CI build system."]}),"\n",(0,t.jsxs)(n.li,{children:["\u267b\ufe0f ",(0,t.jsx)(n.code,{children:":recycle:"})," - Refactor code."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83e\ude79 ",(0,t.jsx)(n.code,{children:":adhesive_bandage:"})," - Simple fix for a non-critical issue."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udd27 ",(0,t.jsx)(n.code,{children:":wrench:"})," - Add or update configuration files."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83c\udf71 ",(0,t.jsx)(n.code,{children:":bento:"})," - Add or update assets."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\uddc3\ufe0f ",(0,t.jsx)(n.code,{children:":card_file_box:"})," - Perform database schema related changes."]}),"\n",(0,t.jsxs)(n.li,{children:["\u270f\ufe0f ",(0,t.jsx)(n.code,{children:":pencil2:"})," - Fix typos."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83c\udf10 ",(0,t.jsx)(n.code,{children:":globe_with_meridians:"})," - Internationalization and translations."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["For a full list of options, see ",(0,t.jsx)(n.a,{href:"https://gitmoji.dev/",children:"gitmoji.dev"})]}),"\n",(0,t.jsx)(n.h3,{id:"pr-guidelines",children:"PR Guidelines"}),"\n",(0,t.jsx)(n.p,{children:"Once you've made your changes, and pushed them to your fork or branch, you're ready to open a pull request!"}),"\n",(0,t.jsx)(n.p,{children:"For a pull request to be merged, it must:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Must be backwards compatible"}),"\n",(0,t.jsx)(n.li,{children:"The build, lint and tests (run by GH actions) must pass"}),"\n",(0,t.jsx)(n.li,{children:"There must not be any merge conflicts"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"When you submit your PR, include the required info, by filling out the PR template. Including:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"A brief description of your changes"}),"\n",(0,t.jsx)(n.li,{children:"The issue, ticket or discussion number (if applicable)"}),"\n",(0,t.jsx)(n.li,{children:"For UI relate updates include a screenshot"}),"\n",(0,t.jsx)(n.li,{children:"If any dependencies were added, explain why it was needed, state the cost associated, and confirm it does not introduce any security issues"}),"\n",(0,t.jsx)(n.li,{children:"Finally, check the checkboxes, to confirm that the standards are met, and hit submit!"}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"resources-for-beginners",children:"Resources for Beginners"}),"\n",(0,t.jsx)(n.p,{children:"New to Web Development? Glad you're here! Dashy is a pretty simple app, so it should make a good candidate for your first PR. Presuming that you already have a basic knowledge of JavaScript, the following articles should point you in the right direction for getting up to speed with the technologies used in this project:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://opensource.guide/how-to-contribute/",children:"Open Source for Beginners"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://v3.vuejs.org/guide/introduction.html",children:"Introduction to Vue.js"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.taniarascia.com/getting-started-with-vue/",children:"Vue.js Walkthrough"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://github.com/lukehoban/es6features",children:"ES6 Features"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://blog.logrocket.com/the-definitive-guide-to-scss/",children:"Definitive guide to SCSS"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://docker-curriculum.com/",children:"Complete beginners guide to Docker"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://training.play-with-docker.com/",children:"Docker Classroom - Interactive Tutorials"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.freecodecamp.org/news/learn-typescript-in-5-minutes-13eda868daeb/",children:"Quick start TypeScript guide"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.typescripttutorial.net/",children:"Complete TypeScript tutorial series"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://blog.logrocket.com/vue-typescript-tutorial-examples/",children:"Using TypeScript with Vue.js"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"http://git-cheatsheet.com/",children:"Git cheat sheet"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.freecodecamp.org/news/what-is-npm-a-node-package-manager-tutorial-for-beginners/",children:"Basics of using NPM"})}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["As well as Node, Git and Docker- you'll also need an IDE (e.g. ",(0,t.jsx)(n.a,{href:"https://code.visualstudio.com/",children:"VS Code"})," or ",(0,t.jsx)(n.a,{href:"https://www.vim.org/",children:"Vim"}),") and a terminal (Windows users may find ",(0,t.jsx)(n.a,{href:"https://docs.microsoft.com/en-us/windows/wsl/",children:"WSL"})," more convenient)."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"app-info",children:"App Info"}),"\n",(0,t.jsx)(n.h3,{id:"style-guide",children:"Style Guide"}),"\n",(0,t.jsxs)(n.p,{children:["Linting is done using ",(0,t.jsx)(n.a,{href:"https://eslint.org/",children:"ESLint"}),", and using the ",(0,t.jsx)(n.a,{href:"https://github.com/vuejs/eslint-config-standard",children:"Vue.js Styleguide"}),", which is very similar to the ",(0,t.jsx)(n.a,{href:"https://github.com/airbnb/javascript",children:"AirBnB Styleguide"}),". You can run ",(0,t.jsx)(n.code,{children:"yarn lint"})," to report and fix issues. While the dev server is running, issues will be reported to the console automatically, and any lint errors will trigger the build to fail. Note that all lint checks must pass before any PR can be merged. Linting is also run as a git pre-commit hook"]}),"\n",(0,t.jsx)(n.p,{children:"The most significant things to note are:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Indentation should be done with two spaces"}),"\n",(0,t.jsx)(n.li,{children:"Strings should use single quotes"}),"\n",(0,t.jsx)(n.li,{children:"All statements must end in a semi-colon"}),"\n",(0,t.jsx)(n.li,{children:"The final element in all objects must be preceded with a comma"}),"\n",(0,t.jsx)(n.li,{children:"Maximum line length is 100"}),"\n",(0,t.jsx)(n.li,{children:"There must be exactly one blank line between sections, before function names, and at the end of the file"}),"\n",(0,t.jsx)(n.li,{children:"With conditionals, put else on the same line as your if block's closing brace"}),"\n",(0,t.jsx)(n.li,{children:"All multiline blocks must use braces"}),"\n",(0,t.jsx)(n.li,{children:"Avoid console statements in the frontend"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Styleguides:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Vue: ",(0,t.jsx)(n.a,{href:"https://vuejs.org/v2/style-guide/",children:"Vue styleguide"})]}),"\n",(0,t.jsxs)(n.li,{children:["JavaScript: ",(0,t.jsx)(n.a,{href:"https://github.com/airbnb/javascript",children:"github.com/airbnb/javascript"})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"application-structure",children:"Application Structure"}),"\n",(0,t.jsxs)(n.h4,{id:"files-in-the-root-",children:["Files in the Root: ",(0,t.jsx)(n.code,{children:"./"})]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"\u256e\n\u251c\u2500\u2500 package.json # Project meta-data, dependencies and paths to scripts\n\u251c\u2500\u2500 src/ # Project front-end source code\n\u251c\u2500\u2500 server.js # A Node.js server to serve up the /dist directory\n\u251c\u2500\u2500 services/ # All server-side endpoints and utilities\n\u251c\u2500\u2500 vue.config.js # Vue.js configuration\n\u251c\u2500\u2500 Dockerfile # The blueprint for building the Docker container\n\u251c\u2500\u2500 docker-compose.yml # A Docker run command\n\u251c\u2500\u2500 .env # Location for any environmental variables\n\u251c\u2500\u2500 yarn.lock # Auto-generated list of current packages and version numbers\n\u251c\u2500\u2500 docs/ # Markdown documentation\n\u251c\u2500\u2500 README.md # Readme, basic info for getting started\n\u251c\u2500\u2500 LICENSE.md # License for use\n\u256f\n"})}),"\n",(0,t.jsxs)(n.h4,{id:"frontend-source-src",children:["Frontend Source: ",(0,t.jsx)(n.code,{children:"./src/"})]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"./src\n\u251c\u2500\u2500 App.vue # Vue.js starting file\n\u251c\u2500\u2500 assets # Static non-compiled assets\n\u2502 \u251c\u2500\u2500 fonts # .ttf font files\n\u2502 \u251c\u2500\u2500 locales # All app text, each language in a separate JSON file\n\u2502 \u2570\u2500\u2500 interface-icons # SVG icons used in the app\n\u251c\u2500\u2500 components # All front-end Vue web components\n\u2502 \u251c\u2500\u2500 Charts # Charting components for dynamically displaying widget data\n\u2502 \u2502 \u251c\u2500\u2500 Gauge.vue # A speed-dial style chart for showing 0 - 100 values\n\u2502 \u2502 \u2570\u2500\u2500 PercentageChart.vue # A horizontal bar for showing percentage breakdowns\n\u2502 \u251c\u2500\u2500 Configuration # Components relating to the user config pop-up\n\u2502 \u2502 \u251c\u2500\u2500 AppInfoModal.vue # A modal showing core app info, like version, language, etc\n\u2502 \u2502 \u251c\u2500\u2500 AppVersion.vue # Shows current version from package.json, compares with GitHub\n\u2502 \u2502 \u251c\u2500\u2500 CloudBackupRestore.vue # Form where the user manages cloud sync options\n\u2502 \u2502 \u251c\u2500\u2500 ConfigContainer.vue # Main container, wrapping all other config components\n\u2502 \u2502 \u251c\u2500\u2500 CustomCss.vue # Form where the user can input custom CSS\n\u2502 \u2502 \u251c\u2500\u2500 EditSiteMeta.vue # Form where the user can edit site meta data\n\u2502 \u2502 \u251c\u2500\u2500 JsonEditor.vue # JSON editor, where the user can modify the main config file\n\u2502 \u2502 \u2570\u2500\u2500 RebuildApp.vue # A component allowing user to trigger a rebuild through the UI\n\u2502 \u251c\u2500\u2500 FormElements # Basic form elements used throughout the app\n\u2502 \u2502 \u251c\u2500\u2500 Button.vue # Standard button component\n\u2502 \u2502 \u251c\u2500\u2500 Radio.vue # Standard radio button input\n\u2502 \u2502 \u251c\u2500\u2500 Select.vue # Standard dropdown input selector\n\u2502 \u2502 \u251c\u2500\u2500 Input.vue # Standard text field input component\n\u2502 \u2502 \u2570\u2500\u2500 Toggle.vue # Standard on / off toggle switch\n\u2502 \u251c\u2500\u2500 InteractiveEditor # Components for the interactive UI config editor\n\u2502 \u2502 \u251c\u2500\u2500 AddNewSectionLauncher # Button that launches the EditSection form, used for adding new section\n\u2502 \u2502 \u251c\u2500\u2500 EditAppConfig.vue # Form for editing appConfig\n\u2502 \u2502 \u251c\u2500\u2500 EditPageInfo.vue # Form for editing pageInfo\n\u2502 \u2502 \u251c\u2500\u2500 EditSection.vue # Form for adding / editing sections\n\u2502 \u2502 \u251c\u2500\u2500 EditItem.vue # Form for adding or editing items\n\u2502 \u2502 \u251c\u2500\u2500 EditModeSaveMenu.vue # The bar at the bottom of screen in edit mode, containing save buttons\n\u2502 \u2502 \u251c\u2500\u2500 EditModeTopBanner.vue # The bar at the top of screen in edit mode\n\u2502 \u2502 \u251c\u2500\u2500 ExportConfigMenu.vue # Modal for viewing / exporting edited config\n\u2502 \u2502 \u251c\u2500\u2500 MoveItemTo.vue # Form for moving / copying items to other sections\n\u2502 \u2502 \u2570\u2500\u2500 SaveCancelButtons.vue # Buttons visible in all the edit menus, to save or cancel changes\n\u2502 \u251c\u2500\u2500 LinkItems # Components for Sections and Link Items\n\u2502 \u2502 \u251c\u2500\u2500 Collapsable.vue # The collapsible functionality of sections\n\u2502 \u2502 \u251c\u2500\u2500 IframeModal.vue # Pop-up iframe modal, for viewing websites within the app\n\u2502 \u2502 \u251c\u2500\u2500 Item.vue # Main link item, which is displayed within an item group\n\u2502 \u2502 \u251c\u2500\u2500 ItemGroup.vue # Item group is a section containing icons\n\u2502 \u2502 \u251c\u2500\u2500 ItemIcon.vue # The icon used by both items and sections\n\u2502 \u2502 \u251c\u2500\u2500 ItemOpenMethodIcon.vue # A small icon, visible on hover, indicating opening method\n\u2502 \u2502 \u251c\u2500\u2500 ItemContextMenu.vue # The right-click menu, for showing Item opening methods and info\n\u2502 \u2502 \u251c\u2500\u2500 SectionContextMenu.vue # The right-click menu, for showing Section edit/ open options\n\u2502 \u2502 \u2570\u2500\u2500 StatusIndicator.vue # Traffic light dot, showing if app is online or down\n\u2502 \u251c\u2500\u2500 Minimal View # Components used for the startpage / minimal alternative view\n\u2502 \u2502 \u251c\u2500\u2500 MinimalHeading.vue # Title part of minimal view\n\u2502 \u2502 \u251c\u2500\u2500 MinimalSearch.vue # Search bar for minimal view\n\u2502 \u2502 \u2570\u2500\u2500 MinimalSection.vue # Tabbed-Item section for minimal view\n\u2502 \u251c\u2500\u2500 PageStrcture # Components relating the main structure of the page\n\u2502 \u2502 \u251c\u2500\u2500 Footer.vue # Footer, visible at the bottom of all pages\n\u2502 \u2502 \u251c\u2500\u2500 Header.vue # Header, visible at the top of pages, and includes title and nav\n\u2502 \u2502 \u251c\u2500\u2500 LoadingScreen.vue # Splash screen shown on first load\n\u2502 \u2502 \u251c\u2500\u2500 Nav.vue # Navigation bar, includes a list of links\n\u2502 \u2502 \u2570\u2500\u2500 PageTitle.vue # Page title and sub-title, visible within the Header\n\u2502 \u251c\u2500\u2500 Workspace # Components used for the multi-tasking/ Workspace view\n\u2502 \u2502 \u251c\u2500\u2500 MultiTaskingWeb.vue # When multi-tasking enabled, generates new iframe\n\u2502 \u2502 \u251c\u2500\u2500 SideBar.vue # The left sidebar for the workspace view\n\u2502 \u2502 \u251c\u2500\u2500 SideBarItem.vue # App item for the sidebar view\n\u2502 \u2502 \u251c\u2500\u2500 SideBarSection.vue # Collapsible collection of items within workspace sidebar\n\u2502 \u2502 \u251c\u2500\u2500 WebContent.vue # Workspace iframe view, displays content of current app\n\u2502 \u2502 \u2570\u2500\u2500 WidgetView.vue # Workspace container for displaying widgets in main content\n\u2502 \u251c\u2500\u2500 Widgets # Directory contains all custom widget components\n\u2502 \u2502 \u2570\u2500\u2500 .... # Too many to list, see widget docs instead\n\u2502 \u2570\u2500\u2500 Settings # Components relating to the quick-settings, in the top-right\n\u2502 \u251c\u2500\u2500 AuthButtons.vue # Logout button and other app info\n\u2502 \u251c\u2500\u2500 ConfigLauncher.vue # Icon that when clicked will launch the Configuration component\n\u2502 \u251c\u2500\u2500 CustomThemeMaker.vue # Color pickers for letting user build their own theme\n\u2502 \u251c\u2500\u2500 ItemSizeSelector.vue # Set of buttons used to set and save item size\n\u2502 \u251c\u2500\u2500 KeyboardShortcutInfo.vue# Small pop-up displaying the available keyboard shortcuts\n\u2502 \u251c\u2500\u2500 LanguageSwitcher.vue # Dropdown in a modal for changing app language\n\u2502 \u251c\u2500\u2500 LayoutSelector.vue # Set of buttons, letting the user select their desired layout\n\u2502 \u251c\u2500\u2500 SearchBar.vue # The input field in the header, used for searching the app\n\u2502 \u251c\u2500\u2500 SettingsContainer.vue # Container that wraps all the quick-settings components\n\u2502 \u2570\u2500\u2500 ThemeSelector.vue # Drop-down menu enabling the user to select and change themes\n\u251c\u2500\u2500 main.js # Main front-end entry point\n\u251c\u2500\u2500 registerServiceWorker.js # Registers and manages service workers, for PWA apps\n\u251c\u2500\u2500 router.js # Defines all available application routes\n\u251c\u2500\u2500 styles # Directory of all globally used common SCSS styles\n\u2502 \u251c\u2500\u2500 color-palette.scss # All color variable names and default values\n\u2502 \u251c\u2500\u2500 color-themes.scss # All variable values for built-in themes\n\u2502 \u251c\u2500\u2500 dimensions.scss # Dimensions and sizes as variables\n\u2502 \u251c\u2500\u2500 global-styles.scss # Basics and style resets used globally\n\u2502 \u251c\u2500\u2500 media-queries.scss # Screen sizes and media queries\n\u2502 \u251c\u2500\u2500 style-helpers.scss # SCSS functions used for modifying values\n\u2502 \u251c\u2500\u2500 typography.scss # Font and text styles used globally\n\u2502 \u2570\u2500\u2500 user-defined-themes.scss # Empty, put any custom styles or themes here\n\u251c\u2500\u2500 mixins # Reusable component bases, extended by other views / components\n\u2502 \u251c\u2500\u2500 ChartingMixin.js # Functions for rendering charts in widget components\n\u2502 \u251c\u2500\u2500 GlancesMixin.js # Functions for fetching system info from Glances for widgets\n\u2502 \u251c\u2500\u2500 HomeMixin.js # Functions for homepage, used by default, minimal and workspace views\n\u2502 \u2570\u2500\u2500 WidgetMixin.js # Functions for all widgets, like data fetching, updating and error handling\n\u251c\u2500\u2500 utils # Directory of re-used helper functions\n\u2502 \u251c\u2500\u2500 ArrowKeyNavigation.js # Functionality for arrow-key navigation\n\u2502 \u251c\u2500\u2500 Auth.js # Handles all authentication related actions\n\u2502 \u251c\u2500\u2500 CheckSectionVisibility.js # Checks which parts of the page should be visible/ hidden based on config\n\u2502 \u251c\u2500\u2500 ClickOutside.js # A directive for detecting click, used to hide dropdown, modal or context menu\n\u2502 \u251c\u2500\u2500 ConfigHelpers.js # Helper functions for managing configuration\n\u2502 \u251c\u2500\u2500 CloudBackup.js # Functionality for encrypting, processing and network calls\n\u2502 \u251c\u2500\u2500 ConfigSchema.json # The schema, used to validate the users conf.yml file\n\u2502 \u251c\u2500\u2500 ConfigAccumulator.js # Central place for managing and combining config\n\u2502 \u251c\u2500\u2500 ConfigHelpers.js # Collection of helper functions to process config using accumulator\n\u2502 \u251c\u2500\u2500 ConfigValidator.js # A helper script that validates the config file against schema\n\u2502 \u251c\u2500\u2500 CoolConsole.js # Prints info, warning and error messages to browser console, with a cool style\n\u2502 \u251c\u2500\u2500 defaults.js # Global constants and their default values\n\u2502 \u251c\u2500\u2500 emojis.json # List of emojis with unicode and shortcode, used for emoji icon feature\n\u2502 \u251c\u2500\u2500 EmojiUnicodeRegex.js # Regular expression to validate emoji unicode format, for emoji icons\n\u2502 \u251c\u2500\u2500 ErrorHandler.js # Helper function called when an error is returned\n\u2502 \u251c\u2500\u2500 InitServiceWorker.js # Initializes and manages service worker, if enabled\n\u2502 \u251c\u2500\u2500 Search.js # Helper functions for searching/ filtering items in all views\n\u2502 \u251c\u2500\u2500 JsonToYaml.js # Function that parses and converts raw JSON into valid YAML\n\u2502 \u251c\u2500\u2500 KeycloakAuth.js # Singleton class to manage Keycloak authentication\n\u2502 \u251c\u2500\u2500 OidcAuth.js # Manages OIDC authentication with external providers\n\u2502 \u251c\u2500\u2500 HeaderAuth.js # Handles header-based authentication via reverse proxy\n\u2502 \u251c\u2500\u2500 languages.js # Handles fetching, switching and validating languages\n\u2502 \u2570\u2500\u2500 ThemeHelper.js # Function that handles the fetching and setting of user themes\n\u2570\u2500\u2500 views # Directory of available pages, corresponding to available routes\n \u251c\u2500\u2500 Home.vue # The home page container\n \u251c\u2500\u2500 About.vue # About page\n \u251c\u2500\u2500 Login.vue # Authentication page\n \u251c\u2500\u2500 Minimal.vue # The minimal view\n \u251c\u2500\u2500 Workspace.vue # The workspace view with apps in sidebar\n \u251c\u2500\u2500 DownloadConfig.vue # Config export page\n \u2570\u2500\u2500 404.vue # Not found page\n"})}),"\n",(0,t.jsx)(n.h4,{id:"visualisation-of-source-directory",children:"Visualisation of Source Directory"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/repo-visualization.svg",alt:"File Breakdown"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"development-tools",children:"Development Tools"}),"\n",(0,t.jsx)(n.h3,{id:"performance---lighthouse",children:"Performance - Lighthouse"}),"\n",(0,t.jsx)(n.p,{children:"The easiest method of checking performance is to use Chromium's build in auditing tool, Lighthouse. To run the test, open Developer Tools (usually F12) --\x3e Lighthouse and click on the 'Generate Report' button at the bottom."}),"\n",(0,t.jsx)(n.h3,{id:"dependencies---bundlephobia",children:"Dependencies - BundlePhobia"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"https://bundlephobia.com/",children:"BundlePhobia"})," is a really useful app that lets you analyze the cost of adding any particular dependency to an application"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"notes-1",children:"Notes"}),"\n",(0,t.jsx)(n.h3,{id:"known-warnings",children:"Known Warnings"}),"\n",(0,t.jsx)(n.p,{children:"When running the build command, several warnings appear. These are not errors, and do not affect the security or performance of the application. They will be addressed in a future update"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"WARN A new version of sass-loader is available. Please upgrade for best experience."})," - Currently we're using an older version of SASS loader, since the more recent releases do not seem to be compatible with the Vue CLI's webpack configuration."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"WARN asset size limit: The following asset(s) exceed the recommended size limit (244 KiB)."})," - For the PWA to support Windows 10, a splash screen asset is required, and is quite large. This throws a warning, however PWA assets are not loaded until needed, so shouldn't have any impact on application performance. A similar warning is thrown for the Raleway font, and that is looking to be addressed."]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453(e,n,i){i.d(n,{R:()=>r,x:()=>a});var s=i(6540);const t={},o=s.createContext(t);function r(e){const n=s.useContext(o);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[5992],{2745(e,n,i){i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"developing","title":"Developing","description":"This article outlines how to get Dashy running in a development environment, and outlines the basics of the architecture.","source":"@site/docs/developing.md","sourceDirName":".","slug":"/developing","permalink":"/docs/developing","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/developing.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Contributing","permalink":"/docs/contributing"},"next":{"title":"Development Guides","permalink":"/docs/development-guides"}}');var t=i(4848),o=i(8453);const r={},a="Developing",l={},d=[{value:"Setting up the Dev Environment",id:"setting-up-the-dev-environment",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Running the Project",id:"running-the-project",level:3},{value:"Project Commands",id:"project-commands",level:3},{value:"Basics",id:"basics",level:4},{value:"Development",id:"development",level:4},{value:"Utils and Checks",id:"utils-and-checks",level:4},{value:"Alternate Start Commands",id:"alternate-start-commands",level:4},{value:"Notes",id:"notes",level:4},{value:"Environmental Variables",id:"environmental-variables",level:3},{value:"Environment Modes",id:"environment-modes",level:3},{value:"Git Strategy",id:"git-strategy",level:2},{value:"Git Flow",id:"git-flow",level:3},{value:"Git Branch Naming",id:"git-branch-naming",level:3},{value:"Commit Emojis",id:"commit-emojis",level:3},{value:"PR Guidelines",id:"pr-guidelines",level:3},{value:"Resources for Beginners",id:"resources-for-beginners",level:2},{value:"App Info",id:"app-info",level:2},{value:"Style Guide",id:"style-guide",level:3},{value:"Application Structure",id:"application-structure",level:3},{value:"Files in the Root: ./",id:"files-in-the-root-",level:4},{value:"Frontend Source: ./src/",id:"frontend-source-src",level:4},{value:"Visualisation of Source Directory",id:"visualisation-of-source-directory",level:4},{value:"Development Tools",id:"development-tools",level:2},{value:"Performance - Lighthouse",id:"performance---lighthouse",level:3},{value:"Dependencies - BundlePhobia",id:"dependencies---bundlephobia",level:3},{value:"Notes",id:"notes-1",level:2},{value:"Known Warnings",id:"known-warnings",level:3}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"developing",children:"Developing"})}),"\n",(0,t.jsxs)(n.p,{children:["This article outlines how to get Dashy running in a development environment, and outlines the basics of the architecture.\nIf you're adding new features, you may want to check out the ",(0,t.jsx)(n.a,{href:"/docs/development-guides",children:"Development Guides"})," docs, for tutorials covering basic tasks."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#setting-up-the-dev-environment",children:"Setting up the Development Environment"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#prerequisites",children:"Prerequisites"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#running-the-project",children:"Running the App"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#project-commands",children:"Project Commands"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#environmental-variables",children:"Environmental Variables"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#git-strategy",children:"Git Strategy"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#git-flow",children:"Flow"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#git-branch-naming",children:"Branches"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#commit-emojis",children:"Commit emojis"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#pr-guidelines",children:"PR Guidelines"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#resources-for-beginners",children:"Resources for Beginners"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#app-info",children:"App Info"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#style-guide",children:"Code Style Guide"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#application-structure",children:"Application Structure"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#development-tools",children:"Development Tools"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#notes",children:"Misc / Notes"})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"setting-up-the-dev-environment",children:"Setting up the Dev Environment"}),"\n",(0,t.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,t.jsxs)(n.p,{children:["You will need either the latest or LTS version of ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"https://nodejs.org/",children:"Node.js"})})," to build and serve the application and ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"https://git-scm.com/downloads",children:"Git"})})," to easily fetch the code, and push any changes. If you plan on running or deploying the container, you'll also need ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"https://docs.docker.com/get-docker/",children:"Docker"})}),". To avoid any unexpected issues, ensure you've got at least ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"https://www.npmjs.com/get-npm",children:"NPM"})})," V 7.5 or ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"https://classic.yarnpkg.com/en/docs/install/#windows-stable",children:"Yarn"})})," 1.22 (you may find ",(0,t.jsx)(n.a,{href:"https://github.com/nvm-sh/nvm",children:"NVM"})," helpful for switching/ managing versions)."]}),"\n",(0,t.jsx)(n.h3,{id:"running-the-project",children:"Running the Project"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Get Code: ",(0,t.jsx)(n.code,{children:"git clone https://github.com/Lissy93/dashy.git"})]}),"\n",(0,t.jsxs)(n.li,{children:["Navigate into the directory: ",(0,t.jsx)(n.code,{children:"cd dashy"})]}),"\n",(0,t.jsxs)(n.li,{children:["Install dependencies: ",(0,t.jsx)(n.code,{children:"yarn"})]}),"\n",(0,t.jsxs)(n.li,{children:["Start dev server: ",(0,t.jsx)(n.code,{children:"yarn dev"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Dashy should now be being served on ",(0,t.jsx)(n.a,{href:"http://localhost:8080/",children:"http://localhost:8080/"}),". Hot reload is enabled, so making changes to any of the files will trigger them to be rebuilt and the page refreshed."]}),"\n",(0,t.jsx)(n.h3,{id:"project-commands",children:"Project Commands"}),"\n",(0,t.jsx)(n.h4,{id:"basics",children:"Basics"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn build"})})," - In the interest of speed, the application is pre-compiled, this means that the config file is read during build-time, and therefore the app needs to rebuilt for any new changes to take effect. Luckily this is very straight forward. Just run ",(0,t.jsx)(n.code,{children:"yarn build"})," or ",(0,t.jsx)(n.code,{children:"docker exec -it [container-id] yarn build"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn start"})})," - Starts a web server, and serves up the production site from ",(0,t.jsx)(n.code,{children:"./dist"})," (must run build command first)"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"development",children:"Development"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn dev"})})," - Starts the development server with hot reloading"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn lint"})})," - Lints code to ensure it follows a consistent, neat style"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn test"})})," - Runs tests, and outputs results"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"utils-and-checks",children:"Utils and Checks"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn validate-config"})})," - If you have quite a long configuration file, you may wish to check that it's all good to go, before deploying the app. This can be done with ",(0,t.jsx)(n.code,{children:"yarn validate-config"})," or ",(0,t.jsx)(n.code,{children:"docker exec -it [container-id] yarn validate-config"}),". Your config file needs to be in ",(0,t.jsx)(n.code,{children:"/user-data/conf.yml"})," (or within your Docker container at ",(0,t.jsx)(n.code,{children:"/app/user-data/conf.yml"}),"). This will first check that your YAML is valid, and then validates it against Dashy's ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json",children:"schema"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn health-check"})})," - Checks that the application is up and running on it's specified port, and outputs current status and response times. Useful for integrating into your monitoring service, if you need to maintain high system availability"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"alternate-start-commands",children:"Alternate Start Commands"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn build-and-start"})})," - Builds the app, runs checks and starts the production server. Commands are run in parallel, and so is faster than running them in independently. Uses the ",(0,t.jsx)(n.code,{children:"yarn build"})," and ",(0,t.jsx)(n.code,{children:"yarn start"})," commands"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn build-watch"})})," - If you find yourself making frequent changes to your configuration, and do not want to have to keep manually rebuilding, then this option is for you. It will watch for changes to any files within the projects root, and then trigger a rebuild. Note that if you are developing new features, then ",(0,t.jsx)(n.code,{children:"yarn dev"})," would be more appropriate, as it's significantly faster at recompiling (under 1 second), and has hot reloading, linting and testing integrated"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"yarn pm2-start"})})," - Starts the Node server using ",(0,t.jsx)(n.a,{href:"https://pm2.keymetrics.io/",children:"PM2"}),", a process manager for Node.js applications, that helps them stay alive. PM2 has some built-in basic monitoring features, and an optional ",(0,t.jsx)(n.a,{href:"https://pm2.io/",children:"management solution"}),". If you are running the app on bare metal, it is recommended to use this start command"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"notes",children:"Notes"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["If you are using NPM, replace ",(0,t.jsx)(n.code,{children:"yarn"})," with ",(0,t.jsx)(n.code,{children:"npm run"})]}),"\n",(0,t.jsxs)(n.li,{children:["If you are using Docker, precede each command with ",(0,t.jsx)(n.code,{children:"docker exec -it [container-id]"}),". Container ID can be found by running ",(0,t.jsx)(n.code,{children:"docker ps"})]}),"\n",(0,t.jsxs)(n.li,{children:["You can manage the app using the ",(0,t.jsx)(n.a,{href:"https://cli.vuejs.org/guide/cli-service.html",children:"Vue-CLI Service"}),", with ",(0,t.jsx)(n.code,{children:"npx vue-cli-service [command]"}),". Or to start the Vue Management UI, run ",(0,t.jsx)(n.code,{children:"npx vue ui"}),", and open ",(0,t.jsx)(n.code,{children:"http://localhost:8000"})]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"environmental-variables",children:"Environmental Variables"}),"\n",(0,t.jsxs)(n.p,{children:["All environmental variables are optional. Currently there are not many environmental variables used, as most of the user preferences are stored under ",(0,t.jsx)(n.code,{children:"appConfig"})," in the ",(0,t.jsx)(n.code,{children:"conf.yml"})," file."]}),"\n",(0,t.jsxs)(n.p,{children:["You can set variables either in your environment, or using the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/.env",children:(0,t.jsx)(n.code,{children:".env"})})," file."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"NODE_ENV"})," - Current environment, can be either development, production or test"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"PORT"})," - The port to expose the running application on"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"HOST"})," - The host that Dashy is running on, domain or IP"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"BASE_URL"})," - The default base path for serving up static assets"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"VUE_APP_DOMAIN"})," - Usually the same as BASE_URL, but accessible in frontend"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"INTEGRITY"})," - Should enable SRI for build script and link resources"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"IS_DOCKER"})," - Computed automatically on build. Indicates if running in container"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"VUE_APP_VERSION"})," - Again, set automatically using package.json during build time"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"BACKUP_DIR"})," - Directory for conf.yml backups"]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"environment-modes",children:"Environment Modes"}),"\n",(0,t.jsxs)(n.p,{children:["You can set the environment using the ",(0,t.jsx)(n.code,{children:"NODE_ENV"})," variable. By default, the correct environment should be selected based on the script you run to start the app. The following environments are supported: ",(0,t.jsx)(n.code,{children:"production"}),", ",(0,t.jsx)(n.code,{children:"development"})," and ",(0,t.jsx)(n.code,{children:"test"}),". For more info, see ",(0,t.jsx)(n.a,{href:"https://cli.vuejs.org/guide/mode-and-env.html#modes",children:"Vue CLI Environment Modes"}),"."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"git-strategy",children:"Git Strategy"}),"\n",(0,t.jsx)(n.h3,{id:"git-flow",children:"Git Flow"}),"\n",(0,t.jsxs)(n.p,{children:["Like most Git repos, we are following the ",(0,t.jsx)(n.a,{href:"https://guides.github.com/introduction/flow",children:"Github Flow"})," standard."]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Create a branch (or fork if you don'd have write access)"}),"\n",(0,t.jsx)(n.li,{children:"Code some awesome stuff \ud83e\uddd1\u200d\ud83d\udcbb"}),"\n",(0,t.jsx)(n.li,{children:"Add, commit and push your changes to your branch/ fork"}),"\n",(0,t.jsx)(n.li,{children:"Head over to GitHub and create a Pull Request"}),"\n",(0,t.jsx)(n.li,{children:"Fill in the required sections in the template, and hit submit"}),"\n",(0,t.jsx)(n.li,{children:"Follow up with any reviews on your code"}),"\n",(0,t.jsx)(n.li,{children:"Merge \ud83c\udf89"}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"git-branch-naming",children:"Git Branch Naming"}),"\n",(0,t.jsxs)(n.p,{children:["The format of your branch name should be something similar to: ",(0,t.jsx)(n.code,{children:"[TYPE]/[TICKET]_[TITLE]"}),"\nFor example, ",(0,t.jsx)(n.code,{children:"FEATURE/420_Awesome-feature"})," or ",(0,t.jsx)(n.code,{children:"FIX/690_login-server-error"})]}),"\n",(0,t.jsx)(n.h3,{id:"commit-emojis",children:"Commit Emojis"}),"\n",(0,t.jsx)(n.p,{children:"Using a single emoji at the start of each commit message, to indicate the type task, makes the commit ledger easier to understand, plus it looks cool."}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["\ud83c\udfa8 ",(0,t.jsx)(n.code,{children:":art:"})," - Improve structure / format of the code."]}),"\n",(0,t.jsxs)(n.li,{children:["\u26a1\ufe0f ",(0,t.jsx)(n.code,{children:":zap:"})," - Improve performance."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udd25 ",(0,t.jsx)(n.code,{children:":fire:"})," - Remove code or files."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udc1b ",(0,t.jsx)(n.code,{children:":bug:"})," - Fix a bug."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\ude91\ufe0f ",(0,t.jsx)(n.code,{children:":ambulance:"})," - Critical hotfix"]}),"\n",(0,t.jsxs)(n.li,{children:["\u2728 ",(0,t.jsx)(n.code,{children:":sparkles:"})," - Introduce new features."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udcdd ",(0,t.jsx)(n.code,{children:":memo:"})," - Add or update documentation."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\ude80 ",(0,t.jsx)(n.code,{children:":rocket:"})," - Deploy stuff."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udc84 ",(0,t.jsx)(n.code,{children:":lipstick:"})," - Add or update the UI and style files."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83c\udf89 ",(0,t.jsx)(n.code,{children:":tada:"})," - Begin a project."]}),"\n",(0,t.jsxs)(n.li,{children:["\u2705 ",(0,t.jsx)(n.code,{children:":white_check_mark:"})," - Add, update, or pass tests."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udd12\ufe0f ",(0,t.jsx)(n.code,{children:":lock:"})," - Fix security issues."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udd16 ",(0,t.jsx)(n.code,{children:":bookmark:"})," - Make a Release or Version tag."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udea8 ",(0,t.jsx)(n.code,{children:":rotating_light:"})," - Fix compiler / linter warnings."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udea7 ",(0,t.jsx)(n.code,{children:":construction:"})," - Work in progress."]}),"\n",(0,t.jsxs)(n.li,{children:["\u2b06\ufe0f ",(0,t.jsx)(n.code,{children:":arrow_up:"})," - Upgrade dependencies."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udc77 ",(0,t.jsx)(n.code,{children:":construction_worker:"})," - Add or update CI build system."]}),"\n",(0,t.jsxs)(n.li,{children:["\u267b\ufe0f ",(0,t.jsx)(n.code,{children:":recycle:"})," - Refactor code."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83e\ude79 ",(0,t.jsx)(n.code,{children:":adhesive_bandage:"})," - Simple fix for a non-critical issue."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udd27 ",(0,t.jsx)(n.code,{children:":wrench:"})," - Add or update configuration files."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83c\udf71 ",(0,t.jsx)(n.code,{children:":bento:"})," - Add or update assets."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\uddc3\ufe0f ",(0,t.jsx)(n.code,{children:":card_file_box:"})," - Perform database schema related changes."]}),"\n",(0,t.jsxs)(n.li,{children:["\u270f\ufe0f ",(0,t.jsx)(n.code,{children:":pencil2:"})," - Fix typos."]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83c\udf10 ",(0,t.jsx)(n.code,{children:":globe_with_meridians:"})," - Internationalization and translations."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["For a full list of options, see ",(0,t.jsx)(n.a,{href:"https://gitmoji.dev/",children:"gitmoji.dev"})]}),"\n",(0,t.jsx)(n.h3,{id:"pr-guidelines",children:"PR Guidelines"}),"\n",(0,t.jsx)(n.p,{children:"Once you've made your changes, and pushed them to your fork or branch, you're ready to open a pull request!"}),"\n",(0,t.jsx)(n.p,{children:"For a pull request to be merged, it must:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Must be backwards compatible"}),"\n",(0,t.jsx)(n.li,{children:"The build, lint and tests (run by GH actions) must pass"}),"\n",(0,t.jsx)(n.li,{children:"There must not be any merge conflicts"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"When you submit your PR, include the required info, by filling out the PR template. Including:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"A brief description of your changes"}),"\n",(0,t.jsx)(n.li,{children:"The issue, ticket or discussion number (if applicable)"}),"\n",(0,t.jsx)(n.li,{children:"For UI relate updates include a screenshot"}),"\n",(0,t.jsx)(n.li,{children:"If any dependencies were added, explain why it was needed, state the cost associated, and confirm it does not introduce any security issues"}),"\n",(0,t.jsx)(n.li,{children:"Finally, check the checkboxes, to confirm that the standards are met, and hit submit!"}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"resources-for-beginners",children:"Resources for Beginners"}),"\n",(0,t.jsx)(n.p,{children:"New to Web Development? Glad you're here! Dashy is a pretty simple app, so it should make a good candidate for your first PR. Presuming that you already have a basic knowledge of JavaScript, the following articles should point you in the right direction for getting up to speed with the technologies used in this project:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://opensource.guide/how-to-contribute/",children:"Open Source for Beginners"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://v3.vuejs.org/guide/introduction.html",children:"Introduction to Vue.js"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.taniarascia.com/getting-started-with-vue/",children:"Vue.js Walkthrough"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://github.com/lukehoban/es6features",children:"ES6 Features"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://blog.logrocket.com/the-definitive-guide-to-scss/",children:"Definitive guide to SCSS"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://docker-curriculum.com/",children:"Complete beginners guide to Docker"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://training.play-with-docker.com/",children:"Docker Classroom - Interactive Tutorials"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.freecodecamp.org/news/learn-typescript-in-5-minutes-13eda868daeb/",children:"Quick start TypeScript guide"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.typescripttutorial.net/",children:"Complete TypeScript tutorial series"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://blog.logrocket.com/vue-typescript-tutorial-examples/",children:"Using TypeScript with Vue.js"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"http://git-cheatsheet.com/",children:"Git cheat sheet"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.freecodecamp.org/news/what-is-npm-a-node-package-manager-tutorial-for-beginners/",children:"Basics of using NPM"})}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["As well as Node, Git and Docker- you'll also need an IDE (e.g. ",(0,t.jsx)(n.a,{href:"https://code.visualstudio.com/",children:"VS Code"})," or ",(0,t.jsx)(n.a,{href:"https://www.vim.org/",children:"Vim"}),") and a terminal (Windows users may find ",(0,t.jsx)(n.a,{href:"https://docs.microsoft.com/en-us/windows/wsl/",children:"WSL"})," more convenient)."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"app-info",children:"App Info"}),"\n",(0,t.jsx)(n.h3,{id:"style-guide",children:"Style Guide"}),"\n",(0,t.jsxs)(n.p,{children:["Linting is done using ",(0,t.jsx)(n.a,{href:"https://eslint.org/",children:"ESLint"}),", and using the ",(0,t.jsx)(n.a,{href:"https://github.com/vuejs/eslint-config-standard",children:"Vue.js Styleguide"}),", which is very similar to the ",(0,t.jsx)(n.a,{href:"https://github.com/airbnb/javascript",children:"AirBnB Styleguide"}),". You can run ",(0,t.jsx)(n.code,{children:"yarn lint"})," to report and fix issues. While the dev server is running, issues will be reported to the console automatically, and any lint errors will trigger the build to fail. Note that all lint checks must pass before any PR can be merged. Linting is also run as a git pre-commit hook"]}),"\n",(0,t.jsx)(n.p,{children:"The most significant things to note are:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Indentation should be done with two spaces"}),"\n",(0,t.jsx)(n.li,{children:"Strings should use single quotes"}),"\n",(0,t.jsx)(n.li,{children:"All statements must end in a semi-colon"}),"\n",(0,t.jsx)(n.li,{children:"The final element in all objects must be preceded with a comma"}),"\n",(0,t.jsx)(n.li,{children:"Maximum line length is 100"}),"\n",(0,t.jsx)(n.li,{children:"There must be exactly one blank line between sections, before function names, and at the end of the file"}),"\n",(0,t.jsx)(n.li,{children:"With conditionals, put else on the same line as your if block's closing brace"}),"\n",(0,t.jsx)(n.li,{children:"All multiline blocks must use braces"}),"\n",(0,t.jsx)(n.li,{children:"Avoid console statements in the frontend"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Styleguides:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Vue: ",(0,t.jsx)(n.a,{href:"https://vuejs.org/v2/style-guide/",children:"Vue styleguide"})]}),"\n",(0,t.jsxs)(n.li,{children:["JavaScript: ",(0,t.jsx)(n.a,{href:"https://github.com/airbnb/javascript",children:"github.com/airbnb/javascript"})]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"application-structure",children:"Application Structure"}),"\n",(0,t.jsxs)(n.h4,{id:"files-in-the-root-",children:["Files in the Root: ",(0,t.jsx)(n.code,{children:"./"})]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"\u256e\n\u251c\u2500\u2500 package.json # Project meta-data, dependencies and paths to scripts\n\u251c\u2500\u2500 src/ # Project front-end source code\n\u251c\u2500\u2500 server.js # A Node.js server to serve up the /dist directory\n\u251c\u2500\u2500 services/ # All server-side endpoints and utilities\n\u251c\u2500\u2500 vue.config.js # Vue.js configuration\n\u251c\u2500\u2500 Dockerfile # The blueprint for building the Docker container\n\u251c\u2500\u2500 docker-compose.yml # A Docker run command\n\u251c\u2500\u2500 .env # Location for any environmental variables\n\u251c\u2500\u2500 yarn.lock # Auto-generated list of current packages and version numbers\n\u251c\u2500\u2500 docs/ # Markdown documentation\n\u251c\u2500\u2500 README.md # Readme, basic info for getting started\n\u251c\u2500\u2500 LICENSE.md # License for use\n\u256f\n"})}),"\n",(0,t.jsxs)(n.h4,{id:"frontend-source-src",children:["Frontend Source: ",(0,t.jsx)(n.code,{children:"./src/"})]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"./src\n\u251c\u2500\u2500 App.vue # Vue.js starting file\n\u251c\u2500\u2500 assets # Static non-compiled assets\n\u2502 \u251c\u2500\u2500 fonts # .ttf font files\n\u2502 \u251c\u2500\u2500 locales # All app text, each language in a separate JSON file\n\u2502 \u2570\u2500\u2500 interface-icons # SVG icons used in the app\n\u251c\u2500\u2500 components # All front-end Vue web components\n\u2502 \u251c\u2500\u2500 Charts # Charting components for dynamically displaying widget data\n\u2502 \u2502 \u251c\u2500\u2500 Gauge.vue # A speed-dial style chart for showing 0 - 100 values\n\u2502 \u2502 \u2570\u2500\u2500 PercentageChart.vue # A horizontal bar for showing percentage breakdowns\n\u2502 \u251c\u2500\u2500 Configuration # Components relating to the user config pop-up\n\u2502 \u2502 \u251c\u2500\u2500 AppInfoModal.vue # A modal showing core app info, like version, language, etc\n\u2502 \u2502 \u251c\u2500\u2500 AppVersion.vue # Shows current version from package.json, compares with GitHub\n\u2502 \u2502 \u251c\u2500\u2500 CloudBackupRestore.vue # Form where the user manages cloud sync options\n\u2502 \u2502 \u251c\u2500\u2500 ConfigContainer.vue # Main container, wrapping all other config components\n\u2502 \u2502 \u251c\u2500\u2500 CustomCss.vue # Form where the user can input custom CSS\n\u2502 \u2502 \u251c\u2500\u2500 EditSiteMeta.vue # Form where the user can edit site meta data\n\u2502 \u2502 \u251c\u2500\u2500 JsonEditor.vue # JSON editor, where the user can modify the main config file\n\u2502 \u2502 \u2570\u2500\u2500 RebuildApp.vue # A component allowing user to trigger a rebuild through the UI\n\u2502 \u251c\u2500\u2500 FormElements # Basic form elements used throughout the app\n\u2502 \u2502 \u251c\u2500\u2500 Button.vue # Standard button component\n\u2502 \u2502 \u251c\u2500\u2500 Radio.vue # Standard radio button input\n\u2502 \u2502 \u251c\u2500\u2500 Select.vue # Standard dropdown input selector\n\u2502 \u2502 \u251c\u2500\u2500 Input.vue # Standard text field input component\n\u2502 \u2502 \u2570\u2500\u2500 Toggle.vue # Standard on / off toggle switch\n\u2502 \u251c\u2500\u2500 InteractiveEditor # Components for the interactive UI config editor\n\u2502 \u2502 \u251c\u2500\u2500 AddNewSectionLauncher # Button that launches the EditSection form, used for adding new section\n\u2502 \u2502 \u251c\u2500\u2500 EditAppConfig.vue # Form for editing appConfig\n\u2502 \u2502 \u251c\u2500\u2500 EditPageInfo.vue # Form for editing pageInfo\n\u2502 \u2502 \u251c\u2500\u2500 EditSection.vue # Form for adding / editing sections\n\u2502 \u2502 \u251c\u2500\u2500 EditItem.vue # Form for adding or editing items\n\u2502 \u2502 \u251c\u2500\u2500 EditModeSaveMenu.vue # The bar at the bottom of screen in edit mode, containing save buttons\n\u2502 \u2502 \u251c\u2500\u2500 EditModeTopBanner.vue # The bar at the top of screen in edit mode\n\u2502 \u2502 \u251c\u2500\u2500 ExportConfigMenu.vue # Modal for viewing / exporting edited config\n\u2502 \u2502 \u251c\u2500\u2500 MoveItemTo.vue # Form for moving / copying items to other sections\n\u2502 \u2502 \u2570\u2500\u2500 SaveCancelButtons.vue # Buttons visible in all the edit menus, to save or cancel changes\n\u2502 \u251c\u2500\u2500 LinkItems # Components for Sections and Link Items\n\u2502 \u2502 \u251c\u2500\u2500 Collapsable.vue # The collapsible functionality of sections\n\u2502 \u2502 \u251c\u2500\u2500 IframeModal.vue # Pop-up iframe modal, for viewing websites within the app\n\u2502 \u2502 \u251c\u2500\u2500 Item.vue # Main link item, which is displayed within an item group\n\u2502 \u2502 \u251c\u2500\u2500 ItemGroup.vue # Item group is a section containing icons\n\u2502 \u2502 \u251c\u2500\u2500 ItemIcon.vue # The icon used by both items and sections\n\u2502 \u2502 \u251c\u2500\u2500 ItemOpenMethodIcon.vue # A small icon, visible on hover, indicating opening method\n\u2502 \u2502 \u251c\u2500\u2500 ItemContextMenu.vue # The right-click menu, for showing Item opening methods and info\n\u2502 \u2502 \u251c\u2500\u2500 SectionContextMenu.vue # The right-click menu, for showing Section edit/ open options\n\u2502 \u2502 \u2570\u2500\u2500 StatusIndicator.vue # Traffic light dot, showing if app is online or down\n\u2502 \u251c\u2500\u2500 Minimal View # Components used for the startpage / minimal alternative view\n\u2502 \u2502 \u251c\u2500\u2500 MinimalHeading.vue # Title part of minimal view\n\u2502 \u2502 \u251c\u2500\u2500 MinimalSearch.vue # Search bar for minimal view\n\u2502 \u2502 \u2570\u2500\u2500 MinimalSection.vue # Tabbed-Item section for minimal view\n\u2502 \u251c\u2500\u2500 PageStrcture # Components relating the main structure of the page\n\u2502 \u2502 \u251c\u2500\u2500 Footer.vue # Footer, visible at the bottom of all pages\n\u2502 \u2502 \u251c\u2500\u2500 Header.vue # Header, visible at the top of pages, and includes title and nav\n\u2502 \u2502 \u251c\u2500\u2500 LoadingScreen.vue # Splash screen shown on first load\n\u2502 \u2502 \u251c\u2500\u2500 Nav.vue # Navigation bar, includes a list of links\n\u2502 \u2502 \u2570\u2500\u2500 PageTitle.vue # Page title and sub-title, visible within the Header\n\u2502 \u251c\u2500\u2500 Workspace # Components used for the multi-tasking/ Workspace view\n\u2502 \u2502 \u251c\u2500\u2500 MultiTaskingWeb.vue # When multi-tasking enabled, generates new iframe\n\u2502 \u2502 \u251c\u2500\u2500 SideBar.vue # The left sidebar for the workspace view\n\u2502 \u2502 \u251c\u2500\u2500 SideBarItem.vue # App item for the sidebar view\n\u2502 \u2502 \u251c\u2500\u2500 SideBarSection.vue # Collapsible collection of items within workspace sidebar\n\u2502 \u2502 \u251c\u2500\u2500 WebContent.vue # Workspace iframe view, displays content of current app\n\u2502 \u2502 \u2570\u2500\u2500 WidgetView.vue # Workspace container for displaying widgets in main content\n\u2502 \u251c\u2500\u2500 Widgets # Directory contains all custom widget components\n\u2502 \u2502 \u2570\u2500\u2500 .... # Too many to list, see widget docs instead\n\u2502 \u2570\u2500\u2500 Settings # Components relating to the quick-settings, in the top-right\n\u2502 \u251c\u2500\u2500 AuthButtons.vue # Logout button and other app info\n\u2502 \u251c\u2500\u2500 ConfigLauncher.vue # Icon that when clicked will launch the Configuration component\n\u2502 \u251c\u2500\u2500 CustomThemeMaker.vue # Color pickers for letting user build their own theme\n\u2502 \u251c\u2500\u2500 ItemSizeSelector.vue # Set of buttons used to set and save item size\n\u2502 \u251c\u2500\u2500 KeyboardShortcutInfo.vue# Small pop-up displaying the available keyboard shortcuts\n\u2502 \u251c\u2500\u2500 LanguageSwitcher.vue # Dropdown in a modal for changing app language\n\u2502 \u251c\u2500\u2500 LayoutSelector.vue # Set of buttons, letting the user select their desired layout\n\u2502 \u251c\u2500\u2500 SearchBar.vue # The input field in the header, used for searching the app\n\u2502 \u251c\u2500\u2500 SettingsContainer.vue # Container that wraps all the quick-settings components\n\u2502 \u2570\u2500\u2500 ThemeSelector.vue # Drop-down menu enabling the user to select and change themes\n\u251c\u2500\u2500 main.js # Main front-end entry point\n\u251c\u2500\u2500 registerServiceWorker.js # Registers and manages service workers, for PWA apps\n\u251c\u2500\u2500 router.js # Defines all available application routes\n\u251c\u2500\u2500 styles # Directory of all globally used common SCSS styles\n\u2502 \u251c\u2500\u2500 color-palette.scss # All color variable names and default values\n\u2502 \u251c\u2500\u2500 color-themes.scss # All variable values for built-in themes\n\u2502 \u251c\u2500\u2500 dimensions.scss # Dimensions and sizes as variables\n\u2502 \u251c\u2500\u2500 global-styles.scss # Basics and style resets used globally\n\u2502 \u251c\u2500\u2500 media-queries.scss # Screen sizes and media queries\n\u2502 \u251c\u2500\u2500 style-helpers.scss # SCSS functions used for modifying values\n\u2502 \u251c\u2500\u2500 typography.scss # Font and text styles used globally\n\u2502 \u2570\u2500\u2500 user-defined-themes.scss # Empty, put any custom styles or themes here\n\u251c\u2500\u2500 mixins # Reusable component bases, extended by other views / components\n\u2502 \u251c\u2500\u2500 ChartingMixin.js # Functions for rendering charts in widget components\n\u2502 \u251c\u2500\u2500 GlancesMixin.js # Functions for fetching system info from Glances for widgets\n\u2502 \u251c\u2500\u2500 HomeMixin.js # Functions for homepage, used by default, minimal and workspace views\n\u2502 \u2570\u2500\u2500 WidgetMixin.js # Functions for all widgets, like data fetching, updating and error handling\n\u251c\u2500\u2500 utils # Directory of re-used helper functions\n\u2502 \u251c\u2500\u2500 ArrowKeyNavigation.js # Functionality for arrow-key navigation\n\u2502 \u251c\u2500\u2500 Auth.js # Handles all authentication related actions\n\u2502 \u251c\u2500\u2500 CheckSectionVisibility.js # Checks which parts of the page should be visible/ hidden based on config\n\u2502 \u251c\u2500\u2500 ClickOutside.js # A directive for detecting click, used to hide dropdown, modal or context menu\n\u2502 \u251c\u2500\u2500 ConfigHelpers.js # Helper functions for managing configuration\n\u2502 \u251c\u2500\u2500 CloudBackup.js # Functionality for encrypting, processing and network calls\n\u2502 \u251c\u2500\u2500 ConfigSchema.json # The schema, used to validate the users conf.yml file\n\u2502 \u251c\u2500\u2500 ConfigAccumulator.js # Central place for managing and combining config\n\u2502 \u251c\u2500\u2500 ConfigHelpers.js # Collection of helper functions to process config using accumulator\n\u2502 \u251c\u2500\u2500 ConfigValidator.js # A helper script that validates the config file against schema\n\u2502 \u251c\u2500\u2500 CoolConsole.js # Prints info, warning and error messages to browser console, with a cool style\n\u2502 \u251c\u2500\u2500 defaults.js # Global constants and their default values\n\u2502 \u251c\u2500\u2500 emojis.json # List of emojis with unicode and shortcode, used for emoji icon feature\n\u2502 \u251c\u2500\u2500 EmojiUnicodeRegex.js # Regular expression to validate emoji unicode format, for emoji icons\n\u2502 \u251c\u2500\u2500 ErrorHandler.js # Helper function called when an error is returned\n\u2502 \u251c\u2500\u2500 InitServiceWorker.js # Initializes and manages service worker, if enabled\n\u2502 \u251c\u2500\u2500 Search.js # Helper functions for searching/ filtering items in all views\n\u2502 \u251c\u2500\u2500 JsonToYaml.js # Function that parses and converts raw JSON into valid YAML\n\u2502 \u251c\u2500\u2500 KeycloakAuth.js # Singleton class to manage Keycloak authentication\n\u2502 \u251c\u2500\u2500 OidcAuth.js # Manages OIDC authentication with external providers\n\u2502 \u251c\u2500\u2500 HeaderAuth.js # Handles header-based authentication via reverse proxy\n\u2502 \u251c\u2500\u2500 languages.js # Handles fetching, switching and validating languages\n\u2502 \u2570\u2500\u2500 ThemeHelper.js # Function that handles the fetching and setting of user themes\n\u2570\u2500\u2500 views # Directory of available pages, corresponding to available routes\n \u251c\u2500\u2500 Home.vue # The home page container\n \u251c\u2500\u2500 About.vue # About page\n \u251c\u2500\u2500 Login.vue # Authentication page\n \u251c\u2500\u2500 Minimal.vue # The minimal view\n \u251c\u2500\u2500 Workspace.vue # The workspace view with apps in sidebar\n \u251c\u2500\u2500 DownloadConfig.vue # Config export page\n \u2570\u2500\u2500 404.vue # Not found page\n"})}),"\n",(0,t.jsx)(n.h4,{id:"visualisation-of-source-directory",children:"Visualisation of Source Directory"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/repo-visualization.svg",alt:"File Breakdown"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"development-tools",children:"Development Tools"}),"\n",(0,t.jsx)(n.h3,{id:"performance---lighthouse",children:"Performance - Lighthouse"}),"\n",(0,t.jsx)(n.p,{children:"The easiest method of checking performance is to use Chromium's build in auditing tool, Lighthouse. To run the test, open Developer Tools (usually F12) --\x3e Lighthouse and click on the 'Generate Report' button at the bottom."}),"\n",(0,t.jsx)(n.h3,{id:"dependencies---bundlephobia",children:"Dependencies - BundlePhobia"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"https://bundlephobia.com/",children:"BundlePhobia"})," is a really useful app that lets you analyze the cost of adding any particular dependency to an application"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"notes-1",children:"Notes"}),"\n",(0,t.jsx)(n.h3,{id:"known-warnings",children:"Known Warnings"}),"\n",(0,t.jsx)(n.p,{children:"When running the build command, several warnings appear. These are not errors, and do not affect the security or performance of the application. They will be addressed in a future update"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"WARN A new version of sass-loader is available. Please upgrade for best experience."})," - Currently we're using an older version of SASS loader, since the more recent releases do not seem to be compatible with the Vue CLI's webpack configuration."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"WARN asset size limit: The following asset(s) exceed the recommended size limit (244 KiB)."})," - For the PWA to support Windows 10, a splash screen asset is required, and is quite large. This throws a warning, however PWA assets are not loaded until needed, so shouldn't have any impact on application performance. A similar warning is thrown for the Raleway font, and that is looking to be addressed."]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453(e,n,i){i.d(n,{R:()=>r,x:()=>a});var s=i(6540);const t={},o=s.createContext(t);function r(e){const n=s.useContext(o);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/72e14192.2cdb9209.js b/assets/js/72e14192.c9e76143.js similarity index 99% rename from assets/js/72e14192.2cdb9209.js rename to assets/js/72e14192.c9e76143.js index 27a5620b..047db93d 100644 --- a/assets/js/72e14192.2cdb9209.js +++ b/assets/js/72e14192.c9e76143.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[2814],{1953(e,s,n){n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"quick-start","title":"Quick Start","description":"Welcome to Dashy! So glad you\'re here \ud83d\ude0a In a couple of minutes, you\'ll have your new dashboard up and running \ud83d\ude80","source":"@site/docs/quick-start.md","sourceDirName":".","slug":"/quick-start","permalink":"/docs/quick-start","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/quick-start.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","next":{"title":"Deployment","permalink":"/docs/deployment"}}');var t=n(4848),o=n(8453);const r={},l="Quick Start",a={},c=[{value:"1. Prerequisites",id:"1-prerequisites",level:2},{value:"2. Installation",id:"2-installation",level:2},{value:"3. User Data Directory",id:"3-user-data-directory",level:2},{value:"4. Configure",id:"4-configure",level:2},{value:"5. Further Customisation",id:"5-further-customisation",level:2},{value:"6. Final Note",id:"6-final-note",level:2},{value:"Alternative Deployment Method 1 - From Source",id:"alternative-deployment-method-1---from-source",level:2},{value:"Alternative Deployment Method 2 - Netlify",id:"alternative-deployment-method-2---netlify",level:2},{value:"Alternative Deployment Method 3 - Cloud Services",id:"alternative-deployment-method-3---cloud-services",level:2}];function h(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"quick-start",children:"Quick Start"})}),"\n",(0,t.jsx)(s.p,{children:"Welcome to Dashy! So glad you're here \ud83d\ude0a In a couple of minutes, you'll have your new dashboard up and running \ud83d\ude80"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"TLDR;"})," Run ",(0,t.jsx)(s.code,{children:"docker run -p 8080:8080 lissy93/dashy"}),", then open ",(0,t.jsx)(s.code,{children:"http://localhost:8080"})]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"1-prerequisites",children:"1. Prerequisites"}),"\n",(0,t.jsxs)(s.p,{children:["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 ",(0,t.jsx)(s.a,{href:"https://docs.docker.com/get-docker/",children:"Docker Documentation"}),".\nIf 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 ",(0,t.jsx)(s.a,{href:"/docs/deployment",children:"Deployment Docs"}),"."]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"2-installation",children:"2. Installation"}),"\n",(0,t.jsx)(s.p,{children:"To pull the latest image, and build and start the app run:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-bash",children:"docker run -d \\\n -p 8080:8080 \\\n -v ~/my-conf.yml:/app/user-data/conf.yml \\\n --name my-dashboard \\\n --restart=always \\\n lissy93/dashy:latest\n"})}),"\n",(0,t.jsxs)(s.p,{children:["Either replace the -v path to point to your config file, or leave it out. For a full list of available options, then see ",(0,t.jsx)(s.a,{href:"/docs/deployment#deploy-with-docker",children:"Dashy with Docker"})," Docs. If you'd prefer to use Docker Compose, then see ",(0,t.jsx)(s.a,{href:"/docs/deployment#using-docker-compose",children:"Dashy with Docker Compose"})," Docs. Alternate registries, architectures and pinned versions are also supported."]}),"\n",(0,t.jsxs)(s.p,{children:["Your dashboard should now be up and running at ",(0,t.jsx)(s.code,{children:"http://localhost:8080"})," (or your servers IP address/ domain, and the port that you chose). The first time you build, it may take a few minutes."]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"3-user-data-directory",children:"3. User Data Directory"}),"\n",(0,t.jsxs)(s.p,{children:["Your config file should be placed inside ",(0,t.jsx)(s.code,{children:"user-data/"})," (in Docker, that's ",(0,t.jsx)(s.code,{children:"/app/user-data/"}),")."]}),"\n",(0,t.jsx)(s.p,{children:"This directory can also contain some optional assets you wish to use within your dashboard, like icons, fonts, styles, scripts, etc."}),"\n",(0,t.jsxs)(s.p,{children:["Any files placed here will be served up to the root of the domain, and override the contents of ",(0,t.jsx)(s.code,{children:"public/"}),".\nFor example, if you had ",(0,t.jsx)(s.code,{children:"user-data/favicon.ico"})," this would be accessible at ",(0,t.jsx)(s.code,{children:"http://my-dashy-instance.local/favicon.ico"})]}),"\n",(0,t.jsxs)(s.p,{children:["Example Files in ",(0,t.jsx)(s.code,{children:"user-data"}),":"]}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"conf.yml"})," - This is the only file that is compulsory, it's your main Dashy config"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"**.yml"})," - Include more config files, if you'd like to have multiple pages, see ",(0,t.jsx)(s.a,{href:"/docs/pages-and-sections#multi-page-support",children:"Multi-page support"})," for docs"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"favicon.ico"})," - The default favicon, shown in the browser's tab title"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"initialization.html"})," - Static HTML page displayed before the app has finished compiling, see ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/public/initialization.html",children:(0,t.jsx)(s.code,{children:"public/initialization.html"})})]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"robots.txt"})," - Search engine crawl rules, override this if you want your dashboard to be indexable"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"manifest.json"})," - PWA configuration file, for installing Dashy on mobile devices"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"index.html"})," - The main index page which initializes the client-side app, copy it from ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/public/index.html",children:(0,t.jsx)(s.code,{children:"/public/index.html"})})]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"**.html"})," - Write your own HTML pages, and access them at ",(0,t.jsx)(s.code,{children:"http://my-dashy-instance.local/my-page.html"})]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"fonts/"})," - Custom fonts (be sure to include the ones already in ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/master/public/fonts",children:(0,t.jsx)(s.code,{children:"public/fonts"})})]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"item-icons/"})," - To use your own icons for items on your dashboard, see ",(0,t.jsx)(s.a,{href:"/docs/icons#local-icons",children:"Icons --\x3e Local Icons"})]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"web-icons/"})," - Override Dashy logo"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"widget-resources/"})," - Fonts, icons and assets for custom widgets"]}),"\n"]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"4-configure",children:"4. Configure"}),"\n",(0,t.jsxs)(s.p,{children:["Now that you've got Dashy running, you are going to want to set it up with your own content.\nConfig is written in ",(0,t.jsx)(s.a,{href:"https://yaml.org/",children:"YAML Format"}),", and saved in ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/user-data/conf.yml",children:(0,t.jsx)(s.code,{children:"/user-data/conf.yml"})}),".\nThe format on the config file is pretty straight forward. There are four root attributes:"]}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/configuring#pageinfo",children:(0,t.jsx)(s.code,{children:"pageInfo"})})," - Dashboard meta data, like title, description, nav bar links and footer text"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/configuring#appconfig-optional",children:(0,t.jsx)(s.code,{children:"appConfig"})})," - Dashboard settings, like themes, authentication, language and customization"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/configuring#section",children:(0,t.jsx)(s.code,{children:"sections"})})," - An array of sections, each including an array of items"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/configuring#pages-optional",children:(0,t.jsx)(s.code,{children:"pages"})})," - Have multiples pages in your dashboard"]}),"\n"]}),"\n",(0,t.jsxs)(s.p,{children:["You can view a full list of all available config options in the ",(0,t.jsx)(s.a,{href:"/docs/configuring",children:"Configuring Docs"}),"."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-yaml",children:"pageInfo:\n title: Home Lab\nsections: # An array of sections\n- name: Example Section\n icon: far fa-rocket\n items:\n - title: GitHub\n description: Dashy source code and docs\n icon: fab fa-github\n url: https://github.com/Lissy93/dashy\n - title: Issues\n description: View open issues, or raise a new one\n icon: fas fa-bug\n url: https://github.com/Lissy93/dashy/issues\n- name: Local Services\n items:\n - title: Firewall\n icon: favicon\n url: http://192.168.1.1/\n - title: Game Server\n icon: https://i.ibb.co/710B3Yc/space-invader-x256.png\n url: http://192.168.130.1/\n"})}),"\n",(0,t.jsx)(s.p,{children:"Notes:"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:["You can use a Docker volume to pass a config file from your host system to the container\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:["E.g. ",(0,t.jsx)(s.code,{children:"-v ./host-system/my-local-conf.yml:/app/user-data/conf.yml"})]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(s.li,{children:"It's also possible to edit your config directly through the UI, and changes will be saved in this file"}),"\n",(0,t.jsxs)(s.li,{children:["Check your config against Dashy's schema, with ",(0,t.jsx)(s.code,{children:"docker exec -it [container-id] yarn validate-config"})]}),"\n",(0,t.jsxs)(s.li,{children:["You might find it helpful to look at some examples, a collection of which can be ",(0,t.jsx)(s.a,{href:"https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10",children:"found here"})]}),"\n",(0,t.jsx)(s.li,{children:"It's also possible to load a remote config, e.g. from a GitHub Gist"}),"\n"]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"5-further-customisation",children:"5. Further Customisation"}),"\n",(0,t.jsxs)(s.p,{children:["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 ",(0,t.jsx)(s.a,{href:"/docs/management",children:"Management Docs"}),"."]}),"\n",(0,t.jsx)(s.p,{children:"You might also want to check out the docs for specific features you'd like to use:"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/authentication",children:"Authentication"})," - Setting up authentication to protect your dashboard"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/alternate-views",children:"Alternate Views"})," - Using the startpage and workspace view"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/backup-restore",children:"Backup & Restore"})," - Guide to Dashy's cloud sync feature"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/icons",children:"Icons"})," - Outline of all available icon types for sections and items"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/multi-language-support",children:"Localisation"})," - How to change language, or add your own"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/status-indicators",children:"Status Indicators"})," - Using Dashy to monitor uptime and status of your apps"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/searching",children:"Search & Shortcuts"})," - Using instant filter, web search and custom hotkeys"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/theming",children:"Theming"})," - Complete guide to applying, writing and modifying themes and styles"]}),"\n"]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"6-final-note",children:"6. Final Note"}),"\n",(0,t.jsxs)(s.p,{children:["If you need any help or support in getting Dashy running, head over to the ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/discussions",children:"Discussions"})," page. If you think you've found a bug, please do ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/issues/new/choose",children:"raise it"})," so it can be fixed. For contact options, see the ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/.github/SUPPORT",children:"Support Page"}),"."]}),"\n",(0,t.jsxs)(s.p,{children:["If you're enjoying Dashy, and have a few minutes to spare, please do take a moment to look at the ",(0,t.jsx)(s.a,{href:"/docs/contributing",children:"Contributing Page"}),". Huge thanks to ",(0,t.jsx)(s.a,{href:"/docs/credits",children:"everyone"})," who has already helped out!"]}),"\n",(0,t.jsx)(s.p,{children:"Enjoy your dashboard :)"}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"alternative-deployment-method-1---from-source",children:"Alternative Deployment Method 1 - From Source"}),"\n",(0,t.jsxs)(s.p,{children:["You can also easily run the app on your system without Docker. For this ",(0,t.jsx)(s.a,{href:"https://git-scm.com/downloads",children:"Git"}),", ",(0,t.jsx)(s.a,{href:"https://nodejs.org/",children:"Node.js"}),", and ",(0,t.jsx)(s.a,{href:"https://yarnpkg.com/",children:"Yarn"})," are required."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-bash",children:"git clone https://github.com/Lissy93/dashy.git && cd dashy\nyarn # Install dependencies\nyarn build # Build the app\nyarn start # Start the app\n"})}),"\n",(0,t.jsxs)(s.p,{children:["Then edit ",(0,t.jsx)(s.code,{children:"./user-data/conf.yml"})]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"alternative-deployment-method-2---netlify",children:"Alternative Deployment Method 2 - Netlify"}),"\n",(0,t.jsxs)(s.p,{children:["Don't have a server? No problem! You can run Dashy for free on Netlify (as well as many ",(0,t.jsx)(s.a,{href:"/docs/deployment#deploy-to-cloud-service",children:"other cloud providers"}),"). All you need it a GitHub account."]}),"\n",(0,t.jsxs)(s.ol,{children:["\n",(0,t.jsx)(s.li,{children:"Fork Dashy's repository on GitHub"}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"https://app.netlify.com/login/",children:"Log in"})," to Netlify with GitHub"]}),"\n",(0,t.jsxs)(s.li,{children:['Click "New site from Git" and select your forked repo, then click ',(0,t.jsx)(s.strong,{children:"Deploy"}),"!"]}),"\n",(0,t.jsxs)(s.li,{children:["You can then edit the config in ",(0,t.jsx)(s.code,{children:"./user-data/conf.yml"})," in your repo, and Netlify will rebuild the app"]}),"\n"]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"alternative-deployment-method-3---cloud-services",children:"Alternative Deployment Method 3 - Cloud Services"}),"\n",(0,t.jsx)(s.p,{children:"Dashy supports 1-Click deployments on several popular cloud platforms. To spin up a new instance, just click a link below:"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/ZxtzrP3/netlify.png",width:"18"})," Deploy to Netlify"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://heroku.com/deploy?template=https://github.com/Lissy93/dashy",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/d2P1WZ7/heroku.png",width:"18"})," Deploy to Heroku"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://vercel.com/new/project?template=https://github.com/lissy93/dashy",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/Ld2FZzb/vercel.png",width:"18"})," Deploy to Vercel"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/xCHtzgh/render.png",width:"18"})," Deploy to Render"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/J7MGymY/googlecloud.png",width:"18"})," Deploy to GCP"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/HVWVYF7/docker.png",width:"18"})," Deploy to PWD"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://easypanel.io/docs/templates/dashy",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/7NxnM2P/easypanel.png",width:"18"})," Deploy to Easypanel"]})}),"\n"]})]})}function d(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},8453(e,s,n){n.d(s,{R:()=>r,x:()=>l});var i=n(6540);const t={},o=i.createContext(t);function r(e){const s=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[2814],{1953(e,s,n){n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"quick-start","title":"Quick Start","description":"Welcome to Dashy! So glad you\'re here \ud83d\ude0a In a couple of minutes, you\'ll have your new dashboard up and running \ud83d\ude80","source":"@site/docs/quick-start.md","sourceDirName":".","slug":"/quick-start","permalink":"/docs/quick-start","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/quick-start.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","next":{"title":"Deployment","permalink":"/docs/deployment"}}');var t=n(4848),o=n(8453);const r={},l="Quick Start",a={},c=[{value:"1. Prerequisites",id:"1-prerequisites",level:2},{value:"2. Installation",id:"2-installation",level:2},{value:"3. User Data Directory",id:"3-user-data-directory",level:2},{value:"4. Configure",id:"4-configure",level:2},{value:"5. Further Customisation",id:"5-further-customisation",level:2},{value:"6. Final Note",id:"6-final-note",level:2},{value:"Alternative Deployment Method 1 - From Source",id:"alternative-deployment-method-1---from-source",level:2},{value:"Alternative Deployment Method 2 - Netlify",id:"alternative-deployment-method-2---netlify",level:2},{value:"Alternative Deployment Method 3 - Cloud Services",id:"alternative-deployment-method-3---cloud-services",level:2}];function h(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"quick-start",children:"Quick Start"})}),"\n",(0,t.jsx)(s.p,{children:"Welcome to Dashy! So glad you're here \ud83d\ude0a In a couple of minutes, you'll have your new dashboard up and running \ud83d\ude80"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"TLDR;"})," Run ",(0,t.jsx)(s.code,{children:"docker run -p 8080:8080 lissy93/dashy"}),", then open ",(0,t.jsx)(s.code,{children:"http://localhost:8080"})]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"1-prerequisites",children:"1. Prerequisites"}),"\n",(0,t.jsxs)(s.p,{children:["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 ",(0,t.jsx)(s.a,{href:"https://docs.docker.com/get-docker/",children:"Docker Documentation"}),".\nIf 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 ",(0,t.jsx)(s.a,{href:"/docs/deployment",children:"Deployment Docs"}),"."]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"2-installation",children:"2. Installation"}),"\n",(0,t.jsx)(s.p,{children:"To pull the latest image, and build and start the app run:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-bash",children:"docker run -d \\\n -p 8080:8080 \\\n -v ~/my-conf.yml:/app/user-data/conf.yml \\\n --name my-dashboard \\\n --restart=always \\\n lissy93/dashy:latest\n"})}),"\n",(0,t.jsxs)(s.p,{children:["Either replace the -v path to point to your config file, or leave it out. For a full list of available options, then see ",(0,t.jsx)(s.a,{href:"/docs/deployment#deploy-with-docker",children:"Dashy with Docker"})," Docs. If you'd prefer to use Docker Compose, then see ",(0,t.jsx)(s.a,{href:"/docs/deployment#using-docker-compose",children:"Dashy with Docker Compose"})," Docs. Alternate registries, architectures and pinned versions are also supported."]}),"\n",(0,t.jsxs)(s.p,{children:["Your dashboard should now be up and running at ",(0,t.jsx)(s.code,{children:"http://localhost:8080"})," (or your servers IP address/ domain, and the port that you chose). The first time you build, it may take a few minutes."]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"3-user-data-directory",children:"3. User Data Directory"}),"\n",(0,t.jsxs)(s.p,{children:["Your config file should be placed inside ",(0,t.jsx)(s.code,{children:"user-data/"})," (in Docker, that's ",(0,t.jsx)(s.code,{children:"/app/user-data/"}),")."]}),"\n",(0,t.jsx)(s.p,{children:"This directory can also contain some optional assets you wish to use within your dashboard, like icons, fonts, styles, scripts, etc."}),"\n",(0,t.jsxs)(s.p,{children:["Any files placed here will be served up to the root of the domain, and override the contents of ",(0,t.jsx)(s.code,{children:"public/"}),".\nFor example, if you had ",(0,t.jsx)(s.code,{children:"user-data/favicon.ico"})," this would be accessible at ",(0,t.jsx)(s.code,{children:"http://my-dashy-instance.local/favicon.ico"})]}),"\n",(0,t.jsxs)(s.p,{children:["Example Files in ",(0,t.jsx)(s.code,{children:"user-data"}),":"]}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"conf.yml"})," - This is the only file that is compulsory, it's your main Dashy config"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"**.yml"})," - Include more config files, if you'd like to have multiple pages, see ",(0,t.jsx)(s.a,{href:"/docs/pages-and-sections#multi-page-support",children:"Multi-page support"})," for docs"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"favicon.ico"})," - The default favicon, shown in the browser's tab title"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"initialization.html"})," - Static HTML page displayed before the app has finished compiling, see ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/public/initialization.html",children:(0,t.jsx)(s.code,{children:"public/initialization.html"})})]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"robots.txt"})," - Search engine crawl rules, override this if you want your dashboard to be indexable"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"manifest.json"})," - PWA configuration file, for installing Dashy on mobile devices"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"index.html"})," - The main index page which initializes the client-side app, copy it from ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/public/index.html",children:(0,t.jsx)(s.code,{children:"/public/index.html"})})]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"**.html"})," - Write your own HTML pages, and access them at ",(0,t.jsx)(s.code,{children:"http://my-dashy-instance.local/my-page.html"})]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"fonts/"})," - Custom fonts (be sure to include the ones already in ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/master/public/fonts",children:(0,t.jsx)(s.code,{children:"public/fonts"})})]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"item-icons/"})," - To use your own icons for items on your dashboard, see ",(0,t.jsx)(s.a,{href:"/docs/icons#local-icons",children:"Icons --\x3e Local Icons"})]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"web-icons/"})," - Override Dashy logo"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"widget-resources/"})," - Fonts, icons and assets for custom widgets"]}),"\n"]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"4-configure",children:"4. Configure"}),"\n",(0,t.jsxs)(s.p,{children:["Now that you've got Dashy running, you are going to want to set it up with your own content.\nConfig is written in ",(0,t.jsx)(s.a,{href:"https://yaml.org/",children:"YAML Format"}),", and saved in ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/user-data/conf.yml",children:(0,t.jsx)(s.code,{children:"/user-data/conf.yml"})}),".\nThe format on the config file is pretty straight forward. There are four root attributes:"]}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/configuring#pageinfo",children:(0,t.jsx)(s.code,{children:"pageInfo"})})," - Dashboard meta data, like title, description, nav bar links and footer text"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/configuring#appconfig-optional",children:(0,t.jsx)(s.code,{children:"appConfig"})})," - Dashboard settings, like themes, authentication, language and customization"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/configuring#section",children:(0,t.jsx)(s.code,{children:"sections"})})," - An array of sections, each including an array of items"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/configuring#pages-optional",children:(0,t.jsx)(s.code,{children:"pages"})})," - Have multiples pages in your dashboard"]}),"\n"]}),"\n",(0,t.jsxs)(s.p,{children:["You can view a full list of all available config options in the ",(0,t.jsx)(s.a,{href:"/docs/configuring",children:"Configuring Docs"}),"."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-yaml",children:"pageInfo:\n title: Home Lab\nsections: # An array of sections\n- name: Example Section\n icon: far fa-rocket\n items:\n - title: GitHub\n description: Dashy source code and docs\n icon: fab fa-github\n url: https://github.com/Lissy93/dashy\n - title: Issues\n description: View open issues, or raise a new one\n icon: fas fa-bug\n url: https://github.com/Lissy93/dashy/issues\n- name: Local Services\n items:\n - title: Firewall\n icon: favicon\n url: http://192.168.1.1/\n - title: Game Server\n icon: https://i.ibb.co/710B3Yc/space-invader-x256.png\n url: http://192.168.130.1/\n"})}),"\n",(0,t.jsx)(s.p,{children:"Notes:"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:["You can use a Docker volume to pass a config file from your host system to the container\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:["E.g. ",(0,t.jsx)(s.code,{children:"-v ./host-system/my-local-conf.yml:/app/user-data/conf.yml"})]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(s.li,{children:"It's also possible to edit your config directly through the UI, and changes will be saved in this file"}),"\n",(0,t.jsxs)(s.li,{children:["Check your config against Dashy's schema, with ",(0,t.jsx)(s.code,{children:"docker exec -it [container-id] yarn validate-config"})]}),"\n",(0,t.jsxs)(s.li,{children:["You might find it helpful to look at some examples, a collection of which can be ",(0,t.jsx)(s.a,{href:"https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10",children:"found here"})]}),"\n",(0,t.jsx)(s.li,{children:"It's also possible to load a remote config, e.g. from a GitHub Gist"}),"\n"]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"5-further-customisation",children:"5. Further Customisation"}),"\n",(0,t.jsxs)(s.p,{children:["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 ",(0,t.jsx)(s.a,{href:"/docs/management",children:"Management Docs"}),"."]}),"\n",(0,t.jsx)(s.p,{children:"You might also want to check out the docs for specific features you'd like to use:"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/authentication",children:"Authentication"})," - Setting up authentication to protect your dashboard"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/alternate-views",children:"Alternate Views"})," - Using the startpage and workspace view"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/backup-restore",children:"Backup & Restore"})," - Guide to Dashy's cloud sync feature"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/icons",children:"Icons"})," - Outline of all available icon types for sections and items"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/multi-language-support",children:"Localisation"})," - How to change language, or add your own"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/status-indicators",children:"Status Indicators"})," - Using Dashy to monitor uptime and status of your apps"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/searching",children:"Search & Shortcuts"})," - Using instant filter, web search and custom hotkeys"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"/docs/theming",children:"Theming"})," - Complete guide to applying, writing and modifying themes and styles"]}),"\n"]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"6-final-note",children:"6. Final Note"}),"\n",(0,t.jsxs)(s.p,{children:["If you need any help or support in getting Dashy running, head over to the ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/discussions",children:"Discussions"})," page. If you think you've found a bug, please do ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/issues/new/choose",children:"raise it"})," so it can be fixed. For contact options, see the ",(0,t.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/.github/SUPPORT",children:"Support Page"}),"."]}),"\n",(0,t.jsxs)(s.p,{children:["If you're enjoying Dashy, and have a few minutes to spare, please do take a moment to look at the ",(0,t.jsx)(s.a,{href:"/docs/contributing",children:"Contributing Page"}),". Huge thanks to ",(0,t.jsx)(s.a,{href:"/docs/credits",children:"everyone"})," who has already helped out!"]}),"\n",(0,t.jsx)(s.p,{children:"Enjoy your dashboard :)"}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"alternative-deployment-method-1---from-source",children:"Alternative Deployment Method 1 - From Source"}),"\n",(0,t.jsxs)(s.p,{children:["You can also easily run the app on your system without Docker. For this ",(0,t.jsx)(s.a,{href:"https://git-scm.com/downloads",children:"Git"}),", ",(0,t.jsx)(s.a,{href:"https://nodejs.org/",children:"Node.js"}),", and ",(0,t.jsx)(s.a,{href:"https://yarnpkg.com/",children:"Yarn"})," are required."]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-bash",children:"git clone https://github.com/Lissy93/dashy.git && cd dashy\nyarn # Install dependencies\nyarn build # Build the app\nyarn start # Start the app\n"})}),"\n",(0,t.jsxs)(s.p,{children:["Then edit ",(0,t.jsx)(s.code,{children:"./user-data/conf.yml"})]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"alternative-deployment-method-2---netlify",children:"Alternative Deployment Method 2 - Netlify"}),"\n",(0,t.jsxs)(s.p,{children:["Don't have a server? No problem! You can run Dashy for free on Netlify (as well as many ",(0,t.jsx)(s.a,{href:"/docs/deployment#deploy-to-cloud-service",children:"other cloud providers"}),"). All you need it a GitHub account."]}),"\n",(0,t.jsxs)(s.ol,{children:["\n",(0,t.jsx)(s.li,{children:"Fork Dashy's repository on GitHub"}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"https://app.netlify.com/login/",children:"Log in"})," to Netlify with GitHub"]}),"\n",(0,t.jsxs)(s.li,{children:['Click "New site from Git" and select your forked repo, then click ',(0,t.jsx)(s.strong,{children:"Deploy"}),"!"]}),"\n",(0,t.jsxs)(s.li,{children:["You can then edit the config in ",(0,t.jsx)(s.code,{children:"./user-data/conf.yml"})," in your repo, and Netlify will rebuild the app"]}),"\n"]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"alternative-deployment-method-3---cloud-services",children:"Alternative Deployment Method 3 - Cloud Services"}),"\n",(0,t.jsx)(s.p,{children:"Dashy supports 1-Click deployments on several popular cloud platforms. To spin up a new instance, just click a link below:"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/ZxtzrP3/netlify.png",width:"18"})," Deploy to Netlify"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://heroku.com/deploy?template=https://github.com/Lissy93/dashy",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/d2P1WZ7/heroku.png",width:"18"})," Deploy to Heroku"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://vercel.com/new/project?template=https://github.com/lissy93/dashy",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/Ld2FZzb/vercel.png",width:"18"})," Deploy to Vercel"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/xCHtzgh/render.png",width:"18"})," Deploy to Render"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/J7MGymY/googlecloud.png",width:"18"})," Deploy to GCP"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/HVWVYF7/docker.png",width:"18"})," Deploy to PWD"]})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsxs)(s.a,{href:"https://easypanel.io/docs/templates/dashy",children:[(0,t.jsx)(s.img,{src:"https://i.ibb.co/7NxnM2P/easypanel.png",width:"18"})," Deploy to Easypanel"]})}),"\n"]})]})}function d(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},8453(e,s,n){n.d(s,{R:()=>r,x:()=>l});var i=n(6540);const t={},o=i.createContext(t);function r(e){const s=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/87124b4e.fbd759a4.js b/assets/js/87124b4e.b191a6a6.js similarity index 99% rename from assets/js/87124b4e.fbd759a4.js rename to assets/js/87124b4e.b191a6a6.js index 9e556765..9fa3d45c 100644 --- a/assets/js/87124b4e.fbd759a4.js +++ b/assets/js/87124b4e.b191a6a6.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[8278],{8030(e,t,s){s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>n,toc:()=>h});const n=JSON.parse('{"id":"status-indicators","title":"Status Indicators","description":"Dashy has an optional feature that can display a small icon next to each of your running services, indicating it\'s current status. This can be useful if you are using Dashy as your homelab\'s start page, as it gives you an overview of the health of each of your running services. The status feature will show response time, response code, online/ offline check and if applicable, a relevant error message.","source":"@site/docs/status-indicators.md","sourceDirName":".","slug":"/status-indicators","permalink":"/docs/status-indicators","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/status-indicators.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Theming","permalink":"/docs/theming"},"next":{"title":"Authentication","permalink":"/docs/authentication"}}');var i=s(4848),a=s(8453);const r={},o="Status Indicators",c={},h=[{value:"Enabling Status Indicators",id:"enabling-status-indicators",level:2},{value:"Continuous Checking",id:"continuous-checking",level:2},{value:"Using a Different Endpoint",id:"using-a-different-endpoint",level:2},{value:"Setting Custom Headers",id:"setting-custom-headers",level:2},{value:"Disabling Security",id:"disabling-security",level:2},{value:"Allowing Alternative Status Codes",id:"allowing-alternative-status-codes",level:2},{value:"Troubleshooting Failing Status Checks",id:"troubleshooting-failing-status-checks",level:2},{value:"How it Works",id:"how-it-works",level:2}];function l(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",img:"img",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"status-indicators",children:"Status Indicators"})}),"\n",(0,i.jsx)(t.p,{children:"Dashy has an optional feature that can display a small icon next to each of your running services, indicating it's current status. This can be useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. The status feature will show response time, response code, online/ offline check and if applicable, a relevant error message."}),"\n ",(0,i.jsx)(t.img,{width:"800",src:"/docs/assets/status-check-demo.gif"}),"\n",(0,i.jsx)(t.h2,{id:"enabling-status-indicators",children:"Enabling Status Indicators"}),"\n",(0,i.jsxs)(t.p,{children:["By default, this feature is off. If you do not want this feature, just don't add the ",(0,i.jsx)(t.code,{children:"statusCheck"})," to your conf.yml file, then no requests will be made."]}),"\n",(0,i.jsxs)(t.p,{children:["To enable status checks, you can either turn it on for all items, by setting ",(0,i.jsx)(t.code,{children:"appConfig.statusCheck: true"}),", like:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-yaml",children:"appConfig:\n statusCheck: true\n"})}),"\n",(0,i.jsxs)(t.p,{children:["Or you can enable/ disable it on a per-item basis, with the ",(0,i.jsx)(t.code,{children:"item[n].statusCheck"})," attribute"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-yaml",children:"sections:\n- name: Firewall\n items:\n - title: OPNsense\n description: Firewall Central Management\n icon: networking/opnsense.png\n url: https://192.168.1.1\n statusCheck: false\n - title: MalTrail\n description: Malicious traffic detection system\n icon: networking/maltrail.png\n url: http://192.168.1.1:8338\n statusCheck: true\n - title: Ntopng\n description: Network traffic probe and network use monitor\n icon: networking/ntop.png\n url: http://192.168.1.1:3001\n statusCheck: true\n"})}),"\n",(0,i.jsx)(t.h2,{id:"continuous-checking",children:"Continuous Checking"}),"\n",(0,i.jsxs)(t.p,{children:["By default, with status indicators enabled Dashy will check an applications status on page load, and will not keep indicators updated. This is usually desirable behavior. However, if you do want the status indicators to continue to poll your running services, this can be enabled by setting the ",(0,i.jsx)(t.code,{children:"statusCheckInterval"})," attribute. Here you define an interval as an integer in seconds, and Dashy will poll your apps every x seconds. Note that if this number is very low (below 5 seconds), you may notice the app running slightly slower."]}),"\n",(0,i.jsx)(t.p,{children:"The following example, will instruct Dashy to continuously check the status of your services every 20 seconds."}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-text",children:"appConfig:\n statusCheck: true\n statusCheckInterval: 20\n"})}),"\n",(0,i.jsx)(t.h2,{id:"using-a-different-endpoint",children:"Using a Different Endpoint"}),"\n",(0,i.jsx)(t.p,{children:"By default, the status checker will use the URL of each application being checked. In some situations, you may want to use a different endpoint for status checking. Similarly, some services provide a dedicated path for uptime monitoring."}),"\n",(0,i.jsxs)(t.p,{children:["You can set the ",(0,i.jsx)(t.code,{children:"statusCheckUrl"})," property on any given item in order to do this. The status checker will then ping that endpoint, instead of the apps main ",(0,i.jsx)(t.code,{children:"url"})," property."]}),"\n",(0,i.jsx)(t.h2,{id:"setting-custom-headers",children:"Setting Custom Headers"}),"\n",(0,i.jsxs)(t.p,{children:["If your service is responding with an error, despite being up and running, it is most likely because custom headers for authentication, authorization or encoding are required. You can define these headers under the ",(0,i.jsx)(t.code,{children:"statusCheckHeaders"})," property for any service. It should be defined as an object format, with the name of header as the key, and header content as the value.\nFor example, ",(0,i.jsx)(t.code,{children:"statusCheckHeaders: { 'X-Custom-Header': 'foobar' }"})]}),"\n",(0,i.jsx)(t.h2,{id:"disabling-security",children:"Disabling Security"}),"\n",(0,i.jsxs)(t.p,{children:["By default, (if you're using HTTPS) any requests to insecure or non-HTTPS content will be blocked. This will cause the status check to fail. If you trust the endpoint (e.g. you're self-hosting it), then you can disable this security measure for an individual item. This is done by setting ",(0,i.jsx)(t.code,{children:"statusCheckAllowInsecure: true"})]}),"\n",(0,i.jsx)(t.h2,{id:"allowing-alternative-status-codes",children:"Allowing Alternative Status Codes"}),"\n",(0,i.jsxs)(t.p,{children:["If you expect your service to return a status code that is not in the 2XX range, and still want the indicator to be green, then you can specify an expected status code under ",(0,i.jsx)(t.code,{children:"statusCheckAcceptCodes"})," for a given item. For example, ",(0,i.jsx)(t.code,{children:"statusCheckAcceptCodes: '403,418'"})]}),"\n",(0,i.jsx)(t.h2,{id:"troubleshooting-failing-status-checks",children:"Troubleshooting Failing Status Checks"}),"\n",(0,i.jsx)(t.p,{children:"If you're using status checks, and despite a given service being online, the check is displaying an error, there are a couple of things you can look at:"}),"\n",(0,i.jsxs)(t.p,{children:["If your service requires requests to include any authorization in the headers, then use the ",(0,i.jsx)(t.code,{children:"statusCheckHeaders"})," property, as described ",(0,i.jsx)(t.a,{href:"#setting-custom-headers",children:"above"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["If you are still having issues, it may be because your target application is blocking requests from Dashy's IP. This is a ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"CORS error"}),", and can be fixed by setting the headers on your target app, to include:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-text",children:"Access-Control-Allow-Origin: https://location-of-dashy/\nVary: Origin\n"})}),"\n",(0,i.jsxs)(t.p,{children:["If the URL you are checking has an unsigned certificate, or is not using HTTPS, then you may need to disable the rejection of insecure requests. This can be done by setting ",(0,i.jsx)(t.code,{children:"statusCheckAllowInsecure"})," to true for a given item."]}),"\n",(0,i.jsxs)(t.p,{children:["If your service is online, but responds with a status code that is not in the 2xx range, then you can use ",(0,i.jsx)(t.code,{children:"statusCheckAcceptCodes"})," to set an accepted status code."]}),"\n",(0,i.jsxs)(t.p,{children:["If you get an error, like ",(0,i.jsx)(t.code,{children:"Service Unavailable: Server resulted in a fatal error"}),", even when it's definitely online, this is most likely caused by missing the protocol. Don't forget to include ",(0,i.jsx)(t.code,{children:"https://"})," (or whatever protocol) before the URL, and ensure that if needed, you've specified the port."]}),"\n",(0,i.jsxs)(t.p,{children:["Running Dashy in HOST network mode, instead of BRIDGE will allow status check access to other services in HOST mode. For more info, see ",(0,i.jsx)(t.a,{href:"https://github.com/Lissy93/dashy/discussions/445",children:"#445"}),"."]}),"\n",(0,i.jsx)(t.p,{children:"If you have firewall rules configured, then ensure that they don't prevent Dashy from making requests to the other services you are trying to access."}),"\n",(0,i.jsxs)(t.p,{children:["Currently, the status check needs a page to be rendered, so if this URL in your browser does not return anything, then status checks will not work. This may be modified in the future, but in the meantime, a fix would be to make your own status service, which just checks if your app responds with whatever code you'd like, and then return a 200 plus renders an arbitrary message. Then just point ",(0,i.jsx)(t.code,{children:"statusCheckUrl"})," to your custom page."]}),"\n",(0,i.jsxs)(t.p,{children:["For further troubleshooting, use an application like ",(0,i.jsx)(t.a,{href:"https://postman.com",children:"Postman"})," to diagnose the issue. Set the parameter to ",(0,i.jsx)(t.code,{children:"GET"}),", and then make a call to: ",(0,i.jsx)(t.code,{children:"https://[url-of-dashy]/status-check/?&url=[service-url]"}),". Where the service URL must have first been encoded (e.g. with ",(0,i.jsx)(t.code,{children:"encodeURIComponent()"})," or ",(0,i.jsx)(t.a,{href:"https://www.urlencoder.io/",children:"urlencoder.io"}),")"]}),"\n",(0,i.jsx)(t.p,{children:"If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method."}),"\n",(0,i.jsx)(t.h2,{id:"how-it-works",children:"How it Works"}),"\n",(0,i.jsxs)(t.p,{children:["When the app is loaded, if ",(0,i.jsx)(t.code,{children:"appConfig.statusCheck: true"})," is set, or if any items have the ",(0,i.jsx)(t.code,{children:"statusCheck: true"})," enabled, then Dashy will make a request, to ",(0,i.jsx)(t.code,{children:"https://[your-host-name]/status-check?url=[address-or-servce]"})," (may al include GET params for headers and the secure flag), which in turn will ping that running service, and respond with a status code. Response time is calculated from the difference between start and end time of the request."]}),"\n",(0,i.jsx)(t.p,{children:"When the response completes, an indicator will display next to each item. The color denotes the status: Yellow while waiting for the response to return, green if request was successful, red if it failed, and grey if it was unable to make the request all together."}),"\n",(0,i.jsxs)(t.p,{children:["All requests are made straight from your server, there is no intermediary. So providing you are hosting Dashy yourself, and are checking the status of other self-hosted services, there shouldn't be any privacy concerns. Requests are made asynchronously, so this won't have any significant impact on page load speeds. However recurring requests (using ",(0,i.jsx)(t.code,{children:"statusCheckInterval"}),") may run more slowly if the interval between requests is very short."]})]})}function d(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453(e,t,s){s.d(t,{R:()=>r,x:()=>o});var n=s(6540);const i={},a=n.createContext(i);function r(e){const t=n.useContext(a);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[8278],{8030(e,t,s){s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>n,toc:()=>h});const n=JSON.parse('{"id":"status-indicators","title":"Status Indicators","description":"Dashy has an optional feature that can display a small icon next to each of your running services, indicating it\'s current status. This can be useful if you are using Dashy as your homelab\'s start page, as it gives you an overview of the health of each of your running services. The status feature will show response time, response code, online/ offline check and if applicable, a relevant error message.","source":"@site/docs/status-indicators.md","sourceDirName":".","slug":"/status-indicators","permalink":"/docs/status-indicators","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/status-indicators.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Theming","permalink":"/docs/theming"},"next":{"title":"Authentication","permalink":"/docs/authentication"}}');var i=s(4848),a=s(8453);const r={},o="Status Indicators",c={},h=[{value:"Enabling Status Indicators",id:"enabling-status-indicators",level:2},{value:"Continuous Checking",id:"continuous-checking",level:2},{value:"Using a Different Endpoint",id:"using-a-different-endpoint",level:2},{value:"Setting Custom Headers",id:"setting-custom-headers",level:2},{value:"Disabling Security",id:"disabling-security",level:2},{value:"Allowing Alternative Status Codes",id:"allowing-alternative-status-codes",level:2},{value:"Troubleshooting Failing Status Checks",id:"troubleshooting-failing-status-checks",level:2},{value:"How it Works",id:"how-it-works",level:2}];function l(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",img:"img",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"status-indicators",children:"Status Indicators"})}),"\n",(0,i.jsx)(t.p,{children:"Dashy has an optional feature that can display a small icon next to each of your running services, indicating it's current status. This can be useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. The status feature will show response time, response code, online/ offline check and if applicable, a relevant error message."}),"\n ",(0,i.jsx)(t.img,{width:"800",src:"/docs/assets/status-check-demo.gif"}),"\n",(0,i.jsx)(t.h2,{id:"enabling-status-indicators",children:"Enabling Status Indicators"}),"\n",(0,i.jsxs)(t.p,{children:["By default, this feature is off. If you do not want this feature, just don't add the ",(0,i.jsx)(t.code,{children:"statusCheck"})," to your conf.yml file, then no requests will be made."]}),"\n",(0,i.jsxs)(t.p,{children:["To enable status checks, you can either turn it on for all items, by setting ",(0,i.jsx)(t.code,{children:"appConfig.statusCheck: true"}),", like:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-yaml",children:"appConfig:\n statusCheck: true\n"})}),"\n",(0,i.jsxs)(t.p,{children:["Or you can enable/ disable it on a per-item basis, with the ",(0,i.jsx)(t.code,{children:"item[n].statusCheck"})," attribute"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-yaml",children:"sections:\n- name: Firewall\n items:\n - title: OPNsense\n description: Firewall Central Management\n icon: networking/opnsense.png\n url: https://192.168.1.1\n statusCheck: false\n - title: MalTrail\n description: Malicious traffic detection system\n icon: networking/maltrail.png\n url: http://192.168.1.1:8338\n statusCheck: true\n - title: Ntopng\n description: Network traffic probe and network use monitor\n icon: networking/ntop.png\n url: http://192.168.1.1:3001\n statusCheck: true\n"})}),"\n",(0,i.jsx)(t.h2,{id:"continuous-checking",children:"Continuous Checking"}),"\n",(0,i.jsxs)(t.p,{children:["By default, with status indicators enabled Dashy will check an applications status on page load, and will not keep indicators updated. This is usually desirable behavior. However, if you do want the status indicators to continue to poll your running services, this can be enabled by setting the ",(0,i.jsx)(t.code,{children:"statusCheckInterval"})," attribute. Here you define an interval as an integer in seconds, and Dashy will poll your apps every x seconds. Note that if this number is very low (below 5 seconds), you may notice the app running slightly slower."]}),"\n",(0,i.jsx)(t.p,{children:"The following example, will instruct Dashy to continuously check the status of your services every 20 seconds."}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-text",children:"appConfig:\n statusCheck: true\n statusCheckInterval: 20\n"})}),"\n",(0,i.jsx)(t.h2,{id:"using-a-different-endpoint",children:"Using a Different Endpoint"}),"\n",(0,i.jsx)(t.p,{children:"By default, the status checker will use the URL of each application being checked. In some situations, you may want to use a different endpoint for status checking. Similarly, some services provide a dedicated path for uptime monitoring."}),"\n",(0,i.jsxs)(t.p,{children:["You can set the ",(0,i.jsx)(t.code,{children:"statusCheckUrl"})," property on any given item in order to do this. The status checker will then ping that endpoint, instead of the apps main ",(0,i.jsx)(t.code,{children:"url"})," property."]}),"\n",(0,i.jsx)(t.h2,{id:"setting-custom-headers",children:"Setting Custom Headers"}),"\n",(0,i.jsxs)(t.p,{children:["If your service is responding with an error, despite being up and running, it is most likely because custom headers for authentication, authorization or encoding are required. You can define these headers under the ",(0,i.jsx)(t.code,{children:"statusCheckHeaders"})," property for any service. It should be defined as an object format, with the name of header as the key, and header content as the value.\nFor example, ",(0,i.jsx)(t.code,{children:"statusCheckHeaders: { 'X-Custom-Header': 'foobar' }"})]}),"\n",(0,i.jsx)(t.h2,{id:"disabling-security",children:"Disabling Security"}),"\n",(0,i.jsxs)(t.p,{children:["By default, (if you're using HTTPS) any requests to insecure or non-HTTPS content will be blocked. This will cause the status check to fail. If you trust the endpoint (e.g. you're self-hosting it), then you can disable this security measure for an individual item. This is done by setting ",(0,i.jsx)(t.code,{children:"statusCheckAllowInsecure: true"})]}),"\n",(0,i.jsx)(t.h2,{id:"allowing-alternative-status-codes",children:"Allowing Alternative Status Codes"}),"\n",(0,i.jsxs)(t.p,{children:["If you expect your service to return a status code that is not in the 2XX range, and still want the indicator to be green, then you can specify an expected status code under ",(0,i.jsx)(t.code,{children:"statusCheckAcceptCodes"})," for a given item. For example, ",(0,i.jsx)(t.code,{children:"statusCheckAcceptCodes: '403,418'"})]}),"\n",(0,i.jsx)(t.h2,{id:"troubleshooting-failing-status-checks",children:"Troubleshooting Failing Status Checks"}),"\n",(0,i.jsx)(t.p,{children:"If you're using status checks, and despite a given service being online, the check is displaying an error, there are a couple of things you can look at:"}),"\n",(0,i.jsxs)(t.p,{children:["If your service requires requests to include any authorization in the headers, then use the ",(0,i.jsx)(t.code,{children:"statusCheckHeaders"})," property, as described ",(0,i.jsx)(t.a,{href:"#setting-custom-headers",children:"above"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["If you are still having issues, it may be because your target application is blocking requests from Dashy's IP. This is a ",(0,i.jsx)(t.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"CORS error"}),", and can be fixed by setting the headers on your target app, to include:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-text",children:"Access-Control-Allow-Origin: https://location-of-dashy/\nVary: Origin\n"})}),"\n",(0,i.jsxs)(t.p,{children:["If the URL you are checking has an unsigned certificate, or is not using HTTPS, then you may need to disable the rejection of insecure requests. This can be done by setting ",(0,i.jsx)(t.code,{children:"statusCheckAllowInsecure"})," to true for a given item."]}),"\n",(0,i.jsxs)(t.p,{children:["If your service is online, but responds with a status code that is not in the 2xx range, then you can use ",(0,i.jsx)(t.code,{children:"statusCheckAcceptCodes"})," to set an accepted status code."]}),"\n",(0,i.jsxs)(t.p,{children:["If you get an error, like ",(0,i.jsx)(t.code,{children:"Service Unavailable: Server resulted in a fatal error"}),", even when it's definitely online, this is most likely caused by missing the protocol. Don't forget to include ",(0,i.jsx)(t.code,{children:"https://"})," (or whatever protocol) before the URL, and ensure that if needed, you've specified the port."]}),"\n",(0,i.jsxs)(t.p,{children:["Running Dashy in HOST network mode, instead of BRIDGE will allow status check access to other services in HOST mode. For more info, see ",(0,i.jsx)(t.a,{href:"https://github.com/Lissy93/dashy/discussions/445",children:"#445"}),"."]}),"\n",(0,i.jsx)(t.p,{children:"If you have firewall rules configured, then ensure that they don't prevent Dashy from making requests to the other services you are trying to access."}),"\n",(0,i.jsxs)(t.p,{children:["Currently, the status check needs a page to be rendered, so if this URL in your browser does not return anything, then status checks will not work. This may be modified in the future, but in the meantime, a fix would be to make your own status service, which just checks if your app responds with whatever code you'd like, and then return a 200 plus renders an arbitrary message. Then just point ",(0,i.jsx)(t.code,{children:"statusCheckUrl"})," to your custom page."]}),"\n",(0,i.jsxs)(t.p,{children:["For further troubleshooting, use an application like ",(0,i.jsx)(t.a,{href:"https://postman.com",children:"Postman"})," to diagnose the issue. Set the parameter to ",(0,i.jsx)(t.code,{children:"GET"}),", and then make a call to: ",(0,i.jsx)(t.code,{children:"https://[url-of-dashy]/status-check/?&url=[service-url]"}),". Where the service URL must have first been encoded (e.g. with ",(0,i.jsx)(t.code,{children:"encodeURIComponent()"})," or ",(0,i.jsx)(t.a,{href:"https://www.urlencoder.io/",children:"urlencoder.io"}),")"]}),"\n",(0,i.jsx)(t.p,{children:"If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method."}),"\n",(0,i.jsx)(t.h2,{id:"how-it-works",children:"How it Works"}),"\n",(0,i.jsxs)(t.p,{children:["When the app is loaded, if ",(0,i.jsx)(t.code,{children:"appConfig.statusCheck: true"})," is set, or if any items have the ",(0,i.jsx)(t.code,{children:"statusCheck: true"})," enabled, then Dashy will make a request, to ",(0,i.jsx)(t.code,{children:"https://[your-host-name]/status-check?url=[address-or-servce]"})," (may al include GET params for headers and the secure flag), which in turn will ping that running service, and respond with a status code. Response time is calculated from the difference between start and end time of the request."]}),"\n",(0,i.jsx)(t.p,{children:"When the response completes, an indicator will display next to each item. The color denotes the status: Yellow while waiting for the response to return, green if request was successful, red if it failed, and grey if it was unable to make the request all together."}),"\n",(0,i.jsxs)(t.p,{children:["All requests are made straight from your server, there is no intermediary. So providing you are hosting Dashy yourself, and are checking the status of other self-hosted services, there shouldn't be any privacy concerns. Requests are made asynchronously, so this won't have any significant impact on page load speeds. However recurring requests (using ",(0,i.jsx)(t.code,{children:"statusCheckInterval"}),") may run more slowly if the interval between requests is very short."]})]})}function d(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453(e,t,s){s.d(t,{R:()=>r,x:()=>o});var n=s(6540);const i={},a=n.createContext(i);function r(e){const t=n.useContext(a);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9b4185c1.4070b1b4.js b/assets/js/9b4185c1.6ac6ec81.js similarity index 99% rename from assets/js/9b4185c1.4070b1b4.js rename to assets/js/9b4185c1.6ac6ec81.js index d6d1dfac..0c3a9a4d 100644 --- a/assets/js/9b4185c1.4070b1b4.js +++ b/assets/js/9b4185c1.6ac6ec81.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[5330],{9356(e,s,i){i.r(s),i.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"privacy","title":"Privacy & Security","description":"Dashy was built with privacy in mind.","source":"@site/docs/privacy.md","sourceDirName":".","slug":"/privacy","permalink":"/docs/privacy","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/privacy.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Development Guides","permalink":"/docs/development-guides"},"next":{"title":"Credits","permalink":"/docs/credits"}}');var r=i(4848),t=i(8453);const o={},a="Privacy & Security",c={},l=[{value:"Contents",id:"contents",level:2},{value:"External Requests",id:"external-requests",level:2},{value:"Icons",id:"icons",level:3},{value:"Font Awesome",id:"font-awesome",level:4},{value:"Material Design Icons",id:"material-design-icons",level:4},{value:"Favicon Fetching",id:"favicon-fetching",level:4},{value:"Generative Icons",id:"generative-icons",level:4},{value:"Other Icons",id:"other-icons",level:4},{value:"Web Assets",id:"web-assets",level:4},{value:"Features",id:"features",level:3},{value:"Status Checking",id:"status-checking",level:4},{value:"Update Checks",id:"update-checks",level:4},{value:"Cloud Backup",id:"cloud-backup",level:4},{value:"Web Search",id:"web-search",level:4},{value:"Anonymous Error Reporting",id:"anonymous-error-reporting",level:4},{value:"Themes",id:"themes",level:3},{value:"Widgets",id:"widgets",level:3},{value:"Browser Storage",id:"browser-storage",level:2},{value:"Cookies",id:"cookies",level:3},{value:"Session Storage",id:"session-storage",level:3},{value:"Local Storage",id:"local-storage",level:3},{value:"Deleting Stored Data",id:"deleting-stored-data",level:3},{value:"Dependencies",id:"dependencies",level:2},{value:"Securing your Environment",id:"securing-your-environment",level:2},{value:"Security Features",id:"security-features",level:2},{value:"Subresource Integrity",id:"subresource-integrity",level:3},{value:"SSL",id:"ssl",level:3},{value:"Authentication",id:"authentication",level:3},{value:"Disabling Features",id:"disabling-features",level:2},{value:"Reporting a Security Issue",id:"reporting-a-security-issue",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",kbd:"kbd",li:"li",p:"p",strong:"strong",table:"table",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"privacy--security",children:"Privacy & Security"})}),"\n",(0,r.jsxs)(s.p,{children:["Dashy was built with privacy in mind.\nSelf-hosting your own apps and services is a great way to protect yourself from the mass data collection employed by big tech companies, and Dashy was designed to make self-hosting easier, by keeping your local services organized and accessible from a single place. The ",(0,r.jsx)(s.a,{href:"/docs/management",children:"management docs"})," contains a though guide on the steps you can take to secure your homelab."]}),"\n",(0,r.jsx)(s.p,{children:"Dashy operates on the premise, that no external data requests should ever be made, unless explicitly enabled by the user. In the interest of transparency, the code is 100% open source and clearly documented throughout."}),"\n\n\n\n\n\n\n",(0,r.jsx)(s.table,{children:(0,r.jsx)(s.thead,{children:(0,r.jsx)(s.tr,{children:(0,r.jsxs)(s.th,{children:["\ud83d\udd10 For privacy and security tips, check out another project of mine: ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/personal-security-checklist",children:"Personal Security Checklist"})})]})})})}),"\n",(0,r.jsx)(s.h2,{id:"contents",children:"Contents"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.a,{href:"#external-requests",children:"External Requests"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#icons",children:"Icons"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#themes",children:"Themes"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#widgets",children:"Widgets"})}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.a,{href:"#features",children:"Features"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#status-checking",children:"Status Checking"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#update-checks",children:"Update Checks"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#cloud-backup",children:"Cloud Backup"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#web-search",children:"Web Search"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#anonymous-error-reporting",children:"Error Reporting"})}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#browser-storage",children:"Browser Storage"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#dependencies",children:"App Dependencies"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#security-features",children:"Security Features"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#securing-your-environment",children:"Securing your Environment"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#reporting-a-security-issue",children:"Reporting a Security Issue"})}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"external-requests",children:"External Requests"}),"\n",(0,r.jsx)(s.p,{children:"By default, Dashy will not make any external requests, unless you configure it to. Some features (which are off by default) do require internat access, and this section outlines those features, the services used, and links to their privacy policies."}),"\n",(0,r.jsx)(s.p,{children:"The following section outlines all network requests that are made when certain features are enabled."}),"\n",(0,r.jsx)(s.h3,{id:"icons",children:"Icons"}),"\n",(0,r.jsx)(s.h4,{id:"font-awesome",children:"Font Awesome"}),"\n",(0,r.jsxs)(s.p,{children:["If either any of your sections, items or themes are using icons from font-awesome, then it will be automatically enabled. But you can also manually enable or disable it by setting ",(0,r.jsx)(s.code,{children:"appConfig.enableFontAwesome"})," to ",(0,r.jsx)(s.code,{children:"true"})," / ",(0,r.jsx)(s.code,{children:"false"}),". Requests are made directly to Font-Awesome CDN, for more info, see the ",(0,r.jsx)(s.a,{href:"https://fontawesome.com/privacy",children:"Font Awesome Privacy Policy"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"material-design-icons",children:"Material Design Icons"}),"\n",(0,r.jsxs)(s.p,{children:["If either any of your sections, items or themes are mdi icons, then it will be automatically enabled. But you can also manually enable or disable it by setting ",(0,r.jsx)(s.code,{children:"appConfig.enableMaterialDesignIcons"})," to ",(0,r.jsx)(s.code,{children:"true"})," / ",(0,r.jsx)(s.code,{children:"false"}),". Requests are made directly to Material-Design-Icons CDN, for more info, see the ",(0,r.jsx)(s.a,{href:"https://materialdesignicons.com/",children:"Material Design Icons Website"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"favicon-fetching",children:"Favicon Fetching"}),"\n",(0,r.jsxs)(s.p,{children:["If an item's icon is set to ",(0,r.jsx)(s.code,{children:"favicon"}),", then it will be auto-fetched from the corresponding URL. Since not all websites have their icon located at ",(0,r.jsx)(s.code,{children:"/favicon.ico"}),", and if they do, it's often very low resolution (like ",(0,r.jsx)(s.code,{children:"16 x 16 px"}),"). Therefore, the default behavior is for Dashy to check if the URL is public, and if so will use an API to fetch the favicon. For self-hosted services, the favicon will be fetched from the default path, and no external requests will be made."]}),"\n",(0,r.jsxs)(s.p,{children:["The default favicon API is ",(0,r.jsx)(s.a,{href:"https://favicon.allesedv.com/",children:"allesedv.com"}),", but this can be changed by setting ",(0,r.jsx)(s.code,{children:"appConfig.faviconApi"})," to an alternate source (",(0,r.jsx)(s.code,{children:"iconhorse"}),", ",(0,r.jsx)(s.code,{children:"faviconkit"}),", ",(0,r.jsx)(s.code,{children:"besticon"}),", ",(0,r.jsx)(s.code,{children:"duckduckgo"}),", ",(0,r.jsx)(s.code,{children:"google"})," and ",(0,r.jsx)(s.code,{children:"allesedv"})," are supported). If you do not want to use any API, then you can set this property to ",(0,r.jsx)(s.code,{children:"local"}),", and the favicon will be fetched from the default path. For hosted services, this will still incur an external request."]}),"\n",(0,r.jsx)(s.h4,{id:"generative-icons",children:"Generative Icons"}),"\n",(0,r.jsxs)(s.p,{children:["If an item has the icon set to ",(0,r.jsx)(s.code,{children:"generative"}),", then an external request it made to ",(0,r.jsx)(s.a,{href:"https://dicebear.com/",children:"Dice Bear"})," to fetch the uniquely generated icon. The URL of a given service is used as the key for generating the icon, but it is first hashed and encoded for basic privacy. For more info, please reference the ",(0,r.jsx)(s.a,{href:"https://avatars.dicebear.com/legal/privacy-policy",children:"Dicebear Privacy Policy"})]}),"\n",(0,r.jsxs)(s.p,{children:["As a fallback, if Dicebear fails, then ",(0,r.jsx)(s.a,{href:"https://evatar.io/",children:"Evatar"})," is used."]}),"\n",(0,r.jsx)(s.h4,{id:"other-icons",children:"Other Icons"}),"\n",(0,r.jsxs)(s.p,{children:["Section icons, item icons and app icons are able to accept a URL to a raw image, if the image is hosted online then an external request will be made. To avoid the need to make external requests for icon assets, you can either use a self-hosted CDN, or store your images within ",(0,r.jsx)(s.code,{children:"./public/item-icons"})," (which can be mounted as a volume if you're using Docker)."]}),"\n",(0,r.jsx)(s.h4,{id:"web-assets",children:"Web Assets"}),"\n",(0,r.jsx)(s.p,{children:"By default, all assets required by Dashy come bundled within the source, and so no external requests are made. If you add an additional font, which is imported from a CDN, then that will incur an external request. The same applies for other web assets, like external images, scripts or styles."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"features",children:"Features"}),"\n",(0,r.jsx)(s.h4,{id:"status-checking",children:"Status Checking"}),"\n",(0,r.jsx)(s.p,{children:"The status checking feature allows you to ping your apps/ services to check if they are currently operational."}),"\n",(0,r.jsx)(s.p,{children:"Dashy will ping your services directly, and does not rely on any third party. If you are checking the uptime status of a public/ hosted application, then please refer to that services privacy policy. For all self-hosted services, requests happen locally within your network, and are not external."}),"\n",(0,r.jsx)(s.h4,{id:"update-checks",children:"Update Checks"}),"\n",(0,r.jsxs)(s.p,{children:["When the application loads, it checks for updates. The results of which are displayed in the config menu of the UI. This was implemented because using a very outdated version of Dashy may have unfixed issues. Your version is fetched from the source (local request), but the latest version is fetched from GitHub, which is an external request. This can be disabled by setting ",(0,r.jsx)(s.code,{children:"appConfig.disableUpdateChecks: true"})]}),"\n",(0,r.jsx)(s.h4,{id:"cloud-backup",children:"Cloud Backup"}),"\n",(0,r.jsxs)(s.p,{children:["Dashy has an optional End-to-End encrypted ",(0,r.jsx)(s.a,{href:"/docs/backup-restore",children:"cloud backup feature"}),". No data is ever transmitted unless you actively enable this feature through the UI."]}),"\n",(0,r.jsxs)(s.p,{children:["All data is encrypted before being sent to the backend. This is done in ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/CloudBackup.js",children:(0,r.jsx)(s.code,{children:"CloudBackup.js"})}),", using ",(0,r.jsx)(s.a,{href:"https://github.com/brix/crypto-js",children:"crypto.js"}),"'s AES method, using the users chosen password as the key. The data is then sent to a ",(0,r.jsx)(s.a,{href:"https://developers.cloudflare.com/workers/learning/how-workers-works",children:"Cloudflare worker"})," (a platform for running serverless functions), and stored in a ",(0,r.jsx)(s.a,{href:"https://developers.cloudflare.com/workers/learning/how-kv-works",children:"KV"})," data store."]}),"\n",(0,r.jsx)(s.p,{children:"Your selected password never leaves your device, and is hashed before being compared. It is only possible to restore a configuration if you have both the backup ID and decryption password. Because the data is encrypted on the client-side (before being sent to the cloud), it is not possible for a man-in-the-middle, government entity, website owner, or even Cloudflare to be able read any of your data."}),"\n",(0,r.jsx)(s.h4,{id:"web-search",children:"Web Search"}),"\n",(0,r.jsxs)(s.p,{children:["Dashy has a primitive ",(0,r.jsx)(s.a,{href:"/docs/searching#web-search",children:"web search feature"}),". No external requests are made, instead you are redirected to your chosen search engine (defaults to DuckDuckGo), using your chosen opening method."]}),"\n",(0,r.jsxs)(s.p,{children:["This feature can be disabled under appConfig, with ",(0,r.jsx)(s.code,{children:"webSearch: { disableWebSearch: true }"})]}),"\n",(0,r.jsx)(s.h4,{id:"anonymous-error-reporting",children:"Anonymous Error Reporting"}),"\n",(0,r.jsxs)(s.p,{children:["Error reporting is disabled by default, and no data will ever be sent without your explicit consent. In fact, the error tracking code isn't even imported unless you have actively enabled it. ",(0,r.jsx)(s.a,{href:"https://github.com/getsentry/sentry",children:"Sentry"})," is used for this, it's an open source error tracking and performance monitoring tool, used to identify any issues which occur in the production app (if you enable it)."]}),"\n",(0,r.jsxs)(s.p,{children:["The crash report includes the file or line of code that triggered the error, and a 2-layer deep stack trace. Reoccurring errors will also include the following user information: OS type (Mac, Windows, Linux, Android or iOS) and browser type (Firefox, Chrome, IE, Safari). Data scrubbing is enabled. IP address will not be stored. If any potentially identifiable data ever finds its way into a crash report, it will be automatically and permanently erased. All statistics collected are anonymized and stored securely, and ae automatically deleted after 14 days. For more about privacy and security, see the ",(0,r.jsx)(s.a,{href:"https://sentry.io/security/",children:"Sentry Docs"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["Enabling anonymous error reporting helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. Error reporting is activated by setting ",(0,r.jsx)(s.code,{children:"appConfig.enableErrorReporting: true"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If you need to monitor bugs yourself, then you can ",(0,r.jsx)(s.a,{href:"https://develop.sentry.dev/self-hosted/",children:"self-host your own Sentry Server"}),", and use it by setting ",(0,r.jsx)(s.code,{children:"appConfig.sentryDsn"})," to your Sentry instances ",(0,r.jsx)(s.a,{href:"https://docs.sentry.io/product/sentry-basics/dsn-explainer/",children:"Data Source Name"}),", then just enable error reporting in Dashy."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"themes",children:"Themes"}),"\n",(0,r.jsx)(s.p,{children:"Certain themes may use external assets (such as fonts or images). Currently, this only applies the Adventure theme."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"widgets",children:"Widgets"}),"\n",(0,r.jsxs)(s.p,{children:["Dashy supports ",(0,r.jsx)(s.a,{href:"/docs/widgets",children:"Widgets"})," for displaying dynamic content. Below is a list of all widgets that make external data requests, along with the endpoint they call and a link to the Privacy Policy of that service."]}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#weather",children:"Weather"})})," and ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#weather-forecast",children:"Weather Forecast"})}),": ",(0,r.jsx)(s.code,{children:"https://api.openweathermap.org"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://openweather.co.uk/privacy-policy",children:"OWM Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#rss-feed",children:"RSS Feed"})}),": ",(0,r.jsx)(s.code,{children:"https://api.rss2json.com/v1/api.json"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://rss2json.com/privacy-policy",children:"Rss2Json Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#public-ip",children:"IP Address"})}),": ",(0,r.jsx)(s.code,{children:"https://ipapi.co/json"})," or ",(0,r.jsx)(s.code,{children:"http://ip-api.com/json"})," or ",(0,r.jsx)(s.code,{children:"https://api.ip2location.io/"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://ipgeolocation.io/privacy.html",children:"IPGeoLocation Privacy Policy"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://ip-api.com/docs/legal",children:"IP-API Privacy Policy"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://ip2location.io/privacy-policy",children:"IP2Location.io Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#ip-blacklist",children:"IP Blacklist"})}),": ",(0,r.jsx)(s.code,{children:"https://api.blacklistchecker.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://blacklistchecker.com/privacy",children:"Blacklist Checker Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#domain-monitor",children:"Domain Monitor"})}),": ",(0,r.jsx)(s.code,{children:"http://api.whoapi.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://whoapi.com/privacy-policy/",children:"WhoAPI Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#crypto-watch-list",children:"Crypto Watch List"})})," and ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#crypto-token-price-history",children:"Token Price History"})}),": ",(0,r.jsx)(s.code,{children:"https://api.coingecko.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.coingecko.com/en/privacy",children:"CoinGecko Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#wallet-balance",children:"Wallet Balance"})}),": ",(0,r.jsx)(s.code,{children:"https://api.blockcypher.com/"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.blockcypher.com/privacy.html",children:"BlockCypher Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#code-stats",children:"Code::Stats"})}),": ",(0,r.jsx)(s.code,{children:"https://codestats.net"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://codestats.net/tos#privacy",children:"Code::Stats Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#addyio",children:"addy.io"})}),": ",(0,r.jsx)(s.code,{children:"https://app.addy.io"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://addy.io/privacy/",children:"addy.io Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#vulnerability-feed",children:"Vulnerability Feed"})}),": ",(0,r.jsx)(s.code,{children:"https://www.cvedetails.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.cvedetails.com/privacy.php",children:"CVE Details Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#exchange-rates",children:"Exchange Rate"})}),": ",(0,r.jsx)(s.code,{children:"https://v6.exchangerate-api.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.exchangerate-api.com/terms",children:"ExchangeRateAPI Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#public-holidays",children:"Public Holidays"})}),": ",(0,r.jsx)(s.code,{children:"https://kayaposoft.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://github.com/jurajmajer/enrico",children:"jurajmajer/enrico"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#covid-19-status",children:"Covid-19 Status"})}),": ",(0,r.jsx)(s.code,{children:"https://codestats.net"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://github.com/disease-sh/api",children:"disease-sh/api"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#sports-scores",children:"Sports Scores"})}),": ",(0,r.jsx)(s.code,{children:"https://thesportsdb.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"No Policy Available"}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#news-headlines",children:"News Headlines"})}),": ",(0,r.jsx)(s.code,{children:"https://api.currentsapi.services"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://currentsapi.services/privacy",children:"CurrentsAPI Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#mullvad-status",children:"Mullvad Status"})}),": ",(0,r.jsx)(s.code,{children:"https://am.i.mullvad.net"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://mullvad.net/en/help/privacy-policy/",children:"Mullvad Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#tfl-status",children:"TFL Status"})}),": ",(0,r.jsx)(s.code,{children:"https://api.tfl.gov.uk"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://tfl.gov.uk/corporate/privacy-and-cookies/",children:"TFL Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#stock-price-history",children:"Stock Price History"})}),": ",(0,r.jsx)(s.code,{children:"https://alphavantage.co"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.alphavantage.co/privacy/",children:"AlphaVantage Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#eth-gas-prices",children:"ETH Gas Prices"})}),": ",(0,r.jsx)(s.code,{children:"https://ethgas.watch"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://github.com/wslyvh/ethgaswatch",children:"wslyvh/ethgaswatch"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#joke",children:"Joke"})}),": ",(0,r.jsx)(s.code,{children:"https://v2.jokeapi.dev"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://sv443.net/privacypolicy/en",children:"SV443's Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#flight-data",children:"Flight Data"})}),": ",(0,r.jsx)(s.code,{children:"https://aerodatabox.p.rapidapi.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.aerodatabox.com/#h.p_cxtiyzwf_wqd",children:"AeroDataBox Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#astronomy-picture-of-the-day",children:"Astronomy Picture of the Day"})}),": ",(0,r.jsx)(s.code,{children:"https://apodapi.herokuapp.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.nasa.gov/about/highlights/HP_Privacy.html",children:"NASA's Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#github-trending",children:"GitHub Trending"})})," and ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#github-profile-stats",children:"GitHub Profile Stats"})}),": ",(0,r.jsx)(s.code,{children:"https://api.github.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://docs.github.com/en/github/site-policy/github-privacy-statement",children:"GitHub's Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#cron-monitoring-health-checks",children:"Cron Monitoring (Health Checks)"})}),": ",(0,r.jsx)(s.code,{children:"https://healthchecks.io"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://healthchecks.io/privacy/",children:"Health-Checks Privacy Policy"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"browser-storage",children:"Browser Storage"}),"\n",(0,r.jsx)(s.p,{children:"In order for user preferences to be persisted between sessions, certain data needs to be stored in the browsers local storage. No personal info is kept here, none of this data can be accessed by other domains, and no data is ever sent to any server without your prior consent."}),"\n",(0,r.jsxs)(s.p,{children:["You can view and delete stored data by opening up the dev tools: ",(0,r.jsx)(s.kbd,{children:"F12"})," --\x3e ",(0,r.jsx)(s.code,{children:"Application"})," --\x3e ",(0,r.jsx)(s.code,{children:"Storage"}),"."]}),"\n",(0,r.jsx)(s.p,{children:"The following section outlines all data that is stored in the browsers, as cookies, session storage or local storage."}),"\n",(0,r.jsx)(s.h3,{id:"cookies",children:"Cookies"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/HTTP_cookie",children:"Cookies"})," will expire after their pre-defined lifetime"]}),"\n"]}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"AUTH_TOKEN"})," - A unique token, generated from a hash of users credentials, to verify they are authenticated. Only used when auth is enabled."]}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"session-storage",children:"Session Storage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage",children:"Session storage"})," is deleted when the current session ends (tab / window is closed)"]}),"\n"]}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"SW_STATUS"})," - The current status of any service workers"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"ERROR_LOG"})," - List of recent errors"]}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"local-storage",children:"Local Storage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage",children:"Local storage"})," is persisted between sessions, and only deleted when manually removed"]}),"\n"]}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"LANGUAGE"})," - The locale to show app text in"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"HIDE_INFO_NOTIFICATION"})," - Set to true once user dismissed welcome message, so that it's not shown again"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"LAYOUT_ORIENTATION"})," - Preferred section layout, either horizontal, vertical or auto"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"COLLAPSE_STATE"})," - Remembers which sections are collapsed"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"ICON_SIZE"})," - Size of items, either small, medium or large"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"THEME"})," - Users applied theme"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"CUSTOM_COLORS"})," - Any color modifications made to a given theme"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"BACKUP_ID"})," - If a backup has been made, the ID is stored here"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"BACKUP_HASH"})," - A unique hash of the previous backups meta data"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"HIDE_SETTINGS"})," - Lets user hide or show the settings menu"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"USERNAME"})," - If user logged in, store username. Only used to show welcome message, not used for auth"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"CONF_SECTIONS"})," - Array of sections, only used when user applies changes locally"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"PAGE_INFO"})," - Config page info, only used when user applies changes locally"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"APP_CONFIG"})," - App config, only used when user applies changes locally"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"MOST_USED"})," - If smart sort is used to order items by most used, store open count"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"LAST_USED"})," - If smart sort is used to order items by last used, store timestamps"]}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"deleting-stored-data",children:"Deleting Stored Data"}),"\n",(0,r.jsxs)(s.p,{children:["You can manually view and delete session storage, local storage and cookies at anytime. Fist ",(0,r.jsx)(s.a,{href:"/docs/troubleshooting#how-to-open-browser-console",children:"open"})," your browsers developer tools (usually ",(0,r.jsx)(s.kbd,{children:"F12"}),"), then under the Application tab select the storage category. Here you will see a list of stored data, and you can select any item and delete it."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"dependencies",children:"Dependencies"}),"\n",(0,r.jsxs)(s.p,{children:["As with most web projects, Dashy relies on several ",(0,r.jsx)(s.a,{href:"/docs/credits#dependencies",children:"dependencies"}),". For links to each, and a breakdown of their licenses, please see ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/.github/LEGAL",children:"Legal"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["Dependencies can introduce security vulnerabilities, but since all these packages are open source any issues are usually very quickly spotted. Dashy is using Snyk for dependency security monitoring, and you can see ",(0,r.jsx)(s.a,{href:"https://snyk.io/test/github/lissy93/dashy",children:"the latest report here"}),". If any issue is detected by Snyk, a note about it will appear at the top of the Readme, and will usually be fixed within 48 hours."]}),"\n",(0,r.jsxs)(s.p,{children:["Note that packages listed under ",(0,r.jsx)(s.code,{children:"devDependencies"})," section are only used for building the project, and are not included in the production environment."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"securing-your-environment",children:"Securing your Environment"}),"\n",(0,r.jsx)(s.p,{children:"Running your self-hosted applications in individual, containerized environments (such as containers or VMs) helps keep them isolated, and prevent an exploit in one service effecting another."}),"\n",(0,r.jsxs)(s.p,{children:["If you're running Dashy in a container, see ",(0,r.jsx)(s.a,{href:"/docs/management#container-security",children:"Management Docs --\x3e Container Security"})," for step-by-step security guide."]}),"\n",(0,r.jsx)(s.p,{children:"There is very little complexity involved with Dashy, and therefore the attack surface is reasonably small, but it is still important to follow best practices and employ monitoring for all your self-hosted apps. A couple of things that you should look at include:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"Use SSL for securing traffic in transit"}),"\n",(0,r.jsxs)(s.li,{children:["Configure ",(0,r.jsx)(s.a,{href:"/docs/authentication#alternative-authentication-methods",children:"authentication"})," to prevent unauthorized access"]}),"\n",(0,r.jsx)(s.li,{children:"Keep your system, software and Dashy up-to-date"}),"\n",(0,r.jsx)(s.li,{children:"Ensure your server is appropriately secured"}),"\n",(0,r.jsx)(s.li,{children:"Manage users and SSH correctly"}),"\n",(0,r.jsx)(s.li,{children:"Enable and configure firewall rules"}),"\n",(0,r.jsx)(s.li,{children:"Implement security, malware and traffic scanning"}),"\n",(0,r.jsx)(s.li,{children:"Setup malicious traffic detection"}),"\n",(0,r.jsxs)(s.li,{children:["Understand the ",(0,r.jsx)(s.a,{href:"https://docs.docker.com/engine/security/",children:"Docker attack fronts"}),", and follow ",(0,r.jsx)(s.a,{href:"https://snyk.io/blog/10-docker-image-security-best-practices/",children:"Docker Security Best Practices"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This is covered in more detail in ",(0,r.jsx)(s.a,{href:"/docs/management",children:"App Management"}),"."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"security-features",children:"Security Features"}),"\n",(0,r.jsx)(s.h3,{id:"subresource-integrity",children:"Subresource Integrity"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity",children:"Subresource Integrity"})," or SRI is a security feature that enables browsers to verify that resources they fetch are delivered without unexpected manipulation. It works by allowing you to provide a cryptographic hash that a fetched resource must match. This prevents the app from loading any resources that have been manipulated, by verifying the files hashes. It safeguards against the risk of an attacker injecting arbitrary malicious content into any files served up via a CDN."]}),"\n",(0,r.jsxs)(s.p,{children:["Dashy supports SRI, and it is recommended to enable this if you are hosting your dashboard via a public CDN. To enable SRI, set the ",(0,r.jsx)(s.code,{children:"INTEGRITY"})," environmental variable to ",(0,r.jsx)(s.code,{children:"true"}),"."]}),"\n",(0,r.jsx)(s.h3,{id:"ssl",children:"SSL"}),"\n",(0,r.jsxs)(s.p,{children:["Native SSL support is enabled, for setup instructions, see the ",(0,r.jsx)(s.a,{href:"/docs/management#ssl-certificates",children:"Management Docs"})]}),"\n",(0,r.jsx)(s.h3,{id:"authentication",children:"Authentication"}),"\n",(0,r.jsxs)(s.p,{children:["Dashy supports both basic auth, as well as server-based SSO using Keycloak. Full details of which, along with alternate authentication methods can be found in the ",(0,r.jsx)(s.a,{href:"/docs/authentication",children:"Authentication Docs"}),". If your dashboard is exposed to the internet and/ or contains any sensitive info it is strongly recommended to configure access control with Keycloak or another server-side method."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"disabling-features",children:"Disabling Features"}),"\n",(0,r.jsx)(s.p,{children:"You may wish to disable features that you don't want to use, if they involve storing data in the browser or making network requests."}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:["To disable smart-sort (uses local storage), set ",(0,r.jsx)(s.code,{children:"appConfig.disableSmartSort: true"})]}),"\n",(0,r.jsxs)(s.li,{children:["To disable update checks (makes external request to GH), set ",(0,r.jsx)(s.code,{children:"appConfig.disableUpdateChecks: true"})]}),"\n",(0,r.jsxs)(s.li,{children:["To disable web search (redirect to external / internal content), set ",(0,r.jsx)(s.code,{children:"appConfig.disableWebSearch: true"})]}),"\n",(0,r.jsxs)(s.li,{children:["To keep status checks disabled (external/ internal requests), set ",(0,r.jsx)(s.code,{children:"appConfig.statusCheck: false"})]}),"\n",(0,r.jsxs)(s.li,{children:["To keep font-awesome icons disabled (external requests), set ",(0,r.jsx)(s.code,{children:"appConfig.enableFontAwesome: false"})]}),"\n",(0,r.jsxs)(s.li,{children:["To keep error reporting disabled (external requests and data collection), set ",(0,r.jsx)(s.code,{children:"appConfig.enableErrorReporting: false"})]}),"\n",(0,r.jsxs)(s.li,{children:["To keep the service worker disabled (stores cache of app in browser data), set ",(0,r.jsx)(s.code,{children:"appConfig.enableServiceWorker: false"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"reporting-a-security-issue",children:"Reporting a Security Issue"}),"\n",(0,r.jsxs)(s.p,{children:["If you think you've found a critical issue with Dashy, please send an email to ",(0,r.jsx)(s.code,{children:"security@mail.alicia.omg.lol"}),". You can encrypt it, using ",(0,r.jsx)(s.a,{href:"https://keybase.io/aliciasykes/pgp_keys.asc?fingerprint=0688f8d34587d954e9e51fb8fedb68f55c0283a7",children:(0,r.jsx)(s.code,{children:"0688 F8D3 4587 D954 E9E5 1FB8 FEDB 68F5 5C02 83A7"})}),". You should receive a response within 48 hours. For more information, see ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/.github/SECURITY",children:"SECURITY.md"}),"."]}),"\n",(0,r.jsx)(s.p,{children:"All non-critical issues can be raised as a ticket."}),"\n",(0,r.jsx)(s.p,{children:"Please include the following information:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)"}),"\n",(0,r.jsx)(s.li,{children:"Full paths of source file(s) related to the manifestation of the issue"}),"\n",(0,r.jsx)(s.li,{children:"The location of the affected source code (tag/branch/commit or direct URL)"}),"\n",(0,r.jsx)(s.li,{children:"Any special configuration required to reproduce the issue"}),"\n",(0,r.jsx)(s.li,{children:"Step-by-step instructions to reproduce the issue"}),"\n",(0,r.jsx)(s.li,{children:"Proof-of-concept or exploit code (if possible)"}),"\n",(0,r.jsx)(s.li,{children:"Impact of the issue, including how an attacker might exploit the issue"}),"\n"]})]})}function h(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453(e,s,i){i.d(s,{R:()=>o,x:()=>a});var n=i(6540);const r={},t=n.createContext(r);function o(e){const s=n.useContext(t);return n.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),n.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[5330],{9356(e,s,i){i.r(s),i.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"privacy","title":"Privacy & Security","description":"Dashy was built with privacy in mind.","source":"@site/docs/privacy.md","sourceDirName":".","slug":"/privacy","permalink":"/docs/privacy","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/privacy.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Development Guides","permalink":"/docs/development-guides"},"next":{"title":"Credits","permalink":"/docs/credits"}}');var r=i(4848),t=i(8453);const o={},a="Privacy & Security",c={},l=[{value:"Contents",id:"contents",level:2},{value:"External Requests",id:"external-requests",level:2},{value:"Icons",id:"icons",level:3},{value:"Font Awesome",id:"font-awesome",level:4},{value:"Material Design Icons",id:"material-design-icons",level:4},{value:"Favicon Fetching",id:"favicon-fetching",level:4},{value:"Generative Icons",id:"generative-icons",level:4},{value:"Other Icons",id:"other-icons",level:4},{value:"Web Assets",id:"web-assets",level:4},{value:"Features",id:"features",level:3},{value:"Status Checking",id:"status-checking",level:4},{value:"Update Checks",id:"update-checks",level:4},{value:"Cloud Backup",id:"cloud-backup",level:4},{value:"Web Search",id:"web-search",level:4},{value:"Anonymous Error Reporting",id:"anonymous-error-reporting",level:4},{value:"Themes",id:"themes",level:3},{value:"Widgets",id:"widgets",level:3},{value:"Browser Storage",id:"browser-storage",level:2},{value:"Cookies",id:"cookies",level:3},{value:"Session Storage",id:"session-storage",level:3},{value:"Local Storage",id:"local-storage",level:3},{value:"Deleting Stored Data",id:"deleting-stored-data",level:3},{value:"Dependencies",id:"dependencies",level:2},{value:"Securing your Environment",id:"securing-your-environment",level:2},{value:"Security Features",id:"security-features",level:2},{value:"Subresource Integrity",id:"subresource-integrity",level:3},{value:"SSL",id:"ssl",level:3},{value:"Authentication",id:"authentication",level:3},{value:"Disabling Features",id:"disabling-features",level:2},{value:"Reporting a Security Issue",id:"reporting-a-security-issue",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",kbd:"kbd",li:"li",p:"p",strong:"strong",table:"table",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"privacy--security",children:"Privacy & Security"})}),"\n",(0,r.jsxs)(s.p,{children:["Dashy was built with privacy in mind.\nSelf-hosting your own apps and services is a great way to protect yourself from the mass data collection employed by big tech companies, and Dashy was designed to make self-hosting easier, by keeping your local services organized and accessible from a single place. The ",(0,r.jsx)(s.a,{href:"/docs/management",children:"management docs"})," contains a though guide on the steps you can take to secure your homelab."]}),"\n",(0,r.jsx)(s.p,{children:"Dashy operates on the premise, that no external data requests should ever be made, unless explicitly enabled by the user. In the interest of transparency, the code is 100% open source and clearly documented throughout."}),"\n\n\n\n\n\n\n",(0,r.jsx)(s.table,{children:(0,r.jsx)(s.thead,{children:(0,r.jsx)(s.tr,{children:(0,r.jsxs)(s.th,{children:["\ud83d\udd10 For privacy and security tips, check out another project of mine: ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/personal-security-checklist",children:"Personal Security Checklist"})})]})})})}),"\n",(0,r.jsx)(s.h2,{id:"contents",children:"Contents"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.a,{href:"#external-requests",children:"External Requests"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#icons",children:"Icons"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#themes",children:"Themes"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#widgets",children:"Widgets"})}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.a,{href:"#features",children:"Features"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#status-checking",children:"Status Checking"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#update-checks",children:"Update Checks"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#cloud-backup",children:"Cloud Backup"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#web-search",children:"Web Search"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#anonymous-error-reporting",children:"Error Reporting"})}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#browser-storage",children:"Browser Storage"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#dependencies",children:"App Dependencies"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#security-features",children:"Security Features"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#securing-your-environment",children:"Securing your Environment"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#reporting-a-security-issue",children:"Reporting a Security Issue"})}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"external-requests",children:"External Requests"}),"\n",(0,r.jsx)(s.p,{children:"By default, Dashy will not make any external requests, unless you configure it to. Some features (which are off by default) do require internat access, and this section outlines those features, the services used, and links to their privacy policies."}),"\n",(0,r.jsx)(s.p,{children:"The following section outlines all network requests that are made when certain features are enabled."}),"\n",(0,r.jsx)(s.h3,{id:"icons",children:"Icons"}),"\n",(0,r.jsx)(s.h4,{id:"font-awesome",children:"Font Awesome"}),"\n",(0,r.jsxs)(s.p,{children:["If either any of your sections, items or themes are using icons from font-awesome, then it will be automatically enabled. But you can also manually enable or disable it by setting ",(0,r.jsx)(s.code,{children:"appConfig.enableFontAwesome"})," to ",(0,r.jsx)(s.code,{children:"true"})," / ",(0,r.jsx)(s.code,{children:"false"}),". Requests are made directly to Font-Awesome CDN, for more info, see the ",(0,r.jsx)(s.a,{href:"https://fontawesome.com/privacy",children:"Font Awesome Privacy Policy"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"material-design-icons",children:"Material Design Icons"}),"\n",(0,r.jsxs)(s.p,{children:["If either any of your sections, items or themes are mdi icons, then it will be automatically enabled. But you can also manually enable or disable it by setting ",(0,r.jsx)(s.code,{children:"appConfig.enableMaterialDesignIcons"})," to ",(0,r.jsx)(s.code,{children:"true"})," / ",(0,r.jsx)(s.code,{children:"false"}),". Requests are made directly to Material-Design-Icons CDN, for more info, see the ",(0,r.jsx)(s.a,{href:"https://materialdesignicons.com/",children:"Material Design Icons Website"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"favicon-fetching",children:"Favicon Fetching"}),"\n",(0,r.jsxs)(s.p,{children:["If an item's icon is set to ",(0,r.jsx)(s.code,{children:"favicon"}),", then it will be auto-fetched from the corresponding URL. Since not all websites have their icon located at ",(0,r.jsx)(s.code,{children:"/favicon.ico"}),", and if they do, it's often very low resolution (like ",(0,r.jsx)(s.code,{children:"16 x 16 px"}),"). Therefore, the default behavior is for Dashy to check if the URL is public, and if so will use an API to fetch the favicon. For self-hosted services, the favicon will be fetched from the default path, and no external requests will be made."]}),"\n",(0,r.jsxs)(s.p,{children:["The default favicon API is ",(0,r.jsx)(s.a,{href:"https://favicon.allesedv.com/",children:"allesedv.com"}),", but this can be changed by setting ",(0,r.jsx)(s.code,{children:"appConfig.faviconApi"})," to an alternate source (",(0,r.jsx)(s.code,{children:"iconhorse"}),", ",(0,r.jsx)(s.code,{children:"faviconkit"}),", ",(0,r.jsx)(s.code,{children:"besticon"}),", ",(0,r.jsx)(s.code,{children:"duckduckgo"}),", ",(0,r.jsx)(s.code,{children:"google"})," and ",(0,r.jsx)(s.code,{children:"allesedv"})," are supported). If you do not want to use any API, then you can set this property to ",(0,r.jsx)(s.code,{children:"local"}),", and the favicon will be fetched from the default path. For hosted services, this will still incur an external request."]}),"\n",(0,r.jsx)(s.h4,{id:"generative-icons",children:"Generative Icons"}),"\n",(0,r.jsxs)(s.p,{children:["If an item has the icon set to ",(0,r.jsx)(s.code,{children:"generative"}),", then an external request it made to ",(0,r.jsx)(s.a,{href:"https://dicebear.com/",children:"Dice Bear"})," to fetch the uniquely generated icon. The URL of a given service is used as the key for generating the icon, but it is first hashed and encoded for basic privacy. For more info, please reference the ",(0,r.jsx)(s.a,{href:"https://avatars.dicebear.com/legal/privacy-policy",children:"Dicebear Privacy Policy"})]}),"\n",(0,r.jsxs)(s.p,{children:["As a fallback, if Dicebear fails, then ",(0,r.jsx)(s.a,{href:"https://evatar.io/",children:"Evatar"})," is used."]}),"\n",(0,r.jsx)(s.h4,{id:"other-icons",children:"Other Icons"}),"\n",(0,r.jsxs)(s.p,{children:["Section icons, item icons and app icons are able to accept a URL to a raw image, if the image is hosted online then an external request will be made. To avoid the need to make external requests for icon assets, you can either use a self-hosted CDN, or store your images within ",(0,r.jsx)(s.code,{children:"./public/item-icons"})," (which can be mounted as a volume if you're using Docker)."]}),"\n",(0,r.jsx)(s.h4,{id:"web-assets",children:"Web Assets"}),"\n",(0,r.jsx)(s.p,{children:"By default, all assets required by Dashy come bundled within the source, and so no external requests are made. If you add an additional font, which is imported from a CDN, then that will incur an external request. The same applies for other web assets, like external images, scripts or styles."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"features",children:"Features"}),"\n",(0,r.jsx)(s.h4,{id:"status-checking",children:"Status Checking"}),"\n",(0,r.jsx)(s.p,{children:"The status checking feature allows you to ping your apps/ services to check if they are currently operational."}),"\n",(0,r.jsx)(s.p,{children:"Dashy will ping your services directly, and does not rely on any third party. If you are checking the uptime status of a public/ hosted application, then please refer to that services privacy policy. For all self-hosted services, requests happen locally within your network, and are not external."}),"\n",(0,r.jsx)(s.h4,{id:"update-checks",children:"Update Checks"}),"\n",(0,r.jsxs)(s.p,{children:["When the application loads, it checks for updates. The results of which are displayed in the config menu of the UI. This was implemented because using a very outdated version of Dashy may have unfixed issues. Your version is fetched from the source (local request), but the latest version is fetched from GitHub, which is an external request. This can be disabled by setting ",(0,r.jsx)(s.code,{children:"appConfig.disableUpdateChecks: true"})]}),"\n",(0,r.jsx)(s.h4,{id:"cloud-backup",children:"Cloud Backup"}),"\n",(0,r.jsxs)(s.p,{children:["Dashy has an optional End-to-End encrypted ",(0,r.jsx)(s.a,{href:"/docs/backup-restore",children:"cloud backup feature"}),". No data is ever transmitted unless you actively enable this feature through the UI."]}),"\n",(0,r.jsxs)(s.p,{children:["All data is encrypted before being sent to the backend. This is done in ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/CloudBackup.js",children:(0,r.jsx)(s.code,{children:"CloudBackup.js"})}),", using ",(0,r.jsx)(s.a,{href:"https://github.com/brix/crypto-js",children:"crypto.js"}),"'s AES method, using the users chosen password as the key. The data is then sent to a ",(0,r.jsx)(s.a,{href:"https://developers.cloudflare.com/workers/learning/how-workers-works",children:"Cloudflare worker"})," (a platform for running serverless functions), and stored in a ",(0,r.jsx)(s.a,{href:"https://developers.cloudflare.com/workers/learning/how-kv-works",children:"KV"})," data store."]}),"\n",(0,r.jsx)(s.p,{children:"Your selected password never leaves your device, and is hashed before being compared. It is only possible to restore a configuration if you have both the backup ID and decryption password. Because the data is encrypted on the client-side (before being sent to the cloud), it is not possible for a man-in-the-middle, government entity, website owner, or even Cloudflare to be able read any of your data."}),"\n",(0,r.jsx)(s.h4,{id:"web-search",children:"Web Search"}),"\n",(0,r.jsxs)(s.p,{children:["Dashy has a primitive ",(0,r.jsx)(s.a,{href:"/docs/searching#web-search",children:"web search feature"}),". No external requests are made, instead you are redirected to your chosen search engine (defaults to DuckDuckGo), using your chosen opening method."]}),"\n",(0,r.jsxs)(s.p,{children:["This feature can be disabled under appConfig, with ",(0,r.jsx)(s.code,{children:"webSearch: { disableWebSearch: true }"})]}),"\n",(0,r.jsx)(s.h4,{id:"anonymous-error-reporting",children:"Anonymous Error Reporting"}),"\n",(0,r.jsxs)(s.p,{children:["Error reporting is disabled by default, and no data will ever be sent without your explicit consent. In fact, the error tracking code isn't even imported unless you have actively enabled it. ",(0,r.jsx)(s.a,{href:"https://github.com/getsentry/sentry",children:"Sentry"})," is used for this, it's an open source error tracking and performance monitoring tool, used to identify any issues which occur in the production app (if you enable it)."]}),"\n",(0,r.jsxs)(s.p,{children:["The crash report includes the file or line of code that triggered the error, and a 2-layer deep stack trace. Reoccurring errors will also include the following user information: OS type (Mac, Windows, Linux, Android or iOS) and browser type (Firefox, Chrome, IE, Safari). Data scrubbing is enabled. IP address will not be stored. If any potentially identifiable data ever finds its way into a crash report, it will be automatically and permanently erased. All statistics collected are anonymized and stored securely, and ae automatically deleted after 14 days. For more about privacy and security, see the ",(0,r.jsx)(s.a,{href:"https://sentry.io/security/",children:"Sentry Docs"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["Enabling anonymous error reporting helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. Error reporting is activated by setting ",(0,r.jsx)(s.code,{children:"appConfig.enableErrorReporting: true"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If you need to monitor bugs yourself, then you can ",(0,r.jsx)(s.a,{href:"https://develop.sentry.dev/self-hosted/",children:"self-host your own Sentry Server"}),", and use it by setting ",(0,r.jsx)(s.code,{children:"appConfig.sentryDsn"})," to your Sentry instances ",(0,r.jsx)(s.a,{href:"https://docs.sentry.io/product/sentry-basics/dsn-explainer/",children:"Data Source Name"}),", then just enable error reporting in Dashy."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"themes",children:"Themes"}),"\n",(0,r.jsx)(s.p,{children:"Certain themes may use external assets (such as fonts or images). Currently, this only applies the Adventure theme."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"widgets",children:"Widgets"}),"\n",(0,r.jsxs)(s.p,{children:["Dashy supports ",(0,r.jsx)(s.a,{href:"/docs/widgets",children:"Widgets"})," for displaying dynamic content. Below is a list of all widgets that make external data requests, along with the endpoint they call and a link to the Privacy Policy of that service."]}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#weather",children:"Weather"})})," and ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#weather-forecast",children:"Weather Forecast"})}),": ",(0,r.jsx)(s.code,{children:"https://api.openweathermap.org"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://openweather.co.uk/privacy-policy",children:"OWM Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#rss-feed",children:"RSS Feed"})}),": ",(0,r.jsx)(s.code,{children:"https://api.rss2json.com/v1/api.json"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://rss2json.com/privacy-policy",children:"Rss2Json Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#public-ip",children:"IP Address"})}),": ",(0,r.jsx)(s.code,{children:"https://ipapi.co/json"})," or ",(0,r.jsx)(s.code,{children:"http://ip-api.com/json"})," or ",(0,r.jsx)(s.code,{children:"https://api.ip2location.io/"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://ipgeolocation.io/privacy.html",children:"IPGeoLocation Privacy Policy"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://ip-api.com/docs/legal",children:"IP-API Privacy Policy"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://ip2location.io/privacy-policy",children:"IP2Location.io Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#ip-blacklist",children:"IP Blacklist"})}),": ",(0,r.jsx)(s.code,{children:"https://api.blacklistchecker.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://blacklistchecker.com/privacy",children:"Blacklist Checker Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#domain-monitor",children:"Domain Monitor"})}),": ",(0,r.jsx)(s.code,{children:"http://api.whoapi.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://whoapi.com/privacy-policy/",children:"WhoAPI Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#crypto-watch-list",children:"Crypto Watch List"})})," and ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#crypto-token-price-history",children:"Token Price History"})}),": ",(0,r.jsx)(s.code,{children:"https://api.coingecko.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.coingecko.com/en/privacy",children:"CoinGecko Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#wallet-balance",children:"Wallet Balance"})}),": ",(0,r.jsx)(s.code,{children:"https://api.blockcypher.com/"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.blockcypher.com/privacy.html",children:"BlockCypher Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#code-stats",children:"Code::Stats"})}),": ",(0,r.jsx)(s.code,{children:"https://codestats.net"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://codestats.net/tos#privacy",children:"Code::Stats Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#addyio",children:"addy.io"})}),": ",(0,r.jsx)(s.code,{children:"https://app.addy.io"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://addy.io/privacy/",children:"addy.io Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#vulnerability-feed",children:"Vulnerability Feed"})}),": ",(0,r.jsx)(s.code,{children:"https://www.cvedetails.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.cvedetails.com/privacy.php",children:"CVE Details Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#exchange-rates",children:"Exchange Rate"})}),": ",(0,r.jsx)(s.code,{children:"https://v6.exchangerate-api.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.exchangerate-api.com/terms",children:"ExchangeRateAPI Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#public-holidays",children:"Public Holidays"})}),": ",(0,r.jsx)(s.code,{children:"https://kayaposoft.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://github.com/jurajmajer/enrico",children:"jurajmajer/enrico"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#covid-19-status",children:"Covid-19 Status"})}),": ",(0,r.jsx)(s.code,{children:"https://codestats.net"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://github.com/disease-sh/api",children:"disease-sh/api"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#sports-scores",children:"Sports Scores"})}),": ",(0,r.jsx)(s.code,{children:"https://thesportsdb.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"No Policy Available"}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#news-headlines",children:"News Headlines"})}),": ",(0,r.jsx)(s.code,{children:"https://api.currentsapi.services"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://currentsapi.services/privacy",children:"CurrentsAPI Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#mullvad-status",children:"Mullvad Status"})}),": ",(0,r.jsx)(s.code,{children:"https://am.i.mullvad.net"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://mullvad.net/en/help/privacy-policy/",children:"Mullvad Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#tfl-status",children:"TFL Status"})}),": ",(0,r.jsx)(s.code,{children:"https://api.tfl.gov.uk"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://tfl.gov.uk/corporate/privacy-and-cookies/",children:"TFL Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#stock-price-history",children:"Stock Price History"})}),": ",(0,r.jsx)(s.code,{children:"https://alphavantage.co"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.alphavantage.co/privacy/",children:"AlphaVantage Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#eth-gas-prices",children:"ETH Gas Prices"})}),": ",(0,r.jsx)(s.code,{children:"https://ethgas.watch"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://github.com/wslyvh/ethgaswatch",children:"wslyvh/ethgaswatch"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#joke",children:"Joke"})}),": ",(0,r.jsx)(s.code,{children:"https://v2.jokeapi.dev"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://sv443.net/privacypolicy/en",children:"SV443's Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#flight-data",children:"Flight Data"})}),": ",(0,r.jsx)(s.code,{children:"https://aerodatabox.p.rapidapi.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.aerodatabox.com/#h.p_cxtiyzwf_wqd",children:"AeroDataBox Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#astronomy-picture-of-the-day",children:"Astronomy Picture of the Day"})}),": ",(0,r.jsx)(s.code,{children:"https://apodapi.herokuapp.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://www.nasa.gov/about/highlights/HP_Privacy.html",children:"NASA's Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#github-trending",children:"GitHub Trending"})})," and ",(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#github-profile-stats",children:"GitHub Profile Stats"})}),": ",(0,r.jsx)(s.code,{children:"https://api.github.com"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://docs.github.com/en/github/site-policy/github-privacy-statement",children:"GitHub's Privacy Policy"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/docs/widgets#cron-monitoring-health-checks",children:"Cron Monitoring (Health Checks)"})}),": ",(0,r.jsx)(s.code,{children:"https://healthchecks.io"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://healthchecks.io/privacy/",children:"Health-Checks Privacy Policy"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"browser-storage",children:"Browser Storage"}),"\n",(0,r.jsx)(s.p,{children:"In order for user preferences to be persisted between sessions, certain data needs to be stored in the browsers local storage. No personal info is kept here, none of this data can be accessed by other domains, and no data is ever sent to any server without your prior consent."}),"\n",(0,r.jsxs)(s.p,{children:["You can view and delete stored data by opening up the dev tools: ",(0,r.jsx)(s.kbd,{children:"F12"})," --\x3e ",(0,r.jsx)(s.code,{children:"Application"})," --\x3e ",(0,r.jsx)(s.code,{children:"Storage"}),"."]}),"\n",(0,r.jsx)(s.p,{children:"The following section outlines all data that is stored in the browsers, as cookies, session storage or local storage."}),"\n",(0,r.jsx)(s.h3,{id:"cookies",children:"Cookies"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/HTTP_cookie",children:"Cookies"})," will expire after their pre-defined lifetime"]}),"\n"]}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"AUTH_TOKEN"})," - A unique token, generated from a hash of users credentials, to verify they are authenticated. Only used when auth is enabled."]}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"session-storage",children:"Session Storage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage",children:"Session storage"})," is deleted when the current session ends (tab / window is closed)"]}),"\n"]}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"SW_STATUS"})," - The current status of any service workers"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"ERROR_LOG"})," - List of recent errors"]}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"local-storage",children:"Local Storage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage",children:"Local storage"})," is persisted between sessions, and only deleted when manually removed"]}),"\n"]}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"LANGUAGE"})," - The locale to show app text in"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"HIDE_INFO_NOTIFICATION"})," - Set to true once user dismissed welcome message, so that it's not shown again"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"LAYOUT_ORIENTATION"})," - Preferred section layout, either horizontal, vertical or auto"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"COLLAPSE_STATE"})," - Remembers which sections are collapsed"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"ICON_SIZE"})," - Size of items, either small, medium or large"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"THEME"})," - Users applied theme"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"CUSTOM_COLORS"})," - Any color modifications made to a given theme"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"BACKUP_ID"})," - If a backup has been made, the ID is stored here"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"BACKUP_HASH"})," - A unique hash of the previous backups meta data"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"HIDE_SETTINGS"})," - Lets user hide or show the settings menu"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"USERNAME"})," - If user logged in, store username. Only used to show welcome message, not used for auth"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"CONF_SECTIONS"})," - Array of sections, only used when user applies changes locally"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"PAGE_INFO"})," - Config page info, only used when user applies changes locally"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"APP_CONFIG"})," - App config, only used when user applies changes locally"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"MOST_USED"})," - If smart sort is used to order items by most used, store open count"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"LAST_USED"})," - If smart sort is used to order items by last used, store timestamps"]}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"deleting-stored-data",children:"Deleting Stored Data"}),"\n",(0,r.jsxs)(s.p,{children:["You can manually view and delete session storage, local storage and cookies at anytime. Fist ",(0,r.jsx)(s.a,{href:"/docs/troubleshooting#how-to-open-browser-console",children:"open"})," your browsers developer tools (usually ",(0,r.jsx)(s.kbd,{children:"F12"}),"), then under the Application tab select the storage category. Here you will see a list of stored data, and you can select any item and delete it."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"dependencies",children:"Dependencies"}),"\n",(0,r.jsxs)(s.p,{children:["As with most web projects, Dashy relies on several ",(0,r.jsx)(s.a,{href:"/docs/credits#dependencies",children:"dependencies"}),". For links to each, and a breakdown of their licenses, please see ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/.github/LEGAL",children:"Legal"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["Dependencies can introduce security vulnerabilities, but since all these packages are open source any issues are usually very quickly spotted. Dashy is using Snyk for dependency security monitoring, and you can see ",(0,r.jsx)(s.a,{href:"https://snyk.io/test/github/lissy93/dashy",children:"the latest report here"}),". If any issue is detected by Snyk, a note about it will appear at the top of the Readme, and will usually be fixed within 48 hours."]}),"\n",(0,r.jsxs)(s.p,{children:["Note that packages listed under ",(0,r.jsx)(s.code,{children:"devDependencies"})," section are only used for building the project, and are not included in the production environment."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"securing-your-environment",children:"Securing your Environment"}),"\n",(0,r.jsx)(s.p,{children:"Running your self-hosted applications in individual, containerized environments (such as containers or VMs) helps keep them isolated, and prevent an exploit in one service effecting another."}),"\n",(0,r.jsxs)(s.p,{children:["If you're running Dashy in a container, see ",(0,r.jsx)(s.a,{href:"/docs/management#container-security",children:"Management Docs --\x3e Container Security"})," for step-by-step security guide."]}),"\n",(0,r.jsx)(s.p,{children:"There is very little complexity involved with Dashy, and therefore the attack surface is reasonably small, but it is still important to follow best practices and employ monitoring for all your self-hosted apps. A couple of things that you should look at include:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"Use SSL for securing traffic in transit"}),"\n",(0,r.jsxs)(s.li,{children:["Configure ",(0,r.jsx)(s.a,{href:"/docs/authentication#alternative-authentication-methods",children:"authentication"})," to prevent unauthorized access"]}),"\n",(0,r.jsx)(s.li,{children:"Keep your system, software and Dashy up-to-date"}),"\n",(0,r.jsx)(s.li,{children:"Ensure your server is appropriately secured"}),"\n",(0,r.jsx)(s.li,{children:"Manage users and SSH correctly"}),"\n",(0,r.jsx)(s.li,{children:"Enable and configure firewall rules"}),"\n",(0,r.jsx)(s.li,{children:"Implement security, malware and traffic scanning"}),"\n",(0,r.jsx)(s.li,{children:"Setup malicious traffic detection"}),"\n",(0,r.jsxs)(s.li,{children:["Understand the ",(0,r.jsx)(s.a,{href:"https://docs.docker.com/engine/security/",children:"Docker attack fronts"}),", and follow ",(0,r.jsx)(s.a,{href:"https://snyk.io/blog/10-docker-image-security-best-practices/",children:"Docker Security Best Practices"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This is covered in more detail in ",(0,r.jsx)(s.a,{href:"/docs/management",children:"App Management"}),"."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"security-features",children:"Security Features"}),"\n",(0,r.jsx)(s.h3,{id:"subresource-integrity",children:"Subresource Integrity"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity",children:"Subresource Integrity"})," or SRI is a security feature that enables browsers to verify that resources they fetch are delivered without unexpected manipulation. It works by allowing you to provide a cryptographic hash that a fetched resource must match. This prevents the app from loading any resources that have been manipulated, by verifying the files hashes. It safeguards against the risk of an attacker injecting arbitrary malicious content into any files served up via a CDN."]}),"\n",(0,r.jsxs)(s.p,{children:["Dashy supports SRI, and it is recommended to enable this if you are hosting your dashboard via a public CDN. To enable SRI, set the ",(0,r.jsx)(s.code,{children:"INTEGRITY"})," environmental variable to ",(0,r.jsx)(s.code,{children:"true"}),"."]}),"\n",(0,r.jsx)(s.h3,{id:"ssl",children:"SSL"}),"\n",(0,r.jsxs)(s.p,{children:["Native SSL support is enabled, for setup instructions, see the ",(0,r.jsx)(s.a,{href:"/docs/management#ssl-certificates",children:"Management Docs"})]}),"\n",(0,r.jsx)(s.h3,{id:"authentication",children:"Authentication"}),"\n",(0,r.jsxs)(s.p,{children:["Dashy supports both basic auth, as well as server-based SSO using Keycloak. Full details of which, along with alternate authentication methods can be found in the ",(0,r.jsx)(s.a,{href:"/docs/authentication",children:"Authentication Docs"}),". If your dashboard is exposed to the internet and/ or contains any sensitive info it is strongly recommended to configure access control with Keycloak or another server-side method."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"disabling-features",children:"Disabling Features"}),"\n",(0,r.jsx)(s.p,{children:"You may wish to disable features that you don't want to use, if they involve storing data in the browser or making network requests."}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:["To disable smart-sort (uses local storage), set ",(0,r.jsx)(s.code,{children:"appConfig.disableSmartSort: true"})]}),"\n",(0,r.jsxs)(s.li,{children:["To disable update checks (makes external request to GH), set ",(0,r.jsx)(s.code,{children:"appConfig.disableUpdateChecks: true"})]}),"\n",(0,r.jsxs)(s.li,{children:["To disable web search (redirect to external / internal content), set ",(0,r.jsx)(s.code,{children:"appConfig.disableWebSearch: true"})]}),"\n",(0,r.jsxs)(s.li,{children:["To keep status checks disabled (external/ internal requests), set ",(0,r.jsx)(s.code,{children:"appConfig.statusCheck: false"})]}),"\n",(0,r.jsxs)(s.li,{children:["To keep font-awesome icons disabled (external requests), set ",(0,r.jsx)(s.code,{children:"appConfig.enableFontAwesome: false"})]}),"\n",(0,r.jsxs)(s.li,{children:["To keep error reporting disabled (external requests and data collection), set ",(0,r.jsx)(s.code,{children:"appConfig.enableErrorReporting: false"})]}),"\n",(0,r.jsxs)(s.li,{children:["To keep the service worker disabled (stores cache of app in browser data), set ",(0,r.jsx)(s.code,{children:"appConfig.enableServiceWorker: false"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"reporting-a-security-issue",children:"Reporting a Security Issue"}),"\n",(0,r.jsxs)(s.p,{children:["If you think you've found a critical issue with Dashy, please send an email to ",(0,r.jsx)(s.code,{children:"security@mail.alicia.omg.lol"}),". You can encrypt it, using ",(0,r.jsx)(s.a,{href:"https://keybase.io/aliciasykes/pgp_keys.asc?fingerprint=0688f8d34587d954e9e51fb8fedb68f55c0283a7",children:(0,r.jsx)(s.code,{children:"0688 F8D3 4587 D954 E9E5 1FB8 FEDB 68F5 5C02 83A7"})}),". You should receive a response within 48 hours. For more information, see ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/.github/SECURITY",children:"SECURITY.md"}),"."]}),"\n",(0,r.jsx)(s.p,{children:"All non-critical issues can be raised as a ticket."}),"\n",(0,r.jsx)(s.p,{children:"Please include the following information:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)"}),"\n",(0,r.jsx)(s.li,{children:"Full paths of source file(s) related to the manifestation of the issue"}),"\n",(0,r.jsx)(s.li,{children:"The location of the affected source code (tag/branch/commit or direct URL)"}),"\n",(0,r.jsx)(s.li,{children:"Any special configuration required to reproduce the issue"}),"\n",(0,r.jsx)(s.li,{children:"Step-by-step instructions to reproduce the issue"}),"\n",(0,r.jsx)(s.li,{children:"Proof-of-concept or exploit code (if possible)"}),"\n",(0,r.jsx)(s.li,{children:"Impact of the issue, including how an attacker might exploit the issue"}),"\n"]})]})}function h(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453(e,s,i){i.d(s,{R:()=>o,x:()=>a});var n=i(6540);const r={},t=n.createContext(r);function o(e){const s=n.useContext(t);return n.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),n.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9be9f402.8af42e68.js b/assets/js/9be9f402.8eabe311.js similarity index 99% rename from assets/js/9be9f402.8af42e68.js rename to assets/js/9be9f402.8eabe311.js index 25ba95cc..50374f2c 100644 --- a/assets/js/9be9f402.8af42e68.js +++ b/assets/js/9be9f402.8eabe311.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[5552],{8803(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>a,frontMatter:()=>l,metadata:()=>i,toc:()=>h});const i=JSON.parse('{"id":"widgets","title":"Widgets","description":"Dashy has support for displaying dynamic content in the form of widgets. There are several built-in widgets available out-of-the-box as well as support for custom widgets to display stats from almost any service with an API.","source":"@site/docs/widgets.md","sourceDirName":".","slug":"/widgets","permalink":"/docs/widgets","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/widgets.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Icons","permalink":"/docs/icons"},"next":{"title":"Theming","permalink":"/docs/theming"}}');var r=s(4848),d=s(8453);const l={},t="Widgets",c={},h=[{value:"Contents",id:"contents",level:2},{value:"General Widgets",id:"general-widgets",level:2},{value:"Clock",id:"clock",level:3},{value:"Options",id:"options",level:4},{value:"Example",id:"example",level:4},{value:"Info",id:"info",level:4},{value:"Weather",id:"weather",level:3},{value:"Options",id:"options-1",level:4},{value:"Example",id:"example-1",level:4},{value:"Info",id:"info-1",level:4},{value:"Weather Forecast",id:"weather-forecast",level:3},{value:"Options",id:"options-2",level:4},{value:"Example",id:"example-2",level:4},{value:"Info",id:"info-2",level:4},{value:"RSS Feed",id:"rss-feed",level:3},{value:"Options",id:"options-3",level:4},{value:"Example",id:"example-3",level:4},{value:"Info",id:"info-3",level:4},{value:"Image",id:"image",level:3},{value:"Options",id:"options-4",level:4},{value:"Example",id:"example-4",level:4},{value:"Info",id:"info-4",level:4},{value:"Public IP",id:"public-ip",level:3},{value:"Options",id:"options-5",level:4},{value:"Example",id:"example-5",level:4},{value:"Info",id:"info-5",level:4},{value:"IP Blacklist",id:"ip-blacklist",level:3},{value:"Options",id:"options-6",level:4},{value:"Example",id:"example-6",level:4},{value:"Info",id:"info-6",level:4},{value:"Domain Monitor",id:"domain-monitor",level:3},{value:"Options",id:"options-7",level:4},{value:"Example",id:"example-7",level:4},{value:"Info",id:"info-7",level:4},{value:"Crypto Watch List",id:"crypto-watch-list",level:3},{value:"Options",id:"options-8",level:4},{value:"Example",id:"example-8",level:4},{value:"Info",id:"info-8",level:4},{value:"Crypto Token Price History",id:"crypto-token-price-history",level:3},{value:"Options",id:"options-9",level:4},{value:"Example",id:"example-9",level:4},{value:"Info",id:"info-9",level:4},{value:"Wallet Balance",id:"wallet-balance",level:3},{value:"Options",id:"options-10",level:4},{value:"Example",id:"example-10",level:4},{value:"Info",id:"info-10",level:4},{value:"Code Stats",id:"code-stats",level:3},{value:"Options",id:"options-11",level:4},{value:"Example",id:"example-11",level:4},{value:"Info",id:"info-11",level:4},{value:"Mullvad Status",id:"mullvad-status",level:3},{value:"Options",id:"options-12",level:4},{value:"Example",id:"example-12",level:4},{value:"Info",id:"info-12",level:4},{value:"addy.io",id:"addyio",level:3},{value:"Options",id:"options-13",level:4},{value:"Example",id:"example-13",level:4},{value:"Info",id:"info-13",level:4},{value:"Vulnerability Feed",id:"vulnerability-feed",level:3},{value:"Options",id:"options-14",level:4},{value:"Example",id:"example-14",level:4},{value:"Info",id:"info-14",level:4},{value:"Exchange Rates",id:"exchange-rates",level:3},{value:"Options",id:"options-15",level:4},{value:"Example",id:"example-15",level:4},{value:"Info",id:"info-15",level:4},{value:"Public Holidays",id:"public-holidays",level:3},{value:"Options",id:"options-16",level:4},{value:"Example",id:"example-16",level:4},{value:"Info",id:"info-16",level:4},{value:"Covid-19 Status",id:"covid-19-status",level:3},{value:"Options",id:"options-17",level:4},{value:"Example",id:"example-17",level:4},{value:"Info",id:"info-17",level:4},{value:"Sports Scores",id:"sports-scores",level:3},{value:"Options",id:"options-18",level:4},{value:"Example",id:"example-18",level:4},{value:"Info",id:"info-18",level:4},{value:"News Headlines",id:"news-headlines",level:3},{value:"Options",id:"options-19",level:4},{value:"Example",id:"example-19",level:4},{value:"Info",id:"info-19",level:4},{value:"TFL Status",id:"tfl-status",level:3},{value:"Options",id:"options-20",level:4},{value:"Example",id:"example-20",level:4},{value:"Info",id:"info-20",level:4},{value:"Stock Price History",id:"stock-price-history",level:3},{value:"Options",id:"options-21",level:4},{value:"Example",id:"example-21",level:4},{value:"Info",id:"info-21",level:4},{value:"ETH Gas Prices",id:"eth-gas-prices",level:3},{value:"Options",id:"options-22",level:4},{value:"Example",id:"example-22",level:4},{value:"Info",id:"info-22",level:4},{value:"Joke",id:"joke",level:3},{value:"Options",id:"options-23",level:4},{value:"Example",id:"example-23",level:4},{value:"Info",id:"info-23",level:4},{value:"Chuck Norris quotes",id:"chuck-norris-quotes",level:3},{value:"Options",id:"options-24",level:4},{value:"Example",id:"example-24",level:4},{value:"Info",id:"info-24",level:4},{value:"XKCD Comics",id:"xkcd-comics",level:3},{value:"Options",id:"options-25",level:4},{value:"Example",id:"example-25",level:4},{value:"Info",id:"info-25",level:4},{value:"Flight Data",id:"flight-data",level:3},{value:"Options",id:"options-26",level:4},{value:"Example",id:"example-26",level:4},{value:"Info",id:"info-26",level:4},{value:"Astronomy Picture of the Day",id:"astronomy-picture-of-the-day",level:3},{value:"Options",id:"options-27",level:4},{value:"Example",id:"example-27",level:4},{value:"Info",id:"info-27",level:4},{value:"GitHub Trending",id:"github-trending",level:3},{value:"Options",id:"options-28",level:4},{value:"Example",id:"example-28",level:4},{value:"Info",id:"info-28",level:4},{value:"GitHub Profile Stats",id:"github-profile-stats",level:3},{value:"Options",id:"options-29",level:4},{value:"Example",id:"example-29",level:4},{value:"Info",id:"info-29",level:4},{value:"HealthChecks Status",id:"healthchecks-status",level:3},{value:"Options",id:"options-30",level:4},{value:"Info",id:"info-30",level:4},{value:"Hackernews Trending",id:"hackernews-trending",level:3},{value:"Options",id:"options-31",level:4},{value:"Example",id:"example-30",level:5},{value:"MVG Departure",id:"mvg-departure",level:3},{value:"Options",id:"options-32",level:4},{value:"Info",id:"info-31",level:4},{value:"MVG Connection",id:"mvg-connection",level:3},{value:"Options",id:"options-33",level:4},{value:"Info",id:"info-32",level:4},{value:"Custom List",id:"custom-list",level:3},{value:"Options",id:"options-34",level:4},{value:"Json Schema",id:"json-schema",level:4},{value:"Notes",id:"notes",level:4},{value:"Example",id:"example-31",level:4},{value:"Info",id:"info-33",level:4},{value:"Custom search",id:"custom-search",level:3},{value:"Options",id:"options-35",level:4},{value:"Notes",id:"notes-1",level:4},{value:"Example",id:"example-32",level:4},{value:"Info",id:"info-34",level:4},{value:"RescueTime Overview",id:"rescuetime-overview",level:3},{value:"Options",id:"options-36",level:4},{value:"Example",id:"example-33",level:4},{value:"Info",id:"info-35",level:4},{value:"Minecraft Server",id:"minecraft-server",level:3},{value:"Options",id:"options-37",level:4},{value:"Example",id:"example-34",level:4},{value:"Info",id:"info-36",level:4},{value:"Self-Hosted Services Widgets",id:"self-hosted-services-widgets",level:2},{value:"System Info",id:"system-info",level:3},{value:"Options",id:"options-38",level:4},{value:"Example",id:"example-35",level:4},{value:"Info",id:"info-37",level:4},{value:"Cron Monitoring (Health Checks)",id:"cron-monitoring-health-checks",level:3},{value:"Options",id:"options-39",level:4},{value:"Example",id:"example-36",level:4},{value:"Info",id:"info-38",level:4},{value:"CPU History (NetData)",id:"cpu-history-netdata",level:3},{value:"Options",id:"options-40",level:4},{value:"Example",id:"example-37",level:4},{value:"Info",id:"info-39",level:4},{value:"Memory History (NetData)",id:"memory-history-netdata",level:3},{value:"Options",id:"options-41",level:4},{value:"Example",id:"example-38",level:4},{value:"Info",id:"info-40",level:4},{value:"Load History (NetData)",id:"load-history-netdata",level:3},{value:"Options",id:"options-42",level:4},{value:"Example",id:"example-39",level:4},{value:"Info",id:"info-41",level:4},{value:"Pi-Hole Stats",id:"pi-hole-stats",level:3},{value:"Options",id:"options-43",level:4},{value:"Example",id:"example-40",level:4},{value:"Info",id:"info-42",level:4},{value:"Pi-Hole Stats v6",id:"pi-hole-stats-v6",level:3},{value:"Options",id:"options-44",level:4},{value:"Example",id:"example-41",level:4},{value:"Info",id:"info-43",level:4},{value:"Pi-Hole Queries",id:"pi-hole-queries",level:3},{value:"Options",id:"options-45",level:4},{value:"Example",id:"example-42",level:4},{value:"Info",id:"info-44",level:4},{value:"Pi-Hole Queries v6",id:"pi-hole-queries-v6",level:3},{value:"Options",id:"options-46",level:4},{value:"Example",id:"example-43",level:4},{value:"Info",id:"info-45",level:4},{value:"Pi-Hole Recent Traffic",id:"pi-hole-recent-traffic",level:3},{value:"Options",id:"options-47",level:4},{value:"Example",id:"example-44",level:4},{value:"Info",id:"info-46",level:4},{value:"Pi-Hole Recent Traffic v6",id:"pi-hole-recent-traffic-v6",level:3},{value:"Options",id:"options-48",level:4},{value:"Example",id:"example-45",level:4},{value:"Info",id:"info-47",level:4},{value:"Stat Ping Statuses",id:"stat-ping-statuses",level:3},{value:"Options",id:"options-49",level:4},{value:"Example",id:"example-46",level:4},{value:"Info",id:"info-48",level:4},{value:"Synology Download Station",id:"synology-download-station",level:3},{value:"Options",id:"options-50",level:4},{value:"Example",id:"example-47",level:4},{value:"Info",id:"info-49",level:4},{value:"AdGuard Home Block Stats",id:"adguard-home-block-stats",level:3},{value:"Options",id:"options-51",level:4},{value:"Example",id:"example-48",level:4},{value:"Info",id:"info-50",level:4},{value:"AdGuard Home Filters",id:"adguard-home-filters",level:3},{value:"Options",id:"options-52",level:4},{value:"Example",id:"example-49",level:4},{value:"Info",id:"info-51",level:4},{value:"AdGuard Home DNS Info",id:"adguard-home-dns-info",level:3},{value:"Options",id:"options-53",level:4},{value:"Example",id:"example-50",level:4},{value:"Info",id:"info-52",level:4},{value:"AdGuard Home Top Domains",id:"adguard-home-top-domains",level:3},{value:"Options",id:"options-54",level:4},{value:"Example",id:"example-51",level:4},{value:"Info",id:"info-53",level:4},{value:"Nextcloud User",id:"nextcloud-user",level:3},{value:"Options",id:"options-55",level:4},{value:"Example",id:"example-52",level:4},{value:"Info",id:"info-54",level:4},{value:"Nextcloud User Statuses",id:"nextcloud-user-statuses",level:3},{value:"Options",id:"options-56",level:4},{value:"Example",id:"example-53",level:4},{value:"Info",id:"info-55",level:4},{value:"Nextcloud Notifications",id:"nextcloud-notifications",level:3},{value:"Options",id:"options-57",level:4},{value:"Example",id:"example-54",level:4},{value:"Info",id:"info-56",level:4},{value:"Nextcloud System",id:"nextcloud-system",level:3},{value:"Options",id:"options-58",level:4},{value:"Example",id:"example-55",level:4},{value:"Info",id:"info-57",level:4},{value:"Nextcloud Stats",id:"nextcloud-stats",level:3},{value:"Options",id:"options-59",level:4},{value:"Example",id:"example-56",level:4},{value:"Info",id:"info-58",level:4},{value:"Nextcloud PHP OPcache Stats",id:"nextcloud-php-opcache-stats",level:3},{value:"Options",id:"options-60",level:4},{value:"Example",id:"example-57",level:4},{value:"Info",id:"info-59",level:4},{value:"Proxmox lists",id:"proxmox-lists",level:3},{value:"Options",id:"options-61",level:4},{value:"Example",id:"example-58",level:4},{value:"Info",id:"info-60",level:4},{value:"Troubleshooting",id:"troubleshooting",level:4},{value:"Sabnzbd",id:"sabnzbd",level:3},{value:"Options",id:"options-62",level:4},{value:"Example",id:"example-59",level:4},{value:"Info",id:"info-61",level:4},{value:"Gluetun VPN Info",id:"gluetun-vpn-info",level:3},{value:"Options",id:"options-63",level:4},{value:"Example",id:"example-60",level:4},{value:"Info",id:"info-62",level:4},{value:"Drone CI Builds",id:"drone-ci-builds",level:3},{value:"Options",id:"options-64",level:4},{value:"Example",id:"example-61",level:4},{value:"Info",id:"info-63",level:4},{value:"Filebrowser",id:"filebrowser",level:3},{value:"Options",id:"options-65",level:4},{value:"Example",id:"example-62",level:4},{value:"Widget Sections",id:"widget-sections",level:4},{value:"Info",id:"info-64",level:4},{value:"Linkding",id:"linkding",level:3},{value:"Options",id:"options-66",level:4},{value:"Example",id:"example-63",level:4},{value:"Info",id:"info-65",level:4},{value:"Uptime Kuma",id:"uptime-kuma",level:3},{value:"Options",id:"options-67",level:4},{value:"Example",id:"example-64",level:4},{value:"Info",id:"info-66",level:4},{value:"Uptime Kuma Status Page",id:"uptime-kuma-status-page",level:3},{value:"Options",id:"options-68",level:4},{value:"Example",id:"example-65",level:4},{value:"Info",id:"info-67",level:4},{value:"Tactical RMM",id:"tactical-rmm",level:3},{value:"Options",id:"options-69",level:4},{value:"Example",id:"example-66",level:4},{value:"Info",id:"info-68",level:4},{value:"System Resource Monitoring",id:"system-resource-monitoring",level:2},{value:"Glances",id:"glances",level:3},{value:"Options",id:"options-70",level:4},{value:"Info",id:"info-69",level:4},{value:"Screenshot",id:"screenshot",level:4},{value:"Current CPU Usage",id:"current-cpu-usage",level:3},{value:"Example",id:"example-67",level:4},{value:"Current CPU Usage Speedometer",id:"current-cpu-usage-speedometer",level:3},{value:"Example",id:"example-68",level:4},{value:"CPU Usage Per Core",id:"cpu-usage-per-core",level:3},{value:"Example",id:"example-69",level:4},{value:"CPU Usage History",id:"cpu-usage-history",level:3},{value:"Options",id:"options-71",level:4},{value:"Example",id:"example-70",level:4},{value:"Current Memory Usage",id:"current-memory-usage",level:3},{value:"Example",id:"example-71",level:4},{value:"Current Memory Usage Speedometer",id:"current-memory-usage-speedometer",level:3},{value:"Example",id:"example-72",level:4},{value:"Memory Usage History",id:"memory-usage-history",level:3},{value:"Options",id:"options-72",level:4},{value:"Example",id:"example-73",level:4},{value:"Disk Space",id:"disk-space",level:3},{value:"Example",id:"example-74",level:4},{value:"Disk IO",id:"disk-io",level:3},{value:"Example",id:"example-75",level:4},{value:"System Load",id:"system-load",level:3},{value:"Example",id:"example-76",level:4},{value:"Uptime",id:"uptime",level:3},{value:"Example",id:"example-77",level:4},{value:"System Load History",id:"system-load-history",level:3},{value:"Example",id:"example-78",level:4},{value:"Network Interfaces",id:"network-interfaces",level:3},{value:"Example",id:"example-79",level:4},{value:"Network Traffic",id:"network-traffic",level:3},{value:"Example",id:"example-80",level:4},{value:"Resource Usage Alerts",id:"resource-usage-alerts",level:3},{value:"Example",id:"example-81",level:4},{value:"IP Address",id:"ip-address",level:3},{value:"Example",id:"example-82",level:4},{value:"CPU Temp",id:"cpu-temp",level:3},{value:"Options",id:"options-73",level:4},{value:"Example",id:"example-83",level:4},{value:"Compact Metrics",id:"compact-metrics",level:3},{value:"Options",id:"options-74",level:4},{value:"Example",id:"example-84",level:4},{value:"Dynamic Widgets",id:"dynamic-widgets",level:2},{value:"Iframe Widget",id:"iframe-widget",level:3},{value:"Options",id:"options-75",level:4},{value:"Example",id:"example-85",level:4},{value:"HTML Embedded Widget",id:"html-embedded-widget",level:3},{value:"Options",id:"options-76",level:4},{value:"Example",id:"example-86",level:4},{value:"API Response",id:"api-response",level:3},{value:"Prometheus Data",id:"prometheus-data",level:3},{value:"Data Feed",id:"data-feed",level:3},{value:"Example",id:"example-87",level:4},{value:"Usage & Customizations",id:"usage--customizations",level:2},{value:"Widget Usage Guide",id:"widget-usage-guide",level:3},{value:"Continuous Updates",id:"continuous-updates",level:3},{value:"Proxying Requests",id:"proxying-requests",level:3},{value:"Handling Secrets",id:"handling-secrets",level:3},{value:"Setting Timeout",id:"setting-timeout",level:3},{value:"Adding Labels",id:"adding-labels",level:3},{value:"Ignoring Errors",id:"ignoring-errors",level:3},{value:"Widget Styling",id:"widget-styling",level:3},{value:"Customizing Charts",id:"customizing-charts",level:3},{value:"Language Translations",id:"language-translations",level:3},{value:"Widget UI Options",id:"widget-ui-options",level:3},{value:"Build your own Widget",id:"build-your-own-widget",level:3},{value:"Requesting a Widget",id:"requesting-a-widget",level:3},{value:"Troubleshooting Widget Errors",id:"troubleshooting-widget-errors",level:3},{value:"CORS Errors",id:"cors-errors",level:4},{value:"Option 1 - Ensure Correct Protocol",id:"option-1---ensure-correct-protocol",level:4},{value:"Option 2 - Set Headers",id:"option-2---set-headers",level:4},{value:"Option 3 - Proxying Request",id:"option-3---proxying-request",level:4},{value:"Option 4 - Use a plugin",id:"option-4---use-a-plugin",level:4},{value:"Raising an Issue",id:"raising-an-issue",level:3}];function o(e){const n={a:"a",blockquote:"blockquote",br:"br",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,d.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"widgets",children:"Widgets"})}),"\n",(0,r.jsx)(n.p,{children:"Dashy has support for displaying dynamic content in the form of widgets. There are several built-in widgets available out-of-the-box as well as support for custom widgets to display stats from almost any service with an API."}),"\n",(0,r.jsx)(n.h2,{id:"contents",children:"Contents"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#general-widgets",children:"General Widgets"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#clock",children:"Clock"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#weather",children:"Weather"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#weather-forecast",children:"Weather Forecast"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#rss-feed",children:"RSS Feed"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#image",children:"Image"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#public-ip",children:"Public IP Address"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#ip-blacklist",children:"IP Blacklist Checker"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#domain-monitor",children:"Domain Monitor"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#crypto-watch-list",children:"Crypto Watch List"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#crypto-token-price-history",children:"Crypto Price History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#wallet-balance",children:"Crypto Wallet Balance"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#code-stats",children:"Code Stats"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#mullvad-status",children:"Mullvad Status"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#addyio",children:"Email Aliases (addy.io)"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#vulnerability-feed",children:"Vulnerability Feed"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#exchange-rates",children:"Exchange Rates"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#public-holidays",children:"Public Holidays"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#covid-19-status",children:"Covid-19 Status"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#sports-scores",children:"Sports Scores"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#news-headlines",children:"News Headlines"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#tfl-status",children:"TFL Status"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#stock-price-history",children:"Stock Price History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#eth-gas-prices",children:"ETH Gas Prices"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#joke",children:"Joke of the Day"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#chuck-norris-quotes",children:"Chuck Norris quotes"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#xkcd-comics",children:"XKCD Comics"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#flight-data",children:"Flight Data"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#astronomy-picture-of-the-day",children:"NASA APOD"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#github-trending",children:"GitHub Trending"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#github-profile-stats",children:"GitHub Profile Stats"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#healthchecks-status",children:"Healthchecks Status"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#hackernews-trending",children:"Hackernews Trending"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#mvg-departure",children:"Mvg Departure"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#mvg-connection",children:"Mvg Connection"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#custom-search",children:"Custom search"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#rescuetime-overview",children:"Rescuetime overview"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#minecraft-server",children:"Minecraft Server"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#self-hosted-services-widgets",children:"Self-Hosted Services Widgets"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#system-info",children:"System Info"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cron-monitoring-health-checks",children:"Cron Monitoring"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cpu-history-netdata",children:"CPU History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#memory-history-netdata",children:"Memory History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#load-history-netdata",children:"System Load History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-stats",children:"Pi-Hole Stats"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-stats-v6",children:"Pi-Hole Stats v6"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-queries",children:"Pi-Hole Queries"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-queries-v6",children:"Pi-Hole Queries v6"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-recent-traffic",children:"Pi-Hole Recent Traffic"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-recent-traffic-v6",children:"Pi-Hole Recent Traffic v6"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#stat-ping-statuses",children:"Stat Ping Statuses"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#synology-download-station",children:"Synology Download Station"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#adguard-home-block-stats",children:"AdGuard Home Block Stats"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#adguard-home-filters",children:"AdGuard Home Filters"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#adguard-home-dns-info",children:"AdGuard Home DNS Info"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#adguard-home-top-domains",children:"AdGuard Home Top Domains"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-user",children:"Nextcloud User"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-user-statuses",children:"Nextcloud User Statuses"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-notifications",children:"Nextcloud Notifications"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-system",children:"Nextcloud System"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-stats",children:"Nextcloud Stats"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-php-opcache-stats",children:"Nextcloud PHP OPcache"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#proxmox-lists",children:"Proxmox lists"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#sabnzbd",children:"Sabnzbd"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#gluetun-vpn-info",children:"Gluetun VPN Info"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#drone-ci-builds",children:"Drone CI Build"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#filebrowser",children:"Filebrowser"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#linkding",children:"Linkding"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#uptime-kuma",children:"Uptime Kuma"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#uptime-kuma-status-page",children:"Uptime Kuma Status Page"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#tactical-rmm",children:"Tactical RMM"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#system-resource-monitoring",children:"System Resource Monitoring"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#current-cpu-usage",children:"CPU Usage Current"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cpu-usage-per-core",children:"CPU Usage Per Core"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cpu-usage-history",children:"CPU Usage History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#current-memory-usage",children:"Memory Usage Current"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#memory-usage-history",children:"Memory Usage History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#disk-space",children:"Disk Space"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#disk-io",children:"Disk IO"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#system-load",children:"System Load"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#system-load-history",children:"System Load History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#network-interfaces",children:"Network Interfaces"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#network-traffic",children:"Network Traffic"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#resource-usage-alerts",children:"Resource Usage Alerts"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#ip-address",children:"Public & Private IP"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cpu-temp",children:"CPU Temperature"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#compact-metrics",children:"Compact Metrics"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#dynamic-widgets",children:"Dynamic Widgets"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#iframe-widget",children:"Iframe Widget"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#html-embedded-widget",children:"HTML Embed Widget"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#api-response",children:"API Response"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#prometheus-data",children:"Prometheus Data"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#data-feed",children:"Data Feed"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#usage--customizations",children:"Usage & Customizations"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#widget-usage-guide",children:"Widget Usage Guide"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#continuous-updates",children:"Continuous Updates"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#proxying-requests",children:"Proxying Requests"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#handling-secrets",children:"Handling Secrets"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#setting-timeout",children:"Setting Timeout"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#adding-labels",children:"Adding Labels"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#ignoring-errors",children:"Ignoring Errors"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#widget-styling",children:"Custom CSS Styling"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#customizing-charts",children:"Customizing Charts"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#language-translations",children:"Language Translations"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#widget-ui-options",children:"Widget UI Options"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#build-your-own-widget",children:"Building a Widget"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#requesting-a-widget",children:"Requesting a Widget"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#troubleshooting-widget-errors",children:"Troubleshooting"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"general-widgets",children:"General Widgets"}),"\n",(0,r.jsx)(n.h3,{id:"clock",children:"Clock"}),"\n",(0,r.jsx)(n.p,{children:"A simple, live-updating time and date widget with time-zone support. All fields are optional."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/clock"})}),"\n",(0,r.jsx)(n.h4,{id:"options",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"timeZone"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The time zone to display date and time in.",(0,r.jsx)(n.br,{})," Specified as Region/City, for example: ",(0,r.jsx)(n.code,{children:"Australia/Melbourne"}),". See the ",(0,r.jsx)(n.a,{href:"https://timezonedb.com/time-zones",children:"Time Zone DB"})," for a full list of supported TZs. Defaults to the browser / device's local time"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"format"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["A country code for displaying the date and time in local format.",(0,r.jsx)(n.br,{}),"Specified as ",(0,r.jsx)(n.code,{children:"[ISO-3166]-[ISO-639]"}),", for example: ",(0,r.jsx)(n.code,{children:"en-AU"}),". See ",(0,r.jsx)(n.a,{href:"https://www.fincher.org/Utilities/CountryLanguageList.shtml",children:"here"})," for a full list of locales. Defaults to the browser / device's region"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"customCityName"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"By default the city from the time-zone is shown, but setting this value will override that text"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideDate"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", the date and city will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideSeconds"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", seconds will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"use12Hour"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", 12 hour time will be displayed. Defaults to the settings suggested by the current ",(0,r.jsx)(n.code,{children:"format"})," and ",(0,r.jsx)(n.code,{children:"timeZone"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: clock\n options:\n timeZone: Europe/London\n format: en-GB\n hideDate: false\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info",children:"Info"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"No external data requests."})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"weather",children:"Weather"}),"\n",(0,r.jsx)(n.p,{children:"A simple, live-updating local weather component, showing temperature, conditions and more info."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/weather"})}),"\n",(0,r.jsx)(n.h4,{id:"options-1",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your OpenWeatherMap API key. You can get one for free at ",(0,r.jsx)(n.a,{href:"https://openweathermap.org/",children:"openweathermap.org"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"city"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A city name to use for fetching weather. This can also be a state code or country code, following the ISO-3166 format"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"units"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The units to use for displaying data, can be either ",(0,r.jsx)(n.code,{children:"metric"})," or ",(0,r.jsx)(n.code,{children:"imperial"}),". Defaults to ",(0,r.jsx)(n.code,{children:"metric"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideDetails"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", the additional details (wind, humidity, pressure, etc) will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"lat"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["To show weather for a specific location, you can provide the latitude and longitude coordinates. If provided, this will override the ",(0,r.jsx)(n.code,{children:"city"})," option"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"lon"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["To show weather for a specific location, you can provide the latitude and longitude coordinates. If provided, this will override the ",(0,r.jsx)(n.code,{children:"city"})," option"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: weather\n options:\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n city: London\n units: metric\n hideDetails: true\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-1",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://openweather.co.uk/privacy-policy",children:"OWM Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"weather-forecast",children:"Weather Forecast"}),"\n",(0,r.jsxs)(n.p,{children:["Displays the weather (temperature and conditions) for the next few days for a given location. Note that this requires either the free ",(0,r.jsx)(n.a,{href:"https://home.openweathermap.org/students",children:"OpenWeatherMap Student Plan"}),", or the Premium Plan."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/weather-forecast"})}),"\n",(0,r.jsx)(n.h4,{id:"options-2",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your OpenWeatherMap API key. You can get one at ",(0,r.jsx)(n.a,{href:"https://openweathermap.org/",children:"openweathermap.org"})," or for free via the ",(0,r.jsx)(n.a,{href:"https://home.openweathermap.org/students",children:"OWM Student Plan"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"city"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A city name to use for fetching weather. This can also be a state code or country code, following the ISO-3166 format"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"numDays"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of days to display of forecast info to display. Defaults to ",(0,r.jsx)(n.code,{children:"4"}),", max ",(0,r.jsx)(n.code,{children:"16"})," days"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"units"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The units to use for displaying data, can be either ",(0,r.jsx)(n.code,{children:"metric"})," or ",(0,r.jsx)(n.code,{children:"imperial"}),". Defaults to ",(0,r.jsx)(n.code,{children:"metric"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideDetails"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", the additional details (wind, humidity, pressure, etc) will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: weather-forecast\n options:\n city: California\n numDays: 6\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n units: imperial\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-2",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udd34 Premium (free for personal use only)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://openweather.co.uk/privacy-policy",children:"OWM Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"rss-feed",children:"RSS Feed"}),"\n",(0,r.jsx)(n.p,{children:"Display news and updates from any RSS-enabled service."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/rss"})}),"\n",(0,r.jsx)(n.h4,{id:"options-3",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"rssUrl"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL location of your RSS feed"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["An API key for ",(0,r.jsx)(n.a,{href:"https://rss2json.com/",children:"rss2json"}),". It's free, and will allow you to make 10,000 requests per day, you can sign up ",(0,r.jsx)(n.a,{href:"https://rss2json.com/sign-up",children:"here"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"The number of posts to return. If you haven't specified an API key, this will be limited to 10"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"orderBy"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["How results should be sorted. Can be either ",(0,r.jsx)(n.code,{children:"pubDate"}),", ",(0,r.jsx)(n.code,{children:"author"})," or ",(0,r.jsx)(n.code,{children:"title"}),". Defaults to ",(0,r.jsx)(n.code,{children:"pubDate"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"orderDirection"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Order direction of feed items to return. Can be either ",(0,r.jsx)(n.code,{children:"asc"})," or ",(0,r.jsx)(n.code,{children:"desc"}),". Defaults to ",(0,r.jsx)(n.code,{children:"desc"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"parseLocally"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If true parse the rss feed locally instead of using the rss2json API."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: rss-feed\n options:\n rssUrl: https://www.schneier.com/blog/atom.xml\n apiKey: xxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-3",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free Plan (up to 10,000 requests / day)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://rss2json.com/privacy-policy",children:"Rss2Json Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"image",children:"Image"}),"\n",(0,r.jsx)(n.p,{children:"Displays an image."}),"\n",(0,r.jsxs)(n.p,{children:["This may be useful if you have a service (such as Grafana - ",(0,r.jsx)(n.a,{href:"https://mattionline.de/grafana-api-export-graph-as-png/",children:"see example"}),"), which periodically exports charts or other data as an image."]}),"\n",(0,r.jsxs)(n.p,{children:["You can also store images within Dashy's public directory (using a Docker volume), and reference them directly. E.g. ",(0,r.jsx)(n.code,{children:"-v ./path/to/my-homelab-logo.png:/app/public/logo.png"}),", then in the widget ",(0,r.jsx)(n.code,{children:"imagePath: /logo.png"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Similarly, any web service that serves up widgets as image can be used. E.g. you could show current star chart for a GitHub repo, with: ",(0,r.jsx)(n.code,{children:"imagePath: https://starchart.cc/Lissy93/dashy.svg"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["If you'd like to embed a live screenshot, of all or just part of a website, then this can be done using ",(0,r.jsx)(n.a,{href:"https://apiflash.com/",children:"API Flash"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Or what about showing a photo of the day? Try ",(0,r.jsx)(n.code,{children:"https://source.unsplash.com/random/400x300"})," or ",(0,r.jsx)(n.code,{children:"https://picsum.photos/400/300"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"300",src:"https://pixelflare.cc/alicia/dashy/image"})}),"\n",(0,r.jsx)(n.h4,{id:"options-4",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"imagePath"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The path (local or remote) of the image to display"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"imageWidth"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify a fixed width for rendered image. Accepts either integer value in ",(0,r.jsx)(n.code,{children:"px"}),", or any string value with units (e.g. ",(0,r.jsx)(n.code,{children:"420"}),", ",(0,r.jsx)(n.code,{children:"100px"}),", ",(0,r.jsx)(n.code,{children:"6.9rem"}),") (defaults to ",(0,r.jsx)(n.code,{children:"auto"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"imageHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify a fixed height for rendered image. Accepts either integer value in ",(0,r.jsx)(n.code,{children:"px"}),", or any string value with units (e.g. ",(0,r.jsx)(n.code,{children:"420"}),", ",(0,r.jsx)(n.code,{children:"100px"}),", ",(0,r.jsx)(n.code,{children:"6.9rem"}),") (defaults to ",(0,r.jsx)(n.code,{children:"auto"}),")"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-4",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: image\n options:\n imagePath: https://i.ibb.co/yhbt6CY/dashy.png\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-4",children:"Info"}),"\n",(0,r.jsx)(n.p,{children:"Unless image fetched from remote source, no external data request is made."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"public-ip",children:"Public IP"}),"\n",(0,r.jsxs)(n.p,{children:['Often find yourself searching "What\'s my IP", just so you can check your VPN is still connected? This widget displays your public IP address, along with ISP name and approx location. Data can be fetched from either ',(0,r.jsx)(n.a,{href:"https://ipapi.co/",children:"IpApi.co"}),", ",(0,r.jsx)(n.a,{href:"https://ip-api.com/",children:"IP-API.com"}),", ",(0,r.jsx)(n.a,{href:"https://ipgeolocation.io/",children:"IpGeolocation.io"})," or ",(0,r.jsx)(n.a,{href:"https://ip2location.io/",children:"IP2Location.io"}),"."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/public-ip"})}),"\n",(0,r.jsx)(n.h4,{id:"options-5",children:"Options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"All fields are optional."})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"provider"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The name of the service to fetch IP address from. Can be either ",(0,r.jsx)(n.code,{children:"ipapi.co"}),", ",(0,r.jsx)(n.code,{children:"ip-api"}),", ",(0,r.jsx)(n.code,{children:"ipgeolocation"})," or ",(0,r.jsx)(n.code,{children:"ip2location.io"}),". Defaults to ",(0,r.jsx)(n.code,{children:"ipapi.co"}),". Note, ",(0,r.jsx)(n.code,{children:"ip-api"})," doesn't work on HTTPS, and if you set to ",(0,r.jsx)(n.code,{children:"ipgeolocation"})," or ",(0,r.jsx)(n.code,{children:"ip2location.io"})," then you must also provide an API key"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Only required if provider is set to ",(0,r.jsx)(n.code,{children:"ipgeolocation"})," or ",(0,r.jsx)(n.code,{children:"ip2location.io"}),". You can get a free IPGeolocation API key ",(0,r.jsx)(n.a,{href:"https://ipgeolocation.io/signup.html",children:"here"})," or a free IP2Location.io API key ",(0,r.jsx)(n.a,{href:"https://ip2location.io/pricing",children:"here"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-5",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: public-ip\n"})}),"\n",(0,r.jsx)(n.p,{children:"Or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: public-ip\n options:\n provider: ipgeolocation\n apiKey: xxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-5",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": _See ",(0,r.jsx)(n.a,{href:"https://ipgeolocation.io/privacy.html",children:"IPGeoLocation Privacy Policy"})," or ",(0,r.jsx)(n.a,{href:"https://ip-api.com/docs/legal",children:"IP-API Privacy Policy"})," or ",(0,r.jsx)(n.a,{href:"https://ip2location.io/privacy-policy",children:"IP2Location.io Privacy Policy"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ip-blacklist",children:"IP Blacklist"}),"\n",(0,r.jsxs)(n.p,{children:["Notice certain web pages aren't loading? This widget quickly shows which blacklists your IP address (or host, or email) appears on, using data from ",(0,r.jsx)(n.a,{href:"https://blacklistchecker.com/",children:"blacklistchecker.com"}),"."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/ip-blacklist"})}),"\n",(0,r.jsx)(n.h4,{id:"options-6",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"ipAddress"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"The IP to check. This can also be a domain/ host name or even an email address. If left blank, Dashy will use your current public IP address."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["You can get your free API key from ",(0,r.jsx)(n.a,{href:"https://blacklistchecker.com/keys",children:"blacklistchecker.com"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-6",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: blacklist-check\n options:\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n ipAddress: 1.1.1.1\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-6",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free Plan"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://blacklistchecker.com/privacy",children:"BlacklistChecker Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"domain-monitor",children:"Domain Monitor"}),"\n",(0,r.jsxs)(n.p,{children:["Keep an eye on the expiry dates of your domain names, using public whois records fetched from ",(0,r.jsx)(n.a,{href:"https://whoapi.com/",children:"whoapi.com"}),". Click the domain name to view additional info, like registrar, name servers and date last updated."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/domain-monitor"})}),"\n",(0,r.jsx)(n.h4,{id:"options-7",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"domain"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The domain to check"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["You can get your free API key from ",(0,r.jsx)(n.a,{href:"https://my.whoapi.com/user/signup",children:"my.whoapi.com"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showFullInfo"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If set to true, the toggle-full-info panel will be open by default"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-7",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: domain-monitor\n options:\n domain: example.com\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n\n - type: domain-monitor\n options:\n domain: example2.com\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-7",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free Plan (10,000 requests)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://whoapi.com/privacy-policy/",children:"WhoAPI Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"crypto-watch-list",children:"Crypto Watch List"}),"\n",(0,r.jsxs)(n.p,{children:["Keep track of price changes of your favorite crypto assets. Data is fetched from ",(0,r.jsx)(n.a,{href:"https://www.coingecko.com/",children:"CoinGecko"}),". All fields are optional."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/crypto-prices"})}),"\n",(0,r.jsx)(n.h4,{id:"options-8",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"assets"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["An array of cryptocurrencies, coins and tokens. See ",(0,r.jsx)(n.a,{href:"https://api.coingecko.com/api/v3/asset_platforms",children:"list of supported assets"}),". If none are specified, then the top coins by ",(0,r.jsx)(n.code,{children:"sortBy"})," (defaults to market cap) will be returned"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"currency"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The fiat currency to display price in, expressed as an ISO-4217 alpha code (see ",(0,r.jsx)(n.a,{href:"https://www.iban.com/currency-codes",children:"list of currencies"}),"). Defaults to ",(0,r.jsx)(n.code,{children:"USD"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"sortBy"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The method of sorting results. Can be ",(0,r.jsx)(n.code,{children:"marketCap"}),", ",(0,r.jsx)(n.code,{children:"volume"})," or ",(0,r.jsx)(n.code,{children:"alphabetical"}),". Defaults to ",(0,r.jsx)(n.code,{children:"marketCap"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Number of results to return, useful when no assets are specified. Defaults to either ",(0,r.jsx)(n.code,{children:"all"})," or ",(0,r.jsx)(n.code,{children:"100"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-8",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: crypto-watch-list\n options:\n limit: 10\n"})}),"\n",(0,r.jsx)(n.p,{children:"Or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: crypto-watch-list\n options:\n currency: GBP\n sortBy: marketCap\n assets:\n - bitcoin\n - ethereum\n - monero\n - cosmos\n - polkadot\n - dogecoin\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-8",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.coingecko.com/en/privacy",children:"CoinGecko Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"crypto-token-price-history",children:"Crypto Token Price History"}),"\n",(0,r.jsxs)(n.p,{children:["Shows recent price history for a given crypto asset, using price data fetched from ",(0,r.jsx)(n.a,{href:"https://www.coingecko.com/",children:"CoinGecko"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/crypto-price-history"})}),"\n",(0,r.jsx)(n.h4,{id:"options-9",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"asset"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Name of a crypto asset, coin or token to fetch price data for, see ",(0,r.jsx)(n.a,{href:"https://api.coingecko.com/api/v3/asset_platforms",children:"list of supported assets"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"currency"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The fiat currency to display results in, expressed as an ISO-4217 alpha code (see ",(0,r.jsx)(n.a,{href:"https://www.iban.com/currency-codes",children:"list of currencies"}),"). Defaults to ",(0,r.jsx)(n.code,{children:"USD"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"numDays"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of days of price history to render. Defaults to ",(0,r.jsx)(n.code,{children:"7"}),", min: ",(0,r.jsx)(n.code,{children:"1"}),", max: ",(0,r.jsx)(n.code,{children:"30"})," days"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColor"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Color of the chart value. Defaults to ",(0,r.jsx)(n.code,{children:"--widget-text-color"})," which inherits dashboard primary color"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The height of rendered chart in px. Defaults to ",(0,r.jsx)(n.code,{children:"300"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-9",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: crypto-price-chart\n options:\n asset: bitcoin\n currency: GBP\n numDays: 7\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-9",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.coingecko.com/en/privacy",children:"CoinGecko Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"wallet-balance",children:"Wallet Balance"}),"\n",(0,r.jsxs)(n.p,{children:["Keep track of your crypto balances and see recent transactions. Data is fetched from ",(0,r.jsx)(n.a,{href:"https://www.blockcypher.com/dev/",children:"BlockCypher"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/crypto-wallet"})}),"\n",(0,r.jsx)(n.h4,{id:"options-10",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"coin"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Symbol of coin or asset, e.g. ",(0,r.jsx)(n.code,{children:"btc"}),", ",(0,r.jsx)(n.code,{children:"eth"})," or ",(0,r.jsx)(n.code,{children:"doge"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"address"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Address to monitor. This is your wallet's ",(0,r.jsx)(n.strong,{children:"public"})," / receiving address"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"network"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["To use a different network, other than mainnet. Defaults to ",(0,r.jsx)(n.code,{children:"main"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit the number of transactions to display. Defaults to ",(0,r.jsx)(n.code,{children:"10"}),", set to large number to show all"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-10",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: wallet-balance\n options:\n coin: btc\n address: 3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-10",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.blockcypher.com/privacy.html",children:"BlockCypher Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"code-stats",children:"Code Stats"}),"\n",(0,r.jsxs)(n.p,{children:["Display your coding summary. ",(0,r.jsx)(n.a,{href:"https://codestats.net/",children:"Code::Stats"})," is a free and open source app that aggregates statistics about your programming activity. Dashy supports both the public instance, as well as self-hosted versions."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/code-stats"})}),"\n",(0,r.jsx)(n.h4,{id:"options-11",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Your CodeStats username"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If your self-hosting CodeStats, then supply the host name. By default it will use the public hosted instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"monthsToShow"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify the number of months to render in the historical data chart. Defaults to ",(0,r.jsx)(n.code,{children:"6"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideMeta"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide the meta section (username, level, all-time and recent XP)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideHistory"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide the historical calendar heat map"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideLanguages"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide the programming languages pie chart"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideMachines"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide the machines percentage chart"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-11",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: code-stats\n options:\n username: alicia\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-11",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted or Managed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://codestats.net/tos#privacy",children:"Code::Stats Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"mullvad-status",children:"Mullvad Status"}),"\n",(0,r.jsxs)(n.p,{children:["Shows your Mullvad VPN connection status, as well as server info. Fetched from ",(0,r.jsx)(n.a,{href:"https://mullvad.net/en/check/",children:"am.i.mullvad.net"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/mullvad"})}),"\n",(0,r.jsx)(n.h4,{id:"options-12",children:"Options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"No Options."})}),"\n",(0,r.jsx)(n.h4,{id:"example-12",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: mullvad-status\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-12",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://mullvad.net/en/help/privacy-policy/",children:"Mullvad Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"addyio",children:"addy.io"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://addy.io/",children:"addy.io"})," is a free and open source mail forwarding service. Use it to protect your real email address, by using a different alias for each of your online accounts, and have all emails land in your normal inbox(es). Supports custom domains, email replies, PGP-encryption, multiple recipients and more"]}),"\n",(0,r.jsx)(n.p,{children:"This widget display email addresses / aliases from addy.io. Click an email address to copy to clipboard, or use the toggle switch to enable/ disable it. Shows usage stats (bandwidth, used aliases etc), as well as total messages received, blocked and sent. Works with both self-hosted and managed instances of addy.io."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/addy"})}),"\n",(0,r.jsx)(n.h4,{id:"options-13",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your addy.io API Key / Personal Access Token. You can generate this under ",(0,r.jsx)(n.a,{href:"https://app.addy.io/settings",children:"Account Settings"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If your self-hosting addy.io, then supply the host name. By default it will use the public hosted instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiVersion"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If you're using an API version that is not version ",(0,r.jsx)(n.code,{children:"v1"}),", then specify it here"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit the number of emails shown per page. Defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"sortBy"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify the sort order for email addresses. Defaults to ",(0,r.jsx)(n.code,{children:"updated_at"}),". Can be either: ",(0,r.jsx)(n.code,{children:"local_part"}),", ",(0,r.jsx)(n.code,{children:"domain"}),", ",(0,r.jsx)(n.code,{children:"email"}),", ",(0,r.jsx)(n.code,{children:"emails_forwarded"}),", ",(0,r.jsx)(n.code,{children:"emails_blocked"}),", ",(0,r.jsx)(n.code,{children:"emails_replied"}),", ",(0,r.jsx)(n.code,{children:"emails_sent"}),", ",(0,r.jsx)(n.code,{children:"created_at"}),", ",(0,r.jsx)(n.code,{children:"updated_at"})," or ",(0,r.jsx)(n.code,{children:"deleted_at"}),". Precede with a ",(0,r.jsx)(n.code,{children:"-"})," character to reverse order."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"searchTerm"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"A search term to filter results by, will search the email, description and domain"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"disableControls"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Prevent any changes being made to account through the widget. User will not be able to enable or disable aliases through UI when this option is set"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideMeta"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Don't show account meta info (forward/ block count, quota usage etc)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideAliases"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Don't show email address / alias list. Will only show account meta info"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-13",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:' - type: anonaddy\n options:\n apiKey: "xxxxxxxxxxxxxxxxxxxxxxxx\\\n xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\\\n xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"\n limit: 5\n sortBy: created_at\n disableControls: true\n'})}),"\n",(0,r.jsx)(n.h4,{id:"info-13",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free for Self-Hosted / Free Plan available on managed instance or $1/month for premium"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted or Managed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://addy.io/privacy/",children:"addy.io Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"vulnerability-feed",children:"Vulnerability Feed"}),"\n",(0,r.jsx)(n.p,{children:"Keep track of recent security advisories and vulnerabilities, with optional filtering by score, exploits, vendor and product. All fields are optional."}),"\n",(0,r.jsxs)(n.p,{children:["Sources from: ",(0,r.jsx)(n.a,{href:"https://services.nvd.nist.gov/rest/json/cves/2.0",children:"https://services.nvd.nist.gov/rest/json/cves/2.0"}),"\nDocs: ",(0,r.jsx)(n.a,{href:"https://nvd.nist.gov/developers/vulnerabilities",children:"https://nvd.nist.gov/developers/vulnerabilities"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/cve"})}),"\n",(0,r.jsx)(n.h4,{id:"options-14",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"cveTag"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["This parameter returns only the CVE records that include the provided cveTag. Options are ",(0,r.jsx)(n.strong,{children:"disputed"}),", ",(0,r.jsx)(n.strong,{children:"unsupported-when-assigned"})," or ",(0,r.jsx)(n.strong,{children:"exclusively-hosted-service"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of results to fetch. Can be between ",(0,r.jsx)(n.code,{children:"5"})," and ",(0,r.jsx)(n.code,{children:"30"}),", defaults to ",(0,r.jsx)(n.code,{children:"5"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"cvssV2Severity"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["This parameter returns only the CVEs that match the provided CVSSv2 qualitative severity rating. Options are ",(0,r.jsx)(n.strong,{children:"LOW"}),", ",(0,r.jsx)(n.strong,{children:"MEDIUM"}),", ",(0,r.jsx)(n.strong,{children:"HIGH"})," or ",(0,r.jsx)(n.strong,{children:"CRITICAL"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"cvssV3Severity"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["This parameter returns only the CVEs that match the provided CVSSv3 qualitative severity rating. Options are ",(0,r.jsx)(n.strong,{children:"LOW"}),", ",(0,r.jsx)(n.strong,{children:"MEDIUM"}),", ",(0,r.jsx)(n.strong,{children:"HIGH"})," or ",(0,r.jsx)(n.strong,{children:"CRITICAL"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"cvssV4Severity"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["This parameter returns only the CVEs that match the provided CVSSv4 qualitative severity rating. Options are ",(0,r.jsx)(n.strong,{children:"LOW"}),", ",(0,r.jsx)(n.strong,{children:"MEDIUM"}),", ",(0,r.jsx)(n.strong,{children:"HIGH"})," or ",(0,r.jsx)(n.strong,{children:"CRITICAL"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"keywordSearch"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"This parameter returns only the CVEs where a word or phrase is found in the current description"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-14",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: cve-vulnerabilities\n"})}),"\n",(0,r.jsx)(n.p,{children:"or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: cve-vulnerabilities\n options:\n cveTag: disputed\n cvssV2Severity: CRITICAL\n limit: 30\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-14",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.cvedetails.com/privacy.php",children:"CVE Details Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"exchange-rates",children:"Exchange Rates"}),"\n",(0,r.jsx)(n.p,{children:"Display current FX rates in your native currency. Hover over a row to view more info, or click to show rates in that currency."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/currencies"})}),"\n",(0,r.jsx)(n.h4,{id:"options-15",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"inputCurrency"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The base currency to show results in. Specified as a 3-letter ISO-4217 code, see ",(0,r.jsx)(n.a,{href:"https://www.exchangerate-api.com/docs/supported-currencies",children:"here"})," for the full list of supported currencies, and their symbols"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"outputCurrencies"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["List or currencies to show results for. Specified as a 3-letter ISO-4217 code, see ",(0,r.jsx)(n.a,{href:"https://www.exchangerate-api.com/docs/supported-currencies",children:"here"})," for the full list of supported currencies, and their symbols"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["API key for ",(0,r.jsx)(n.a,{href:"https://www.exchangerate-api.com/",children:"exchangerate-api.com"}),", usually a 24-digit alpha-numeric string. You can sign up for a free account ",(0,r.jsx)(n.a,{href:"https://app.exchangerate-api.com/sign-up",children:"here"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-15",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: exchange-rates\n options:\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxx\n inputCurrency: GBP\n outputCurrencies:\n - USD\n - JPY\n - HKD\n - KPW\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-15",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 100,000 requests/ month)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.exchangerate-api.com/terms",children:"ExchangeRateAPI Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"public-holidays",children:"Public Holidays"}),"\n",(0,r.jsxs)(n.p,{children:["Counting down to the next day off work? This widget displays upcoming public holidays for your country. Data is fetched from ",(0,r.jsx)(n.a,{href:"http://kayaposoft.com/enrico/",children:"Enrico"})]}),"\n",(0,r.jsxs)(n.p,{children:["Note, config for this widget is case-sensitive (see ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/1268",children:"#1268"}),")"]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/holidays"})}),"\n",(0,r.jsx)(n.h4,{id:"options-16",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"country"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The country to fetch holiday data for, specified as a country code, e.g. ",(0,r.jsx)(n.code,{children:"GB"})," or ",(0,r.jsx)(n.code,{children:"US"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"state"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["restrict a country to a specific state defined by ",(0,r.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/ISO_3166-2",children:"ISO_3166-2"}),", e.g. ",(0,r.jsx)(n.code,{children:"LND"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"holidayType"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The type of holidays to fetch. Can be: ",(0,r.jsx)(n.code,{children:"all"}),", ",(0,r.jsx)(n.code,{children:"public_holiday"}),", ",(0,r.jsx)(n.code,{children:"observance"}),", ",(0,r.jsx)(n.code,{children:"school_holiday"}),", ",(0,r.jsx)(n.code,{children:"other_day"})," or ",(0,r.jsx)(n.code,{children:"extra_working_day"}),". Defaults to ",(0,r.jsx)(n.code,{children:"public_holiday"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"monthsToShow"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of months in advance to show. Min: ",(0,r.jsx)(n.code,{children:"1"}),", max: ",(0,r.jsx)(n.code,{children:"24"}),". Defaults to ",(0,r.jsx)(n.code,{children:"12"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"lang"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The language in which the events should be. Usually local languages and english are available. Default to first available in the country. e.g. ",(0,r.jsx)(n.code,{children:"en"})," or ",(0,r.jsx)(n.code,{children:"fr"}),"."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-16",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: public-holidays\n options:\n country: GB\n state: LND\n holidayType: all\n monthsToShow: 12\n lang: en\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-16",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/jurajmajer/enrico",children:"jurajmajer/enrico"}),") or Managed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"covid-19-status",children:"Covid-19 Status"}),"\n",(0,r.jsxs)(n.p,{children:["Keep track of the current COVID-19 status. Optionally also show cases by country, and a time-series chart. Uses live data from various sources, computed by ",(0,r.jsx)(n.a,{href:"https://disease.sh/",children:"disease.sh"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/covid"})}),"\n",(0,r.jsx)(n.h4,{id:"options-17",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showChart"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Also display a time-series chart showing number of recent cases"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showCountries"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Also display a list of cases per country"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"numDays"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Specify number of days worth of history to render on the chart"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"countries"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string[]"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["An array of countries to display, specified by their ",(0,r.jsx)(n.a,{href:"https://www.iso.org/obp/ui",children:"ISO-3 codes"}),". Leave blank to show all, sorted by most cases. ",(0,r.jsx)(n.code,{children:"showCountries"})," must be set to ",(0,r.jsx)(n.code,{children:"true"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If showing all countries, set a limit for number of results to return. Defaults to ",(0,r.jsx)(n.code,{children:"10"}),", no maximum"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-17",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: covid-stats\n"})}),"\n",(0,r.jsx)(n.p,{children:"Or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: covid-stats\n options:\n showChart: true\n showCountries: true\n countries:\n - GBR\n - USA\n - IND\n - RUS\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-17",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/disease-sh/api",children:"disease-sh/api"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Conditions"}),": ",(0,r.jsx)(n.a,{href:"https://github.com/disease-sh/api/blob/master/TERMS",children:"Terms of Use"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sports-scores",children:"Sports Scores"}),"\n",(0,r.jsxs)(n.p,{children:["Show recent scores and upcoming matches from your favorite sports team. Data is fetched from ",(0,r.jsx)(n.a,{href:"https://www.thesportsdb.com/",children:"TheSportsDB.com"}),". From the UI, you can click any other team to view their scores and upcoming games, or click a league name to see all teams."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/sports"})}),"\n",(0,r.jsx)(n.h4,{id:"options-18",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"teamId"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The ID of a team to fetch scores from. You can search for your team on the ",(0,r.jsx)(n.a,{href:"https://www.thesportsdb.com/teams_main.php",children:"Teams Page"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"leagueId"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Alternatively, provide a league ID to fetch all games from. You can find the ID on the ",(0,r.jsx)(n.a,{href:"https://www.thesportsdb.com/Sport/Leagues",children:"Leagues Page"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"pastOrFuture"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Set to ",(0,r.jsx)(n.code,{children:"past"})," to show scores for recent games, or ",(0,r.jsx)(n.code,{children:"future"})," to show upcoming games. Defaults to ",(0,r.jsx)(n.code,{children:"past"}),". You can change this within the UI"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Optionally specify your API key, which you can sign up for at ",(0,r.jsx)(n.a,{href:"https://www.thesportsdb.com/",children:"TheSportsDB.com"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["To limit output to a certain number of matches, defaults to ",(0,r.jsx)(n.code,{children:"15"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideImage"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Set to ",(0,r.jsx)(n.code,{children:"true"})," to not render the team / match banner image, defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-18",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: sports-scores\n options:\n teamId: 133636\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-18",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 30 requests / minute, limited endpoints)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"news-headlines",children:"News Headlines"}),"\n",(0,r.jsxs)(n.p,{children:["Displays the latest news, click to read full article. Date is fetched from various news sources using ",(0,r.jsx)(n.a,{href:"https://currentsapi.services/en",children:"Currents API"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/news"})}),"\n",(0,r.jsx)(n.h4,{id:"options-19",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your API key for CurrentsAPI. This is free, and you can ",(0,r.jsx)(n.a,{href:"https://currentsapi.services/en/register",children:"get one here"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"country"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Fetch news only from a certain country or region. Specified as a country code, e.g. ",(0,r.jsx)(n.code,{children:"GB"})," or ",(0,r.jsx)(n.code,{children:"US"}),". See ",(0,r.jsx)(n.a,{href:"https://api.currentsapi.services/v1/available/regions",children:"here"})," for a list of supported regions"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"category"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Only return news from within a given category, e.g. ",(0,r.jsx)(n.code,{children:"sports"}),", ",(0,r.jsx)(n.code,{children:"programming"}),", ",(0,r.jsx)(n.code,{children:"world"}),", ",(0,r.jsx)(n.code,{children:"science"}),". The ",(0,r.jsx)(n.a,{href:"https://api.currentsapi.services/v1/available/categories",children:"following categories"})," are supported"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"lang"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify the language for returned articles as a 2-digit ISO code (limited article support). The ",(0,r.jsx)(n.a,{href:"https://api.currentsapi.services/v1/available/languages",children:"following languages"})," are supported, defaults to ",(0,r.jsx)(n.code,{children:"en"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"count"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit the number of results. Can be between ",(0,r.jsx)(n.code,{children:"1"})," and ",(0,r.jsx)(n.code,{children:"200"}),", defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"keywords"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Only return articles that contain an exact match within their title or description"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideImages"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", then article image thumbnails will not be displayed"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-19",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: news-headlines\n options:\n apiKey: xxxxxxx\n category: world\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-19",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 600 requests / day)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://currentsapi.services/privacy",children:"CurrentsAPI Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"tfl-status",children:"TFL Status"}),"\n",(0,r.jsx)(n.p,{children:"Shows real-time tube status of the London Underground. All fields are optional."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/tfl"})}),"\n",(0,r.jsx)(n.h4,{id:"options-20",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showAll"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["By default, details for lines with a Good Service are not visible, but you can click More Details to see all. Setting this option to ",(0,r.jsx)(n.code,{children:"true"})," will show all lines on initial page load"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"sortAlphabetically"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["By default lines are sorted by current status, set this option to ",(0,r.jsx)(n.code,{children:"true"})," to instead sort them alphabetically"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"linesToShow"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"By default all lines are shown. If you're only interested in the status of a few lines, then pass in an array of lines to show, specified by name"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-20",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: tfl-status\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: tfl-status\n options:\n showAll: true\n sortAlphabetically: true\n linesToShow:\n - District\n - Jubilee\n - Central\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-20",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://tfl.gov.uk/corporate/privacy-and-cookies/",children:"TFL Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stock-price-history",children:"Stock Price History"}),"\n",(0,r.jsx)(n.p,{children:"Shows recent price history for a given publicly-traded stock or share"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/stocks"})}),"\n",(0,r.jsx)(n.h4,{id:"options-21",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["API key for ",(0,r.jsx)(n.a,{href:"https://www.alphavantage.co/",children:"Alpha Vantage"}),", you can get a free API key ",(0,r.jsx)(n.a,{href:"https://www.alphavantage.co/support/#api-key",children:"here"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"stock"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The stock symbol for the asset to fetch data for"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"priceTime"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The time to fetch price for. Can be ",(0,r.jsx)(n.code,{children:"high"}),", ",(0,r.jsx)(n.code,{children:"low"}),", ",(0,r.jsx)(n.code,{children:"open"})," or ",(0,r.jsx)(n.code,{children:"close"}),". Defaults to ",(0,r.jsx)(n.code,{children:"high"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColor"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Color of the chart value. Defaults to ",(0,r.jsx)(n.code,{children:"--widget-text-color"})," which inherits dashboard primary color"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The height of rendered chart in px. Defaults to ",(0,r.jsx)(n.code,{children:"300"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-21",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: stock-price-chart\n options:\n stock: NET\n apiKey: PGUWSWD6CZTXMT8N\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-21",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 500 requests/day)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.alphavantage.co/privacy/",children:"AlphaVantage Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"eth-gas-prices",children:"ETH Gas Prices"}),"\n",(0,r.jsxs)(n.p,{children:["Renders the current Gas cost of transactions on the Ethereum network (in both GWEI and USD), along with recent historical prices. Useful for spotting a good time to transact. Uses data from ",(0,r.jsx)(n.a,{href:"https://ethgas.watch/",children:"ethgas.watch"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/eth-gas"})}),"\n",(0,r.jsx)(n.h4,{id:"options-22",children:"Options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"No config options."})}),"\n",(0,r.jsx)(n.h4,{id:"example-22",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: eth-gas-prices\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-22",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/wslyvh/ethgaswatch",children:"wslyvh/ethgaswatch"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"joke",children:"Joke"}),"\n",(0,r.jsxs)(n.p,{children:["Renders a programming or generic joke. Data is fetched from the ",(0,r.jsx)(n.a,{href:"https://github.com/Sv443/JokeAPI",children:"JokesAPI"})," by @Sv443. All fields are optional."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/joke"})}),"\n",(0,r.jsx)(n.h4,{id:"options-23",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"category"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Set the category of jokes to return. Use a string to specify a single category, or an array to pass in multiple options. Available options are: ",(0,r.jsx)(n.code,{children:"all"}),", ",(0,r.jsx)(n.code,{children:"programming"}),", ",(0,r.jsx)(n.code,{children:"pun"}),", ",(0,r.jsx)(n.code,{children:"dark"}),", ",(0,r.jsx)(n.code,{children:"spooky"}),", ",(0,r.jsx)(n.code,{children:"christmas"})," and ",(0,r.jsx)(n.code,{children:"misc"}),". An up-to-date list of supported categories can be found ",(0,r.jsx)(n.a,{href:"https://v2.jokeapi.dev/categories",children:"here"}),". Defaults to ",(0,r.jsx)(n.code,{children:"all"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"safeMode"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Set to ",(0,r.jsx)(n.code,{children:"true"}),", to prevent the fetching of any NSFW jokes. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"language"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify the language for returned jokes. The following languages are supported: ",(0,r.jsx)(n.code,{children:"en"}),", ",(0,r.jsx)(n.code,{children:"cs"}),", ",(0,r.jsx)(n.code,{children:"de"}),", ",(0,r.jsx)(n.code,{children:"es"}),", ",(0,r.jsx)(n.code,{children:"fr"})," and ",(0,r.jsx)(n.code,{children:"pt"}),", and an up-to-date list of supported languages can be found ",(0,r.jsx)(n.a,{href:"https://v2.jokeapi.dev/languages",children:"here"}),". By default, your system language will be used, if it's supported, otherwise English"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-23",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: joke\n options:\n safeMode: true\n language: en\n category: Programming\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-23",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/Sv443/JokeAPI",children:"Sv443/JokeAPI"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://sv443.net/privacypolicy/en",children:"SV443's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"chuck-norris-quotes",children:"Chuck Norris quotes"}),"\n",(0,r.jsxs)(n.p,{children:["Renders a Chuck Norris quote. Data is fetched from the ",(0,r.jsx)(n.a,{href:"https://api.chucknorris.io/",children:"ChuckNorrisAPI"})," by @matchilling. All fields are optional."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://tbd"})}),"\n",(0,r.jsx)(n.h4,{id:"options-24",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"categories"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Set the category of jokes to return. Use a string to specify a single category, or an array to pass in multiple options. Available options are: ",(0,r.jsx)(n.code,{children:"animal"}),",",(0,r.jsx)(n.code,{children:"career"}),",",(0,r.jsx)(n.code,{children:"celebrity"}),",",(0,r.jsx)(n.code,{children:"dev"}),",",(0,r.jsx)(n.code,{children:"explicit"}),",",(0,r.jsx)(n.code,{children:"fashion"}),",",(0,r.jsx)(n.code,{children:"food"}),",",(0,r.jsx)(n.code,{children:"history"}),",",(0,r.jsx)(n.code,{children:"money"}),",",(0,r.jsx)(n.code,{children:"movie"}),",",(0,r.jsx)(n.code,{children:"music"}),",",(0,r.jsx)(n.code,{children:"political"}),",",(0,r.jsx)(n.code,{children:"religion"}),",",(0,r.jsx)(n.code,{children:"science"}),",",(0,r.jsx)(n.code,{children:"sport"})," and ",(0,r.jsx)(n.code,{children:"travel"}),". An up-to-date list of supported categories can be found ",(0,r.jsx)(n.a,{href:"https://api.chucknorris.io/jokes/categories",children:"here"}),". Defaults to not explicitely set and therefore any of the categories can come up."]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-24",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: chucknorris\n options:\n categories: history,sport\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-24",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://api.chucknorris.io/privacy",children:"matchilling's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"xkcd-comics",children:"XKCD Comics"}),"\n",(0,r.jsxs)(n.p,{children:["Have a laugh with the daily comic from ",(0,r.jsx)(n.a,{href:"https://xkcd.com/",children:"XKCD"}),". A classic webcomic website covering everything from Linux, math, romance, science and language. All fields are optional."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/xkcd"})}),"\n",(0,r.jsx)(n.h4,{id:"options-25",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"comic"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string / number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Choose which comic to display. Set to either ",(0,r.jsx)(n.code,{children:"random"}),", ",(0,r.jsx)(n.code,{children:"latest"})," or the series number of a specific comic, like ",(0,r.jsx)(n.code,{children:"627"}),". Defaults to ",(0,r.jsx)(n.code,{children:"latest"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-25",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: xkcd-comic\n options:\n comic: latest\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-25",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"flight-data",children:"Flight Data"}),"\n",(0,r.jsxs)(n.p,{children:["Displays airport departure and arrival flights, using data from ",(0,r.jsx)(n.a,{href:"https://www.aerodatabox.com/",children:"AeroDataBox"}),". Useful if you live near an airport and often wonder where the flight overhead is going to. Hover over a row for more flight data."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/flights"})}),"\n",(0,r.jsx)(n.h4,{id:"options-26",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"airport"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The airport to show flight data from. Should be specified as a 4-character ICAO-code, a full list of which can be found ",(0,r.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/ICAO_airport_code",children:"here"})," (example: ",(0,r.jsx)(n.code,{children:"KBJC"})," or ",(0,r.jsx)(n.code,{children:"EGKK"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["A valid ",(0,r.jsx)(n.a,{href:"https://rapidapi.com/",children:"RapidAPI"})," Key, with ",(0,r.jsx)(n.a,{href:"https://rapidapi.com/aerodatabox/api/aerodatabox/",children:"AeroDataBox"})," enabled (check in your ",(0,r.jsx)(n.a,{href:"https://rapidapi.com/developer/billing/subscriptions-and-usage",children:"Subscription Dashboard"}),"). This API is free to sign up for and use"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"For busy airports, you may wish to limit the number of results visible"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"direction"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["By default, both departure and arrival flights will be fetched, if you would like to only show flights in one direction, set this to wither ",(0,r.jsx)(n.code,{children:"departure"})," or ",(0,r.jsx)(n.code,{children:"arrival"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-26",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: flight-data\n options:\n airport: EGLC\n apiKey: XXXXX\n limit: 12\n direction: all\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-26",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 150 requests / month)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.aerodatabox.com/#h.p_cxtiyzwf_wqd",children:"AeroDataBox"})," and ",(0,r.jsx)(n.a,{href:"https://rapidapi.com/privacy/",children:"RapidAPI Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"astronomy-picture-of-the-day",children:"Astronomy Picture of the Day"}),"\n",(0,r.jsxs)(n.p,{children:["Show the NASA Astronomy Picture of the Day. Data is fetched from ",(0,r.jsx)(n.a,{href:"https://apod.nasa.gov/apod/",children:"APOD"})," using ",(0,r.jsx)(n.a,{href:"https://github.com/lissy93/go-apod",children:"@Lissy93/go-apod"})," / hosted at ",(0,r.jsx)(n.a,{href:"https://apod.as93.net/",children:"apod.as93.net"}),"."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://storage.googleapis.com/as93-screenshots/dashy/apod.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-27",children:"Options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"No config options."})}),"\n",(0,r.jsx)(n.h4,{id:"example-27",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: apod\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-27",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/lissy93/go-apod",children:"@Lissy93/go-apod"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.nasa.gov/about/highlights/HP_Privacy.html",children:"NASA's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"github-trending",children:"GitHub Trending"}),"\n",(0,r.jsxs)(n.p,{children:["Displays currently trending projects on GitHub. Optionally specify a language and time-frame. Data is fetched from ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/gh-trending-no-cors",children:"Lissy93/gh-trending-no-cors"})," using the GitHub API. All fields are optional."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/github-trending"})}),"\n",(0,r.jsx)(n.h4,{id:"options-28",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"lang"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["A programming language to fetch trending repos from that category. E.g. ",(0,r.jsx)(n.code,{children:"javascript"})," or ",(0,r.jsx)(n.code,{children:"go"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"since"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The timeframe to use when calculating trends. Can be either ",(0,r.jsx)(n.code,{children:"daily"}),", ",(0,r.jsx)(n.code,{children:"weekly"})," or ",(0,r.jsx)(n.code,{children:"monthly"}),". Defaults to ",(0,r.jsx)(n.code,{children:"daily"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Optionally limit the number of results. Max ",(0,r.jsx)(n.code,{children:"25"}),", default is ",(0,r.jsx)(n.code,{children:"10"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-28",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: github-trending-repos\n options:\n limit: 8\n since: weekly\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-28",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/gh-trending-no-cors",children:"Lissy93/gh-trending-no-cors"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://docs.github.com/en/github/site-policy/github-privacy-statement",children:"GitHub's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"github-profile-stats",children:"GitHub Profile Stats"}),"\n",(0,r.jsxs)(n.p,{children:["Display stats from your GitHub profile, using embedded cards from ",(0,r.jsx)(n.a,{href:"https://github.com/anuraghazra/github-readme-stats",children:"anuraghazra/github-readme-stats"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/github-stats"})}),"\n",(0,r.jsx)(n.h4,{id:"options-29",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The GitHub username to fetch info for. E.g. ",(0,r.jsx)(n.code,{children:"lissy93"}),". (Not required if ",(0,r.jsx)(n.code,{children:"hideProfileCard"})," and ",(0,r.jsx)(n.code,{children:"hideLanguagesCard"})," are both set to ",(0,r.jsx)(n.code,{children:"true"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideProfileCard"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", the users profile card will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideLanguagesCard"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", the users top languages card will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"repos"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If you'd like to also display stats for some GitHub repositories, then add an array or repo names here. Specified as ",(0,r.jsx)(n.code,{children:"[username]/[repo-name]"}),", e.g. ",(0,r.jsx)(n.code,{children:"lissy93/dashy"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-29",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: github-profile-stats\n options:\n username: Lissy93\n hideLanguagesCard: true\n repos:\n - lissy93/dashy\n - lissy93/personal-security-checklist\n - lissy93/twitter-sentiment-visualisation\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-29",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/anuraghazra/github-readme-stats",children:"anuraghazra/github-readme-stats"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://docs.github.com/en/github/site-policy/github-privacy-statement",children:"GitHub's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"healthchecks-status",children:"HealthChecks Status"}),"\n",(0,r.jsx)(n.p,{children:"Display status of one or more HealthChecks project(s). Works with healthchecks.io and your selfhosted instance."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/healthchecks"})}),"\n",(0,r.jsx)(n.h4,{id:"options-30",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Optional"}),(0,r.jsxs)(n.td,{children:["The base url of your instance, default is ",(0,r.jsx)(n.code,{children:"https://healthchecks.io"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"string"})," or ",(0,r.jsx)(n.code,{children:"array"})]}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"One or more API keys for your healthcheck projects. (Read-only works fine)"})]})]})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: HealthChecks\n options:\n host: https://healthcheck.your-domain.de\n apiKey: \n - abcdefg...\n - zxywvu...\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-30",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free / Paid / Self-hosted"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/healthchecks/healthchecks",children:"healthchecks/healthchecks"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://healthchecks.io/privacy/",children:"Healthchecks.io Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"hackernews-trending",children:"Hackernews Trending"}),"\n",(0,r.jsx)(n.p,{children:"Display new and trending Posts from Hackernews"}),"\n",(0,r.jsx)(n.h4,{id:"options-31",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"stories"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["HN Stories to display defaults to ",(0,r.jsx)(n.code,{children:"topstories"}),". Options are: ",(0,r.jsx)(n.code,{children:"beststories"}),", ",(0,r.jsx)(n.code,{children:"topstories"})," or ",(0,r.jsx)(n.code,{children:"newstories"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"int"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"The size of the list of Posts to show."})]})]})]}),"\n",(0,r.jsx)(n.h5,{id:"example-30",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: hackernews-trending\n options:\n stories: newstories\n limit: 10\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"mvg-departure",children:"MVG Departure"}),"\n",(0,r.jsx)(n.p,{children:"Display departure time of a MVG (M\xfcnchner Verkehrs Gesellschaft) station."}),"\n",(0,r.jsxs)(n.p,{children:["From ",(0,r.jsx)(n.a,{href:"https://www.mvg.de/impressum.html",children:"https://www.mvg.de/impressum.html"}),":"]}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:"[...] Die Verarbeitung unserer Inhalte oder Daten durch Dritte erfordert unsere ausdr\xfcckliche Zustimmung. F\xfcr private, nicht-kommerzielle Zwecke, wird eine gem\xe4\xdfigte Nutzung ohne unsere ausdr\xfcckliche Zustimmung geduldet. Jegliche Form von Data-Mining stellt keine gem\xe4\xdfigte Nutzung dar.[...]"}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"In other words: Private, noncomercial, moderate use of the API is tolerated. They don\u2019t consider data mining as moderate use. (This is not a legal advice)"}),"\n",(0,r.jsx)(n.h4,{id:"options-32",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"location"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The name of the location (exact) or the location id, startin with ",(0,r.jsx)(n.code,{children:"de:09162:"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"integer"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Limit number of entries, defaults to 10."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"A custom title to be displayed."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"header"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"bool"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Shall the title be shown?"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"object"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.line"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for given line(s)."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.product"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for specific product (TRAM, UBAHN, SBAHN, BUS)."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.destination"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/object"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for specific destination(s)"})]})]})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: mvg\n options:\n location: Marienplatz\n limit: 5\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-31",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free / Private use only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": ",(0,r.jsx)(n.a,{href:"https://mvg.de",children:"MVG"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.mvg.de/datenschutz-mvg.html",children:"MVG Datenschutz"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"mvg-connection",children:"MVG Connection"}),"\n",(0,r.jsx)(n.p,{children:"Display the next connection for two addresses/coordinates, stations or POI within Munich using MVG MVG (M\xfcnchner Verkehrs Gesellschaft)."}),"\n",(0,r.jsxs)(n.p,{children:["From ",(0,r.jsx)(n.a,{href:"https://www.mvg.de/impressum.html",children:"https://www.mvg.de/impressum.html"}),":"]}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:"[...] Die Verarbeitung unserer Inhalte oder Daten durch Dritte erfordert unsere ausdr\xfcckliche Zustimmung. F\xfcr private, nicht-kommerzielle Zwecke, wird eine gem\xe4\xdfigte Nutzung ohne unsere ausdr\xfcckliche Zustimmung geduldet. Jegliche Form von Data-Mining stellt keine gem\xe4\xdfigte Nutzung dar.[...]"}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"In other words: Private, noncomercial, moderate use of the API is tolerated. They don\u2019t consider data mining as moderate use. (This is not a legal advice)"}),"\n",(0,r.jsx)(n.h4,{id:"options-33",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"origin"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Origin of the connection."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"destination"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Destination of the connection."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"A custom title to be displayed."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"header"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"bool"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Shall the title be shown?"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"object"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.line"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for given line(s)."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.product"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for specific product (TRAM, UBAHN, SBAHN, BUS)."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.destination"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/object"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for specific destination(s)"})]})]})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: mvg-connection\n options:\n from: Marienplatz\n from: Dachauer Stra\xdfe 123\n header: true\n filters:\n product: [UBAHN]\n line: [U1,U2,U4,U5]\n\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-32",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free / Private use only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": ",(0,r.jsx)(n.a,{href:"https://mvg.de",children:"MVG"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.mvg.de/datenschutz-mvg.html",children:"MVG Datenschutz"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"custom-list",children:"Custom List"}),"\n",(0,r.jsx)(n.p,{children:"Renders custom schema-compliant JOSN in a list."}),"\n",(0,r.jsx)(n.h4,{id:"options-34",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"url"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"text"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A string containing the url of a json file."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"text"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"A title for the widget. Can be helpful if stacking multiple lists in the same section."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"daysForNew"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:"Optional"}),(0,r.jsx)(n.td,{children:"Used to highlight new items."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"json-schema",children:"Json Schema"}),"\n",(0,r.jsx)(n.p,{children:"The input file should comply with the following schema:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'{\n "$schema": "http://json-schema.org/draft-04/schema#",\n "type": "array",\n "items": [\n {\n "type": "object",\n "properties": {\n "link": {\n "type": "object",\n "properties": {\n "text": {\n "type": "string"\n },\n "url": {\n "type": "string"\n },\n "title": {\n "type": "string"\n }\n },\n "required": [\n "text",\n "url",\n "title"\n ]\n },\n "value": {\n "type": "object",\n "properties": {\n "text": {\n "type": "string"\n },\n "title": {\n "type": "string"\n }\n },\n "required": [\n "text",\n "title"\n ]\n },\n "date": {\n "type": "string"\n }\n },\n "required": [\n "link",\n "value",\n "date"\n ]\n }\n ]\n}\n'})}),"\n",(0,r.jsx)(n.p,{children:"Example: This json data was generated by a data worflow that gets the new releases of a few projects from GitHub. The system used to build the data workflow is n8n."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'[\n {\n "link": {\n "text": "jellyfin/jellyfin",\n "url": "https://github.com/jellyfin/jellyfin/releases/tag/v10.10.7",\n "title": ""\n },\n "value": {\n "text": "v10.10.7",\n "title": "2025-04-05"\n },\n "date": "2025-04-05T19:14:59Z"\n },\n {\n "link": {\n "text": "jellyfin/jellyfin-web",\n "url": "https://github.com/jellyfin/jellyfin-web/releases/tag/v10.10.7",\n "title": ""\n },\n "value": {\n "text": "v10.10.7",\n "title": "2025-04-05"\n },\n "date": "2025-04-05T19:15:00Z"\n },\n {\n "link": {\n "text": "lissy93/dashy",\n "url": "https://github.com/Lissy93/dashy/releases/tag/3.1.1",\n "title": ""\n },\n "value": {\n "text": "3.1.1",\n "title": "2024-05-30"\n },\n "date": "2024-05-30T17:20:53Z"\n },\n {\n "link": {\n "text": "VSCodium/vscodium",\n "url": "https://github.com/VSCodium/vscodium/releases/tag/1.102.14746",\n "title": ""\n },\n "value": {\n "text": "1.102.14746",\n "title": "2025-07-16"\n },\n "date": "2025-07-16T18:27:49Z"\n }\n]\n'})}),"\n",(0,r.jsx)(n.h4,{id:"notes",children:"Notes"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"This widget is designed to render data generated by another system that complies with the schema. The example JSON data above was generated using a n8n workflow, and other ETL or workflow systems can generate similar results."}),"\n",(0,r.jsx)(n.li,{children:"To avoid requests to a different system in each refresh, you can save the input files locally in the user-data folder inside your Dashy installation."}),"\n",(0,r.jsxs)(n.li,{children:["To use json files from a different domain, remember to add ",(0,r.jsx)(n.code,{children:"useProxy: true"})," to the widget configuration. I have not tested this use case because I save all my input data locally on the Dashy server. Please open a ticket if you have an issue in this use case."]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"example-31",children:"Example"}),"\n",(0,r.jsxs)(n.p,{children:["This widget renders a json file that from a ",(0,r.jsx)(n.code,{children:"json-data"})," directory inside the ",(0,r.jsx)(n.code,{children:"user-data"})," directory on the Dashy server."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: custom-list\n options:\n url: /json-data/github-releases.json\n title: 'Github Releases'\n daysForNew: 5\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-33",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Not needed for files hosted inside the ",(0,r.jsx)(n.code,{children:"user-data"})," directory. Use ",(0,r.jsx)(n.code,{children:"useProxy: true"})," to bypass CORS restrictions when using data from a different server."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": user defined"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": depends on the user defined host."]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"custom-search",children:"Custom search"}),"\n",(0,r.jsx)(n.p,{children:"Allows web search using multiple user-defined search engines and other websites."}),"\n",(0,r.jsx)(n.h4,{id:"options-35",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"engines"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:"required"}),(0,r.jsxs)(n.td,{children:["An array of search engine objects. Each search engine object should have two required properties: ",(0,r.jsx)(n.strong,{children:"title"})," and ",(0,r.jsx)(n.strong,{children:"url"}),". See the example below."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"placeholder"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"Placeholder text in the search box."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"openingMethod"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsxs)(n.td,{children:["Open search in one of ",(0,r.jsx)(n.code,{children:"newtab"}),", ",(0,r.jsx)(n.code,{children:"sametab"})," or ",(0,r.jsx)(n.code,{children:"workspace"}),"."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"notes-1",children:"Notes"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["The first search engine in the engines array will be treated as the default search engine, and used when the user presses ",(0,r.jsx)(n.code,{children:"Enter"})," in the search box."]}),"\n",(0,r.jsx)(n.li,{children:"Popup blockers can interfere with opening a new search window."}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"example-32",children:"Example"}),"\n",(0,r.jsx)(n.p,{children:"This widget allows searching multiple search engines from dashy."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: 'custom-search'\n options:\n placeholder: Search for something using the buttons below\n engines:\n - title: SearXNG\n url: https://searx.lan/?q=\n - title: Quant\n url: https://www.qwant.com/?q=\n - title: Bing Web\n url: http://www.bing.com/search?q=\n - title: Bing Images\n url: http://www.bing.com/images/search?q=\n - title: Bing Maps\n url: http://www.bing.com/maps/search?q=\n - title: Yandex\n url: https://www.yandex.com/search/?text=\n - title: Passmark\n url: https://www.passmark.com/search/zoomsearch.php?zoom_query=\n - title: IMDB\n url: http://www.imdb.com/find?q=\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-34",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Not needed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": user defined"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": depends on the user defined search engines."]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"rescuetime-overview",children:"RescueTime Overview"}),"\n",(0,r.jsx)(n.p,{children:"Show an overview of how you have spent your time for the current day."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/rescue-time"})}),"\n",(0,r.jsx)(n.h4,{id:"options-36",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"required"}),(0,r.jsx)(n.td,{children:"The API-Key generated in the RescueTime UI."})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-33",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: rescue-time\n useProxy: true\n options:\n apiKey: abcdefghijkl_mnop\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-35",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Depends on user subscription"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": ",(0,r.jsx)(n.a,{href:"https://www.rescuetime.com",children:"RescueTime"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.rescuetime.com/privacy",children:"RescueTime Privacy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"minecraft-server",children:"Minecraft Server"}),"\n",(0,r.jsx)(n.p,{children:"Show minecraft server status"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://i.ibb.co/hcmd4Wf/minecraft-widget.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-37",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Display title for server uses server address if not set."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"server"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Server hostname or ip(:port) will use srv records."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"bedrock"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If server is a bedrock edition server. (default false)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showMods"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Display mod list if available"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showPlayers"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Display player list if available"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showPlugins"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Display plugin list if available"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-34",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: minecraft-status\n options:\n title: Venity Network\n server: play.venitymc.com\n bedrock: true\n showMods: true\n showPlayers: true\n showPlugins: true\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-36",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": ",(0,r.jsx)(n.a,{href:"https://mcsrvstat.us/",children:"Minecraft Server Status"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://mcsrvstat.us/faq",children:"Minecraft Server Status FAQ"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"self-hosted-services-widgets",children:"Self-Hosted Services Widgets"}),"\n",(0,r.jsx)(n.h3,{id:"system-info",children:"System Info"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.mvg.de/datenschutz-mvg.html",children:"MVG Datenschutz"})]}),"\nDisplays info about the server which Dashy is hosted on. Includes user + host, operating system, uptime and basic memory & load data."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/system-info"})}),"\n",(0,r.jsx)(n.h4,{id:"options-38",children:"Options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"No config options."})}),"\n",(0,r.jsx)(n.h4,{id:"example-35",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: system-info\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-37",children:"Info"}),"\n",(0,r.jsx)(n.p,{children:"No external data requests made"}),"\n",(0,r.jsxs)(n.p,{children:["Note that this widget is not available if you are running Dashy in a container or VM. Instead you can use the ",(0,r.jsx)(n.a,{href:"#system-resource-monitoring",children:"System Monitoring"})," widgets to display stats from the host system instead."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cron-monitoring-health-checks",children:"Cron Monitoring (Health Checks)"}),"\n",(0,r.jsxs)(n.p,{children:["Cron job monitoring using ",(0,r.jsx)(n.a,{href:"https://github.com/healthchecks/healthchecks",children:"Health Checks"}),". Both managed and self-hosted instances are supported."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/cron-monitor"})}),"\n",(0,r.jsx)(n.h4,{id:"options-39",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A read-only API key for the project to monitor. You can generate this by selecting a Project --\x3e Settings --\x3e API Access. Note that you must generate a separate key for each project"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If you're self-hosting, or using any instance other than the official (healthchecks.io), you will need to specify the host address. E.g. ",(0,r.jsx)(n.code,{children:"https://healthchecks.example.com"})," or ",(0,r.jsx)(n.code,{children:"http://cron-monitoing.local"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-36",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: health-checks\n options:\n apiKey: XXXXXXXXX\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-38",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 20 services, or self-host for unlimited)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/healthchecks/healthchecks",children:"GitHub - HealthChecks"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://healthchecks.io/privacy/",children:"Health-Checks Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cpu-history-netdata",children:"CPU History (NetData)"}),"\n",(0,r.jsx)(n.p,{children:"Pull recent CPU usage history from NetData."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/cpu-history"})}),"\n",(0,r.jsx)(n.h4,{id:"options-40",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your NetData instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The height of rendered chart in px. Defaults to ",(0,r.jsx)(n.code,{children:"300"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColor"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColors"})})]}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"string"})," / ",(0,r.jsx)(n.code,{children:"array"})]}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Color of the chart value(s) as hex codes. ",(0,r.jsx)(n.code,{children:"chartColor"})," is a single value (defaults to ",(0,r.jsx)(n.code,{children:"--widget-text-color"}),"), whereas ",(0,r.jsx)(n.code,{children:"chartColors"})," is an array of colors"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-37",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nd-cpu-history\n options:\n host: http://192.168.1.1:19999\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-39",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/netdata/netdata",children:"GitHub - NetData"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.netdata.cloud/data-privacy/",children:"NetData Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"memory-history-netdata",children:"Memory History (NetData)"}),"\n",(0,r.jsx)(n.p,{children:"Pull recent system RAM usage from NetData, and show as a breakdown of different categories."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://i.ibb.co/2dsSWnk/nd-memory-history.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-41",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your NetData instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The height of rendered chart in px. Defaults to ",(0,r.jsx)(n.code,{children:"300"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColor"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColors"})})]}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"string"})," / ",(0,r.jsx)(n.code,{children:"array"})]}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Color of the chart value(s) as hex codes. ",(0,r.jsx)(n.code,{children:"chartColor"})," is a single value (defaults to ",(0,r.jsx)(n.code,{children:"--widget-text-color"}),"), whereas ",(0,r.jsx)(n.code,{children:"chartColors"})," is an array of colors"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-38",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nd-ram-history\n options:\n host: http://192.168.1.1:19999\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-40",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/netdata/netdata",children:"GitHub - NetData"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.netdata.cloud/data-privacy/",children:"NetData Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"load-history-netdata",children:"Load History (NetData)"}),"\n",(0,r.jsx)(n.p,{children:"Pull recent load usage in 1, 5 and 15 minute intervals, from NetData."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/load-history"})}),"\n",(0,r.jsx)(n.h4,{id:"options-42",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your NetData instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The height of rendered chart in px. Defaults to ",(0,r.jsx)(n.code,{children:"300"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColor"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColors"})})]}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"string"})," / ",(0,r.jsx)(n.code,{children:"array"})]}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Color of the chart value(s) as hex codes. ",(0,r.jsx)(n.code,{children:"chartColor"})," is a single value (defaults to ",(0,r.jsx)(n.code,{children:"--widget-text-color"}),"), whereas ",(0,r.jsx)(n.code,{children:"chartColors"})," is an array of colors"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-39",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nd-load-history\n options:\n host: http://192.168.1.1:19999\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-41",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/netdata/netdata",children:"GitHub - NetData"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.netdata.cloud/data-privacy/",children:"NetData Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-stats",children:"Pi-Hole Stats"}),"\n",(0,r.jsxs)(n.p,{children:["Displays the number of queries blocked by ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"}),"."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/pi-hole"})}),"\n",(0,r.jsx)(n.h4,{id:"options-43",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideStatus"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideChart"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideInfo"})})]}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide any of the three parts of the widget"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password. It is ",(0,r.jsx)(n.strong,{children:"NOT"})," your pi-hole admin interface or server password. It can be found in ",(0,r.jsx)(n.code,{children:"/etc/pihole/setupVars.conf"}),", and is a 64-character located on the line that starts with ",(0,r.jsx)(n.code,{children:"WEBPASSWORD"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-40",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-stats\n options:\n hostname: http://192.168.130.1\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["[!TIP]\nIn order to avoid leaking secret data, both ",(0,r.jsx)(n.code,{children:"hostname"})," and ",(0,r.jsx)(n.code,{children:"apiKey"})," can leverage environment variables. Simply pass the name of the variable, which MUST start with ",(0,r.jsx)(n.code,{children:"VUE_APP_"}),"."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-stats\n options:\n hostname: VUE_APP_pihole_ip\n apiKey: VUE_APP_pihole_key\n"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:"[!IMPORTANT]\nYou will need to restart the server (or the docker image) if adding/editing an env var for this to be refreshed."}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"info-42",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-Hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-stats-v6",children:"Pi-Hole Stats v6"}),"\n",(0,r.jsxs)(n.p,{children:["Displays the number of queries blocked by ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"}),". Use this version of the widget if you have a v6+ Pi-Hole instance."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://i.ibb.co/zftCLJN/pi-hole-stats.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-44",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideStatus"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideChart"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideInfo"})})]}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide any of the three parts of the widget"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password or application password. It ",(0,r.jsx)(n.strong,{children:"IS"})," your Pi-Hole admin interface password ",(0,r.jsx)(n.strong,{children:"UNLESS"})," you have 2FA turned on (in contrast to the old widget). If you have 2FA turned on you will need to create an application password. Refer to Pi-Hole documentation for how to create an application password."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-41",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-stats-v6\n options:\n hostname: http://192.168.130.1\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["[!TIP]\nIn order to avoid leaking secret data, both ",(0,r.jsx)(n.code,{children:"hostname"})," and ",(0,r.jsx)(n.code,{children:"apiKey"})," can leverage environment variables. Simply pass the name of the variable, which MUST start with ",(0,r.jsx)(n.code,{children:"VUE_APP_"}),"."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-stats-v6\n options:\n hostname: VUE_APP_pihole_ip\n apiKey: VUE_APP_pihole_key\n"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:"[!IMPORTANT]\nYou will need to restart the server (or the docker image) if adding/editing an env var for this to be refreshed."}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"info-43",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-Hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-queries",children:"Pi-Hole Queries"}),"\n",(0,r.jsxs)(n.p,{children:["Shows top queries that were blocked and allowed by ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"}),"."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/pi-hole-queries"})}),"\n",(0,r.jsx)(n.h4,{id:"options-45",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password. It is ",(0,r.jsx)(n.strong,{children:"NOT"})," your pi-hole admin interface or server password. It can be found in ",(0,r.jsx)(n.code,{children:"/etc/pihole/setupVars.conf"}),", and is a 64-character located on the line that starts with ",(0,r.jsx)(n.code,{children:"WEBPASSWORD"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"count"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of queries to display. Defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-42",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-top-queries\n options:\n hostname: https://pi-hole.local\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-44",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-queries-v6",children:"Pi-Hole Queries v6"}),"\n",(0,r.jsxs)(n.p,{children:["Shows top queries that were blocked and allowed by ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"}),". Use this version of the widget if you have a v6+ Pi-Hole instance."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://i.ibb.co/pXR0bdQ/pi-hole-queries.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-46",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password or application password. It ",(0,r.jsx)(n.strong,{children:"IS"})," your Pi-Hole admin interface password ",(0,r.jsx)(n.strong,{children:"UNLESS"})," you have 2FA turned on (in contrast to the old widget). If you have 2FA turned on you will need to create an application password. Refer to Pi-Hole documentation for how to create an application password."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"count"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of queries to display. Defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-43",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-top-queries-v6\n options:\n hostname: https://pi-hole.local\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-45",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-recent-traffic",children:"Pi-Hole Recent Traffic"}),"\n",(0,r.jsxs)(n.p,{children:["Shows number of recent traffic, using allowed and blocked queries from ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://pixelflare.cc/alicia/dashy/pi-hole-trafic"})}),"\n",(0,r.jsx)(n.h4,{id:"options-47",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password. It is ",(0,r.jsx)(n.strong,{children:"NOT"})," your pi-hole admin interface or server password. It can be found in ",(0,r.jsx)(n.code,{children:"/etc/pihole/setupVars.conf"}),", and is a 64-character located on the line that starts with ",(0,r.jsx)(n.code,{children:"WEBPASSWORD"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-44",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-traffic\n options:\n hostname: https://pi-hole.local\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-46",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-recent-traffic-v6",children:"Pi-Hole Recent Traffic v6"}),"\n",(0,r.jsxs)(n.p,{children:["Shows number of recent traffic, using allowed and blocked queries from ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"}),". Use this version of the widget if you have a v6+ Pi-Hole instance."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://i.ibb.co/7kdxxwx/pi-hole-recent-queries.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-48",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password or application password. It ",(0,r.jsx)(n.strong,{children:"IS"})," your Pi-Hole admin interface password ",(0,r.jsx)(n.strong,{children:"UNLESS"})," you have 2FA turned on (in contrast to the old widget). If you have 2FA turned on you will need to create an application password. Refer to Pi-Hole documentation for how to create an application password."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-45",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-traffic-v6\n options:\n hostname: https://pi-hole.local\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-47",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stat-ping-statuses",children:"Stat Ping Statuses"}),"\n",(0,r.jsxs)(n.p,{children:["Displays the current and recent uptime of your running services, via a self-hosted instance of ",(0,r.jsx)(n.a,{href:"https://github.com/statping/statping",children:"StatPing"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"300",src:"https://pixelflare.cc/alicia/dashy/statping"})}),"\n",(0,r.jsx)(n.h4,{id:"options-49",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your StatPing instance, without a trailing slash"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"groupId"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:"Optional"}),(0,r.jsxs)(n.td,{children:["If provided, only Services in the given group are displayed. Defaults to ",(0,r.jsx)(n.code,{children:"0"})," in which case all services are displayed."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showChart"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:"Optional"}),(0,r.jsxs)(n.td,{children:["If provided and ",(0,r.jsx)(n.code,{children:"false"})," then charts are not displayed. Defaults to ",(0,r.jsx)(n.code,{children:"true"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showInfo"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:"Optional"}),(0,r.jsxs)(n.td,{children:["If provided and ",(0,r.jsx)(n.code,{children:"false"})," then information summaries are not displayed. Defaults to ",(0,r.jsx)(n.code,{children:"true"}),"."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-46",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: stat-ping\n options:\n hostname: http://192.168.130.1:8080\n"})}),"\n",(0,r.jsx)(n.p,{children:"or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: stat-ping\n options:\n hostname: http://192.168.130.1:8080\n groupId: 3\n showChart: false\n showInfo: false\n"})}),"\n",(0,r.jsxs)(n.p,{children:["You can use multiple StatPing widgets with different ",(0,r.jsx)(n.code,{children:"groupId"}),"s."]}),"\n",(0,r.jsx)(n.p,{children:"Note, the Group Id is not directly visible in StatPing UI, you can inspect the group select HTML element or the API response to find out."}),"\n",(0,r.jsx)(n.h4,{id:"info-48",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/statping/statping",children:"GitHub - StatPing"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://docs.statping.com/",children:"StatPing Docs"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"synology-download-station",children:"Synology Download Station"}),"\n",(0,r.jsx)(n.p,{children:"Displays the current downloads/torrents tasks of your Synology NAS"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://pixelflare.cc/alicia/dashy/synology-downloads"})}),"\n",(0,r.jsx)(n.h4,{id:"options-50",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Synology NAS, without a trailing slash"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The username of a user on your synology NAS. You will see only this user download station tasks if he is not part of the administrator group. Currently don't support OTP protected accounts."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The password of the account specified above."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-47",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: synology-download\n options:\n hostname: http://192.168.1.1:8080\n username: dashy\n password: totally-secure-password\n\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-49",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://www.synology.com/en-us",children:"Synology"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.synology.com/en-us/company/legal/privacy",children:"Synology Privacy Statement"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"adguard-home-block-stats",children:"AdGuard Home Block Stats"}),"\n",(0,r.jsxs)(n.p,{children:["Fetches data from your ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"})," instance, and\ndisplays total number of allowed and blocked queries, plus a pie chart showing breakdown by block type."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/adguard-stats"})}),"\n",(0,r.jsx)(n.h4,{id:"options-51",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your AdGuard Home instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your username here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your password here"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-48",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: adguard-stats\n useProxy: true\n options:\n hostname: http://127.0.0.1\n username: admin\n password: test\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-50",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/privacy.html",children:"AdGuard Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"adguard-home-filters",children:"AdGuard Home Filters"}),"\n",(0,r.jsxs)(n.p,{children:["Fetches data from your ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"})," instance, to display the current status of each of your filter lists. Includes filter name, last updated, number of items, and a link to the list."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/adguard-filters"})}),"\n",(0,r.jsx)(n.h4,{id:"options-52",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your AdGuard Home instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your username here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your password here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showOnOffStatusOnly"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", will only show aggregated AdGuard filter status (on/off), instead of a list of filters"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-49",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: adguard-filter-status\n useProxy: true\n options:\n hostname: http://127.0.0.1\n username: admin\n password: test\n showOnOffStatusOnly: false\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-51",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/privacy.html",children:"AdGuard Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"adguard-home-dns-info",children:"AdGuard Home DNS Info"}),"\n",(0,r.jsxs)(n.p,{children:["Fetches data from your ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"})," instance, and displays the current status (Enabled / Disabled) of AdGuard DNS. Click show more to view detailed info, including upstream DNS provider, active ports, and the status of DNSSEC, EDNS CS, PTR and IPv6."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/adguard-dns"})}),"\n",(0,r.jsx)(n.h4,{id:"options-53",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your AdGuard Home instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your username here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your password here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showFullInfo"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),', the full DNS info will be shown by default, without having to click "Show Info"']})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-50",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: adguard-dns-info\n useProxy: true\n options:\n hostname: http://127.0.0.1\n username: admin\n password: test\n showFullInfo: false\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-52",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/privacy.html",children:"AdGuard Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"adguard-home-top-domains",children:"AdGuard Home Top Domains"}),"\n",(0,r.jsxs)(n.p,{children:["Fetches data from your ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"})," instance, and displays a list of the most queried, and most blocked domains."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/adguard-domains"})}),"\n",(0,r.jsx)(n.h4,{id:"options-54",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your AdGuard Home instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your username here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your password here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify the number of results to show, between ",(0,r.jsx)(n.code,{children:"1"})," and ",(0,r.jsx)(n.code,{children:"100"}),", defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideBlockedDomains"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Don't show the blocked domains list (queried domains only)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideQueriedDomains"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Don't show the queried domains list (blocked domains only)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-51",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: adguard-top-domains\n useProxy: true\n options:\n hostname: http://127.0.0.1\n username: admin\n password: test\n limit: 10\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-53",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/privacy.html",children:"AdGuard Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-user",children:"Nextcloud User"}),"\n",(0,r.jsxs)(n.p,{children:["Nextcloud is a ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/install/#instructions-server",children:"self hosted"})," productivity platform, it can also be used free of charge with ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/sign-up/",children:"hundreds of existing hosting providers"})," that offer a free Nextcloud account."]}),"\n",(0,r.jsx)(n.p,{children:"Displays branding information of a Nextcloud server (logo, url, slogan) and some user details (name, login name, last login, disk space or quota). Use with regular or admin user."}),"\n",(0,r.jsx)(n.p,{children:"Shows quota usage when quota is enabled for the user or disk usage when not enabled."}),"\n",(0,r.jsx)(n.p,{children:"Known issues: the User API incorrectly reports available disk space as total for admin users when quota is not enabled (which usually is the case for admins)."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/nextcloud-user",alt:"nextcloud-user"})}),"\n",(0,r.jsx)(n.h4,{id:"options-55",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud username"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-52",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-user\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-54",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-user-statuses",children:"Nextcloud User Statuses"}),"\n",(0,r.jsx)(n.p,{children:"Show user statuses for selected users."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/nextcloud-user-status",alt:"nextcloud-userstatus"})}),"\n",(0,r.jsx)(n.h4,{id:"options-56",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud username"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"users"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Nextcloud User IDs to show statuses for, list size between ",(0,r.jsx)(n.code,{children:"1"})," and ",(0,r.jsx)(n.code,{children:"100"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showEmpty"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Show statuses without a message, defaults to ",(0,r.jsx)(n.code,{children:"true"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-53",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-userstatus\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n users: ['bob', 'alice']\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-55",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-notifications",children:"Nextcloud Notifications"}),"\n",(0,r.jsx)(n.p,{children:"Displays your notifications and allows deleting them."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/next-cloud-notifications",alt:"nextcloud-notifications"})}),"\n",(0,r.jsx)(n.h4,{id:"options-57",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud username"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number|string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit displayed notifications either by count, e.g. ",(0,r.jsx)(n.code,{children:"5"})," to show the 5 most recent, or by age, e.g. ",(0,r.jsx)(n.code,{children:"1d"})," to only show notifications not older than a day. Accepted suffixes for age limit are ",(0,r.jsx)(n.code,{children:"m"}),", ",(0,r.jsx)(n.code,{children:"h"})," and ",(0,r.jsx)(n.code,{children:"d"}),"."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-54",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-notifications\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n limit: 6h\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-56",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-system",children:"Nextcloud System"}),"\n",(0,r.jsx)(n.p,{children:"Visualises overall memory utilisation and CPU load averages, shows server versions."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/next-cloud-sysyem",alt:"nextcloud-system"})}),"\n",(0,r.jsx)(n.h4,{id:"options-58",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Must be a Nextcloud admin user"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-55",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-system\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-57",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-stats",children:"Nextcloud Stats"}),"\n",(0,r.jsx)(n.p,{children:"Shows key usage statistics about your Nextcloud server."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/nextcloud-stats",alt:"nextcloud-stats"})}),"\n",(0,r.jsx)(n.h4,{id:"options-59",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Must be a Nextcloud admin user"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-56",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-stats\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-58",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-php-opcache-stats",children:"Nextcloud PHP OPcache Stats"}),"\n",(0,r.jsx)(n.p,{children:"Shows statistics about PHP OPcache performance on your Nextcloud server."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/nextcloud-php",alt:"nextcloud-phpopcache"})}),"\n",(0,r.jsx)(n.h4,{id:"options-60",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Must be a Nextcloud admin user"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-57",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-php-opcache\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-59",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"proxmox-lists",children:"Proxmox lists"}),"\n",(0,r.jsx)(n.p,{children:"Shows lists of nodes, containers, and VMs in a Proxmox virtual environment cluster, with a status indicator."}),"\n",(0,r.jsx)(n.h4,{id:"options-61",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"cluster_url"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The URL of the proxmox cluster server. No trailing ",(0,r.jsx)(n.code,{children:"/"}),". for example: ",(0,r.jsx)(n.code,{children:"https://proxmox.lan:8006"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"user_name"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["A Proxmox API Username, for example ",(0,r.jsx)(n.code,{children:"root@pam"})," or ",(0,r.jsx)(n.code,{children:"dashy@pve"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"token_name"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A Proxmox API token name. You can get a token in the API section of the cluster management interface."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"token_uuid"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The value of the token entered above. This is normally a UUID."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"node"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"A Proxmox node name. If empty or not supplied, a list of nodes will be shown."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"node_data"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsxs)(n.td,{children:["This is required if a node is selected, Currently this accepts two values, either ",(0,r.jsx)(n.code,{children:"lxc"})," or ",(0,r.jsx)(n.code,{children:"qemu"})," but the widget can be improved to get other types of data from the Proxmox API."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"A widget title."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title_as_link"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsxs)(n.td,{children:["When this is set to anything other than 0 or false, the title will be linked to the value entered in the ",(0,r.jsx)(n.code,{children:"cluster_url"})," option."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"footer"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"A widget footer."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"footer_as_link"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsxs)(n.td,{children:["When this is set to anything other than 0 or false, the title will be linked to the value entered in the ",(0,r.jsx)(n.code,{children:"cluster_url"})," option."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hide_templates"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"When this is set to anything other than 0 or false, templates will be filtered out of the result list."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-58",children:"Example"}),"\n",(0,r.jsx)(n.p,{children:"This will show the list of nodes."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: proxmox-lists\n useProxy: true \n options:\n cluster_url: https://proxmox.lan:8006\n user_name: root@pam\n token_name: dashy\n token_uuid: bfb152df-abcd-abcd-abcd-ccb95a472d01\n"})}),"\n",(0,r.jsx)(n.p,{children:"This will show the list of VMs, with a title and a linked fotter, hiding VM templates."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: proxmox-lists\n useProxy: true \n options:\n cluster_url: https://proxmox.lan:8006\n user_name: root@pam\n token_name: dashy\n token_uuid: bfb152df-abcd-abcd-abcd-ccb95a472d01\n node: proxmox\n node_data: qemu\n title: Proxmox VMs\n title_as_link: false\n footer: Proxmox\n footer_as_link: true\n hide_templates: 1\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-60",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://proxmox.com/en/proxmox-ve",children:"Proxmox Virtual Environment"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://proxmox.com/en/privacy-policy",children:"Proxmox's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"404 Error in development mode"}),": The error might disappear in production mode ",(0,r.jsx)(n.code,{children:"yarn start"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"500 Error in production mode"}),": Try adding the certificate authority (CA) certificate of your Proxmox host to Node.js.\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Download the Proxmox CA certificate to your Dashy host."}),"\n",(0,r.jsxs)(n.li,{children:["Export environment variable ",(0,r.jsx)(n.code,{children:"NODE_EXTRA_CA_CERTS"})," and set its value to the path of the downloaded CA certificate. Example: ",(0,r.jsx)(n.code,{children:"export NODE_EXTRA_CA_CERTS=/usr/local/share/ca-certificates/devlab_ca.pem"})]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sabnzbd",children:"Sabnzbd"}),"\n",(0,r.jsx)(n.p,{children:"Shows queue information regarding your self hosted Sabnzbd server."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/sabnzbd",alt:"Sabnzbd"})}),"\n",(0,r.jsx)(n.h4,{id:"options-62",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"sabnzbdUrl"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The URL of the Sabnzbd server. No trailing ",(0,r.jsx)(n.code,{children:"/"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["API key for Sabnzbd access. Located under ",(0,r.jsx)(n.code,{children:"Config"})," -> ",(0,r.jsx)(n.code,{children:"General"})," -> ",(0,r.jsx)(n.code,{children:"Security"})," -> ",(0,r.jsx)(n.code,{children:"API Key"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideDetails"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Hides extra server queue details."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideQueue"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Hides the queue list in an expandable dropdown."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-59",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: sabnzbd\n options:\n sabnzbdUrl: 'https://sabnzbd.example.com'\n apiKey: XXXXXXXXXXXXXXXXXX\n hideDetails: false\n hideQueue: false\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-61",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://sabnzbd.org/",children:"Sabnzbd"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://forums.sabnzbd.org/ucp.php?mode=privacy",children:"Sabnzbd Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"gluetun-vpn-info",children:"Gluetun VPN Info"}),"\n",(0,r.jsx)(n.p,{children:"Display info from the Gluetun VPN container public IP API. This can show the IP and location data for the exit VPN node."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/guletn-vpn"})}),"\n",(0,r.jsx)(n.h4,{id:"options-63",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"visibleFields"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["A comma separated list of the fields you want visible in the widget. You can have any number of the following : ",(0,r.jsx)(n.code,{children:"public_ip"}),", ",(0,r.jsx)(n.code,{children:"region"}),", ",(0,r.jsx)(n.code,{children:"country"}),", ",(0,r.jsx)(n.code,{children:"city"}),", ",(0,r.jsx)(n.code,{children:"location"}),", ",(0,r.jsx)(n.code,{children:"organisation"}),", ",(0,r.jsx)(n.code,{children:"postal_code"}),", ",(0,r.jsx)(n.code,{children:"timezone"}),". Defaults to just ",(0,r.jsx)(n.code,{children:"public_ip"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The url to the gluetun HTTP control server. E.g. ",(0,r.jsx)(n.code,{children:"http://gluetun:8000"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-60",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gluetun-status\n useProxy: true\n options:\n hostname: http://server-or-conatiner-hostname:8000\n visibleFields: public_ip,region,country,city,location,organisation,postal_code,timezone\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-62",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/qdm12/gluetun",children:"Gluetun"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://github.com/qdm12/gluetun/wiki",children:"Gluetun Wiki"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"drone-ci-builds",children:"Drone CI Builds"}),"\n",(0,r.jsxs)(n.p,{children:["Display the last builds from a ",(0,r.jsx)(n.a,{href:"https://www.drone.ci",children:"Drone CI"})," instance. A self-hosted CI system that uses docker."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/drone-ci"})}),"\n",(0,r.jsx)(n.h4,{id:"options-64",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The hostname of the Drone CI instance."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The API key (https://[your-drone-instance]/account)."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"integer"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Limit the amounts of listed builds."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"repo"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Show only builds of the specified repo"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-61",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: drone-ci\n updateInterval: 30\n options:\n host: https://drone.somedomain.com\n apiKey: my-very-secret-api-key\n limit: 10\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-63",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://www.drone.io",children:"Drone"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.drone.io",children:"Drone"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"filebrowser",children:"Filebrowser"}),"\n",(0,r.jsxs)(n.p,{children:["Displays storage statistics and file listings from a ",(0,r.jsx)(n.a,{href:"https://github.com/gtsteffaniak/filebrowser",children:"Filebrowser Quantum"})," instance. Shows directory size, file/folder counts, favorite files, and recently modified files with quick-access links."]}),"\n",(0,r.jsx)(n.h4,{id:"options-65",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of your Filebrowser instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A long-lived API key (create in Settings \u2192 API Keys)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"source"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"The source/scope name to browse. Defaults to the first available source"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"path"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The directory path to display. Defaults to ",(0,r.jsx)(n.code,{children:"/"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"favorites"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"List of filenames to show as quick-access favorites"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showRecent"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Number of recently modified files to display. Defaults to ",(0,r.jsx)(n.code,{children:"5"}),", set to ",(0,r.jsx)(n.code,{children:"0"})," to disable"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Maximum number of files to display per section. Defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideStats"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If ",(0,r.jsx)(n.code,{children:"true"}),", hides the storage statistics section"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideFavorites"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If ",(0,r.jsx)(n.code,{children:"true"}),", hides the favorites section"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideRecent"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If ",(0,r.jsx)(n.code,{children:"true"}),", hides the recent files section"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showDetailedStats"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If ",(0,r.jsx)(n.code,{children:"true"}),", shows additional statistics including last modified date, largest file, hidden file count, total items, and file type breakdown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-62",children:"Example"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"Basic usage:"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: filebrowser\n useProxy: true\n options:\n hostname: http://filebrowser.local:8080\n apiKey: VUE_APP_FILEBROWSER_KEY\n source: Documents\n path: /\n showRecent: 5\n favorites:\n - important-notes.txt\n - config.yaml\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"With detailed statistics:"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: filebrowser\n useProxy: true\n options:\n hostname: http://filebrowser.local:8080\n apiKey: VUE_APP_FILEBROWSER_KEY\n source: Downloads\n showDetailedStats: true\n showRecent: 10\n limit: 15\n"})}),"\n",(0,r.jsx)(n.h4,{id:"widget-sections",children:"Widget Sections"}),"\n",(0,r.jsx)(n.p,{children:"The widget displays up to four sections:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Storage Stats"})," - Directory name, total size, file and folder counts"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Detailed Stats"})," (optional) - Last modified date, largest file, hidden file count, total items, and file type breakdown with badges"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Favorites"})," - Quick-access links to user-specified files"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Recent Files"})," - Most recently modified files sorted by date"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"info-64",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/gtsteffaniak/filebrowser",children:"Filebrowser Quantum"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsx)(n.em,{children:"Self-Hosted"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"linkding",children:"Linkding"}),"\n",(0,r.jsx)(n.p,{children:"Linkding is a self-hosted bookmarking service, which has a clean interface and is simple to set up. This lists the links, filterable by tags."}),"\n",(0,r.jsx)(n.h4,{id:"options-66",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The hostname of the Drone CI instance."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The API key (",(0,r.jsx)(n.a,{href:"https://your-linkding-instance/settings/integrations",children:"https://your-linkding-instance/settings/integrations"}),")."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"tags"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"list of string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter the links by tag."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-63",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: linkding\n updateInterval: 30\n options:\n host: https://lingding.somedomain.com\n apiKey: my-very-secret-api-key\n tags: \n - rpg\n - markdown\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-65",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/sissbruecker/linkding",children:"Linkding"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://github.com/sissbruecker/linkding",children:"Linkding"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"uptime-kuma",children:"Uptime Kuma"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})," is an easy-to-use self-hosted monitoring tool."]}),"\n",(0,r.jsx)(n.h4,{id:"options-67",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"url"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Uptime Kuma instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The API key (see ",(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma/wiki/API-Keys",children:"https://github.com/louislam/uptime-kuma/wiki/API-Keys"}),")."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-64",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: uptime-kuma\n useProxy: true\n options:\n apiKey: uk2_99H0Yd3I2pPNIRfn0TqBFu4g5q85R1Mh75yZzw6H\n url: http://192.168.1.106:3691/metrics\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-66",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})," )"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"uptime-kuma-status-page",children:"Uptime Kuma Status Page"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})," is an easy-to-use self-hosted monitoring tool."]}),"\n",(0,r.jsx)(n.h4,{id:"options-68",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Uptime Kuma instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"slug"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The slug of the status page"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"monitorNames"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"strins"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Names of monitored services (in the same order as on the kuma uptime status page)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-65",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'- type: uptime-kuma-status-page\n options:\n host: http://localhost:3001\n slug: another-beautiful-status-page\n monitorNames:\n - "Name1"\n - "Name2"\n'})}),"\n",(0,r.jsx)(n.h4,{id:"info-67",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Needed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})," )"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"tactical-rmm",children:"Tactical RMM"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://github.com/amidaware/tacticalrmm",children:"Tactical RMM"})," is a self-hosted remote monitoring & management tool."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.a,{href:"https://ibb.co/NVHWpD1",children:(0,r.jsx)(n.img,{src:"https://pixelflare.cc/alicia/dashy/tactical-rmm",alt:"Capture",border:"0"})})}),"\n",(0,r.jsx)(n.h4,{id:"options-69",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"url"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The status endpoint URL (",(0,r.jsx)(n.a,{href:"https://api.example.com/core/status/",children:"https://api.example.com/core/status/"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"token"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The MON_TOKEN (see ",(0,r.jsx)(n.a,{href:"https://docs.tacticalrmm.com/tipsntricks/#monitor-your-trmm-instance-via-the-built-in-monitoring-endpoint",children:"https://docs.tacticalrmm.com/tipsntricks/#monitor-your-trmm-instance-via-the-built-in-monitoring-endpoint"}),")."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-66",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: trmm\n useProxy: true\n options:\n token: PkPVKMzbmXgeQDlJWb0WXYvsIk3JvZyadURud2cSTdMia6hUbQ\n url: https://api.example.com/core/status/\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-68",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/amidaware/tacticalrmm",children:"Tactical RMM"})," )"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://github.com/amidaware/tacticalrmm",children:"Tactical RMM"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"system-resource-monitoring",children:"System Resource Monitoring"}),"\n",(0,r.jsx)(n.h3,{id:"glances",children:"Glances"}),"\n",(0,r.jsxs)(n.p,{children:["The easiest method for displaying system info and resource usage in Dashy is with ",(0,r.jsx)(n.a,{href:"https://nicolargo.github.io/glances/",children:"Glances"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Glances is a cross-platform monitoring tool developed by ",(0,r.jsx)(n.a,{href:"https://github.com/nicolargo",children:"@nicolargo"}),". It's similar to top/htop but with a ",(0,r.jsx)(n.a,{href:"https://glances.readthedocs.io/en/latest/api.html",children:"Rest API"})," and many ",(0,r.jsx)(n.a,{href:"https://glances.readthedocs.io/en/latest/gw/index.html",children:"data exporters"})," available. Under the hood, it uses ",(0,r.jsx)(n.a,{href:"https://github.com/giampaolo/psutil",children:"psutil"})," for retrieving system info."]}),"\n",(0,r.jsxs)(n.p,{children:["If you don't already have it installed, either follow the ",(0,r.jsx)(n.a,{href:"https://github.com/nicolargo/glances/blob/master/README.rst",children:"Installation Guide"})," for your system, or setup ",(0,r.jsx)(n.a,{href:"https://glances.readthedocs.io/en/latest/docker.html",children:"with Docker"}),", or use the one-line install script: ",(0,r.jsx)(n.code,{children:"curl -L https://bit.ly/glances | /bin/bash"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["If you are using Docker to run glances make sure to add the enviroment variable ",(0,r.jsx)(n.code,{children:"-e TZ = {YourTimeZone}"}),". You can get a list of valid timezones by running ",(0,r.jsx)(n.code,{children:"timedatectl list-timezones"})," on any linux system. This is needed so the graphs show the currect time."]}),"\n",(0,r.jsx)(n.p,{children:"Here an example for Docker"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:" docker run -d \\\n --name glances \\\n --restart unless-stopped \\\n -v /var/run/docker.sock:/var/run/docker.sock:ro \\\n -p 61208:61208 \\\n --pid host \\\n --privileged \\\n -e GLANCES_OPT=-w \\\n -e PUID=1000 \\\n -e PGID=1000 \\\n -e TZ=Europe/Zurich \\\n nicolargo/glances:latest\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Glances can be launched with the ",(0,r.jsx)(n.code,{children:"glances"})," command. You'll need to run it in web server mode, using the ",(0,r.jsx)(n.code,{children:"-w"})," option for the API to be reachable. If you don't plan on using the Web UI, then you can disable it using ",(0,r.jsx)(n.code,{children:"--disable-webui"}),". See the ",(0,r.jsx)(n.a,{href:"https://glances.readthedocs.io/en/latest/cmds.html",children:"command reference docs"})," for more info."]}),"\n",(0,r.jsxs)(n.p,{children:["If Glances is running on a Windows system it is recommended to add the following arguments ",(0,r.jsx)(n.code,{children:"--disable-plugin all --enable-plugin cpu,mem,diskio,ip,network,containers,quicklook,load,fs,alert -w"})," This is due to Glances not being that stable on windows, so disabling all plugins that aren't used by Dashy widgets can save on ressources."]}),"\n",(0,r.jsx)(n.h4,{id:"options-70",children:"Options"}),"\n",(0,r.jsxs)(n.p,{children:["All Glance's based widgets require a ",(0,r.jsx)(n.code,{children:"hostname"}),". All other parameters are optional."]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL or IP + port to your Glances instance (without a trailing slash)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If you have setup basic auth on Glances, specify username here (defaults to ",(0,r.jsx)(n.code,{children:"glances"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If you have setup basic auth on Glances, specify password here. ",(0,r.jsx)(n.strong,{children:"Note"}),": since this password is in plaintext, it is important not to reuse it anywhere else"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiVersion"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify an API version, defaults to V ",(0,r.jsx)(n.code,{children:"3"}),". Note that support for older versions is limited"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"For widgets that show a time-series chart, optionally limit the number of data points returned. A higher number will show more historical results, but will take longer to load. A value between 300 - 800 is usually optimal"})]})]})]}),"\n",(0,r.jsxs)(n.p,{children:["Note that if auth is configured, requests must be proxied with ",(0,r.jsx)(n.code,{children:"useProxy: true"})]}),"\n",(0,r.jsx)(n.h4,{id:"info-69",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/nicolargo/glances",children:"GitHub - Nicolargo/Glances"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"screenshot",children:"Screenshot"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://ibb.co/pR6dMZT",children:(0,r.jsx)(n.img,{src:"https://pixelflare.cc/alicia/dashy/monitor-board",alt:"example-screenshot"})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"current-cpu-usage",children:"Current CPU Usage"}),"\n",(0,r.jsx)(n.p,{children:"Live-updating current CPU usage, as a combined average across all cores"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/current-cpu"})}),"\n",(0,r.jsx)(n.h4,{id:"example-67",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-current-cpu\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"current-cpu-usage-speedometer",children:"Current CPU Usage Speedometer"}),"\n",(0,r.jsx)(n.p,{children:"Speedometer styled version of the Current CPU Usage widget"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/current-cpu-speedometer"})}),"\n",(0,r.jsx)(n.h4,{id:"example-68",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-cpu-speedometer\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cpu-usage-per-core",children:"CPU Usage Per Core"}),"\n",(0,r.jsx)(n.p,{children:"Live-updating CPU usage breakdown per core"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/cpu-per-core"})}),"\n",(0,r.jsx)(n.h4,{id:"example-69",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-current-cores\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cpu-usage-history",children:"CPU Usage History"}),"\n",(0,r.jsx)(n.p,{children:"Recent CPU usage history, across all cores, and displayed by user and system"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://pixelflare.cc/alicia/dashy/cpu-history-chart"})}),"\n",(0,r.jsx)(n.h4,{id:"options-71",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit the number of results returned, rendering more data points will take longer to load. Defaults to ",(0,r.jsx)(n.code,{children:"100"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-70",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-cpu-history\n options:\n hostname: http://192.168.130.2:61208\n limit: 60\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"current-memory-usage",children:"Current Memory Usage"}),"\n",(0,r.jsx)(n.p,{children:"Real-time memory usage gauge, with more info visible on click"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/current-mem"})}),"\n",(0,r.jsx)(n.h4,{id:"example-71",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-current-mem\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"current-memory-usage-speedometer",children:"Current Memory Usage Speedometer"}),"\n",(0,r.jsx)(n.p,{children:"Speedometer styled version of the Current Memory Usage widget"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/current-mem-speedometer"})}),"\n",(0,r.jsx)(n.h4,{id:"example-72",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-mem-speedometer\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"memory-usage-history",children:"Memory Usage History"}),"\n",(0,r.jsx)(n.p,{children:"Recent memory usage chart"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://pixelflare.cc/alicia/dashy/mem-history-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"options-72",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit the number of results returned, rendering more data points will take longer to load. Defaults to ",(0,r.jsx)(n.code,{children:"100"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-73",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-mem-history\n options:\n hostname: http://localhost:61208\n limit: 80\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"disk-space",children:"Disk Space"}),"\n",(0,r.jsx)(n.p,{children:"List connected disks, showing free / used space and other info (file system, mount point and space available)"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/diskspace-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-74",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-disk-space\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"disk-io",children:"Disk IO"}),"\n",(0,r.jsx)(n.p,{children:"Shows real-time read and write speeds and operations per sec for each disk"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/disk-io-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-75",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-disk-io\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"system-load",children:"System Load"}),"\n",(0,r.jsx)(n.p,{children:"Shows the number of processes waiting in the run-queue, averaged across all cores. Displays for past 5, 10 and 15 minutes"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/system-load-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-76",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-system-load\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"uptime",children:"Uptime"}),"\n",(0,r.jsx)(n.p,{children:"Displays the system uptime fetched from Glances."}),"\n",(0,r.jsx)(n.h4,{id:"example-77",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-uptime\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"system-load-history",children:"System Load History"}),"\n",(0,r.jsxs)(n.p,{children:["Shows recent historical system load, calculated from the number of processes waiting in the run-queue, in 1, 5 and 15 minute intervals, and averaged across all cores. Optionally specify ",(0,r.jsx)(n.code,{children:"limit"})," to set number of results returned, defaults to ",(0,r.jsx)(n.code,{children:"500"}),", max ",(0,r.jsx)(n.code,{children:"100000"}),", but the higher the number the longer the load and render times will be."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://pixelflare.cc/alicia/dashy/system-load-history-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-78",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-load-history\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"network-interfaces",children:"Network Interfaces"}),"\n",(0,r.jsx)(n.p,{children:"Lists visible network interfaces, including real-time upload/ download stats"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/network-interfaces-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-79",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-network-interfaces\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"network-traffic",children:"Network Traffic"}),"\n",(0,r.jsxs)(n.p,{children:["Shows amount of data recently uploaded/ downloaded across all network interfaces. Optionally set the ",(0,r.jsx)(n.code,{children:"limit"})," option to specify number historical of data points to return"]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/network-traffic-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-80",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-network-traffic\n options:\n hostname: http://192.168.130.2:61208\n limit: 500\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"resource-usage-alerts",children:"Resource Usage Alerts"}),"\n",(0,r.jsx)(n.p,{children:"Lists recent high resource usage alerts (e.g. CPU, mem, IO, load, temp)"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://i.ibb.co/w01NX5R/gl-alerts.png"})}),"\n",(0,r.jsx)(n.h4,{id:"example-81",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-alerts\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ip-address",children:"IP Address"}),"\n",(0,r.jsx)(n.p,{children:"Shows public and private IP address. Note that the ip plugin is not available on all instances of Glances."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/ip-addresses-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-82",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-ip-address\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cpu-temp",children:"CPU Temp"}),"\n",(0,r.jsx)(n.p,{children:"Displays temperature data from system CPUs."}),"\n",(0,r.jsxs)(n.p,{children:["Note: This widget uses the ",(0,r.jsx)(n.a,{href:"https://github.com/nicolargo/glances/blob/develop/glances/plugins/glances_sensors.py",children:(0,r.jsx)(n.code,{children:"sensors"})})," plugin, which is disabled by default, and may cause ",(0,r.jsx)(n.a,{href:"https://github.com/nicolargo/glances/issues/1664#issuecomment-632063558",children:"performance issues"}),".\nYou'll need to enable the sensors plugin to use this widget, using: ",(0,r.jsx)(n.code,{children:"--enable-plugin sensors"})," when you start Glances."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/cpu-temp-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"options-73",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"units"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Use ",(0,r.jsx)(n.code,{children:"C"})," to display temperatures in Celsius or ",(0,r.jsx)(n.code,{children:"F"})," to use Fahrenheit. Defaults to ",(0,r.jsx)(n.code,{children:"C"}),"."]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-83",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-cpu-temp\n options:\n hostname: http://192.168.130.2:61208\n units: C\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"compact-metrics",children:"Compact Metrics"}),"\n",(0,r.jsx)(n.p,{children:"A multi-system overview widget that displays CPU, memory and disk usage for multiple Glances instances in a compact table. Click on a row to see detailed metrics for that system."}),"\n",(0,r.jsx)(n.h4,{id:"options-74",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"systems"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["An array of systems to monitor, each with ",(0,r.jsx)(n.code,{children:"header"})," (display name) and ",(0,r.jsx)(n.code,{children:"url"})," (Glances base URL)"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiVersion"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Glances API version. Defaults to ",(0,r.jsx)(n.code,{children:"4"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If Glances is password-protected, specify the username"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If Glances is password-protected, specify the password"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-84",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-compact-metrics\n options:\n systems:\n - header: Server 1\n url: http://192.168.1.10:61208\n - header: Server 2\n url: http://192.168.1.11:61208\n - header: NAS\n url: http://192.168.1.20:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"dynamic-widgets",children:"Dynamic Widgets"}),"\n",(0,r.jsx)(n.h3,{id:"iframe-widget",children:"Iframe Widget"}),"\n",(0,r.jsx)(n.p,{children:"Embed any webpage into your dashboard as a widget."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/iframe"})}),"\n",(0,r.jsx)(n.h4,{id:"options-75",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"url"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to the webpage to embed"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"frameHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If needed, specify height of iframe in ",(0,r.jsx)(n.code,{children:"px"}),". E.g. ",(0,r.jsx)(n.code,{children:"400"}),", defaults to auto"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-85",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: iframe\n options:\n url: https://fiatleak.com/\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"html-embedded-widget",children:"HTML Embedded Widget"}),"\n",(0,r.jsx)(n.p,{children:"Many websites and apps provide their own embeddable widgets. These can be used with Dashy using the Embed widget, which lets you dynamically embed and HTML, CSS or JavaScript contents."}),"\n",(0,r.jsxs)(n.p,{children:["\u26a0\ufe0f ",(0,r.jsx)(n.strong,{children:"NOTE:"})," Use with extreme caution. Embedding a script from an untrustworthy source may have serious unintended consequences."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/html-embed"})}),"\n",(0,r.jsx)(n.h4,{id:"options-76",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"html"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"HTML contents to render in the widget"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"script"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Raw JavaScript code to execute (caution)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"scriptSrc"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"A URL to JavaScript content (caution)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"css"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Any stylings for widget contents"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-86",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'- type: embed\n options:\n scriptSrc: https://cdn.speedcheck.org/basic/scbjs.min.js\n html: |\n
\n
\n \n Speedcheck\n \n
\n
\n'})}),"\n",(0,r.jsx)(n.p,{children:"Or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'- type: embed\n options:\n css: \'.coinmarketcap-currency-widget { color: var(--widget-text-color); }\'\n html: \'
\'\n scriptSrc: \'https://files.coinmarketcap.com/static/widget/currency.js\'\n'})}),"\n",(0,r.jsx)(n.p,{children:"You can also use this widget to display an image, wither locally or from a remote origin."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: embed\n options:\n html: ''\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"api-response",children:"API Response"}),"\n",(0,r.jsx)(n.p,{children:"Directly output plain-text response from any API-enabled service."}),"\n",(0,r.jsx)(n.p,{children:"// Coming soon..."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"prometheus-data",children:"Prometheus Data"}),"\n",(0,r.jsx)(n.p,{children:"Display data from any service with a Prometheus exporter."}),"\n",(0,r.jsx)(n.p,{children:"// Coming soon..."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"data-feed",children:"Data Feed"}),"\n",(0,r.jsxs)(n.p,{children:["Show live data from an RSS-enabled service. The only required parameter is ",(0,r.jsx)(n.code,{children:"rssUrl"}),", which is the URL to the ATOM feed. See ",(0,r.jsx)(n.a,{href:"#rss-feed",children:"RSS Widget"})," for full list of available options."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"700",src:"https://pixelflare.cc/alicia/dashy/data-feed"})}),"\n",(0,r.jsx)(n.h4,{id:"example-87",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: rss-feed\n options:\n rssUrl: https://notes.aliciasykes.com/feed\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"usage--customizations",children:"Usage & Customizations"}),"\n",(0,r.jsx)(n.h3,{id:"widget-usage-guide",children:"Widget Usage Guide"}),"\n",(0,r.jsx)(n.p,{children:"Like items, widgets are placed under sections. You may have one or more widgets per section."}),"\n",(0,r.jsx)(n.p,{children:"In your YAML config file, this will look something like:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"sections:\n- name: Today\n icon: far fa-calendar-day\n widgets:\n - type: clock\n options:\n format: en-GB\n - type: weather\n options:\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n city: London\n units: metric\n"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:'In this example, there is a single section, named "Today", using a Calendar icon from Font-Awesome. It has 2 widgets, a clock and the current weather.'}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"continuous-updates",children:"Continuous Updates"}),"\n",(0,r.jsxs)(n.p,{children:["By default, a widget which displays dynamic data from an external source, will only fetch results on page load. If you would like to keep data updated at all times, you can enable ",(0,r.jsx)(n.strong,{children:"Continuous Updates"}),". This is done by setting a time value in the ",(0,r.jsx)(n.code,{children:"updateInterval"})," field."]}),"\n",(0,r.jsxs)(n.p,{children:["The value of ",(0,r.jsx)(n.code,{children:"updateInterval"})," is optional, and is specified and seconds. It must be more than ",(0,r.jsx)(n.code,{children:"10"})," and less than ",(0,r.jsx)(n.code,{children:"7200"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"For example, the following widget displaying stats from Pi-Hole will update ever 20 seconds."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"widgets:\n- type: pi-hole-stats\n updateInterval: 20\n options:\n hostname: http://192.168.130.2\n"})}),"\n",(0,r.jsx)(n.p,{children:"Note that if you have many widgets, and set them to continuously update frequently, you will notice a hit to performance. A widget that relies on data from an external API, will also consume your usage quota faster, if set to keep updating."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"proxying-requests",children:"Proxying Requests"}),"\n",(0,r.jsx)(n.p,{children:"If a widget fails to make a data request, and the console shows a CORS error, this means the server is blocking client-side requests."}),"\n",(0,r.jsxs)(n.p,{children:["Dashy has a built-in CORS proxy (",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/services/cors-proxy.js",children:(0,r.jsx)(n.code,{children:"services/cors-proxy.js"})}),"), which will be used automatically by some widgets, or can be forced to use by other by setting the ",(0,r.jsx)(n.code,{children:"useProxy"})," option."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"widgets:\n- type: pi-hole-stats\n useProxy: true\n options:\n hostname: http://pi-hole.local\n"})}),"\n",(0,r.jsx)(n.p,{children:"Alternatively, and more securely, you can set the auth headers on your service to accept requests from Dashy. For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: https://location-of-dashy/\nVary: Origin\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"handling-secrets",children:"Handling Secrets"}),"\n",(0,r.jsxs)(n.p,{children:["Some widgets require you to pass potentially sensetive info such as API keys. The ",(0,r.jsx)(n.code,{children:"conf.yml"})," is not ideal for this, as it's stored in plaintext.\nInstead, for secrets you should use environmental vairables."]}),"\n",(0,r.jsx)(n.p,{children:"You can do this, by setting the environmental variable name as the value, instead of the actual key, and then setting that env var in your container or local environment."}),"\n",(0,r.jsxs)(n.p,{children:["The key can be named whatever you like, but it must start with ",(0,r.jsx)(n.code,{children:"VUE_APP_"})," (to be picked up by Vue). If you need to update any of these values, a rebuild is required (this can be done under the Config menu in the UI, or by running ",(0,r.jsx)(n.code,{children:"yarn build"})," then restarting the container)."]}),"\n",(0,r.jsxs)(n.p,{children:["For more infomation about setting and managing your environmental variables, see ",(0,r.jsx)(n.a,{href:"/docs/management#passing-in-environmental-variables",children:"Management Docs --\x3e Environmental Variables"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: weather\n options:\n apiKey: VUE_APP_WEATHER_TOKEN\n city: London\n units: metric\n hideDetails: true\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Then, set ",(0,r.jsx)(n.code,{children:"VUE_APP_WEATHER_TOKEN='xxx'"})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"setting-timeout",children:"Setting Timeout"}),"\n",(0,r.jsxs)(n.p,{children:["If the endpoint you are requesting data from is slow to respond, you may see a timeout error in the console. This can easily be fixed by specifying the ",(0,r.jsx)(n.code,{children:"timeout"})," property on the offending widget. This should be an integer value, in milliseconds. By default timeout is ",(0,r.jsx)(n.code,{children:"2500"})," ms (2\xbd seconds)."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-current-cpu\n timeout: 8000\n options:\n hostname: https://glances.dns-device.local\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"adding-labels",children:"Adding Labels"}),"\n",(0,r.jsxs)(n.p,{children:["If you have multiple widgets of the same type in a single section, it may not be clear what each one is. To overcome this, you can add a custom label to any given widget, using the ",(0,r.jsx)(n.code,{children:"label"})," property."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- name: CPU Usage\n icon: fas fa-tachometer\n widgets:\n - type: gl-current-cpu\n label: Meida Server\n options:\n hostname: http://media-server.lan:61208\n - type: gl-current-cpu\n label: Firewall\n options:\n hostname: http://firewall.lan:61208\n - type: gl-current-cpu\n label: File Sync Server\n options:\n hostname: http://file-sync.lan:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ignoring-errors",children:"Ignoring Errors"}),"\n",(0,r.jsx)(n.p,{children:"When there's an error fetching or displaying a widgets data, then it will be highlighted in yellow, and a message displayed on the UI."}),"\n",(0,r.jsxs)(n.p,{children:["In some instances, this is a false positive, and the widget is actually functioning correctly. If this is the case, you can disable the UI error message of a given widget by setting: ",(0,r.jsx)(n.code,{children:"ignoreErrors: true"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-disk-io\n ignoreErrors: true\n options:\n hostname: https://glances.dns-device.local\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"widget-styling",children:"Widget Styling"}),"\n",(0,r.jsx)(n.p,{children:"Like elsewhere in Dashy, all colours can be easily modified with CSS variables."}),"\n",(0,r.jsx)(n.p,{children:"Widgets use the following color variables, which can be overridden if desired:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"--widget-text-color"})," - Text color, defaults to ",(0,r.jsx)(n.code,{children:"--primary"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"--widget-background-color"})," - Background color, defaults to ",(0,r.jsx)(n.code,{children:"--background-darker"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"--widget-accent-color"})," - Accent color, defaults to ",(0,r.jsx)(n.code,{children:"--background"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["For more info on how to apply custom variables, see the ",(0,r.jsx)(n.a,{href:"/docs/theming#setting-custom-css-in-the-ui",children:"Theming Docs"})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"customizing-charts",children:"Customizing Charts"}),"\n",(0,r.jsxs)(n.p,{children:["For widgets that contain charts, you can set an array of colors under ",(0,r.jsx)(n.code,{children:"chartColors"}),".\nTo specify the chart height, set ",(0,r.jsx)(n.code,{children:"chartHeight"})," to an integer (in ",(0,r.jsx)(n.code,{children:"px"}),"), defaults to ",(0,r.jsx)(n.code,{children:"300"}),".\nFor example:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-load-history\n options:\n hostname: http://192.168.130.2:61208\n chartColors: ['#9b5de5', '#f15bb5', '#00bbf9', '#00f5d4']\n chartHeight: 450\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"language-translations",children:"Language Translations"}),"\n",(0,r.jsx)(n.p,{children:"Since most of the content displayed within widgets is fetched from an external API, unless that API supports multiple languages, translating dynamic content is not possible."}),"\n",(0,r.jsx)(n.p,{children:"However, any hard-coded content is translatable, and all dates and times will display in your local format."}),"\n",(0,r.jsxs)(n.p,{children:["For more info about multi-language support, see the ",(0,r.jsx)(n.a,{href:"/docs/multi-language-support",children:"Internationalization Docs"}),"."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"widget-ui-options",children:"Widget UI Options"}),"\n",(0,r.jsx)(n.p,{children:"Widgets can be opened in full-page view, by clicking the Arrow icon (top-right). The URL in your address bar will also update, and visiting that web address directly will take you straight to that widget."}),"\n",(0,r.jsx)(n.p,{children:"You can reload the data of any widget, by clicking the Refresh Data icon (also in top-right). This will only affect the widget where the action was triggered from."}),"\n",(0,r.jsxs)(n.p,{children:["All ",(0,r.jsx)(n.a,{href:"/docs/configuring#section",children:"config options"})," that can be applied to sections, can also be applied to widget sections. For example, to make a widget section double the width, set ",(0,r.jsx)(n.code,{children:"displayData.cols: 2"})," within the parent section. You can collapse a widget (by clicking the section title), and collapse state will be saved locally."]}),"\n",(0,r.jsxs)(n.p,{children:["Widgets cannot currently be edited through the UI. This feature is in development, and will be released soon. In the meantime, you can either use the JSON config editor, or use ",(0,r.jsx)(n.a,{href:"https://github.com/coder/code-server",children:"VS Code Server"}),", or just SSH into your box and edit the conf.yml file directly."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"build-your-own-widget",children:"Build your own Widget"}),"\n",(0,r.jsx)(n.p,{children:"Widgets are built in a modular fashion, making it easy for anyone to create their own custom components."}),"\n",(0,r.jsxs)(n.p,{children:["For a full tutorial on creating your own widget, you can follow ",(0,r.jsx)(n.a,{href:"/docs/development-guides#building-a-widget",children:"this guide"}),", or take a look at ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/commit/3da76ce2999f57f76a97454c0276301e39957b8e",children:"here"})," for a code example."]}),"\n",(0,r.jsxs)(n.p,{children:["Alternatively, for displaying simple data, you could also just use the either the ",(0,r.jsx)(n.a,{href:"#iframe-widget",children:"iframe"}),", ",(0,r.jsx)(n.a,{href:"#html-embedded-widget",children:"embed"}),", ",(0,r.jsx)(n.a,{href:"#data-feed",children:"data feed"})," or ",(0,r.jsx)(n.a,{href:"#api-response",children:"API response"})," widgets."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"requesting-a-widget",children:"Requesting a Widget"}),"\n",(0,r.jsx)(n.p,{children:"Suggestions for widget ideas are welcome. But there is no guarantee that I will build your widget idea."}),"\n",(0,r.jsx)(n.p,{children:"Please only request widgets for services that:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Have a publicly accessible API"}),"\n",(0,r.jsx)(n.li,{children:"Are CORS and HTTPS enabled"}),"\n",(0,r.jsx)(n.li,{children:"Are free to use, or have a free plan"}),"\n",(0,r.jsx)(n.li,{children:"Allow for use in their Terms of Service"}),"\n",(0,r.jsx)(n.li,{children:"Would be useful for other users"}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["You can suggest a widget ",(0,r.jsx)(n.a,{href:"https://git.io/Jygo3",children:"here"}),", please star the repo before submitting a ticket. If you are a monthly GitHub sponsor, I will happily build out a custom widget for any service that meets the above criteria, usually within 2 weeks of initial request."]}),"\n",(0,r.jsxs)(n.p,{children:["For services that are not officially supported, it is likely still possible to display data using either the ",(0,r.jsx)(n.a,{href:"#iframe-widget",children:"iframe"}),", ",(0,r.jsx)(n.a,{href:"#html-embedded-widget",children:"embed"})," or ",(0,r.jsx)(n.a,{href:"#api-response",children:"API response"})," widgets. For more advanced features, like charts and action buttons, you could also build your own widget, using ",(0,r.jsx)(n.a,{href:"/docs/development-guides#building-a-widget",children:"this tutorial"}),", it's fairly straight forward, and you can use an ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/src/components/Widgets",children:"existing widget"})," (or ",(0,r.jsx)(n.a,{href:"https://git.io/JygKI",children:"this example"}),") as a template."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"troubleshooting-widget-errors",children:"Troubleshooting Widget Errors"}),"\n",(0,r.jsxs)(n.p,{children:["If an error occurs when fetching or rendering results, you will see a short message in the UI. If that message doesn't adequately explain the problem, then you can ",(0,r.jsx)(n.a,{href:"/docs/troubleshooting#how-to-open-browser-console",children:"open the browser console"})," to see more details."]}),"\n",(0,r.jsx)(n.p,{children:"Before proceeding, ensure that if the widget requires auth your API is correct, and for custom widgets, double check that the URL and protocol is correct."}),"\n",(0,r.jsx)(n.p,{children:"If you're able to, you can find more information about why the request may be failing in the Dev Tools under the Network tab, and you can ensure your endpoint is correct and working using a tool like Postman."}),"\n",(0,r.jsx)(n.h4,{id:"cors-errors",children:"CORS Errors"}),"\n",(0,r.jsxs)(n.p,{children:["The most common issue is a CORS error. This is a browser security mechanism which prevents the client-side app (Dashy) from from accessing resources on a remote origin, without that server's explicit permission (e.g. with headers like Access-Control-Allow-Origin). See the MDN Docs for more info: ",(0,r.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"Cross-Origin Resource Sharing"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"There are several ways to fix a CORS error:"}),"\n",(0,r.jsx)(n.h4,{id:"option-1---ensure-correct-protocol",children:"Option 1 - Ensure Correct Protocol"}),"\n",(0,r.jsx)(n.p,{children:"You will get a CORS error if you try and access a http service from a https source. So ensure that the URL you are requesting has the right protocol, and is correctly formatted."}),"\n",(0,r.jsx)(n.h4,{id:"option-2---set-headers",children:"Option 2 - Set Headers"}),"\n",(0,r.jsxs)(n.p,{children:["If you have control over the destination (e.g. for a self-hosted service), then you can simply apply the correct headers.\nAdd the ",(0,r.jsx)(n.code,{children:"Access-Control-Allow-Origin"})," header, with the value of either ",(0,r.jsx)(n.code,{children:"*"})," to allow requests from anywhere, or more securely, the host of where Dashy is served from. For example:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: https://url-of-dashy.local\n"})}),"\n",(0,r.jsx)(n.p,{children:"or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: *\n"})}),"\n",(0,r.jsx)(n.h4,{id:"option-3---proxying-request",children:"Option 3 - Proxying Request"}),"\n",(0,r.jsxs)(n.p,{children:["You can route requests through Dashy's built-in CORS proxy. Instructions and more details can be found ",(0,r.jsx)(n.a,{href:"#proxying-requests",children:"here"}),". If you don't have control over the target origin, and you are running Dashy either through Docker, with the Node server or on Netlify, then this solution will work for you."]}),"\n",(0,r.jsxs)(n.p,{children:["Just add the ",(0,r.jsx)(n.code,{children:"useProxy: true"})," option to the failing widget."]}),"\n",(0,r.jsx)(n.h4,{id:"option-4---use-a-plugin",children:"Option 4 - Use a plugin"}),"\n",(0,r.jsxs)(n.p,{children:["For testing purposes, you can use an addon, which will disable the CORS checks. You can get the Allow-CORS extension for ",(0,r.jsx)(n.a,{href:"https://chrome.google.com/webstore/detail/allow-cors-access-control/lhobafahddgcelffkeicbaginigeejlf?hl=en-US",children:"Chrome"})," or ",(0,r.jsx)(n.a,{href:"https://addons.mozilla.org/en-US/firefox/addon/access-control-allow-origin/",children:"Firefox"}),", more details ",(0,r.jsx)(n.a,{href:"https://mybrowseraddon.com/access-control-allow-origin.html",children:"here"})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"raising-an-issue",children:"Raising an Issue"}),"\n",(0,r.jsxs)(n.p,{children:["If you need to submit a bug report for a failing widget, then please include the full console output (see ",(0,r.jsx)(n.a,{href:"/docs/troubleshooting#how-to-open-browser-console",children:"how"}),") as well as the relevant parts of your config file. Before sending the request, ensure you've read the docs. If you're new to GitHub, an haven't previously contributed to the project, then please fist star the repo to avoid your ticket being closed by the anti-spam bot."]})]})}function a(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453(e,n,s){s.d(n,{R:()=>l,x:()=>t});var i=s(6540);const r={},d=i.createContext(r);function l(e){const n=i.useContext(d);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[5552],{8803(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>a,frontMatter:()=>l,metadata:()=>i,toc:()=>h});const i=JSON.parse('{"id":"widgets","title":"Widgets","description":"Dashy has support for displaying dynamic content in the form of widgets. There are several built-in widgets available out-of-the-box as well as support for custom widgets to display stats from almost any service with an API.","source":"@site/docs/widgets.md","sourceDirName":".","slug":"/widgets","permalink":"/docs/widgets","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/widgets.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Icons","permalink":"/docs/icons"},"next":{"title":"Theming","permalink":"/docs/theming"}}');var r=s(4848),d=s(8453);const l={},t="Widgets",c={},h=[{value:"Contents",id:"contents",level:2},{value:"General Widgets",id:"general-widgets",level:2},{value:"Clock",id:"clock",level:3},{value:"Options",id:"options",level:4},{value:"Example",id:"example",level:4},{value:"Info",id:"info",level:4},{value:"Weather",id:"weather",level:3},{value:"Options",id:"options-1",level:4},{value:"Example",id:"example-1",level:4},{value:"Info",id:"info-1",level:4},{value:"Weather Forecast",id:"weather-forecast",level:3},{value:"Options",id:"options-2",level:4},{value:"Example",id:"example-2",level:4},{value:"Info",id:"info-2",level:4},{value:"RSS Feed",id:"rss-feed",level:3},{value:"Options",id:"options-3",level:4},{value:"Example",id:"example-3",level:4},{value:"Info",id:"info-3",level:4},{value:"Image",id:"image",level:3},{value:"Options",id:"options-4",level:4},{value:"Example",id:"example-4",level:4},{value:"Info",id:"info-4",level:4},{value:"Public IP",id:"public-ip",level:3},{value:"Options",id:"options-5",level:4},{value:"Example",id:"example-5",level:4},{value:"Info",id:"info-5",level:4},{value:"IP Blacklist",id:"ip-blacklist",level:3},{value:"Options",id:"options-6",level:4},{value:"Example",id:"example-6",level:4},{value:"Info",id:"info-6",level:4},{value:"Domain Monitor",id:"domain-monitor",level:3},{value:"Options",id:"options-7",level:4},{value:"Example",id:"example-7",level:4},{value:"Info",id:"info-7",level:4},{value:"Crypto Watch List",id:"crypto-watch-list",level:3},{value:"Options",id:"options-8",level:4},{value:"Example",id:"example-8",level:4},{value:"Info",id:"info-8",level:4},{value:"Crypto Token Price History",id:"crypto-token-price-history",level:3},{value:"Options",id:"options-9",level:4},{value:"Example",id:"example-9",level:4},{value:"Info",id:"info-9",level:4},{value:"Wallet Balance",id:"wallet-balance",level:3},{value:"Options",id:"options-10",level:4},{value:"Example",id:"example-10",level:4},{value:"Info",id:"info-10",level:4},{value:"Code Stats",id:"code-stats",level:3},{value:"Options",id:"options-11",level:4},{value:"Example",id:"example-11",level:4},{value:"Info",id:"info-11",level:4},{value:"Mullvad Status",id:"mullvad-status",level:3},{value:"Options",id:"options-12",level:4},{value:"Example",id:"example-12",level:4},{value:"Info",id:"info-12",level:4},{value:"addy.io",id:"addyio",level:3},{value:"Options",id:"options-13",level:4},{value:"Example",id:"example-13",level:4},{value:"Info",id:"info-13",level:4},{value:"Vulnerability Feed",id:"vulnerability-feed",level:3},{value:"Options",id:"options-14",level:4},{value:"Example",id:"example-14",level:4},{value:"Info",id:"info-14",level:4},{value:"Exchange Rates",id:"exchange-rates",level:3},{value:"Options",id:"options-15",level:4},{value:"Example",id:"example-15",level:4},{value:"Info",id:"info-15",level:4},{value:"Public Holidays",id:"public-holidays",level:3},{value:"Options",id:"options-16",level:4},{value:"Example",id:"example-16",level:4},{value:"Info",id:"info-16",level:4},{value:"Covid-19 Status",id:"covid-19-status",level:3},{value:"Options",id:"options-17",level:4},{value:"Example",id:"example-17",level:4},{value:"Info",id:"info-17",level:4},{value:"Sports Scores",id:"sports-scores",level:3},{value:"Options",id:"options-18",level:4},{value:"Example",id:"example-18",level:4},{value:"Info",id:"info-18",level:4},{value:"News Headlines",id:"news-headlines",level:3},{value:"Options",id:"options-19",level:4},{value:"Example",id:"example-19",level:4},{value:"Info",id:"info-19",level:4},{value:"TFL Status",id:"tfl-status",level:3},{value:"Options",id:"options-20",level:4},{value:"Example",id:"example-20",level:4},{value:"Info",id:"info-20",level:4},{value:"Stock Price History",id:"stock-price-history",level:3},{value:"Options",id:"options-21",level:4},{value:"Example",id:"example-21",level:4},{value:"Info",id:"info-21",level:4},{value:"ETH Gas Prices",id:"eth-gas-prices",level:3},{value:"Options",id:"options-22",level:4},{value:"Example",id:"example-22",level:4},{value:"Info",id:"info-22",level:4},{value:"Joke",id:"joke",level:3},{value:"Options",id:"options-23",level:4},{value:"Example",id:"example-23",level:4},{value:"Info",id:"info-23",level:4},{value:"Chuck Norris quotes",id:"chuck-norris-quotes",level:3},{value:"Options",id:"options-24",level:4},{value:"Example",id:"example-24",level:4},{value:"Info",id:"info-24",level:4},{value:"XKCD Comics",id:"xkcd-comics",level:3},{value:"Options",id:"options-25",level:4},{value:"Example",id:"example-25",level:4},{value:"Info",id:"info-25",level:4},{value:"Flight Data",id:"flight-data",level:3},{value:"Options",id:"options-26",level:4},{value:"Example",id:"example-26",level:4},{value:"Info",id:"info-26",level:4},{value:"Astronomy Picture of the Day",id:"astronomy-picture-of-the-day",level:3},{value:"Options",id:"options-27",level:4},{value:"Example",id:"example-27",level:4},{value:"Info",id:"info-27",level:4},{value:"GitHub Trending",id:"github-trending",level:3},{value:"Options",id:"options-28",level:4},{value:"Example",id:"example-28",level:4},{value:"Info",id:"info-28",level:4},{value:"GitHub Profile Stats",id:"github-profile-stats",level:3},{value:"Options",id:"options-29",level:4},{value:"Example",id:"example-29",level:4},{value:"Info",id:"info-29",level:4},{value:"HealthChecks Status",id:"healthchecks-status",level:3},{value:"Options",id:"options-30",level:4},{value:"Info",id:"info-30",level:4},{value:"Hackernews Trending",id:"hackernews-trending",level:3},{value:"Options",id:"options-31",level:4},{value:"Example",id:"example-30",level:5},{value:"MVG Departure",id:"mvg-departure",level:3},{value:"Options",id:"options-32",level:4},{value:"Info",id:"info-31",level:4},{value:"MVG Connection",id:"mvg-connection",level:3},{value:"Options",id:"options-33",level:4},{value:"Info",id:"info-32",level:4},{value:"Custom List",id:"custom-list",level:3},{value:"Options",id:"options-34",level:4},{value:"Json Schema",id:"json-schema",level:4},{value:"Notes",id:"notes",level:4},{value:"Example",id:"example-31",level:4},{value:"Info",id:"info-33",level:4},{value:"Custom search",id:"custom-search",level:3},{value:"Options",id:"options-35",level:4},{value:"Notes",id:"notes-1",level:4},{value:"Example",id:"example-32",level:4},{value:"Info",id:"info-34",level:4},{value:"RescueTime Overview",id:"rescuetime-overview",level:3},{value:"Options",id:"options-36",level:4},{value:"Example",id:"example-33",level:4},{value:"Info",id:"info-35",level:4},{value:"Minecraft Server",id:"minecraft-server",level:3},{value:"Options",id:"options-37",level:4},{value:"Example",id:"example-34",level:4},{value:"Info",id:"info-36",level:4},{value:"Self-Hosted Services Widgets",id:"self-hosted-services-widgets",level:2},{value:"System Info",id:"system-info",level:3},{value:"Options",id:"options-38",level:4},{value:"Example",id:"example-35",level:4},{value:"Info",id:"info-37",level:4},{value:"Cron Monitoring (Health Checks)",id:"cron-monitoring-health-checks",level:3},{value:"Options",id:"options-39",level:4},{value:"Example",id:"example-36",level:4},{value:"Info",id:"info-38",level:4},{value:"CPU History (NetData)",id:"cpu-history-netdata",level:3},{value:"Options",id:"options-40",level:4},{value:"Example",id:"example-37",level:4},{value:"Info",id:"info-39",level:4},{value:"Memory History (NetData)",id:"memory-history-netdata",level:3},{value:"Options",id:"options-41",level:4},{value:"Example",id:"example-38",level:4},{value:"Info",id:"info-40",level:4},{value:"Load History (NetData)",id:"load-history-netdata",level:3},{value:"Options",id:"options-42",level:4},{value:"Example",id:"example-39",level:4},{value:"Info",id:"info-41",level:4},{value:"Pi-Hole Stats",id:"pi-hole-stats",level:3},{value:"Options",id:"options-43",level:4},{value:"Example",id:"example-40",level:4},{value:"Info",id:"info-42",level:4},{value:"Pi-Hole Stats v6",id:"pi-hole-stats-v6",level:3},{value:"Options",id:"options-44",level:4},{value:"Example",id:"example-41",level:4},{value:"Info",id:"info-43",level:4},{value:"Pi-Hole Queries",id:"pi-hole-queries",level:3},{value:"Options",id:"options-45",level:4},{value:"Example",id:"example-42",level:4},{value:"Info",id:"info-44",level:4},{value:"Pi-Hole Queries v6",id:"pi-hole-queries-v6",level:3},{value:"Options",id:"options-46",level:4},{value:"Example",id:"example-43",level:4},{value:"Info",id:"info-45",level:4},{value:"Pi-Hole Recent Traffic",id:"pi-hole-recent-traffic",level:3},{value:"Options",id:"options-47",level:4},{value:"Example",id:"example-44",level:4},{value:"Info",id:"info-46",level:4},{value:"Pi-Hole Recent Traffic v6",id:"pi-hole-recent-traffic-v6",level:3},{value:"Options",id:"options-48",level:4},{value:"Example",id:"example-45",level:4},{value:"Info",id:"info-47",level:4},{value:"Stat Ping Statuses",id:"stat-ping-statuses",level:3},{value:"Options",id:"options-49",level:4},{value:"Example",id:"example-46",level:4},{value:"Info",id:"info-48",level:4},{value:"Synology Download Station",id:"synology-download-station",level:3},{value:"Options",id:"options-50",level:4},{value:"Example",id:"example-47",level:4},{value:"Info",id:"info-49",level:4},{value:"AdGuard Home Block Stats",id:"adguard-home-block-stats",level:3},{value:"Options",id:"options-51",level:4},{value:"Example",id:"example-48",level:4},{value:"Info",id:"info-50",level:4},{value:"AdGuard Home Filters",id:"adguard-home-filters",level:3},{value:"Options",id:"options-52",level:4},{value:"Example",id:"example-49",level:4},{value:"Info",id:"info-51",level:4},{value:"AdGuard Home DNS Info",id:"adguard-home-dns-info",level:3},{value:"Options",id:"options-53",level:4},{value:"Example",id:"example-50",level:4},{value:"Info",id:"info-52",level:4},{value:"AdGuard Home Top Domains",id:"adguard-home-top-domains",level:3},{value:"Options",id:"options-54",level:4},{value:"Example",id:"example-51",level:4},{value:"Info",id:"info-53",level:4},{value:"Nextcloud User",id:"nextcloud-user",level:3},{value:"Options",id:"options-55",level:4},{value:"Example",id:"example-52",level:4},{value:"Info",id:"info-54",level:4},{value:"Nextcloud User Statuses",id:"nextcloud-user-statuses",level:3},{value:"Options",id:"options-56",level:4},{value:"Example",id:"example-53",level:4},{value:"Info",id:"info-55",level:4},{value:"Nextcloud Notifications",id:"nextcloud-notifications",level:3},{value:"Options",id:"options-57",level:4},{value:"Example",id:"example-54",level:4},{value:"Info",id:"info-56",level:4},{value:"Nextcloud System",id:"nextcloud-system",level:3},{value:"Options",id:"options-58",level:4},{value:"Example",id:"example-55",level:4},{value:"Info",id:"info-57",level:4},{value:"Nextcloud Stats",id:"nextcloud-stats",level:3},{value:"Options",id:"options-59",level:4},{value:"Example",id:"example-56",level:4},{value:"Info",id:"info-58",level:4},{value:"Nextcloud PHP OPcache Stats",id:"nextcloud-php-opcache-stats",level:3},{value:"Options",id:"options-60",level:4},{value:"Example",id:"example-57",level:4},{value:"Info",id:"info-59",level:4},{value:"Proxmox lists",id:"proxmox-lists",level:3},{value:"Options",id:"options-61",level:4},{value:"Example",id:"example-58",level:4},{value:"Info",id:"info-60",level:4},{value:"Troubleshooting",id:"troubleshooting",level:4},{value:"Sabnzbd",id:"sabnzbd",level:3},{value:"Options",id:"options-62",level:4},{value:"Example",id:"example-59",level:4},{value:"Info",id:"info-61",level:4},{value:"Gluetun VPN Info",id:"gluetun-vpn-info",level:3},{value:"Options",id:"options-63",level:4},{value:"Example",id:"example-60",level:4},{value:"Info",id:"info-62",level:4},{value:"Drone CI Builds",id:"drone-ci-builds",level:3},{value:"Options",id:"options-64",level:4},{value:"Example",id:"example-61",level:4},{value:"Info",id:"info-63",level:4},{value:"Filebrowser",id:"filebrowser",level:3},{value:"Options",id:"options-65",level:4},{value:"Example",id:"example-62",level:4},{value:"Widget Sections",id:"widget-sections",level:4},{value:"Info",id:"info-64",level:4},{value:"Linkding",id:"linkding",level:3},{value:"Options",id:"options-66",level:4},{value:"Example",id:"example-63",level:4},{value:"Info",id:"info-65",level:4},{value:"Uptime Kuma",id:"uptime-kuma",level:3},{value:"Options",id:"options-67",level:4},{value:"Example",id:"example-64",level:4},{value:"Info",id:"info-66",level:4},{value:"Uptime Kuma Status Page",id:"uptime-kuma-status-page",level:3},{value:"Options",id:"options-68",level:4},{value:"Example",id:"example-65",level:4},{value:"Info",id:"info-67",level:4},{value:"Tactical RMM",id:"tactical-rmm",level:3},{value:"Options",id:"options-69",level:4},{value:"Example",id:"example-66",level:4},{value:"Info",id:"info-68",level:4},{value:"System Resource Monitoring",id:"system-resource-monitoring",level:2},{value:"Glances",id:"glances",level:3},{value:"Options",id:"options-70",level:4},{value:"Info",id:"info-69",level:4},{value:"Screenshot",id:"screenshot",level:4},{value:"Current CPU Usage",id:"current-cpu-usage",level:3},{value:"Example",id:"example-67",level:4},{value:"Current CPU Usage Speedometer",id:"current-cpu-usage-speedometer",level:3},{value:"Example",id:"example-68",level:4},{value:"CPU Usage Per Core",id:"cpu-usage-per-core",level:3},{value:"Example",id:"example-69",level:4},{value:"CPU Usage History",id:"cpu-usage-history",level:3},{value:"Options",id:"options-71",level:4},{value:"Example",id:"example-70",level:4},{value:"Current Memory Usage",id:"current-memory-usage",level:3},{value:"Example",id:"example-71",level:4},{value:"Current Memory Usage Speedometer",id:"current-memory-usage-speedometer",level:3},{value:"Example",id:"example-72",level:4},{value:"Memory Usage History",id:"memory-usage-history",level:3},{value:"Options",id:"options-72",level:4},{value:"Example",id:"example-73",level:4},{value:"Disk Space",id:"disk-space",level:3},{value:"Example",id:"example-74",level:4},{value:"Disk IO",id:"disk-io",level:3},{value:"Example",id:"example-75",level:4},{value:"System Load",id:"system-load",level:3},{value:"Example",id:"example-76",level:4},{value:"Uptime",id:"uptime",level:3},{value:"Example",id:"example-77",level:4},{value:"System Load History",id:"system-load-history",level:3},{value:"Example",id:"example-78",level:4},{value:"Network Interfaces",id:"network-interfaces",level:3},{value:"Example",id:"example-79",level:4},{value:"Network Traffic",id:"network-traffic",level:3},{value:"Example",id:"example-80",level:4},{value:"Resource Usage Alerts",id:"resource-usage-alerts",level:3},{value:"Example",id:"example-81",level:4},{value:"IP Address",id:"ip-address",level:3},{value:"Example",id:"example-82",level:4},{value:"CPU Temp",id:"cpu-temp",level:3},{value:"Options",id:"options-73",level:4},{value:"Example",id:"example-83",level:4},{value:"Compact Metrics",id:"compact-metrics",level:3},{value:"Options",id:"options-74",level:4},{value:"Example",id:"example-84",level:4},{value:"Dynamic Widgets",id:"dynamic-widgets",level:2},{value:"Iframe Widget",id:"iframe-widget",level:3},{value:"Options",id:"options-75",level:4},{value:"Example",id:"example-85",level:4},{value:"HTML Embedded Widget",id:"html-embedded-widget",level:3},{value:"Options",id:"options-76",level:4},{value:"Example",id:"example-86",level:4},{value:"API Response",id:"api-response",level:3},{value:"Prometheus Data",id:"prometheus-data",level:3},{value:"Data Feed",id:"data-feed",level:3},{value:"Example",id:"example-87",level:4},{value:"Usage & Customizations",id:"usage--customizations",level:2},{value:"Widget Usage Guide",id:"widget-usage-guide",level:3},{value:"Continuous Updates",id:"continuous-updates",level:3},{value:"Proxying Requests",id:"proxying-requests",level:3},{value:"Handling Secrets",id:"handling-secrets",level:3},{value:"Setting Timeout",id:"setting-timeout",level:3},{value:"Adding Labels",id:"adding-labels",level:3},{value:"Ignoring Errors",id:"ignoring-errors",level:3},{value:"Widget Styling",id:"widget-styling",level:3},{value:"Customizing Charts",id:"customizing-charts",level:3},{value:"Language Translations",id:"language-translations",level:3},{value:"Widget UI Options",id:"widget-ui-options",level:3},{value:"Build your own Widget",id:"build-your-own-widget",level:3},{value:"Requesting a Widget",id:"requesting-a-widget",level:3},{value:"Troubleshooting Widget Errors",id:"troubleshooting-widget-errors",level:3},{value:"CORS Errors",id:"cors-errors",level:4},{value:"Option 1 - Ensure Correct Protocol",id:"option-1---ensure-correct-protocol",level:4},{value:"Option 2 - Set Headers",id:"option-2---set-headers",level:4},{value:"Option 3 - Proxying Request",id:"option-3---proxying-request",level:4},{value:"Option 4 - Use a plugin",id:"option-4---use-a-plugin",level:4},{value:"Raising an Issue",id:"raising-an-issue",level:3}];function o(e){const n={a:"a",blockquote:"blockquote",br:"br",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,d.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"widgets",children:"Widgets"})}),"\n",(0,r.jsx)(n.p,{children:"Dashy has support for displaying dynamic content in the form of widgets. There are several built-in widgets available out-of-the-box as well as support for custom widgets to display stats from almost any service with an API."}),"\n",(0,r.jsx)(n.h2,{id:"contents",children:"Contents"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#general-widgets",children:"General Widgets"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#clock",children:"Clock"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#weather",children:"Weather"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#weather-forecast",children:"Weather Forecast"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#rss-feed",children:"RSS Feed"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#image",children:"Image"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#public-ip",children:"Public IP Address"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#ip-blacklist",children:"IP Blacklist Checker"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#domain-monitor",children:"Domain Monitor"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#crypto-watch-list",children:"Crypto Watch List"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#crypto-token-price-history",children:"Crypto Price History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#wallet-balance",children:"Crypto Wallet Balance"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#code-stats",children:"Code Stats"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#mullvad-status",children:"Mullvad Status"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#addyio",children:"Email Aliases (addy.io)"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#vulnerability-feed",children:"Vulnerability Feed"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#exchange-rates",children:"Exchange Rates"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#public-holidays",children:"Public Holidays"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#covid-19-status",children:"Covid-19 Status"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#sports-scores",children:"Sports Scores"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#news-headlines",children:"News Headlines"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#tfl-status",children:"TFL Status"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#stock-price-history",children:"Stock Price History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#eth-gas-prices",children:"ETH Gas Prices"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#joke",children:"Joke of the Day"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#chuck-norris-quotes",children:"Chuck Norris quotes"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#xkcd-comics",children:"XKCD Comics"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#flight-data",children:"Flight Data"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#astronomy-picture-of-the-day",children:"NASA APOD"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#github-trending",children:"GitHub Trending"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#github-profile-stats",children:"GitHub Profile Stats"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#healthchecks-status",children:"Healthchecks Status"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#hackernews-trending",children:"Hackernews Trending"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#mvg-departure",children:"Mvg Departure"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#mvg-connection",children:"Mvg Connection"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#custom-search",children:"Custom search"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#rescuetime-overview",children:"Rescuetime overview"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#minecraft-server",children:"Minecraft Server"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#self-hosted-services-widgets",children:"Self-Hosted Services Widgets"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#system-info",children:"System Info"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cron-monitoring-health-checks",children:"Cron Monitoring"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cpu-history-netdata",children:"CPU History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#memory-history-netdata",children:"Memory History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#load-history-netdata",children:"System Load History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-stats",children:"Pi-Hole Stats"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-stats-v6",children:"Pi-Hole Stats v6"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-queries",children:"Pi-Hole Queries"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-queries-v6",children:"Pi-Hole Queries v6"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-recent-traffic",children:"Pi-Hole Recent Traffic"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#pi-hole-recent-traffic-v6",children:"Pi-Hole Recent Traffic v6"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#stat-ping-statuses",children:"Stat Ping Statuses"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#synology-download-station",children:"Synology Download Station"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#adguard-home-block-stats",children:"AdGuard Home Block Stats"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#adguard-home-filters",children:"AdGuard Home Filters"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#adguard-home-dns-info",children:"AdGuard Home DNS Info"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#adguard-home-top-domains",children:"AdGuard Home Top Domains"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-user",children:"Nextcloud User"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-user-statuses",children:"Nextcloud User Statuses"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-notifications",children:"Nextcloud Notifications"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-system",children:"Nextcloud System"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-stats",children:"Nextcloud Stats"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#nextcloud-php-opcache-stats",children:"Nextcloud PHP OPcache"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#proxmox-lists",children:"Proxmox lists"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#sabnzbd",children:"Sabnzbd"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#gluetun-vpn-info",children:"Gluetun VPN Info"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#drone-ci-builds",children:"Drone CI Build"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#filebrowser",children:"Filebrowser"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#linkding",children:"Linkding"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#uptime-kuma",children:"Uptime Kuma"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#uptime-kuma-status-page",children:"Uptime Kuma Status Page"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#tactical-rmm",children:"Tactical RMM"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#system-resource-monitoring",children:"System Resource Monitoring"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#current-cpu-usage",children:"CPU Usage Current"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cpu-usage-per-core",children:"CPU Usage Per Core"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cpu-usage-history",children:"CPU Usage History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#current-memory-usage",children:"Memory Usage Current"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#memory-usage-history",children:"Memory Usage History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#disk-space",children:"Disk Space"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#disk-io",children:"Disk IO"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#system-load",children:"System Load"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#system-load-history",children:"System Load History"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#network-interfaces",children:"Network Interfaces"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#network-traffic",children:"Network Traffic"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#resource-usage-alerts",children:"Resource Usage Alerts"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#ip-address",children:"Public & Private IP"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#cpu-temp",children:"CPU Temperature"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#compact-metrics",children:"Compact Metrics"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#dynamic-widgets",children:"Dynamic Widgets"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#iframe-widget",children:"Iframe Widget"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#html-embedded-widget",children:"HTML Embed Widget"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#api-response",children:"API Response"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#prometheus-data",children:"Prometheus Data"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#data-feed",children:"Data Feed"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"#usage--customizations",children:"Usage & Customizations"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#widget-usage-guide",children:"Widget Usage Guide"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#continuous-updates",children:"Continuous Updates"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#proxying-requests",children:"Proxying Requests"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#handling-secrets",children:"Handling Secrets"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#setting-timeout",children:"Setting Timeout"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#adding-labels",children:"Adding Labels"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#ignoring-errors",children:"Ignoring Errors"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#widget-styling",children:"Custom CSS Styling"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#customizing-charts",children:"Customizing Charts"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#language-translations",children:"Language Translations"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#widget-ui-options",children:"Widget UI Options"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#build-your-own-widget",children:"Building a Widget"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#requesting-a-widget",children:"Requesting a Widget"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#troubleshooting-widget-errors",children:"Troubleshooting"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"general-widgets",children:"General Widgets"}),"\n",(0,r.jsx)(n.h3,{id:"clock",children:"Clock"}),"\n",(0,r.jsx)(n.p,{children:"A simple, live-updating time and date widget with time-zone support. All fields are optional."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/clock"})}),"\n",(0,r.jsx)(n.h4,{id:"options",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"timeZone"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The time zone to display date and time in.",(0,r.jsx)(n.br,{})," Specified as Region/City, for example: ",(0,r.jsx)(n.code,{children:"Australia/Melbourne"}),". See the ",(0,r.jsx)(n.a,{href:"https://timezonedb.com/time-zones",children:"Time Zone DB"})," for a full list of supported TZs. Defaults to the browser / device's local time"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"format"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["A country code for displaying the date and time in local format.",(0,r.jsx)(n.br,{}),"Specified as ",(0,r.jsx)(n.code,{children:"[ISO-3166]-[ISO-639]"}),", for example: ",(0,r.jsx)(n.code,{children:"en-AU"}),". See ",(0,r.jsx)(n.a,{href:"https://www.fincher.org/Utilities/CountryLanguageList.shtml",children:"here"})," for a full list of locales. Defaults to the browser / device's region"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"customCityName"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"By default the city from the time-zone is shown, but setting this value will override that text"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideDate"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", the date and city will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideSeconds"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", seconds will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"use12Hour"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", 12 hour time will be displayed. Defaults to the settings suggested by the current ",(0,r.jsx)(n.code,{children:"format"})," and ",(0,r.jsx)(n.code,{children:"timeZone"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: clock\n options:\n timeZone: Europe/London\n format: en-GB\n hideDate: false\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info",children:"Info"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"No external data requests."})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"weather",children:"Weather"}),"\n",(0,r.jsx)(n.p,{children:"A simple, live-updating local weather component, showing temperature, conditions and more info."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/weather"})}),"\n",(0,r.jsx)(n.h4,{id:"options-1",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your OpenWeatherMap API key. You can get one for free at ",(0,r.jsx)(n.a,{href:"https://openweathermap.org/",children:"openweathermap.org"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"city"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A city name to use for fetching weather. This can also be a state code or country code, following the ISO-3166 format"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"units"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The units to use for displaying data, can be either ",(0,r.jsx)(n.code,{children:"metric"})," or ",(0,r.jsx)(n.code,{children:"imperial"}),". Defaults to ",(0,r.jsx)(n.code,{children:"metric"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideDetails"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", the additional details (wind, humidity, pressure, etc) will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"lat"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["To show weather for a specific location, you can provide the latitude and longitude coordinates. If provided, this will override the ",(0,r.jsx)(n.code,{children:"city"})," option"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"lon"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["To show weather for a specific location, you can provide the latitude and longitude coordinates. If provided, this will override the ",(0,r.jsx)(n.code,{children:"city"})," option"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: weather\n options:\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n city: London\n units: metric\n hideDetails: true\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-1",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://openweather.co.uk/privacy-policy",children:"OWM Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"weather-forecast",children:"Weather Forecast"}),"\n",(0,r.jsxs)(n.p,{children:["Displays the weather (temperature and conditions) for the next few days for a given location. Note that this requires either the free ",(0,r.jsx)(n.a,{href:"https://home.openweathermap.org/students",children:"OpenWeatherMap Student Plan"}),", or the Premium Plan."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/weather-forecast"})}),"\n",(0,r.jsx)(n.h4,{id:"options-2",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your OpenWeatherMap API key. You can get one at ",(0,r.jsx)(n.a,{href:"https://openweathermap.org/",children:"openweathermap.org"})," or for free via the ",(0,r.jsx)(n.a,{href:"https://home.openweathermap.org/students",children:"OWM Student Plan"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"city"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A city name to use for fetching weather. This can also be a state code or country code, following the ISO-3166 format"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"numDays"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of days to display of forecast info to display. Defaults to ",(0,r.jsx)(n.code,{children:"4"}),", max ",(0,r.jsx)(n.code,{children:"16"})," days"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"units"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The units to use for displaying data, can be either ",(0,r.jsx)(n.code,{children:"metric"})," or ",(0,r.jsx)(n.code,{children:"imperial"}),". Defaults to ",(0,r.jsx)(n.code,{children:"metric"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideDetails"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", the additional details (wind, humidity, pressure, etc) will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: weather-forecast\n options:\n city: California\n numDays: 6\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n units: imperial\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-2",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udd34 Premium (free for personal use only)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://openweather.co.uk/privacy-policy",children:"OWM Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"rss-feed",children:"RSS Feed"}),"\n",(0,r.jsx)(n.p,{children:"Display news and updates from any RSS-enabled service."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/rss"})}),"\n",(0,r.jsx)(n.h4,{id:"options-3",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"rssUrl"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL location of your RSS feed"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["An API key for ",(0,r.jsx)(n.a,{href:"https://rss2json.com/",children:"rss2json"}),". It's free, and will allow you to make 10,000 requests per day, you can sign up ",(0,r.jsx)(n.a,{href:"https://rss2json.com/sign-up",children:"here"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"The number of posts to return. If you haven't specified an API key, this will be limited to 10"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"orderBy"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["How results should be sorted. Can be either ",(0,r.jsx)(n.code,{children:"pubDate"}),", ",(0,r.jsx)(n.code,{children:"author"})," or ",(0,r.jsx)(n.code,{children:"title"}),". Defaults to ",(0,r.jsx)(n.code,{children:"pubDate"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"orderDirection"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Order direction of feed items to return. Can be either ",(0,r.jsx)(n.code,{children:"asc"})," or ",(0,r.jsx)(n.code,{children:"desc"}),". Defaults to ",(0,r.jsx)(n.code,{children:"desc"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"parseLocally"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If true parse the rss feed locally instead of using the rss2json API."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: rss-feed\n options:\n rssUrl: https://www.schneier.com/blog/atom.xml\n apiKey: xxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-3",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free Plan (up to 10,000 requests / day)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://rss2json.com/privacy-policy",children:"Rss2Json Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"image",children:"Image"}),"\n",(0,r.jsx)(n.p,{children:"Displays an image."}),"\n",(0,r.jsxs)(n.p,{children:["This may be useful if you have a service (such as Grafana - ",(0,r.jsx)(n.a,{href:"https://mattionline.de/grafana-api-export-graph-as-png/",children:"see example"}),"), which periodically exports charts or other data as an image."]}),"\n",(0,r.jsxs)(n.p,{children:["You can also store images within Dashy's public directory (using a Docker volume), and reference them directly. E.g. ",(0,r.jsx)(n.code,{children:"-v ./path/to/my-homelab-logo.png:/app/public/logo.png"}),", then in the widget ",(0,r.jsx)(n.code,{children:"imagePath: /logo.png"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Similarly, any web service that serves up widgets as image can be used. E.g. you could show current star chart for a GitHub repo, with: ",(0,r.jsx)(n.code,{children:"imagePath: https://starchart.cc/Lissy93/dashy.svg"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["If you'd like to embed a live screenshot, of all or just part of a website, then this can be done using ",(0,r.jsx)(n.a,{href:"https://apiflash.com/",children:"API Flash"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Or what about showing a photo of the day? Try ",(0,r.jsx)(n.code,{children:"https://source.unsplash.com/random/400x300"})," or ",(0,r.jsx)(n.code,{children:"https://picsum.photos/400/300"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"300",src:"https://pixelflare.cc/alicia/dashy/image"})}),"\n",(0,r.jsx)(n.h4,{id:"options-4",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"imagePath"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The path (local or remote) of the image to display"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"imageWidth"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify a fixed width for rendered image. Accepts either integer value in ",(0,r.jsx)(n.code,{children:"px"}),", or any string value with units (e.g. ",(0,r.jsx)(n.code,{children:"420"}),", ",(0,r.jsx)(n.code,{children:"100px"}),", ",(0,r.jsx)(n.code,{children:"6.9rem"}),") (defaults to ",(0,r.jsx)(n.code,{children:"auto"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"imageHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify a fixed height for rendered image. Accepts either integer value in ",(0,r.jsx)(n.code,{children:"px"}),", or any string value with units (e.g. ",(0,r.jsx)(n.code,{children:"420"}),", ",(0,r.jsx)(n.code,{children:"100px"}),", ",(0,r.jsx)(n.code,{children:"6.9rem"}),") (defaults to ",(0,r.jsx)(n.code,{children:"auto"}),")"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-4",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: image\n options:\n imagePath: https://i.ibb.co/yhbt6CY/dashy.png\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-4",children:"Info"}),"\n",(0,r.jsx)(n.p,{children:"Unless image fetched from remote source, no external data request is made."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"public-ip",children:"Public IP"}),"\n",(0,r.jsxs)(n.p,{children:['Often find yourself searching "What\'s my IP", just so you can check your VPN is still connected? This widget displays your public IP address, along with ISP name and approx location. Data can be fetched from either ',(0,r.jsx)(n.a,{href:"https://ipapi.co/",children:"IpApi.co"}),", ",(0,r.jsx)(n.a,{href:"https://ip-api.com/",children:"IP-API.com"}),", ",(0,r.jsx)(n.a,{href:"https://ipgeolocation.io/",children:"IpGeolocation.io"})," or ",(0,r.jsx)(n.a,{href:"https://ip2location.io/",children:"IP2Location.io"}),"."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/public-ip"})}),"\n",(0,r.jsx)(n.h4,{id:"options-5",children:"Options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"All fields are optional."})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"provider"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The name of the service to fetch IP address from. Can be either ",(0,r.jsx)(n.code,{children:"ipapi.co"}),", ",(0,r.jsx)(n.code,{children:"ip-api"}),", ",(0,r.jsx)(n.code,{children:"ipgeolocation"})," or ",(0,r.jsx)(n.code,{children:"ip2location.io"}),". Defaults to ",(0,r.jsx)(n.code,{children:"ipapi.co"}),". Note, ",(0,r.jsx)(n.code,{children:"ip-api"})," doesn't work on HTTPS, and if you set to ",(0,r.jsx)(n.code,{children:"ipgeolocation"})," or ",(0,r.jsx)(n.code,{children:"ip2location.io"})," then you must also provide an API key"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Only required if provider is set to ",(0,r.jsx)(n.code,{children:"ipgeolocation"})," or ",(0,r.jsx)(n.code,{children:"ip2location.io"}),". You can get a free IPGeolocation API key ",(0,r.jsx)(n.a,{href:"https://ipgeolocation.io/signup.html",children:"here"})," or a free IP2Location.io API key ",(0,r.jsx)(n.a,{href:"https://ip2location.io/pricing",children:"here"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-5",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: public-ip\n"})}),"\n",(0,r.jsx)(n.p,{children:"Or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: public-ip\n options:\n provider: ipgeolocation\n apiKey: xxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-5",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": _See ",(0,r.jsx)(n.a,{href:"https://ipgeolocation.io/privacy.html",children:"IPGeoLocation Privacy Policy"})," or ",(0,r.jsx)(n.a,{href:"https://ip-api.com/docs/legal",children:"IP-API Privacy Policy"})," or ",(0,r.jsx)(n.a,{href:"https://ip2location.io/privacy-policy",children:"IP2Location.io Privacy Policy"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ip-blacklist",children:"IP Blacklist"}),"\n",(0,r.jsxs)(n.p,{children:["Notice certain web pages aren't loading? This widget quickly shows which blacklists your IP address (or host, or email) appears on, using data from ",(0,r.jsx)(n.a,{href:"https://blacklistchecker.com/",children:"blacklistchecker.com"}),"."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/ip-blacklist"})}),"\n",(0,r.jsx)(n.h4,{id:"options-6",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"ipAddress"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"The IP to check. This can also be a domain/ host name or even an email address. If left blank, Dashy will use your current public IP address."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["You can get your free API key from ",(0,r.jsx)(n.a,{href:"https://blacklistchecker.com/keys",children:"blacklistchecker.com"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-6",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: blacklist-check\n options:\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n ipAddress: 1.1.1.1\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-6",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free Plan"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://blacklistchecker.com/privacy",children:"BlacklistChecker Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"domain-monitor",children:"Domain Monitor"}),"\n",(0,r.jsxs)(n.p,{children:["Keep an eye on the expiry dates of your domain names, using public whois records fetched from ",(0,r.jsx)(n.a,{href:"https://whoapi.com/",children:"whoapi.com"}),". Click the domain name to view additional info, like registrar, name servers and date last updated."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/domain-monitor"})}),"\n",(0,r.jsx)(n.h4,{id:"options-7",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"domain"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The domain to check"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["You can get your free API key from ",(0,r.jsx)(n.a,{href:"https://my.whoapi.com/user/signup",children:"my.whoapi.com"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showFullInfo"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If set to true, the toggle-full-info panel will be open by default"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-7",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: domain-monitor\n options:\n domain: example.com\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n\n - type: domain-monitor\n options:\n domain: example2.com\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-7",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free Plan (10,000 requests)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://whoapi.com/privacy-policy/",children:"WhoAPI Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"crypto-watch-list",children:"Crypto Watch List"}),"\n",(0,r.jsxs)(n.p,{children:["Keep track of price changes of your favorite crypto assets. Data is fetched from ",(0,r.jsx)(n.a,{href:"https://www.coingecko.com/",children:"CoinGecko"}),". All fields are optional."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/crypto-prices"})}),"\n",(0,r.jsx)(n.h4,{id:"options-8",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"assets"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["An array of cryptocurrencies, coins and tokens. See ",(0,r.jsx)(n.a,{href:"https://api.coingecko.com/api/v3/asset_platforms",children:"list of supported assets"}),". If none are specified, then the top coins by ",(0,r.jsx)(n.code,{children:"sortBy"})," (defaults to market cap) will be returned"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"currency"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The fiat currency to display price in, expressed as an ISO-4217 alpha code (see ",(0,r.jsx)(n.a,{href:"https://www.iban.com/currency-codes",children:"list of currencies"}),"). Defaults to ",(0,r.jsx)(n.code,{children:"USD"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"sortBy"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The method of sorting results. Can be ",(0,r.jsx)(n.code,{children:"marketCap"}),", ",(0,r.jsx)(n.code,{children:"volume"})," or ",(0,r.jsx)(n.code,{children:"alphabetical"}),". Defaults to ",(0,r.jsx)(n.code,{children:"marketCap"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Number of results to return, useful when no assets are specified. Defaults to either ",(0,r.jsx)(n.code,{children:"all"})," or ",(0,r.jsx)(n.code,{children:"100"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-8",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: crypto-watch-list\n options:\n limit: 10\n"})}),"\n",(0,r.jsx)(n.p,{children:"Or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: crypto-watch-list\n options:\n currency: GBP\n sortBy: marketCap\n assets:\n - bitcoin\n - ethereum\n - monero\n - cosmos\n - polkadot\n - dogecoin\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-8",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.coingecko.com/en/privacy",children:"CoinGecko Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"crypto-token-price-history",children:"Crypto Token Price History"}),"\n",(0,r.jsxs)(n.p,{children:["Shows recent price history for a given crypto asset, using price data fetched from ",(0,r.jsx)(n.a,{href:"https://www.coingecko.com/",children:"CoinGecko"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/crypto-price-history"})}),"\n",(0,r.jsx)(n.h4,{id:"options-9",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"asset"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Name of a crypto asset, coin or token to fetch price data for, see ",(0,r.jsx)(n.a,{href:"https://api.coingecko.com/api/v3/asset_platforms",children:"list of supported assets"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"currency"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The fiat currency to display results in, expressed as an ISO-4217 alpha code (see ",(0,r.jsx)(n.a,{href:"https://www.iban.com/currency-codes",children:"list of currencies"}),"). Defaults to ",(0,r.jsx)(n.code,{children:"USD"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"numDays"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of days of price history to render. Defaults to ",(0,r.jsx)(n.code,{children:"7"}),", min: ",(0,r.jsx)(n.code,{children:"1"}),", max: ",(0,r.jsx)(n.code,{children:"30"})," days"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColor"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Color of the chart value. Defaults to ",(0,r.jsx)(n.code,{children:"--widget-text-color"})," which inherits dashboard primary color"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The height of rendered chart in px. Defaults to ",(0,r.jsx)(n.code,{children:"300"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-9",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: crypto-price-chart\n options:\n asset: bitcoin\n currency: GBP\n numDays: 7\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-9",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.coingecko.com/en/privacy",children:"CoinGecko Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"wallet-balance",children:"Wallet Balance"}),"\n",(0,r.jsxs)(n.p,{children:["Keep track of your crypto balances and see recent transactions. Data is fetched from ",(0,r.jsx)(n.a,{href:"https://www.blockcypher.com/dev/",children:"BlockCypher"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/crypto-wallet"})}),"\n",(0,r.jsx)(n.h4,{id:"options-10",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"coin"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Symbol of coin or asset, e.g. ",(0,r.jsx)(n.code,{children:"btc"}),", ",(0,r.jsx)(n.code,{children:"eth"})," or ",(0,r.jsx)(n.code,{children:"doge"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"address"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Address to monitor. This is your wallet's ",(0,r.jsx)(n.strong,{children:"public"})," / receiving address"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"network"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["To use a different network, other than mainnet. Defaults to ",(0,r.jsx)(n.code,{children:"main"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit the number of transactions to display. Defaults to ",(0,r.jsx)(n.code,{children:"10"}),", set to large number to show all"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-10",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: wallet-balance\n options:\n coin: btc\n address: 3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-10",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.blockcypher.com/privacy.html",children:"BlockCypher Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"code-stats",children:"Code Stats"}),"\n",(0,r.jsxs)(n.p,{children:["Display your coding summary. ",(0,r.jsx)(n.a,{href:"https://codestats.net/",children:"Code::Stats"})," is a free and open source app that aggregates statistics about your programming activity. Dashy supports both the public instance, as well as self-hosted versions."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/code-stats"})}),"\n",(0,r.jsx)(n.h4,{id:"options-11",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Your CodeStats username"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If your self-hosting CodeStats, then supply the host name. By default it will use the public hosted instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"monthsToShow"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify the number of months to render in the historical data chart. Defaults to ",(0,r.jsx)(n.code,{children:"6"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideMeta"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide the meta section (username, level, all-time and recent XP)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideHistory"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide the historical calendar heat map"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideLanguages"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide the programming languages pie chart"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideMachines"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide the machines percentage chart"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-11",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: code-stats\n options:\n username: alicia\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-11",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted or Managed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://codestats.net/tos#privacy",children:"Code::Stats Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"mullvad-status",children:"Mullvad Status"}),"\n",(0,r.jsxs)(n.p,{children:["Shows your Mullvad VPN connection status, as well as server info. Fetched from ",(0,r.jsx)(n.a,{href:"https://mullvad.net/en/check/",children:"am.i.mullvad.net"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/mullvad"})}),"\n",(0,r.jsx)(n.h4,{id:"options-12",children:"Options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"No Options."})}),"\n",(0,r.jsx)(n.h4,{id:"example-12",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: mullvad-status\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-12",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://mullvad.net/en/help/privacy-policy/",children:"Mullvad Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"addyio",children:"addy.io"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://addy.io/",children:"addy.io"})," is a free and open source mail forwarding service. Use it to protect your real email address, by using a different alias for each of your online accounts, and have all emails land in your normal inbox(es). Supports custom domains, email replies, PGP-encryption, multiple recipients and more"]}),"\n",(0,r.jsx)(n.p,{children:"This widget display email addresses / aliases from addy.io. Click an email address to copy to clipboard, or use the toggle switch to enable/ disable it. Shows usage stats (bandwidth, used aliases etc), as well as total messages received, blocked and sent. Works with both self-hosted and managed instances of addy.io."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/addy"})}),"\n",(0,r.jsx)(n.h4,{id:"options-13",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your addy.io API Key / Personal Access Token. You can generate this under ",(0,r.jsx)(n.a,{href:"https://app.addy.io/settings",children:"Account Settings"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If your self-hosting addy.io, then supply the host name. By default it will use the public hosted instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiVersion"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If you're using an API version that is not version ",(0,r.jsx)(n.code,{children:"v1"}),", then specify it here"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit the number of emails shown per page. Defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"sortBy"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify the sort order for email addresses. Defaults to ",(0,r.jsx)(n.code,{children:"updated_at"}),". Can be either: ",(0,r.jsx)(n.code,{children:"local_part"}),", ",(0,r.jsx)(n.code,{children:"domain"}),", ",(0,r.jsx)(n.code,{children:"email"}),", ",(0,r.jsx)(n.code,{children:"emails_forwarded"}),", ",(0,r.jsx)(n.code,{children:"emails_blocked"}),", ",(0,r.jsx)(n.code,{children:"emails_replied"}),", ",(0,r.jsx)(n.code,{children:"emails_sent"}),", ",(0,r.jsx)(n.code,{children:"created_at"}),", ",(0,r.jsx)(n.code,{children:"updated_at"})," or ",(0,r.jsx)(n.code,{children:"deleted_at"}),". Precede with a ",(0,r.jsx)(n.code,{children:"-"})," character to reverse order."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"searchTerm"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"A search term to filter results by, will search the email, description and domain"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"disableControls"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Prevent any changes being made to account through the widget. User will not be able to enable or disable aliases through UI when this option is set"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideMeta"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Don't show account meta info (forward/ block count, quota usage etc)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideAliases"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Don't show email address / alias list. Will only show account meta info"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-13",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:' - type: anonaddy\n options:\n apiKey: "xxxxxxxxxxxxxxxxxxxxxxxx\\\n xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\\\n xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"\n limit: 5\n sortBy: created_at\n disableControls: true\n'})}),"\n",(0,r.jsx)(n.h4,{id:"info-13",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free for Self-Hosted / Free Plan available on managed instance or $1/month for premium"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted or Managed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://addy.io/privacy/",children:"addy.io Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"vulnerability-feed",children:"Vulnerability Feed"}),"\n",(0,r.jsx)(n.p,{children:"Keep track of recent security advisories and vulnerabilities, with optional filtering by score, exploits, vendor and product. All fields are optional."}),"\n",(0,r.jsxs)(n.p,{children:["Sources from: ",(0,r.jsx)(n.a,{href:"https://services.nvd.nist.gov/rest/json/cves/2.0",children:"https://services.nvd.nist.gov/rest/json/cves/2.0"}),"\nDocs: ",(0,r.jsx)(n.a,{href:"https://nvd.nist.gov/developers/vulnerabilities",children:"https://nvd.nist.gov/developers/vulnerabilities"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/cve"})}),"\n",(0,r.jsx)(n.h4,{id:"options-14",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"cveTag"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["This parameter returns only the CVE records that include the provided cveTag. Options are ",(0,r.jsx)(n.strong,{children:"disputed"}),", ",(0,r.jsx)(n.strong,{children:"unsupported-when-assigned"})," or ",(0,r.jsx)(n.strong,{children:"exclusively-hosted-service"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of results to fetch. Can be between ",(0,r.jsx)(n.code,{children:"5"})," and ",(0,r.jsx)(n.code,{children:"30"}),", defaults to ",(0,r.jsx)(n.code,{children:"5"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"cvssV2Severity"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["This parameter returns only the CVEs that match the provided CVSSv2 qualitative severity rating. Options are ",(0,r.jsx)(n.strong,{children:"LOW"}),", ",(0,r.jsx)(n.strong,{children:"MEDIUM"}),", ",(0,r.jsx)(n.strong,{children:"HIGH"})," or ",(0,r.jsx)(n.strong,{children:"CRITICAL"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"cvssV3Severity"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["This parameter returns only the CVEs that match the provided CVSSv3 qualitative severity rating. Options are ",(0,r.jsx)(n.strong,{children:"LOW"}),", ",(0,r.jsx)(n.strong,{children:"MEDIUM"}),", ",(0,r.jsx)(n.strong,{children:"HIGH"})," or ",(0,r.jsx)(n.strong,{children:"CRITICAL"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"cvssV4Severity"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["This parameter returns only the CVEs that match the provided CVSSv4 qualitative severity rating. Options are ",(0,r.jsx)(n.strong,{children:"LOW"}),", ",(0,r.jsx)(n.strong,{children:"MEDIUM"}),", ",(0,r.jsx)(n.strong,{children:"HIGH"})," or ",(0,r.jsx)(n.strong,{children:"CRITICAL"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"keywordSearch"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"This parameter returns only the CVEs where a word or phrase is found in the current description"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-14",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: cve-vulnerabilities\n"})}),"\n",(0,r.jsx)(n.p,{children:"or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: cve-vulnerabilities\n options:\n cveTag: disputed\n cvssV2Severity: CRITICAL\n limit: 30\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-14",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.cvedetails.com/privacy.php",children:"CVE Details Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"exchange-rates",children:"Exchange Rates"}),"\n",(0,r.jsx)(n.p,{children:"Display current FX rates in your native currency. Hover over a row to view more info, or click to show rates in that currency."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/currencies"})}),"\n",(0,r.jsx)(n.h4,{id:"options-15",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"inputCurrency"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The base currency to show results in. Specified as a 3-letter ISO-4217 code, see ",(0,r.jsx)(n.a,{href:"https://www.exchangerate-api.com/docs/supported-currencies",children:"here"})," for the full list of supported currencies, and their symbols"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"outputCurrencies"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["List or currencies to show results for. Specified as a 3-letter ISO-4217 code, see ",(0,r.jsx)(n.a,{href:"https://www.exchangerate-api.com/docs/supported-currencies",children:"here"})," for the full list of supported currencies, and their symbols"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["API key for ",(0,r.jsx)(n.a,{href:"https://www.exchangerate-api.com/",children:"exchangerate-api.com"}),", usually a 24-digit alpha-numeric string. You can sign up for a free account ",(0,r.jsx)(n.a,{href:"https://app.exchangerate-api.com/sign-up",children:"here"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-15",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: exchange-rates\n options:\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxx\n inputCurrency: GBP\n outputCurrencies:\n - USD\n - JPY\n - HKD\n - KPW\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-15",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 100,000 requests/ month)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.exchangerate-api.com/terms",children:"ExchangeRateAPI Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"public-holidays",children:"Public Holidays"}),"\n",(0,r.jsxs)(n.p,{children:["Counting down to the next day off work? This widget displays upcoming public holidays for your country. Data is fetched from ",(0,r.jsx)(n.a,{href:"http://kayaposoft.com/enrico/",children:"Enrico"})]}),"\n",(0,r.jsxs)(n.p,{children:["Note, config for this widget is case-sensitive (see ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/1268",children:"#1268"}),")"]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/holidays"})}),"\n",(0,r.jsx)(n.h4,{id:"options-16",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"country"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The country to fetch holiday data for, specified as a country code, e.g. ",(0,r.jsx)(n.code,{children:"GB"})," or ",(0,r.jsx)(n.code,{children:"US"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"state"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["restrict a country to a specific state defined by ",(0,r.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/ISO_3166-2",children:"ISO_3166-2"}),", e.g. ",(0,r.jsx)(n.code,{children:"LND"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"holidayType"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The type of holidays to fetch. Can be: ",(0,r.jsx)(n.code,{children:"all"}),", ",(0,r.jsx)(n.code,{children:"public_holiday"}),", ",(0,r.jsx)(n.code,{children:"observance"}),", ",(0,r.jsx)(n.code,{children:"school_holiday"}),", ",(0,r.jsx)(n.code,{children:"other_day"})," or ",(0,r.jsx)(n.code,{children:"extra_working_day"}),". Defaults to ",(0,r.jsx)(n.code,{children:"public_holiday"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"monthsToShow"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of months in advance to show. Min: ",(0,r.jsx)(n.code,{children:"1"}),", max: ",(0,r.jsx)(n.code,{children:"24"}),". Defaults to ",(0,r.jsx)(n.code,{children:"12"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"lang"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The language in which the events should be. Usually local languages and english are available. Default to first available in the country. e.g. ",(0,r.jsx)(n.code,{children:"en"})," or ",(0,r.jsx)(n.code,{children:"fr"}),"."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-16",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: public-holidays\n options:\n country: GB\n state: LND\n holidayType: all\n monthsToShow: 12\n lang: en\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-16",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/jurajmajer/enrico",children:"jurajmajer/enrico"}),") or Managed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"covid-19-status",children:"Covid-19 Status"}),"\n",(0,r.jsxs)(n.p,{children:["Keep track of the current COVID-19 status. Optionally also show cases by country, and a time-series chart. Uses live data from various sources, computed by ",(0,r.jsx)(n.a,{href:"https://disease.sh/",children:"disease.sh"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/covid"})}),"\n",(0,r.jsx)(n.h4,{id:"options-17",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showChart"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Also display a time-series chart showing number of recent cases"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showCountries"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Also display a list of cases per country"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"numDays"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Specify number of days worth of history to render on the chart"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"countries"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string[]"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["An array of countries to display, specified by their ",(0,r.jsx)(n.a,{href:"https://www.iso.org/obp/ui",children:"ISO-3 codes"}),". Leave blank to show all, sorted by most cases. ",(0,r.jsx)(n.code,{children:"showCountries"})," must be set to ",(0,r.jsx)(n.code,{children:"true"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If showing all countries, set a limit for number of results to return. Defaults to ",(0,r.jsx)(n.code,{children:"10"}),", no maximum"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-17",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: covid-stats\n"})}),"\n",(0,r.jsx)(n.p,{children:"Or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: covid-stats\n options:\n showChart: true\n showCountries: true\n countries:\n - GBR\n - USA\n - IND\n - RUS\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-17",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/disease-sh/api",children:"disease-sh/api"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Conditions"}),": ",(0,r.jsx)(n.a,{href:"https://github.com/disease-sh/api/blob/master/TERMS",children:"Terms of Use"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sports-scores",children:"Sports Scores"}),"\n",(0,r.jsxs)(n.p,{children:["Show recent scores and upcoming matches from your favorite sports team. Data is fetched from ",(0,r.jsx)(n.a,{href:"https://www.thesportsdb.com/",children:"TheSportsDB.com"}),". From the UI, you can click any other team to view their scores and upcoming games, or click a league name to see all teams."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/sports"})}),"\n",(0,r.jsx)(n.h4,{id:"options-18",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"teamId"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The ID of a team to fetch scores from. You can search for your team on the ",(0,r.jsx)(n.a,{href:"https://www.thesportsdb.com/teams_main.php",children:"Teams Page"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"leagueId"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Alternatively, provide a league ID to fetch all games from. You can find the ID on the ",(0,r.jsx)(n.a,{href:"https://www.thesportsdb.com/Sport/Leagues",children:"Leagues Page"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"pastOrFuture"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Set to ",(0,r.jsx)(n.code,{children:"past"})," to show scores for recent games, or ",(0,r.jsx)(n.code,{children:"future"})," to show upcoming games. Defaults to ",(0,r.jsx)(n.code,{children:"past"}),". You can change this within the UI"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Optionally specify your API key, which you can sign up for at ",(0,r.jsx)(n.a,{href:"https://www.thesportsdb.com/",children:"TheSportsDB.com"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["To limit output to a certain number of matches, defaults to ",(0,r.jsx)(n.code,{children:"15"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideImage"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Set to ",(0,r.jsx)(n.code,{children:"true"})," to not render the team / match banner image, defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-18",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: sports-scores\n options:\n teamId: 133636\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-18",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 30 requests / minute, limited endpoints)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"news-headlines",children:"News Headlines"}),"\n",(0,r.jsxs)(n.p,{children:["Displays the latest news, click to read full article. Date is fetched from various news sources using ",(0,r.jsx)(n.a,{href:"https://currentsapi.services/en",children:"Currents API"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/news"})}),"\n",(0,r.jsx)(n.h4,{id:"options-19",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your API key for CurrentsAPI. This is free, and you can ",(0,r.jsx)(n.a,{href:"https://currentsapi.services/en/register",children:"get one here"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"country"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Fetch news only from a certain country or region. Specified as a country code, e.g. ",(0,r.jsx)(n.code,{children:"GB"})," or ",(0,r.jsx)(n.code,{children:"US"}),". See ",(0,r.jsx)(n.a,{href:"https://api.currentsapi.services/v1/available/regions",children:"here"})," for a list of supported regions"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"category"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Only return news from within a given category, e.g. ",(0,r.jsx)(n.code,{children:"sports"}),", ",(0,r.jsx)(n.code,{children:"programming"}),", ",(0,r.jsx)(n.code,{children:"world"}),", ",(0,r.jsx)(n.code,{children:"science"}),". The ",(0,r.jsx)(n.a,{href:"https://api.currentsapi.services/v1/available/categories",children:"following categories"})," are supported"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"lang"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify the language for returned articles as a 2-digit ISO code (limited article support). The ",(0,r.jsx)(n.a,{href:"https://api.currentsapi.services/v1/available/languages",children:"following languages"})," are supported, defaults to ",(0,r.jsx)(n.code,{children:"en"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"count"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit the number of results. Can be between ",(0,r.jsx)(n.code,{children:"1"})," and ",(0,r.jsx)(n.code,{children:"200"}),", defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"keywords"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Only return articles that contain an exact match within their title or description"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideImages"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", then article image thumbnails will not be displayed"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-19",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: news-headlines\n options:\n apiKey: xxxxxxx\n category: world\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-19",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 600 requests / day)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://currentsapi.services/privacy",children:"CurrentsAPI Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"tfl-status",children:"TFL Status"}),"\n",(0,r.jsx)(n.p,{children:"Shows real-time tube status of the London Underground. All fields are optional."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/tfl"})}),"\n",(0,r.jsx)(n.h4,{id:"options-20",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showAll"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["By default, details for lines with a Good Service are not visible, but you can click More Details to see all. Setting this option to ",(0,r.jsx)(n.code,{children:"true"})," will show all lines on initial page load"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"sortAlphabetically"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["By default lines are sorted by current status, set this option to ",(0,r.jsx)(n.code,{children:"true"})," to instead sort them alphabetically"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"linesToShow"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"By default all lines are shown. If you're only interested in the status of a few lines, then pass in an array of lines to show, specified by name"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-20",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: tfl-status\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: tfl-status\n options:\n showAll: true\n sortAlphabetically: true\n linesToShow:\n - District\n - Jubilee\n - Central\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-20",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://tfl.gov.uk/corporate/privacy-and-cookies/",children:"TFL Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stock-price-history",children:"Stock Price History"}),"\n",(0,r.jsx)(n.p,{children:"Shows recent price history for a given publicly-traded stock or share"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/stocks"})}),"\n",(0,r.jsx)(n.h4,{id:"options-21",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["API key for ",(0,r.jsx)(n.a,{href:"https://www.alphavantage.co/",children:"Alpha Vantage"}),", you can get a free API key ",(0,r.jsx)(n.a,{href:"https://www.alphavantage.co/support/#api-key",children:"here"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"stock"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The stock symbol for the asset to fetch data for"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"priceTime"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The time to fetch price for. Can be ",(0,r.jsx)(n.code,{children:"high"}),", ",(0,r.jsx)(n.code,{children:"low"}),", ",(0,r.jsx)(n.code,{children:"open"})," or ",(0,r.jsx)(n.code,{children:"close"}),". Defaults to ",(0,r.jsx)(n.code,{children:"high"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColor"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Color of the chart value. Defaults to ",(0,r.jsx)(n.code,{children:"--widget-text-color"})," which inherits dashboard primary color"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The height of rendered chart in px. Defaults to ",(0,r.jsx)(n.code,{children:"300"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-21",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: stock-price-chart\n options:\n stock: NET\n apiKey: PGUWSWD6CZTXMT8N\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-21",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 500 requests/day)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.alphavantage.co/privacy/",children:"AlphaVantage Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"eth-gas-prices",children:"ETH Gas Prices"}),"\n",(0,r.jsxs)(n.p,{children:["Renders the current Gas cost of transactions on the Ethereum network (in both GWEI and USD), along with recent historical prices. Useful for spotting a good time to transact. Uses data from ",(0,r.jsx)(n.a,{href:"https://ethgas.watch/",children:"ethgas.watch"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/eth-gas"})}),"\n",(0,r.jsx)(n.h4,{id:"options-22",children:"Options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"No config options."})}),"\n",(0,r.jsx)(n.h4,{id:"example-22",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: eth-gas-prices\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-22",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/wslyvh/ethgaswatch",children:"wslyvh/ethgaswatch"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"joke",children:"Joke"}),"\n",(0,r.jsxs)(n.p,{children:["Renders a programming or generic joke. Data is fetched from the ",(0,r.jsx)(n.a,{href:"https://github.com/Sv443/JokeAPI",children:"JokesAPI"})," by @Sv443. All fields are optional."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/joke"})}),"\n",(0,r.jsx)(n.h4,{id:"options-23",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"category"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Set the category of jokes to return. Use a string to specify a single category, or an array to pass in multiple options. Available options are: ",(0,r.jsx)(n.code,{children:"all"}),", ",(0,r.jsx)(n.code,{children:"programming"}),", ",(0,r.jsx)(n.code,{children:"pun"}),", ",(0,r.jsx)(n.code,{children:"dark"}),", ",(0,r.jsx)(n.code,{children:"spooky"}),", ",(0,r.jsx)(n.code,{children:"christmas"})," and ",(0,r.jsx)(n.code,{children:"misc"}),". An up-to-date list of supported categories can be found ",(0,r.jsx)(n.a,{href:"https://v2.jokeapi.dev/categories",children:"here"}),". Defaults to ",(0,r.jsx)(n.code,{children:"all"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"safeMode"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Set to ",(0,r.jsx)(n.code,{children:"true"}),", to prevent the fetching of any NSFW jokes. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"language"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify the language for returned jokes. The following languages are supported: ",(0,r.jsx)(n.code,{children:"en"}),", ",(0,r.jsx)(n.code,{children:"cs"}),", ",(0,r.jsx)(n.code,{children:"de"}),", ",(0,r.jsx)(n.code,{children:"es"}),", ",(0,r.jsx)(n.code,{children:"fr"})," and ",(0,r.jsx)(n.code,{children:"pt"}),", and an up-to-date list of supported languages can be found ",(0,r.jsx)(n.a,{href:"https://v2.jokeapi.dev/languages",children:"here"}),". By default, your system language will be used, if it's supported, otherwise English"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-23",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: joke\n options:\n safeMode: true\n language: en\n category: Programming\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-23",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/Sv443/JokeAPI",children:"Sv443/JokeAPI"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://sv443.net/privacypolicy/en",children:"SV443's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"chuck-norris-quotes",children:"Chuck Norris quotes"}),"\n",(0,r.jsxs)(n.p,{children:["Renders a Chuck Norris quote. Data is fetched from the ",(0,r.jsx)(n.a,{href:"https://api.chucknorris.io/",children:"ChuckNorrisAPI"})," by @matchilling. All fields are optional."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://tbd"})}),"\n",(0,r.jsx)(n.h4,{id:"options-24",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"categories"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Set the category of jokes to return. Use a string to specify a single category, or an array to pass in multiple options. Available options are: ",(0,r.jsx)(n.code,{children:"animal"}),",",(0,r.jsx)(n.code,{children:"career"}),",",(0,r.jsx)(n.code,{children:"celebrity"}),",",(0,r.jsx)(n.code,{children:"dev"}),",",(0,r.jsx)(n.code,{children:"explicit"}),",",(0,r.jsx)(n.code,{children:"fashion"}),",",(0,r.jsx)(n.code,{children:"food"}),",",(0,r.jsx)(n.code,{children:"history"}),",",(0,r.jsx)(n.code,{children:"money"}),",",(0,r.jsx)(n.code,{children:"movie"}),",",(0,r.jsx)(n.code,{children:"music"}),",",(0,r.jsx)(n.code,{children:"political"}),",",(0,r.jsx)(n.code,{children:"religion"}),",",(0,r.jsx)(n.code,{children:"science"}),",",(0,r.jsx)(n.code,{children:"sport"})," and ",(0,r.jsx)(n.code,{children:"travel"}),". An up-to-date list of supported categories can be found ",(0,r.jsx)(n.a,{href:"https://api.chucknorris.io/jokes/categories",children:"here"}),". Defaults to not explicitely set and therefore any of the categories can come up."]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-24",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: chucknorris\n options:\n categories: history,sport\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-24",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://api.chucknorris.io/privacy",children:"matchilling's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"xkcd-comics",children:"XKCD Comics"}),"\n",(0,r.jsxs)(n.p,{children:["Have a laugh with the daily comic from ",(0,r.jsx)(n.a,{href:"https://xkcd.com/",children:"XKCD"}),". A classic webcomic website covering everything from Linux, math, romance, science and language. All fields are optional."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/xkcd"})}),"\n",(0,r.jsx)(n.h4,{id:"options-25",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"comic"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string / number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Choose which comic to display. Set to either ",(0,r.jsx)(n.code,{children:"random"}),", ",(0,r.jsx)(n.code,{children:"latest"})," or the series number of a specific comic, like ",(0,r.jsx)(n.code,{children:"627"}),". Defaults to ",(0,r.jsx)(n.code,{children:"latest"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-25",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: xkcd-comic\n options:\n comic: latest\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-25",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"flight-data",children:"Flight Data"}),"\n",(0,r.jsxs)(n.p,{children:["Displays airport departure and arrival flights, using data from ",(0,r.jsx)(n.a,{href:"https://www.aerodatabox.com/",children:"AeroDataBox"}),". Useful if you live near an airport and often wonder where the flight overhead is going to. Hover over a row for more flight data."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/flights"})}),"\n",(0,r.jsx)(n.h4,{id:"options-26",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"airport"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The airport to show flight data from. Should be specified as a 4-character ICAO-code, a full list of which can be found ",(0,r.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/ICAO_airport_code",children:"here"})," (example: ",(0,r.jsx)(n.code,{children:"KBJC"})," or ",(0,r.jsx)(n.code,{children:"EGKK"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["A valid ",(0,r.jsx)(n.a,{href:"https://rapidapi.com/",children:"RapidAPI"})," Key, with ",(0,r.jsx)(n.a,{href:"https://rapidapi.com/aerodatabox/api/aerodatabox/",children:"AeroDataBox"})," enabled (check in your ",(0,r.jsx)(n.a,{href:"https://rapidapi.com/developer/billing/subscriptions-and-usage",children:"Subscription Dashboard"}),"). This API is free to sign up for and use"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"For busy airports, you may wish to limit the number of results visible"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"direction"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["By default, both departure and arrival flights will be fetched, if you would like to only show flights in one direction, set this to wither ",(0,r.jsx)(n.code,{children:"departure"})," or ",(0,r.jsx)(n.code,{children:"arrival"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-26",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: flight-data\n options:\n airport: EGLC\n apiKey: XXXXX\n limit: 12\n direction: all\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-26",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 150 requests / month)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance Only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.aerodatabox.com/#h.p_cxtiyzwf_wqd",children:"AeroDataBox"})," and ",(0,r.jsx)(n.a,{href:"https://rapidapi.com/privacy/",children:"RapidAPI Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"astronomy-picture-of-the-day",children:"Astronomy Picture of the Day"}),"\n",(0,r.jsxs)(n.p,{children:["Show the NASA Astronomy Picture of the Day. Data is fetched from ",(0,r.jsx)(n.a,{href:"https://apod.nasa.gov/apod/",children:"APOD"})," using ",(0,r.jsx)(n.a,{href:"https://github.com/lissy93/go-apod",children:"@Lissy93/go-apod"})," / hosted at ",(0,r.jsx)(n.a,{href:"https://apod.as93.net/",children:"apod.as93.net"}),"."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://storage.googleapis.com/as93-screenshots/dashy/apod.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-27",children:"Options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"No config options."})}),"\n",(0,r.jsx)(n.h4,{id:"example-27",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: apod\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-27",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/lissy93/go-apod",children:"@Lissy93/go-apod"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.nasa.gov/about/highlights/HP_Privacy.html",children:"NASA's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"github-trending",children:"GitHub Trending"}),"\n",(0,r.jsxs)(n.p,{children:["Displays currently trending projects on GitHub. Optionally specify a language and time-frame. Data is fetched from ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/gh-trending-no-cors",children:"Lissy93/gh-trending-no-cors"})," using the GitHub API. All fields are optional."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/github-trending"})}),"\n",(0,r.jsx)(n.h4,{id:"options-28",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"lang"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["A programming language to fetch trending repos from that category. E.g. ",(0,r.jsx)(n.code,{children:"javascript"})," or ",(0,r.jsx)(n.code,{children:"go"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"since"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The timeframe to use when calculating trends. Can be either ",(0,r.jsx)(n.code,{children:"daily"}),", ",(0,r.jsx)(n.code,{children:"weekly"})," or ",(0,r.jsx)(n.code,{children:"monthly"}),". Defaults to ",(0,r.jsx)(n.code,{children:"daily"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Optionally limit the number of results. Max ",(0,r.jsx)(n.code,{children:"25"}),", default is ",(0,r.jsx)(n.code,{children:"10"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-28",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: github-trending-repos\n options:\n limit: 8\n since: weekly\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-28",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/gh-trending-no-cors",children:"Lissy93/gh-trending-no-cors"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://docs.github.com/en/github/site-policy/github-privacy-statement",children:"GitHub's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"github-profile-stats",children:"GitHub Profile Stats"}),"\n",(0,r.jsxs)(n.p,{children:["Display stats from your GitHub profile, using embedded cards from ",(0,r.jsx)(n.a,{href:"https://github.com/anuraghazra/github-readme-stats",children:"anuraghazra/github-readme-stats"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/github-stats"})}),"\n",(0,r.jsx)(n.h4,{id:"options-29",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The GitHub username to fetch info for. E.g. ",(0,r.jsx)(n.code,{children:"lissy93"}),". (Not required if ",(0,r.jsx)(n.code,{children:"hideProfileCard"})," and ",(0,r.jsx)(n.code,{children:"hideLanguagesCard"})," are both set to ",(0,r.jsx)(n.code,{children:"true"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideProfileCard"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", the users profile card will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideLanguagesCard"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", the users top languages card will not be shown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"repos"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If you'd like to also display stats for some GitHub repositories, then add an array or repo names here. Specified as ",(0,r.jsx)(n.code,{children:"[username]/[repo-name]"}),", e.g. ",(0,r.jsx)(n.code,{children:"lissy93/dashy"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-29",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: github-profile-stats\n options:\n username: Lissy93\n hideLanguagesCard: true\n repos:\n - lissy93/dashy\n - lissy93/personal-security-checklist\n - lissy93/twitter-sentiment-visualisation\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-29",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/anuraghazra/github-readme-stats",children:"anuraghazra/github-readme-stats"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://docs.github.com/en/github/site-policy/github-privacy-statement",children:"GitHub's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"healthchecks-status",children:"HealthChecks Status"}),"\n",(0,r.jsx)(n.p,{children:"Display status of one or more HealthChecks project(s). Works with healthchecks.io and your selfhosted instance."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/healthchecks"})}),"\n",(0,r.jsx)(n.h4,{id:"options-30",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Optional"}),(0,r.jsxs)(n.td,{children:["The base url of your instance, default is ",(0,r.jsx)(n.code,{children:"https://healthchecks.io"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"string"})," or ",(0,r.jsx)(n.code,{children:"array"})]}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"One or more API keys for your healthcheck projects. (Read-only works fine)"})]})]})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: HealthChecks\n options:\n host: https://healthcheck.your-domain.de\n apiKey: \n - abcdefg...\n - zxywvu...\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-30",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free / Paid / Self-hosted"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/healthchecks/healthchecks",children:"healthchecks/healthchecks"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://healthchecks.io/privacy/",children:"Healthchecks.io Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"hackernews-trending",children:"Hackernews Trending"}),"\n",(0,r.jsx)(n.p,{children:"Display new and trending Posts from Hackernews"}),"\n",(0,r.jsx)(n.h4,{id:"options-31",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"stories"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["HN Stories to display defaults to ",(0,r.jsx)(n.code,{children:"topstories"}),". Options are: ",(0,r.jsx)(n.code,{children:"beststories"}),", ",(0,r.jsx)(n.code,{children:"topstories"})," or ",(0,r.jsx)(n.code,{children:"newstories"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"int"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"The size of the list of Posts to show."})]})]})]}),"\n",(0,r.jsx)(n.h5,{id:"example-30",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: hackernews-trending\n options:\n stories: newstories\n limit: 10\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"mvg-departure",children:"MVG Departure"}),"\n",(0,r.jsx)(n.p,{children:"Display departure time of a MVG (M\xfcnchner Verkehrs Gesellschaft) station."}),"\n",(0,r.jsxs)(n.p,{children:["From ",(0,r.jsx)(n.a,{href:"https://www.mvg.de/impressum.html",children:"https://www.mvg.de/impressum.html"}),":"]}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:"[...] Die Verarbeitung unserer Inhalte oder Daten durch Dritte erfordert unsere ausdr\xfcckliche Zustimmung. F\xfcr private, nicht-kommerzielle Zwecke, wird eine gem\xe4\xdfigte Nutzung ohne unsere ausdr\xfcckliche Zustimmung geduldet. Jegliche Form von Data-Mining stellt keine gem\xe4\xdfigte Nutzung dar.[...]"}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"In other words: Private, noncomercial, moderate use of the API is tolerated. They don\u2019t consider data mining as moderate use. (This is not a legal advice)"}),"\n",(0,r.jsx)(n.h4,{id:"options-32",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"location"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The name of the location (exact) or the location id, startin with ",(0,r.jsx)(n.code,{children:"de:09162:"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"integer"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Limit number of entries, defaults to 10."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"A custom title to be displayed."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"header"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"bool"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Shall the title be shown?"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"object"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.line"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for given line(s)."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.product"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for specific product (TRAM, UBAHN, SBAHN, BUS)."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.destination"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/object"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for specific destination(s)"})]})]})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: mvg\n options:\n location: Marienplatz\n limit: 5\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-31",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free / Private use only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": ",(0,r.jsx)(n.a,{href:"https://mvg.de",children:"MVG"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.mvg.de/datenschutz-mvg.html",children:"MVG Datenschutz"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"mvg-connection",children:"MVG Connection"}),"\n",(0,r.jsx)(n.p,{children:"Display the next connection for two addresses/coordinates, stations or POI within Munich using MVG MVG (M\xfcnchner Verkehrs Gesellschaft)."}),"\n",(0,r.jsxs)(n.p,{children:["From ",(0,r.jsx)(n.a,{href:"https://www.mvg.de/impressum.html",children:"https://www.mvg.de/impressum.html"}),":"]}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:"[...] Die Verarbeitung unserer Inhalte oder Daten durch Dritte erfordert unsere ausdr\xfcckliche Zustimmung. F\xfcr private, nicht-kommerzielle Zwecke, wird eine gem\xe4\xdfigte Nutzung ohne unsere ausdr\xfcckliche Zustimmung geduldet. Jegliche Form von Data-Mining stellt keine gem\xe4\xdfigte Nutzung dar.[...]"}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"In other words: Private, noncomercial, moderate use of the API is tolerated. They don\u2019t consider data mining as moderate use. (This is not a legal advice)"}),"\n",(0,r.jsx)(n.h4,{id:"options-33",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"origin"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Origin of the connection."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"destination"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Destination of the connection."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"A custom title to be displayed."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"header"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"bool"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Shall the title be shown?"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"object"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.line"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for given line(s)."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.product"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for specific product (TRAM, UBAHN, SBAHN, BUS)."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"filters.destination"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string/object"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter results for specific destination(s)"})]})]})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: mvg-connection\n options:\n from: Marienplatz\n from: Dachauer Stra\xdfe 123\n header: true\n filters:\n product: [UBAHN]\n line: [U1,U2,U4,U5]\n\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-32",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free / Private use only"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": ",(0,r.jsx)(n.a,{href:"https://mvg.de",children:"MVG"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.mvg.de/datenschutz-mvg.html",children:"MVG Datenschutz"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"custom-list",children:"Custom List"}),"\n",(0,r.jsx)(n.p,{children:"Renders custom schema-compliant JOSN in a list."}),"\n",(0,r.jsx)(n.h4,{id:"options-34",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"url"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"text"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A string containing the url of a json file."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"text"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"A title for the widget. Can be helpful if stacking multiple lists in the same section."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"daysForNew"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:"Optional"}),(0,r.jsx)(n.td,{children:"Used to highlight new items."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"json-schema",children:"Json Schema"}),"\n",(0,r.jsx)(n.p,{children:"The input file should comply with the following schema:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'{\n "$schema": "http://json-schema.org/draft-04/schema#",\n "type": "array",\n "items": [\n {\n "type": "object",\n "properties": {\n "link": {\n "type": "object",\n "properties": {\n "text": {\n "type": "string"\n },\n "url": {\n "type": "string"\n },\n "title": {\n "type": "string"\n }\n },\n "required": [\n "text",\n "url",\n "title"\n ]\n },\n "value": {\n "type": "object",\n "properties": {\n "text": {\n "type": "string"\n },\n "title": {\n "type": "string"\n }\n },\n "required": [\n "text",\n "title"\n ]\n },\n "date": {\n "type": "string"\n }\n },\n "required": [\n "link",\n "value",\n "date"\n ]\n }\n ]\n}\n'})}),"\n",(0,r.jsx)(n.p,{children:"Example: This json data was generated by a data worflow that gets the new releases of a few projects from GitHub. The system used to build the data workflow is n8n."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'[\n {\n "link": {\n "text": "jellyfin/jellyfin",\n "url": "https://github.com/jellyfin/jellyfin/releases/tag/v10.10.7",\n "title": ""\n },\n "value": {\n "text": "v10.10.7",\n "title": "2025-04-05"\n },\n "date": "2025-04-05T19:14:59Z"\n },\n {\n "link": {\n "text": "jellyfin/jellyfin-web",\n "url": "https://github.com/jellyfin/jellyfin-web/releases/tag/v10.10.7",\n "title": ""\n },\n "value": {\n "text": "v10.10.7",\n "title": "2025-04-05"\n },\n "date": "2025-04-05T19:15:00Z"\n },\n {\n "link": {\n "text": "lissy93/dashy",\n "url": "https://github.com/Lissy93/dashy/releases/tag/3.1.1",\n "title": ""\n },\n "value": {\n "text": "3.1.1",\n "title": "2024-05-30"\n },\n "date": "2024-05-30T17:20:53Z"\n },\n {\n "link": {\n "text": "VSCodium/vscodium",\n "url": "https://github.com/VSCodium/vscodium/releases/tag/1.102.14746",\n "title": ""\n },\n "value": {\n "text": "1.102.14746",\n "title": "2025-07-16"\n },\n "date": "2025-07-16T18:27:49Z"\n }\n]\n'})}),"\n",(0,r.jsx)(n.h4,{id:"notes",children:"Notes"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"This widget is designed to render data generated by another system that complies with the schema. The example JSON data above was generated using a n8n workflow, and other ETL or workflow systems can generate similar results."}),"\n",(0,r.jsx)(n.li,{children:"To avoid requests to a different system in each refresh, you can save the input files locally in the user-data folder inside your Dashy installation."}),"\n",(0,r.jsxs)(n.li,{children:["To use json files from a different domain, remember to add ",(0,r.jsx)(n.code,{children:"useProxy: true"})," to the widget configuration. I have not tested this use case because I save all my input data locally on the Dashy server. Please open a ticket if you have an issue in this use case."]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"example-31",children:"Example"}),"\n",(0,r.jsxs)(n.p,{children:["This widget renders a json file that from a ",(0,r.jsx)(n.code,{children:"json-data"})," directory inside the ",(0,r.jsx)(n.code,{children:"user-data"})," directory on the Dashy server."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: custom-list\n options:\n url: /json-data/github-releases.json\n title: 'Github Releases'\n daysForNew: 5\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-33",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Not needed for files hosted inside the ",(0,r.jsx)(n.code,{children:"user-data"})," directory. Use ",(0,r.jsx)(n.code,{children:"useProxy: true"})," to bypass CORS restrictions when using data from a different server."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": user defined"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": depends on the user defined host."]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"custom-search",children:"Custom search"}),"\n",(0,r.jsx)(n.p,{children:"Allows web search using multiple user-defined search engines and other websites."}),"\n",(0,r.jsx)(n.h4,{id:"options-35",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"engines"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:"required"}),(0,r.jsxs)(n.td,{children:["An array of search engine objects. Each search engine object should have two required properties: ",(0,r.jsx)(n.strong,{children:"title"})," and ",(0,r.jsx)(n.strong,{children:"url"}),". See the example below."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"placeholder"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"Placeholder text in the search box."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"openingMethod"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsxs)(n.td,{children:["Open search in one of ",(0,r.jsx)(n.code,{children:"newtab"}),", ",(0,r.jsx)(n.code,{children:"sametab"})," or ",(0,r.jsx)(n.code,{children:"workspace"}),"."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"notes-1",children:"Notes"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["The first search engine in the engines array will be treated as the default search engine, and used when the user presses ",(0,r.jsx)(n.code,{children:"Enter"})," in the search box."]}),"\n",(0,r.jsx)(n.li,{children:"Popup blockers can interfere with opening a new search window."}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"example-32",children:"Example"}),"\n",(0,r.jsx)(n.p,{children:"This widget allows searching multiple search engines from dashy."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: 'custom-search'\n options:\n placeholder: Search for something using the buttons below\n engines:\n - title: SearXNG\n url: https://searx.lan/?q=\n - title: Quant\n url: https://www.qwant.com/?q=\n - title: Bing Web\n url: http://www.bing.com/search?q=\n - title: Bing Images\n url: http://www.bing.com/images/search?q=\n - title: Bing Maps\n url: http://www.bing.com/maps/search?q=\n - title: Yandex\n url: https://www.yandex.com/search/?text=\n - title: Passmark\n url: https://www.passmark.com/search/zoomsearch.php?zoom_query=\n - title: IMDB\n url: http://www.imdb.com/find?q=\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-34",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Not needed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": user defined"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": depends on the user defined search engines."]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"rescuetime-overview",children:"RescueTime Overview"}),"\n",(0,r.jsx)(n.p,{children:"Show an overview of how you have spent your time for the current day."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/rescue-time"})}),"\n",(0,r.jsx)(n.h4,{id:"options-36",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"required"}),(0,r.jsx)(n.td,{children:"The API-Key generated in the RescueTime UI."})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-33",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: rescue-time\n useProxy: true\n options:\n apiKey: abcdefghijkl_mnop\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-35",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Depends on user subscription"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": ",(0,r.jsx)(n.a,{href:"https://www.rescuetime.com",children:"RescueTime"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.rescuetime.com/privacy",children:"RescueTime Privacy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"minecraft-server",children:"Minecraft Server"}),"\n",(0,r.jsx)(n.p,{children:"Show minecraft server status"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://i.ibb.co/hcmd4Wf/minecraft-widget.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-37",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Display title for server uses server address if not set."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"server"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Server hostname or ip(:port) will use srv records."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"bedrock"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If server is a bedrock edition server. (default false)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showMods"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Display mod list if available"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showPlayers"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Display player list if available"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showPlugins"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Display plugin list if available"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-34",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: minecraft-status\n options:\n title: Venity Network\n server: play.venitymc.com\n bedrock: true\n showMods: true\n showPlayers: true\n showPlugins: true\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-36",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": ",(0,r.jsx)(n.a,{href:"https://mcsrvstat.us/",children:"Minecraft Server Status"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://mcsrvstat.us/faq",children:"Minecraft Server Status FAQ"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"self-hosted-services-widgets",children:"Self-Hosted Services Widgets"}),"\n",(0,r.jsx)(n.h3,{id:"system-info",children:"System Info"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.mvg.de/datenschutz-mvg.html",children:"MVG Datenschutz"})]}),"\nDisplays info about the server which Dashy is hosted on. Includes user + host, operating system, uptime and basic memory & load data."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/system-info"})}),"\n",(0,r.jsx)(n.h4,{id:"options-38",children:"Options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.em,{children:"No config options."})}),"\n",(0,r.jsx)(n.h4,{id:"example-35",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: system-info\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-37",children:"Info"}),"\n",(0,r.jsx)(n.p,{children:"No external data requests made"}),"\n",(0,r.jsxs)(n.p,{children:["Note that this widget is not available if you are running Dashy in a container or VM. Instead you can use the ",(0,r.jsx)(n.a,{href:"#system-resource-monitoring",children:"System Monitoring"})," widgets to display stats from the host system instead."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cron-monitoring-health-checks",children:"Cron Monitoring (Health Checks)"}),"\n",(0,r.jsxs)(n.p,{children:["Cron job monitoring using ",(0,r.jsx)(n.a,{href:"https://github.com/healthchecks/healthchecks",children:"Health Checks"}),". Both managed and self-hosted instances are supported."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/cron-monitor"})}),"\n",(0,r.jsx)(n.h4,{id:"options-39",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A read-only API key for the project to monitor. You can generate this by selecting a Project --\x3e Settings --\x3e API Access. Note that you must generate a separate key for each project"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If you're self-hosting, or using any instance other than the official (healthchecks.io), you will need to specify the host address. E.g. ",(0,r.jsx)(n.code,{children:"https://healthchecks.example.com"})," or ",(0,r.jsx)(n.code,{children:"http://cron-monitoing.local"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-36",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: health-checks\n options:\n apiKey: XXXXXXXXX\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-38",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe0 Free plan (up to 20 services, or self-host for unlimited)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Managed Instance or Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/healthchecks/healthchecks",children:"GitHub - HealthChecks"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://healthchecks.io/privacy/",children:"Health-Checks Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cpu-history-netdata",children:"CPU History (NetData)"}),"\n",(0,r.jsx)(n.p,{children:"Pull recent CPU usage history from NetData."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/cpu-history"})}),"\n",(0,r.jsx)(n.h4,{id:"options-40",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your NetData instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The height of rendered chart in px. Defaults to ",(0,r.jsx)(n.code,{children:"300"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColor"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColors"})})]}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"string"})," / ",(0,r.jsx)(n.code,{children:"array"})]}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Color of the chart value(s) as hex codes. ",(0,r.jsx)(n.code,{children:"chartColor"})," is a single value (defaults to ",(0,r.jsx)(n.code,{children:"--widget-text-color"}),"), whereas ",(0,r.jsx)(n.code,{children:"chartColors"})," is an array of colors"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-37",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nd-cpu-history\n options:\n host: http://192.168.1.1:19999\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-39",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/netdata/netdata",children:"GitHub - NetData"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.netdata.cloud/data-privacy/",children:"NetData Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"memory-history-netdata",children:"Memory History (NetData)"}),"\n",(0,r.jsx)(n.p,{children:"Pull recent system RAM usage from NetData, and show as a breakdown of different categories."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://i.ibb.co/2dsSWnk/nd-memory-history.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-41",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your NetData instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The height of rendered chart in px. Defaults to ",(0,r.jsx)(n.code,{children:"300"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColor"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColors"})})]}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"string"})," / ",(0,r.jsx)(n.code,{children:"array"})]}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Color of the chart value(s) as hex codes. ",(0,r.jsx)(n.code,{children:"chartColor"})," is a single value (defaults to ",(0,r.jsx)(n.code,{children:"--widget-text-color"}),"), whereas ",(0,r.jsx)(n.code,{children:"chartColors"})," is an array of colors"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-38",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nd-ram-history\n options:\n host: http://192.168.1.1:19999\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-40",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/netdata/netdata",children:"GitHub - NetData"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.netdata.cloud/data-privacy/",children:"NetData Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"load-history-netdata",children:"Load History (NetData)"}),"\n",(0,r.jsx)(n.p,{children:"Pull recent load usage in 1, 5 and 15 minute intervals, from NetData."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/load-history"})}),"\n",(0,r.jsx)(n.h4,{id:"options-42",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your NetData instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The height of rendered chart in px. Defaults to ",(0,r.jsx)(n.code,{children:"300"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColor"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"chartColors"})})]}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"string"})," / ",(0,r.jsx)(n.code,{children:"array"})]}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Color of the chart value(s) as hex codes. ",(0,r.jsx)(n.code,{children:"chartColor"})," is a single value (defaults to ",(0,r.jsx)(n.code,{children:"--widget-text-color"}),"), whereas ",(0,r.jsx)(n.code,{children:"chartColors"})," is an array of colors"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-39",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nd-load-history\n options:\n host: http://192.168.1.1:19999\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-41",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/netdata/netdata",children:"GitHub - NetData"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.netdata.cloud/data-privacy/",children:"NetData Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-stats",children:"Pi-Hole Stats"}),"\n",(0,r.jsxs)(n.p,{children:["Displays the number of queries blocked by ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"}),"."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/pi-hole"})}),"\n",(0,r.jsx)(n.h4,{id:"options-43",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideStatus"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideChart"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideInfo"})})]}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide any of the three parts of the widget"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password. It is ",(0,r.jsx)(n.strong,{children:"NOT"})," your pi-hole admin interface or server password. It can be found in ",(0,r.jsx)(n.code,{children:"/etc/pihole/setupVars.conf"}),", and is a 64-character located on the line that starts with ",(0,r.jsx)(n.code,{children:"WEBPASSWORD"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-40",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-stats\n options:\n hostname: http://192.168.130.1\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["[!TIP]\nIn order to avoid leaking secret data, both ",(0,r.jsx)(n.code,{children:"hostname"})," and ",(0,r.jsx)(n.code,{children:"apiKey"})," can leverage environment variables. Simply pass the name of the variable, which MUST start with ",(0,r.jsx)(n.code,{children:"VUE_APP_"}),"."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-stats\n options:\n hostname: VUE_APP_pihole_ip\n apiKey: VUE_APP_pihole_key\n"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:"[!IMPORTANT]\nYou will need to restart the server (or the docker image) if adding/editing an env var for this to be refreshed."}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"info-42",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-Hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-stats-v6",children:"Pi-Hole Stats v6"}),"\n",(0,r.jsxs)(n.p,{children:["Displays the number of queries blocked by ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"}),". Use this version of the widget if you have a v6+ Pi-Hole instance."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://i.ibb.co/zftCLJN/pi-hole-stats.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-44",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideStatus"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideChart"})})," / ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideInfo"})})]}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Optionally hide any of the three parts of the widget"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password or application password. It ",(0,r.jsx)(n.strong,{children:"IS"})," your Pi-Hole admin interface password ",(0,r.jsx)(n.strong,{children:"UNLESS"})," you have 2FA turned on (in contrast to the old widget). If you have 2FA turned on you will need to create an application password. Refer to Pi-Hole documentation for how to create an application password."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-41",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-stats-v6\n options:\n hostname: http://192.168.130.1\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["[!TIP]\nIn order to avoid leaking secret data, both ",(0,r.jsx)(n.code,{children:"hostname"})," and ",(0,r.jsx)(n.code,{children:"apiKey"})," can leverage environment variables. Simply pass the name of the variable, which MUST start with ",(0,r.jsx)(n.code,{children:"VUE_APP_"}),"."]}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-stats-v6\n options:\n hostname: VUE_APP_pihole_ip\n apiKey: VUE_APP_pihole_key\n"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:"[!IMPORTANT]\nYou will need to restart the server (or the docker image) if adding/editing an env var for this to be refreshed."}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"info-43",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-Hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-queries",children:"Pi-Hole Queries"}),"\n",(0,r.jsxs)(n.p,{children:["Shows top queries that were blocked and allowed by ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"}),"."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/pi-hole-queries"})}),"\n",(0,r.jsx)(n.h4,{id:"options-45",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password. It is ",(0,r.jsx)(n.strong,{children:"NOT"})," your pi-hole admin interface or server password. It can be found in ",(0,r.jsx)(n.code,{children:"/etc/pihole/setupVars.conf"}),", and is a 64-character located on the line that starts with ",(0,r.jsx)(n.code,{children:"WEBPASSWORD"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"count"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of queries to display. Defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-42",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-top-queries\n options:\n hostname: https://pi-hole.local\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-44",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-queries-v6",children:"Pi-Hole Queries v6"}),"\n",(0,r.jsxs)(n.p,{children:["Shows top queries that were blocked and allowed by ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"}),". Use this version of the widget if you have a v6+ Pi-Hole instance."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://i.ibb.co/pXR0bdQ/pi-hole-queries.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-46",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password or application password. It ",(0,r.jsx)(n.strong,{children:"IS"})," your Pi-Hole admin interface password ",(0,r.jsx)(n.strong,{children:"UNLESS"})," you have 2FA turned on (in contrast to the old widget). If you have 2FA turned on you will need to create an application password. Refer to Pi-Hole documentation for how to create an application password."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"count"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The number of queries to display. Defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-43",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-top-queries-v6\n options:\n hostname: https://pi-hole.local\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-45",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-recent-traffic",children:"Pi-Hole Recent Traffic"}),"\n",(0,r.jsxs)(n.p,{children:["Shows number of recent traffic, using allowed and blocked queries from ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://pixelflare.cc/alicia/dashy/pi-hole-trafic"})}),"\n",(0,r.jsx)(n.h4,{id:"options-47",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password. It is ",(0,r.jsx)(n.strong,{children:"NOT"})," your pi-hole admin interface or server password. It can be found in ",(0,r.jsx)(n.code,{children:"/etc/pihole/setupVars.conf"}),", and is a 64-character located on the line that starts with ",(0,r.jsx)(n.code,{children:"WEBPASSWORD"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-44",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-traffic\n options:\n hostname: https://pi-hole.local\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-46",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pi-hole-recent-traffic-v6",children:"Pi-Hole Recent Traffic v6"}),"\n",(0,r.jsxs)(n.p,{children:["Shows number of recent traffic, using allowed and blocked queries from ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/",children:"Pi-Hole"}),". Use this version of the widget if you have a v6+ Pi-Hole instance."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://i.ibb.co/7kdxxwx/pi-hole-recent-queries.png"})}),"\n",(0,r.jsx)(n.h4,{id:"options-48",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Pi-Hole instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Your Pi-Hole web password or application password. It ",(0,r.jsx)(n.strong,{children:"IS"})," your Pi-Hole admin interface password ",(0,r.jsx)(n.strong,{children:"UNLESS"})," you have 2FA turned on (in contrast to the old widget). If you have 2FA turned on you will need to create an application password. Refer to Pi-Hole documentation for how to create an application password."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-45",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: pi-hole-traffic-v6\n options:\n hostname: https://pi-hole.local\n apiKey: xxxxxxxxxxxxxxxxxxxxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-47",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udd34 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/pi-hole/pi-hole",children:"GitHub - Pi-hole"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://pi-hole.net/privacy/",children:"Pi-Hole Privacy Guide"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stat-ping-statuses",children:"Stat Ping Statuses"}),"\n",(0,r.jsxs)(n.p,{children:["Displays the current and recent uptime of your running services, via a self-hosted instance of ",(0,r.jsx)(n.a,{href:"https://github.com/statping/statping",children:"StatPing"})]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"300",src:"https://pixelflare.cc/alicia/dashy/statping"})}),"\n",(0,r.jsx)(n.h4,{id:"options-49",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your StatPing instance, without a trailing slash"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"groupId"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:"Optional"}),(0,r.jsxs)(n.td,{children:["If provided, only Services in the given group are displayed. Defaults to ",(0,r.jsx)(n.code,{children:"0"})," in which case all services are displayed."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showChart"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:"Optional"}),(0,r.jsxs)(n.td,{children:["If provided and ",(0,r.jsx)(n.code,{children:"false"})," then charts are not displayed. Defaults to ",(0,r.jsx)(n.code,{children:"true"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showInfo"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:"Optional"}),(0,r.jsxs)(n.td,{children:["If provided and ",(0,r.jsx)(n.code,{children:"false"})," then information summaries are not displayed. Defaults to ",(0,r.jsx)(n.code,{children:"true"}),"."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-46",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: stat-ping\n options:\n hostname: http://192.168.130.1:8080\n"})}),"\n",(0,r.jsx)(n.p,{children:"or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: stat-ping\n options:\n hostname: http://192.168.130.1:8080\n groupId: 3\n showChart: false\n showInfo: false\n"})}),"\n",(0,r.jsxs)(n.p,{children:["You can use multiple StatPing widgets with different ",(0,r.jsx)(n.code,{children:"groupId"}),"s."]}),"\n",(0,r.jsx)(n.p,{children:"Note, the Group Id is not directly visible in StatPing UI, you can inspect the group select HTML element or the API response to find out."}),"\n",(0,r.jsx)(n.h4,{id:"info-48",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/statping/statping",children:"GitHub - StatPing"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://docs.statping.com/",children:"StatPing Docs"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"synology-download-station",children:"Synology Download Station"}),"\n",(0,r.jsx)(n.p,{children:"Displays the current downloads/torrents tasks of your Synology NAS"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://pixelflare.cc/alicia/dashy/synology-downloads"})}),"\n",(0,r.jsx)(n.h4,{id:"options-50",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your Synology NAS, without a trailing slash"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The username of a user on your synology NAS. You will see only this user download station tasks if he is not part of the administrator group. Currently don't support OTP protected accounts."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The password of the account specified above."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-47",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: synology-download\n options:\n hostname: http://192.168.1.1:8080\n username: dashy\n password: totally-secure-password\n\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-49",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://www.synology.com/en-us",children:"Synology"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.synology.com/en-us/company/legal/privacy",children:"Synology Privacy Statement"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"adguard-home-block-stats",children:"AdGuard Home Block Stats"}),"\n",(0,r.jsxs)(n.p,{children:["Fetches data from your ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"})," instance, and\ndisplays total number of allowed and blocked queries, plus a pie chart showing breakdown by block type."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/adguard-stats"})}),"\n",(0,r.jsx)(n.h4,{id:"options-51",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your AdGuard Home instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your username here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your password here"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-48",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: adguard-stats\n useProxy: true\n options:\n hostname: http://127.0.0.1\n username: admin\n password: test\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-50",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/privacy.html",children:"AdGuard Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"adguard-home-filters",children:"AdGuard Home Filters"}),"\n",(0,r.jsxs)(n.p,{children:["Fetches data from your ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"})," instance, to display the current status of each of your filter lists. Includes filter name, last updated, number of items, and a link to the list."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/adguard-filters"})}),"\n",(0,r.jsx)(n.h4,{id:"options-52",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your AdGuard Home instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your username here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your password here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showOnOffStatusOnly"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),", will only show aggregated AdGuard filter status (on/off), instead of a list of filters"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-49",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: adguard-filter-status\n useProxy: true\n options:\n hostname: http://127.0.0.1\n username: admin\n password: test\n showOnOffStatusOnly: false\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-51",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/privacy.html",children:"AdGuard Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"adguard-home-dns-info",children:"AdGuard Home DNS Info"}),"\n",(0,r.jsxs)(n.p,{children:["Fetches data from your ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"})," instance, and displays the current status (Enabled / Disabled) of AdGuard DNS. Click show more to view detailed info, including upstream DNS provider, active ports, and the status of DNSSEC, EDNS CS, PTR and IPv6."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/adguard-dns"})}),"\n",(0,r.jsx)(n.h4,{id:"options-53",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your AdGuard Home instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your username here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your password here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showFullInfo"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If set to ",(0,r.jsx)(n.code,{children:"true"}),', the full DNS info will be shown by default, without having to click "Show Info"']})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-50",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: adguard-dns-info\n useProxy: true\n options:\n hostname: http://127.0.0.1\n username: admin\n password: test\n showFullInfo: false\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-52",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/privacy.html",children:"AdGuard Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"adguard-home-top-domains",children:"AdGuard Home Top Domains"}),"\n",(0,r.jsxs)(n.p,{children:["Fetches data from your ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"})," instance, and displays a list of the most queried, and most blocked domains."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"600",src:"https://pixelflare.cc/alicia/dashy/adguard-domains"})}),"\n",(0,r.jsx)(n.h4,{id:"options-54",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to your AdGuard Home instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your username here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If you've got auth enabled on AdGuard, provide your password here"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify the number of results to show, between ",(0,r.jsx)(n.code,{children:"1"})," and ",(0,r.jsx)(n.code,{children:"100"}),", defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideBlockedDomains"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Don't show the blocked domains list (queried domains only)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideQueriedDomains"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Don't show the queried domains list (blocked domains only)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-51",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: adguard-top-domains\n useProxy: true\n options:\n hostname: http://127.0.0.1\n username: admin\n password: test\n limit: 10\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-53",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/adguard-home/overview.html",children:"AdGuard Home"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://adguard.com/en/privacy.html",children:"AdGuard Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-user",children:"Nextcloud User"}),"\n",(0,r.jsxs)(n.p,{children:["Nextcloud is a ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/install/#instructions-server",children:"self hosted"})," productivity platform, it can also be used free of charge with ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/sign-up/",children:"hundreds of existing hosting providers"})," that offer a free Nextcloud account."]}),"\n",(0,r.jsx)(n.p,{children:"Displays branding information of a Nextcloud server (logo, url, slogan) and some user details (name, login name, last login, disk space or quota). Use with regular or admin user."}),"\n",(0,r.jsx)(n.p,{children:"Shows quota usage when quota is enabled for the user or disk usage when not enabled."}),"\n",(0,r.jsx)(n.p,{children:"Known issues: the User API incorrectly reports available disk space as total for admin users when quota is not enabled (which usually is the case for admins)."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/nextcloud-user",alt:"nextcloud-user"})}),"\n",(0,r.jsx)(n.h4,{id:"options-55",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud username"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-52",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-user\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-54",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-user-statuses",children:"Nextcloud User Statuses"}),"\n",(0,r.jsx)(n.p,{children:"Show user statuses for selected users."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/nextcloud-user-status",alt:"nextcloud-userstatus"})}),"\n",(0,r.jsx)(n.h4,{id:"options-56",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud username"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"users"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["Nextcloud User IDs to show statuses for, list size between ",(0,r.jsx)(n.code,{children:"1"})," and ",(0,r.jsx)(n.code,{children:"100"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showEmpty"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Show statuses without a message, defaults to ",(0,r.jsx)(n.code,{children:"true"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-53",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-userstatus\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n users: ['bob', 'alice']\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-55",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-notifications",children:"Nextcloud Notifications"}),"\n",(0,r.jsx)(n.p,{children:"Displays your notifications and allows deleting them."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/next-cloud-notifications",alt:"nextcloud-notifications"})}),"\n",(0,r.jsx)(n.h4,{id:"options-57",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud username"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number|string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit displayed notifications either by count, e.g. ",(0,r.jsx)(n.code,{children:"5"})," to show the 5 most recent, or by age, e.g. ",(0,r.jsx)(n.code,{children:"1d"})," to only show notifications not older than a day. Accepted suffixes for age limit are ",(0,r.jsx)(n.code,{children:"m"}),", ",(0,r.jsx)(n.code,{children:"h"})," and ",(0,r.jsx)(n.code,{children:"d"}),"."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-54",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-notifications\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n limit: 6h\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-56",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-system",children:"Nextcloud System"}),"\n",(0,r.jsx)(n.p,{children:"Visualises overall memory utilisation and CPU load averages, shows server versions."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/next-cloud-sysyem",alt:"nextcloud-system"})}),"\n",(0,r.jsx)(n.h4,{id:"options-58",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Must be a Nextcloud admin user"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-55",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-system\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-57",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-stats",children:"Nextcloud Stats"}),"\n",(0,r.jsx)(n.p,{children:"Shows key usage statistics about your Nextcloud server."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/nextcloud-stats",alt:"nextcloud-stats"})}),"\n",(0,r.jsx)(n.h4,{id:"options-59",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Must be a Nextcloud admin user"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-56",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-stats\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-58",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nextcloud-php-opcache-stats",children:"Nextcloud PHP OPcache Stats"}),"\n",(0,r.jsx)(n.p,{children:"Shows statistics about PHP OPcache performance on your Nextcloud server."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/nextcloud-php",alt:"nextcloud-phpopcache"})}),"\n",(0,r.jsx)(n.h4,{id:"options-60",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Nextcloud server"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Must be a Nextcloud admin user"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"Nextcloud app-password (create one in Settings -> Security)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-57",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: nextcloud-php-opcache\n useProxy: true\n options:\n hostname: https://nextcloud.example.com\n username: alice\n password: xxxxx-xxxxx-xxxxx-xxxxx\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-59",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://nextcloud.com",children:"Nextcloud"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://nextcloud.com/privacy",children:"Nextcloud Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"proxmox-lists",children:"Proxmox lists"}),"\n",(0,r.jsx)(n.p,{children:"Shows lists of nodes, containers, and VMs in a Proxmox virtual environment cluster, with a status indicator."}),"\n",(0,r.jsx)(n.h4,{id:"options-61",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"cluster_url"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The URL of the proxmox cluster server. No trailing ",(0,r.jsx)(n.code,{children:"/"}),". for example: ",(0,r.jsx)(n.code,{children:"https://proxmox.lan:8006"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"user_name"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["A Proxmox API Username, for example ",(0,r.jsx)(n.code,{children:"root@pam"})," or ",(0,r.jsx)(n.code,{children:"dashy@pve"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"token_name"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A Proxmox API token name. You can get a token in the API section of the cluster management interface."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"token_uuid"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The value of the token entered above. This is normally a UUID."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"node"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"A Proxmox node name. If empty or not supplied, a list of nodes will be shown."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"node_data"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsxs)(n.td,{children:["This is required if a node is selected, Currently this accepts two values, either ",(0,r.jsx)(n.code,{children:"lxc"})," or ",(0,r.jsx)(n.code,{children:"qemu"})," but the widget can be improved to get other types of data from the Proxmox API."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"A widget title."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"title_as_link"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsxs)(n.td,{children:["When this is set to anything other than 0 or false, the title will be linked to the value entered in the ",(0,r.jsx)(n.code,{children:"cluster_url"})," option."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"footer"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"A widget footer."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"footer_as_link"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsxs)(n.td,{children:["When this is set to anything other than 0 or false, the title will be linked to the value entered in the ",(0,r.jsx)(n.code,{children:"cluster_url"})," option."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hide_templates"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:"optional"}),(0,r.jsx)(n.td,{children:"When this is set to anything other than 0 or false, templates will be filtered out of the result list."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-58",children:"Example"}),"\n",(0,r.jsx)(n.p,{children:"This will show the list of nodes."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: proxmox-lists\n useProxy: true \n options:\n cluster_url: https://proxmox.lan:8006\n user_name: root@pam\n token_name: dashy\n token_uuid: bfb152df-abcd-abcd-abcd-ccb95a472d01\n"})}),"\n",(0,r.jsx)(n.p,{children:"This will show the list of VMs, with a title and a linked fotter, hiding VM templates."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: proxmox-lists\n useProxy: true \n options:\n cluster_url: https://proxmox.lan:8006\n user_name: root@pam\n token_name: dashy\n token_uuid: bfb152df-abcd-abcd-abcd-ccb95a472d01\n node: proxmox\n node_data: qemu\n title: Proxmox VMs\n title_as_link: false\n footer: Proxmox\n footer_as_link: true\n hide_templates: 1\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-60",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://proxmox.com/en/proxmox-ve",children:"Proxmox Virtual Environment"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://proxmox.com/en/privacy-policy",children:"Proxmox's Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"404 Error in development mode"}),": The error might disappear in production mode ",(0,r.jsx)(n.code,{children:"yarn start"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"500 Error in production mode"}),": Try adding the certificate authority (CA) certificate of your Proxmox host to Node.js.\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Download the Proxmox CA certificate to your Dashy host."}),"\n",(0,r.jsxs)(n.li,{children:["Export environment variable ",(0,r.jsx)(n.code,{children:"NODE_EXTRA_CA_CERTS"})," and set its value to the path of the downloaded CA certificate. Example: ",(0,r.jsx)(n.code,{children:"export NODE_EXTRA_CA_CERTS=/usr/local/share/ca-certificates/devlab_ca.pem"})]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sabnzbd",children:"Sabnzbd"}),"\n",(0,r.jsx)(n.p,{children:"Shows queue information regarding your self hosted Sabnzbd server."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"450",src:"https://pixelflare.cc/alicia/dashy/sabnzbd",alt:"Sabnzbd"})}),"\n",(0,r.jsx)(n.h4,{id:"options-62",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"sabnzbdUrl"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The URL of the Sabnzbd server. No trailing ",(0,r.jsx)(n.code,{children:"/"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["API key for Sabnzbd access. Located under ",(0,r.jsx)(n.code,{children:"Config"})," -> ",(0,r.jsx)(n.code,{children:"General"})," -> ",(0,r.jsx)(n.code,{children:"Security"})," -> ",(0,r.jsx)(n.code,{children:"API Key"}),"."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideDetails"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Hides extra server queue details."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideQueue"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Hides the queue list in an expandable dropdown."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-59",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:" - type: sabnzbd\n options:\n sabnzbdUrl: 'https://sabnzbd.example.com'\n apiKey: XXXXXXXXXXXXXXXXXX\n hideDetails: false\n hideQueue: false\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-61",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://sabnzbd.org/",children:"Sabnzbd"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://forums.sabnzbd.org/ucp.php?mode=privacy",children:"Sabnzbd Privacy Policy"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"gluetun-vpn-info",children:"Gluetun VPN Info"}),"\n",(0,r.jsx)(n.p,{children:"Display info from the Gluetun VPN container public IP API. This can show the IP and location data for the exit VPN node."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/guletn-vpn"})}),"\n",(0,r.jsx)(n.h4,{id:"options-63",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"visibleFields"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["A comma separated list of the fields you want visible in the widget. You can have any number of the following : ",(0,r.jsx)(n.code,{children:"public_ip"}),", ",(0,r.jsx)(n.code,{children:"region"}),", ",(0,r.jsx)(n.code,{children:"country"}),", ",(0,r.jsx)(n.code,{children:"city"}),", ",(0,r.jsx)(n.code,{children:"location"}),", ",(0,r.jsx)(n.code,{children:"organisation"}),", ",(0,r.jsx)(n.code,{children:"postal_code"}),", ",(0,r.jsx)(n.code,{children:"timezone"}),". Defaults to just ",(0,r.jsx)(n.code,{children:"public_ip"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The url to the gluetun HTTP control server. E.g. ",(0,r.jsx)(n.code,{children:"http://gluetun:8000"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-60",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gluetun-status\n useProxy: true\n options:\n hostname: http://server-or-conatiner-hostname:8000\n visibleFields: public_ip,region,country,city,location,organisation,postal_code,timezone\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-62",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/qdm12/gluetun",children:"Gluetun"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://github.com/qdm12/gluetun/wiki",children:"Gluetun Wiki"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"drone-ci-builds",children:"Drone CI Builds"}),"\n",(0,r.jsxs)(n.p,{children:["Display the last builds from a ",(0,r.jsx)(n.a,{href:"https://www.drone.ci",children:"Drone CI"})," instance. A self-hosted CI system that uses docker."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"380",src:"https://pixelflare.cc/alicia/dashy/drone-ci"})}),"\n",(0,r.jsx)(n.h4,{id:"options-64",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The hostname of the Drone CI instance."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The API key (https://[your-drone-instance]/account)."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"integer"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Limit the amounts of listed builds."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"repo"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Show only builds of the specified repo"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-61",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: drone-ci\n updateInterval: 30\n options:\n host: https://drone.somedomain.com\n apiKey: my-very-secret-api-key\n limit: 10\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-63",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://www.drone.io",children:"Drone"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://www.drone.io",children:"Drone"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"filebrowser",children:"Filebrowser"}),"\n",(0,r.jsxs)(n.p,{children:["Displays storage statistics and file listings from a ",(0,r.jsx)(n.a,{href:"https://github.com/gtsteffaniak/filebrowser",children:"Filebrowser Quantum"})," instance. Shows directory size, file/folder counts, favorite files, and recently modified files with quick-access links."]}),"\n",(0,r.jsx)(n.h4,{id:"options-65",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of your Filebrowser instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"A long-lived API key (create in Settings \u2192 API Keys)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"source"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"The source/scope name to browse. Defaults to the first available source"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"path"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["The directory path to display. Defaults to ",(0,r.jsx)(n.code,{children:"/"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"favorites"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"List of filenames to show as quick-access favorites"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showRecent"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Number of recently modified files to display. Defaults to ",(0,r.jsx)(n.code,{children:"5"}),", set to ",(0,r.jsx)(n.code,{children:"0"})," to disable"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Maximum number of files to display per section. Defaults to ",(0,r.jsx)(n.code,{children:"10"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideStats"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If ",(0,r.jsx)(n.code,{children:"true"}),", hides the storage statistics section"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideFavorites"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If ",(0,r.jsx)(n.code,{children:"true"}),", hides the favorites section"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hideRecent"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If ",(0,r.jsx)(n.code,{children:"true"}),", hides the recent files section"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"showDetailedStats"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"boolean"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If ",(0,r.jsx)(n.code,{children:"true"}),", shows additional statistics including last modified date, largest file, hidden file count, total items, and file type breakdown. Defaults to ",(0,r.jsx)(n.code,{children:"false"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-62",children:"Example"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"Basic usage:"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: filebrowser\n useProxy: true\n options:\n hostname: http://filebrowser.local:8080\n apiKey: VUE_APP_FILEBROWSER_KEY\n source: Documents\n path: /\n showRecent: 5\n favorites:\n - important-notes.txt\n - config.yaml\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"With detailed statistics:"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: filebrowser\n useProxy: true\n options:\n hostname: http://filebrowser.local:8080\n apiKey: VUE_APP_FILEBROWSER_KEY\n source: Downloads\n showDetailedStats: true\n showRecent: 10\n limit: 15\n"})}),"\n",(0,r.jsx)(n.h4,{id:"widget-sections",children:"Widget Sections"}),"\n",(0,r.jsx)(n.p,{children:"The widget displays up to four sections:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Storage Stats"})," - Directory name, total size, file and folder counts"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Detailed Stats"})," (optional) - Last modified date, largest file, hidden file count, total items, and file type breakdown with badges"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Favorites"})," - Quick-access links to user-specified files"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Recent Files"})," - Most recently modified files sorted by date"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"info-64",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/gtsteffaniak/filebrowser",children:"Filebrowser Quantum"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsx)(n.em,{children:"Self-Hosted"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"linkding",children:"Linkding"}),"\n",(0,r.jsx)(n.p,{children:"Linkding is a self-hosted bookmarking service, which has a clean interface and is simple to set up. This lists the links, filterable by tags."}),"\n",(0,r.jsx)(n.h4,{id:"options-66",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The hostname of the Drone CI instance."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The API key (",(0,r.jsx)(n.a,{href:"https://your-linkding-instance/settings/integrations",children:"https://your-linkding-instance/settings/integrations"}),")."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"tags"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"list of string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Filter the links by tag."})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-63",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: linkding\n updateInterval: 30\n options:\n host: https://lingding.somedomain.com\n apiKey: my-very-secret-api-key\n tags: \n - rpg\n - markdown\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-65",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/sissbruecker/linkding",children:"Linkding"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://github.com/sissbruecker/linkding",children:"Linkding"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"uptime-kuma",children:"Uptime Kuma"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})," is an easy-to-use self-hosted monitoring tool."]}),"\n",(0,r.jsx)(n.h4,{id:"options-67",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"url"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Uptime Kuma instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiKey"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The API key (see ",(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma/wiki/API-Keys",children:"https://github.com/louislam/uptime-kuma/wiki/API-Keys"}),")."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-64",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: uptime-kuma\n useProxy: true\n options:\n apiKey: uk2_99H0Yd3I2pPNIRfn0TqBFu4g5q85R1Mh75yZzw6H\n url: http://192.168.1.106:3691/metrics\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-66",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})," )"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"uptime-kuma-status-page",children:"Uptime Kuma Status Page"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})," is an easy-to-use self-hosted monitoring tool."]}),"\n",(0,r.jsx)(n.h4,{id:"options-68",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"host"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL of the Uptime Kuma instance"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"slug"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The slug of the status page"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"monitorNames"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"strins"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Names of monitored services (in the same order as on the kuma uptime status page)"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-65",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'- type: uptime-kuma-status-page\n options:\n host: http://localhost:3001\n slug: another-beautiful-status-page\n monitorNames:\n - "Name1"\n - "Name2"\n'})}),"\n",(0,r.jsx)(n.h4,{id:"info-67",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Not Needed"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})," )"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://github.com/louislam/uptime-kuma",children:"Uptime Kuma"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"tactical-rmm",children:"Tactical RMM"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://github.com/amidaware/tacticalrmm",children:"Tactical RMM"})," is a self-hosted remote monitoring & management tool."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.a,{href:"https://ibb.co/NVHWpD1",children:(0,r.jsx)(n.img,{src:"https://pixelflare.cc/alicia/dashy/tactical-rmm",alt:"Capture",border:"0"})})}),"\n",(0,r.jsx)(n.h4,{id:"options-69",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"url"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The status endpoint URL (",(0,r.jsx)(n.a,{href:"https://api.example.com/core/status/",children:"https://api.example.com/core/status/"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"token"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["The MON_TOKEN (see ",(0,r.jsx)(n.a,{href:"https://docs.tacticalrmm.com/tipsntricks/#monitor-your-trmm-instance-via-the-built-in-monitoring-endpoint",children:"https://docs.tacticalrmm.com/tipsntricks/#monitor-your-trmm-instance-via-the-built-in-monitoring-endpoint"}),")."]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-66",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: trmm\n useProxy: true\n options:\n token: PkPVKMzbmXgeQDlJWb0WXYvsIk3JvZyadURud2cSTdMia6hUbQ\n url: https://api.example.com/core/status/\n"})}),"\n",(0,r.jsx)(n.h4,{id:"info-68",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe0 Proxied"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe2 Required"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/amidaware/tacticalrmm",children:"Tactical RMM"})," )"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": ",(0,r.jsxs)(n.em,{children:["See ",(0,r.jsx)(n.a,{href:"https://github.com/amidaware/tacticalrmm",children:"Tactical RMM"})]})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"system-resource-monitoring",children:"System Resource Monitoring"}),"\n",(0,r.jsx)(n.h3,{id:"glances",children:"Glances"}),"\n",(0,r.jsxs)(n.p,{children:["The easiest method for displaying system info and resource usage in Dashy is with ",(0,r.jsx)(n.a,{href:"https://nicolargo.github.io/glances/",children:"Glances"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["Glances is a cross-platform monitoring tool developed by ",(0,r.jsx)(n.a,{href:"https://github.com/nicolargo",children:"@nicolargo"}),". It's similar to top/htop but with a ",(0,r.jsx)(n.a,{href:"https://glances.readthedocs.io/en/latest/api.html",children:"Rest API"})," and many ",(0,r.jsx)(n.a,{href:"https://glances.readthedocs.io/en/latest/gw/index.html",children:"data exporters"})," available. Under the hood, it uses ",(0,r.jsx)(n.a,{href:"https://github.com/giampaolo/psutil",children:"psutil"})," for retrieving system info."]}),"\n",(0,r.jsxs)(n.p,{children:["If you don't already have it installed, either follow the ",(0,r.jsx)(n.a,{href:"https://github.com/nicolargo/glances/blob/master/README.rst",children:"Installation Guide"})," for your system, or setup ",(0,r.jsx)(n.a,{href:"https://glances.readthedocs.io/en/latest/docker.html",children:"with Docker"}),", or use the one-line install script: ",(0,r.jsx)(n.code,{children:"curl -L https://bit.ly/glances | /bin/bash"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["If you are using Docker to run glances make sure to add the enviroment variable ",(0,r.jsx)(n.code,{children:"-e TZ = {YourTimeZone}"}),". You can get a list of valid timezones by running ",(0,r.jsx)(n.code,{children:"timedatectl list-timezones"})," on any linux system. This is needed so the graphs show the currect time."]}),"\n",(0,r.jsx)(n.p,{children:"Here an example for Docker"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:" docker run -d \\\n --name glances \\\n --restart unless-stopped \\\n -v /var/run/docker.sock:/var/run/docker.sock:ro \\\n -p 61208:61208 \\\n --pid host \\\n --privileged \\\n -e GLANCES_OPT=-w \\\n -e PUID=1000 \\\n -e PGID=1000 \\\n -e TZ=Europe/Zurich \\\n nicolargo/glances:latest\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Glances can be launched with the ",(0,r.jsx)(n.code,{children:"glances"})," command. You'll need to run it in web server mode, using the ",(0,r.jsx)(n.code,{children:"-w"})," option for the API to be reachable. If you don't plan on using the Web UI, then you can disable it using ",(0,r.jsx)(n.code,{children:"--disable-webui"}),". See the ",(0,r.jsx)(n.a,{href:"https://glances.readthedocs.io/en/latest/cmds.html",children:"command reference docs"})," for more info."]}),"\n",(0,r.jsxs)(n.p,{children:["If Glances is running on a Windows system it is recommended to add the following arguments ",(0,r.jsx)(n.code,{children:"--disable-plugin all --enable-plugin cpu,mem,diskio,ip,network,containers,quicklook,load,fs,alert -w"})," This is due to Glances not being that stable on windows, so disabling all plugins that aren't used by Dashy widgets can save on ressources."]}),"\n",(0,r.jsx)(n.h4,{id:"options-70",children:"Options"}),"\n",(0,r.jsxs)(n.p,{children:["All Glance's based widgets require a ",(0,r.jsx)(n.code,{children:"hostname"}),". All other parameters are optional."]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"hostname"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL or IP + port to your Glances instance (without a trailing slash)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If you have setup basic auth on Glances, specify username here (defaults to ",(0,r.jsx)(n.code,{children:"glances"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If you have setup basic auth on Glances, specify password here. ",(0,r.jsx)(n.strong,{children:"Note"}),": since this password is in plaintext, it is important not to reuse it anywhere else"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiVersion"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Specify an API version, defaults to V ",(0,r.jsx)(n.code,{children:"3"}),". Note that support for older versions is limited"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"For widgets that show a time-series chart, optionally limit the number of data points returned. A higher number will show more historical results, but will take longer to load. A value between 300 - 800 is usually optimal"})]})]})]}),"\n",(0,r.jsxs)(n.p,{children:["Note that if auth is configured, requests must be proxied with ",(0,r.jsx)(n.code,{children:"useProxy: true"})]}),"\n",(0,r.jsx)(n.h4,{id:"info-69",children:"Info"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"CORS"}),": \ud83d\udfe2 Enabled"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Auth"}),": \ud83d\udfe0 Optional"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Price"}),": \ud83d\udfe2 Free"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Self-Hosted (see ",(0,r.jsx)(n.a,{href:"https://github.com/nicolargo/glances",children:"GitHub - Nicolargo/Glances"}),")"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Privacy"}),": \u26ab No Policy Available"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"screenshot",children:"Screenshot"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://ibb.co/pR6dMZT",children:(0,r.jsx)(n.img,{src:"https://pixelflare.cc/alicia/dashy/monitor-board",alt:"example-screenshot"})})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"current-cpu-usage",children:"Current CPU Usage"}),"\n",(0,r.jsx)(n.p,{children:"Live-updating current CPU usage, as a combined average across all cores"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/current-cpu"})}),"\n",(0,r.jsx)(n.h4,{id:"example-67",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-current-cpu\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"current-cpu-usage-speedometer",children:"Current CPU Usage Speedometer"}),"\n",(0,r.jsx)(n.p,{children:"Speedometer styled version of the Current CPU Usage widget"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/current-cpu-speedometer"})}),"\n",(0,r.jsx)(n.h4,{id:"example-68",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-cpu-speedometer\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cpu-usage-per-core",children:"CPU Usage Per Core"}),"\n",(0,r.jsx)(n.p,{children:"Live-updating CPU usage breakdown per core"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/cpu-per-core"})}),"\n",(0,r.jsx)(n.h4,{id:"example-69",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-current-cores\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cpu-usage-history",children:"CPU Usage History"}),"\n",(0,r.jsx)(n.p,{children:"Recent CPU usage history, across all cores, and displayed by user and system"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://pixelflare.cc/alicia/dashy/cpu-history-chart"})}),"\n",(0,r.jsx)(n.h4,{id:"options-71",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit the number of results returned, rendering more data points will take longer to load. Defaults to ",(0,r.jsx)(n.code,{children:"100"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-70",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-cpu-history\n options:\n hostname: http://192.168.130.2:61208\n limit: 60\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"current-memory-usage",children:"Current Memory Usage"}),"\n",(0,r.jsx)(n.p,{children:"Real-time memory usage gauge, with more info visible on click"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/current-mem"})}),"\n",(0,r.jsx)(n.h4,{id:"example-71",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-current-mem\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"current-memory-usage-speedometer",children:"Current Memory Usage Speedometer"}),"\n",(0,r.jsx)(n.p,{children:"Speedometer styled version of the Current Memory Usage widget"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/current-mem-speedometer"})}),"\n",(0,r.jsx)(n.h4,{id:"example-72",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-mem-speedometer\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"memory-usage-history",children:"Memory Usage History"}),"\n",(0,r.jsx)(n.p,{children:"Recent memory usage chart"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://pixelflare.cc/alicia/dashy/mem-history-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"options-72",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"limit"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Limit the number of results returned, rendering more data points will take longer to load. Defaults to ",(0,r.jsx)(n.code,{children:"100"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-73",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-mem-history\n options:\n hostname: http://localhost:61208\n limit: 80\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"disk-space",children:"Disk Space"}),"\n",(0,r.jsx)(n.p,{children:"List connected disks, showing free / used space and other info (file system, mount point and space available)"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/diskspace-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-74",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-disk-space\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"disk-io",children:"Disk IO"}),"\n",(0,r.jsx)(n.p,{children:"Shows real-time read and write speeds and operations per sec for each disk"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/disk-io-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-75",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-disk-io\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"system-load",children:"System Load"}),"\n",(0,r.jsx)(n.p,{children:"Shows the number of processes waiting in the run-queue, averaged across all cores. Displays for past 5, 10 and 15 minutes"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/system-load-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-76",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-system-load\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"uptime",children:"Uptime"}),"\n",(0,r.jsx)(n.p,{children:"Displays the system uptime fetched from Glances."}),"\n",(0,r.jsx)(n.h4,{id:"example-77",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-uptime\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"system-load-history",children:"System Load History"}),"\n",(0,r.jsxs)(n.p,{children:["Shows recent historical system load, calculated from the number of processes waiting in the run-queue, in 1, 5 and 15 minute intervals, and averaged across all cores. Optionally specify ",(0,r.jsx)(n.code,{children:"limit"})," to set number of results returned, defaults to ",(0,r.jsx)(n.code,{children:"500"}),", max ",(0,r.jsx)(n.code,{children:"100000"}),", but the higher the number the longer the load and render times will be."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"500",src:"https://pixelflare.cc/alicia/dashy/system-load-history-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-78",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-load-history\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"network-interfaces",children:"Network Interfaces"}),"\n",(0,r.jsx)(n.p,{children:"Lists visible network interfaces, including real-time upload/ download stats"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/network-interfaces-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-79",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-network-interfaces\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"network-traffic",children:"Network Traffic"}),"\n",(0,r.jsxs)(n.p,{children:["Shows amount of data recently uploaded/ downloaded across all network interfaces. Optionally set the ",(0,r.jsx)(n.code,{children:"limit"})," option to specify number historical of data points to return"]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/network-traffic-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-80",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-network-traffic\n options:\n hostname: http://192.168.130.2:61208\n limit: 500\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"resource-usage-alerts",children:"Resource Usage Alerts"}),"\n",(0,r.jsx)(n.p,{children:"Lists recent high resource usage alerts (e.g. CPU, mem, IO, load, temp)"}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://i.ibb.co/w01NX5R/gl-alerts.png"})}),"\n",(0,r.jsx)(n.h4,{id:"example-81",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-alerts\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ip-address",children:"IP Address"}),"\n",(0,r.jsx)(n.p,{children:"Shows public and private IP address. Note that the ip plugin is not available on all instances of Glances."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/ip-addresses-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"example-82",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-ip-address\n options:\n hostname: http://192.168.130.2:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cpu-temp",children:"CPU Temp"}),"\n",(0,r.jsx)(n.p,{children:"Displays temperature data from system CPUs."}),"\n",(0,r.jsxs)(n.p,{children:["Note: This widget uses the ",(0,r.jsx)(n.a,{href:"https://github.com/nicolargo/glances/blob/develop/glances/plugins/glances_sensors.py",children:(0,r.jsx)(n.code,{children:"sensors"})})," plugin, which is disabled by default, and may cause ",(0,r.jsx)(n.a,{href:"https://github.com/nicolargo/glances/issues/1664#issuecomment-632063558",children:"performance issues"}),".\nYou'll need to enable the sensors plugin to use this widget, using: ",(0,r.jsx)(n.code,{children:"--enable-plugin sensors"})," when you start Glances."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/cpu-temp-glances"})}),"\n",(0,r.jsx)(n.h4,{id:"options-73",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"units"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Use ",(0,r.jsx)(n.code,{children:"C"})," to display temperatures in Celsius or ",(0,r.jsx)(n.code,{children:"F"})," to use Fahrenheit. Defaults to ",(0,r.jsx)(n.code,{children:"C"}),"."]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"example-83",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-cpu-temp\n options:\n hostname: http://192.168.130.2:61208\n units: C\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"compact-metrics",children:"Compact Metrics"}),"\n",(0,r.jsx)(n.p,{children:"A multi-system overview widget that displays CPU, memory and disk usage for multiple Glances instances in a compact table. Click on a row to see detailed metrics for that system."}),"\n",(0,r.jsx)(n.h4,{id:"options-74",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"systems"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"array"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsxs)(n.td,{children:["An array of systems to monitor, each with ",(0,r.jsx)(n.code,{children:"header"})," (display name) and ",(0,r.jsx)(n.code,{children:"url"})," (Glances base URL)"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"apiVersion"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["Glances API version. Defaults to ",(0,r.jsx)(n.code,{children:"4"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"username"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If Glances is password-protected, specify the username"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"password"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"If Glances is password-protected, specify the password"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-84",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-compact-metrics\n options:\n systems:\n - header: Server 1\n url: http://192.168.1.10:61208\n - header: Server 2\n url: http://192.168.1.11:61208\n - header: NAS\n url: http://192.168.1.20:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"dynamic-widgets",children:"Dynamic Widgets"}),"\n",(0,r.jsx)(n.h3,{id:"iframe-widget",children:"Iframe Widget"}),"\n",(0,r.jsx)(n.p,{children:"Embed any webpage into your dashboard as a widget."}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/iframe"})}),"\n",(0,r.jsx)(n.h4,{id:"options-75",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"url"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:"Required"}),(0,r.jsx)(n.td,{children:"The URL to the webpage to embed"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"frameHeight"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"number"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsxs)(n.td,{children:["If needed, specify height of iframe in ",(0,r.jsx)(n.code,{children:"px"}),". E.g. ",(0,r.jsx)(n.code,{children:"400"}),", defaults to auto"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-85",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: iframe\n options:\n url: https://fiatleak.com/\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"html-embedded-widget",children:"HTML Embedded Widget"}),"\n",(0,r.jsx)(n.p,{children:"Many websites and apps provide their own embeddable widgets. These can be used with Dashy using the Embed widget, which lets you dynamically embed and HTML, CSS or JavaScript contents."}),"\n",(0,r.jsxs)(n.p,{children:["\u26a0\ufe0f ",(0,r.jsx)(n.strong,{children:"NOTE:"})," Use with extreme caution. Embedding a script from an untrustworthy source may have serious unintended consequences."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"400",src:"https://pixelflare.cc/alicia/dashy/html-embed"})}),"\n",(0,r.jsx)(n.h4,{id:"options-76",children:"Options"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Field"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Type"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Description"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"html"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"HTML contents to render in the widget"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"script"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Raw JavaScript code to execute (caution)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"scriptSrc"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"A URL to JavaScript content (caution)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"css"})})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.em,{children:"Optional"})}),(0,r.jsx)(n.td,{children:"Any stylings for widget contents"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"example-86",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'- type: embed\n options:\n scriptSrc: https://cdn.speedcheck.org/basic/scbjs.min.js\n html: |\n
\n
\n \n Speedcheck\n \n
\n
\n'})}),"\n",(0,r.jsx)(n.p,{children:"Or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'- type: embed\n options:\n css: \'.coinmarketcap-currency-widget { color: var(--widget-text-color); }\'\n html: \'
\'\n scriptSrc: \'https://files.coinmarketcap.com/static/widget/currency.js\'\n'})}),"\n",(0,r.jsx)(n.p,{children:"You can also use this widget to display an image, wither locally or from a remote origin."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: embed\n options:\n html: ''\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"api-response",children:"API Response"}),"\n",(0,r.jsx)(n.p,{children:"Directly output plain-text response from any API-enabled service."}),"\n",(0,r.jsx)(n.p,{children:"// Coming soon..."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"prometheus-data",children:"Prometheus Data"}),"\n",(0,r.jsx)(n.p,{children:"Display data from any service with a Prometheus exporter."}),"\n",(0,r.jsx)(n.p,{children:"// Coming soon..."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"data-feed",children:"Data Feed"}),"\n",(0,r.jsxs)(n.p,{children:["Show live data from an RSS-enabled service. The only required parameter is ",(0,r.jsx)(n.code,{children:"rssUrl"}),", which is the URL to the ATOM feed. See ",(0,r.jsx)(n.a,{href:"#rss-feed",children:"RSS Widget"})," for full list of available options."]}),"\n",(0,r.jsx)(n.p,{align:"center",children:(0,r.jsx)(n.img,{width:"700",src:"https://pixelflare.cc/alicia/dashy/data-feed"})}),"\n",(0,r.jsx)(n.h4,{id:"example-87",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: rss-feed\n options:\n rssUrl: https://notes.aliciasykes.com/feed\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"usage--customizations",children:"Usage & Customizations"}),"\n",(0,r.jsx)(n.h3,{id:"widget-usage-guide",children:"Widget Usage Guide"}),"\n",(0,r.jsx)(n.p,{children:"Like items, widgets are placed under sections. You may have one or more widgets per section."}),"\n",(0,r.jsx)(n.p,{children:"In your YAML config file, this will look something like:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"sections:\n- name: Today\n icon: far fa-calendar-day\n widgets:\n - type: clock\n options:\n format: en-GB\n - type: weather\n options:\n apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n city: London\n units: metric\n"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:'In this example, there is a single section, named "Today", using a Calendar icon from Font-Awesome. It has 2 widgets, a clock and the current weather.'}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"continuous-updates",children:"Continuous Updates"}),"\n",(0,r.jsxs)(n.p,{children:["By default, a widget which displays dynamic data from an external source, will only fetch results on page load. If you would like to keep data updated at all times, you can enable ",(0,r.jsx)(n.strong,{children:"Continuous Updates"}),". This is done by setting a time value in the ",(0,r.jsx)(n.code,{children:"updateInterval"})," field."]}),"\n",(0,r.jsxs)(n.p,{children:["The value of ",(0,r.jsx)(n.code,{children:"updateInterval"})," is optional, and is specified and seconds. It must be more than ",(0,r.jsx)(n.code,{children:"10"})," and less than ",(0,r.jsx)(n.code,{children:"7200"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"For example, the following widget displaying stats from Pi-Hole will update ever 20 seconds."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"widgets:\n- type: pi-hole-stats\n updateInterval: 20\n options:\n hostname: http://192.168.130.2\n"})}),"\n",(0,r.jsx)(n.p,{children:"Note that if you have many widgets, and set them to continuously update frequently, you will notice a hit to performance. A widget that relies on data from an external API, will also consume your usage quota faster, if set to keep updating."}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"proxying-requests",children:"Proxying Requests"}),"\n",(0,r.jsx)(n.p,{children:"If a widget fails to make a data request, and the console shows a CORS error, this means the server is blocking client-side requests."}),"\n",(0,r.jsxs)(n.p,{children:["Dashy has a built-in CORS proxy (",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/services/cors-proxy.js",children:(0,r.jsx)(n.code,{children:"services/cors-proxy.js"})}),"), which will be used automatically by some widgets, or can be forced to use by other by setting the ",(0,r.jsx)(n.code,{children:"useProxy"})," option."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"widgets:\n- type: pi-hole-stats\n useProxy: true\n options:\n hostname: http://pi-hole.local\n"})}),"\n",(0,r.jsx)(n.p,{children:"Alternatively, and more securely, you can set the auth headers on your service to accept requests from Dashy. For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: https://location-of-dashy/\nVary: Origin\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"handling-secrets",children:"Handling Secrets"}),"\n",(0,r.jsxs)(n.p,{children:["Some widgets require you to pass potentially sensetive info such as API keys. The ",(0,r.jsx)(n.code,{children:"conf.yml"})," is not ideal for this, as it's stored in plaintext.\nInstead, for secrets you should use environmental vairables."]}),"\n",(0,r.jsx)(n.p,{children:"You can do this, by setting the environmental variable name as the value, instead of the actual key, and then setting that env var in your container or local environment."}),"\n",(0,r.jsxs)(n.p,{children:["The key can be named whatever you like, but it must start with ",(0,r.jsx)(n.code,{children:"VUE_APP_"})," (to be picked up by Vue). If you need to update any of these values, a rebuild is required (this can be done under the Config menu in the UI, or by running ",(0,r.jsx)(n.code,{children:"yarn build"})," then restarting the container)."]}),"\n",(0,r.jsxs)(n.p,{children:["For more infomation about setting and managing your environmental variables, see ",(0,r.jsx)(n.a,{href:"/docs/management#passing-in-environmental-variables",children:"Management Docs --\x3e Environmental Variables"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: weather\n options:\n apiKey: VUE_APP_WEATHER_TOKEN\n city: London\n units: metric\n hideDetails: true\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Then, set ",(0,r.jsx)(n.code,{children:"VUE_APP_WEATHER_TOKEN='xxx'"})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"setting-timeout",children:"Setting Timeout"}),"\n",(0,r.jsxs)(n.p,{children:["If the endpoint you are requesting data from is slow to respond, you may see a timeout error in the console. This can easily be fixed by specifying the ",(0,r.jsx)(n.code,{children:"timeout"})," property on the offending widget. This should be an integer value, in milliseconds. By default timeout is ",(0,r.jsx)(n.code,{children:"2500"})," ms (2\xbd seconds)."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-current-cpu\n timeout: 8000\n options:\n hostname: https://glances.dns-device.local\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"adding-labels",children:"Adding Labels"}),"\n",(0,r.jsxs)(n.p,{children:["If you have multiple widgets of the same type in a single section, it may not be clear what each one is. To overcome this, you can add a custom label to any given widget, using the ",(0,r.jsx)(n.code,{children:"label"})," property."]}),"\n",(0,r.jsx)(n.p,{children:"For example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- name: CPU Usage\n icon: fas fa-tachometer\n widgets:\n - type: gl-current-cpu\n label: Meida Server\n options:\n hostname: http://media-server.lan:61208\n - type: gl-current-cpu\n label: Firewall\n options:\n hostname: http://firewall.lan:61208\n - type: gl-current-cpu\n label: File Sync Server\n options:\n hostname: http://file-sync.lan:61208\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ignoring-errors",children:"Ignoring Errors"}),"\n",(0,r.jsx)(n.p,{children:"When there's an error fetching or displaying a widgets data, then it will be highlighted in yellow, and a message displayed on the UI."}),"\n",(0,r.jsxs)(n.p,{children:["In some instances, this is a false positive, and the widget is actually functioning correctly. If this is the case, you can disable the UI error message of a given widget by setting: ",(0,r.jsx)(n.code,{children:"ignoreErrors: true"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-disk-io\n ignoreErrors: true\n options:\n hostname: https://glances.dns-device.local\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"widget-styling",children:"Widget Styling"}),"\n",(0,r.jsx)(n.p,{children:"Like elsewhere in Dashy, all colours can be easily modified with CSS variables."}),"\n",(0,r.jsx)(n.p,{children:"Widgets use the following color variables, which can be overridden if desired:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"--widget-text-color"})," - Text color, defaults to ",(0,r.jsx)(n.code,{children:"--primary"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"--widget-background-color"})," - Background color, defaults to ",(0,r.jsx)(n.code,{children:"--background-darker"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"--widget-accent-color"})," - Accent color, defaults to ",(0,r.jsx)(n.code,{children:"--background"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["For more info on how to apply custom variables, see the ",(0,r.jsx)(n.a,{href:"/docs/theming#setting-custom-css-in-the-ui",children:"Theming Docs"})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"customizing-charts",children:"Customizing Charts"}),"\n",(0,r.jsxs)(n.p,{children:["For widgets that contain charts, you can set an array of colors under ",(0,r.jsx)(n.code,{children:"chartColors"}),".\nTo specify the chart height, set ",(0,r.jsx)(n.code,{children:"chartHeight"})," to an integer (in ",(0,r.jsx)(n.code,{children:"px"}),"), defaults to ",(0,r.jsx)(n.code,{children:"300"}),".\nFor example:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"- type: gl-load-history\n options:\n hostname: http://192.168.130.2:61208\n chartColors: ['#9b5de5', '#f15bb5', '#00bbf9', '#00f5d4']\n chartHeight: 450\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"language-translations",children:"Language Translations"}),"\n",(0,r.jsx)(n.p,{children:"Since most of the content displayed within widgets is fetched from an external API, unless that API supports multiple languages, translating dynamic content is not possible."}),"\n",(0,r.jsx)(n.p,{children:"However, any hard-coded content is translatable, and all dates and times will display in your local format."}),"\n",(0,r.jsxs)(n.p,{children:["For more info about multi-language support, see the ",(0,r.jsx)(n.a,{href:"/docs/multi-language-support",children:"Internationalization Docs"}),"."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"widget-ui-options",children:"Widget UI Options"}),"\n",(0,r.jsx)(n.p,{children:"Widgets can be opened in full-page view, by clicking the Arrow icon (top-right). The URL in your address bar will also update, and visiting that web address directly will take you straight to that widget."}),"\n",(0,r.jsx)(n.p,{children:"You can reload the data of any widget, by clicking the Refresh Data icon (also in top-right). This will only affect the widget where the action was triggered from."}),"\n",(0,r.jsxs)(n.p,{children:["All ",(0,r.jsx)(n.a,{href:"/docs/configuring#section",children:"config options"})," that can be applied to sections, can also be applied to widget sections. For example, to make a widget section double the width, set ",(0,r.jsx)(n.code,{children:"displayData.cols: 2"})," within the parent section. You can collapse a widget (by clicking the section title), and collapse state will be saved locally."]}),"\n",(0,r.jsxs)(n.p,{children:["Widgets cannot currently be edited through the UI. This feature is in development, and will be released soon. In the meantime, you can either use the JSON config editor, or use ",(0,r.jsx)(n.a,{href:"https://github.com/coder/code-server",children:"VS Code Server"}),", or just SSH into your box and edit the conf.yml file directly."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"build-your-own-widget",children:"Build your own Widget"}),"\n",(0,r.jsx)(n.p,{children:"Widgets are built in a modular fashion, making it easy for anyone to create their own custom components."}),"\n",(0,r.jsxs)(n.p,{children:["For a full tutorial on creating your own widget, you can follow ",(0,r.jsx)(n.a,{href:"/docs/development-guides#building-a-widget",children:"this guide"}),", or take a look at ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/commit/3da76ce2999f57f76a97454c0276301e39957b8e",children:"here"})," for a code example."]}),"\n",(0,r.jsxs)(n.p,{children:["Alternatively, for displaying simple data, you could also just use the either the ",(0,r.jsx)(n.a,{href:"#iframe-widget",children:"iframe"}),", ",(0,r.jsx)(n.a,{href:"#html-embedded-widget",children:"embed"}),", ",(0,r.jsx)(n.a,{href:"#data-feed",children:"data feed"})," or ",(0,r.jsx)(n.a,{href:"#api-response",children:"API response"})," widgets."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"requesting-a-widget",children:"Requesting a Widget"}),"\n",(0,r.jsx)(n.p,{children:"Suggestions for widget ideas are welcome. But there is no guarantee that I will build your widget idea."}),"\n",(0,r.jsx)(n.p,{children:"Please only request widgets for services that:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Have a publicly accessible API"}),"\n",(0,r.jsx)(n.li,{children:"Are CORS and HTTPS enabled"}),"\n",(0,r.jsx)(n.li,{children:"Are free to use, or have a free plan"}),"\n",(0,r.jsx)(n.li,{children:"Allow for use in their Terms of Service"}),"\n",(0,r.jsx)(n.li,{children:"Would be useful for other users"}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["You can suggest a widget ",(0,r.jsx)(n.a,{href:"https://git.io/Jygo3",children:"here"}),", please star the repo before submitting a ticket. If you are a monthly GitHub sponsor, I will happily build out a custom widget for any service that meets the above criteria, usually within 2 weeks of initial request."]}),"\n",(0,r.jsxs)(n.p,{children:["For services that are not officially supported, it is likely still possible to display data using either the ",(0,r.jsx)(n.a,{href:"#iframe-widget",children:"iframe"}),", ",(0,r.jsx)(n.a,{href:"#html-embedded-widget",children:"embed"})," or ",(0,r.jsx)(n.a,{href:"#api-response",children:"API response"})," widgets. For more advanced features, like charts and action buttons, you could also build your own widget, using ",(0,r.jsx)(n.a,{href:"/docs/development-guides#building-a-widget",children:"this tutorial"}),", it's fairly straight forward, and you can use an ",(0,r.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/src/components/Widgets",children:"existing widget"})," (or ",(0,r.jsx)(n.a,{href:"https://git.io/JygKI",children:"this example"}),") as a template."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"troubleshooting-widget-errors",children:"Troubleshooting Widget Errors"}),"\n",(0,r.jsxs)(n.p,{children:["If an error occurs when fetching or rendering results, you will see a short message in the UI. If that message doesn't adequately explain the problem, then you can ",(0,r.jsx)(n.a,{href:"/docs/troubleshooting#how-to-open-browser-console",children:"open the browser console"})," to see more details."]}),"\n",(0,r.jsx)(n.p,{children:"Before proceeding, ensure that if the widget requires auth your API is correct, and for custom widgets, double check that the URL and protocol is correct."}),"\n",(0,r.jsx)(n.p,{children:"If you're able to, you can find more information about why the request may be failing in the Dev Tools under the Network tab, and you can ensure your endpoint is correct and working using a tool like Postman."}),"\n",(0,r.jsx)(n.h4,{id:"cors-errors",children:"CORS Errors"}),"\n",(0,r.jsxs)(n.p,{children:["The most common issue is a CORS error. This is a browser security mechanism which prevents the client-side app (Dashy) from from accessing resources on a remote origin, without that server's explicit permission (e.g. with headers like Access-Control-Allow-Origin). See the MDN Docs for more info: ",(0,r.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"Cross-Origin Resource Sharing"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"There are several ways to fix a CORS error:"}),"\n",(0,r.jsx)(n.h4,{id:"option-1---ensure-correct-protocol",children:"Option 1 - Ensure Correct Protocol"}),"\n",(0,r.jsx)(n.p,{children:"You will get a CORS error if you try and access a http service from a https source. So ensure that the URL you are requesting has the right protocol, and is correctly formatted."}),"\n",(0,r.jsx)(n.h4,{id:"option-2---set-headers",children:"Option 2 - Set Headers"}),"\n",(0,r.jsxs)(n.p,{children:["If you have control over the destination (e.g. for a self-hosted service), then you can simply apply the correct headers.\nAdd the ",(0,r.jsx)(n.code,{children:"Access-Control-Allow-Origin"})," header, with the value of either ",(0,r.jsx)(n.code,{children:"*"})," to allow requests from anywhere, or more securely, the host of where Dashy is served from. For example:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: https://url-of-dashy.local\n"})}),"\n",(0,r.jsx)(n.p,{children:"or"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: *\n"})}),"\n",(0,r.jsx)(n.h4,{id:"option-3---proxying-request",children:"Option 3 - Proxying Request"}),"\n",(0,r.jsxs)(n.p,{children:["You can route requests through Dashy's built-in CORS proxy. Instructions and more details can be found ",(0,r.jsx)(n.a,{href:"#proxying-requests",children:"here"}),". If you don't have control over the target origin, and you are running Dashy either through Docker, with the Node server or on Netlify, then this solution will work for you."]}),"\n",(0,r.jsxs)(n.p,{children:["Just add the ",(0,r.jsx)(n.code,{children:"useProxy: true"})," option to the failing widget."]}),"\n",(0,r.jsx)(n.h4,{id:"option-4---use-a-plugin",children:"Option 4 - Use a plugin"}),"\n",(0,r.jsxs)(n.p,{children:["For testing purposes, you can use an addon, which will disable the CORS checks. You can get the Allow-CORS extension for ",(0,r.jsx)(n.a,{href:"https://chrome.google.com/webstore/detail/allow-cors-access-control/lhobafahddgcelffkeicbaginigeejlf?hl=en-US",children:"Chrome"})," or ",(0,r.jsx)(n.a,{href:"https://addons.mozilla.org/en-US/firefox/addon/access-control-allow-origin/",children:"Firefox"}),", more details ",(0,r.jsx)(n.a,{href:"https://mybrowseraddon.com/access-control-allow-origin.html",children:"here"})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"raising-an-issue",children:"Raising an Issue"}),"\n",(0,r.jsxs)(n.p,{children:["If you need to submit a bug report for a failing widget, then please include the full console output (see ",(0,r.jsx)(n.a,{href:"/docs/troubleshooting#how-to-open-browser-console",children:"how"}),") as well as the relevant parts of your config file. Before sending the request, ensure you've read the docs. If you're new to GitHub, an haven't previously contributed to the project, then please fist star the repo to avoid your ticket being closed by the anti-spam bot."]})]})}function a(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453(e,n,s){s.d(n,{R:()=>l,x:()=>t});var i=s(6540);const r={},d=i.createContext(r);function l(e){const n=i.useContext(d);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9d9f8394.2c92b45d.js b/assets/js/9d9f8394.ffa35d26.js similarity index 99% rename from assets/js/9d9f8394.2c92b45d.js rename to assets/js/9d9f8394.ffa35d26.js index 36af5c0d..52f9ff2f 100644 --- a/assets/js/9d9f8394.2c92b45d.js +++ b/assets/js/9d9f8394.ffa35d26.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[9013],{7309(e,n,s){s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>c,frontMatter:()=>t,metadata:()=>i,toc:()=>h});const i=JSON.parse('{"id":"troubleshooting","title":"Troubleshooting","description":"**This document contains common problems and their solutions.**","source":"@site/docs/troubleshooting.md","sourceDirName":".","slug":"/troubleshooting","permalink":"/docs/troubleshooting","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/troubleshooting.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"App Management","permalink":"/docs/management"},"next":{"title":"Icons","permalink":"/docs/icons"}}');var o=s(4848),r=s(8453);const t={},a="Troubleshooting",l={},h=[{value:"Contents",id:"contents",level:2},{value:"Config not saving",id:"config-not-saving",level:2},{value:"Possible Issue 1: Unable to call save endpoint from CDN/static server",id:"possible-issue-1-unable-to-call-save-endpoint-from-cdnstatic-server",level:3},{value:"Possible Issue 2: Unable to save",id:"possible-issue-2-unable-to-save",level:3},{value:"Possible Issue 3: Saved but not updating",id:"possible-issue-3-saved-but-not-updating",level:3},{value:"Refused to Connect in Modal or Workspace View",id:"refused-to-connect-in-modal-or-workspace-view",level:2},{value:"NGINX",id:"nginx",level:3},{value:"Caddy",id:"caddy",level:3},{value:"Apache",id:"apache",level:3},{value:"LightHttpd",id:"lighthttpd",level:3},{value:"404 On Static Hosting",id:"404-on-static-hosting",level:2},{value:"404 after Launch from Mobile Home Screen",id:"404-after-launch-from-mobile-home-screen",level:2},{value:"404 On Multi-Page Apps",id:"404-on-multi-page-apps",level:2},{value:"Yarn Error",id:"yarn-error",level:2},{value:"Remote Config Not Loading",id:"remote-config-not-loading",level:2},{value:"Ineffective mark-compacts near heap limit Allocation failed",id:"ineffective-mark-compacts-near-heap-limit-allocation-failed",level:2},{value:"Command failed with signal "SIGKILL"",id:"command-failed-with-signal-sigkill",level:2},{value:"Auth Validation Error: "should be object"",id:"auth-validation-error-should-be-object",level:2},{value:"App Not Starting After Update to 2.0.4",id:"app-not-starting-after-update-to-204",level:2},{value:"Keycloak Redirect Error",id:"keycloak-redirect-error",level:2},{value:"Docker Directory",id:"docker-directory",level:2},{value:"Config not Saving on Vercel / Netlify / CDN",id:"config-not-saving-on-vercel--netlify--cdn",level:2},{value:"Config Not Updating",id:"config-not-updating",level:2},{value:"Config Still not Updating",id:"config-still-not-updating",level:2},{value:"Styles and Assets not Updating",id:"styles-and-assets-not-updating",level:2},{value:"DockerHub toomanyrequests",id:"dockerhub-toomanyrequests",level:2},{value:"Solution 1 - Use an alternate container registry",id:"solution-1---use-an-alternate-container-registry",level:3},{value:"Solution 2 - Increase your rate limits",id:"solution-2---increase-your-rate-limits",level:3},{value:"Config Validation Errors",id:"config-validation-errors",level:2},{value:"Node Sass does not yet support your current environment",id:"node-sass-does-not-yet-support-your-current-environment",level:2},{value:"Unreachable Code Error",id:"unreachable-code-error",level:2},{value:"Error: Cannot find module './_baseValues'",id:"error-cannot-find-module-_basevalues",level:2},{value:"Invalid Host Header while running through ngrok",id:"invalid-host-header-while-running-through-ngrok",level:2},{value:"Warnings in the Console during deploy",id:"warnings-in-the-console-during-deploy",level:2},{value:"Docker Login Fails on Ubuntu",id:"docker-login-fails-on-ubuntu",level:2},{value:"Status Checks Failing",id:"status-checks-failing",level:2},{value:"Widget Errors",id:"widget-errors",level:2},{value:"Find Error Message",id:"find-error-message",level:3},{value:"Check Config",id:"check-config",level:3},{value:"Timeout Error",id:"timeout-error",level:3},{value:"CORS error",id:"cors-error",level:3},{value:"More Info",id:"more-info",level:3},{value:"Widget CORS Errors",id:"widget-cors-errors",level:2},{value:"Option 1 - Ensure Correct Protocol",id:"option-1---ensure-correct-protocol",level:3},{value:"Option 2 - Set Headers",id:"option-2---set-headers",level:3},{value:"Option 3 - Proxying Request",id:"option-3---proxying-request",level:3},{value:"Option 4 - Use a plugin",id:"option-4---use-a-plugin",level:3},{value:"Widget Shows Error Incorrectly",id:"widget-shows-error-incorrectly",level:2},{value:"Weather Forecast Widget 401",id:"weather-forecast-widget-401",level:2},{value:"Widget Displaying Inaccurate Data",id:"widget-displaying-inaccurate-data",level:2},{value:"Font Awesome Icons not Displaying",id:"font-awesome-icons-not-displaying",level:2},{value:"Copy to Clipboard not Working",id:"copy-to-clipboard-not-working",level:2},{value:"Unsupported Digital Envelope Routines",id:"unsupported-digital-envelope-routines",level:2},{value:"How to Reset Local Settings",id:"how-to-reset-local-settings",level:2},{value:"How to make a bug report",id:"how-to-make-a-bug-report",level:2},{value:"Step 1 - Where to open issues",id:"step-1---where-to-open-issues",level:3},{value:"Step 2 - Checking it's not already covered",id:"step-2---checking-its-not-already-covered",level:3},{value:"Step 3 - Describe the Issue",id:"step-3---describe-the-issue",level:3},{value:"Step 4 - Provide Supporting Info",id:"step-4---provide-supporting-info",level:3},{value:"Step 5 - Fix Released",id:"step-5---fix-released",level:3},{value:"How-To Open Browser Console",id:"how-to-open-browser-console",level:2},{value:"Git Contributions not Displaying",id:"git-contributions-not-displaying",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",br:"br",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",kbd:"kbd",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"troubleshooting",children:"Troubleshooting"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.em,{children:(0,o.jsx)(n.strong,{children:"This document contains common problems and their solutions."})}),(0,o.jsx)(n.br,{}),"\nPlease ensure your issue isn't listed here, before opening a new ticket."]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.em,{children:"Found something not listed here? Consider adding it, to help other users."})}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"contents",children:"Contents"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#config-not-saving",children:"Config not saving"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#refused-to-connect-in-modal-or-workspace-view",children:"Refused to Connect in Web Content View"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#404-on-static-hosting",children:"404 On Static Hosting"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#404-after-launch-from-mobile-home-screen",children:"404 from Mobile Home Screen"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#yarn-error",children:"Yarn Build or Run Error"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#remote-config-not-loading",children:"Remote Config Not Loading"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#ineffective-mark-compacts-near-heap-limit-allocation-failed",children:"Heap limit Allocation failed"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#command-failed-with-signal-sigkill",children:'Command failed with signal "SIGKILL"'})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#auth-validation-error-should-be-object",children:'Auth Validation Error: "should be object"'})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#app-not-starting-after-update-to-204",children:"App Not Starting After Update to 2.0.4"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#keycloak-redirect-error",children:"Keycloak Redirect Error"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#docker-directory",children:"Docker Directory Error"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#config-not-saving-on-vercel--netlify--cdn",children:"Config not Saving on Vercel / Netlify / CDN"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#config-not-updating",children:"Config Not Updating"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#config-still-not-updating",children:"Config Still not Updating"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#styles-and-assets-not-updating",children:"Styles and Assets not Updating"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#dockerhub-toomanyrequests",children:"DockerHub toomanyrequests"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#config-validation-errors",children:"Config Validation Errors"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#node-sass-does-not-yet-support-your-current-environment",children:"Node Sass unsupported environment"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#unreachable-code-error",children:"Unreachable Code Error"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#error-cannot-find-module-_basevalues",children:"Cannot find module './_baseValues'"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#invalid-host-header-while-running-through-ngrok",children:"Ngrok Invalid Host Headers"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#warnings-in-the-console-during-deploy",children:"Warnings in the Console during deploy"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#docker-login-fails-on-ubuntu",children:"Docker Login Fails on Ubuntu"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#status-checks-failing",children:"Status Checks Failing"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#widget-errors",children:"Diagnosing Widget Errors"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#widget-cors-errors",children:"Fixing Widget CORS Errors"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#widget-shows-error-incorrectly",children:"Widget Shows Error Incorrectly"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#weather-forecast-widget-401",children:"Weather Forecast Widget 401"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#widget-displaying-inaccurate-data",children:"Widget Displaying Inaccurate Data"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#font-awesome-icons-not-displaying",children:"Font Awesome Icons not Displaying"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#copy-to-clipboard-not-working",children:"Copy to Clipboard not Working"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#unsupported-digital-envelope-routines",children:"Unsupported Digital Envelope Routines"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#how-to-reset-local-settings",children:"How to Reset Local Settings"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#how-to-make-a-bug-report",children:"How to make a bug report"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#how-to-open-browser-console",children:"How-To Open Browser Console"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#git-contributions-not-displaying",children:"Git Contributions not Displaying"})}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"config-not-saving",children:"Config not saving"}),"\n",(0,o.jsx)(n.h3,{id:"possible-issue-1-unable-to-call-save-endpoint-from-cdnstatic-server",children:"Possible Issue 1: Unable to call save endpoint from CDN/static server"}),"\n",(0,o.jsxs)(n.p,{children:["If you're running Dashy using a static hosting provider (like Vercel), then there is no Node server, and so the save config action will not work via the UI.\nYou'll instead need to copy the YAML after making your changes, and paste that into your ",(0,o.jsx)(n.code,{children:"conf.yml"})," directly. If you've connected Vercel to git, then these changes will take effect automatically, once you commit your changes.\nLook here for more information: ",(0,o.jsx)(n.a,{href:"https://dashy.to/docs/deployment#deploy-to-cloud-service",children:"https://dashy.to/docs/deployment#deploy-to-cloud-service"})]}),"\n",(0,o.jsx)(n.p,{children:"If you're running on Netlify, there are some cloud functions which take care of all the server endpoints (like status checking), so these will work as expected."}),"\n",(0,o.jsxs)(n.p,{children:["See also ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/1465",children:"#1465"})]}),"\n",(0,o.jsx)(n.h3,{id:"possible-issue-2-unable-to-save",children:"Possible Issue 2: Unable to save"}),"\n",(0,o.jsx)(n.p,{children:"In Docker, double check that the file isn't read-only, and that the container actually has permissions to modify it. You shouldn't really be running it as a root user, and I'm not sure if it will work if you do-"}),"\n",(0,o.jsx)(n.h3,{id:"possible-issue-3-saved-but-not-updating",children:"Possible Issue 3: Saved but not updating"}),"\n",(0,o.jsx)(n.p,{children:"After saving, the frontend will recompile, which may take a couple seconds (or a bit longer on a Pi or low-powered device). If it doesn't recompile, you can manually trigger a re-build."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsxs)(n.h2,{id:"refused-to-connect-in-modal-or-workspace-view",children:[(0,o.jsx)(n.code,{children:"Refused to Connect"})," in Modal or Workspace View"]}),"\n",(0,o.jsx)(n.p,{children:"This is not an issue with Dashy, but instead caused by the target app preventing direct access through embedded elements."}),"\n",(0,o.jsxs)(n.p,{children:["As defined in ",(0,o.jsx)(n.a,{href:"https://datatracker.ietf.org/doc/html/rfc7034",children:"RFC-7034"}),", for any web content to be accessed through an embedded element, it must have the ",(0,o.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options",children:(0,o.jsx)(n.code,{children:"X-Frame-Options"})})," HTTP header set to ",(0,o.jsx)(n.code,{children:"ALLOW"}),". If you are getting a ",(0,o.jsx)(n.code,{children:"Refused to Connect"})," error then this header is set to ",(0,o.jsx)(n.code,{children:"DENY"})," (or ",(0,o.jsx)(n.code,{children:"SAMEORIGIN"})," and it's on a different host). Thankfully, for self-hosted services, it is easy to set these headers."]}),"\n",(0,o.jsx)(n.p,{children:"These settings are usually set in the config file for the web server that's hosting the target application, here are some examples of how to enable cross-origin access with common web servers:"}),"\n",(0,o.jsx)(n.h3,{id:"nginx",children:"NGINX"}),"\n",(0,o.jsxs)(n.p,{children:["In NGINX, you can use the ",(0,o.jsx)(n.a,{href:"https://nginx.org/en/docs/http/ngx_http_headers_module.html",children:(0,o.jsx)(n.code,{children:"add_header"})})," module within the app block."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"server {\n ...\n add_header X-Frame-Options SAMEORIGIN always;\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Then reload with ",(0,o.jsx)(n.code,{children:"service nginx reload"})]}),"\n",(0,o.jsx)(n.h3,{id:"caddy",children:"Caddy"}),"\n",(0,o.jsxs)(n.p,{children:["In Caddy, you can use the ",(0,o.jsx)(n.a,{href:"https://caddyserver.com/docs/caddyfile/directives/header",children:(0,o.jsx)(n.code,{children:"header"})})," directive."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"header {\n X-Frame-Options SAMEORIGIN\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"apache",children:"Apache"}),"\n",(0,o.jsxs)(n.p,{children:["In Apache, you can use the ",(0,o.jsx)(n.a,{href:"https://httpd.apache.org/docs/current/mod/mod_headers.html",children:(0,o.jsx)(n.code,{children:"mod_headers"})})," module to set the ",(0,o.jsx)(n.code,{children:"X-Frame-Options"})," in your config file. This file is usually located somewhere like `/etc/apache2/httpd.conf"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:'Header set X-Frame-Options: "ALLOW-FROM http://[dashy-location]/"\n'})}),"\n",(0,o.jsx)(n.h3,{id:"lighthttpd",children:"LightHttpd"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Content-Security-Policy: frame-ancestors 'self' https://[dashy-location]/\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"404-on-static-hosting",children:"404 On Static Hosting"}),"\n",(0,o.jsx)(n.p,{children:"If you're seeing Dashy's 404 page on initial load/ refresh, and then the main app when you go back to Home, then this is likely caused by the Vue router, and if so can be fixed in one of two ways."}),"\n",(0,o.jsxs)(n.p,{children:["The first solution is to switch the routing mode, from HTML5 ",(0,o.jsx)(n.code,{children:"history"})," mode to ",(0,o.jsx)(n.code,{children:"hash"})," mode, by setting ",(0,o.jsx)(n.code,{children:"appConfig.routingMode"})," to ",(0,o.jsx)(n.code,{children:"hash"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["If this works, but you wish to continue using HTML5 history mode, then a bit of extra ",(0,o.jsx)(n.a,{href:"/docs/management#web-server-configuration",children:"server configuration"})," is required. This is explained in more detaail in the ",(0,o.jsx)(n.a,{href:"https://router.vuejs.org/guide/essentials/history-mode.html",children:"Vue Docs"}),". Once completed, you can then use ",(0,o.jsx)(n.code,{children:"routingMode: history"})," again, for neater URLs."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"404-after-launch-from-mobile-home-screen",children:"404 after Launch from Mobile Home Screen"}),"\n",(0,o.jsxs)(n.p,{children:['Similar to the above issue, if you get a 404 after using iOS and Android\'s "Add to Home Screen" feature, then this is caused by Vue router.\nIt can be fixed by setting ',(0,o.jsx)(n.code,{children:"appConfig.routingMode"})," to ",(0,o.jsx)(n.code,{children:"hash"})]}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/628",children:"#628"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/762",children:"#762"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"404-on-multi-page-apps",children:"404 On Multi-Page Apps"}),"\n",(0,o.jsxs)(n.p,{children:["Similar to above, if you get a 404 error when visiting a page directly on multi-page apps, then this can be fixed under ",(0,o.jsx)(n.code,{children:"appConfig"}),", by setting ",(0,o.jsx)(n.code,{children:"routingMode"})," to ",(0,o.jsx)(n.code,{children:"hash"}),". Then rebuilding, and refreshing the page."]}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/670",children:"#670"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/763",children:"#763"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"yarn-error",children:"Yarn Error"}),"\n",(0,o.jsxs)(n.p,{children:["For more info, see ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/1",children:"Issue #1"})]}),"\n",(0,o.jsxs)(n.p,{children:["First of all, check that you've got yarn installed correctly - see the ",(0,o.jsx)(n.a,{href:"https://classic.yarnpkg.com/en/docs/install",children:"yarn installation docs"})," for more info."]}),"\n",(0,o.jsxs)(n.p,{children:["If you're getting an error about scenarios, then you've likely installed the wrong yarn... (you're ",(0,o.jsx)(n.a,{href:"https://github.com/yarnpkg/yarn/issues/2821",children:"not"})," the only one!). You can fix it by uninstalling, adding the correct repo, and reinstalling, for example, in Debian:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:"sudo apt remove yarn"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:"curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:'echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list'})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:"sudo apt update && sudo apt install yarn"})}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Alternatively, as a workaround, you have several options:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Try using ",(0,o.jsx)(n.a,{href:"https://www.npmjs.com/get-npm",children:"NPM"})," instead: So clone, cd, then run ",(0,o.jsx)(n.code,{children:"npm install"}),", ",(0,o.jsx)(n.code,{children:"npm run build"})," and ",(0,o.jsx)(n.code,{children:"npm start"})]}),"\n",(0,o.jsxs)(n.li,{children:["Try using ",(0,o.jsx)(n.a,{href:"https://www.docker.com/get-started",children:"Docker"})," instead, and all of the system setup and dependencies will already be taken care of. So from within the directory, just run ",(0,o.jsx)(n.code,{children:"docker build -t lissy93/dashy ."})," to build, and then use docker start to run the project, e.g: ",(0,o.jsx)(n.code,{children:"docker run -it -p 8080:8080 lissy93/dashy"})," (see the ",(0,o.jsx)(n.a,{href:"/docs/deployment#deploy-with-docker",children:"deploying docs"})," for more info)"]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"remote-config-not-loading",children:"Remote Config Not Loading"}),"\n",(0,o.jsx)(n.p,{children:"If you've got a multi-page dashboard, and are hosting the additional config files yourself, then CORS rules will apply. A CORS error will look something like:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Access to XMLHttpRequest at 'https://example.com/raw/my-config.yml' from origin 'http://dashy.local' has been blocked by CORS policy:\nNo 'Access-Control-Allow-Origin' header is present on the requested resource.\n"})}),"\n",(0,o.jsx)(n.p,{children:"The solution is to add the appropriate headers onto the target server, to allow it to accept requests from the origin where you're running Dashy."}),"\n",(0,o.jsxs)(n.p,{children:["If it is a remote service, that you do not have admin access to, then another option is to proxy the request. Either host your own, or use a publicly accessible service, like ",(0,o.jsx)(n.a,{href:"https://allorigins.win",children:"allorigins.win"}),", e.g: ",(0,o.jsx)(n.code,{children:"https://api.allorigins.win/raw?url=https://pastebin.com/raw/4tZpaJV5"}),". For git-based services specifically, there's ",(0,o.jsx)(n.a,{href:"https://raw.githack.com/",children:"raw.githack.com"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"ineffective-mark-compacts-near-heap-limit-allocation-failed",children:"Ineffective mark-compacts near heap limit Allocation failed"}),"\n",(0,o.jsx)(n.p,{children:"If you see an error message, similar to:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"<--- Last few GCs ---\x3e\n\n[61:0x74533040] 229060 ms: Mark-sweep (reduce) 127.1 (236.9) -> 127.1 (137.4) MB, 5560.7 / 0.3 ms (average mu = 0.286, current mu = 0.011) allocation failure scavenge might not succeed\n\n<--- JS stacktrace ---\x3e\n\nFATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This is likely caused by insufficient memory allocation to the container. When the container first starts up, or has to rebuild, the memory usage spikes, and if there isn't enough memory, it may terminate. This can be specified with, for example: ",(0,o.jsx)(n.code,{children:"--memory=1024m"}),". For more info, see ",(0,o.jsx)(n.a,{href:"https://docs.docker.com/config/containers/resource_constraints/",children:"Docker: Runtime options with Memory, CPUs, and GPUs"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/380",children:"#380"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/350",children:"#350"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/297",children:"#297"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/349",children:"#349"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/510",children:"#510"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/511",children:"#511"})," and ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/834",children:"#834"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"command-failed-with-signal-sigkill",children:'Command failed with signal "SIGKILL"'}),"\n",(0,o.jsxs)(n.p,{children:["In Docker, this can be caused by not enough memory. When the container first starts up, or has to rebuild, the memory usage spikes, and so a larger allocation may be required. This can be specified with, for example: ",(0,o.jsx)(n.code,{children:"--memory=1024m"}),". For more info, see ",(0,o.jsx)(n.a,{href:"https://docs.docker.com/config/containers/resource_constraints/",children:"Docker: Runtime options with Memory, CPUs, and GPUs"})]}),"\n",(0,o.jsxs)(n.p,{children:["See also ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/624",children:"#624"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"auth-validation-error-should-be-object",children:'Auth Validation Error: "should be object"'}),"\n",(0,o.jsxs)(n.p,{children:["In V 1.6.5 an update was made that in the future will become a breaking change. You will need to update you config to reflect this before V 2.0.0 is released. In the meantime, your previous config will continue to function normally, but you will see a validation warning. The change means that the structure of the ",(0,o.jsx)(n.code,{children:"appConfig.auth"})," object is now an object, which has a ",(0,o.jsx)(n.code,{children:"users"})," property."]}),"\n",(0,o.jsxs)(n.p,{children:["For more info, see ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/discussions/177",children:"this announcement"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"You can fix this by replacing:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"auth:\n- user: xxx\n hash: xxx\n"})}),"\n",(0,o.jsx)(n.p,{children:"with"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"auth:\n users:\n - user: xxx\n hash: xxx\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"app-not-starting-after-update-to-204",children:"App Not Starting After Update to 2.0.4"}),"\n",(0,o.jsxs)(n.p,{children:["Version 2.0.4 introduced changes to how the config is read, and the app is build. If you were previously mounting ",(0,o.jsx)(n.code,{children:"/public"})," as a volume, then this will over-write the build app, preventing it from starting. The solution is to just pass in the file(s) / sub-directories that you need. For example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"volumes:\n- /srv/dashy/conf.yml:/app/user-data/conf.yml\n- /srv/dashy/item-icons:/app/public/item-icons\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"keycloak-redirect-error",children:"Keycloak Redirect Error"}),"\n",(0,o.jsxs)(n.p,{children:["Check the ",(0,o.jsx)(n.a,{href:"#how-to-open-browser-console",children:"browser's console output"}),", if you've not set any headers, you will likely see a CORS error here, which would be the source of the issue."]}),"\n",(0,o.jsxs)(n.p,{children:["You need to allow Dashy to make requests to Keycloak, and Keycloak to redirect to Dashy. The way you do this depends on how you're hosting these applications / which proxy you are using, and examples can be found in the ",(0,o.jsx)(n.a,{href:"/docs/management#setting-headers",children:"Management Docs"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"For example, add the access control header to Keycloak, like:"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"Access-Control-Allow-Origin [URL-of Dashy]"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that for requests that transport sensitive info like credentials, setting the accept header to a wildcard (",(0,o.jsx)(n.code,{children:"*"}),") is not allowed - see ",(0,o.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#requests_with_credentials",children:"MDN Docs"}),", so you will need to specify the actual URL."]}),"\n",(0,o.jsxs)(n.p,{children:["You should also ensure that Keycloak is correctly configured, with a user, realm and application, and be sure that you have set a valid redirect URL in Keycloak (",(0,o.jsx)(n.a,{href:"https://user-images.githubusercontent.com/1862727/148599768-db4ee4f8-72c5-402d-8f00-051d999e6267.png",children:"screenshot"}),")."]}),"\n",(0,o.jsxs)(n.p,{children:["For more details on how to set headers, see the ",(0,o.jsx)(n.a,{href:"/docs/management#setting-headers",children:"Example Headers"})," in the management docs, or reference the documentation for your proxy."]}),"\n",(0,o.jsxs)(n.p,{children:["If you're running in Kubernetes, you will need to enable CORS ingress rules, see ",(0,o.jsx)(n.a,{href:"https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#enable-cors",children:"docs"}),", e.g:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:'nginx.ingress.kubernetes.io/cors-allow-origin: "https://dashy.example.com"\nnginx.ingress.kubernetes.io/enable-cors: "true"\n'})}),"\n",(0,o.jsx)(n.p,{children:"See also: #479, #409, #507, #491, #341, #520"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"docker-directory",children:"Docker Directory"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:'Error response from daemon: OCI runtime create failed: container_linux.go:380:\nstarting container process caused: process_linux.go:545: container init caused:\nrootfs_linux.go:76: mounting "/home/ubuntu/my-conf.yml" to rootfs at\n"/app/user-data/conf.yml" caused: mount through procfd: not a directory:\nunknown: Are you trying to mount a directory onto a file (or vice-versa)?\nCheck if the specified host path exists and is the expected type.\n'})}),"\n",(0,o.jsxs)(n.p,{children:["If you get an error similar to the one above, you are mounting a directory to the config file's location, when a plain file is expected. Create a YAML file, (",(0,o.jsx)(n.code,{children:"touch my-conf.yml"}),"), populate it with a sample config, then pass it as a volume: ",(0,o.jsx)(n.code,{children:"-v ./my-local-conf.yml:/app/user-data/conf.yml"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"config-not-saving-on-vercel--netlify--cdn",children:"Config not Saving on Vercel / Netlify / CDN"}),"\n",(0,o.jsxs)(n.p,{children:["If you're running Dashy using a static hosting provider (like Vercel), then there is no Node server, and so the save config action will not work via the UI.\nYou'll instead need to copy the YAML after making your changes, and paste that into your ",(0,o.jsx)(n.code,{children:"conf.yml"})," directly. If you've connected Vercel to git, then these changes will take effect automatically, once you commit your changes."]}),"\n",(0,o.jsx)(n.p,{children:"If you're running on Netlify, there are some cloud functions which take care of all the server endpoints (like status checking), so these will work as expected."}),"\n",(0,o.jsxs)(n.p,{children:["See also ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/1465",children:"#1465"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"config-not-updating",children:"Config Not Updating"}),"\n",(0,o.jsx)(n.p,{children:'Dashy has the option to save settings and config locally, in browser storage. Anything here will take precedence over whatever is in your config file, sometimes with unintended consequences. If you\'ve updated the config file manually, and are not seeing changes reflected in the UI, then try visiting the site in Incognito mode. If that works, then the solution is just to clear local storage. This can be done from the config menu, under "Clear Local Settings".'}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"config-still-not-updating",children:"Config Still not Updating"}),"\n",(0,o.jsxs)(n.p,{children:["Sometimes your text editor updates files ",(0,o.jsx)(n.a,{href:"https://linuxhandbook.com/inode-linux/",children:"inode"}),", meaning changes will not be picked up by the Docker container. This ",(0,o.jsx)(n.a,{href:"https://medium.com/@jonsbun/why-need-to-be-careful-when-mounting-single-files-into-a-docker-container-4f929340834",children:"article"})," explains things further."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"styles-and-assets-not-updating",children:"Styles and Assets not Updating"}),"\n",(0,o.jsxs)(n.p,{children:["If you find that your styles and other visual assets work when visiting ",(0,o.jsx)(n.code,{children:"ip:port"})," by not ",(0,o.jsx)(n.code,{children:"dashy.domain.com"}),", then this is usually caused by caching. In your browser, do a hard-refresh (",(0,o.jsx)(n.kbd,{children:"Ctrl"})," + ",(0,o.jsx)(n.kbd,{children:"F5"}),"). If you use Cloudflare, then you can clear the cache through the management console, or set the cache level to Bypass for certain files, under the Rules tab."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsxs)(n.h2,{id:"dockerhub-toomanyrequests",children:["DockerHub ",(0,o.jsx)(n.code,{children:"toomanyrequests"})]}),"\n",(0,o.jsx)(n.p,{children:"This situation relates to error messages similar to one of the following, returned when pulling, updating or running the Docker container from Docker Hub."}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Continuing execution. Pulling image lissy93/dashy:release-1.6.0\nerror pulling image configuration: toomanyrequests\n"})}),"\n",(0,o.jsx)(n.p,{children:"or"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit\n"})}),"\n",(0,o.jsxs)(n.p,{children:["When DockerHub returns one of these errors, or a ",(0,o.jsx)(n.code,{children:"429"})," status, that means you've hit your rate limit. This was ",(0,o.jsx)(n.a,{href:"https://www.docker.com/blog/scaling-docker-to-serve-millions-more-developers-network-egress/",children:"introduced"})," last year, and prevents unauthenticated or free users from running docker pull more than 100 times per 6 hours.\nYou can ",(0,o.jsx)(n.a,{href:"https://www.docker.com/blog/checking-your-current-docker-pull-rate-limits-and-status/",children:"check your rate limit status"})," by looking for the ",(0,o.jsx)(n.code,{children:"ratelimit-remaining"})," header in any DockerHub responses."]}),"\n",(0,o.jsx)(n.h3,{id:"solution-1---use-an-alternate-container-registry",children:"Solution 1 - Use an alternate container registry"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Dashy is also available through GHCR, which at present does not have any hard limits. Just use ",(0,o.jsx)(n.code,{children:"docker pull ghcr.io/lissy93/dashy:latest"})," to fetch the image"]}),"\n",(0,o.jsxs)(n.li,{children:["You can also build the image from source, by cloning the repo, and running ",(0,o.jsx)(n.code,{children:"docker build -t dashy ."})," or use the pre-made docker compose"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"solution-2---increase-your-rate-limits",children:"Solution 2 - Increase your rate limits"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Logging in to DockerHub will increase your rate limit from 100 requests to 200 requests per 6 hour period"}),"\n",(0,o.jsx)(n.li,{children:"Upgrading to a Pro for $5/month will increase your image requests to 5,000 per day, and any plans above have no rate limits"}),"\n",(0,o.jsx)(n.li,{children:"Since rate limits are counted based on your IP address, proxying your requests, or using a VPN may work"}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"config-validation-errors",children:"Config Validation Errors"}),"\n",(0,o.jsxs)(n.p,{children:["The configuration file is validated against ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json",children:"Dashy's Schema"})," using AJV."]}),"\n",(0,o.jsxs)(n.p,{children:["First, check that your syntax is valid, using ",(0,o.jsx)(n.a,{href:"https://codebeautify.org/yaml-validator/",children:"YAML Validator"})," or ",(0,o.jsx)(n.a,{href:"https://codebeautify.org/jsonvalidator",children:"JSON Validator"}),". If the issue persists, then take a look at the ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json",children:"schema"}),", and verify that the field you are trying to add/ modify matches the required format. You can also use ",(0,o.jsx)(n.a,{href:"https://www.jsonschemavalidator.net/s/JFUj7X9J",children:"this tool"})," to validate your JSON config against the schema, or run ",(0,o.jsx)(n.code,{children:"yarn validate-config"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"If you're trying to use a recently released feature, and are getting a warning, this is likely because you've not yet updated the the current latest version of Dashy."}),"\n",(0,o.jsx)(n.p,{children:"If the issue still persists, you should raise an issue."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"node-sass-does-not-yet-support-your-current-environment",children:"Node Sass does not yet support your current environment"}),"\n",(0,o.jsxs)(n.p,{children:["Caused by node-sass's binaries being built for a for a different architecture\nTo fix this, just run: ",(0,o.jsx)(n.code,{children:"yarn rebuild node-sass"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"unreachable-code-error",children:"Unreachable Code Error"}),"\n",(0,o.jsxs)(n.p,{children:["An error similar to: ",(0,o.jsx)(n.code,{children:"Fatal error in , line 0. Unreachable code, FailureMessage Object: 0xffe6c8ac. Illegal instruction (core dumped)"}),"\nIs related to a bug in a downstream package, see ",(0,o.jsx)(n.a,{href:"https://github.com/nodejs/docker-node/issues/1477",children:"nodejs/docker-node#1477"}),".\nUsually, updating your system and packages will resolve the issue."]}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/776",children:"#776"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"error-cannot-find-module-_basevalues",children:"Error: Cannot find module './_baseValues'"}),"\n",(0,o.jsxs)(n.p,{children:["Clearing the cache should fix this: ",(0,o.jsx)(n.code,{children:"yarn cache clean"}),"\nIf the issue persists, remove (",(0,o.jsx)(n.code,{children:"rm -rf node_modules\\ yarn.lock"}),") and reinstall (",(0,o.jsx)(n.code,{children:"yarn"}),") node_modules"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"invalid-host-header-while-running-through-ngrok",children:"Invalid Host Header while running through ngrok"}),"\n",(0,o.jsxs)(n.p,{children:["Just add the ",(0,o.jsx)(n.a,{href:"https://ngrok.com/docs#http-host-header",children:"-host-header"})," flag, e.g. ",(0,o.jsx)(n.code,{children:'ngrok http 8080 -host-header="localhost:8080"'})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"warnings-in-the-console-during-deploy",children:"Warnings in the Console during deploy"}),"\n",(0,o.jsx)(n.p,{children:"Please acknowledge the difference between errors and warnings before raising an issue about messages in the console. It's not unusual to see warnings about a new version of a certain package being available, an asset bundle bing oversized or a service worker not yet having a cache. These shouldn't have any impact on the running application, so please don't raise issues about these unless it directly relates to a bug or issue you're experiencing. Errors on the other hand should not appear in the console, and they are worth looking into further."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"docker-login-fails-on-ubuntu",children:"Docker Login Fails on Ubuntu"}),"\n",(0,o.jsxs)(n.p,{children:["Run ",(0,o.jsx)(n.code,{children:"sudo apt install gnupg2 pass && gpg2 -k"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"status-checks-failing",children:"Status Checks Failing"}),"\n",(0,o.jsx)(n.p,{children:"If you're using status checks, and despite a given service being online, the check is displaying an error, there are a couple of things you can look at:"}),"\n",(0,o.jsxs)(n.p,{children:["If your service requires requests to include any authorization in the headers, then use the ",(0,o.jsx)(n.code,{children:"statusCheckHeaders"})," property, as described in the ",(0,o.jsx)(n.a,{href:"/docs/status-indicators#setting-custom-headers",children:"docs"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["If you are still having issues, it may be because your target application is blocking requests from Dashy's IP. This is a ",(0,o.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"CORS error"}),", and can be fixed by setting the headers on your target app, to include:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: https://location-of-dashy/\nVary: Origin\n"})}),"\n",(0,o.jsxs)(n.p,{children:["If the URL you are checking has an unsigned certificate, or is not using HTTPS, then you may need to disable the rejection of insecure requests. This can be done by setting ",(0,o.jsx)(n.code,{children:"statusCheckAllowInsecure"})," to true for a given item."]}),"\n",(0,o.jsxs)(n.p,{children:["If your service is online, but responds with a status code that is not in the 2xx range, then you can use ",(0,o.jsx)(n.code,{children:"statusCheckAcceptCodes"})," to set an accepted status code."]}),"\n",(0,o.jsxs)(n.p,{children:["If you get an error, like ",(0,o.jsx)(n.code,{children:"Service Unavailable: Server resulted in a fatal error"}),", even when it's definitely online, this is most likely caused by missing the protocol. Don't forget to include ",(0,o.jsx)(n.code,{children:"https://"})," (or whatever protocol) before the URL, and ensure that if needed, you've specified the port."]}),"\n",(0,o.jsxs)(n.p,{children:["Running Dashy in HOST network mode, instead of BRIDGE will allow status check access to other services in HOST mode. For more info, see ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/discussions/445",children:"#445"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"If you have firewall rules configured, then ensure that they don't prevent Dashy from making requests to the other services you are trying to access."}),"\n",(0,o.jsxs)(n.p,{children:["Currently, the status check needs a page to be rendered, so if this URL in your browser does not return anything, then status checks will not work. This may be modified in the future, but in the meantime, a fix would be to make your own status service, which just checks if your app responds with whatever code you'd like, and then return a 200 plus renders an arbitrary message. Then just point ",(0,o.jsx)(n.code,{children:"statusCheckUrl"})," to your custom page."]}),"\n",(0,o.jsxs)(n.p,{children:["For further troubleshooting, use an application like ",(0,o.jsx)(n.a,{href:"https://postman.com",children:"Postman"})," to diagnose the issue. Set the parameter to ",(0,o.jsx)(n.code,{children:"GET"}),", and then make a call to: ",(0,o.jsx)(n.code,{children:"https://[url-of-dashy]/status-check/?&url=[service-url]"}),". Where the service URL must have first been encoded (e.g. with ",(0,o.jsx)(n.code,{children:"encodeURIComponent()"})," or ",(0,o.jsx)(n.a,{href:"https://www.urlencoder.io/",children:"urlencoder.io"}),")"]}),"\n",(0,o.jsx)(n.p,{children:"If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"widget-errors",children:"Widget Errors"}),"\n",(0,o.jsx)(n.h3,{id:"find-error-message",children:"Find Error Message"}),"\n",(0,o.jsxs)(n.p,{children:["If an error occurs when fetching or rendering results, you will see a short message in the UI. If that message doesn't adequately explain the problem, then you can ",(0,o.jsx)(n.a,{href:"/docs/troubleshooting#how-to-open-browser-console",children:"open the browser console"})," to see more details."]}),"\n",(0,o.jsx)(n.h3,{id:"check-config",children:"Check Config"}),"\n",(0,o.jsx)(n.p,{children:"Before proceeding, ensure that if the widget requires auth your API is correct, and for custom widgets, double check that the URL and protocol is correct."}),"\n",(0,o.jsx)(n.h3,{id:"timeout-error",children:"Timeout Error"}),"\n",(0,o.jsxs)(n.p,{children:["If the error message in the console includes: ",(0,o.jsx)(n.code,{children:"Error: timeout of 500ms exceeded"}),", then your Glances endpoint is slower to respond than expected. You can fix this by ",(0,o.jsx)(n.a,{href:"/docs/widgets#setting-timeout",children:"setting timeout"})," to a larger value. This is done on each widget, with the ",(0,o.jsx)(n.code,{children:"timeout"})," attribute, and is specified in ms. E.g. ",(0,o.jsx)(n.code,{children:"timeout: 5000"})," would only fail if no response is returned within 5 seconds."]}),"\n",(0,o.jsx)(n.h3,{id:"cors-error",children:"CORS error"}),"\n",(0,o.jsxs)(n.p,{children:["If the console message mentions to corss-origin blocking, then this is a CORS error, see: ",(0,o.jsx)(n.a,{href:"#widget-cors-errors",children:"Fixing Widget CORS Errors"})]}),"\n",(0,o.jsx)(n.h3,{id:"more-info",children:"More Info"}),"\n",(0,o.jsx)(n.p,{children:"If you're able to, you can find more information about why the request may be failing in the Dev Tools under the Network tab, and you can ensure your endpoint is correct and working using a tool like Postman."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"widget-cors-errors",children:"Widget CORS Errors"}),"\n",(0,o.jsxs)(n.p,{children:["The most common widget issue is a CORS error. This is a browser security mechanism which prevents the client-side app (Dashy) from from accessing resources on a remote origin, without that server's explicit permission (e.g. with headers like Access-Control-Allow-Origin). See the MDN Docs for more info: ",(0,o.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"Cross-Origin Resource Sharing"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"There are several ways to fix a CORS error:"}),"\n",(0,o.jsx)(n.h3,{id:"option-1---ensure-correct-protocol",children:"Option 1 - Ensure Correct Protocol"}),"\n",(0,o.jsx)(n.p,{children:"You will get a CORS error if you try and access a http service from a https source. So ensure that the URL you are requesting has the right protocol, and is correctly formatted."}),"\n",(0,o.jsx)(n.h3,{id:"option-2---set-headers",children:"Option 2 - Set Headers"}),"\n",(0,o.jsxs)(n.p,{children:["If you have control over the destination (e.g. for a self-hosted service), then you can simply apply the correct headers.\nAdd the ",(0,o.jsx)(n.code,{children:"Access-Control-Allow-Origin"})," header, with the value of either ",(0,o.jsx)(n.code,{children:"*"})," to allow requests from anywhere, or more securely, the host of where Dashy is served from. For example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: https://url-of-dashy.local\n"})}),"\n",(0,o.jsx)(n.p,{children:"or"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: *\n"})}),"\n",(0,o.jsxs)(n.p,{children:["For more info on how to set headers, see: ",(0,o.jsx)(n.a,{href:"/docs/management#setting-headers",children:"Setting Headers"})," in the management docs"]}),"\n",(0,o.jsx)(n.h3,{id:"option-3---proxying-request",children:"Option 3 - Proxying Request"}),"\n",(0,o.jsxs)(n.p,{children:["You can route requests through Dashy's built-in CORS proxy. Instructions and more details can be found ",(0,o.jsx)(n.a,{href:"/docs/widgets#proxying-requests",children:"here"}),". If you don't have control over the target origin, and you are running Dashy either through Docker, with the Node server or on Netlify, then this solution will work for you."]}),"\n",(0,o.jsxs)(n.p,{children:["Just add the ",(0,o.jsx)(n.code,{children:"useProxy: true"})," option to the failing widget."]}),"\n",(0,o.jsx)(n.h3,{id:"option-4---use-a-plugin",children:"Option 4 - Use a plugin"}),"\n",(0,o.jsxs)(n.p,{children:["For testing purposes, you can use an addon, which will disable the CORS checks. You can get the Allow-CORS extension for ",(0,o.jsx)(n.a,{href:"https://chrome.google.com/webstore/detail/allow-cors-access-control/lhobafahddgcelffkeicbaginigeejlf?hl=en-US",children:"Chrome"})," or ",(0,o.jsx)(n.a,{href:"https://addons.mozilla.org/en-US/firefox/addon/access-control-allow-origin/",children:"Firefox"}),", more details ",(0,o.jsx)(n.a,{href:"https://mybrowseraddon.com/access-control-allow-origin.html",children:"here"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"widget-shows-error-incorrectly",children:"Widget Shows Error Incorrectly"}),"\n",(0,o.jsx)(n.p,{children:"When there's an error fetching or displaying a widgets data, then it will be highlighted in yellow, and a message displayed on the UI."}),"\n",(0,o.jsxs)(n.p,{children:["In some instances, this is a false positive, and the widget is actually functioning correctly.\nIf this is the case, you can disable the UI error message of a given widget by setting: ",(0,o.jsx)(n.code,{children:"ignoreErrors: true"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"weather-forecast-widget-401",children:"Weather Forecast Widget 401"}),"\n",(0,o.jsx)(n.p,{children:"A 401 error means your API key is invalid, it is not an issue with Dashy."}),"\n",(0,o.jsxs)(n.p,{children:["Usually this happens due to an error in your config. If you're unsure, copy and paste the ",(0,o.jsx)(n.a,{href:"/docs/widgets#weather",children:"example"})," config, replacing the API key with your own."]}),"\n",(0,o.jsxs)(n.p,{children:["Check that ",(0,o.jsx)(n.code,{children:"apiKey"})," is correctly specified, and nested within ",(0,o.jsx)(n.code,{children:"options"}),". Ensure your input city is valid."]}),"\n",(0,o.jsxs)(n.p,{children:["To test your API key, try making a request to ",(0,o.jsx)(n.code,{children:"https://api.openweathermap.org/data/2.5/weather?q=London&appid=[your-api-key]"})]}),"\n",(0,o.jsxs)(n.p,{children:["If ",(0,o.jsx)(n.a,{href:"/docs/widgets#weather-forecast",children:"Weather widget"})," is working fine, but you are getting a ",(0,o.jsx)(n.code,{children:"401"})," for the ",(0,o.jsx)(n.a,{href:"/docs/widgets#weather-forecast",children:"Weather Forecast widget"}),", then this is also an OWM API key issue.\nSince the forecasting API requires an upgraded plan. ULPT: You can get a free, premium API key by filling in ",(0,o.jsx)(n.a,{href:"https://home.openweathermap.org/students",children:"this form"}),". It's a student plan, but there's no verification to check that you are still a student."]}),"\n",(0,o.jsx)(n.p,{children:"A future update will be pushed out, to use a free weather forecasting API."}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/803",children:"#803"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/789",children:"#789"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/577",children:"#577"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/621",children:"#621"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/578",children:"#578"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/discussions/806",children:"#806"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"widget-displaying-inaccurate-data",children:"Widget Displaying Inaccurate Data"}),"\n",(0,o.jsx)(n.p,{children:"If any widget is not displaying the data you expect, first confirm that your config is correct, then try manually calling the API endpoint."}),"\n",(0,o.jsxs)(n.p,{children:["If the raw API output is correct, yet the widget is rendering incorrect results, then it is likely a bug, and a ticket should be raised. You can start to debug the issue, by looking at the widget's code (",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/src/components/Widgets",children:"here"}),"), and the browser console + networking tab."]}),"\n",(0,o.jsxs)(n.p,{children:["If the API itself is returning incorrect, incomplete or inaccurate data then an issue needs to be raised ",(0,o.jsx)(n.strong,{children:"with the API provider"})," (not Dashy!). You can find the API provider included within the widget docs, or for a full list see the ",(0,o.jsx)(n.a,{href:"/docs/privacy#widgets",children:"Privacy Docs"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/807",children:"#807"})," (re, domain monitor)"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"font-awesome-icons-not-displaying",children:"Font Awesome Icons not Displaying"}),"\n",(0,o.jsxs)(n.p,{children:["Usually, Font Awesome will be automatically enabled if one or more of your icons are using Font-Awesome. If this is not happening, then you can always manually enable (or disable) Font Awesome by setting: ",(0,o.jsx)(n.a,{href:"/docs/configuring#appconfig-optional",children:(0,o.jsx)(n.code,{children:"appConfig"})}),".",(0,o.jsx)(n.code,{children:"enableFontAwesome"})," to ",(0,o.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["If you are trying to use a premium icon, then you must have a ",(0,o.jsx)(n.a,{href:"https://fontawesome.com/plans",children:"Pro License"}),". You'll then need to specify your Pro plan API key under ",(0,o.jsx)(n.code,{children:"appConfig.fontAwesomeKey"}),". You can find this key, by logging into your FA account, navigate to Account \u2192 ",(0,o.jsx)(n.a,{href:"https://fontawesome.com/kits",children:"Kits"})," \u2192 New Kit \u2192 Copy Kit Code. The code is a 10-digit alpha-numeric code, and is also visible within the new kit's URL, for example: ",(0,o.jsx)(n.code,{children:"81e48ce079"}),"."]}),"\n",(0,o.jsx)(n.p,{align:"center",children:(0,o.jsx)(n.img,{src:"https://i.ibb.co/hZ0D9vs/where-do-i-find-my-font-awesome-key.png",width:"600"})}),"\n",(0,o.jsxs)(n.p,{children:["Be sure that you're specifying the icon category and name correctly. You're icon should look be ",(0,o.jsx)(n.code,{children:"[category] fa-[icon-name]"}),". The following categories are supported: ",(0,o.jsx)(n.code,{children:"far"})," ",(0,o.jsx)(n.em,{children:"(regular)"}),", ",(0,o.jsx)(n.code,{children:"fas"})," ",(0,o.jsx)(n.em,{children:"(solid)"}),", ",(0,o.jsx)(n.code,{children:"fal"}),(0,o.jsx)(n.em,{children:"(light)"}),", ",(0,o.jsx)(n.code,{children:"fad"})," ",(0,o.jsx)(n.em,{children:"(duo-tone)"})," and ",(0,o.jsx)(n.code,{children:"fab"}),(0,o.jsx)(n.em,{children:"(brands)"}),". With the exception of brands, you'll usually want all your icons to be in from same category, so they look uniform."]}),"\n",(0,o.jsxs)(n.p,{children:["Ensure the icon you are trying to use, is available within ",(0,o.jsx)(n.a,{href:"https://fontawesome.com/v5/search",children:"FontAwesome Version 5"})," (we've not yet upgraded to V6, as it works a little differently)."]}),"\n",(0,o.jsxs)(n.p,{children:["Examples: ",(0,o.jsx)(n.code,{children:"fab fa-raspberry-pi"}),", ",(0,o.jsx)(n.code,{children:"fas fa-database"}),", ",(0,o.jsx)(n.code,{children:"fas fa-server"}),", ",(0,o.jsx)(n.code,{children:"fas fa-ethernet"})]}),"\n",(0,o.jsxs)(n.p,{children:["Finally, check the ",(0,o.jsx)(n.a,{href:"#how-to-open-browser-console",children:"browser console"})," for any error messages, and raise a ticket if the issue persists."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"copy-to-clipboard-not-working",children:"Copy to Clipboard not Working"}),"\n",(0,o.jsxs)(n.p,{children:["If the copy to clipboard feature (either under Config --\x3e Export, or Item --\x3e Copy URL) isn't functioning as expected, first check the browser console. If you see ",(0,o.jsx)(n.code,{children:"TypeError: Cannot read properties of undefined (reading 'writeText')"})," then this feature is not supported by your browser.\nThe most common reason for this, is if you not running the app over HTTPS. Copying to the clipboard requires the app to be running in a secure origin / aka have valid HTTPS cert. You can read more about this ",(0,o.jsx)(n.a,{href:"https://stackoverflow.com/a/71876238/979052",children:"here"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"As a workaround, you could either:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Highlight the text and copy / ",(0,o.jsx)(n.kbd,{children:"Ctrl"})," + ",(0,o.jsx)(n.kbd,{children:"C"})]}),"\n",(0,o.jsxs)(n.li,{children:["Or setup SSL - ",(0,o.jsx)(n.a,{href:"/docs/management#ssl-certificates",children:"here's a guide"})," on doing so"]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"unsupported-digital-envelope-routines",children:"Unsupported Digital Envelope Routines"}),"\n",(0,o.jsxs)(n.p,{children:["If you're running on GitHub Codespaces, and seeing: ",(0,o.jsx)(n.code,{children:"Error: error:0308010C:digital envelope routines::unsupported"})," when using Node 17+, it can be resolved by adding the ",(0,o.jsx)(n.code,{children:"--openssl-legacy-provider"})," flag to your ",(0,o.jsx)(n.code,{children:"NODE_OPTIONS"})," environmental variable.\nFor example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"export NODE_OPTIONS=--openssl-legacy-provider\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This will be fixed once ",(0,o.jsx)(n.a,{href:"https://github.com/webpack/webpack/pull/17659",children:"webpack/webpack#17659"})," is merged."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"how-to-reset-local-settings",children:"How to Reset Local Settings"}),"\n",(0,o.jsx)(n.p,{children:"Some settings are stored locally, in the browser's storage."}),"\n",(0,o.jsx)(n.p,{children:"In some instances cached assets can prevent your settings from being updated, in which case you may wish to reset local data."}),"\n",(0,o.jsx)(n.p,{children:'To clear all local data from the UI, head to the Config Menu, then click "Reset Local Settings", and Confirm when prompted.\nThis will not affect your config file. But be sure that you keep a backup of your config, if you\'ve not written changes it to disk.'}),"\n",(0,o.jsxs)(n.p,{children:["You can also view any and all data that Dashy is storing, using the developer tools. Open your browser's dev tools (usually ",(0,o.jsx)(n.kbd,{children:"F12"}),"), in Chromium head to the Application tab, or in Firefox go to the Storage tab. Select Local Storage, then scroll down the the URL Dashy is running on. You should now see all data being stored, and you can select and delete any fields you wish."]}),"\n",(0,o.jsxs)(n.p,{children:["For a full list of all data that may be cached, see the ",(0,o.jsx)(n.a,{href:"/docs/privacy#browser-storage",children:"Privacy Docs"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"how-to-make-a-bug-report",children:"How to make a bug report"}),"\n",(0,o.jsx)(n.h3,{id:"step-1---where-to-open-issues",children:"Step 1 - Where to open issues"}),"\n",(0,o.jsxs)(n.p,{children:["You will need a GitHub account in order to raise a ticket. You can then ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E",children:"click here"})," to open a new bug report."]}),"\n",(0,o.jsx)(n.h3,{id:"step-2---checking-its-not-already-covered",children:"Step 2 - Checking it's not already covered"}),"\n",(0,o.jsx)(n.p,{children:"Before submitting, please check that:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"A similar ticket has not previously been opened"}),"\n",(0,o.jsxs)(n.li,{children:["The issue is not covered in the ",(0,o.jsx)(n.a,{href:"/docs/troubleshooting",children:"troubleshooting guide"})," or ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/docs#readme",children:"docs"})]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"step-3---describe-the-issue",children:"Step 3 - Describe the Issue"}),"\n",(0,o.jsx)(n.p,{children:"Your ticket will likely be dealt with more effectively if you can explain the issue clearly, and provide all relevant supporting material."}),"\n",(0,o.jsx)(n.p,{children:"Complete the fields, asking for your environment info and version of Dashy.\nThen describe the issue, briefly explaining the steps to reproduce, expected outcome and actual outcome."}),"\n",(0,o.jsx)(n.h3,{id:"step-4---provide-supporting-info",children:"Step 4 - Provide Supporting Info"}),"\n",(0,o.jsx)(n.p,{children:"Where relevant please also include:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"A screenshot of the issue"}),"\n",(0,o.jsx)(n.li,{children:"The relevant parts of your config file"}),"\n",(0,o.jsxs)(n.li,{children:["Logs\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["If client-side issue, then include the browser logs (",(0,o.jsx)(n.a,{href:"#how-to-open-browser-console",children:"see how"}),")"]}),"\n",(0,o.jsx)(n.li,{children:"If server-side / during deployment, include the terminal output"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.em,{children:"Take care to redact any personal info, (like IP addresses, auth hashes or API keys)."})}),"\n",(0,o.jsx)(n.h3,{id:"step-5---fix-released",children:"Step 5 - Fix Released"}),"\n",(0,o.jsx)(n.p,{children:"A maintainer will aim to respond within 48 hours.\nThe timeframe for resolving your issue, will vary depending on severity of the bug and the complexity of the fix.\nYou will be notified on your ticket, when a fix has been released."}),"\n",(0,o.jsxs)(n.p,{children:["Finally, be sure to remain respectful to other users and project maintainers, in line with the ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT#contributor-covenant-code-of-conduct",children:"Contributor Covenant Code of Conduct"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"how-to-open-browser-console",children:"How-To Open Browser Console"}),"\n",(0,o.jsx)(n.p,{children:"When raising a bug, one crucial piece of info needed is the browser's console output. This will help the developer diagnose and fix the issue."}),"\n",(0,o.jsxs)(n.p,{children:['If you\'ve been asked for this info, but are unsure where to find it, then it is under the "Console" tab, in the browsers developer tools, which can be opened with ',(0,o.jsx)(n.kbd,{children:"F12"}),". You can right-click the console, and select Save As to download the log."]}),"\n",(0,o.jsx)(n.p,{children:"To open dev tools, and jump straight to the console:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Win / Linux: ",(0,o.jsx)(n.kbd,{children:"Ctrl"})," + ",(0,o.jsx)(n.kbd,{children:"Shift"})," + ",(0,o.jsx)(n.kbd,{children:"J"})]}),"\n",(0,o.jsxs)(n.li,{children:["MacOS: ",(0,o.jsx)(n.kbd,{children:"Cmd"})," + ",(0,o.jsx)(n.kbd,{children:"Option"})," + ",(0,o.jsx)(n.kbd,{children:"J"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["For more detailed walk through, see ",(0,o.jsx)(n.a,{href:"https://support.shortpoint.com/support/solutions/articles/1000222881-save-browser-console-file",children:"this article"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"git-contributions-not-displaying",children:"Git Contributions not Displaying"}),"\n",(0,o.jsxs)(n.p,{children:["If you've contributed to Dashy (or any other project), but your contributions are not showing up on your GH profile, or in Dashy's ",(0,o.jsx)(n.a,{href:"/docs/credits",children:"Credits Page"}),", then this is likely a git config issue."]}),"\n",(0,o.jsxs)(n.p,{children:["These statistics are generated using the username / email associated with commits. This info needs to be setup on your local machine using ",(0,o.jsx)(n.a,{href:"https://git-scm.com/docs/git-config",children:(0,o.jsx)(n.code,{children:"git config"})}),"."]}),"\n",(0,o.jsx)(n.p,{children:"Run the following commands (replacing name + email with your info):"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:'git config --global user.name "John Doe"'})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:"git config --global user.email johndoe@example.com"})}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["For more info, see ",(0,o.jsx)(n.a,{href:"https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup",children:"Git First Time Setup Docs"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"Note that only contributions to the master / main branch or a project are counted"})]})}function c(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453(e,n,s){s.d(n,{R:()=>t,x:()=>a});var i=s(6540);const o={},r=i.createContext(o);function t(e){const n=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[9013],{7309(e,n,s){s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>c,frontMatter:()=>t,metadata:()=>i,toc:()=>h});const i=JSON.parse('{"id":"troubleshooting","title":"Troubleshooting","description":"**This document contains common problems and their solutions.**","source":"@site/docs/troubleshooting.md","sourceDirName":".","slug":"/troubleshooting","permalink":"/docs/troubleshooting","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/troubleshooting.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"App Management","permalink":"/docs/management"},"next":{"title":"Icons","permalink":"/docs/icons"}}');var o=s(4848),r=s(8453);const t={},a="Troubleshooting",l={},h=[{value:"Contents",id:"contents",level:2},{value:"Config not saving",id:"config-not-saving",level:2},{value:"Possible Issue 1: Unable to call save endpoint from CDN/static server",id:"possible-issue-1-unable-to-call-save-endpoint-from-cdnstatic-server",level:3},{value:"Possible Issue 2: Unable to save",id:"possible-issue-2-unable-to-save",level:3},{value:"Possible Issue 3: Saved but not updating",id:"possible-issue-3-saved-but-not-updating",level:3},{value:"Refused to Connect in Modal or Workspace View",id:"refused-to-connect-in-modal-or-workspace-view",level:2},{value:"NGINX",id:"nginx",level:3},{value:"Caddy",id:"caddy",level:3},{value:"Apache",id:"apache",level:3},{value:"LightHttpd",id:"lighthttpd",level:3},{value:"404 On Static Hosting",id:"404-on-static-hosting",level:2},{value:"404 after Launch from Mobile Home Screen",id:"404-after-launch-from-mobile-home-screen",level:2},{value:"404 On Multi-Page Apps",id:"404-on-multi-page-apps",level:2},{value:"Yarn Error",id:"yarn-error",level:2},{value:"Remote Config Not Loading",id:"remote-config-not-loading",level:2},{value:"Ineffective mark-compacts near heap limit Allocation failed",id:"ineffective-mark-compacts-near-heap-limit-allocation-failed",level:2},{value:"Command failed with signal "SIGKILL"",id:"command-failed-with-signal-sigkill",level:2},{value:"Auth Validation Error: "should be object"",id:"auth-validation-error-should-be-object",level:2},{value:"App Not Starting After Update to 2.0.4",id:"app-not-starting-after-update-to-204",level:2},{value:"Keycloak Redirect Error",id:"keycloak-redirect-error",level:2},{value:"Docker Directory",id:"docker-directory",level:2},{value:"Config not Saving on Vercel / Netlify / CDN",id:"config-not-saving-on-vercel--netlify--cdn",level:2},{value:"Config Not Updating",id:"config-not-updating",level:2},{value:"Config Still not Updating",id:"config-still-not-updating",level:2},{value:"Styles and Assets not Updating",id:"styles-and-assets-not-updating",level:2},{value:"DockerHub toomanyrequests",id:"dockerhub-toomanyrequests",level:2},{value:"Solution 1 - Use an alternate container registry",id:"solution-1---use-an-alternate-container-registry",level:3},{value:"Solution 2 - Increase your rate limits",id:"solution-2---increase-your-rate-limits",level:3},{value:"Config Validation Errors",id:"config-validation-errors",level:2},{value:"Node Sass does not yet support your current environment",id:"node-sass-does-not-yet-support-your-current-environment",level:2},{value:"Unreachable Code Error",id:"unreachable-code-error",level:2},{value:"Error: Cannot find module './_baseValues'",id:"error-cannot-find-module-_basevalues",level:2},{value:"Invalid Host Header while running through ngrok",id:"invalid-host-header-while-running-through-ngrok",level:2},{value:"Warnings in the Console during deploy",id:"warnings-in-the-console-during-deploy",level:2},{value:"Docker Login Fails on Ubuntu",id:"docker-login-fails-on-ubuntu",level:2},{value:"Status Checks Failing",id:"status-checks-failing",level:2},{value:"Widget Errors",id:"widget-errors",level:2},{value:"Find Error Message",id:"find-error-message",level:3},{value:"Check Config",id:"check-config",level:3},{value:"Timeout Error",id:"timeout-error",level:3},{value:"CORS error",id:"cors-error",level:3},{value:"More Info",id:"more-info",level:3},{value:"Widget CORS Errors",id:"widget-cors-errors",level:2},{value:"Option 1 - Ensure Correct Protocol",id:"option-1---ensure-correct-protocol",level:3},{value:"Option 2 - Set Headers",id:"option-2---set-headers",level:3},{value:"Option 3 - Proxying Request",id:"option-3---proxying-request",level:3},{value:"Option 4 - Use a plugin",id:"option-4---use-a-plugin",level:3},{value:"Widget Shows Error Incorrectly",id:"widget-shows-error-incorrectly",level:2},{value:"Weather Forecast Widget 401",id:"weather-forecast-widget-401",level:2},{value:"Widget Displaying Inaccurate Data",id:"widget-displaying-inaccurate-data",level:2},{value:"Font Awesome Icons not Displaying",id:"font-awesome-icons-not-displaying",level:2},{value:"Copy to Clipboard not Working",id:"copy-to-clipboard-not-working",level:2},{value:"Unsupported Digital Envelope Routines",id:"unsupported-digital-envelope-routines",level:2},{value:"How to Reset Local Settings",id:"how-to-reset-local-settings",level:2},{value:"How to make a bug report",id:"how-to-make-a-bug-report",level:2},{value:"Step 1 - Where to open issues",id:"step-1---where-to-open-issues",level:3},{value:"Step 2 - Checking it's not already covered",id:"step-2---checking-its-not-already-covered",level:3},{value:"Step 3 - Describe the Issue",id:"step-3---describe-the-issue",level:3},{value:"Step 4 - Provide Supporting Info",id:"step-4---provide-supporting-info",level:3},{value:"Step 5 - Fix Released",id:"step-5---fix-released",level:3},{value:"How-To Open Browser Console",id:"how-to-open-browser-console",level:2},{value:"Git Contributions not Displaying",id:"git-contributions-not-displaying",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",br:"br",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",kbd:"kbd",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"troubleshooting",children:"Troubleshooting"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.em,{children:(0,o.jsx)(n.strong,{children:"This document contains common problems and their solutions."})}),(0,o.jsx)(n.br,{}),"\nPlease ensure your issue isn't listed here, before opening a new ticket."]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.em,{children:"Found something not listed here? Consider adding it, to help other users."})}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"contents",children:"Contents"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#config-not-saving",children:"Config not saving"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#refused-to-connect-in-modal-or-workspace-view",children:"Refused to Connect in Web Content View"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#404-on-static-hosting",children:"404 On Static Hosting"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#404-after-launch-from-mobile-home-screen",children:"404 from Mobile Home Screen"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#yarn-error",children:"Yarn Build or Run Error"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#remote-config-not-loading",children:"Remote Config Not Loading"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#ineffective-mark-compacts-near-heap-limit-allocation-failed",children:"Heap limit Allocation failed"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#command-failed-with-signal-sigkill",children:'Command failed with signal "SIGKILL"'})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#auth-validation-error-should-be-object",children:'Auth Validation Error: "should be object"'})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#app-not-starting-after-update-to-204",children:"App Not Starting After Update to 2.0.4"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#keycloak-redirect-error",children:"Keycloak Redirect Error"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#docker-directory",children:"Docker Directory Error"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#config-not-saving-on-vercel--netlify--cdn",children:"Config not Saving on Vercel / Netlify / CDN"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#config-not-updating",children:"Config Not Updating"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#config-still-not-updating",children:"Config Still not Updating"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#styles-and-assets-not-updating",children:"Styles and Assets not Updating"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#dockerhub-toomanyrequests",children:"DockerHub toomanyrequests"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#config-validation-errors",children:"Config Validation Errors"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#node-sass-does-not-yet-support-your-current-environment",children:"Node Sass unsupported environment"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#unreachable-code-error",children:"Unreachable Code Error"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#error-cannot-find-module-_basevalues",children:"Cannot find module './_baseValues'"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#invalid-host-header-while-running-through-ngrok",children:"Ngrok Invalid Host Headers"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#warnings-in-the-console-during-deploy",children:"Warnings in the Console during deploy"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#docker-login-fails-on-ubuntu",children:"Docker Login Fails on Ubuntu"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#status-checks-failing",children:"Status Checks Failing"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#widget-errors",children:"Diagnosing Widget Errors"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#widget-cors-errors",children:"Fixing Widget CORS Errors"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#widget-shows-error-incorrectly",children:"Widget Shows Error Incorrectly"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#weather-forecast-widget-401",children:"Weather Forecast Widget 401"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#widget-displaying-inaccurate-data",children:"Widget Displaying Inaccurate Data"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#font-awesome-icons-not-displaying",children:"Font Awesome Icons not Displaying"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#copy-to-clipboard-not-working",children:"Copy to Clipboard not Working"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#unsupported-digital-envelope-routines",children:"Unsupported Digital Envelope Routines"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#how-to-reset-local-settings",children:"How to Reset Local Settings"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#how-to-make-a-bug-report",children:"How to make a bug report"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#how-to-open-browser-console",children:"How-To Open Browser Console"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#git-contributions-not-displaying",children:"Git Contributions not Displaying"})}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"config-not-saving",children:"Config not saving"}),"\n",(0,o.jsx)(n.h3,{id:"possible-issue-1-unable-to-call-save-endpoint-from-cdnstatic-server",children:"Possible Issue 1: Unable to call save endpoint from CDN/static server"}),"\n",(0,o.jsxs)(n.p,{children:["If you're running Dashy using a static hosting provider (like Vercel), then there is no Node server, and so the save config action will not work via the UI.\nYou'll instead need to copy the YAML after making your changes, and paste that into your ",(0,o.jsx)(n.code,{children:"conf.yml"})," directly. If you've connected Vercel to git, then these changes will take effect automatically, once you commit your changes.\nLook here for more information: ",(0,o.jsx)(n.a,{href:"https://dashy.to/docs/deployment#deploy-to-cloud-service",children:"https://dashy.to/docs/deployment#deploy-to-cloud-service"})]}),"\n",(0,o.jsx)(n.p,{children:"If you're running on Netlify, there are some cloud functions which take care of all the server endpoints (like status checking), so these will work as expected."}),"\n",(0,o.jsxs)(n.p,{children:["See also ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/1465",children:"#1465"})]}),"\n",(0,o.jsx)(n.h3,{id:"possible-issue-2-unable-to-save",children:"Possible Issue 2: Unable to save"}),"\n",(0,o.jsx)(n.p,{children:"In Docker, double check that the file isn't read-only, and that the container actually has permissions to modify it. You shouldn't really be running it as a root user, and I'm not sure if it will work if you do-"}),"\n",(0,o.jsx)(n.h3,{id:"possible-issue-3-saved-but-not-updating",children:"Possible Issue 3: Saved but not updating"}),"\n",(0,o.jsx)(n.p,{children:"After saving, the frontend will recompile, which may take a couple seconds (or a bit longer on a Pi or low-powered device). If it doesn't recompile, you can manually trigger a re-build."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsxs)(n.h2,{id:"refused-to-connect-in-modal-or-workspace-view",children:[(0,o.jsx)(n.code,{children:"Refused to Connect"})," in Modal or Workspace View"]}),"\n",(0,o.jsx)(n.p,{children:"This is not an issue with Dashy, but instead caused by the target app preventing direct access through embedded elements."}),"\n",(0,o.jsxs)(n.p,{children:["As defined in ",(0,o.jsx)(n.a,{href:"https://datatracker.ietf.org/doc/html/rfc7034",children:"RFC-7034"}),", for any web content to be accessed through an embedded element, it must have the ",(0,o.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options",children:(0,o.jsx)(n.code,{children:"X-Frame-Options"})})," HTTP header set to ",(0,o.jsx)(n.code,{children:"ALLOW"}),". If you are getting a ",(0,o.jsx)(n.code,{children:"Refused to Connect"})," error then this header is set to ",(0,o.jsx)(n.code,{children:"DENY"})," (or ",(0,o.jsx)(n.code,{children:"SAMEORIGIN"})," and it's on a different host). Thankfully, for self-hosted services, it is easy to set these headers."]}),"\n",(0,o.jsx)(n.p,{children:"These settings are usually set in the config file for the web server that's hosting the target application, here are some examples of how to enable cross-origin access with common web servers:"}),"\n",(0,o.jsx)(n.h3,{id:"nginx",children:"NGINX"}),"\n",(0,o.jsxs)(n.p,{children:["In NGINX, you can use the ",(0,o.jsx)(n.a,{href:"https://nginx.org/en/docs/http/ngx_http_headers_module.html",children:(0,o.jsx)(n.code,{children:"add_header"})})," module within the app block."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"server {\n ...\n add_header X-Frame-Options SAMEORIGIN always;\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Then reload with ",(0,o.jsx)(n.code,{children:"service nginx reload"})]}),"\n",(0,o.jsx)(n.h3,{id:"caddy",children:"Caddy"}),"\n",(0,o.jsxs)(n.p,{children:["In Caddy, you can use the ",(0,o.jsx)(n.a,{href:"https://caddyserver.com/docs/caddyfile/directives/header",children:(0,o.jsx)(n.code,{children:"header"})})," directive."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"header {\n X-Frame-Options SAMEORIGIN\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"apache",children:"Apache"}),"\n",(0,o.jsxs)(n.p,{children:["In Apache, you can use the ",(0,o.jsx)(n.a,{href:"https://httpd.apache.org/docs/current/mod/mod_headers.html",children:(0,o.jsx)(n.code,{children:"mod_headers"})})," module to set the ",(0,o.jsx)(n.code,{children:"X-Frame-Options"})," in your config file. This file is usually located somewhere like `/etc/apache2/httpd.conf"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:'Header set X-Frame-Options: "ALLOW-FROM http://[dashy-location]/"\n'})}),"\n",(0,o.jsx)(n.h3,{id:"lighthttpd",children:"LightHttpd"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Content-Security-Policy: frame-ancestors 'self' https://[dashy-location]/\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"404-on-static-hosting",children:"404 On Static Hosting"}),"\n",(0,o.jsx)(n.p,{children:"If you're seeing Dashy's 404 page on initial load/ refresh, and then the main app when you go back to Home, then this is likely caused by the Vue router, and if so can be fixed in one of two ways."}),"\n",(0,o.jsxs)(n.p,{children:["The first solution is to switch the routing mode, from HTML5 ",(0,o.jsx)(n.code,{children:"history"})," mode to ",(0,o.jsx)(n.code,{children:"hash"})," mode, by setting ",(0,o.jsx)(n.code,{children:"appConfig.routingMode"})," to ",(0,o.jsx)(n.code,{children:"hash"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["If this works, but you wish to continue using HTML5 history mode, then a bit of extra ",(0,o.jsx)(n.a,{href:"/docs/management#web-server-configuration",children:"server configuration"})," is required. This is explained in more detaail in the ",(0,o.jsx)(n.a,{href:"https://router.vuejs.org/guide/essentials/history-mode.html",children:"Vue Docs"}),". Once completed, you can then use ",(0,o.jsx)(n.code,{children:"routingMode: history"})," again, for neater URLs."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"404-after-launch-from-mobile-home-screen",children:"404 after Launch from Mobile Home Screen"}),"\n",(0,o.jsxs)(n.p,{children:['Similar to the above issue, if you get a 404 after using iOS and Android\'s "Add to Home Screen" feature, then this is caused by Vue router.\nIt can be fixed by setting ',(0,o.jsx)(n.code,{children:"appConfig.routingMode"})," to ",(0,o.jsx)(n.code,{children:"hash"})]}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/628",children:"#628"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/762",children:"#762"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"404-on-multi-page-apps",children:"404 On Multi-Page Apps"}),"\n",(0,o.jsxs)(n.p,{children:["Similar to above, if you get a 404 error when visiting a page directly on multi-page apps, then this can be fixed under ",(0,o.jsx)(n.code,{children:"appConfig"}),", by setting ",(0,o.jsx)(n.code,{children:"routingMode"})," to ",(0,o.jsx)(n.code,{children:"hash"}),". Then rebuilding, and refreshing the page."]}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/670",children:"#670"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/763",children:"#763"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"yarn-error",children:"Yarn Error"}),"\n",(0,o.jsxs)(n.p,{children:["For more info, see ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/1",children:"Issue #1"})]}),"\n",(0,o.jsxs)(n.p,{children:["First of all, check that you've got yarn installed correctly - see the ",(0,o.jsx)(n.a,{href:"https://classic.yarnpkg.com/en/docs/install",children:"yarn installation docs"})," for more info."]}),"\n",(0,o.jsxs)(n.p,{children:["If you're getting an error about scenarios, then you've likely installed the wrong yarn... (you're ",(0,o.jsx)(n.a,{href:"https://github.com/yarnpkg/yarn/issues/2821",children:"not"})," the only one!). You can fix it by uninstalling, adding the correct repo, and reinstalling, for example, in Debian:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:"sudo apt remove yarn"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:"curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:'echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list'})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:"sudo apt update && sudo apt install yarn"})}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Alternatively, as a workaround, you have several options:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Try using ",(0,o.jsx)(n.a,{href:"https://www.npmjs.com/get-npm",children:"NPM"})," instead: So clone, cd, then run ",(0,o.jsx)(n.code,{children:"npm install"}),", ",(0,o.jsx)(n.code,{children:"npm run build"})," and ",(0,o.jsx)(n.code,{children:"npm start"})]}),"\n",(0,o.jsxs)(n.li,{children:["Try using ",(0,o.jsx)(n.a,{href:"https://www.docker.com/get-started",children:"Docker"})," instead, and all of the system setup and dependencies will already be taken care of. So from within the directory, just run ",(0,o.jsx)(n.code,{children:"docker build -t lissy93/dashy ."})," to build, and then use docker start to run the project, e.g: ",(0,o.jsx)(n.code,{children:"docker run -it -p 8080:8080 lissy93/dashy"})," (see the ",(0,o.jsx)(n.a,{href:"/docs/deployment#deploy-with-docker",children:"deploying docs"})," for more info)"]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"remote-config-not-loading",children:"Remote Config Not Loading"}),"\n",(0,o.jsx)(n.p,{children:"If you've got a multi-page dashboard, and are hosting the additional config files yourself, then CORS rules will apply. A CORS error will look something like:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Access to XMLHttpRequest at 'https://example.com/raw/my-config.yml' from origin 'http://dashy.local' has been blocked by CORS policy:\nNo 'Access-Control-Allow-Origin' header is present on the requested resource.\n"})}),"\n",(0,o.jsx)(n.p,{children:"The solution is to add the appropriate headers onto the target server, to allow it to accept requests from the origin where you're running Dashy."}),"\n",(0,o.jsxs)(n.p,{children:["If it is a remote service, that you do not have admin access to, then another option is to proxy the request. Either host your own, or use a publicly accessible service, like ",(0,o.jsx)(n.a,{href:"https://allorigins.win",children:"allorigins.win"}),", e.g: ",(0,o.jsx)(n.code,{children:"https://api.allorigins.win/raw?url=https://pastebin.com/raw/4tZpaJV5"}),". For git-based services specifically, there's ",(0,o.jsx)(n.a,{href:"https://raw.githack.com/",children:"raw.githack.com"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"ineffective-mark-compacts-near-heap-limit-allocation-failed",children:"Ineffective mark-compacts near heap limit Allocation failed"}),"\n",(0,o.jsx)(n.p,{children:"If you see an error message, similar to:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"<--- Last few GCs ---\x3e\n\n[61:0x74533040] 229060 ms: Mark-sweep (reduce) 127.1 (236.9) -> 127.1 (137.4) MB, 5560.7 / 0.3 ms (average mu = 0.286, current mu = 0.011) allocation failure scavenge might not succeed\n\n<--- JS stacktrace ---\x3e\n\nFATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This is likely caused by insufficient memory allocation to the container. When the container first starts up, or has to rebuild, the memory usage spikes, and if there isn't enough memory, it may terminate. This can be specified with, for example: ",(0,o.jsx)(n.code,{children:"--memory=1024m"}),". For more info, see ",(0,o.jsx)(n.a,{href:"https://docs.docker.com/config/containers/resource_constraints/",children:"Docker: Runtime options with Memory, CPUs, and GPUs"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/380",children:"#380"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/350",children:"#350"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/297",children:"#297"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/349",children:"#349"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/510",children:"#510"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/511",children:"#511"})," and ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/834",children:"#834"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"command-failed-with-signal-sigkill",children:'Command failed with signal "SIGKILL"'}),"\n",(0,o.jsxs)(n.p,{children:["In Docker, this can be caused by not enough memory. When the container first starts up, or has to rebuild, the memory usage spikes, and so a larger allocation may be required. This can be specified with, for example: ",(0,o.jsx)(n.code,{children:"--memory=1024m"}),". For more info, see ",(0,o.jsx)(n.a,{href:"https://docs.docker.com/config/containers/resource_constraints/",children:"Docker: Runtime options with Memory, CPUs, and GPUs"})]}),"\n",(0,o.jsxs)(n.p,{children:["See also ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/624",children:"#624"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"auth-validation-error-should-be-object",children:'Auth Validation Error: "should be object"'}),"\n",(0,o.jsxs)(n.p,{children:["In V 1.6.5 an update was made that in the future will become a breaking change. You will need to update you config to reflect this before V 2.0.0 is released. In the meantime, your previous config will continue to function normally, but you will see a validation warning. The change means that the structure of the ",(0,o.jsx)(n.code,{children:"appConfig.auth"})," object is now an object, which has a ",(0,o.jsx)(n.code,{children:"users"})," property."]}),"\n",(0,o.jsxs)(n.p,{children:["For more info, see ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/discussions/177",children:"this announcement"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"You can fix this by replacing:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"auth:\n- user: xxx\n hash: xxx\n"})}),"\n",(0,o.jsx)(n.p,{children:"with"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"auth:\n users:\n - user: xxx\n hash: xxx\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"app-not-starting-after-update-to-204",children:"App Not Starting After Update to 2.0.4"}),"\n",(0,o.jsxs)(n.p,{children:["Version 2.0.4 introduced changes to how the config is read, and the app is build. If you were previously mounting ",(0,o.jsx)(n.code,{children:"/public"})," as a volume, then this will over-write the build app, preventing it from starting. The solution is to just pass in the file(s) / sub-directories that you need. For example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"volumes:\n- /srv/dashy/conf.yml:/app/user-data/conf.yml\n- /srv/dashy/item-icons:/app/public/item-icons\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"keycloak-redirect-error",children:"Keycloak Redirect Error"}),"\n",(0,o.jsxs)(n.p,{children:["Check the ",(0,o.jsx)(n.a,{href:"#how-to-open-browser-console",children:"browser's console output"}),", if you've not set any headers, you will likely see a CORS error here, which would be the source of the issue."]}),"\n",(0,o.jsxs)(n.p,{children:["You need to allow Dashy to make requests to Keycloak, and Keycloak to redirect to Dashy. The way you do this depends on how you're hosting these applications / which proxy you are using, and examples can be found in the ",(0,o.jsx)(n.a,{href:"/docs/management#setting-headers",children:"Management Docs"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"For example, add the access control header to Keycloak, like:"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"Access-Control-Allow-Origin [URL-of Dashy]"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that for requests that transport sensitive info like credentials, setting the accept header to a wildcard (",(0,o.jsx)(n.code,{children:"*"}),") is not allowed - see ",(0,o.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#requests_with_credentials",children:"MDN Docs"}),", so you will need to specify the actual URL."]}),"\n",(0,o.jsxs)(n.p,{children:["You should also ensure that Keycloak is correctly configured, with a user, realm and application, and be sure that you have set a valid redirect URL in Keycloak (",(0,o.jsx)(n.a,{href:"https://user-images.githubusercontent.com/1862727/148599768-db4ee4f8-72c5-402d-8f00-051d999e6267.png",children:"screenshot"}),")."]}),"\n",(0,o.jsxs)(n.p,{children:["For more details on how to set headers, see the ",(0,o.jsx)(n.a,{href:"/docs/management#setting-headers",children:"Example Headers"})," in the management docs, or reference the documentation for your proxy."]}),"\n",(0,o.jsxs)(n.p,{children:["If you're running in Kubernetes, you will need to enable CORS ingress rules, see ",(0,o.jsx)(n.a,{href:"https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#enable-cors",children:"docs"}),", e.g:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:'nginx.ingress.kubernetes.io/cors-allow-origin: "https://dashy.example.com"\nnginx.ingress.kubernetes.io/enable-cors: "true"\n'})}),"\n",(0,o.jsx)(n.p,{children:"See also: #479, #409, #507, #491, #341, #520"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"docker-directory",children:"Docker Directory"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:'Error response from daemon: OCI runtime create failed: container_linux.go:380:\nstarting container process caused: process_linux.go:545: container init caused:\nrootfs_linux.go:76: mounting "/home/ubuntu/my-conf.yml" to rootfs at\n"/app/user-data/conf.yml" caused: mount through procfd: not a directory:\nunknown: Are you trying to mount a directory onto a file (or vice-versa)?\nCheck if the specified host path exists and is the expected type.\n'})}),"\n",(0,o.jsxs)(n.p,{children:["If you get an error similar to the one above, you are mounting a directory to the config file's location, when a plain file is expected. Create a YAML file, (",(0,o.jsx)(n.code,{children:"touch my-conf.yml"}),"), populate it with a sample config, then pass it as a volume: ",(0,o.jsx)(n.code,{children:"-v ./my-local-conf.yml:/app/user-data/conf.yml"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"config-not-saving-on-vercel--netlify--cdn",children:"Config not Saving on Vercel / Netlify / CDN"}),"\n",(0,o.jsxs)(n.p,{children:["If you're running Dashy using a static hosting provider (like Vercel), then there is no Node server, and so the save config action will not work via the UI.\nYou'll instead need to copy the YAML after making your changes, and paste that into your ",(0,o.jsx)(n.code,{children:"conf.yml"})," directly. If you've connected Vercel to git, then these changes will take effect automatically, once you commit your changes."]}),"\n",(0,o.jsx)(n.p,{children:"If you're running on Netlify, there are some cloud functions which take care of all the server endpoints (like status checking), so these will work as expected."}),"\n",(0,o.jsxs)(n.p,{children:["See also ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/1465",children:"#1465"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"config-not-updating",children:"Config Not Updating"}),"\n",(0,o.jsx)(n.p,{children:'Dashy has the option to save settings and config locally, in browser storage. Anything here will take precedence over whatever is in your config file, sometimes with unintended consequences. If you\'ve updated the config file manually, and are not seeing changes reflected in the UI, then try visiting the site in Incognito mode. If that works, then the solution is just to clear local storage. This can be done from the config menu, under "Clear Local Settings".'}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"config-still-not-updating",children:"Config Still not Updating"}),"\n",(0,o.jsxs)(n.p,{children:["Sometimes your text editor updates files ",(0,o.jsx)(n.a,{href:"https://linuxhandbook.com/inode-linux/",children:"inode"}),", meaning changes will not be picked up by the Docker container. This ",(0,o.jsx)(n.a,{href:"https://medium.com/@jonsbun/why-need-to-be-careful-when-mounting-single-files-into-a-docker-container-4f929340834",children:"article"})," explains things further."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"styles-and-assets-not-updating",children:"Styles and Assets not Updating"}),"\n",(0,o.jsxs)(n.p,{children:["If you find that your styles and other visual assets work when visiting ",(0,o.jsx)(n.code,{children:"ip:port"})," by not ",(0,o.jsx)(n.code,{children:"dashy.domain.com"}),", then this is usually caused by caching. In your browser, do a hard-refresh (",(0,o.jsx)(n.kbd,{children:"Ctrl"})," + ",(0,o.jsx)(n.kbd,{children:"F5"}),"). If you use Cloudflare, then you can clear the cache through the management console, or set the cache level to Bypass for certain files, under the Rules tab."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsxs)(n.h2,{id:"dockerhub-toomanyrequests",children:["DockerHub ",(0,o.jsx)(n.code,{children:"toomanyrequests"})]}),"\n",(0,o.jsx)(n.p,{children:"This situation relates to error messages similar to one of the following, returned when pulling, updating or running the Docker container from Docker Hub."}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Continuing execution. Pulling image lissy93/dashy:release-1.6.0\nerror pulling image configuration: toomanyrequests\n"})}),"\n",(0,o.jsx)(n.p,{children:"or"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit\n"})}),"\n",(0,o.jsxs)(n.p,{children:["When DockerHub returns one of these errors, or a ",(0,o.jsx)(n.code,{children:"429"})," status, that means you've hit your rate limit. This was ",(0,o.jsx)(n.a,{href:"https://www.docker.com/blog/scaling-docker-to-serve-millions-more-developers-network-egress/",children:"introduced"})," last year, and prevents unauthenticated or free users from running docker pull more than 100 times per 6 hours.\nYou can ",(0,o.jsx)(n.a,{href:"https://www.docker.com/blog/checking-your-current-docker-pull-rate-limits-and-status/",children:"check your rate limit status"})," by looking for the ",(0,o.jsx)(n.code,{children:"ratelimit-remaining"})," header in any DockerHub responses."]}),"\n",(0,o.jsx)(n.h3,{id:"solution-1---use-an-alternate-container-registry",children:"Solution 1 - Use an alternate container registry"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Dashy is also available through GHCR, which at present does not have any hard limits. Just use ",(0,o.jsx)(n.code,{children:"docker pull ghcr.io/lissy93/dashy:latest"})," to fetch the image"]}),"\n",(0,o.jsxs)(n.li,{children:["You can also build the image from source, by cloning the repo, and running ",(0,o.jsx)(n.code,{children:"docker build -t dashy ."})," or use the pre-made docker compose"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"solution-2---increase-your-rate-limits",children:"Solution 2 - Increase your rate limits"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Logging in to DockerHub will increase your rate limit from 100 requests to 200 requests per 6 hour period"}),"\n",(0,o.jsx)(n.li,{children:"Upgrading to a Pro for $5/month will increase your image requests to 5,000 per day, and any plans above have no rate limits"}),"\n",(0,o.jsx)(n.li,{children:"Since rate limits are counted based on your IP address, proxying your requests, or using a VPN may work"}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"config-validation-errors",children:"Config Validation Errors"}),"\n",(0,o.jsxs)(n.p,{children:["The configuration file is validated against ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json",children:"Dashy's Schema"})," using AJV."]}),"\n",(0,o.jsxs)(n.p,{children:["First, check that your syntax is valid, using ",(0,o.jsx)(n.a,{href:"https://codebeautify.org/yaml-validator/",children:"YAML Validator"})," or ",(0,o.jsx)(n.a,{href:"https://codebeautify.org/jsonvalidator",children:"JSON Validator"}),". If the issue persists, then take a look at the ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json",children:"schema"}),", and verify that the field you are trying to add/ modify matches the required format. You can also use ",(0,o.jsx)(n.a,{href:"https://www.jsonschemavalidator.net/s/JFUj7X9J",children:"this tool"})," to validate your JSON config against the schema, or run ",(0,o.jsx)(n.code,{children:"yarn validate-config"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"If you're trying to use a recently released feature, and are getting a warning, this is likely because you've not yet updated the the current latest version of Dashy."}),"\n",(0,o.jsx)(n.p,{children:"If the issue still persists, you should raise an issue."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"node-sass-does-not-yet-support-your-current-environment",children:"Node Sass does not yet support your current environment"}),"\n",(0,o.jsxs)(n.p,{children:["Caused by node-sass's binaries being built for a for a different architecture\nTo fix this, just run: ",(0,o.jsx)(n.code,{children:"yarn rebuild node-sass"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"unreachable-code-error",children:"Unreachable Code Error"}),"\n",(0,o.jsxs)(n.p,{children:["An error similar to: ",(0,o.jsx)(n.code,{children:"Fatal error in , line 0. Unreachable code, FailureMessage Object: 0xffe6c8ac. Illegal instruction (core dumped)"}),"\nIs related to a bug in a downstream package, see ",(0,o.jsx)(n.a,{href:"https://github.com/nodejs/docker-node/issues/1477",children:"nodejs/docker-node#1477"}),".\nUsually, updating your system and packages will resolve the issue."]}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/776",children:"#776"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"error-cannot-find-module-_basevalues",children:"Error: Cannot find module './_baseValues'"}),"\n",(0,o.jsxs)(n.p,{children:["Clearing the cache should fix this: ",(0,o.jsx)(n.code,{children:"yarn cache clean"}),"\nIf the issue persists, remove (",(0,o.jsx)(n.code,{children:"rm -rf node_modules\\ yarn.lock"}),") and reinstall (",(0,o.jsx)(n.code,{children:"yarn"}),") node_modules"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"invalid-host-header-while-running-through-ngrok",children:"Invalid Host Header while running through ngrok"}),"\n",(0,o.jsxs)(n.p,{children:["Just add the ",(0,o.jsx)(n.a,{href:"https://ngrok.com/docs#http-host-header",children:"-host-header"})," flag, e.g. ",(0,o.jsx)(n.code,{children:'ngrok http 8080 -host-header="localhost:8080"'})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"warnings-in-the-console-during-deploy",children:"Warnings in the Console during deploy"}),"\n",(0,o.jsx)(n.p,{children:"Please acknowledge the difference between errors and warnings before raising an issue about messages in the console. It's not unusual to see warnings about a new version of a certain package being available, an asset bundle bing oversized or a service worker not yet having a cache. These shouldn't have any impact on the running application, so please don't raise issues about these unless it directly relates to a bug or issue you're experiencing. Errors on the other hand should not appear in the console, and they are worth looking into further."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"docker-login-fails-on-ubuntu",children:"Docker Login Fails on Ubuntu"}),"\n",(0,o.jsxs)(n.p,{children:["Run ",(0,o.jsx)(n.code,{children:"sudo apt install gnupg2 pass && gpg2 -k"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"status-checks-failing",children:"Status Checks Failing"}),"\n",(0,o.jsx)(n.p,{children:"If you're using status checks, and despite a given service being online, the check is displaying an error, there are a couple of things you can look at:"}),"\n",(0,o.jsxs)(n.p,{children:["If your service requires requests to include any authorization in the headers, then use the ",(0,o.jsx)(n.code,{children:"statusCheckHeaders"})," property, as described in the ",(0,o.jsx)(n.a,{href:"/docs/status-indicators#setting-custom-headers",children:"docs"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["If you are still having issues, it may be because your target application is blocking requests from Dashy's IP. This is a ",(0,o.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"CORS error"}),", and can be fixed by setting the headers on your target app, to include:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: https://location-of-dashy/\nVary: Origin\n"})}),"\n",(0,o.jsxs)(n.p,{children:["If the URL you are checking has an unsigned certificate, or is not using HTTPS, then you may need to disable the rejection of insecure requests. This can be done by setting ",(0,o.jsx)(n.code,{children:"statusCheckAllowInsecure"})," to true for a given item."]}),"\n",(0,o.jsxs)(n.p,{children:["If your service is online, but responds with a status code that is not in the 2xx range, then you can use ",(0,o.jsx)(n.code,{children:"statusCheckAcceptCodes"})," to set an accepted status code."]}),"\n",(0,o.jsxs)(n.p,{children:["If you get an error, like ",(0,o.jsx)(n.code,{children:"Service Unavailable: Server resulted in a fatal error"}),", even when it's definitely online, this is most likely caused by missing the protocol. Don't forget to include ",(0,o.jsx)(n.code,{children:"https://"})," (or whatever protocol) before the URL, and ensure that if needed, you've specified the port."]}),"\n",(0,o.jsxs)(n.p,{children:["Running Dashy in HOST network mode, instead of BRIDGE will allow status check access to other services in HOST mode. For more info, see ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/discussions/445",children:"#445"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"If you have firewall rules configured, then ensure that they don't prevent Dashy from making requests to the other services you are trying to access."}),"\n",(0,o.jsxs)(n.p,{children:["Currently, the status check needs a page to be rendered, so if this URL in your browser does not return anything, then status checks will not work. This may be modified in the future, but in the meantime, a fix would be to make your own status service, which just checks if your app responds with whatever code you'd like, and then return a 200 plus renders an arbitrary message. Then just point ",(0,o.jsx)(n.code,{children:"statusCheckUrl"})," to your custom page."]}),"\n",(0,o.jsxs)(n.p,{children:["For further troubleshooting, use an application like ",(0,o.jsx)(n.a,{href:"https://postman.com",children:"Postman"})," to diagnose the issue. Set the parameter to ",(0,o.jsx)(n.code,{children:"GET"}),", and then make a call to: ",(0,o.jsx)(n.code,{children:"https://[url-of-dashy]/status-check/?&url=[service-url]"}),". Where the service URL must have first been encoded (e.g. with ",(0,o.jsx)(n.code,{children:"encodeURIComponent()"})," or ",(0,o.jsx)(n.a,{href:"https://www.urlencoder.io/",children:"urlencoder.io"}),")"]}),"\n",(0,o.jsx)(n.p,{children:"If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"widget-errors",children:"Widget Errors"}),"\n",(0,o.jsx)(n.h3,{id:"find-error-message",children:"Find Error Message"}),"\n",(0,o.jsxs)(n.p,{children:["If an error occurs when fetching or rendering results, you will see a short message in the UI. If that message doesn't adequately explain the problem, then you can ",(0,o.jsx)(n.a,{href:"/docs/troubleshooting#how-to-open-browser-console",children:"open the browser console"})," to see more details."]}),"\n",(0,o.jsx)(n.h3,{id:"check-config",children:"Check Config"}),"\n",(0,o.jsx)(n.p,{children:"Before proceeding, ensure that if the widget requires auth your API is correct, and for custom widgets, double check that the URL and protocol is correct."}),"\n",(0,o.jsx)(n.h3,{id:"timeout-error",children:"Timeout Error"}),"\n",(0,o.jsxs)(n.p,{children:["If the error message in the console includes: ",(0,o.jsx)(n.code,{children:"Error: timeout of 500ms exceeded"}),", then your Glances endpoint is slower to respond than expected. You can fix this by ",(0,o.jsx)(n.a,{href:"/docs/widgets#setting-timeout",children:"setting timeout"})," to a larger value. This is done on each widget, with the ",(0,o.jsx)(n.code,{children:"timeout"})," attribute, and is specified in ms. E.g. ",(0,o.jsx)(n.code,{children:"timeout: 5000"})," would only fail if no response is returned within 5 seconds."]}),"\n",(0,o.jsx)(n.h3,{id:"cors-error",children:"CORS error"}),"\n",(0,o.jsxs)(n.p,{children:["If the console message mentions to corss-origin blocking, then this is a CORS error, see: ",(0,o.jsx)(n.a,{href:"#widget-cors-errors",children:"Fixing Widget CORS Errors"})]}),"\n",(0,o.jsx)(n.h3,{id:"more-info",children:"More Info"}),"\n",(0,o.jsx)(n.p,{children:"If you're able to, you can find more information about why the request may be failing in the Dev Tools under the Network tab, and you can ensure your endpoint is correct and working using a tool like Postman."}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"widget-cors-errors",children:"Widget CORS Errors"}),"\n",(0,o.jsxs)(n.p,{children:["The most common widget issue is a CORS error. This is a browser security mechanism which prevents the client-side app (Dashy) from from accessing resources on a remote origin, without that server's explicit permission (e.g. with headers like Access-Control-Allow-Origin). See the MDN Docs for more info: ",(0,o.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS",children:"Cross-Origin Resource Sharing"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"There are several ways to fix a CORS error:"}),"\n",(0,o.jsx)(n.h3,{id:"option-1---ensure-correct-protocol",children:"Option 1 - Ensure Correct Protocol"}),"\n",(0,o.jsx)(n.p,{children:"You will get a CORS error if you try and access a http service from a https source. So ensure that the URL you are requesting has the right protocol, and is correctly formatted."}),"\n",(0,o.jsx)(n.h3,{id:"option-2---set-headers",children:"Option 2 - Set Headers"}),"\n",(0,o.jsxs)(n.p,{children:["If you have control over the destination (e.g. for a self-hosted service), then you can simply apply the correct headers.\nAdd the ",(0,o.jsx)(n.code,{children:"Access-Control-Allow-Origin"})," header, with the value of either ",(0,o.jsx)(n.code,{children:"*"})," to allow requests from anywhere, or more securely, the host of where Dashy is served from. For example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: https://url-of-dashy.local\n"})}),"\n",(0,o.jsx)(n.p,{children:"or"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"Access-Control-Allow-Origin: *\n"})}),"\n",(0,o.jsxs)(n.p,{children:["For more info on how to set headers, see: ",(0,o.jsx)(n.a,{href:"/docs/management#setting-headers",children:"Setting Headers"})," in the management docs"]}),"\n",(0,o.jsx)(n.h3,{id:"option-3---proxying-request",children:"Option 3 - Proxying Request"}),"\n",(0,o.jsxs)(n.p,{children:["You can route requests through Dashy's built-in CORS proxy. Instructions and more details can be found ",(0,o.jsx)(n.a,{href:"/docs/widgets#proxying-requests",children:"here"}),". If you don't have control over the target origin, and you are running Dashy either through Docker, with the Node server or on Netlify, then this solution will work for you."]}),"\n",(0,o.jsxs)(n.p,{children:["Just add the ",(0,o.jsx)(n.code,{children:"useProxy: true"})," option to the failing widget."]}),"\n",(0,o.jsx)(n.h3,{id:"option-4---use-a-plugin",children:"Option 4 - Use a plugin"}),"\n",(0,o.jsxs)(n.p,{children:["For testing purposes, you can use an addon, which will disable the CORS checks. You can get the Allow-CORS extension for ",(0,o.jsx)(n.a,{href:"https://chrome.google.com/webstore/detail/allow-cors-access-control/lhobafahddgcelffkeicbaginigeejlf?hl=en-US",children:"Chrome"})," or ",(0,o.jsx)(n.a,{href:"https://addons.mozilla.org/en-US/firefox/addon/access-control-allow-origin/",children:"Firefox"}),", more details ",(0,o.jsx)(n.a,{href:"https://mybrowseraddon.com/access-control-allow-origin.html",children:"here"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"widget-shows-error-incorrectly",children:"Widget Shows Error Incorrectly"}),"\n",(0,o.jsx)(n.p,{children:"When there's an error fetching or displaying a widgets data, then it will be highlighted in yellow, and a message displayed on the UI."}),"\n",(0,o.jsxs)(n.p,{children:["In some instances, this is a false positive, and the widget is actually functioning correctly.\nIf this is the case, you can disable the UI error message of a given widget by setting: ",(0,o.jsx)(n.code,{children:"ignoreErrors: true"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"weather-forecast-widget-401",children:"Weather Forecast Widget 401"}),"\n",(0,o.jsx)(n.p,{children:"A 401 error means your API key is invalid, it is not an issue with Dashy."}),"\n",(0,o.jsxs)(n.p,{children:["Usually this happens due to an error in your config. If you're unsure, copy and paste the ",(0,o.jsx)(n.a,{href:"/docs/widgets#weather",children:"example"})," config, replacing the API key with your own."]}),"\n",(0,o.jsxs)(n.p,{children:["Check that ",(0,o.jsx)(n.code,{children:"apiKey"})," is correctly specified, and nested within ",(0,o.jsx)(n.code,{children:"options"}),". Ensure your input city is valid."]}),"\n",(0,o.jsxs)(n.p,{children:["To test your API key, try making a request to ",(0,o.jsx)(n.code,{children:"https://api.openweathermap.org/data/2.5/weather?q=London&appid=[your-api-key]"})]}),"\n",(0,o.jsxs)(n.p,{children:["If ",(0,o.jsx)(n.a,{href:"/docs/widgets#weather-forecast",children:"Weather widget"})," is working fine, but you are getting a ",(0,o.jsx)(n.code,{children:"401"})," for the ",(0,o.jsx)(n.a,{href:"/docs/widgets#weather-forecast",children:"Weather Forecast widget"}),", then this is also an OWM API key issue.\nSince the forecasting API requires an upgraded plan. ULPT: You can get a free, premium API key by filling in ",(0,o.jsx)(n.a,{href:"https://home.openweathermap.org/students",children:"this form"}),". It's a student plan, but there's no verification to check that you are still a student."]}),"\n",(0,o.jsx)(n.p,{children:"A future update will be pushed out, to use a free weather forecasting API."}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/803",children:"#803"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/789",children:"#789"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/577",children:"#577"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/621",children:"#621"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/578",children:"#578"}),", ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/discussions/806",children:"#806"})]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"widget-displaying-inaccurate-data",children:"Widget Displaying Inaccurate Data"}),"\n",(0,o.jsx)(n.p,{children:"If any widget is not displaying the data you expect, first confirm that your config is correct, then try manually calling the API endpoint."}),"\n",(0,o.jsxs)(n.p,{children:["If the raw API output is correct, yet the widget is rendering incorrect results, then it is likely a bug, and a ticket should be raised. You can start to debug the issue, by looking at the widget's code (",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/src/components/Widgets",children:"here"}),"), and the browser console + networking tab."]}),"\n",(0,o.jsxs)(n.p,{children:["If the API itself is returning incorrect, incomplete or inaccurate data then an issue needs to be raised ",(0,o.jsx)(n.strong,{children:"with the API provider"})," (not Dashy!). You can find the API provider included within the widget docs, or for a full list see the ",(0,o.jsx)(n.a,{href:"/docs/privacy#widgets",children:"Privacy Docs"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["See also: ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/807",children:"#807"})," (re, domain monitor)"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"font-awesome-icons-not-displaying",children:"Font Awesome Icons not Displaying"}),"\n",(0,o.jsxs)(n.p,{children:["Usually, Font Awesome will be automatically enabled if one or more of your icons are using Font-Awesome. If this is not happening, then you can always manually enable (or disable) Font Awesome by setting: ",(0,o.jsx)(n.a,{href:"/docs/configuring#appconfig-optional",children:(0,o.jsx)(n.code,{children:"appConfig"})}),".",(0,o.jsx)(n.code,{children:"enableFontAwesome"})," to ",(0,o.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["If you are trying to use a premium icon, then you must have a ",(0,o.jsx)(n.a,{href:"https://fontawesome.com/plans",children:"Pro License"}),". You'll then need to specify your Pro plan API key under ",(0,o.jsx)(n.code,{children:"appConfig.fontAwesomeKey"}),". You can find this key, by logging into your FA account, navigate to Account \u2192 ",(0,o.jsx)(n.a,{href:"https://fontawesome.com/kits",children:"Kits"})," \u2192 New Kit \u2192 Copy Kit Code. The code is a 10-digit alpha-numeric code, and is also visible within the new kit's URL, for example: ",(0,o.jsx)(n.code,{children:"81e48ce079"}),"."]}),"\n",(0,o.jsx)(n.p,{align:"center",children:(0,o.jsx)(n.img,{src:"https://i.ibb.co/hZ0D9vs/where-do-i-find-my-font-awesome-key.png",width:"600"})}),"\n",(0,o.jsxs)(n.p,{children:["Be sure that you're specifying the icon category and name correctly. You're icon should look be ",(0,o.jsx)(n.code,{children:"[category] fa-[icon-name]"}),". The following categories are supported: ",(0,o.jsx)(n.code,{children:"far"})," ",(0,o.jsx)(n.em,{children:"(regular)"}),", ",(0,o.jsx)(n.code,{children:"fas"})," ",(0,o.jsx)(n.em,{children:"(solid)"}),", ",(0,o.jsx)(n.code,{children:"fal"}),(0,o.jsx)(n.em,{children:"(light)"}),", ",(0,o.jsx)(n.code,{children:"fad"})," ",(0,o.jsx)(n.em,{children:"(duo-tone)"})," and ",(0,o.jsx)(n.code,{children:"fab"}),(0,o.jsx)(n.em,{children:"(brands)"}),". With the exception of brands, you'll usually want all your icons to be in from same category, so they look uniform."]}),"\n",(0,o.jsxs)(n.p,{children:["Ensure the icon you are trying to use, is available within ",(0,o.jsx)(n.a,{href:"https://fontawesome.com/v5/search",children:"FontAwesome Version 5"})," (we've not yet upgraded to V6, as it works a little differently)."]}),"\n",(0,o.jsxs)(n.p,{children:["Examples: ",(0,o.jsx)(n.code,{children:"fab fa-raspberry-pi"}),", ",(0,o.jsx)(n.code,{children:"fas fa-database"}),", ",(0,o.jsx)(n.code,{children:"fas fa-server"}),", ",(0,o.jsx)(n.code,{children:"fas fa-ethernet"})]}),"\n",(0,o.jsxs)(n.p,{children:["Finally, check the ",(0,o.jsx)(n.a,{href:"#how-to-open-browser-console",children:"browser console"})," for any error messages, and raise a ticket if the issue persists."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"copy-to-clipboard-not-working",children:"Copy to Clipboard not Working"}),"\n",(0,o.jsxs)(n.p,{children:["If the copy to clipboard feature (either under Config --\x3e Export, or Item --\x3e Copy URL) isn't functioning as expected, first check the browser console. If you see ",(0,o.jsx)(n.code,{children:"TypeError: Cannot read properties of undefined (reading 'writeText')"})," then this feature is not supported by your browser.\nThe most common reason for this, is if you not running the app over HTTPS. Copying to the clipboard requires the app to be running in a secure origin / aka have valid HTTPS cert. You can read more about this ",(0,o.jsx)(n.a,{href:"https://stackoverflow.com/a/71876238/979052",children:"here"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"As a workaround, you could either:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Highlight the text and copy / ",(0,o.jsx)(n.kbd,{children:"Ctrl"})," + ",(0,o.jsx)(n.kbd,{children:"C"})]}),"\n",(0,o.jsxs)(n.li,{children:["Or setup SSL - ",(0,o.jsx)(n.a,{href:"/docs/management#ssl-certificates",children:"here's a guide"})," on doing so"]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"unsupported-digital-envelope-routines",children:"Unsupported Digital Envelope Routines"}),"\n",(0,o.jsxs)(n.p,{children:["If you're running on GitHub Codespaces, and seeing: ",(0,o.jsx)(n.code,{children:"Error: error:0308010C:digital envelope routines::unsupported"})," when using Node 17+, it can be resolved by adding the ",(0,o.jsx)(n.code,{children:"--openssl-legacy-provider"})," flag to your ",(0,o.jsx)(n.code,{children:"NODE_OPTIONS"})," environmental variable.\nFor example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"export NODE_OPTIONS=--openssl-legacy-provider\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This will be fixed once ",(0,o.jsx)(n.a,{href:"https://github.com/webpack/webpack/pull/17659",children:"webpack/webpack#17659"})," is merged."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"how-to-reset-local-settings",children:"How to Reset Local Settings"}),"\n",(0,o.jsx)(n.p,{children:"Some settings are stored locally, in the browser's storage."}),"\n",(0,o.jsx)(n.p,{children:"In some instances cached assets can prevent your settings from being updated, in which case you may wish to reset local data."}),"\n",(0,o.jsx)(n.p,{children:'To clear all local data from the UI, head to the Config Menu, then click "Reset Local Settings", and Confirm when prompted.\nThis will not affect your config file. But be sure that you keep a backup of your config, if you\'ve not written changes it to disk.'}),"\n",(0,o.jsxs)(n.p,{children:["You can also view any and all data that Dashy is storing, using the developer tools. Open your browser's dev tools (usually ",(0,o.jsx)(n.kbd,{children:"F12"}),"), in Chromium head to the Application tab, or in Firefox go to the Storage tab. Select Local Storage, then scroll down the the URL Dashy is running on. You should now see all data being stored, and you can select and delete any fields you wish."]}),"\n",(0,o.jsxs)(n.p,{children:["For a full list of all data that may be cached, see the ",(0,o.jsx)(n.a,{href:"/docs/privacy#browser-storage",children:"Privacy Docs"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"how-to-make-a-bug-report",children:"How to make a bug report"}),"\n",(0,o.jsx)(n.h3,{id:"step-1---where-to-open-issues",children:"Step 1 - Where to open issues"}),"\n",(0,o.jsxs)(n.p,{children:["You will need a GitHub account in order to raise a ticket. You can then ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E",children:"click here"})," to open a new bug report."]}),"\n",(0,o.jsx)(n.h3,{id:"step-2---checking-its-not-already-covered",children:"Step 2 - Checking it's not already covered"}),"\n",(0,o.jsx)(n.p,{children:"Before submitting, please check that:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"A similar ticket has not previously been opened"}),"\n",(0,o.jsxs)(n.li,{children:["The issue is not covered in the ",(0,o.jsx)(n.a,{href:"/docs/troubleshooting",children:"troubleshooting guide"})," or ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/docs#readme",children:"docs"})]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"step-3---describe-the-issue",children:"Step 3 - Describe the Issue"}),"\n",(0,o.jsx)(n.p,{children:"Your ticket will likely be dealt with more effectively if you can explain the issue clearly, and provide all relevant supporting material."}),"\n",(0,o.jsx)(n.p,{children:"Complete the fields, asking for your environment info and version of Dashy.\nThen describe the issue, briefly explaining the steps to reproduce, expected outcome and actual outcome."}),"\n",(0,o.jsx)(n.h3,{id:"step-4---provide-supporting-info",children:"Step 4 - Provide Supporting Info"}),"\n",(0,o.jsx)(n.p,{children:"Where relevant please also include:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"A screenshot of the issue"}),"\n",(0,o.jsx)(n.li,{children:"The relevant parts of your config file"}),"\n",(0,o.jsxs)(n.li,{children:["Logs\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["If client-side issue, then include the browser logs (",(0,o.jsx)(n.a,{href:"#how-to-open-browser-console",children:"see how"}),")"]}),"\n",(0,o.jsx)(n.li,{children:"If server-side / during deployment, include the terminal output"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.em,{children:"Take care to redact any personal info, (like IP addresses, auth hashes or API keys)."})}),"\n",(0,o.jsx)(n.h3,{id:"step-5---fix-released",children:"Step 5 - Fix Released"}),"\n",(0,o.jsx)(n.p,{children:"A maintainer will aim to respond within 48 hours.\nThe timeframe for resolving your issue, will vary depending on severity of the bug and the complexity of the fix.\nYou will be notified on your ticket, when a fix has been released."}),"\n",(0,o.jsxs)(n.p,{children:["Finally, be sure to remain respectful to other users and project maintainers, in line with the ",(0,o.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT#contributor-covenant-code-of-conduct",children:"Contributor Covenant Code of Conduct"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"how-to-open-browser-console",children:"How-To Open Browser Console"}),"\n",(0,o.jsx)(n.p,{children:"When raising a bug, one crucial piece of info needed is the browser's console output. This will help the developer diagnose and fix the issue."}),"\n",(0,o.jsxs)(n.p,{children:['If you\'ve been asked for this info, but are unsure where to find it, then it is under the "Console" tab, in the browsers developer tools, which can be opened with ',(0,o.jsx)(n.kbd,{children:"F12"}),". You can right-click the console, and select Save As to download the log."]}),"\n",(0,o.jsx)(n.p,{children:"To open dev tools, and jump straight to the console:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Win / Linux: ",(0,o.jsx)(n.kbd,{children:"Ctrl"})," + ",(0,o.jsx)(n.kbd,{children:"Shift"})," + ",(0,o.jsx)(n.kbd,{children:"J"})]}),"\n",(0,o.jsxs)(n.li,{children:["MacOS: ",(0,o.jsx)(n.kbd,{children:"Cmd"})," + ",(0,o.jsx)(n.kbd,{children:"Option"})," + ",(0,o.jsx)(n.kbd,{children:"J"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["For more detailed walk through, see ",(0,o.jsx)(n.a,{href:"https://support.shortpoint.com/support/solutions/articles/1000222881-save-browser-console-file",children:"this article"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"git-contributions-not-displaying",children:"Git Contributions not Displaying"}),"\n",(0,o.jsxs)(n.p,{children:["If you've contributed to Dashy (or any other project), but your contributions are not showing up on your GH profile, or in Dashy's ",(0,o.jsx)(n.a,{href:"/docs/credits",children:"Credits Page"}),", then this is likely a git config issue."]}),"\n",(0,o.jsxs)(n.p,{children:["These statistics are generated using the username / email associated with commits. This info needs to be setup on your local machine using ",(0,o.jsx)(n.a,{href:"https://git-scm.com/docs/git-config",children:(0,o.jsx)(n.code,{children:"git config"})}),"."]}),"\n",(0,o.jsx)(n.p,{children:"Run the following commands (replacing name + email with your info):"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:'git config --global user.name "John Doe"'})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.code,{children:"git config --global user.email johndoe@example.com"})}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["For more info, see ",(0,o.jsx)(n.a,{href:"https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup",children:"Git First Time Setup Docs"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"Note that only contributions to the master / main branch or a project are counted"})]})}function c(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453(e,n,s){s.d(n,{R:()=>t,x:()=>a});var i=s(6540);const o={},r=i.createContext(o);function t(e){const n=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a3713279.a6f2bed7.js b/assets/js/a3713279.33d4fec1.js similarity index 99% rename from assets/js/a3713279.a6f2bed7.js rename to assets/js/a3713279.33d4fec1.js index 8c7307a2..f186dec3 100644 --- a/assets/js/a3713279.a6f2bed7.js +++ b/assets/js/a3713279.33d4fec1.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[9588],{1989(e,s,n){n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});const o=JSON.parse('{"id":"deployment","title":"Deployment","description":"Welcome to Dashy, so glad you\'re here :) Deployment is super easy, and there are several methods available depending on what type of system you\'re using. If you\'re self-hosting, then deploying with Docker (or similar container engine) is the recommended approach.","source":"@site/docs/deployment.md","sourceDirName":".","slug":"/deployment","permalink":"/docs/deployment","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/deployment.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Quick Start","permalink":"/docs/quick-start"},"next":{"title":"Configuring","permalink":"/docs/configuring"}}');var r=n(4848),i=n(8453);const t={},l="Deployment",a={},d=[{value:"Quick Start",id:"quick-start",level:2},{value:"Deployment Methods",id:"deployment-methods",level:2},{value:"Deploy with Docker",id:"deploy-with-docker",level:2},{value:"Using Docker Compose",id:"using-docker-compose",level:2},{value:"Kubernetes",id:"kubernetes",level:2},{value:"Unraid",id:"unraid",level:2},{value:"Synology NAS",id:"synology-nas",level:2},{value:"Build from Source",id:"build-from-source",level:2},{value:"Deploy to cloud service",id:"deploy-to-cloud-service",level:2},{value:"Netlify",id:"netlify",level:3},{value:"Heroku",id:"heroku",level:3},{value:"Vercel",id:"vercel",level:3},{value:"DigitalOcean",id:"digitalocean",level:3},{value:"Google Cloud Platform",id:"google-cloud-platform",level:3},{value:"Platform.sh",id:"platformsh",level:3},{value:"Render",id:"render",level:3},{value:"Railway",id:"railway",level:3},{value:"Scalingo",id:"scalingo",level:3},{value:"Play-with-Docker",id:"play-with-docker",level:3},{value:"Surge.sh",id:"surgesh",level:3},{value:"Easypanel",id:"easypanel",level:3},{value:"EdgeOne Pages",id:"edgeone-pages",level:3},{value:"Hosting with CDN",id:"hosting-with-cdn",level:2},{value:"Requirements",id:"requirements",level:2},{value:"System Requirements",id:"system-requirements",level:3},{value:"Docker",id:"docker",level:3},{value:"Bare Metal",id:"bare-metal",level:3},{value:"CDN / Cloud Deploy",id:"cdn--cloud-deploy",level:3},{value:"Browser Support",id:"browser-support",level:3}];function c(e){const s={a:"a",blockquote:"blockquote",br:"br",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"deployment",children:"Deployment"})}),"\n",(0,r.jsx)(s.p,{children:"Welcome to Dashy, so glad you're here :) Deployment is super easy, and there are several methods available depending on what type of system you're using. If you're self-hosting, then deploying with Docker (or similar container engine) is the recommended approach."}),"\n",(0,r.jsx)(s.h2,{id:"quick-start",children:"Quick Start"}),"\n",(0,r.jsxs)(s.p,{children:["If you want to skip the fuss, and ",(0,r.jsx)(s.a,{href:"/docs/quick-start",children:"get straight down to it"}),", then you can spin up a new instance of Dashy by running:"]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"docker run -p 8080:8080 lissy93/dashy\n"})}),"\n",(0,r.jsxs)(s.p,{children:["See ",(0,r.jsx)(s.a,{href:"/docs/management",children:"Management Docs"})," for info about securing, monitoring, updating, health checks, auto starting, web server configuration, etc"]}),"\n",(0,r.jsxs)(s.p,{children:["Once you've got Dashy up and running, you'll want to configure it with your own content, for this you can reference the ",(0,r.jsx)(s.a,{href:"/docs/configuring",children:"configuring docs"}),"."]}),"\n",(0,r.jsx)(s.h2,{id:"deployment-methods",children:"Deployment Methods"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.a,{href:"#",children:"Deployment"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#quick-start",children:"Quick Start"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#deployment-methods",children:"Deployment Methods"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#deploy-with-docker",children:"Deploy with Docker"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#using-docker-compose",children:"Using Docker Compose"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#kubernetes",children:"Kubernetes"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#unraid",children:"Unraid"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#synology-nas",children:"Synology NAS"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#build-from-source",children:"Build from Source"})}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.a,{href:"#deploy-to-cloud-service",children:"Deploy to cloud service"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#netlify",children:"Netlify"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#heroku",children:"Heroku"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#vercel",children:"Vercel"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#digitalocean",children:"DigitalOcean"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#google-cloud-platform",children:"Google Cloud Platform"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#platformsh",children:"Platform.sh"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#render",children:"Render"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#railway",children:"Railway"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#scalingo",children:"Scalingo"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#play-with-docker",children:"Play-with-Docker"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#surgesh",children:"Surge.sh"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#easypanel",children:"Easypanel"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#edgeone-pages",children:"EdgeOne Pages"})}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#hosting-with-cdn",children:"Hosting with CDN"})}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.a,{href:"#requirements",children:"Requirements"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#system-requirements",children:"System Requirements"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#docker",children:"Docker"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#bare-metal",children:"Bare Metal"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#cdn--cloud-deploy",children:"CDN / Cloud Deploy"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#browser-support",children:"Browser Support"})}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"deploy-with-docker",children:"Deploy with Docker"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Container Info"}),": ",(0,r.jsxs)(s.a,{href:"https://hub.docker.com/r/lissy93/dashy",children:["\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/badge/Architectures-amd64%20%7C%20arm32v7%20%7C%20arm64v8-6ba6e5",alt:"Docker Supported Architecture"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/badge/Base_Image-Alpine_3.19-6ba6e5",alt:"Docker Base Image"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/badge/Hosted_on-DockerHub-6ba6e5",alt:"Docker Hosted on"}),"\n"]}),(0,r.jsx)(s.br,{}),"\n",(0,r.jsx)(s.strong,{children:"Status"}),": ",(0,r.jsxs)(s.a,{href:"https://hub.docker.com/r/lissy93/dashy",children:["\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/docker/cloud/build/lissy93/dashy?label=Docker%20Build",alt:"Docker Build Status"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/docker/pulls/lissy93/dashy?color=ecb2f7",alt:"Docker Pulls"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/docker/stars/lissy93/dashy?color=f7f754&label=Docker%20Stars",alt:"Docker Stars"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/docker/image-size/lissy93/dashy/latest?color=1eea76",alt:"Docker Image Size"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/docker/cloud/automated/lissy93/dashy?color=f4a966&label=Docker%20Build",alt:"Docker Cloud Build"}),"\n"]})]}),"\n",(0,r.jsxs)(s.p,{children:["Dashy has a built container image hosted on ",(0,r.jsx)(s.a,{href:"https://hub.docker.com/r/lissy93/dashy",children:"Docker Hub"}),". You will need ",(0,r.jsx)(s.a,{href:"https://docs.docker.com/get-docker/",children:"Docker"})," installed on your system."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"docker run -d \\\n -p 8080:8080 \\\n -v /root/my-local-conf.yml:/app/user-data/conf.yml \\\n --name my-dashboard \\\n --restart=always \\\n lissy93/dashy:latest\n"})}),"\n",(0,r.jsx)(s.p,{children:"Explanation of the above options:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"-d"})," Detached mode (not running in the foreground of your terminal)"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"-p"})," The port that should be exposed, and the port it should be mapped to in your host system ",(0,r.jsx)(s.code,{children:"[host-port][container-port]"}),", leave the container port as is"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"-v"})," Specify volumes, to pass data from your host system to the container, in the format of ",(0,r.jsx)(s.code,{children:"[host-path]:[container-path]"}),", you can use this to pass your config file, directory of assets (like icons), custom CSS or web assets (like favicon.ico, manifest.json etc)"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"--name"})," Give your container a human-readable name"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"--restart=always"})," Spin up the container when the daemon starts, or after it has been stopped"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"lissy93/dashy:latest"})," This last option is the image the container should be built from, you can also use a specific version or architecture type, by replacing ",(0,r.jsx)(s.code,{children:":latest"})," with one of the ",(0,r.jsx)(s.a,{href:"https://hub.docker.com/r/lissy93/dashy/tags",children:"tags"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["For all available options, and to learn more, see the ",(0,r.jsx)(s.a,{href:"https://docs.docker.com/engine/reference/commandline/run/",children:"Docker Run Docs"})]}),"\n",(0,r.jsxs)(s.p,{children:["Dashy is also available through GHCR: ",(0,r.jsx)(s.code,{children:"docker pull ghcr.io/lissy93/dashy:latest"})]}),"\n",(0,r.jsxs)(s.p,{children:["If you're deploying Dashy on a modern ARM-based board, such as a Raspberry Pi (2+), then you'll need to use one of Dashy's ARM images. Set the base image + tag to either ",(0,r.jsx)(s.code,{children:"lissy93/dashy:arm64v8"})," or ",(0,r.jsx)(s.code,{children:"lissy93/dashy:arm32v7"}),", depending on your system architecture. You can also use the ",(0,r.jsx)(s.code,{children:"multi-arch"})," image, which should work on all system architectures."]}),"\n",(0,r.jsxs)(s.p,{children:["The image defaults to ",(0,r.jsx)(s.code,{children:":latest"}),", but you can instead specify a specific version, e.g. ",(0,r.jsx)(s.code,{children:"docker pull lissy93/dashy:release-1.5.0"})]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"using-docker-compose",children:"Using Docker Compose"}),"\n",(0,r.jsxs)(s.p,{children:["Using Docker Compose can be useful for saving your specific config in files, without having to type out a long run command each time. Save compose config as a YAML file, and then run ",(0,r.jsx)(s.code,{children:"docker compose up -d"})," (optionally use the ",(0,r.jsx)(s.code,{children:"-f"})," flag to specify file location, if it isn't located at ",(0,r.jsx)(s.code,{children:"./docker-compose.yml"}),"), ",(0,r.jsx)(s.code,{children:"-d"})," is detached mode (not running in the foreground of your terminal). Compose is also useful if you are using clusters, as the format is very similar to stack files, used with Docker Swarm."]}),"\n",(0,r.jsxs)(s.p,{children:["The following is a complete example of a ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/docker-compose.yml",children:(0,r.jsx)(s.code,{children:"docker-compose.yml"})})," for Dashy. Run it as is, or uncomment the additional options you need."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-yaml",children:"---\nservices:\n dashy:\n # To build from source, replace 'image: lissy93/dashy' with 'build: .'\n # build: .\n image: lissy93/dashy\n container_name: Dashy\n # Pass in your config file below, by specifying the path on your host machine\n # volumes:\n # - /root/my-config.yml:/app/user-data/conf.yml\n ports:\n - 8080:8080\n # Set any environmental variables\n environment:\n - NODE_ENV=production\n # Specify your user ID and group ID. You can find this by running `id -u` and `id -g`\n # - UID=1000\n # - GID=1000\n # Specify restart policy\n restart: unless-stopped\n # Configure healthchecks\n healthcheck:\n test: ['CMD', 'node', '/app/services/healthcheck']\n interval: 1m30s\n timeout: 10s\n retries: 3\n start_period: 40s\n"})}),"\n",(0,r.jsxs)(s.p,{children:["You can use a different tag, by for example setting ",(0,r.jsx)(s.code,{children:"image: lissy93/dashy:arm64v8"}),", or pull from GHCR instead by setting ",(0,r.jsx)(s.code,{children:"image: ghcr.io/lissy93/dashy"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If you are building from source, and would like to use one of the ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/master/docker",children:"other Dockerfiles"}),", then under ",(0,r.jsx)(s.code,{children:"services.dashy"})," first set ",(0,r.jsx)(s.code,{children:"context: ."}),", then specify the the path to the dockerfile, e.g. ",(0,r.jsx)(s.code,{children:"dockerfile: ./docker/Dockerfile-arm32v7"})]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"kubernetes",children:"Kubernetes"}),"\n",(0,r.jsxs)(s.p,{children:["@vyrtualsynthese has written a Helm Chart for deploying with Kubernetes, available ",(0,r.jsx)(s.a,{href:"https://github.com/vyrtualsynthese/selfhosted-helmcharts/tree/main/charts/dashy",children:"here"})]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"unraid",children:"Unraid"}),"\n",(0,r.jsx)(s.p,{children:"// TODO"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"synology-nas",children:"Synology NAS"}),"\n",(0,r.jsx)(s.p,{children:"Installing dashy is really simply and fast:"}),"\n",(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsxs)(s.p,{children:["Install Docker via Synology ",(0,r.jsx)(s.code,{children:"Package Center"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsxs)(s.p,{children:["Go to ",(0,r.jsx)(s.code,{children:"File Station"})," and open the ",(0,r.jsx)(s.code,{children:"docker"})," folder. Inside the docker folder, create one new folder and name it ",(0,r.jsx)(s.code,{children:"dashy"}),"."]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsx)(s.p,{children:"Note: Be careful to enter only lowercase, not uppercase letters."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsx)(s.p,{children:"Go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script."}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsxs)(s.p,{children:["Once you click on ",(0,r.jsx)(s.code,{children:"User-defined"})," script a new window will open."]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsx)(s.p,{children:"Follow the instructions below:"}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsx)(s.p,{children:'General: In the Task field type in Install dashy. Uncheck "Enabled" option. Select root User.'}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsx)(s.p,{children:'Schedule: Select Run on the following date then select "Do not repeat".'}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsx)(s.p,{children:'Task Settings: Check "Send run details by email", add your email then copy paste the code below in the Run command area. After that click OK.'}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"docker run -d \\\n -p 4000:8080 \\\n -v /volume1/docker/dashy/my-local-conf.yml:/app/user-data/conf.yml \\\n --name dashy \\\n --restart=always \\\n lissy93/dashy:latest\n"})}),"\n",(0,r.jsx)(s.p,{children:"dashy should be up within 1-2min after you've started the install task procedure"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"build-from-source",children:"Build from Source"}),"\n",(0,r.jsxs)(s.p,{children:["If you do not want to use Docker, you can run Dashy directly on your host system. For this, you will need both ",(0,r.jsx)(s.a,{href:"https://git-scm.com/downloads",children:"git"})," and the latest or LTS version of ",(0,r.jsx)(s.a,{href:"https://nodejs.org/",children:"Node.js"})," installed, and optionally ",(0,r.jsx)(s.a,{href:"https://yarnpkg.com/",children:"yarn"})]}),"\n",(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsxs)(s.li,{children:["Get Code: ",(0,r.jsx)(s.code,{children:"git clone https://github.com/Lissy93/dashy.git"})," and ",(0,r.jsx)(s.code,{children:"cd dashy"})]}),"\n",(0,r.jsxs)(s.li,{children:["Configuration: Fill in your settings in ",(0,r.jsx)(s.code,{children:"./user-data/conf.yml"})]}),"\n",(0,r.jsxs)(s.li,{children:["Install dependencies: ",(0,r.jsx)(s.code,{children:"yarn"})]}),"\n",(0,r.jsxs)(s.li,{children:["Build: ",(0,r.jsx)(s.code,{children:"yarn build"})]}),"\n",(0,r.jsxs)(s.li,{children:["Run: ",(0,r.jsx)(s.code,{children:"yarn start"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"deploy-to-cloud-service",children:"Deploy to cloud service"}),"\n",(0,r.jsx)(s.p,{children:"If you don't have a home server, then fear not - Dashy can be deployed to pretty much any cloud provider. The above Docker and NPM guides will work exactly the same on a VPS, but I've also setup some 1-Click deploy links for 10+ of the most common cloud providers, to make things easier. Note that if your instance is exposed to the internet, it will be your responsibility to adequately secure it."}),"\n",(0,r.jsxs)(s.p,{children:["Some hosting providers required a bit of extra configuration, which was why I've made separate branches for deploying to those services (named: ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/deploy_cloudflare",children:(0,r.jsx)(s.code,{children:"deploy_cloudflare"})}),", ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/deploy_digital-ocean",children:(0,r.jsx)(s.code,{children:"deploy_digital-ocean"})}),", ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/deploy_platform-sh",children:(0,r.jsx)(s.code,{children:"deploy_platform-sh"})})," and ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/deploy_render",children:(0,r.jsx)(s.code,{children:"deploy_render"})}),"). If there's another cloud service which you'd like 1-click deployment to be supported for, feel free to raise an issue."]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsx)(s.p,{children:"[!NOTE]\nIf you use a static hosting provider, then status checks, writing new config changes to disk from the UI, and triggering a rebuild through the UI will not be available. This is because these features need endpoints provided by Dashy's local Node server. Everything else should work just the same though."}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"netlify",children:"Netlify"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/GtKMysT/deploy-netlify-button.png",alt:"Deploy to Netlify"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://www.netlify.com/",children:"Netlify"})," offers Git-based serverless cloud hosting for web applications. Their services are free to use for personal use, and they support deployment from both public and private repos, as well as direct file upload. The free plan also allows you to use your own custom domain or sub-domain, and is easy to setup."]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Netlify, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy\n"})}),"\n",(0,r.jsx)(s.h3,{id:"heroku",children:"Heroku"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://heroku.com/deploy?template=https://github.com/Lissy93/dashy",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/GdMFzBP/deploy-heroku-button.png",alt:"Deploy to Heroku"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://www.heroku.com/",children:"Heroku"})," is a fully managed cloud platform as a service. You define app settings in a Procfile and app.json, which specifying how the app should be build and how the server should be started. Heroku costs a minimum of $5 for 1,000 dyno hours per month (there are around 720 hours in a month), and supports custom domains. Heroku's single-dyno service is not as quite performant as some other providers, and the app will have a short wake-up time when not visited for a while"]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Heroku, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://heroku.com/deploy?template=https://github.com/Lissy93/dashy\n"})}),"\n",(0,r.jsx)(s.h3,{id:"vercel",children:"Vercel"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://vercel.com/new/project?template=https://github.com/lissy93/dashy",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/mJF3R7m/deploy-vercel-button.png",alt:"Deploy with Vercel"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://vercel.com/",children:"Vercel"})," is a performance-focused platform for hosting static frontend apps. It comes bundled with some useful tools for monitoring and analyzing application performance and other metrics. Vercel is free for personal use, allows for custom domains and has very reasonable limits."]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Vercel, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://vercel.com/new/project?template=https://github.com/lissy93/dashy\n"})}),"\n",(0,r.jsx)(s.h3,{id:"digitalocean",children:"DigitalOcean"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://cloud.digitalocean.com/apps/new?repo=https://github.com/lissy93/dashy/tree/deploy_digital-ocean&refcode=3838338e7f79",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/PFt0PkB/deploy-digital-ocean-button.png",alt:"Deploy to DO"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://www.digitalocean.com/",children:"DigitalOcean"})," is a cloud service providing affordable developer-friendly virtual machines from $5/month. But they also have an app platform, where you can run web apps, static sites, APIs and background workers. CDN-backed static sites are free for personal use."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://cloud.digitalocean.com/apps/new?repo=https://github.com/lissy93/dashy/tree/deploy_digital-ocean\n"})}),"\n",(0,r.jsx)(s.h3,{id:"google-cloud-platform",children:"Google Cloud Platform"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/LkvHttd/deploy-google-cloud-button.png",alt:"Run on Google Cloud"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://cloud.google.com/run/",children:"Cloud Run"})," is a service offered by ",(0,r.jsx)(s.a,{href:"https://cloud.google.com/",children:"Google Cloud"}),". It's a fully managed serverless platform, for developing and deploying highly scalable containerized applications. Similar to AWS and Azure, GCP offers a wide range of cloud services, which are billed on a pay\u2010per\u2010use basis, but Cloud Run has a ",(0,r.jsx)(s.a,{href:"https://cloud.google.com/run/pricing",children:"free tier"})," offering 180,000 vCPU-seconds, 360,000 GiB-seconds, and 2 million requests per month."]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to GCP, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git\n"})}),"\n",(0,r.jsx)(s.h3,{id:"platformsh",children:"Platform.sh"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://console.platform.sh/projects/create-project/?template=https://github.com/lissy93/dashy&utm_campaign=deploy_on_platform?utm_medium=button&utm_source=affiliate_links&utm_content=https://github.com/lissy93/dashy",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/nPnJgJP/deploy-platform-sh-button.png",alt:"Deploy to Platform.sh"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://platform.sh",children:"Platform.sh"})," is an end-to-end solution for developing and deploying applications. It is geared towards enterprise users with large teams, and focuses on allowing applications to scale up and down. Unlike the above providers, Platform.sh is not free, although you can deploy a test app to it without needing a payment method"]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Platform.sh, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://console.platform.sh/projects/create-project/?template=https://github.com/lissy93/dashy\n"})}),"\n",(0,r.jsx)(s.h3,{id:"render",children:"Render"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/QXNCbxT/deploy-render-button.png",alt:"Deploy to Render"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://render.com",children:"Render"})," is cloud provider that provides easy deployments for static sites, Docker apps, web services, databases and background workers. Render is great for developing applications, and very easy to use. Static sites are free, and services start at $7/month. Currently there are only 2 server locations - Oregon, USA and Frankfurt, Germany. For more info, see the ",(0,r.jsx)(s.a,{href:"https://render.com/docs",children:"Render Docs"})]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Render, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render\n"})}),"\n",(0,r.jsx)(s.h3,{id:"railway",children:"Railway"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://railway.app/template/MtdjAQ?referralCode=app",children:(0,r.jsx)(s.img,{src:"https://railway.app/button.svg",alt:"Deploy on Railway"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://railway.app/",children:"Railway"})," is a Platform as a Service (PaaS) that offers a complete platform for building and delivering programs to the backend of the cloud. You bring your code and Railway does the rest. Railway offers an extremely good developer experience and makes it effortless to deploy apps. Railway offers a free Trial Plan, and paid plans start at $5/month. Railway has 4 server locations: US-west, US-east, EU-west and ASIA-South-East."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://railway.app/template/MtdjAQ\n"})}),"\n",(0,r.jsx)(s.h3,{id:"scalingo",children:"Scalingo"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://my.scalingo.com/deploy?source=https://github.com/lissy93/dashy#master",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/nj0KxyH/deploy-scalingo-button.png",alt:"Deploy on Scalingo"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://scalingo.com/",children:"Scalingo"})," is a scalable container-based cloud platform as a service. It's focus is on compliance and uptime, and is geared towards enterprise users. Scalingo is also not free, although they do have a 3-day free trial that does not require a payment method."]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Scalingo, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://my.scalingo.com/deploy?source=https://github.com/lissy93/dashy#master\n"})}),"\n",(0,r.jsx)(s.h3,{id:"play-with-docker",children:"Play-with-Docker"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/SfbH7Zy/deploy-pwd-button.png",alt:"Try in PWD"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://labs.play-with-docker.com/",children:"Play with Docker"})," is a community project by Marcos Liljedhal and Jonathan Leibiusky and sponsored by Docker, intended to provide a hands-on learning environment. Their labs let you quickly spin up a Docker container or stack, and test out the image in a temporary, sandboxed environment. There's no need to sign up, and it's completely free."]}),"\n",(0,r.jsx)(s.p,{children:"To run Dashy in PWD, use the following URL:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml\n"})}),"\n",(0,r.jsx)(s.h3,{id:"surgesh",children:"Surge.sh"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/XkcKzKz/deploy-surge-button.png",alt:"Follow instructions below"})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"http://surge.sh/",children:"Surge.sh"})," is quick and easy static web publishing platform for frontend-apps.\nSurge supports ",(0,r.jsx)(s.a,{href:"https://surge.sh/help/adding-password-protection-to-a-project",children:"password-protected projects"}),". You can also ",(0,r.jsx)(s.a,{href:"https://surge.sh/help/adding-a-custom-domain",children:"add a custom domain"})," and then ",(0,r.jsx)(s.a,{href:"https://surge.sh/help/using-https-by-default",children:"force HTTPS by default"})," and optionally ",(0,r.jsx)(s.a,{href:"https://surge.sh/help/securing-your-custom-domain-with-ssl",children:"set a custom SSL certificate"})]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Surge.sh, first clone and cd into Dashy, install dependencies, and then use the following commands"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"yarn add -g surge\nyarn build\nsurge ./dist\n"})}),"\n",(0,r.jsx)(s.h3,{id:"easypanel",children:"Easypanel"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://easypanel.io/docs/templates/dashy",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/ZNPwQX3/deploy-easypanel-button.png",alt:"Deploy to Easypanel"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://easypanel.io",children:"Easypanel"})," it's a modern server control panel. You can use it to deploy Dashy on your own server."]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Easypanel, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://easypanel.io/docs/templates/dashy\n"})}),"\n",(0,r.jsx)(s.h3,{id:"edgeone-pages",children:"EdgeOne Pages"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://edgeone.ai/pages/new?repository-url=https://github.com/lissy93/dashy",children:(0,r.jsx)(s.img,{src:"https://cdnstatic.tencentcs.com/edgeone/pages/deploy.svg",alt:"Deploy to EdgeOne"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://pages.edgeone.ai",children:"EdgeOne Pages"})," it's a is built on a cloud-edge integrated architecture, combining hosting, acceleration, computing, and integration to enable faster and more efficient deployments.\nTo deploy Dashy to EdgeOne, use the following link"]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://edgeone.ai/pages/new?repository-url=https://github.com/lissy93/dashy\n"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"hosting-with-cdn",children:"Hosting with CDN"}),"\n",(0,r.jsxs)(s.p,{children:["Once Dashy has been built, it is effectively just a static web app. This means that it can be served up with pretty much any static host, CDN or web server. To host Dashy through a CDN, the steps are very similar to building from source: clone the project, cd into it, install dependencies, write your config file and build the app. Once build is complete you will have a ",(0,r.jsx)(s.code,{children:"./dist"})," directory within Dashy's root, and this is the build application which is ready to be served up."]}),"\n",(0,r.jsx)(s.p,{children:"However without Dashy's node server, there are a couple of features that will be unavailable to you, including: Writing config changes to disk through the UI, triggering a rebuild through the UI and application status checks. Everything else will work fine."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"requirements",children:"Requirements"}),"\n",(0,r.jsx)(s.h3,{id:"system-requirements",children:"System Requirements"}),"\n",(0,r.jsx)(s.p,{children:"Dashy works well on a Raspberry Pi (tested on Pi 3 and later), but should also run well on any system."}),"\n",(0,r.jsx)(s.h3,{id:"docker",children:"Docker"}),"\n",(0,r.jsx)(s.p,{children:"Initial app build causes a spike in resource usage, but once the built app is running it is fairly steady. For this reason, Dashy works best with a minimum of 1GB of memory, and 1GB of disk space."}),"\n",(0,r.jsx)(s.h3,{id:"bare-metal",children:"Bare Metal"}),"\n",(0,r.jsx)(s.p,{children:"Minimum 526mb mem, 2GB disk space."}),"\n",(0,r.jsx)(s.h3,{id:"cdn--cloud-deploy",children:"CDN / Cloud Deploy"}),"\n",(0,r.jsxs)(s.p,{children:["No specific requirements. The built application alone (without the Node server) is very light-weight, and can be handled smoothly by pretty much any CDN or cloud deployment service (see ",(0,r.jsx)(s.a,{href:"/docs/deployment#deploy-to-cloud-service",children:"this list"})," or natively supported cloud providers)."]}),"\n",(0,r.jsx)(s.p,{children:"If you're using your own icons, or other assets, additional disk space will be required for those resources."}),"\n",(0,r.jsx)(s.h3,{id:"browser-support",children:"Browser Support"}),"\n",(0,r.jsx)(s.p,{children:"JavaScript is required to run Dashy."}),"\n",(0,r.jsx)(s.p,{children:"In terms of browser support, pretty much any browser released since 2018 should render content just fine. However, for Internet Explorer, only IE11+ is supported, yet performance here is still not optimal. The recommended browser is either a Chromium-based / Webkit browser (Chrome, Brave, Vivaldi, Edge, Yandex, etc), or Firefox or one of it's forks (FF-ESR, Tor, LibreWolf, etc). Recent versions of Safari and Opera are also supported, but with limited continuous testing."}),"\n",(0,r.jsx)(s.p,{align:"center",children:(0,r.jsx)(s.img,{width:"500",src:"https://i.ibb.co/pjnmbw9/browser-compatibility.png"})})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},8453(e,s,n){n.d(s,{R:()=>t,x:()=>l});var o=n(6540);const r={},i=o.createContext(r);function t(e){const s=o.useContext(i);return o.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),o.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[9588],{1989(e,s,n){n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});const o=JSON.parse('{"id":"deployment","title":"Deployment","description":"Welcome to Dashy, so glad you\'re here :) Deployment is super easy, and there are several methods available depending on what type of system you\'re using. If you\'re self-hosting, then deploying with Docker (or similar container engine) is the recommended approach.","source":"@site/docs/deployment.md","sourceDirName":".","slug":"/deployment","permalink":"/docs/deployment","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/deployment.md","tags":[],"version":"current","lastUpdatedAt":1775053834000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Quick Start","permalink":"/docs/quick-start"},"next":{"title":"Configuring","permalink":"/docs/configuring"}}');var r=n(4848),i=n(8453);const t={},l="Deployment",a={},d=[{value:"Quick Start",id:"quick-start",level:2},{value:"Deployment Methods",id:"deployment-methods",level:2},{value:"Deploy with Docker",id:"deploy-with-docker",level:2},{value:"Using Docker Compose",id:"using-docker-compose",level:2},{value:"Kubernetes",id:"kubernetes",level:2},{value:"Unraid",id:"unraid",level:2},{value:"Synology NAS",id:"synology-nas",level:2},{value:"Build from Source",id:"build-from-source",level:2},{value:"Deploy to cloud service",id:"deploy-to-cloud-service",level:2},{value:"Netlify",id:"netlify",level:3},{value:"Heroku",id:"heroku",level:3},{value:"Vercel",id:"vercel",level:3},{value:"DigitalOcean",id:"digitalocean",level:3},{value:"Google Cloud Platform",id:"google-cloud-platform",level:3},{value:"Platform.sh",id:"platformsh",level:3},{value:"Render",id:"render",level:3},{value:"Railway",id:"railway",level:3},{value:"Scalingo",id:"scalingo",level:3},{value:"Play-with-Docker",id:"play-with-docker",level:3},{value:"Surge.sh",id:"surgesh",level:3},{value:"Easypanel",id:"easypanel",level:3},{value:"EdgeOne Pages",id:"edgeone-pages",level:3},{value:"Hosting with CDN",id:"hosting-with-cdn",level:2},{value:"Requirements",id:"requirements",level:2},{value:"System Requirements",id:"system-requirements",level:3},{value:"Docker",id:"docker",level:3},{value:"Bare Metal",id:"bare-metal",level:3},{value:"CDN / Cloud Deploy",id:"cdn--cloud-deploy",level:3},{value:"Browser Support",id:"browser-support",level:3}];function c(e){const s={a:"a",blockquote:"blockquote",br:"br",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"deployment",children:"Deployment"})}),"\n",(0,r.jsx)(s.p,{children:"Welcome to Dashy, so glad you're here :) Deployment is super easy, and there are several methods available depending on what type of system you're using. If you're self-hosting, then deploying with Docker (or similar container engine) is the recommended approach."}),"\n",(0,r.jsx)(s.h2,{id:"quick-start",children:"Quick Start"}),"\n",(0,r.jsxs)(s.p,{children:["If you want to skip the fuss, and ",(0,r.jsx)(s.a,{href:"/docs/quick-start",children:"get straight down to it"}),", then you can spin up a new instance of Dashy by running:"]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"docker run -p 8080:8080 lissy93/dashy\n"})}),"\n",(0,r.jsxs)(s.p,{children:["See ",(0,r.jsx)(s.a,{href:"/docs/management",children:"Management Docs"})," for info about securing, monitoring, updating, health checks, auto starting, web server configuration, etc"]}),"\n",(0,r.jsxs)(s.p,{children:["Once you've got Dashy up and running, you'll want to configure it with your own content, for this you can reference the ",(0,r.jsx)(s.a,{href:"/docs/configuring",children:"configuring docs"}),"."]}),"\n",(0,r.jsx)(s.h2,{id:"deployment-methods",children:"Deployment Methods"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.a,{href:"#",children:"Deployment"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#quick-start",children:"Quick Start"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#deployment-methods",children:"Deployment Methods"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#deploy-with-docker",children:"Deploy with Docker"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#using-docker-compose",children:"Using Docker Compose"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#kubernetes",children:"Kubernetes"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#unraid",children:"Unraid"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#synology-nas",children:"Synology NAS"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#build-from-source",children:"Build from Source"})}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.a,{href:"#deploy-to-cloud-service",children:"Deploy to cloud service"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#netlify",children:"Netlify"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#heroku",children:"Heroku"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#vercel",children:"Vercel"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#digitalocean",children:"DigitalOcean"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#google-cloud-platform",children:"Google Cloud Platform"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#platformsh",children:"Platform.sh"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#render",children:"Render"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#railway",children:"Railway"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#scalingo",children:"Scalingo"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#play-with-docker",children:"Play-with-Docker"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#surgesh",children:"Surge.sh"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#easypanel",children:"Easypanel"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#edgeone-pages",children:"EdgeOne Pages"})}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#hosting-with-cdn",children:"Hosting with CDN"})}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.a,{href:"#requirements",children:"Requirements"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#system-requirements",children:"System Requirements"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#docker",children:"Docker"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#bare-metal",children:"Bare Metal"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#cdn--cloud-deploy",children:"CDN / Cloud Deploy"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"#browser-support",children:"Browser Support"})}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"deploy-with-docker",children:"Deploy with Docker"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Container Info"}),": ",(0,r.jsxs)(s.a,{href:"https://hub.docker.com/r/lissy93/dashy",children:["\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/badge/Architectures-amd64%20%7C%20arm32v7%20%7C%20arm64v8-6ba6e5",alt:"Docker Supported Architecture"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/badge/Base_Image-Alpine_3.19-6ba6e5",alt:"Docker Base Image"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/badge/Hosted_on-DockerHub-6ba6e5",alt:"Docker Hosted on"}),"\n"]}),(0,r.jsx)(s.br,{}),"\n",(0,r.jsx)(s.strong,{children:"Status"}),": ",(0,r.jsxs)(s.a,{href:"https://hub.docker.com/r/lissy93/dashy",children:["\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/docker/cloud/build/lissy93/dashy?label=Docker%20Build",alt:"Docker Build Status"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/docker/pulls/lissy93/dashy?color=ecb2f7",alt:"Docker Pulls"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/docker/stars/lissy93/dashy?color=f7f754&label=Docker%20Stars",alt:"Docker Stars"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/docker/image-size/lissy93/dashy/latest?color=1eea76",alt:"Docker Image Size"}),"\n",(0,r.jsx)(s.img,{src:"https://img.shields.io/docker/cloud/automated/lissy93/dashy?color=f4a966&label=Docker%20Build",alt:"Docker Cloud Build"}),"\n"]})]}),"\n",(0,r.jsxs)(s.p,{children:["Dashy has a built container image hosted on ",(0,r.jsx)(s.a,{href:"https://hub.docker.com/r/lissy93/dashy",children:"Docker Hub"}),". You will need ",(0,r.jsx)(s.a,{href:"https://docs.docker.com/get-docker/",children:"Docker"})," installed on your system."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"docker run -d \\\n -p 8080:8080 \\\n -v /root/my-local-conf.yml:/app/user-data/conf.yml \\\n --name my-dashboard \\\n --restart=always \\\n lissy93/dashy:latest\n"})}),"\n",(0,r.jsx)(s.p,{children:"Explanation of the above options:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"-d"})," Detached mode (not running in the foreground of your terminal)"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"-p"})," The port that should be exposed, and the port it should be mapped to in your host system ",(0,r.jsx)(s.code,{children:"[host-port][container-port]"}),", leave the container port as is"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"-v"})," Specify volumes, to pass data from your host system to the container, in the format of ",(0,r.jsx)(s.code,{children:"[host-path]:[container-path]"}),", you can use this to pass your config file, directory of assets (like icons), custom CSS or web assets (like favicon.ico, manifest.json etc)"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"--name"})," Give your container a human-readable name"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"--restart=always"})," Spin up the container when the daemon starts, or after it has been stopped"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.code,{children:"lissy93/dashy:latest"})," This last option is the image the container should be built from, you can also use a specific version or architecture type, by replacing ",(0,r.jsx)(s.code,{children:":latest"})," with one of the ",(0,r.jsx)(s.a,{href:"https://hub.docker.com/r/lissy93/dashy/tags",children:"tags"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["For all available options, and to learn more, see the ",(0,r.jsx)(s.a,{href:"https://docs.docker.com/engine/reference/commandline/run/",children:"Docker Run Docs"})]}),"\n",(0,r.jsxs)(s.p,{children:["Dashy is also available through GHCR: ",(0,r.jsx)(s.code,{children:"docker pull ghcr.io/lissy93/dashy:latest"})]}),"\n",(0,r.jsxs)(s.p,{children:["If you're deploying Dashy on a modern ARM-based board, such as a Raspberry Pi (2+), then you'll need to use one of Dashy's ARM images. Set the base image + tag to either ",(0,r.jsx)(s.code,{children:"lissy93/dashy:arm64v8"})," or ",(0,r.jsx)(s.code,{children:"lissy93/dashy:arm32v7"}),", depending on your system architecture. You can also use the ",(0,r.jsx)(s.code,{children:"multi-arch"})," image, which should work on all system architectures."]}),"\n",(0,r.jsxs)(s.p,{children:["The image defaults to ",(0,r.jsx)(s.code,{children:":latest"}),", but you can instead specify a specific version, e.g. ",(0,r.jsx)(s.code,{children:"docker pull lissy93/dashy:release-1.5.0"})]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"using-docker-compose",children:"Using Docker Compose"}),"\n",(0,r.jsxs)(s.p,{children:["Using Docker Compose can be useful for saving your specific config in files, without having to type out a long run command each time. Save compose config as a YAML file, and then run ",(0,r.jsx)(s.code,{children:"docker compose up -d"})," (optionally use the ",(0,r.jsx)(s.code,{children:"-f"})," flag to specify file location, if it isn't located at ",(0,r.jsx)(s.code,{children:"./docker-compose.yml"}),"), ",(0,r.jsx)(s.code,{children:"-d"})," is detached mode (not running in the foreground of your terminal). Compose is also useful if you are using clusters, as the format is very similar to stack files, used with Docker Swarm."]}),"\n",(0,r.jsxs)(s.p,{children:["The following is a complete example of a ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/blob/master/docker-compose.yml",children:(0,r.jsx)(s.code,{children:"docker-compose.yml"})})," for Dashy. Run it as is, or uncomment the additional options you need."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-yaml",children:"---\nservices:\n dashy:\n # To build from source, replace 'image: lissy93/dashy' with 'build: .'\n # build: .\n image: lissy93/dashy\n container_name: Dashy\n # Pass in your config file below, by specifying the path on your host machine\n # volumes:\n # - /root/my-config.yml:/app/user-data/conf.yml\n ports:\n - 8080:8080\n # Set any environmental variables\n environment:\n - NODE_ENV=production\n # Specify your user ID and group ID. You can find this by running `id -u` and `id -g`\n # - UID=1000\n # - GID=1000\n # Specify restart policy\n restart: unless-stopped\n # Configure healthchecks\n healthcheck:\n test: ['CMD', 'node', '/app/services/healthcheck']\n interval: 1m30s\n timeout: 10s\n retries: 3\n start_period: 40s\n"})}),"\n",(0,r.jsxs)(s.p,{children:["You can use a different tag, by for example setting ",(0,r.jsx)(s.code,{children:"image: lissy93/dashy:arm64v8"}),", or pull from GHCR instead by setting ",(0,r.jsx)(s.code,{children:"image: ghcr.io/lissy93/dashy"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If you are building from source, and would like to use one of the ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/master/docker",children:"other Dockerfiles"}),", then under ",(0,r.jsx)(s.code,{children:"services.dashy"})," first set ",(0,r.jsx)(s.code,{children:"context: ."}),", then specify the the path to the dockerfile, e.g. ",(0,r.jsx)(s.code,{children:"dockerfile: ./docker/Dockerfile-arm32v7"})]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"kubernetes",children:"Kubernetes"}),"\n",(0,r.jsxs)(s.p,{children:["@vyrtualsynthese has written a Helm Chart for deploying with Kubernetes, available ",(0,r.jsx)(s.a,{href:"https://github.com/vyrtualsynthese/selfhosted-helmcharts/tree/main/charts/dashy",children:"here"})]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"unraid",children:"Unraid"}),"\n",(0,r.jsx)(s.p,{children:"// TODO"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"synology-nas",children:"Synology NAS"}),"\n",(0,r.jsx)(s.p,{children:"Installing dashy is really simply and fast:"}),"\n",(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsxs)(s.p,{children:["Install Docker via Synology ",(0,r.jsx)(s.code,{children:"Package Center"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsxs)(s.p,{children:["Go to ",(0,r.jsx)(s.code,{children:"File Station"})," and open the ",(0,r.jsx)(s.code,{children:"docker"})," folder. Inside the docker folder, create one new folder and name it ",(0,r.jsx)(s.code,{children:"dashy"}),"."]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsx)(s.p,{children:"Note: Be careful to enter only lowercase, not uppercase letters."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsx)(s.p,{children:"Go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script."}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsxs)(s.p,{children:["Once you click on ",(0,r.jsx)(s.code,{children:"User-defined"})," script a new window will open."]}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsx)(s.p,{children:"Follow the instructions below:"}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsx)(s.p,{children:'General: In the Task field type in Install dashy. Uncheck "Enabled" option. Select root User.'}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsx)(s.p,{children:'Schedule: Select Run on the following date then select "Do not repeat".'}),"\n"]}),"\n",(0,r.jsxs)(s.li,{children:["\n",(0,r.jsx)(s.p,{children:'Task Settings: Check "Send run details by email", add your email then copy paste the code below in the Run command area. After that click OK.'}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"docker run -d \\\n -p 4000:8080 \\\n -v /volume1/docker/dashy/my-local-conf.yml:/app/user-data/conf.yml \\\n --name dashy \\\n --restart=always \\\n lissy93/dashy:latest\n"})}),"\n",(0,r.jsx)(s.p,{children:"dashy should be up within 1-2min after you've started the install task procedure"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"build-from-source",children:"Build from Source"}),"\n",(0,r.jsxs)(s.p,{children:["If you do not want to use Docker, you can run Dashy directly on your host system. For this, you will need both ",(0,r.jsx)(s.a,{href:"https://git-scm.com/downloads",children:"git"})," and the latest or LTS version of ",(0,r.jsx)(s.a,{href:"https://nodejs.org/",children:"Node.js"})," installed, and optionally ",(0,r.jsx)(s.a,{href:"https://yarnpkg.com/",children:"yarn"})]}),"\n",(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsxs)(s.li,{children:["Get Code: ",(0,r.jsx)(s.code,{children:"git clone https://github.com/Lissy93/dashy.git"})," and ",(0,r.jsx)(s.code,{children:"cd dashy"})]}),"\n",(0,r.jsxs)(s.li,{children:["Configuration: Fill in your settings in ",(0,r.jsx)(s.code,{children:"./user-data/conf.yml"})]}),"\n",(0,r.jsxs)(s.li,{children:["Install dependencies: ",(0,r.jsx)(s.code,{children:"yarn"})]}),"\n",(0,r.jsxs)(s.li,{children:["Build: ",(0,r.jsx)(s.code,{children:"yarn build"})]}),"\n",(0,r.jsxs)(s.li,{children:["Run: ",(0,r.jsx)(s.code,{children:"yarn start"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"deploy-to-cloud-service",children:"Deploy to cloud service"}),"\n",(0,r.jsx)(s.p,{children:"If you don't have a home server, then fear not - Dashy can be deployed to pretty much any cloud provider. The above Docker and NPM guides will work exactly the same on a VPS, but I've also setup some 1-Click deploy links for 10+ of the most common cloud providers, to make things easier. Note that if your instance is exposed to the internet, it will be your responsibility to adequately secure it."}),"\n",(0,r.jsxs)(s.p,{children:["Some hosting providers required a bit of extra configuration, which was why I've made separate branches for deploying to those services (named: ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/deploy_cloudflare",children:(0,r.jsx)(s.code,{children:"deploy_cloudflare"})}),", ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/deploy_digital-ocean",children:(0,r.jsx)(s.code,{children:"deploy_digital-ocean"})}),", ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/deploy_platform-sh",children:(0,r.jsx)(s.code,{children:"deploy_platform-sh"})})," and ",(0,r.jsx)(s.a,{href:"https://github.com/Lissy93/dashy/tree/deploy_render",children:(0,r.jsx)(s.code,{children:"deploy_render"})}),"). If there's another cloud service which you'd like 1-click deployment to be supported for, feel free to raise an issue."]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsx)(s.p,{children:"[!NOTE]\nIf you use a static hosting provider, then status checks, writing new config changes to disk from the UI, and triggering a rebuild through the UI will not be available. This is because these features need endpoints provided by Dashy's local Node server. Everything else should work just the same though."}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"netlify",children:"Netlify"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/GtKMysT/deploy-netlify-button.png",alt:"Deploy to Netlify"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://www.netlify.com/",children:"Netlify"})," offers Git-based serverless cloud hosting for web applications. Their services are free to use for personal use, and they support deployment from both public and private repos, as well as direct file upload. The free plan also allows you to use your own custom domain or sub-domain, and is easy to setup."]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Netlify, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy\n"})}),"\n",(0,r.jsx)(s.h3,{id:"heroku",children:"Heroku"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://heroku.com/deploy?template=https://github.com/Lissy93/dashy",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/GdMFzBP/deploy-heroku-button.png",alt:"Deploy to Heroku"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://www.heroku.com/",children:"Heroku"})," is a fully managed cloud platform as a service. You define app settings in a Procfile and app.json, which specifying how the app should be build and how the server should be started. Heroku costs a minimum of $5 for 1,000 dyno hours per month (there are around 720 hours in a month), and supports custom domains. Heroku's single-dyno service is not as quite performant as some other providers, and the app will have a short wake-up time when not visited for a while"]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Heroku, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://heroku.com/deploy?template=https://github.com/Lissy93/dashy\n"})}),"\n",(0,r.jsx)(s.h3,{id:"vercel",children:"Vercel"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://vercel.com/new/project?template=https://github.com/lissy93/dashy",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/mJF3R7m/deploy-vercel-button.png",alt:"Deploy with Vercel"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://vercel.com/",children:"Vercel"})," is a performance-focused platform for hosting static frontend apps. It comes bundled with some useful tools for monitoring and analyzing application performance and other metrics. Vercel is free for personal use, allows for custom domains and has very reasonable limits."]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Vercel, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://vercel.com/new/project?template=https://github.com/lissy93/dashy\n"})}),"\n",(0,r.jsx)(s.h3,{id:"digitalocean",children:"DigitalOcean"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://cloud.digitalocean.com/apps/new?repo=https://github.com/lissy93/dashy/tree/deploy_digital-ocean&refcode=3838338e7f79",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/PFt0PkB/deploy-digital-ocean-button.png",alt:"Deploy to DO"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://www.digitalocean.com/",children:"DigitalOcean"})," is a cloud service providing affordable developer-friendly virtual machines from $5/month. But they also have an app platform, where you can run web apps, static sites, APIs and background workers. CDN-backed static sites are free for personal use."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://cloud.digitalocean.com/apps/new?repo=https://github.com/lissy93/dashy/tree/deploy_digital-ocean\n"})}),"\n",(0,r.jsx)(s.h3,{id:"google-cloud-platform",children:"Google Cloud Platform"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/LkvHttd/deploy-google-cloud-button.png",alt:"Run on Google Cloud"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://cloud.google.com/run/",children:"Cloud Run"})," is a service offered by ",(0,r.jsx)(s.a,{href:"https://cloud.google.com/",children:"Google Cloud"}),". It's a fully managed serverless platform, for developing and deploying highly scalable containerized applications. Similar to AWS and Azure, GCP offers a wide range of cloud services, which are billed on a pay\u2010per\u2010use basis, but Cloud Run has a ",(0,r.jsx)(s.a,{href:"https://cloud.google.com/run/pricing",children:"free tier"})," offering 180,000 vCPU-seconds, 360,000 GiB-seconds, and 2 million requests per month."]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to GCP, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git\n"})}),"\n",(0,r.jsx)(s.h3,{id:"platformsh",children:"Platform.sh"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://console.platform.sh/projects/create-project/?template=https://github.com/lissy93/dashy&utm_campaign=deploy_on_platform?utm_medium=button&utm_source=affiliate_links&utm_content=https://github.com/lissy93/dashy",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/nPnJgJP/deploy-platform-sh-button.png",alt:"Deploy to Platform.sh"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://platform.sh",children:"Platform.sh"})," is an end-to-end solution for developing and deploying applications. It is geared towards enterprise users with large teams, and focuses on allowing applications to scale up and down. Unlike the above providers, Platform.sh is not free, although you can deploy a test app to it without needing a payment method"]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Platform.sh, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://console.platform.sh/projects/create-project/?template=https://github.com/lissy93/dashy\n"})}),"\n",(0,r.jsx)(s.h3,{id:"render",children:"Render"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/QXNCbxT/deploy-render-button.png",alt:"Deploy to Render"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://render.com",children:"Render"})," is cloud provider that provides easy deployments for static sites, Docker apps, web services, databases and background workers. Render is great for developing applications, and very easy to use. Static sites are free, and services start at $7/month. Currently there are only 2 server locations - Oregon, USA and Frankfurt, Germany. For more info, see the ",(0,r.jsx)(s.a,{href:"https://render.com/docs",children:"Render Docs"})]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Render, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render\n"})}),"\n",(0,r.jsx)(s.h3,{id:"railway",children:"Railway"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://railway.app/template/MtdjAQ?referralCode=app",children:(0,r.jsx)(s.img,{src:"https://railway.app/button.svg",alt:"Deploy on Railway"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://railway.app/",children:"Railway"})," is a Platform as a Service (PaaS) that offers a complete platform for building and delivering programs to the backend of the cloud. You bring your code and Railway does the rest. Railway offers an extremely good developer experience and makes it effortless to deploy apps. Railway offers a free Trial Plan, and paid plans start at $5/month. Railway has 4 server locations: US-west, US-east, EU-west and ASIA-South-East."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://railway.app/template/MtdjAQ\n"})}),"\n",(0,r.jsx)(s.h3,{id:"scalingo",children:"Scalingo"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://my.scalingo.com/deploy?source=https://github.com/lissy93/dashy#master",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/nj0KxyH/deploy-scalingo-button.png",alt:"Deploy on Scalingo"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://scalingo.com/",children:"Scalingo"})," is a scalable container-based cloud platform as a service. It's focus is on compliance and uptime, and is geared towards enterprise users. Scalingo is also not free, although they do have a 3-day free trial that does not require a payment method."]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Scalingo, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://my.scalingo.com/deploy?source=https://github.com/lissy93/dashy#master\n"})}),"\n",(0,r.jsx)(s.h3,{id:"play-with-docker",children:"Play-with-Docker"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/SfbH7Zy/deploy-pwd-button.png",alt:"Try in PWD"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://labs.play-with-docker.com/",children:"Play with Docker"})," is a community project by Marcos Liljedhal and Jonathan Leibiusky and sponsored by Docker, intended to provide a hands-on learning environment. Their labs let you quickly spin up a Docker container or stack, and test out the image in a temporary, sandboxed environment. There's no need to sign up, and it's completely free."]}),"\n",(0,r.jsx)(s.p,{children:"To run Dashy in PWD, use the following URL:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml\n"})}),"\n",(0,r.jsx)(s.h3,{id:"surgesh",children:"Surge.sh"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/XkcKzKz/deploy-surge-button.png",alt:"Follow instructions below"})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"http://surge.sh/",children:"Surge.sh"})," is quick and easy static web publishing platform for frontend-apps.\nSurge supports ",(0,r.jsx)(s.a,{href:"https://surge.sh/help/adding-password-protection-to-a-project",children:"password-protected projects"}),". You can also ",(0,r.jsx)(s.a,{href:"https://surge.sh/help/adding-a-custom-domain",children:"add a custom domain"})," and then ",(0,r.jsx)(s.a,{href:"https://surge.sh/help/using-https-by-default",children:"force HTTPS by default"})," and optionally ",(0,r.jsx)(s.a,{href:"https://surge.sh/help/securing-your-custom-domain-with-ssl",children:"set a custom SSL certificate"})]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Surge.sh, first clone and cd into Dashy, install dependencies, and then use the following commands"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-bash",children:"yarn add -g surge\nyarn build\nsurge ./dist\n"})}),"\n",(0,r.jsx)(s.h3,{id:"easypanel",children:"Easypanel"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://easypanel.io/docs/templates/dashy",children:(0,r.jsx)(s.img,{src:"https://i.ibb.co/ZNPwQX3/deploy-easypanel-button.png",alt:"Deploy to Easypanel"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://easypanel.io",children:"Easypanel"})," it's a modern server control panel. You can use it to deploy Dashy on your own server."]}),"\n",(0,r.jsx)(s.p,{children:"To deploy Dashy to Easypanel, use the following link"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://easypanel.io/docs/templates/dashy\n"})}),"\n",(0,r.jsx)(s.h3,{id:"edgeone-pages",children:"EdgeOne Pages"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://edgeone.ai/pages/new?repository-url=https://github.com/lissy93/dashy",children:(0,r.jsx)(s.img,{src:"https://cdnstatic.tencentcs.com/edgeone/pages/deploy.svg",alt:"Deploy to EdgeOne"})})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://pages.edgeone.ai",children:"EdgeOne Pages"})," it's a is built on a cloud-edge integrated architecture, combining hosting, acceleration, computing, and integration to enable faster and more efficient deployments.\nTo deploy Dashy to EdgeOne, use the following link"]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-text",children:"https://edgeone.ai/pages/new?repository-url=https://github.com/lissy93/dashy\n"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"hosting-with-cdn",children:"Hosting with CDN"}),"\n",(0,r.jsxs)(s.p,{children:["Once Dashy has been built, it is effectively just a static web app. This means that it can be served up with pretty much any static host, CDN or web server. To host Dashy through a CDN, the steps are very similar to building from source: clone the project, cd into it, install dependencies, write your config file and build the app. Once build is complete you will have a ",(0,r.jsx)(s.code,{children:"./dist"})," directory within Dashy's root, and this is the build application which is ready to be served up."]}),"\n",(0,r.jsx)(s.p,{children:"However without Dashy's node server, there are a couple of features that will be unavailable to you, including: Writing config changes to disk through the UI, triggering a rebuild through the UI and application status checks. Everything else will work fine."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h2,{id:"requirements",children:"Requirements"}),"\n",(0,r.jsx)(s.h3,{id:"system-requirements",children:"System Requirements"}),"\n",(0,r.jsx)(s.p,{children:"Dashy works well on a Raspberry Pi (tested on Pi 3 and later), but should also run well on any system."}),"\n",(0,r.jsx)(s.h3,{id:"docker",children:"Docker"}),"\n",(0,r.jsx)(s.p,{children:"Initial app build causes a spike in resource usage, but once the built app is running it is fairly steady. For this reason, Dashy works best with a minimum of 1GB of memory, and 1GB of disk space."}),"\n",(0,r.jsx)(s.h3,{id:"bare-metal",children:"Bare Metal"}),"\n",(0,r.jsx)(s.p,{children:"Minimum 526mb mem, 2GB disk space."}),"\n",(0,r.jsx)(s.h3,{id:"cdn--cloud-deploy",children:"CDN / Cloud Deploy"}),"\n",(0,r.jsxs)(s.p,{children:["No specific requirements. The built application alone (without the Node server) is very light-weight, and can be handled smoothly by pretty much any CDN or cloud deployment service (see ",(0,r.jsx)(s.a,{href:"/docs/deployment#deploy-to-cloud-service",children:"this list"})," or natively supported cloud providers)."]}),"\n",(0,r.jsx)(s.p,{children:"If you're using your own icons, or other assets, additional disk space will be required for those resources."}),"\n",(0,r.jsx)(s.h3,{id:"browser-support",children:"Browser Support"}),"\n",(0,r.jsx)(s.p,{children:"JavaScript is required to run Dashy."}),"\n",(0,r.jsx)(s.p,{children:"In terms of browser support, pretty much any browser released since 2018 should render content just fine. However, for Internet Explorer, only IE11+ is supported, yet performance here is still not optimal. The recommended browser is either a Chromium-based / Webkit browser (Chrome, Brave, Vivaldi, Edge, Yandex, etc), or Firefox or one of it's forks (FF-ESR, Tor, LibreWolf, etc). Recent versions of Safari and Opera are also supported, but with limited continuous testing."}),"\n",(0,r.jsx)(s.p,{align:"center",children:(0,r.jsx)(s.img,{width:"500",src:"https://i.ibb.co/pjnmbw9/browser-compatibility.png"})})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},8453(e,s,n){n.d(s,{R:()=>t,x:()=>l});var o=n(6540);const r={},i=o.createContext(r);function t(e){const s=o.useContext(i);return o.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),o.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a63906ba.b697e989.js b/assets/js/a63906ba.55c1e433.js similarity index 99% rename from assets/js/a63906ba.b697e989.js rename to assets/js/a63906ba.55c1e433.js index 79c61246..f7189ac1 100644 --- a/assets/js/a63906ba.b697e989.js +++ b/assets/js/a63906ba.55c1e433.js @@ -1 +1 @@ -"use strict";(globalThis.webpackChunkdashy=globalThis.webpackChunkdashy||[]).push([[6903],{2737(e,n,s){s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"development-guides","title":"Development Guides","description":"A series of short tutorials, to guide you through the most common development tasks.","source":"@site/docs/development-guides.md","sourceDirName":".","slug":"/development-guides","permalink":"/docs/development-guides","draft":false,"unlisted":false,"editUrl":"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/development-guides.md","tags":[],"version":"current","lastUpdatedAt":1775052655000,"frontMatter":{},"sidebar":"dashySidebar","previous":{"title":"Developing","permalink":"/docs/developing"},"next":{"title":"Privacy & Security","permalink":"/docs/privacy"}}');var t=s(4848),r=s(8453);const a={},o="Development Guides",d={},l=[{value:"Creating a new theme",id:"creating-a-new-theme",level:2},{value:"1. Add Theme Name",id:"1-add-theme-name",level:3},{value:"2. Write some Styles",id:"2-write-some-styles",level:3},{value:"Writing Translations",id:"writing-translations",level:2},{value:"1. Create a new Language File",id:"1-create-a-new-language-file",level:3},{value:"2. Translate",id:"2-translate",level:3},{value:"3. Add your file to the app",id:"3-add-your-file-to-the-app",level:3},{value:"Adding a new option in the config file",id:"adding-a-new-option-in-the-config-file",level:2},{value:"Updating Dependencies",id:"updating-dependencies",level:2},{value:"Developing Netlify Cloud Functions",id:"developing-netlify-cloud-functions",level:2},{value:"1. Run Netlify Dev Server",id:"1-run-netlify-dev-server",level:3},{value:"2. Create a lambda function",id:"2-create-a-lambda-function",level:3},{value:"3. Redirect the Node endpoint to the function",id:"3-redirect-the-node-endpoint-to-the-function",level:3},{value:"Hiding Page Furniture on Certain Routes",id:"hiding-page-furniture-on-certain-routes",level:2},{value:"1. Add the route name to the should hide array",id:"1-add-the-route-name-to-the-should-hide-array",level:3},{value:"2. Add the conditional to the structural component to hide",id:"2-add-the-conditional-to-the-structural-component-to-hide",level:3},{value:"Adding / Using Environmental Variables",id:"adding--using-environmental-variables",level:2},{value:"Building a Widget",id:"building-a-widget",level:2},{value:"Step 0 - Prerequisites",id:"step-0---prerequisites",level:3},{value:"Step 1 - Create Widget",id:"step-1---create-widget",level:3},{value:"Step 2 - Adding Functionality",id:"step-2---adding-functionality",level:3},{value:"Accessing User Options",id:"accessing-user-options",level:4},{value:"Adding an API Endpoint",id:"adding-an-api-endpoint",level:4},{value:"Making an API Request",id:"making-an-api-request",level:4},{value:"Processing Response",id:"processing-response",level:4},{value:"Rendering Response",id:"rendering-response",level:4},{value:"Styling",id:"styling",level:4},{value:"Step 3 - Register",id:"step-3---register",level:3},{value:"Step 4 - Docs",id:"step-4---docs",level:3},{value:"Respecting Config Permissions",id:"respecting-config-permissions",level:2}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",input:"input",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"development-guides",children:"Development Guides"})}),"\n",(0,t.jsx)(n.p,{children:"A series of short tutorials, to guide you through the most common development tasks."}),"\n",(0,t.jsx)(n.p,{children:"Sections:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#creating-a-new-theme",children:"Creating a new theme"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#writing-translations",children:"Writing Translations"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#adding-a-new-option-in-the-config-file",children:"Adding a new option in the config file"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#updating-dependencies",children:"Updating Dependencies"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#developing-netlify-cloud-functions",children:"Writing Netlify Cloud Functions"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#hiding-page-furniture-on-certain-routes",children:"Hiding Page Furniture"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#adding--using-environmental-variables",children:"Adding / Using Environmental Variables"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#building-a-widget",children:"Building a Widget"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#respecting-config-permissions",children:"Respecting Config Permissions"})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"creating-a-new-theme",children:"Creating a new theme"}),"\n",(0,t.jsx)(n.p,{children:"Adding a new theme is really easy. There're two things you need to do: Pass the theme name to Dashy, so that it can be added to the theme selector dropdown menu, and then write some styles!"}),"\n",(0,t.jsx)(n.h3,{id:"1-add-theme-name",children:"1. Add Theme Name"}),"\n",(0,t.jsxs)(n.p,{children:["Choose a snappy name for your theme, and add it to the ",(0,t.jsx)(n.code,{children:"builtInThemes"})," array inside ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js#l27",children:(0,t.jsx)(n.code,{children:"defaults.js"})}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"2-write-some-styles",children:"2. Write some Styles"}),"\n",(0,t.jsxs)(n.p,{children:["Put your theme styles inside ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/styles/color-themes.scss",children:(0,t.jsx)(n.code,{children:"color-themes.scss"})}),".\nCreate a new block, and make sure that ",(0,t.jsx)(n.code,{children:"data-theme"})," matches the theme name you chose above. For example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-css",children:"html[data-theme='tiger'] {\n --primary: #f58233;\n --background: #0b1021;\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Then you can go ahead and write your own custom CSS. Although all CSS is supported here, the best way to define your theme is by setting the CSS variables. You can find a ",(0,t.jsx)(n.a,{href:"/docs/theming#css-variables",children:"list of all CSS variables, here"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["For a full guide on styling, see ",(0,t.jsx)(n.a,{href:"/docs/theming",children:"Theming Docs"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Note that if your theme is just for yourself, and you're not submitting a PR, then you can instead just pass it under ",(0,t.jsx)(n.code,{children:"appConfig.cssThemes"})," inside your config file. And then put your theme in your own stylesheet, and pass it into the Docker container - ",(0,t.jsx)(n.a,{href:"/docs/theming#adding-your-own-theme",children:"see how"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"writing-translations",children:"Writing Translations"}),"\n",(0,t.jsxs)(n.p,{children:["For full docs about Dashy's multi-language support, see ",(0,t.jsx)(n.a,{href:"/docs/multi-language-support",children:"Multi-Language Support"})]}),"\n",(0,t.jsxs)(n.p,{children:["Dashy is using ",(0,t.jsx)(n.a,{href:"https://vue-i18n.intlify.dev/guide/",children:"vue-i18n"})," to manage multi-language support."]}),"\n",(0,t.jsx)(n.p,{children:"Adding a new language is pretty straightforward, with just three steps:"}),"\n",(0,t.jsx)(n.h3,{id:"1-create-a-new-language-file",children:"1. Create a new Language File"}),"\n",(0,t.jsxs)(n.p,{children:["Create a new JSON file in ",(0,t.jsx)(n.code,{children:"./src/assets/locales"})," name is a 2-digit ",(0,t.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes",children:"ISO-639 code"})," for your language, E.g. for German ",(0,t.jsx)(n.code,{children:"de.json"}),", French ",(0,t.jsx)(n.code,{children:"fr.json"})," or Spanish ",(0,t.jsx)(n.code,{children:"es.json"})," - You can find a list of all ISO codes at ",(0,t.jsx)(n.a,{href:"https://www.iso.org/obp/ui",children:"iso.org"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"2-translate",children:"2. Translate"}),"\n",(0,t.jsxs)(n.p,{children:["Using ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/src/assets/locales/en.json",children:(0,t.jsx)(n.code,{children:"en.json"})})," as an example, translate the JSON values to your language, while leaving the keys as they are. It's fine to leave out certain items, as if they're missing they will fall-back to English. If you see any attribute which include curly braces (",(0,t.jsx)(n.code,{children:"{xxx}"}),"), then leave the inner value of these braces as is, as this is for variables."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-json",children:'{\n "theme-maker": {\n "export-button": "Benutzerdefinierte Variablen exportieren",\n "reset-button": "Stile zur\xfccksetzen f\xfcr",\n "show-all-button": "Alle Variablen anzeigen",\n "save-button": "Speichern",\n "cancel-button": "Abbrechen",\n "saved-toast": "{theme} Erfolgreich aktualisiert",\n "reset-toast": "Benutzerdefinierte Farben f\xfcr {theme} entfernt"\n },\n}\n'})}),"\n",(0,t.jsx)(n.h3,{id:"3-add-your-file-to-the-app",children:"3. Add your file to the app"}),"\n",(0,t.jsxs)(n.p,{children:["In ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/src/utils/languages.js",children:(0,t.jsx)(n.code,{children:"./src/utils/languages.js"})}),", you need to do 2 small things:"]}),"\n",(0,t.jsxs)(n.p,{children:["First import your new translation file, do this at the top of the page.\nE.g. ",(0,t.jsx)(n.code,{children:"import de from '@/assets/locales/de.json';"})]}),"\n",(0,t.jsx)(n.p,{children:"Second, add it to the array of languages, e.g:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"export const languages = [\n {\n name: 'English',\n code: 'en',\n locale: en,\n flag: '\ud83c\uddec\ud83c\udde7',\n },\n {\n name: 'German', // The name of your language\n code: 'de', // The ISO code of your language\n locale: de, // The name of the file you imported (no quotes)\n flag: '\ud83c\udde9\ud83c\uddea', // An optional flag emoji\n },\n];\n"})}),"\n",(0,t.jsxs)(n.p,{children:["You can also add your new language to the readme file, under the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy#language-switching",children:"Language Switching"})," section, and optionally include your name/ username if you'd like to be credited for your work. Done!"]}),"\n",(0,t.jsx)(n.p,{children:"If you are not comfortable with making pull requests, or do not want to modify the code, then feel free to instead send the translated file to me, and I can add it into the application. I will be sure to credit you appropriately."}),"\n",(0,t.jsx)(n.h2,{id:"adding-a-new-option-in-the-config-file",children:"Adding a new option in the config file"}),"\n",(0,t.jsx)(n.p,{children:"This section is for, adding a new setting to the config file."}),"\n",(0,t.jsxs)(n.p,{children:["All of the users config is specified in ",(0,t.jsx)(n.code,{children:"./user-data/conf.yml"})," - see ",(0,t.jsx)(n.a,{href:"/docs/configuring",children:"Configuring Docs"})," for info.\nIt's important to first ensure that there isn't a similar option already available, the new option is definitely necessary, and most importantly that it is fully backwards compatible."]}),"\n",(0,t.jsx)(n.p,{children:"Next choose the appropriate section to place it under"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Application settings should be located under ",(0,t.jsx)(n.code,{children:"appConfig"})]}),"\n",(0,t.jsxs)(n.li,{children:["Page info (such as text and metadata) should be under ",(0,t.jsx)(n.code,{children:"pageInfo"})]}),"\n",(0,t.jsxs)(n.li,{children:["Data relating to specific sections should be under ",(0,t.jsx)(n.code,{children:"section[n].displayData"})]}),"\n",(0,t.jsxs)(n.li,{children:["Settings applied to specific items or widgets, should be under ",(0,t.jsx)(n.code,{children:"item[n]"})," or ",(0,t.jsx)(n.code,{children:"widget[n]"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["For example, if your option is added under ",(0,t.jsx)(n.code,{children:"appConfig"}),", you can access it within your component using the ",(0,t.jsx)(n.code,{children:"$store"}),", this is typically placed in a computed property, e.g:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"computed: {\n appConfig() {\n return this.$store.getters.appConfig;\n },\n ...\n},\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Then, where you want to get the users value within your component, use something like: ",(0,t.jsx)(n.code,{children:"this.appConfig.myProperty"}),". If the user hasn't specified the value, Don't forget to have a fallback or default for it."]}),"\n",(0,t.jsxs)(n.p,{children:["If you have a default fallback value, then this would typically be specified in the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js",children:(0,t.jsx)(n.code,{children:"defaults.js"})})," file."]}),"\n",(0,t.jsxs)(n.p,{children:["You will now need to add the definition of your new attribute into the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json",children:"ConfigSchema"}),". This will make it available in the UI config editor, and also ensure that the config validation check doesn't fail.\nFor example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-json",children:'"fontAwesomeKey": {\n "type": "string",\n "pattern": "^[a-z0-9]{10}$",\n "description": "API key for font-awesome",\n "example": "0821c65656"\n}\n'})}),"\n",(0,t.jsx)(n.p,{children:"or"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-json",children:'"iconSize": {\n "enum": [ "small", "medium", "large" ],\n "default": "medium",\n "description": "The size of each link item / icon"\n}\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Finally, add your new property to the ",(0,t.jsx)(n.a,{href:"/docs/configuring",children:(0,t.jsx)(n.code,{children:"configuring.md"})})," API docs. Put it under the relevant section, and be sure to include field name, data type, a description and mention that it is optional. If your new feature needs more explanation, then you can also document it under the relevant section elsewhere in the documentation."]}),"\n",(0,t.jsx)(n.p,{children:"Checklist:"}),"\n",(0,t.jsxs)(n.ul,{className:"contains-task-list",children:["\n",(0,t.jsxs)(n.li,{className:"task-list-item",children:[(0,t.jsx)(n.input,{type:"checkbox",disabled:!0})," Ensure the new attribute is actually necessary, and nothing similar already exists"]}),"\n",(0,t.jsxs)(n.li,{className:"task-list-item",children:[(0,t.jsx)(n.input,{type:"checkbox",disabled:!0})," Update the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json",children:"Schema"})," with the parameters for your new option"]}),"\n",(0,t.jsxs)(n.li,{className:"task-list-item",children:[(0,t.jsx)(n.input,{type:"checkbox",disabled:!0})," If required, set a default or fallback value (usually in ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js",children:(0,t.jsx)(n.code,{children:"defaults.js"})}),")"]}),"\n",(0,t.jsxs)(n.li,{className:"task-list-item",children:[(0,t.jsx)(n.input,{type:"checkbox",disabled:!0})," Document the new value in ",(0,t.jsx)(n.a,{href:"/docs/configuring",children:(0,t.jsx)(n.code,{children:"configuring.md"})}),", and if required under the relevant section in the docs"]}),"\n",(0,t.jsxs)(n.li,{className:"task-list-item",children:[(0,t.jsx)(n.input,{type:"checkbox",disabled:!0})," Ensure your changes are backwards compatible, and that nothing breaks if the attribute isn't specified"]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"updating-dependencies",children:"Updating Dependencies"}),"\n",(0,t.jsxs)(n.p,{children:["Running ",(0,t.jsx)(n.code,{children:"yarn upgrade"})," will updated all dependencies based on the ranges specified in the ",(0,t.jsx)(n.code,{children:"package.json"}),". The ",(0,t.jsx)(n.code,{children:"yarn.lock"})," file will be updated, as will the contents of ",(0,t.jsx)(n.code,{children:"./node_modules"}),", for more info, see the ",(0,t.jsx)(n.a,{href:"https://classic.yarnpkg.com/en/docs/cli/upgrade/",children:"yarn upgrade documentation"}),". ",(0,t.jsx)(n.a,{href:"https://github.com/raineorshine/npm-check-updates",children:(0,t.jsx)(n.code,{children:"npm-check-updates"})})," is a useful tool to help with this.\nIt is important to thoroughly test after any big dependency updates."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"developing-netlify-cloud-functions",children:"Developing Netlify Cloud Functions"}),"\n",(0,t.jsx)(n.p,{children:"When Dashy is deployed to Netlify, it is effectively running as a static app, and therefore the server-side code for the Node.js endpoints is not available. However Netlify now supports serverless cloud lambda functions, which can be used to replace most functionality."}),"\n",(0,t.jsx)(n.h3,{id:"1-run-netlify-dev-server",children:"1. Run Netlify Dev Server"}),"\n",(0,t.jsxs)(n.p,{children:["First off all, install the Netlify CLI: ",(0,t.jsx)(n.code,{children:"npm install netlify-cli -g"}),"\nThen, from within the root of Dashy's directory, start the server, by running: ",(0,t.jsx)(n.code,{children:"netlify dev"})]}),"\n",(0,t.jsx)(n.h3,{id:"2-create-a-lambda-function",children:"2. Create a lambda function"}),"\n",(0,t.jsxs)(n.p,{children:["This should be saved in the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/services/serverless-functions",children:(0,t.jsx)(n.code,{children:"./services/serverless-functions"})})," directory"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"exports.handler = async () => ({\n statusCode: 200,\n body: 'Return some data here...',\n});\n"})}),"\n",(0,t.jsx)(n.h3,{id:"3-redirect-the-node-endpoint-to-the-function",children:"3. Redirect the Node endpoint to the function"}),"\n",(0,t.jsxs)(n.p,{children:["In the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/FEATURE/serverless-functions/netlify.toml",children:(0,t.jsx)(n.code,{children:"netlify.toml"})})," file, add a 301 redirect, with the path to the original Node.js endpoint, and the name of your cloud function"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-toml",children:'[[redirects]]\n from = "/status-check"\n to = "/.netlify/functions/cloud-status-check"\n status = 301\n force = true\n'})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"hiding-page-furniture-on-certain-routes",children:"Hiding Page Furniture on Certain Routes"}),"\n",(0,t.jsx)(n.p,{children:"For some pages (such as the login page, the minimal start page, etc) the basic page furniture, (like header, footer, nav, etc) is not needed. This section explains how you can hide furniture on a new view (step 1), or add a component that should be hidden on certain views (step 2)."}),"\n",(0,t.jsx)(n.h3,{id:"1-add-the-route-name-to-the-should-hide-array",children:"1. Add the route name to the should hide array"}),"\n",(0,t.jsxs)(n.p,{children:["In ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js",children:(0,t.jsx)(n.code,{children:"./src/utils/defaults.js"})}),", there's an array called ",(0,t.jsx)(n.code,{children:"hideFurnitureOn"}),". Append the name of the route (the same as it appears in ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/router.js",children:(0,t.jsx)(n.code,{children:"router.js"})}),") here."]}),"\n",(0,t.jsx)(n.h3,{id:"2-add-the-conditional-to-the-structural-component-to-hide",children:"2. Add the conditional to the structural component to hide"}),"\n",(0,t.jsx)(n.p,{children:"First, import the helper function:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"import { shouldBeVisible } from '@/utils/SectionHelpers';\n"})}),"\n",(0,t.jsx)(n.p,{children:"Then you can create a computed value, that calls this function, passing in the route name:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"export default {\n ...\n computed: {\n ...\n isVisible() {\n return shouldBeVisible(this.$route.name);\n },\n },\n};\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Finally, in the markup of your component, just add a ",(0,t.jsx)(n.code,{children:"v-if"})," statement, referencing your computed value"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-vue",children:'
\n ...\n
\n'})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"adding--using-environmental-variables",children:"Adding / Using Environmental Variables"}),"\n",(0,t.jsxs)(n.p,{children:["All environmental variables are optional. Currently there are not many environmental variables used, as most of the user preferences are stored under ",(0,t.jsx)(n.code,{children:"appConfig"})," in the ",(0,t.jsx)(n.code,{children:"conf.yml"})," file."]}),"\n",(0,t.jsxs)(n.p,{children:["You can set variables either in your environment, or using the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/.env",children:(0,t.jsx)(n.code,{children:".env"})})," file."]}),"\n",(0,t.jsxs)(n.p,{children:["Any environmental variables used by the frontend are preceded with ",(0,t.jsx)(n.code,{children:"VUE_APP_"}),". Vue will merge the contents of your ",(0,t.jsx)(n.code,{children:".env"})," file into the app in a similar way to the ",(0,t.jsx)(n.a,{href:"https://github.com/motdotla/dotenv",children:"'dotenv'"})," package, where any variables that you set on your system will always take preference over the contents of any ",(0,t.jsx)(n.code,{children:".env"})," file."]}),"\n",(0,t.jsxs)(n.p,{children:["If add any new variables, ensure that there is always a fallback (define it in ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js",children:(0,t.jsx)(n.code,{children:"defaults.js"})}),"), so as to not cause breaking changes. Don't commit the contents of your ",(0,t.jsx)(n.code,{children:".env"})," file to git, but instead take a few moments to document what you've added under the appropriate section. Try and follow the concepts outlined in the ",(0,t.jsx)(n.a,{href:"https://12factor.net/config",children:"12 factor app"}),"."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"building-a-widget",children:"Building a Widget"}),"\n",(0,t.jsx)(n.h3,{id:"step-0---prerequisites",children:"Step 0 - Prerequisites"}),"\n",(0,t.jsxs)(n.p,{children:["If this is your first time working on Dashy, then the ",(0,t.jsx)(n.a,{href:"/docs/developing",children:"Developing Docs"})," instructions for project setup and running. In short, you just need to clone the project, cd into it, install dependencies (",(0,t.jsx)(n.code,{children:"yarn"}),") and then start the development server (",(0,t.jsx)(n.code,{children:"yarn dev"}),")."]}),"\n",(0,t.jsxs)(n.p,{children:["To build a widget, you'll also need some basic knowledge of Vue.js. The ",(0,t.jsx)(n.a,{href:"https://vuejs.org/v2/guide/",children:"official Vue docs"})," provides a good starting point, as does ",(0,t.jsx)(n.a,{href:"https://www.taniarascia.com/getting-started-with-vue/",children:"this guide"})," by Tania Rascia"]}),"\n",(0,t.jsxs)(n.p,{children:["If you just want to jump straight in, then ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/commit/3da76ce2999f57f76a97454c0276301e39957b8e",children:"here"})," is a complete implementation of a new example widget, or take a look at the ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/blob/master/src/components/Widgets/XkcdComic.vue",children:(0,t.jsx)(n.code,{children:"XkcdComic.vue"})})," widget, which is pretty simple."]}),"\n",(0,t.jsx)(n.h3,{id:"step-1---create-widget",children:"Step 1 - Create Widget"}),"\n",(0,t.jsxs)(n.p,{children:["Firstly, create a new ",(0,t.jsx)(n.code,{children:".vue"})," file under ",(0,t.jsx)(n.a,{href:"https://github.com/Lissy93/dashy/tree/master/src/components/Widgets",children:(0,t.jsx)(n.code,{children:"./src/components/Widgets"})}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-vue",children:"\n\n - - - + + + -
Skip to main content

Alternate Views & Opening Methods

+

Alternate Views & Opening Methods

Views​

Dashy has three different views:

    @@ -54,6 +54,6 @@

    Even if the target is not set (or is set to sametab), you can still launch any given app in an alternative method. Either right-click to see all options, or use one of the keyboard shortcuts: Alt + Click will open the modal, and Ctrl + Click will open in a new tab.

    If you don't like the custom context menu, it can be disabled by setting appConfig.disableContextMenu: true.

    -

    If you get a 'Refused to Connect' error in the modal or workspace views, then the target app has it's X-Frame-Options HTTP set to block requests from embedded content. You can easily fix this by setting this header to ALLOW, for instructions on how to do so, see the Troubleshooting Docs.

+

If you get a 'Refused to Connect' error in the modal or workspace views, then the target app has it's X-Frame-Options HTTP set to block requests from embedded content. You can easily fix this by setting this header to ALLOW, for instructions on how to do so, see the Troubleshooting Docs.

\ No newline at end of file diff --git a/docs/authentication/index.html b/docs/authentication/index.html index 7ce3e2c3..d30139d4 100644 --- a/docs/authentication/index.html +++ b/docs/authentication/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Authentication

+

Authentication

+

⬆️ Back to Top

\ No newline at end of file diff --git a/docs/backup-restore/index.html b/docs/backup-restore/index.html index f3e1fe1f..22378732 100644 --- a/docs/backup-restore/index.html +++ b/docs/backup-restore/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Cloud Backup and Restore

+

Cloud Backup and Restore

Beyond the cloud backup/restore service, there are several other self-hosted options you can use to backup Dashy, and any other Docker container data. These are outlined in the Management docs, at: Docker Backup Options.

Dashy has a built-in feature for securely backing up your config to a hosted cloud service, and then restoring it on another instance. This feature is totally optional, and if you do not enable it, then Dashy will not make any external network requests.

This is useful not only for backing up your configuration off-site, but it also enables Dashy to be used without having write a YAML config file, and makes it possible to use a public hosted instance, without the need to self-host.

@@ -99,6 +99,6 @@

For more info, see the API Docs.

-

If you are using Postman, you may find this pre-made collection helpful in getting things setup.

+

If you are using Postman, you may find this pre-made collection helpful in getting things setup.

\ No newline at end of file diff --git a/docs/configuring/index.html b/docs/configuring/index.html index f283314e..90842f0e 100644 --- a/docs/configuring/index.html +++ b/docs/configuring/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Configuring

+

Configuring

All app configuration is specified in /user-data/conf.yml which is in YAML Format format. If you're using Docker, this file can be passed in as a volume. Changes can either be made directly to this file, or done through the UI. From the UI you can also export, backup, reset, validate and download your configuration file.

There are three ways to edit the config​

+

⬆️ Back to Top

\ No newline at end of file diff --git a/docs/contributing/index.html b/docs/contributing/index.html index 1a40f5ab..92ba584f 100644 --- a/docs/contributing/index.html +++ b/docs/contributing/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Contributing

+

Contributing

First off, thank you for considering contributing towards Dashy! 🙌 There are several ways that you can help out, and any contributions, however small will always be very much appreciated. You will be appropriately credited in the readme - huge thank you to everyone who has helped so far 💞

@@ -97,6 +97,6 @@ All content is located either in the Credits Page

Auto-generated contributors

Star-Gazers Over Time​

-

](https://seladb.github.io/StarTrack-js/#/preload?r=lissy93,dashy)

+

](https://seladb.github.io/StarTrack-js/#/preload?r=lissy93,dashy)

\ No newline at end of file diff --git a/docs/credits/index.html b/docs/credits/index.html index 0694e557..90fa50f6 100644 --- a/docs/credits/index.html +++ b/docs/credits/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Credits

+

Credits

Sponsors​

Sponsors

Contributors​

@@ -55,6 +55,6 @@

You​

-

Would you like to be listed here? Whatever your skill set, Dashy needs people like you to help support future development. Check out the Contributing Page for ways that you can get involved. Huge thank you to everyone who has already contributed! 💖

+

Would you like to be listed here? Whatever your skill set, Dashy needs people like you to help support future development. Check out the Contributing Page for ways that you can get involved. Huge thank you to everyone who has already contributed! 💖

\ No newline at end of file diff --git a/docs/deployment/index.html b/docs/deployment/index.html index c8137a16..bbaf32ba 100644 --- a/docs/deployment/index.html +++ b/docs/deployment/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Deployment

+

Deployment

Welcome to Dashy, so glad you're here :) Deployment is super easy, and there are several methods available depending on what type of system you're using. If you're self-hosting, then deploying with Docker (or similar container engine) is the recommended approach.

Quick Start​

If you want to skip the fuss, and get straight down to it, then you can spin up a new instance of Dashy by running:

@@ -243,6 +243,6 @@ To deploy Dashy to EdgeOne, use the following link

Browser Support​

JavaScript is required to run Dashy.

In terms of browser support, pretty much any browser released since 2018 should render content just fine. However, for Internet Explorer, only IE11+ is supported, yet performance here is still not optimal. The recommended browser is either a Chromium-based / Webkit browser (Chrome, Brave, Vivaldi, Edge, Yandex, etc), or Firefox or one of it's forks (FF-ESR, Tor, LibreWolf, etc). Recent versions of Safari and Opera are also supported, but with limited continuous testing.

-

+

\ No newline at end of file diff --git a/docs/developing/index.html b/docs/developing/index.html index 933f48f8..0c136669 100644 --- a/docs/developing/index.html +++ b/docs/developing/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Developing

+

Developing

This article outlines how to get Dashy running in a development environment, and outlines the basics of the architecture. If you're adding new features, you may want to check out the Development Guides docs, for tutorials covering basic tasks.

    @@ -220,6 +220,6 @@ For example, FEATURE/420_Awesome-feature or FIX/690_login-ser

    Known Warnings​

    When running the build command, several warnings appear. These are not errors, and do not affect the security or performance of the application. They will be addressed in a future update

    WARN A new version of sass-loader is available. Please upgrade for best experience. - Currently we're using an older version of SASS loader, since the more recent releases do not seem to be compatible with the Vue CLI's webpack configuration.

    -

    WARN asset size limit: The following asset(s) exceed the recommended size limit (244 KiB). - For the PWA to support Windows 10, a splash screen asset is required, and is quite large. This throws a warning, however PWA assets are not loaded until needed, so shouldn't have any impact on application performance. A similar warning is thrown for the Raleway font, and that is looking to be addressed.

+

WARN asset size limit: The following asset(s) exceed the recommended size limit (244 KiB). - For the PWA to support Windows 10, a splash screen asset is required, and is quite large. This throws a warning, however PWA assets are not loaded until needed, so shouldn't have any impact on application performance. A similar warning is thrown for the Raleway font, and that is looking to be addressed.

\ No newline at end of file diff --git a/docs/development-guides/index.html b/docs/development-guides/index.html index cfc880f5..cc4e5063 100644 --- a/docs/development-guides/index.html +++ b/docs/development-guides/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Development Guides

+

Development Guides

A series of short tutorials, to guide you through the most common development tasks.

Sections:

    @@ -206,6 +206,6 @@ First create a new computed property, like:

    If required, add a message showing that the component isn't available, using the AccessError component. E.g.

    import AccessError from '@/components/Configuration/AccessError';
    <AccessError v-else />
    -

    The $store.getters.permissions object also returns options for when and where config can be saved, using: allowWriteToDisk, and allowSaveLocally - both are booleans.

+

The $store.getters.permissions object also returns options for when and where config can be saved, using: allowWriteToDisk, and allowSaveLocally - both are booleans.

\ No newline at end of file diff --git a/docs/icons/index.html b/docs/icons/index.html index aa621aaa..04cfbfb0 100644 --- a/docs/icons/index.html +++ b/docs/icons/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Icons

+

Icons

Both sections and items can have an icon, which is specified using the icon attribute. Using icons improves the aesthetics of your UI and makes the app more intuitive to use. Dashy supports multiple different icon providers, usage instructions for which are explained here.

  • @@ -146,6 +146,6 @@

    Notes​

    If you are using icons from an external source, these will be fetched on initial page load automatically, if and when needed. But combining icons from multiple services may have a negative impact on performance.

    You can improve load speeds, by downloading your required icons, and serving them locally. Scaling icons to the minimum required dimensions (e.g. 128x128 or 64x64) will also greatly improve application load times.

    -

    For icons from external sources, please see the Privacy Policies and Licenses for that provider.

+

For icons from external sources, please see the Privacy Policies and Licenses for that provider.

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 03cf61bb..21672628 100644 --- a/docs/index.html +++ b/docs/index.html @@ -10,14 +10,14 @@ - - - + + + -
Skip to main content

Dashy Docs

Note, for the most up-to-date documentation, please see the GitHub repository

+
Skip to main content

Dashy Docs

Note, for the most up-to-date documentation, please see the GitHub repository

\ No newline at end of file diff --git a/docs/license/index.html b/docs/license/index.html index 206e183e..af8b9681 100644 --- a/docs/license/index.html +++ b/docs/license/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

License

+

License

MIT License​

Copyright (c) 2021 Alicia Sykes

Permission is hereby granted, free of charge, to any person obtaining a copy @@ -37,6 +37,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

-

For more information about the MIT License, see: https://opensource.org/licenses/MIT

+

For more information about the MIT License, see: https://opensource.org/licenses/MIT

\ No newline at end of file diff --git a/docs/management/index.html b/docs/management/index.html index 71bfd43e..48465eb9 100644 --- a/docs/management/index.html +++ b/docs/management/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

App Management

+

App Management

The following article is a primer on managing self-hosted apps. It covers everything from keeping the Dashy (or any other app) up-to-date, secure, backed up, to other topics like auto-starting, monitoring, log management, web server configuration and using custom domains.

Contents​

    @@ -470,6 +470,6 @@ For example: scp -r ./dist/* [username]@[server_ip]:/var/www/dashy/htmlYou may wish to upload your image to a container registry for easier access. Note that if you choose to do this on a public registry, please name your container something other than just 'dashy', to avoid confusion with the official image. You can push your build image, by running: docker push ghcr.io/OWNER/IMAGE_NAME:latest. You will first need to authenticate, this can be done by running echo $CR_PAT | docker login ghcr.io -u USERNAME --password-stdin, where CR_PAT is an environmental variable containing a token generated from your GitHub account. For more info, see the Container Registry Docs.

    ⬆️ Back to Top

    -
+
\ No newline at end of file diff --git a/docs/multi-language-support/index.html b/docs/multi-language-support/index.html index 5190efef..f04b3034 100644 --- a/docs/multi-language-support/index.html +++ b/docs/multi-language-support/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Internationalization

+

Internationalization

Internationalization is the process of making an application available in other languages. This is important, as not everyone is a native English speaker. This page explains how you can switch languages, how to add a new language, and how to make text translatable when writing a new component.

  • Setting your Language
    • @@ -81,6 +81,6 @@ For example: alert(this.$t('my-widget.awesome-text')).

    In ./src/components/Settings/SearchBar.vue:

    <template>
      <form>
        <label for="search-input">{{ $t('search.search-label') }}</label>
        <input
          v-model="searchValue"
          :placeholder="$t('search.search-placeholder')"
        />
      </form>
    </template>

    Then in ./src/assets/locales/en.json:

    -
    {
    "search": {
        "search-label": "Search",
        "search-placeholder": "Start typing to filter",
      },
      ...
    }
+
{
"search": {
    "search-label": "Search",
    "search-placeholder": "Start typing to filter",
  },
  ...
}
\ No newline at end of file diff --git a/docs/pages-and-sections/index.html b/docs/pages-and-sections/index.html index 50b11e1d..d811feca 100644 --- a/docs/pages-and-sections/index.html +++ b/docs/pages-and-sections/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Pages and Sections

+

Pages and Sections

Multi-Page Support​

You can have additional pages within your dashboard, with each having it's own config file. The config files for sub-pages can either be stored locally, or hosted separately. A link to each additional page will be displayed in the navigation bar.

You can edit additional pages using the interactive editor, exactly the same was as your primary page (so long as it's local). But please save changes to one page, before you start editing the next.

@@ -49,6 +49,6 @@ The config file must, of course be accessible from within Dashy. If your config 
- name: Coding
  icon: far fa-code
  items:
  - title: GitHub
    url: https://github.com/
  - title: StackOverflow
    url: http://stackoverflow.com/

But items can also be grouped together, referred to as sub-items. This is useful for a group of less frequently used items, which you don't want to take up too much space.

Item groups may also have an optional title.

-
- name: Coding
  icon: far fa-code
  items:
  - title: Normal Item 1
  - title: Normal Item 2
  - subItems:
    - title: JavaScript
      url: https://developer.mozilla.org
      icon: si-javascript
    - title: TypeScript
      url: https://www.typescriptlang.org/docs
      icon: si-typescript
    - title: Svelt
      url: https://svelte.dev/docs
      icon: si-svelte
    - title: Go
      url: https://go.dev/doc
      icon: si-go
+
- name: Coding
  icon: far fa-code
  items:
  - title: Normal Item 1
  - title: Normal Item 2
  - subItems:
    - title: JavaScript
      url: https://developer.mozilla.org
      icon: si-javascript
    - title: TypeScript
      url: https://www.typescriptlang.org/docs
      icon: si-typescript
    - title: Svelt
      url: https://svelte.dev/docs
      icon: si-svelte
    - title: Go
      url: https://go.dev/doc
      icon: si-go
\ No newline at end of file diff --git a/docs/privacy/index.html b/docs/privacy/index.html index aac9a619..4147dfdf 100644 --- a/docs/privacy/index.html +++ b/docs/privacy/index.html @@ -10,15 +10,15 @@ - - - + + + -
Skip to main content

Privacy & Security

+

Privacy & Security

Dashy was built with privacy in mind. Self-hosting your own apps and services is a great way to protect yourself from the mass data collection employed by big tech companies, and Dashy was designed to make self-hosting easier, by keeping your local services organized and accessible from a single place. The management docs contains a though guide on the steps you can take to secure your homelab.

Dashy operates on the premise, that no external data requests should ever be made, unless explicitly enabled by the user. In the interest of transparency, the code is 100% open source and clearly documented throughout.

@@ -321,6 +321,6 @@ Self-hosting your own apps and services is a great way to protect yourself from
  • Step-by-step instructions to reproduce the issue
  • Proof-of-concept or exploit code (if possible)
  • Impact of the issue, including how an attacker might exploit the issue
    • -
    +
    \ No newline at end of file diff --git a/docs/quick-start/index.html b/docs/quick-start/index.html index ee87e388..dd9f7768 100644 --- a/docs/quick-start/index.html +++ b/docs/quick-start/index.html @@ -10,15 +10,15 @@ - - - + + + -
    Skip to main content

    Quick Start

    +

    Quick Start

    Welcome to Dashy! So glad you're here 😊 In a couple of minutes, you'll have your new dashboard up and running 🚀

    TLDR; Run docker run -p 8080:8080 lissy93/dashy, then open http://localhost:8080

    @@ -121,6 +121,6 @@ The format on the config file is pretty straight forward. There are four root at
  • Deploy to GCP
  • Deploy to PWD
  • Deploy to Easypanel
    • -
    +
    \ No newline at end of file diff --git a/docs/release-workflow/index.html b/docs/release-workflow/index.html index f12e8a60..52ad91a7 100644 --- a/docs/release-workflow/index.html +++ b/docs/release-workflow/index.html @@ -10,15 +10,15 @@ - - - + + + -
    Skip to main content

    Releases and Workflows

    +
    +
    \ No newline at end of file diff --git a/docs/searching/index.html b/docs/searching/index.html index afd9a792..353c4a40 100644 --- a/docs/searching/index.html +++ b/docs/searching/index.html @@ -10,15 +10,15 @@ - - - + + + -
    Skip to main content

    Keyboard Shortcuts

    +

    Keyboard Shortcuts

    Searching​

    One of the primary purposes of Dashy is to allow you to quickly find and launch a given app. To make this as quick as possible, there is no need to touch the mouse, or press a certain key to begin searching - just start typing. Results will be filtered in real-time. No need to worry about case, special characters or small typos, these are taken care of, and your results should appear.

    @@ -63,6 +63,6 @@ 
    appConfig:
      webSearch:
        openUrlsDirectly: true

    You can clear your search term at any time, resting the UI to it's initial state, by pressing Esc. -This can also be used to close any open pop-up modals.

    +This can also be used to close any open pop-up modals.

    \ No newline at end of file diff --git a/docs/showcase/index.html b/docs/showcase/index.html index 1a71153d..a62b2326 100644 --- a/docs/showcase/index.html +++ b/docs/showcase/index.html @@ -10,15 +10,15 @@ - - - + + + -
    Skip to main content

    Dashy Showcase 🌟

    +

    Dashy Showcase 🌟

    @@ -208,6 +208,6 @@ Dashy is awesome!

    Template​

    If you're submitting a pull request, please use a format similar to this:

    -
    ### [Dashboard Name] (required)

    > Submitted by [@username](https://github.com/user) (optional)

    [An optional text description, or any interesting details] (optional)

    ![dashboard-screenshot](https://example.com/url-to-screenshot.png) (required)

    ---

    +
    ### [Dashboard Name] (required)

    > Submitted by [@username](https://github.com/user) (optional)

    [An optional text description, or any interesting details] (optional)

    ![dashboard-screenshot](https://example.com/url-to-screenshot.png) (required)

    ---

    \ No newline at end of file diff --git a/docs/status-indicators/index.html b/docs/status-indicators/index.html index 6e2f411c..f6fcded7 100644 --- a/docs/status-indicators/index.html +++ b/docs/status-indicators/index.html @@ -10,15 +10,15 @@ - - - + + + -
    Skip to main content

    Status Indicators

    +

    Status Indicators

    Dashy has an optional feature that can display a small icon next to each of your running services, indicating it's current status. This can be useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. The status feature will show response time, response code, online/ offline check and if applicable, a relevant error message.

    Enabling Status Indicators​

    @@ -57,6 +57,6 @@ For example, statusCheckHeaders: { 'X-Custom-Header': 'foob

    How it Works​

    When the app is loaded, if appConfig.statusCheck: true is set, or if any items have the statusCheck: true enabled, then Dashy will make a request, to https://[your-host-name]/status-check?url=[address-or-servce] (may al include GET params for headers and the secure flag), which in turn will ping that running service, and respond with a status code. Response time is calculated from the difference between start and end time of the request.

    When the response completes, an indicator will display next to each item. The color denotes the status: Yellow while waiting for the response to return, green if request was successful, red if it failed, and grey if it was unable to make the request all together.

    -

    All requests are made straight from your server, there is no intermediary. So providing you are hosting Dashy yourself, and are checking the status of other self-hosted services, there shouldn't be any privacy concerns. Requests are made asynchronously, so this won't have any significant impact on page load speeds. However recurring requests (using statusCheckInterval) may run more slowly if the interval between requests is very short.

    +

    All requests are made straight from your server, there is no intermediary. So providing you are hosting Dashy yourself, and are checking the status of other self-hosted services, there shouldn't be any privacy concerns. Requests are made asynchronously, so this won't have any significant impact on page load speeds. However recurring requests (using statusCheckInterval) may run more slowly if the interval between requests is very short.

    \ No newline at end of file diff --git a/docs/theming/index.html b/docs/theming/index.html index 7c986118..e9d7a01e 100644 --- a/docs/theming/index.html +++ b/docs/theming/index.html @@ -10,15 +10,15 @@ - - - + + + -

    Theming

    +
    +
    \ No newline at end of file diff --git a/docs/troubleshooting/index.html b/docs/troubleshooting/index.html index 57715867..3fd8165b 100644 --- a/docs/troubleshooting/index.html +++ b/docs/troubleshooting/index.html @@ -10,15 +10,15 @@ - - - + + + -

    Troubleshooting

    +

    Troubleshooting

    This document contains common problems and their solutions.
    Please ensure your issue isn't listed here, before opening a new ticket.

    @@ -379,6 +379,6 @@ You will be notified on your ticket, when a fix has been released.

  • git config --global user.email johndoe@example.com

    • For more info, see Git First Time Setup Docs.

    -

    Note that only contributions to the master / main branch or a project are counted

    +

    Note that only contributions to the master / main branch or a project are counted

    \ No newline at end of file diff --git a/docs/widgets/index.html b/docs/widgets/index.html index b9c60cd2..24c4ef75 100644 --- a/docs/widgets/index.html +++ b/docs/widgets/index.html @@ -10,15 +10,15 @@ - - - + + + -

    Widgets

    +

    Widgets

    Dashy has support for displaying dynamic content in the form of widgets. There are several built-in widgets available out-of-the-box as well as support for custom widgets to display stats from almost any service with an API.

    Contents​

      @@ -4116,6 +4116,6 @@ Add the Access-Control-Allow-Origin header, with the value of eithe

      For testing purposes, you can use an addon, which will disable the CORS checks. You can get the Allow-CORS extension for Chrome or Firefox, more details here

      Raising an Issue​

      -

      If you need to submit a bug report for a failing widget, then please include the full console output (see how) as well as the relevant parts of your config file. Before sending the request, ensure you've read the docs. If you're new to GitHub, an haven't previously contributed to the project, then please fist star the repo to avoid your ticket being closed by the anti-spam bot.

    +

    If you need to submit a bug report for a failing widget, then please include the full console output (see how) as well as the relevant parts of your config file. Before sending the request, ensure you've read the docs. If you're new to GitHub, an haven't previously contributed to the project, then please fist star the repo to avoid your ticket being closed by the anti-spam bot.

    \ No newline at end of file diff --git a/index.html b/index.html index b66030dc..a749338a 100644 --- a/index.html +++ b/index.html @@ -10,14 +10,14 @@ - - - + + + -

    Dashy

    The Ultimate Homepage for your Homelab

    Get StartedLive DemoSource CodeDocumentation
    Dashy is an open source, highly customizable, easy to use, privacy-respecting dashboard app.Keep Reading...
    201Contributors
    24.4kGitHub Stars
    15.3MDocker Downloads
    5MDoc Site Views

    Theming

    With tons of built-in themes to choose form, plus a UI color palette editor, you can have a unique looking dashboard in no time. There is also support for custom CSS, and since all properties use CSS variables, it is easy to override.
    Learn more in the Docs Docs
    Demo of Theming feature in Dashy

    Icons

    Dashy can auto-fetch icons from the favicon of each of your apps/ services. There is also native support for Font Awesome, Material Design Icons, emoji icons and of course normal images.
    Learn more in the Docs Docs
    Demo of Icons feature in Dashy

    Status Indicators

    Get an instant overview of the health of each of your apps with status indicators. Once enabled, a small dot next to each app will show weather it is up and online, with more info like response time visible on hover.
    Learn more in the Docs Docs
    Demo of Status Indicators feature in Dashy

    Authentication

    Need to protect your dashboard, the simple auth feature is super quick to enable, and has support for multiple users with granular controls. Dashy also has built-in support for Keycloak and other SSO providers.
    Learn more in the Docs Docs
    Screenshot Coming Soon

    Widgets

    Display dynamic content from any API-enabled service. Dashy comes bundled with 50+ pre-built widgets for self-hosted services, productivity and monitoring.
    Learn more in the Docs Docs
    Demo of Widgets feature in Dashy

    Alternate Views

    As well as the default home, there is also a minimal view, which makes a great fast-loading browser startpage. Plus a workspace view useful for working on multiple apps at once, all without having to leave your dashboard.
    Learn more in the Docs Docs
    Demo of Alternate Views feature in Dashy

    Launching Methods

    Choose how to launch each of your apps by default, or right click for all options. Apps can be opened in a new tab, the same tab, a quick pop-up modal or in the workspace view.
    Learn more in the Docs Docs
    Demo of Launching Methods feature in Dashy

    Search & Shortcuts

    To search, just start typing, results will be filtered instantly. Use the arrow keys or tab to navigate through results, and press enter to launch. You can also create custom shortcuts for frequently used apps, or add custom tags for easier searching. Dashy can also be used to search the web using your favorite search engine.
    Learn more in the Docs Docs
    Demo of Search & Shortcuts feature in Dashy

    Cloud Backup & Sync

    There is an optional, end-to-end encrypted, free backup cloud service. This enables you to have your config backed up off-site, and to sync data between multiple instances easily.
    Learn more in the Docs Docs
    Screenshot Coming Soon

    Configuration

    Dashy's config is specified in a simple YAML file. But you can also configure the directly through the UI, and have changes written to, and backed up on disk. Real-time validation and hints are in place to help you.
    Learn more in the Docs Docs
    Demo of Configuration feature in Dashy

    Multi-Language Support

    Dashy's UI has been translated into several languages by several amazing contributors. Currently English, German, French, Dutch and Slovenian are supported. Your language should be applied automatically, or you can change it in the config menu.
    Learn more in the Docs Docs
    Screenshot Coming Soon

    Easy Deployment

    Although Dashy can be easily run on bare metal, the quickest method of getting started is with Docker. Just run `docker run -p 8080:80 lissy93/dashy` to pull, build and and run Dashy.
    Learn more in the Docs Docs
    Screenshot Coming Soon

    Customizable Layouts

    Structure your dashboard to fit your use case. From the UI, you can choose between different layouts, item sizes, show/ hide components, switch themes plus more. You can customize pretty much every area of your dashboard. There are config options for custom header, footer, nav bar links, title etc. You can also choose to hide any elements you don't need.
    Learn more in the Docs Docs
    Screenshot Coming Soon

    Powered by You

    Support us

    If you've found Dashy useful, consider contributing, or dropping us a star!

    Author

    Dashy was initially built by me, Alicia Sykes (@Lissy93 on GitHub), I build free and open source apps, focused on security, privacy, Linux and self-hosting.

    Sponsor More Apps

    Sponsors

    Huge thanks to the following sponsors for supporting Dashy's development 💖

    UlisesGascon's avatarUlises Gascónbmcgonag's avatarBrian McGonagillUhOhSpaghettiCode's avatarNo Thanksundefined's avatarEnvisage Cloud Solutionsgl0bal01's avatarglobal01hesreallyhim's avatarReally HimLambdaTest-Inc's avatarTestMu AI Open Source Office (Formerly LambdaTest)hudsonrock-partnerships's avatarhudsonrock-partnershipsundefined's avatarTerminal TroveBigoudOps's avatarJohn BigoudOpsfrankdez93's avatarfrankdez93undefined's avatarSSD Nodesundefined's avatarUmbrelDaechler's avatarDaechlerhelixzz's avatarHeliXZzvlad-tim's avatarVladelvito's avatarelvitoaraguaci's avatararaguaciInDieTasten's avatarInDieTastenbile0026's avatarZach Bilesanivar's avatarAnivar Aravind

    Contributors

    Dashy was made possible, thanks to these wonderful contributors 🩵

    ⭐Lissy93's avatarLissy93 (2587)⭐liss-bot's avatarliss-bot (646)⭐aspenyang's avataraspenyang (41)⭐CrazyWolf13's avatarCrazyWolf13 (32)⭐marekful's avatarmarekful (27)⭐EVOTk's avatarEVOTk (24)⭐snyk-bot's avatarsnyk-bot (24)⭐azerioxal's avatarazerioxal (22)⭐m42e's avatarm42e (19)⭐pinarruiz's avatarpinarruiz (16)⭐casmbu's avatarcasmbu (14)⭐ricardodemauro's avatarricardodemauro ⭐imjimmeh's avatarimjimmeh ⭐kashif-se's avatarkashif-se ⭐josuablejeru's avatarjosuablejeru ⭐lammersbjorn's avatarlammersbjorn ⭐ThrustVector's avatarThrustVector ⭐albcp's avataralbcp Cereal916's avatarCereal916 lordpansar's avatarlordpansar jammo2k5's avatarjammo2k5 evroon's avatarevroon alhazmy13's avataralhazmy13 alayham's avataralayham altearius's avataraltearius LinuxSBC's avatarLinuxSBC UrekD's avatarUrekD shumittaher's avatarshumittaher hockwill's avatarhockwill z3r0l1nk's avatarz3r0l1nk zcq100's avatarzcq100 wozboz's avatarwozboz he0119's avatarhe0119 dkadioglu's avatardkadioglu conlan0's avatarconlan0 Totto16's avatarTotto16 toddejohnson's avatartoddejohnson remygrandin's avatarremygrandin aviolaris's avataraviolaris Tracreed's avatarTracreed dasunsrule32's avatardasunsrule32 rubenandre's avatarrubenandre rtm516's avatarrtm516 onedr0p's avataronedr0p stanly0726's avatarstanly0726 kt-alt's avatarkt-alt Bogyie's avatarBogyie webysther's avatarwebysther jtuzar's avatarjtuzar apgyorfi's avatarapgyorfi lucolvin's avatarlucolvin Kf637's avatarKf637 JDB321Sailor's avatarJDB321Sailor berksmbl's avatarberksmbl alucarddelta's avataralucarddelta hockeymikey's avatarhockeymikey itsmejoeeey's avataritsmejoeeey k073l's avatark073l m42cel's avatarm42cel mmihaly's avatarmmihaly noblepower1337's avatarnoblepower1337 patrickheeney's avatarpatrickheeney rokiden's avatarrokiden zigotica's avatarzigotica BySempron's avatarBySempron ssrangisetti's avatarssrangisetti a-mnich's avatara-mnich alexdelprete's avataralexdelprete BOZG's avatarBOZG moemoeq's avatarmoemoeq daentech's avatardaentech deneor's avatardeneor GuilhermeLCS95's avatarGuilhermeLCS95 kit494way's avatarkit494way pwhelan's avatarpwhelan rnowotniak's avatarrnowotniak TJonesy's avatarTJonesy twsouthwick's avatartwsouthwick thomaswienecke's avatarthomaswienecke armageddon421's avatararmageddon421 domportera's avatardomportera rubjo's avatarrubjo turnrye's avatarturnrye sachahjkl's avatarsachahjkl shazzx's avatarshazzx ThinkSalat's avatarThinkSalat sxravan's avatarsxravan royshreyaa's avatarroyshreyaa Smexhy's avatarSmexhy TheZachAttack01's avatarTheZachAttack01 stavros-k's avatarstavros-k XenonR's avatarXenonR StevKast's avatarStevKast ThibautSnoeijs's avatarThibautSnoeijs RoubenRehman's avatarRoubenRehman RobLoach's avatarRobLoach PrynsTag's avatarPrynsTag PlusaN's avatarPlusaN onurege3467's avataronurege3467 oka4shi's avataroka4shi pedorich-n's avatarpedorich-n bubylou's avatarbubylou michaelfeinbier's avatarmichaelfeinbier stinkybernie's avatarstinkybernie miclav's avatarmiclav imsakg's avatarimsakg AmadeusGraves's avatarAmadeusGraves click0's avatarclick0 tazboyz16's avatartazboyz16 sur1v's avatarsur1v soaibsafi's avatarsoaibsafi sasetz's avatarsasetz s-weigand's avatars-weigand pablomalo's avatarpablomalo onwp's avataronwp nOw-Ay's avatarnOw-Ay markxoe's avatarmarkxoe ivyturner's avatarivyturner kxenoxx's avatarkxenoxx jrobles98's avatarjrobles98 jnach's avatarjnach imlonghao's avatarimlonghao icy-comet's avataricy-comet huangshaohuai's avatarhuangshaohuai flechaig's avatarflechaig baifengheixi's avatarbaifengheixi aypt's avataraypt allozavrr's avatarallozavrr XertDev's avatarXertDev willbrowningme's avatarwillbrowningme vishwamartur's avatarvishwamartur pvillaverde's avatarpvillaverde emiran-orange's avataremiran-orange edugof's avataredugof Dylan-Bs's avatarDylan-Bs dyauss's avatardyauss ddenev's avatarddenev dougaldhub's avatardougaldhub dkyeremeh's avatardkyeremeh deepsourcebot's avatardeepsourcebot DawidPietrykowski's avatarDawidPietrykowski skaarj1989's avatarskaarj1989 The127's avatarThe127 yeralin's avataryeralin danfein's avatardanfein clsty's avatarclsty bskim45's avatarbskim45 BhasherBEL's avatarBhasherBEL BeginCI's avatarBeginCI BRAVO68WEB's avatarBRAVO68WEB AaronPorts's avatarAaronPorts AndreasdeReus's avatarAndreasdeReus alydemah's avataralydemah Alexis-BX's avatarAlexis-BX 5idereal's avatar5idereal 0n1cOn3's avatar0n1cOn3 maximemoreillon's avatarmaximemoreillon Glitch3dPenguin's avatarGlitch3dPenguin pho3nixf1re's avatarpho3nixf1re MatesMotionless's avatarMatesMotionless markusdd's avatarmarkusdd asenov's avatarasenov luispabon's avatarluispabon LeoColman's avatarLeoColman larsreinhardt's avatarlarsreinhardt KierenConnell's avatarKierenConnell kieraneglin's avatarkieraneglin SharpCoder's avatarSharpCoder jonas-schulze's avatarjonas-schulze johnhorton2010's avatarjohnhorton2010 Singebob's avatarSingebob Hellhium's avatarHellhium jjmung's avatarjjmung b1thunt3r's avatarb1thunt3r Compunctus's avatarCompunctus nealian's avatarnealian ip2location-com's avatarip2location-com FraglyG's avatarFraglyG hubortje's avatarhubortje gbrown09's avatargbrown09 FormatToday's avatarFormatToday
    +

    Dashy

    The Ultimate Homepage for your Homelab

    Get StartedLive DemoSource CodeDocumentation
    Dashy is an open source, highly customizable, easy to use, privacy-respecting dashboard app.Keep Reading...
    201Contributors
    24.4kGitHub Stars
    15.3MDocker Downloads
    5MDoc Site Views

    Theming

    With tons of built-in themes to choose form, plus a UI color palette editor, you can have a unique looking dashboard in no time. There is also support for custom CSS, and since all properties use CSS variables, it is easy to override.
    Learn more in the Docs Docs
    Demo of Theming feature in Dashy

    Icons

    Dashy can auto-fetch icons from the favicon of each of your apps/ services. There is also native support for Font Awesome, Material Design Icons, emoji icons and of course normal images.
    Learn more in the Docs Docs
    Demo of Icons feature in Dashy

    Status Indicators

    Get an instant overview of the health of each of your apps with status indicators. Once enabled, a small dot next to each app will show weather it is up and online, with more info like response time visible on hover.
    Learn more in the Docs Docs
    Demo of Status Indicators feature in Dashy

    Authentication

    Need to protect your dashboard, the simple auth feature is super quick to enable, and has support for multiple users with granular controls. Dashy also has built-in support for Keycloak and other SSO providers.
    Learn more in the Docs Docs
    Screenshot Coming Soon

    Widgets

    Display dynamic content from any API-enabled service. Dashy comes bundled with 50+ pre-built widgets for self-hosted services, productivity and monitoring.
    Learn more in the Docs Docs
    Demo of Widgets feature in Dashy

    Alternate Views

    As well as the default home, there is also a minimal view, which makes a great fast-loading browser startpage. Plus a workspace view useful for working on multiple apps at once, all without having to leave your dashboard.
    Learn more in the Docs Docs
    Demo of Alternate Views feature in Dashy

    Launching Methods

    Choose how to launch each of your apps by default, or right click for all options. Apps can be opened in a new tab, the same tab, a quick pop-up modal or in the workspace view.
    Learn more in the Docs Docs
    Demo of Launching Methods feature in Dashy

    Search & Shortcuts

    To search, just start typing, results will be filtered instantly. Use the arrow keys or tab to navigate through results, and press enter to launch. You can also create custom shortcuts for frequently used apps, or add custom tags for easier searching. Dashy can also be used to search the web using your favorite search engine.
    Learn more in the Docs Docs
    Demo of Search & Shortcuts feature in Dashy

    Cloud Backup & Sync

    There is an optional, end-to-end encrypted, free backup cloud service. This enables you to have your config backed up off-site, and to sync data between multiple instances easily.
    Learn more in the Docs Docs
    Screenshot Coming Soon

    Configuration

    Dashy's config is specified in a simple YAML file. But you can also configure the directly through the UI, and have changes written to, and backed up on disk. Real-time validation and hints are in place to help you.
    Learn more in the Docs Docs
    Demo of Configuration feature in Dashy

    Multi-Language Support

    Dashy's UI has been translated into several languages by several amazing contributors. Currently English, German, French, Dutch and Slovenian are supported. Your language should be applied automatically, or you can change it in the config menu.
    Learn more in the Docs Docs
    Screenshot Coming Soon

    Easy Deployment

    Although Dashy can be easily run on bare metal, the quickest method of getting started is with Docker. Just run `docker run -p 8080:80 lissy93/dashy` to pull, build and and run Dashy.
    Learn more in the Docs Docs
    Screenshot Coming Soon

    Customizable Layouts

    Structure your dashboard to fit your use case. From the UI, you can choose between different layouts, item sizes, show/ hide components, switch themes plus more. You can customize pretty much every area of your dashboard. There are config options for custom header, footer, nav bar links, title etc. You can also choose to hide any elements you don't need.
    Learn more in the Docs Docs
    Screenshot Coming Soon

    Powered by You

    Support us

    If you've found Dashy useful, consider contributing, or dropping us a star!

    Author

    Dashy was initially built by me, Alicia Sykes (@Lissy93 on GitHub), I build free and open source apps, focused on security, privacy, Linux and self-hosting.

    Sponsor More Apps

    Sponsors

    Huge thanks to the following sponsors for supporting Dashy's development 💖

    UlisesGascon's avatarUlises Gascónbmcgonag's avatarBrian McGonagillUhOhSpaghettiCode's avatarNo Thanksundefined's avatarEnvisage Cloud Solutionsgl0bal01's avatarglobal01hesreallyhim's avatarReally HimLambdaTest-Inc's avatarTestMu AI Open Source Office (Formerly LambdaTest)hudsonrock-partnerships's avatarhudsonrock-partnershipsundefined's avatarTerminal TroveBigoudOps's avatarJohn BigoudOpsfrankdez93's avatarfrankdez93undefined's avatarSSD Nodesundefined's avatarUmbrelDaechler's avatarDaechlerhelixzz's avatarHeliXZzvlad-tim's avatarVladelvito's avatarelvitoaraguaci's avatararaguaciInDieTasten's avatarInDieTastenbile0026's avatarZach Bilesanivar's avatarAnivar Aravind

    Contributors

    Dashy was made possible, thanks to these wonderful contributors 🩵

    ⭐Lissy93's avatarLissy93 (2587)⭐liss-bot's avatarliss-bot (646)⭐aspenyang's avataraspenyang (41)⭐CrazyWolf13's avatarCrazyWolf13 (32)⭐marekful's avatarmarekful (27)⭐EVOTk's avatarEVOTk (24)⭐snyk-bot's avatarsnyk-bot (24)⭐azerioxal's avatarazerioxal (22)⭐m42e's avatarm42e (19)⭐pinarruiz's avatarpinarruiz (16)⭐casmbu's avatarcasmbu (14)⭐ricardodemauro's avatarricardodemauro ⭐imjimmeh's avatarimjimmeh ⭐kashif-se's avatarkashif-se ⭐josuablejeru's avatarjosuablejeru ⭐lammersbjorn's avatarlammersbjorn ⭐ThrustVector's avatarThrustVector ⭐albcp's avataralbcp Cereal916's avatarCereal916 lordpansar's avatarlordpansar jammo2k5's avatarjammo2k5 evroon's avatarevroon alhazmy13's avataralhazmy13 alayham's avataralayham altearius's avataraltearius LinuxSBC's avatarLinuxSBC UrekD's avatarUrekD shumittaher's avatarshumittaher hockwill's avatarhockwill z3r0l1nk's avatarz3r0l1nk zcq100's avatarzcq100 wozboz's avatarwozboz he0119's avatarhe0119 dkadioglu's avatardkadioglu conlan0's avatarconlan0 Totto16's avatarTotto16 toddejohnson's avatartoddejohnson remygrandin's avatarremygrandin aviolaris's avataraviolaris Tracreed's avatarTracreed dasunsrule32's avatardasunsrule32 rubenandre's avatarrubenandre rtm516's avatarrtm516 onedr0p's avataronedr0p stanly0726's avatarstanly0726 kt-alt's avatarkt-alt Bogyie's avatarBogyie webysther's avatarwebysther jtuzar's avatarjtuzar apgyorfi's avatarapgyorfi lucolvin's avatarlucolvin Kf637's avatarKf637 JDB321Sailor's avatarJDB321Sailor berksmbl's avatarberksmbl alucarddelta's avataralucarddelta hockeymikey's avatarhockeymikey itsmejoeeey's avataritsmejoeeey k073l's avatark073l m42cel's avatarm42cel mmihaly's avatarmmihaly noblepower1337's avatarnoblepower1337 patrickheeney's avatarpatrickheeney rokiden's avatarrokiden zigotica's avatarzigotica BySempron's avatarBySempron ssrangisetti's avatarssrangisetti a-mnich's avatara-mnich alexdelprete's avataralexdelprete BOZG's avatarBOZG moemoeq's avatarmoemoeq daentech's avatardaentech deneor's avatardeneor GuilhermeLCS95's avatarGuilhermeLCS95 kit494way's avatarkit494way pwhelan's avatarpwhelan rnowotniak's avatarrnowotniak TJonesy's avatarTJonesy twsouthwick's avatartwsouthwick thomaswienecke's avatarthomaswienecke armageddon421's avatararmageddon421 domportera's avatardomportera rubjo's avatarrubjo turnrye's avatarturnrye sachahjkl's avatarsachahjkl shazzx's avatarshazzx ThinkSalat's avatarThinkSalat sxravan's avatarsxravan royshreyaa's avatarroyshreyaa Smexhy's avatarSmexhy TheZachAttack01's avatarTheZachAttack01 stavros-k's avatarstavros-k XenonR's avatarXenonR StevKast's avatarStevKast ThibautSnoeijs's avatarThibautSnoeijs RoubenRehman's avatarRoubenRehman RobLoach's avatarRobLoach PrynsTag's avatarPrynsTag PlusaN's avatarPlusaN onurege3467's avataronurege3467 oka4shi's avataroka4shi pedorich-n's avatarpedorich-n bubylou's avatarbubylou michaelfeinbier's avatarmichaelfeinbier stinkybernie's avatarstinkybernie miclav's avatarmiclav imsakg's avatarimsakg AmadeusGraves's avatarAmadeusGraves click0's avatarclick0 tazboyz16's avatartazboyz16 sur1v's avatarsur1v soaibsafi's avatarsoaibsafi sasetz's avatarsasetz s-weigand's avatars-weigand pablomalo's avatarpablomalo onwp's avataronwp nOw-Ay's avatarnOw-Ay markxoe's avatarmarkxoe ivyturner's avatarivyturner kxenoxx's avatarkxenoxx jrobles98's avatarjrobles98 jnach's avatarjnach imlonghao's avatarimlonghao icy-comet's avataricy-comet huangshaohuai's avatarhuangshaohuai flechaig's avatarflechaig baifengheixi's avatarbaifengheixi aypt's avataraypt allozavrr's avatarallozavrr XertDev's avatarXertDev willbrowningme's avatarwillbrowningme vishwamartur's avatarvishwamartur pvillaverde's avatarpvillaverde emiran-orange's avataremiran-orange edugof's avataredugof Dylan-Bs's avatarDylan-Bs dyauss's avatardyauss ddenev's avatarddenev dougaldhub's avatardougaldhub dkyeremeh's avatardkyeremeh deepsourcebot's avatardeepsourcebot DawidPietrykowski's avatarDawidPietrykowski skaarj1989's avatarskaarj1989 The127's avatarThe127 yeralin's avataryeralin danfein's avatardanfein clsty's avatarclsty bskim45's avatarbskim45 BhasherBEL's avatarBhasherBEL BeginCI's avatarBeginCI BRAVO68WEB's avatarBRAVO68WEB AaronPorts's avatarAaronPorts AndreasdeReus's avatarAndreasdeReus alydemah's avataralydemah Alexis-BX's avatarAlexis-BX 5idereal's avatar5idereal 0n1cOn3's avatar0n1cOn3 maximemoreillon's avatarmaximemoreillon Glitch3dPenguin's avatarGlitch3dPenguin pho3nixf1re's avatarpho3nixf1re MatesMotionless's avatarMatesMotionless markusdd's avatarmarkusdd asenov's avatarasenov luispabon's avatarluispabon LeoColman's avatarLeoColman larsreinhardt's avatarlarsreinhardt KierenConnell's avatarKierenConnell kieraneglin's avatarkieraneglin SharpCoder's avatarSharpCoder jonas-schulze's avatarjonas-schulze johnhorton2010's avatarjohnhorton2010 Singebob's avatarSingebob Hellhium's avatarHellhium jjmung's avatarjjmung b1thunt3r's avatarb1thunt3r Compunctus's avatarCompunctus nealian's avatarnealian ip2location-com's avatarip2location-com FraglyG's avatarFraglyG hubortje's avatarhubortje gbrown09's avatargbrown09 FormatToday's avatarFormatToday
    \ No newline at end of file diff --git a/markdown-page/index.html b/markdown-page/index.html index 8de8b503..0bb12eb5 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -10,15 +10,15 @@ - - - + + + -

    Markdown page example

    +

    Markdown page example

    You don't need React to write simple standalone pages.

    \ No newline at end of file diff --git a/search/index.html b/search/index.html index feb4258e..e4a15375 100644 --- a/search/index.html +++ b/search/index.html @@ -10,14 +10,14 @@ - - - + + + -

    Search the documentation

    +

    Search the documentation

    \ No newline at end of file diff --git a/survey/index.html b/survey/index.html index 8773c018..d68818a5 100644 --- a/survey/index.html +++ b/survey/index.html @@ -10,14 +10,14 @@ - - - + + + -
    +
    \ No newline at end of file diff --git a/updates/index.html b/updates/index.html index be642b54..8afaaac7 100644 --- a/updates/index.html +++ b/updates/index.html @@ -10,14 +10,14 @@ - - - + + + -

    Project Updates

    The latest releases and updates from Dashy

    March 2026

    3.2.1Tag
    View on:GitHubDockerHub
    c608879⬆️ Bump version to 3.2.1liss-botliss-bot ·
    d8bf8ea🔀 Merge pull request #2027 from Lissy93/update/remove-axiosLissy93Lissy93 ·
    c07f3dc🥅 Handle null headersLissy93Lissy93 ·
    c42e201➖ Uninstall Axios depLissy93Lissy93 ·
    63952fb🚚 Replace instances of Axios with new request handlers across everywhereLissy93Lissy93 ·
    a0a6d48⚡ Creates client-side request wrapper instead of axiosLissy93Lissy93 ·
    47078a4⚡ Creates server-side request wrapper instead of axiosLissy93Lissy93 ·
    Release 3.2.0Release3.2.0

    What's Changed Update Github trending widget by @alhazmy13 in https://github.com/Lissy93/dashy/pull/1562 Bump simple-icons to 12.2.0 by @michaelfeinbier in https://github.com/Lissy93/dashy/pull/16

    liss-botliss-botView on:GitHubDockerHub
    24d7414🔀 Merge pull request #2021 from Lissy93/fix/small-issuesLissy93Lissy93 ·
    75a9e1a⬆️ Bump to 3.2.0Lissy93Lissy93 ·
    37e6a9f🐛 Fixes sabnzbd path prefix configurable (#1965)Lissy93Lissy93 ·
    1cf089d🐛 Fixes missing copyclipboard in workspace view (#1851)Lissy93Lissy93 ·
    551433e🐛 Fixes allow target to be empty (#1895)Lissy93Lissy93 ·
    0b9a703🔐 Updates security contact info (#1994)Lissy93Lissy93 ·
    b578702✨ Adds "New Window" as opening method (#1970)Lissy93Lissy93 ·
    271eb26🐛 Fixes duplicate forecase entries in weather (#1887)Lissy93Lissy93 ·
    1f30baf🐛 Fixes custom search engine prevening bangs (#1980)Lissy93Lissy93 ·
    f5f98b2🌐 Updates alias for Chinese (#1920)Lissy93Lissy93 ·
    3.1.15Tag
    View on:GitHubDockerHub
    d1e1313⬆️ Bump version to 3.1.15liss-botliss-bot ·
    0361575🔀 Merge pull request #2020 from Lissy93/fix/external-auth-mem-spikeLissy93Lissy93 ·
    9c87642🐛 Deep copy auth.users to prevent infinite loop (#1995)Lissy93Lissy93 ·
    3.1.14Tag
    View on:GitHubDockerHub
    702642c⬆️ Bump version to 3.1.14liss-botliss-bot ·
    3d8427f🔀 Merge pull request #2019 from Lissy93/fix/remove-clearbitLissy93Lissy93 ·
    b43c23e🔀 Merge pull request #2018 from Lissy93/dependabot/npm_and_yarn/path-to-regexp-0.1.13Lissy93Lissy93 ·
    bf40469Merge pull request #2017 from Lissy93/dependabot/npm_and_yarn/happy-dom-20.8.9Lissy93Lissy93 ·
    cfed398🔥 Removes Clearbit for icons (#1837)Lissy93Lissy93 ·
    98bff09Bump path-to-regexp from 0.1.12 to 0.1.13dependabot[bot]dependabot[bot] ·
    4f2d3c6Bump happy-dom from 17.6.3 to 20.8.9dependabot[bot]dependabot[bot] ·
    0622aa7🔀 Merge pull request #2016 from Lissy93/dependabot/npm_and_yarn/node-forge-1.4.0Lissy93Lissy93 ·
    6809001Bump node-forge from 1.3.3 to 1.4.0dependabot[bot]dependabot[bot] ·
    3724764🔀 Merge pull request #2013 from Lissy93/dependabot/npm_and_yarn/picomatch-2.3.2Lissy93Lissy93 ·
    4a67047Bump picomatch from 2.3.1 to 2.3.2dependabot[bot]dependabot[bot] ·
    3.1.13Tag
    View on:GitHubDockerHub
    1f5f3aa⬆️ Bump version to 3.1.13liss-botliss-bot ·
    a90f585🔀 Merge pull request #2012 from Lissy93/fix/pi-hole-api-key-env-varLissy93Lissy93 ·
    50c9ecd🐛 Fixed Pi Hole key not read from env var (#1934)Lissy93Lissy93 ·
    b1eb3f2🐛 Fixed Pi Hole key not read from env var (#1934)Lissy93Lissy93 ·
    7d48a82Merge pull request #2010 from Lissy93/dependabot/npm_and_yarn/flatted-3.4.2Lissy93Lissy93 ·
    165fe3aBump flatted from 3.4.0 to 3.4.2dependabot[bot]dependabot[bot] ·
    3.1.12Tag
    View on:GitHubDockerHub
    bf7977c⬆️ Bump version to 3.1.12liss-botliss-bot ·
    a6a10c2🔀 Merge pull request #1922 from JasperX777/jasper/feature-1821-glances-uptimeLissy93Lissy93 ·
    7b2ab67✨ Finishes implementing glances uptime widgetLissy93Lissy93 ·
    9417525📝 Adds Glances uptime docs into widgetsLissy93Lissy93 ·
    b760786🔄️ Merge branch 'master' of github.com:lissy93/dashy into jasper/feature-1821-glances-uptimeLissy93Lissy93 ·
    aed7fca👷 Update CI build of docs site, with --fetch-depthLissy93Lissy93 ·
    51b89d2🔀 Merge pull request #1985 from jonas-schulze/update-simple-iconsLissy93Lissy93 ·
    d40e42b⬆️ Updates simple-icons, from 14.4.0 to 16.6.0Lissy93Lissy93 ·
    f967be1🔄️ Merge branch 'master' of github.com:lissy93/dashy into update-simple-iconsLissy93Lissy93 ·
    3.1.11Tag
    View on:GitHubDockerHub
    aeec9fd⬆️ Bump version to 3.1.11liss-botliss-bot ·
    48286e8🔀 Merge pull request #1977 from noblepower1337/patch-2Lissy93Lissy93 ·
    e236b3c🌐 Finishes implementing Kyrgyz translations, thanks @noblepower1337Lissy93Lissy93 ·
    cee6bee🔄️ Merge branch 'master' of github.com:lissy93/dashy into patch-2Lissy93Lissy93 ·
    762d60e🔀 Merge branch 'master' of github.com:lissy93/dashyLissy93Lissy93 ·
    3.1.10Tag
    View on:GitHubDockerHub
    d22bcac⬆️ Bump version to 3.1.10liss-botliss-bot ·
    ddfffd1🔀 Merge pull request #1969 from JDB321Sailor/masterLissy93Lissy93 ·
    43068f6♻️ Refactors to remove unnecisary intermediaty varianple for filter tiles in sidebarLissy93Lissy93 ·
    df997b6🔄 Rebases from masterLissy93Lissy93 ·
    1ac4001🔄 Rebases from masterLissy93Lissy93 ·
    0084cb3📝 Updates config info and paths in docsLissy93Lissy93 ·
    66af716🖼️ Update img sources for widget screenshotsLissy93Lissy93 ·
    3.1.9Tag
    View on:GitHubDockerHub
    b0f8011⬆️ Bump version to 3.1.9liss-botliss-bot ·
    ecb0970🔀 Merge pull request #1928 from shumittaher/bugcolsLissy93Lissy93 ·
    45dcc7c📝 Updates docs with correct col countLissy93Lissy93 ·
    e07f298🥅 Adds safty check when displayData undefinedLissy93Lissy93 ·
    7ff6141🔄️ Merge branch 'master' of github.com:lissy93/dashy into bugcolsLissy93Lissy93 ·
    3.1.8Tag
    View on:GitHubDockerHub
    8d52976⬆️ Bump version to 3.1.8liss-botliss-bot ·
    d95c198🔀 Merge pull request #1931 from JasperX777/jasper/feature-1853-compact-glanceLissy93Lissy93 ·
    9152bd6⚡️ Split GlCompactMetrics to seperate requests, to handle individual failures okLissy93Lissy93 ·
    678786f📝 Adds missing docs for GlCompactMetrics widgetLissy93Lissy93 ·
    a41111f♻️ GlCompactMetrics to use WidgetBase shared methodsLissy93Lissy93 ·
    fa118dd🔄️ Merge branch 'master' of github.com:lissy93/dashy into jasper/feature-1853-compact-glanceLissy93Lissy93 ·
    3.1.7Tag
    View on:GitHubDockerHub
    d24ac5d⬆️ Bump version to 3.1.7liss-botliss-bot ·
    c179d6b🔀 Merge pull request #2007 from Lissy93/ref/docs-schema-fixesLissy93Lissy93 ·
    3.1.6Tag
    View on:GitHubDockerHub
    3cabcae⬆️ Bump version to 3.1.6liss-botliss-bot ·
    e544c87🔀 Merge pull request #1954 from sypticus/FIX/1953_glances_alerts_api_updateLissy93Lissy93 ·
    bf10fc1🐛 Fix to update alert end / not beginLissy93Lissy93 ·
    5a5f734🔀 Merge branch 'master' of github.com:lissy93/dashy into FIX/1953_glances_alerts_api_updateLissy93Lissy93 ·
    b878304🗃️ Update schema discrepenciesLissy93Lissy93 ·
    ac6f6fa📝 Fix small errors/innacuracies in docsLissy93Lissy93 ·
    d5f2af3⚡️ Improve dev container and workflow configsLissy93Lissy93 ·
    1b1de5a🗑️ Remove stale filesLissy93Lissy93 ·
    3.1.5Tag
    View on:GitHubDockerHub
    448c625⬆️ Bump version to 3.1.5liss-botliss-bot ·
    c2b2eb5🔀 Merge pull request #1915 from aspenyang/opt1-searchLissy93Lissy93 ·
    958f82f✨ Simplifies implementation of opening (searchbar) URLs directlyLissy93Lissy93 ·
    fb41a42🔄 Sync from masterLissy93Lissy93 ·
    6fb99b7🔀 Merge pull request #1948 from BLUE-YBZ/feat/add_cloudDeployEOLissy93Lissy93 ·
    3.1.4Tag
    View on:GitHubDockerHub
    8997d1a⬆️ Bump version to 3.1.4liss-botliss-bot ·
    1686fdc🔀 Merge pull request #1986 from ricardodemauro/masterLissy93Lissy93 ·
    91de9fe🔥 Removes temp code from confLissy93Lissy93 ·
    a674e21🚨 Small lint fixes to cve widgetLissy93Lissy93 ·
    b9ce363🔀 Merge branch 'master' of github.com:lissy93/dashy into ricardodemauro/masterLissy93Lissy93 ·
    5a4c1a3🔀 Merge pull request #1988 from noblepower1337/patch-4Lissy93Lissy93 ·
    40112b6🔀 Merge branch 'master' of github.com:lissy93/dashyLissy93Lissy93 ·
    abaf27c👷 Adds fallback token for tag workflow, removes obsolete docs workflowLissy93Lissy93 ·
    3.1.3Tag
    View on:GitHubDockerHub
    71cff13🔖 Bump version to 3.1.3 [skip ci]liss-botliss-bot ·
    3832a5c🔀 Merge pull request #1991 from TheZachAttack01/patch-1Lissy93Lissy93 ·
    a05ae9b🌐 Adds translations for new GluetunStatus, and fixes indentationLissy93Lissy93 ·
    22749aeMerge branch 'master' of github.com:lissy93/dashy into patch-1Lissy93Lissy93 ·
    b55fe60👷 Fix docs site workflowLissy93Lissy93 ·
    d40ade0👷 Fix docs site workflowLissy93Lissy93 ·
    6548995🔀 Merge pull request #2003 from Lissy93/ref/doc-updateLissy93Lissy93 ·
    b23af30:octocat: Shortens the PR template :)Lissy93Lissy93 ·
    3a269bb💚 Small fix in CI build for tags, and updates the release docsLissy93Lissy93 ·
    3.1.2Tag
    View on:GitHubDockerHub
    06da52f⬆️ Bump version to 3.1.2liss-botliss-bot ·
    a1c0593🔀 Merge pull request #2001 from Lissy93/ref/robustness-improvmentsLissy93Lissy93 ·
    20270e0🍱 Fix favicon loading, and add tag workflowLissy93Lissy93 ·
    d8f8344🔄 Sync from masterLissy93Lissy93 ·
    5432584👷 Auto bump version on PR merge, and trigger new docker tagsLissy93Lissy93 ·
    a1f9573🗑️ Remove obsolete workflowsLissy93Lissy93 ·
    c02e232⬆ Upgrades many dependencies, resolves many security warningsLissy93Lissy93 ·
    70f0ed1🚨 Fixes CI failure from unused imports, resolves deepscan checksLissy93Lissy93 ·
    93df30b🔧 Updates yarn config, for newer versionsLissy93Lissy93 ·
    7fb485e👷 Adds CI for running testsLissy93Lissy93 ·
    099e6e4🧪 Adds Docker smoke testLissy93Lissy93 ·

    February 2026

    721f519📝 Update sponsorship details in README.mdLissy93Lissy93 ·
    a2bf7daMerge pull request #1993 from Lissy93/fix/rss-xss-preventionLissy93Lissy93 ·
    f467b2eFixes RSS parsing and hardens security against XSSLissy93Lissy93 ·
    0ddf972Add forwarded port display in GluetunStatus componentTheZachAttack01TheZachAttack01 ·
    862dda0🔁 Merge pull request #1990 from larsreinhardt/patch-1Lissy93Lissy93 ·
    44eafcfUpdate docker-compose example in deployment docslarsreinhardtlarsreinhardt ·
    05cb97e📃 Update sponsorship information in README.mdLissy93Lissy93 ·
    8d6cd88Add Kyrgyz language contribution to READMEnoblepower1337noblepower1337 ·
    4dec9d8fixing color pick and removing unused functionricardodemauroricardodemauro ·
    a1acb77adding parsing for different types of cvs metricsricardodemauroricardodemauro ·
    53ab9e3removing unecessary asyncricardodemauroricardodemauro ·
    0cb63d0- updating docs to include - documentation of apiricardodemauroricardodemauro ·
    1ce7aaefixing suggestionsricardodemauroricardodemauro ·
    fe3550dremoving mistaken changericardodemauroricardodemauro ·
    4913dbbremoving mistaken commit filericardodemauroricardodemauro ·
    37e85aefixing grammarricardodemauroricardodemauro ·
    770db58updating the docsricardodemauroricardodemauro ·
    2432663fixes #1391 - replacing datasource to nist - https://nvd.nist.gov/developers/vulnerabilitiesricardodemauroricardodemauro ·

    December 2025

    dbae197Merge pull request #3 from JDB321Sailor/copilot/fix-default-view-theme-issueJDB321SailorJDB321Sailor ·
    fc0bd9aFix theme initialization in workspace view by integrating ThemingMixin into HomeMixinCopilotCopilot ·
    dfa08baInitial planCopilotCopilot ·
    f26e37fUpdate GlancesMixin.js - wrong default version in commentMatesMotionlessMatesMotionless ·
    774c690Merge pull request #2 from JDB321Sailor/copilot/verify-hide-from-workspace-configurationJDB321SailorJDB321Sailor ·
    075970bAdd watcher to handle dynamic section changes in SideBar componentCopilotCopilot ·
    4bde34cAdd hideFromWorkspace support at section level in ConfigSchema and SideBar componentCopilotCopilot ·
    e072a2fInitial planCopilotCopilot ·
    2c472bdMerge pull request #1 from JDB321Sailor/copilot/add-hide-from-workspace-optionJDB321SailorJDB321Sailor ·
    3e30ea0Remove test changes from conf.ymlCopilotCopilot ·
    182101cAdd documentation for hideFromWorkspace optionCopilotCopilot ·

    May 2024

    Release 3.1.1Release3.1.1
    liss-botliss-botView on:GitHubDockerHub

    April 2024

    3.0.1Release3.0.1

    Version 3.0.1 Released 🚀 This release includes several UX and security improvments. Your backed up config files will no longer clutter up your user-data directory. The security of auth has been ha

    Lissy93Lissy93View on:GitHubDockerHub
    3.0.0Release3.0.0

    Dashy 3.0 has been released! This version includes some major changes, including: - No more rebuilding 🎉 - Mounting a directory, not a file 😌 - Switch to Non-Root of Port 🔒 - Environmental V

    Lissy93Lissy93View on:GitHubDockerHub

    March 2024

    2.1.2Release2.1.2

    It's been a while (I'm sorry it's taken so long), but here is the newest release of Dashy, V 2.1.2 All credit for this release should go to @CrazyWolf13, whose done an awesome job at organizing all

    Lissy93Lissy93View on:GitHubDockerHub

    July 2022

    2.1.1Release2.1.1

    ✨ 2.1.1 Improvements PR 775 Bug Fixes 🐛 - Update APOD widget to use https://apod.as93.net - 745 by @k073l - Fixes theme applying bug (774) Improvements ⚡️ - Stop status checks when item destroyed

    liss-botliss-botView on:GitHubDockerHub

    June 2022

    2.1.0Release2.1.0

    ✨ 2.0.9 Adds Multi-Page Support PR 685 - Adds Widgets for AdGuard

    liss-botliss-botView on:GitHubDockerHub

    May 2022

    2.0.9Release2.0.9

    ✨ 2.0.9 Adds Multi-Page Support PR 663 - Fix KeyCloak API URL (564) - Fix guest has config access (590) - Fix collapsible content in multi-page support (626) - Fix layout and item size buttons ( 6

    Lissy93Lissy93View on:GitHubDockerHub
    2.0.8Release2.0.8

    You requested it.... Multi-page support is here! As well as your main page, you can now have as many sub-pages as you like. The config file for which, can either be managed locally within Dashy, or

    liss-botliss-botView on:GitHubDockerHub

    April 2022

    2.0.7Release2.0.7

    ⚡️ 2.0.7 Improves handling of Sections and Items PR 595 - Adds functionality for sub-items / item-groups - Creates an item mixin, for reusing functionality - Item width calculated based on parent sect

    liss-botliss-botView on:GitHubDockerHub

    March 2022

    2.0.6Release2.0.6

    🐛 Fixes user requested issues PR 557 - Allows middle click open new tab, Re: 492 - Implements Max redirects for status checks, Re: 494 - Adds Gitpod config for cloud-ready IDE, Re: 497 - Adss new scr

    github-actions[bot]github-actions[bot]View on:GitHubDockerHub
    2.0.5Release2.0.5

    Partially revert 2.0.4, fixing several issues caused by conf.yml not being loaded at startup. This change requires a rebuild of the application when several options under appConfig are changed. Fixes

    github-actions[bot]github-actions[bot]View on:GitHubDockerHub
    2.0.4Tag
    View on:GitHubDockerHub

    February 2022

    2.0.3Tag
    View on:GitHubDockerHub
    2.0.2Tag
    View on:GitHubDockerHub
    2.0.1Tag
    View on:GitHubDockerHub

    January 2022

    Dashy 2.0.0Release2.0.0

    Version 2.0.0 of Dashy is now released! The main changes are the introduction of widgets, as well as usability + stability improvements. Thanks very much to everyone who contributed to this release

    Lissy93Lissy93View on:GitHubDockerHub
    1.9.9Tag
    View on:GitHubDockerHub

    October 2021

    Dashy 1.9.0Release1.9.0

    ✨ New Features - All-new interactive config editor - Option for default opening method, and more target options - Support for single-section view ⚡️ Improvments - Custom 404 pages, and improved

    Lissy93Lissy93View on:GitHubDockerHub

    September 2021

    Dashy 1.8.0Release1.8.0

    Release Highlights - Multi-search supporting custom bangs - Improved language detection - Improved error handling - Spanish translations, contributed by @lu4t - Item sort options, alphabetical, m

    Lissy93Lissy93View on:GitHubDockerHub

    August 2021

    Dashy 1.7.0Release1.7.0

    Release Highlights - Direct web search integration from search bar - Improved loading expereince during initial build - Option for ignoring SSL in local status checks - Improved search, shortcuts

    Lissy93Lissy93View on:GitHubDockerHub
    Dashy 1.6.0Release1.6.0

    Thank you to everyone who has supported the development of Dashy over the past few weeks, thanks to you it is coming along well :) Release Highlights: - Builds a minimal view, which is designed to

    Lissy93Lissy93View on:GitHubDockerHub
    Dashy 1.5.0Release1.5.0

    This release contains several new features, improvements and docs, which have been merged over the past few versions. Thank you everyone who's using and following Dashy, I've had a lot of fun develop

    Lissy93Lissy93View on:GitHubDockerHub

    July 2021

    Dashy 1.4.0Release1.4.0

    Dashy 1.4.0 🚀 Dashy is an easy-to-deploy, highly-customizable self-hosted dashboard. It helps you keep your apps and services organized in a single place, and makes launching your apps super quic

    Lissy93Lissy93View on:GitHubDockerHub

    June 2021

    Dashy ProductionRelease1.3.6

    This is the first GitHub release, but Dashy is currently at V 1.3.5, It includes all the basic functionality for reading and displaying sections and items from the YAML config file, basic config edit

    Lissy93Lissy93View on:GitHubDockerHub
    +

    Project Updates

    The latest releases and updates from Dashy

    March 2026

    3.2.1Tag
    View on:GitHubDockerHub
    c608879⬆️ Bump version to 3.2.1liss-botliss-bot ·
    d8bf8ea🔀 Merge pull request #2027 from Lissy93/update/remove-axiosLissy93Lissy93 ·
    c07f3dc🥅 Handle null headersLissy93Lissy93 ·
    c42e201➖ Uninstall Axios depLissy93Lissy93 ·
    63952fb🚚 Replace instances of Axios with new request handlers across everywhereLissy93Lissy93 ·
    a0a6d48⚡ Creates client-side request wrapper instead of axiosLissy93Lissy93 ·
    47078a4⚡ Creates server-side request wrapper instead of axiosLissy93Lissy93 ·
    Release 3.2.0Release3.2.0

    What's Changed Update Github trending widget by @alhazmy13 in https://github.com/Lissy93/dashy/pull/1562 Bump simple-icons to 12.2.0 by @michaelfeinbier in https://github.com/Lissy93/dashy/pull/16

    liss-botliss-botView on:GitHubDockerHub
    24d7414🔀 Merge pull request #2021 from Lissy93/fix/small-issuesLissy93Lissy93 ·
    75a9e1a⬆️ Bump to 3.2.0Lissy93Lissy93 ·
    37e6a9f🐛 Fixes sabnzbd path prefix configurable (#1965)Lissy93Lissy93 ·
    1cf089d🐛 Fixes missing copyclipboard in workspace view (#1851)Lissy93Lissy93 ·
    551433e🐛 Fixes allow target to be empty (#1895)Lissy93Lissy93 ·
    0b9a703🔐 Updates security contact info (#1994)Lissy93Lissy93 ·
    b578702✨ Adds "New Window" as opening method (#1970)Lissy93Lissy93 ·
    271eb26🐛 Fixes duplicate forecase entries in weather (#1887)Lissy93Lissy93 ·
    1f30baf🐛 Fixes custom search engine prevening bangs (#1980)Lissy93Lissy93 ·
    f5f98b2🌐 Updates alias for Chinese (#1920)Lissy93Lissy93 ·
    3.1.15Tag
    View on:GitHubDockerHub
    d1e1313⬆️ Bump version to 3.1.15liss-botliss-bot ·
    0361575🔀 Merge pull request #2020 from Lissy93/fix/external-auth-mem-spikeLissy93Lissy93 ·
    9c87642🐛 Deep copy auth.users to prevent infinite loop (#1995)Lissy93Lissy93 ·
    3.1.14Tag
    View on:GitHubDockerHub
    702642c⬆️ Bump version to 3.1.14liss-botliss-bot ·
    3d8427f🔀 Merge pull request #2019 from Lissy93/fix/remove-clearbitLissy93Lissy93 ·
    b43c23e🔀 Merge pull request #2018 from Lissy93/dependabot/npm_and_yarn/path-to-regexp-0.1.13Lissy93Lissy93 ·
    bf40469Merge pull request #2017 from Lissy93/dependabot/npm_and_yarn/happy-dom-20.8.9Lissy93Lissy93 ·
    cfed398🔥 Removes Clearbit for icons (#1837)Lissy93Lissy93 ·
    98bff09Bump path-to-regexp from 0.1.12 to 0.1.13dependabot[bot]dependabot[bot] ·
    4f2d3c6Bump happy-dom from 17.6.3 to 20.8.9dependabot[bot]dependabot[bot] ·
    0622aa7🔀 Merge pull request #2016 from Lissy93/dependabot/npm_and_yarn/node-forge-1.4.0Lissy93Lissy93 ·
    6809001Bump node-forge from 1.3.3 to 1.4.0dependabot[bot]dependabot[bot] ·
    3724764🔀 Merge pull request #2013 from Lissy93/dependabot/npm_and_yarn/picomatch-2.3.2Lissy93Lissy93 ·
    4a67047Bump picomatch from 2.3.1 to 2.3.2dependabot[bot]dependabot[bot] ·
    3.1.13Tag
    View on:GitHubDockerHubCodeberg
    1f5f3aa⬆️ Bump version to 3.1.13liss-botliss-bot ·
    a90f585🔀 Merge pull request #2012 from Lissy93/fix/pi-hole-api-key-env-varLissy93Lissy93 ·
    50c9ecd🐛 Fixed Pi Hole key not read from env var (#1934)Lissy93Lissy93 ·
    b1eb3f2🐛 Fixed Pi Hole key not read from env var (#1934)Lissy93Lissy93 ·
    7d48a82Merge pull request #2010 from Lissy93/dependabot/npm_and_yarn/flatted-3.4.2Lissy93Lissy93 ·
    165fe3aBump flatted from 3.4.0 to 3.4.2dependabot[bot]dependabot[bot] ·
    3.1.12Tag
    View on:GitHubDockerHubCodeberg
    bf7977c⬆️ Bump version to 3.1.12liss-botliss-bot ·
    a6a10c2🔀 Merge pull request #1922 from JasperX777/jasper/feature-1821-glances-uptimeLissy93Lissy93 ·
    7b2ab67✨ Finishes implementing glances uptime widgetLissy93Lissy93 ·
    9417525📝 Adds Glances uptime docs into widgetsLissy93Lissy93 ·
    b760786🔄️ Merge branch 'master' of github.com:lissy93/dashy into jasper/feature-1821-glances-uptimeLissy93Lissy93 ·
    aed7fca👷 Update CI build of docs site, with --fetch-depthLissy93Lissy93 ·
    51b89d2🔀 Merge pull request #1985 from jonas-schulze/update-simple-iconsLissy93Lissy93 ·
    d40e42b⬆️ Updates simple-icons, from 14.4.0 to 16.6.0Lissy93Lissy93 ·
    f967be1🔄️ Merge branch 'master' of github.com:lissy93/dashy into update-simple-iconsLissy93Lissy93 ·
    3.1.11Tag
    View on:GitHubDockerHubCodeberg
    aeec9fd⬆️ Bump version to 3.1.11liss-botliss-bot ·
    48286e8🔀 Merge pull request #1977 from noblepower1337/patch-2Lissy93Lissy93 ·
    e236b3c🌐 Finishes implementing Kyrgyz translations, thanks @noblepower1337Lissy93Lissy93 ·
    cee6bee🔄️ Merge branch 'master' of github.com:lissy93/dashy into patch-2Lissy93Lissy93 ·
    762d60e🔀 Merge branch 'master' of github.com:lissy93/dashyLissy93Lissy93 ·
    3.1.10Tag
    View on:GitHubDockerHubCodeberg
    d22bcac⬆️ Bump version to 3.1.10liss-botliss-bot ·
    ddfffd1🔀 Merge pull request #1969 from JDB321Sailor/masterLissy93Lissy93 ·
    43068f6♻️ Refactors to remove unnecisary intermediaty varianple for filter tiles in sidebarLissy93Lissy93 ·
    df997b6🔄 Rebases from masterLissy93Lissy93 ·
    1ac4001🔄 Rebases from masterLissy93Lissy93 ·
    0084cb3📝 Updates config info and paths in docsLissy93Lissy93 ·
    66af716🖼️ Update img sources for widget screenshotsLissy93Lissy93 ·
    3.1.9Tag
    View on:GitHubDockerHubCodeberg
    b0f8011⬆️ Bump version to 3.1.9liss-botliss-bot ·
    ecb0970🔀 Merge pull request #1928 from shumittaher/bugcolsLissy93Lissy93 ·
    45dcc7c📝 Updates docs with correct col countLissy93Lissy93 ·
    e07f298🥅 Adds safty check when displayData undefinedLissy93Lissy93 ·
    7ff6141🔄️ Merge branch 'master' of github.com:lissy93/dashy into bugcolsLissy93Lissy93 ·
    3.1.8Tag
    View on:GitHubDockerHubCodeberg
    8d52976⬆️ Bump version to 3.1.8liss-botliss-bot ·
    d95c198🔀 Merge pull request #1931 from JasperX777/jasper/feature-1853-compact-glanceLissy93Lissy93 ·
    9152bd6⚡️ Split GlCompactMetrics to seperate requests, to handle individual failures okLissy93Lissy93 ·
    678786f📝 Adds missing docs for GlCompactMetrics widgetLissy93Lissy93 ·
    a41111f♻️ GlCompactMetrics to use WidgetBase shared methodsLissy93Lissy93 ·
    fa118dd🔄️ Merge branch 'master' of github.com:lissy93/dashy into jasper/feature-1853-compact-glanceLissy93Lissy93 ·
    3.1.7Tag
    View on:GitHubDockerHubCodeberg
    d24ac5d⬆️ Bump version to 3.1.7liss-botliss-bot ·
    c179d6b🔀 Merge pull request #2007 from Lissy93/ref/docs-schema-fixesLissy93Lissy93 ·
    3.1.6Tag
    View on:GitHubDockerHubCodeberg
    3cabcae⬆️ Bump version to 3.1.6liss-botliss-bot ·
    e544c87🔀 Merge pull request #1954 from sypticus/FIX/1953_glances_alerts_api_updateLissy93Lissy93 ·
    bf10fc1🐛 Fix to update alert end / not beginLissy93Lissy93 ·
    5a5f734🔀 Merge branch 'master' of github.com:lissy93/dashy into FIX/1953_glances_alerts_api_updateLissy93Lissy93 ·
    b878304🗃️ Update schema discrepenciesLissy93Lissy93 ·
    ac6f6fa📝 Fix small errors/innacuracies in docsLissy93Lissy93 ·
    d5f2af3⚡️ Improve dev container and workflow configsLissy93Lissy93 ·
    1b1de5a🗑️ Remove stale filesLissy93Lissy93 ·
    3.1.5Tag
    View on:GitHubDockerHubCodeberg
    448c625⬆️ Bump version to 3.1.5liss-botliss-bot ·
    c2b2eb5🔀 Merge pull request #1915 from aspenyang/opt1-searchLissy93Lissy93 ·
    958f82f✨ Simplifies implementation of opening (searchbar) URLs directlyLissy93Lissy93 ·
    fb41a42🔄 Sync from masterLissy93Lissy93 ·
    6fb99b7🔀 Merge pull request #1948 from BLUE-YBZ/feat/add_cloudDeployEOLissy93Lissy93 ·
    3.1.4Tag
    View on:GitHubDockerHubCodeberg
    8997d1a⬆️ Bump version to 3.1.4liss-botliss-bot ·
    1686fdc🔀 Merge pull request #1986 from ricardodemauro/masterLissy93Lissy93 ·
    91de9fe🔥 Removes temp code from confLissy93Lissy93 ·
    a674e21🚨 Small lint fixes to cve widgetLissy93Lissy93 ·
    b9ce363🔀 Merge branch 'master' of github.com:lissy93/dashy into ricardodemauro/masterLissy93Lissy93 ·
    5a4c1a3🔀 Merge pull request #1988 from noblepower1337/patch-4Lissy93Lissy93 ·
    40112b6🔀 Merge branch 'master' of github.com:lissy93/dashyLissy93Lissy93 ·
    abaf27c👷 Adds fallback token for tag workflow, removes obsolete docs workflowLissy93Lissy93 ·
    3.1.3Tag
    View on:GitHubDockerHubCodeberg
    71cff13🔖 Bump version to 3.1.3 [skip ci]liss-botliss-bot ·
    3832a5c🔀 Merge pull request #1991 from TheZachAttack01/patch-1Lissy93Lissy93 ·
    a05ae9b🌐 Adds translations for new GluetunStatus, and fixes indentationLissy93Lissy93 ·
    22749aeMerge branch 'master' of github.com:lissy93/dashy into patch-1Lissy93Lissy93 ·
    b55fe60👷 Fix docs site workflowLissy93Lissy93 ·
    d40ade0👷 Fix docs site workflowLissy93Lissy93 ·
    6548995🔀 Merge pull request #2003 from Lissy93/ref/doc-updateLissy93Lissy93 ·
    b23af30:octocat: Shortens the PR template :)Lissy93Lissy93 ·
    3a269bb💚 Small fix in CI build for tags, and updates the release docsLissy93Lissy93 ·
    3.1.2Tag
    View on:GitHubDockerHubCodeberg
    06da52f⬆️ Bump version to 3.1.2liss-botliss-bot ·
    a1c0593🔀 Merge pull request #2001 from Lissy93/ref/robustness-improvmentsLissy93Lissy93 ·
    20270e0🍱 Fix favicon loading, and add tag workflowLissy93Lissy93 ·
    d8f8344🔄 Sync from masterLissy93Lissy93 ·
    5432584👷 Auto bump version on PR merge, and trigger new docker tagsLissy93Lissy93 ·
    a1f9573🗑️ Remove obsolete workflowsLissy93Lissy93 ·
    c02e232⬆ Upgrades many dependencies, resolves many security warningsLissy93Lissy93 ·
    70f0ed1🚨 Fixes CI failure from unused imports, resolves deepscan checksLissy93Lissy93 ·
    93df30b🔧 Updates yarn config, for newer versionsLissy93Lissy93 ·
    7fb485e👷 Adds CI for running testsLissy93Lissy93 ·
    099e6e4🧪 Adds Docker smoke testLissy93Lissy93 ·

    February 2026

    721f519📝 Update sponsorship details in README.mdLissy93Lissy93 ·
    a2bf7daMerge pull request #1993 from Lissy93/fix/rss-xss-preventionLissy93Lissy93 ·
    f467b2eFixes RSS parsing and hardens security against XSSLissy93Lissy93 ·
    0ddf972Add forwarded port display in GluetunStatus componentTheZachAttack01TheZachAttack01 ·
    862dda0🔁 Merge pull request #1990 from larsreinhardt/patch-1Lissy93Lissy93 ·
    44eafcfUpdate docker-compose example in deployment docslarsreinhardtlarsreinhardt ·
    05cb97e📃 Update sponsorship information in README.mdLissy93Lissy93 ·
    8d6cd88Add Kyrgyz language contribution to READMEnoblepower1337noblepower1337 ·
    4dec9d8fixing color pick and removing unused functionricardodemauroricardodemauro ·
    a1acb77adding parsing for different types of cvs metricsricardodemauroricardodemauro ·
    53ab9e3removing unecessary asyncricardodemauroricardodemauro ·
    0cb63d0- updating docs to include - documentation of apiricardodemauroricardodemauro ·
    1ce7aaefixing suggestionsricardodemauroricardodemauro ·
    fe3550dremoving mistaken changericardodemauroricardodemauro ·
    4913dbbremoving mistaken commit filericardodemauroricardodemauro ·
    37e85aefixing grammarricardodemauroricardodemauro ·
    770db58updating the docsricardodemauroricardodemauro ·
    2432663fixes #1391 - replacing datasource to nist - https://nvd.nist.gov/developers/vulnerabilitiesricardodemauroricardodemauro ·

    December 2025

    dbae197Merge pull request #3 from JDB321Sailor/copilot/fix-default-view-theme-issueJDB321SailorJDB321Sailor ·
    fc0bd9aFix theme initialization in workspace view by integrating ThemingMixin into HomeMixinCopilotCopilot ·
    dfa08baInitial planCopilotCopilot ·
    f26e37fUpdate GlancesMixin.js - wrong default version in commentMatesMotionlessMatesMotionless ·
    774c690Merge pull request #2 from JDB321Sailor/copilot/verify-hide-from-workspace-configurationJDB321SailorJDB321Sailor ·
    075970bAdd watcher to handle dynamic section changes in SideBar componentCopilotCopilot ·
    4bde34cAdd hideFromWorkspace support at section level in ConfigSchema and SideBar componentCopilotCopilot ·
    e072a2fInitial planCopilotCopilot ·
    2c472bdMerge pull request #1 from JDB321Sailor/copilot/add-hide-from-workspace-optionJDB321SailorJDB321Sailor ·
    3e30ea0Remove test changes from conf.ymlCopilotCopilot ·
    182101cAdd documentation for hideFromWorkspace optionCopilotCopilot ·

    May 2024

    Release 3.1.1Release3.1.1
    liss-botliss-botView on:GitHubDockerHubCodeberg

    April 2024

    3.0.1Release3.0.1

    Version 3.0.1 Released 🚀 This release includes several UX and security improvments. Your backed up config files will no longer clutter up your user-data directory. The security of auth has been ha

    Lissy93Lissy93View on:GitHubDockerHubCodeberg
    3.0.0Release3.0.0

    Dashy 3.0 has been released! This version includes some major changes, including: - No more rebuilding 🎉 - Mounting a directory, not a file 😌 - Switch to Non-Root of Port 🔒 - Environmental V

    Lissy93Lissy93View on:GitHubDockerHubCodeberg

    March 2024

    2.1.2Release2.1.2

    It's been a while (I'm sorry it's taken so long), but here is the newest release of Dashy, V 2.1.2 All credit for this release should go to @CrazyWolf13, whose done an awesome job at organizing all

    Lissy93Lissy93View on:GitHubDockerHubCodeberg

    July 2022

    2.1.1Release2.1.1

    ✨ 2.1.1 Improvements PR 775 Bug Fixes 🐛 - Update APOD widget to use https://apod.as93.net - 745 by @k073l - Fixes theme applying bug (774) Improvements ⚡️ - Stop status checks when item destroyed

    liss-botliss-botView on:GitHubDockerHubCodeberg

    June 2022

    2.1.0Release2.1.0

    ✨ 2.0.9 Adds Multi-Page Support PR 685 - Adds Widgets for AdGuard

    liss-botliss-botView on:GitHubDockerHubCodeberg

    May 2022

    2.0.9Release2.0.9

    ✨ 2.0.9 Adds Multi-Page Support PR 663 - Fix KeyCloak API URL (564) - Fix guest has config access (590) - Fix collapsible content in multi-page support (626) - Fix layout and item size buttons ( 6

    Lissy93Lissy93View on:GitHubDockerHubCodeberg
    2.0.8Release2.0.8

    You requested it.... Multi-page support is here! As well as your main page, you can now have as many sub-pages as you like. The config file for which, can either be managed locally within Dashy, or

    liss-botliss-botView on:GitHubDockerHubCodeberg

    April 2022

    2.0.7Release2.0.7

    ⚡️ 2.0.7 Improves handling of Sections and Items PR 595 - Adds functionality for sub-items / item-groups - Creates an item mixin, for reusing functionality - Item width calculated based on parent sect

    liss-botliss-botView on:GitHubDockerHubCodeberg

    March 2022

    2.0.6Release2.0.6

    🐛 Fixes user requested issues PR 557 - Allows middle click open new tab, Re: 492 - Implements Max redirects for status checks, Re: 494 - Adds Gitpod config for cloud-ready IDE, Re: 497 - Adss new scr

    github-actions[bot]github-actions[bot]View on:GitHubDockerHubCodeberg
    2.0.5Release2.0.5

    Partially revert 2.0.4, fixing several issues caused by conf.yml not being loaded at startup. This change requires a rebuild of the application when several options under appConfig are changed. Fixes

    github-actions[bot]github-actions[bot]View on:GitHubDockerHubCodeberg
    2.0.4Tag
    View on:GitHubDockerHubCodeberg

    February 2022

    2.0.3Tag
    View on:GitHubDockerHubCodeberg
    2.0.2Tag
    View on:GitHubDockerHubCodeberg
    2.0.1Tag
    View on:GitHubDockerHubCodeberg

    January 2022

    Dashy 2.0.0Release2.0.0

    Version 2.0.0 of Dashy is now released! The main changes are the introduction of widgets, as well as usability + stability improvements. Thanks very much to everyone who contributed to this release

    Lissy93Lissy93View on:GitHubDockerHubCodeberg

    October 2021

    Dashy 1.9.0Release1.9.0

    ✨ New Features - All-new interactive config editor - Option for default opening method, and more target options - Support for single-section view ⚡️ Improvments - Custom 404 pages, and improved

    Lissy93Lissy93View on:GitHubDockerHubCodeberg

    September 2021

    Dashy 1.8.0Release1.8.0

    Release Highlights - Multi-search supporting custom bangs - Improved language detection - Improved error handling - Spanish translations, contributed by @lu4t - Item sort options, alphabetical, m

    Lissy93Lissy93View on:GitHubDockerHubCodeberg

    August 2021

    Dashy 1.7.0Release1.7.0

    Release Highlights - Direct web search integration from search bar - Improved loading expereince during initial build - Option for ignoring SSL in local status checks - Improved search, shortcuts

    Lissy93Lissy93View on:GitHubDockerHubCodeberg
    Dashy 1.6.0Release1.6.0

    Thank you to everyone who has supported the development of Dashy over the past few weeks, thanks to you it is coming along well :) Release Highlights: - Builds a minimal view, which is designed to

    Lissy93Lissy93View on:GitHubDockerHubCodeberg
    Dashy 1.5.0Release1.5.0

    This release contains several new features, improvements and docs, which have been merged over the past few versions. Thank you everyone who's using and following Dashy, I've had a lot of fun develop

    Lissy93Lissy93View on:GitHubDockerHubCodeberg

    July 2021

    Dashy 1.4.0Release1.4.0

    Dashy 1.4.0 🚀 Dashy is an easy-to-deploy, highly-customizable self-hosted dashboard. It helps you keep your apps and services organized in a single place, and makes launching your apps super quic

    Lissy93Lissy93View on:GitHubDockerHubCodeberg

    June 2021

    Dashy ProductionRelease1.3.6

    This is the first GitHub release, but Dashy is currently at V 1.3.5, It includes all the basic functionality for reading and displaying sections and items from the YAML config file, basic config edit

    Lissy93Lissy93View on:GitHubDockerHubCodeberg
    \ No newline at end of file