mirror of
https://github.com/Lissy93/dashy.git
synced 2026-06-03 15:24:55 -04:00
4237 lines
559 KiB
HTML
4237 lines
559 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-widgets" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">Widgets | Dashy</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="dashy, dashboard, homelab, self-hosted, docker, homepage"><meta data-rh="true" property="og:type" content="website"><meta data-rh="true" property="og:url" content="https://dashy.to"><meta data-rh="true" property="og:image" content="https://dashy.to/img/dashy.png"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" name="twitter:title" content="Dashy — The Ultimate Homepage for your Homelab"><meta data-rh="true" name="twitter:description" content="Dashy is a self-hosted dashboard app for your homelab. Manage all your services, with status checks, widgets, themes and more."><meta data-rh="true" name="twitter:image" content="https://dashy.to/img/dashy.png"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Widgets | Dashy"><meta data-rh="true" name="description" content="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."><meta data-rh="true" property="og:description" content="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."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://dashy.to/docs/widgets"><link data-rh="true" rel="alternate" href="https://dashy.to/docs/widgets" hreflang="en"><link data-rh="true" rel="alternate" href="https://dashy.to/docs/widgets" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Widgets","item":"https://dashy.to/docs/widgets"}]}</script><link rel="preconnect" href="https://pixelflare.cc">
|
||
<link rel="preconnect" href="https://cdn.as93.net">
|
||
<link rel="dns-prefetch" href="https://api.github.com">
|
||
<link rel="dns-prefetch" href="https://no-track.as93.net">
|
||
<script type="application/ld+json">{"@context":"https://schema.org","@type":"WebSite","name":"Dashy","url":"https://dashy.to","description":"The Ultimate Homepage for your Homelab","publisher":{"@type":"Person","name":"Alicia Sykes","url":"https://aliciasykes.com"}}</script>
|
||
<link rel="manifest" href="/manifest.json">
|
||
<meta name="theme-color" content="#54bff7">
|
||
<script src="https://no-track.as93.net/js/script.js" defer="defer" data-domain="dashy.to"></script><link rel="stylesheet" href="/assets/css/styles.4bd6bc2b.css">
|
||
<script src="/assets/js/runtime~main.626c1716.js" defer="defer"></script>
|
||
<script src="/assets/js/main.71031559.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div class="banner_woPo"><a class="link_ecgS" title="View the changelog, to see what's new!" href="/updates">Dashy <!-- -->V4.1.5<!-- --> is now live 🚀</a><a class="link2_y3x6" title="View the changelog, to see what's new!" href="/updates">See what's new…</a><button class="closeBtn_fC0A" title="Dismiss update, and don't show again" aria-label="Dismiss update, and don't show again">×</button></div><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/dashy.png" alt="Dashy Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/dashy.png" alt="Dashy Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Dashy</b></a><a href="https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><a href="https://demo.dashy.to" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Live Demo<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><a class="navbar__item navbar__link" href="/docs/quick-start">Quick Start</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs">Documentation</a><a class="navbar__item navbar__link" href="/updates">Changelog</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><div class="navbar__search searchBarContainer_NW3z" dir="ltr"><input placeholder="Search" aria-label="Search" class="navbar__search-input searchInput_YFbd" value=""><div class="loadingRing_RJI3 searchBarLoadingRing_YnHq"><div></div><div></div><div></div><div></div></div></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/quick-start"><span title="Running Dashy" class="categoryLinkLabel_W154">Running Dashy</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/docs/icons"><span title="Feature Docs" class="categoryLinkLabel_W154">Feature Docs</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/icons"><span title="Icons" class="linkLabel_WmDU">Icons</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/widgets"><span title="Widgets" class="linkLabel_WmDU">Widgets</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/theming"><span title="Theming" class="linkLabel_WmDU">Theming</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/status-indicators"><span title="Status Indicators" class="linkLabel_WmDU">Status Indicators</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/authentication"><span title="Authentication" class="linkLabel_WmDU">Authentication</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/searching"><span title="Keyboard Shortcuts" class="linkLabel_WmDU">Keyboard Shortcuts</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/alternate-views"><span title="Alternate Views & Opening Methods" class="linkLabel_WmDU">Alternate Views & Opening Methods</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/multi-language-support"><span title="Internationalization" class="linkLabel_WmDU">Internationalization</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/backup-restore"><span title="Cloud Backup and Restore" class="linkLabel_WmDU">Cloud Backup and Restore</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/pages-and-sections"><span title="Pages and Sections" class="linkLabel_WmDU">Pages and Sections</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/showcase"><span title="Community" class="categoryLinkLabel_W154">Community</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/privacy"><span title="Misc" class="categoryLinkLabel_W154">Misc</span></a></div></li></ul></nav></div><div class="sidebar-ad"><script async="" src="//cdn.carbonads.com/carbon.js?serve=CWYIC53L&placement=dashyto" id="_carbonads_js"></script></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Feature Docs</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Widgets</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Widgets</h1></header>
|
||
<p>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.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="contents">Contents<a href="#contents" class="hash-link" aria-label="Direct link to Contents" title="Direct link to Contents" translate="no"></a></h2>
|
||
<ul>
|
||
<li class=""><strong><a href="#general-widgets" class="">General Widgets</a></strong>
|
||
<ul>
|
||
<li class=""><a href="#clock" class="">Clock</a></li>
|
||
<li class=""><a href="#weather" class="">Weather</a></li>
|
||
<li class=""><a href="#weather-forecast" class="">Weather Forecast</a></li>
|
||
<li class=""><a href="#rss-feed" class="">RSS Feed</a></li>
|
||
<li class=""><a href="#image" class="">Image</a></li>
|
||
<li class=""><a href="#public-ip" class="">Public IP Address</a></li>
|
||
<li class=""><a href="#ip-blacklist" class="">IP Blacklist Checker</a></li>
|
||
<li class=""><a href="#domain-monitor" class="">Domain Monitor</a></li>
|
||
<li class=""><a href="#crypto-watch-list" class="">Crypto Watch List</a></li>
|
||
<li class=""><a href="#crypto-token-price-history" class="">Crypto Price History</a></li>
|
||
<li class=""><a href="#wallet-balance" class="">Crypto Wallet Balance</a></li>
|
||
<li class=""><a href="#code-stats" class="">Code Stats</a></li>
|
||
<li class=""><a href="#mullvad-status" class="">Mullvad Status</a></li>
|
||
<li class=""><a href="#addyio" class="">Email Aliases (addy.io)</a></li>
|
||
<li class=""><a href="#vulnerability-feed" class="">Vulnerability Feed</a></li>
|
||
<li class=""><a href="#exchange-rates" class="">Exchange Rates</a></li>
|
||
<li class=""><a href="#public-holidays" class="">Public Holidays</a></li>
|
||
<li class=""><a href="#covid-19-status" class="">Covid-19 Status</a></li>
|
||
<li class=""><a href="#sports-scores" class="">Sports Scores</a></li>
|
||
<li class=""><a href="#news-headlines" class="">News Headlines</a></li>
|
||
<li class=""><a href="#tfl-status" class="">TFL Status</a></li>
|
||
<li class=""><a href="#stock-price-history" class="">Stock Price History</a></li>
|
||
<li class=""><a href="#eth-gas-prices" class="">ETH Gas Prices</a></li>
|
||
<li class=""><a href="#joke" class="">Joke of the Day</a></li>
|
||
<li class=""><a href="#chuck-norris-quotes" class="">Chuck Norris quotes</a></li>
|
||
<li class=""><a href="#xkcd-comics" class="">XKCD Comics</a></li>
|
||
<li class=""><a href="#flight-data" class="">Flight Data</a></li>
|
||
<li class=""><a href="#astronomy-picture-of-the-day" class="">NASA APOD</a></li>
|
||
<li class=""><a href="#github-trending" class="">GitHub Trending</a></li>
|
||
<li class=""><a href="#github-profile-stats" class="">GitHub Profile Stats</a></li>
|
||
<li class=""><a href="#healthchecks-status" class="">Healthchecks Status</a></li>
|
||
<li class=""><a href="#hackernews-trending" class="">Hackernews Trending</a></li>
|
||
<li class=""><a href="#mvg-departure" class="">Mvg Departure</a></li>
|
||
<li class=""><a href="#mvg-connection" class="">Mvg Connection</a></li>
|
||
<li class=""><a href="#custom-search" class="">Custom search</a></li>
|
||
<li class=""><a href="#rescuetime-overview" class="">Rescuetime overview</a></li>
|
||
<li class=""><a href="#minecraft-server" class="">Minecraft Server</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class=""><strong><a href="#self-hosted-services-widgets" class="">Self-Hosted Services Widgets</a></strong>
|
||
<ul>
|
||
<li class=""><a href="#system-info" class="">System Info</a></li>
|
||
<li class=""><a href="#cron-monitoring-health-checks" class="">Cron Monitoring</a></li>
|
||
<li class=""><a href="#cpu-history-netdata" class="">CPU History</a></li>
|
||
<li class=""><a href="#memory-history-netdata" class="">Memory History</a></li>
|
||
<li class=""><a href="#load-history-netdata" class="">System Load History</a></li>
|
||
<li class=""><a href="#pi-hole-stats" class="">Pi-Hole Stats</a></li>
|
||
<li class=""><a href="#pi-hole-stats-v6" class="">Pi-Hole Stats v6</a></li>
|
||
<li class=""><a href="#pi-hole-queries" class="">Pi-Hole Queries</a></li>
|
||
<li class=""><a href="#pi-hole-queries-v6" class="">Pi-Hole Queries v6</a></li>
|
||
<li class=""><a href="#pi-hole-recent-traffic" class="">Pi-Hole Recent Traffic</a></li>
|
||
<li class=""><a href="#pi-hole-recent-traffic-v6" class="">Pi-Hole Recent Traffic v6</a></li>
|
||
<li class=""><a href="#stat-ping-statuses" class="">Stat Ping Statuses</a></li>
|
||
<li class=""><a href="#synology-download-station" class="">Synology Download Station</a></li>
|
||
<li class=""><a href="#adguard-home-block-stats" class="">AdGuard Home Block Stats</a></li>
|
||
<li class=""><a href="#adguard-home-filters" class="">AdGuard Home Filters</a></li>
|
||
<li class=""><a href="#adguard-home-dns-info" class="">AdGuard Home DNS Info</a></li>
|
||
<li class=""><a href="#adguard-home-top-domains" class="">AdGuard Home Top Domains</a></li>
|
||
<li class=""><a href="#nextcloud-user" class="">Nextcloud User</a></li>
|
||
<li class=""><a href="#nextcloud-user-statuses" class="">Nextcloud User Statuses</a></li>
|
||
<li class=""><a href="#nextcloud-notifications" class="">Nextcloud Notifications</a></li>
|
||
<li class=""><a href="#nextcloud-system" class="">Nextcloud System</a></li>
|
||
<li class=""><a href="#nextcloud-stats" class="">Nextcloud Stats</a></li>
|
||
<li class=""><a href="#nextcloud-php-opcache-stats" class="">Nextcloud PHP OPcache</a></li>
|
||
<li class=""><a href="#ntfy-stream" class="">Ntfy stream</a></li>
|
||
<li class=""><a href="#proxmox-lists" class="">Proxmox lists</a></li>
|
||
<li class=""><a href="#sabnzbd" class="">Sabnzbd</a></li>
|
||
<li class=""><a href="#gluetun-vpn-info" class="">Gluetun VPN Info</a></li>
|
||
<li class=""><a href="#drone-ci-builds" class="">Drone CI Build</a></li>
|
||
<li class=""><a href="#filebrowser" class="">Filebrowser</a></li>
|
||
<li class=""><a href="#linkding" class="">Linkding</a></li>
|
||
<li class=""><a href="#uptime-kuma" class="">Uptime Kuma</a></li>
|
||
<li class=""><a href="#uptime-kuma-status-page" class="">Uptime Kuma Status Page</a></li>
|
||
<li class=""><a href="#tactical-rmm" class="">Tactical RMM</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class=""><strong><a href="#system-resource-monitoring" class="">System Resource Monitoring</a></strong>
|
||
<ul>
|
||
<li class=""><a href="#current-cpu-usage" class="">CPU Usage Current</a></li>
|
||
<li class=""><a href="#cpu-usage-per-core" class="">CPU Usage Per Core</a></li>
|
||
<li class=""><a href="#cpu-usage-history" class="">CPU Usage History</a></li>
|
||
<li class=""><a href="#current-memory-usage" class="">Memory Usage Current</a></li>
|
||
<li class=""><a href="#memory-usage-history" class="">Memory Usage History</a></li>
|
||
<li class=""><a href="#disk-space" class="">Disk Space</a></li>
|
||
<li class=""><a href="#disk-io" class="">Disk IO</a></li>
|
||
<li class=""><a href="#system-load" class="">System Load</a></li>
|
||
<li class=""><a href="#system-load-history" class="">System Load History</a></li>
|
||
<li class=""><a href="#network-interfaces" class="">Network Interfaces</a></li>
|
||
<li class=""><a href="#network-traffic" class="">Network Traffic</a></li>
|
||
<li class=""><a href="#resource-usage-alerts" class="">Resource Usage Alerts</a></li>
|
||
<li class=""><a href="#ip-address" class="">Public & Private IP</a></li>
|
||
<li class=""><a href="#cpu-temp" class="">CPU Temperature</a></li>
|
||
<li class=""><a href="#compact-metrics" class="">Compact Metrics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class=""><strong><a href="#dynamic-widgets" class="">Dynamic Widgets</a></strong>
|
||
<ul>
|
||
<li class=""><a href="#iframe-widget" class="">Iframe Widget</a></li>
|
||
<li class=""><a href="#html-embedded-widget" class="">HTML Embed Widget</a></li>
|
||
<li class=""><a href="#api-response" class="">API Response</a></li>
|
||
<li class=""><a href="#prometheus-data" class="">Prometheus Data</a></li>
|
||
<li class=""><a href="#data-feed" class="">Data Feed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class=""><strong><a href="#usage--customizations" class="">Usage & Customizations</a></strong>
|
||
<ul>
|
||
<li class=""><a href="#widget-usage-guide" class="">Widget Usage Guide</a></li>
|
||
<li class=""><a href="#continuous-updates" class="">Continuous Updates</a></li>
|
||
<li class=""><a href="#proxying-requests" class="">Proxying Requests</a></li>
|
||
<li class=""><a href="#handling-secrets" class="">Handling Secrets</a></li>
|
||
<li class=""><a href="#setting-timeout" class="">Setting Timeout</a></li>
|
||
<li class=""><a href="#adding-labels" class="">Adding Labels</a></li>
|
||
<li class=""><a href="#ignoring-errors" class="">Ignoring Errors</a></li>
|
||
<li class=""><a href="#widget-styling" class="">Custom CSS Styling</a></li>
|
||
<li class=""><a href="#customizing-charts" class="">Customizing Charts</a></li>
|
||
<li class=""><a href="#language-translations" class="">Language Translations</a></li>
|
||
<li class=""><a href="#widget-ui-options" class="">Widget UI Options</a></li>
|
||
<li class=""><a href="#build-your-own-widget" class="">Building a Widget</a></li>
|
||
<li class=""><a href="#requesting-a-widget" class="">Requesting a Widget</a></li>
|
||
<li class=""><a href="#troubleshooting-widget-errors" class="">Troubleshooting</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="general-widgets">General Widgets<a href="#general-widgets" class="hash-link" aria-label="Direct link to General Widgets" title="Direct link to General Widgets" translate="no"></a></h2>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="clock">Clock<a href="#clock" class="hash-link" aria-label="Direct link to Clock" title="Direct link to Clock" translate="no"></a></h3>
|
||
<p>A simple, live-updating time and date widget with time-zone support. All fields are optional.</p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="400" src="https://pixelflare.cc/alicia/dashy/clock" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options">Options<a href="#options" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>timeZone</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>The time zone to display date and time in.<br> Specified as Region/City, for example: <code>Australia/Melbourne</code>. See the <a href="https://timezonedb.com/time-zones" target="_blank" rel="noopener noreferrer" class="">Time Zone DB</a> for a full list of supported TZs. Defaults to the browser / device's local time</td></tr><tr><td><strong><code>format</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>A country code for displaying the date and time in local format.<br>Specified as <code>[ISO-3166]-[ISO-639]</code>, for example: <code>en-AU</code>. See <a href="https://www.fincher.org/Utilities/CountryLanguageList.shtml" target="_blank" rel="noopener noreferrer" class="">here</a> for a full list of locales. Defaults to the browser / device's region</td></tr><tr><td><strong><code>customCityName</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>By default the city from the time-zone is shown, but setting this value will override that text</td></tr><tr><td><strong><code>hideDate</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>If set to <code>true</code>, the date and city will not be shown. Defaults to <code>false</code></td></tr><tr><td><strong><code>hideSeconds</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>If set to <code>true</code>, seconds will not be shown. Defaults to <code>false</code></td></tr><tr><td><strong><code>use12Hour</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>If set to <code>true</code>, 12 hour time will be displayed. Defaults to the settings suggested by the current <code>format</code> and <code>timeZone</code></td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example">Example<a href="#example" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> clock</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">timeZone</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> Europe/London</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">format</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> en</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">GB</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">hideDate</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> </span><span class="token boolean important">false</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info">Info<a href="#info" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<p><em>No external data requests.</em></p>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="weather">Weather<a href="#weather" class="hash-link" aria-label="Direct link to Weather" title="Direct link to Weather" translate="no"></a></h3>
|
||
<p>A simple, live-updating local weather component, showing temperature, conditions and more info.</p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="400" src="https://pixelflare.cc/alicia/dashy/weather" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-1">Options<a href="#options-1" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>apiKey</code></strong></td><td><code>string</code></td><td>Required</td><td>Your OpenWeatherMap API key. You can get one for free at <a href="https://openweathermap.org/" target="_blank" rel="noopener noreferrer" class="">openweathermap.org</a></td></tr><tr><td><strong><code>city</code></strong></td><td><code>string</code></td><td>Required</td><td>A city name to use for fetching weather. This can also be a state code or country code, following the ISO-3166 format</td></tr><tr><td><strong><code>cityId</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>An OpenWeatherMap numeric city ID, used to disambiguate cities that share a name. You can find the ID in the URL of the city's page on <a href="https://openweathermap.org/" target="_blank" rel="noopener noreferrer" class="">openweathermap.org</a> (e.g. <code>2643743</code> for London, GB). If provided, this will override the <code>city</code> option</td></tr><tr><td><strong><code>units</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>The units to use for displaying data, can be either <code>metric</code> or <code>imperial</code>. Defaults to <code>metric</code></td></tr><tr><td><strong><code>hideDetails</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>If set to <code>true</code>, the additional details (wind, humidity, pressure, etc) will not be shown. Defaults to <code>false</code></td></tr><tr><td><strong><code>lat</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>To show weather for a specific location, you can provide the latitude and longitude coordinates. If provided, this will override the <code>city</code> and <code>cityId</code> options</td></tr><tr><td><strong><code>lon</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>To show weather for a specific location, you can provide the latitude and longitude coordinates. If provided, this will override the <code>city</code> and <code>cityId</code> options</td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-1">Example<a href="#example-1" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> weather</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">apiKey</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">city</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> London</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">units</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> metric</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">hideDetails</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> </span><span class="token boolean important">true</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-1">Info<a href="#info-1" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<ul>
|
||
<li class=""><strong>CORS</strong>: 🟢 Enabled</li>
|
||
<li class=""><strong>Auth</strong>: 🔴 Required</li>
|
||
<li class=""><strong>Price</strong>: 🟠 Free plan</li>
|
||
<li class=""><strong>Privacy</strong>: <em>See <a href="https://openweather.co.uk/privacy-policy" target="_blank" rel="noopener noreferrer" class="">OWM Privacy Policy</a></em></li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="weather-forecast">Weather Forecast<a href="#weather-forecast" class="hash-link" aria-label="Direct link to Weather Forecast" title="Direct link to Weather Forecast" translate="no"></a></h3>
|
||
<p>Displays the weather (temperature and conditions) for the next few days for a given location. Note that this requires either the free <a href="https://home.openweathermap.org/students" target="_blank" rel="noopener noreferrer" class="">OpenWeatherMap Student Plan</a>, or the Premium Plan.</p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="400" src="https://pixelflare.cc/alicia/dashy/weather-forecast" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-2">Options<a href="#options-2" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>apiKey</code></strong></td><td><code>string</code></td><td>Required</td><td>Your OpenWeatherMap API key. You can get one at <a href="https://openweathermap.org/" target="_blank" rel="noopener noreferrer" class="">openweathermap.org</a> or for free via the <a href="https://home.openweathermap.org/students" target="_blank" rel="noopener noreferrer" class="">OWM Student Plan</a></td></tr><tr><td><strong><code>city</code></strong></td><td><code>string</code></td><td>Required</td><td>A city name to use for fetching weather. This can also be a state code or country code, following the ISO-3166 format</td></tr><tr><td><strong><code>cityId</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>An OpenWeatherMap numeric city ID, used to disambiguate cities that share a name. You can find the ID in the URL of the city's page on <a href="https://openweathermap.org/" target="_blank" rel="noopener noreferrer" class="">openweathermap.org</a> (e.g. <code>2643743</code> for London, GB). If provided, this will override the <code>city</code> option</td></tr><tr><td><strong><code>lat</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>Latitude for a specific location. If provided alongside <code>lon</code>, this will override the <code>city</code> and <code>cityId</code> options</td></tr><tr><td><strong><code>lon</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>Longitude for a specific location. If provided alongside <code>lat</code>, this will override the <code>city</code> and <code>cityId</code> options</td></tr><tr><td><strong><code>numDays</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>The number of days to display of forecast info to display. Defaults to <code>4</code>, max <code>16</code> days</td></tr><tr><td><strong><code>units</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>The units to use for displaying data, can be either <code>metric</code> or <code>imperial</code>. Defaults to <code>metric</code></td></tr><tr><td><strong><code>hideDetails</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>If set to <code>true</code>, the additional details (wind, humidity, pressure, etc) will not be shown. Defaults to <code>false</code></td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-2">Example<a href="#example-2" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> weather</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">forecast</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">city</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> California</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">numDays</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> </span><span class="token number">6</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">apiKey</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">units</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> imperial</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-2">Info<a href="#info-2" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<ul>
|
||
<li class=""><strong>CORS</strong>: 🟢 Enabled</li>
|
||
<li class=""><strong>Auth</strong>: 🔴 Required</li>
|
||
<li class=""><strong>Price</strong>: 🔴 Premium (free for personal use only)</li>
|
||
<li class=""><strong>Privacy</strong>: <em>See <a href="https://openweather.co.uk/privacy-policy" target="_blank" rel="noopener noreferrer" class="">OWM Privacy Policy</a></em></li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="rss-feed">RSS Feed<a href="#rss-feed" class="hash-link" aria-label="Direct link to RSS Feed" title="Direct link to RSS Feed" translate="no"></a></h3>
|
||
<p>Display news and updates from any RSS-enabled service.</p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="600" src="https://pixelflare.cc/alicia/dashy/rss" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-3">Options<a href="#options-3" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>rssUrl</code></strong></td><td><code>string</code></td><td>Required</td><td>The URL location of your RSS feed</td></tr><tr><td><strong><code>apiKey</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>An API key for <a href="https://rss2json.com/" target="_blank" rel="noopener noreferrer" class="">rss2json</a>. It's free, and will allow you to make 10,000 requests per day, you can sign up <a href="https://rss2json.com/sign-up" target="_blank" rel="noopener noreferrer" class="">here</a></td></tr><tr><td><strong><code>limit</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>The number of posts to return. If you haven't specified an API key, this will be limited to 10</td></tr><tr><td><strong><code>orderBy</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>How results should be sorted. Can be either <code>pubDate</code>, <code>author</code> or <code>title</code>. Defaults to <code>pubDate</code></td></tr><tr><td><strong><code>orderDirection</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>Order direction of feed items to return. Can be either <code>asc</code> or <code>desc</code>. Defaults to <code>desc</code></td></tr><tr><td><strong><code>parseLocally</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>If true parse the rss feed locally instead of using the rss2json API.</td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-3">Example<a href="#example-3" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> rss</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">feed</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">rssUrl</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> https</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain">//www.schneier.com/blog/atom.xml</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">apiKey</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> xxxx</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-3">Info<a href="#info-3" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<ul>
|
||
<li class=""><strong>CORS</strong>: 🟢 Enabled</li>
|
||
<li class=""><strong>Auth</strong>: 🟠 Optional</li>
|
||
<li class=""><strong>Price</strong>: 🟠 Free Plan (up to 10,000 requests / day)</li>
|
||
<li class=""><strong>Privacy</strong>: <em>See <a href="https://rss2json.com/privacy-policy" target="_blank" rel="noopener noreferrer" class="">Rss2Json Privacy Policy</a></em></li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="image">Image<a href="#image" class="hash-link" aria-label="Direct link to Image" title="Direct link to Image" translate="no"></a></h3>
|
||
<p>Displays an image.</p>
|
||
<p>This may be useful if you have a service (such as Grafana - <a href="https://mattionline.de/grafana-api-export-graph-as-png/" target="_blank" rel="noopener noreferrer" class="">see example</a>), which periodically exports charts or other data as an image.</p>
|
||
<p>You can also store images within Dashy's public directory (using a Docker volume), and reference them directly. E.g. <code>-v ./path/to/my-homelab-logo.png:/app/public/logo.png</code>, then in the widget <code>imagePath: /logo.png</code>.</p>
|
||
<p>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: <code>imagePath: https://starchart.cc/Lissy93/dashy.svg</code>.</p>
|
||
<p>If you'd like to embed a live screenshot, of all or just part of a website, then this can be done using <a href="https://apiflash.com/" target="_blank" rel="noopener noreferrer" class="">API Flash</a>.</p>
|
||
<p>Or what about showing a photo of the day? Try <code>https://source.unsplash.com/random/400x300</code> or <code>https://picsum.photos/400/300</code></p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="300" src="https://pixelflare.cc/alicia/dashy/image" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-4">Options<a href="#options-4" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>imagePath</code></strong></td><td><code>string</code></td><td>Required</td><td>The path (local or remote) of the image to display</td></tr><tr><td><strong><code>imageWidth</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>Specify a fixed width for rendered image. Accepts either integer value in <code>px</code>, or any string value with units (e.g. <code>420</code>, <code>100px</code>, <code>6.9rem</code>) (defaults to <code>auto</code>)</td></tr><tr><td><strong><code>imageHeight</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>Specify a fixed height for rendered image. Accepts either integer value in <code>px</code>, or any string value with units (e.g. <code>420</code>, <code>100px</code>, <code>6.9rem</code>) (defaults to <code>auto</code>)</td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-4">Example<a href="#example-4" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> image</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">imagePath</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> https</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain">//i.ibb.co/yhbt6CY/dashy.png</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-4">Info<a href="#info-4" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<p>Unless image fetched from remote source, no external data request is made.</p>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="public-ip">Public IP<a href="#public-ip" class="hash-link" aria-label="Direct link to Public IP" title="Direct link to Public IP" translate="no"></a></h3>
|
||
<p>Displays your public IP address, ISP and approximate location.</p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="400" src="https://pixelflare.cc/alicia/dashy/public-ip" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-5">Options<a href="#options-5" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>provider</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>One of <code>ipinfo</code> <em>(default)</em>, <code>freeipapi</code>, <code>ipquery</code>, <code>ip-api</code>, or <code>ipgeolocation</code>. See the table below</td></tr><tr><td><strong><code>apiKey</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>Required for <code>ipgeolocation</code>. Optional for <code>ipinfo</code> (a <a href="https://ipinfo.io/signup" target="_blank" rel="noopener noreferrer" class="">free token</a> raises the rate limit from ~1k/day to ~50k/month)</td></tr><tr><td><strong><code>hideLocation</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>Set to <code>true</code> to hide the flag, ISP name and city/region — only the IP address is shown. Defaults to <code>false</code></td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-5">Example<a href="#example-5" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<p>Default (no options needed)</p>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> public</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">ip</span><br></span></code></pre></div></div>
|
||
<p>Using <code>ip-api</code> via the proxy (gets server IP, because of <code>useProxy</code>)</p>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> public</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">ip</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">useProxy</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> </span><span class="token boolean important">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">provider</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> ip</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">api</span><br></span></code></pre></div></div>
|
||
<p>Using <code>ipgeolocation</code> with a key:</p>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> public</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">ip</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">provider</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> ipgeolocation</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">apiKey</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> xxxxxxxxxxxxxxx</span><br></span></code></pre></div></div>
|
||
<div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_BuS1"><p>Setting <code>useProxy: true</code> makes the lookup happen from Dashy's server instead of your browser, so the upstream API returns the public IP of the machine running Dashy, whereas without <code>useProxy</code> it will show your public IP.</p></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="supported-providers">Supported providers<a href="#supported-providers" class="hash-link" aria-label="Direct link to Supported providers" title="Direct link to Supported providers" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Provider</strong></th><th><strong>Key</strong></th><th><strong>Proxy</strong></th><th><strong>Notes</strong></th></tr></thead><tbody><tr><td><code>ipinfo</code> <em>(default)</em></td><td>🟢 Not needed / 🟠 Optional</td><td>🟢 Not needed</td><td>Service from <a href="https://ipinfo.io/" target="_blank" rel="noopener noreferrer" class="">ipinfo.io</a>. Keyless gives ~1k/day; a <a href="https://ipinfo.io/signup" target="_blank" rel="noopener noreferrer" class="">free token</a> raises this to ~50k/month. Sometimes blocked by adblockers.</td></tr><tr><td><code>freeipapi</code></td><td>🟢 Not needed</td><td>🟢 Not needed</td><td>Keyless, 60 req/min via <a href="https://freeipapi.com/" target="_blank" rel="noopener noreferrer" class="">freeipapi.com</a>.</td></tr><tr><td><code>ipquery</code></td><td>🟢 Not needed</td><td>🟢 Not needed</td><td>Modern keyless API from <a href="https://ipquery.io/" target="_blank" rel="noopener noreferrer" class="">ipquery.io</a>. Includes VPN/Tor/datacenter risk flags in the raw response.</td></tr><tr><td><code>ip-api</code></td><td>🟢 Not needed</td><td>🔴 <strong>Required</strong></td><td><a href="https://ip-api.com/" target="_blank" rel="noopener noreferrer" class="">ip-api.com</a> is HTTP-only on the free tier, so the proxy is needed to avoid mixed-content errors.</td></tr><tr><td><code>ipgeolocation</code></td><td>🔴 <strong>Required</strong></td><td>🟢 Not needed</td><td>Get a free key from <a href="https://ipgeolocation.io/signup.html" target="_blank" rel="noopener noreferrer" class="">ipgeolocation.io</a>.</td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-5">Info<a href="#info-5" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<ul>
|
||
<li class=""><strong>CORS</strong>: 🟢 Enabled (only <code>provider: ip-api</code> needs the proxy)</li>
|
||
<li class=""><strong>Auth</strong>: 🟠 Optional (only <code>ipgeolocation</code> requires a key, and <code>ipinfo</code> is optional)</li>
|
||
<li class=""><strong>Price</strong>: 🟢 Free</li>
|
||
<li class=""><strong>Host</strong>: Managed Instance Only</li>
|
||
<li class=""><strong>Privacy</strong>: See the policy for whichever provider you choose: <a href="https://freeipapi.com/" target="_blank" rel="noopener noreferrer" class="">freeipapi.com</a>, <a href="https://ipinfo.io/privacy-policy" target="_blank" rel="noopener noreferrer" class="">ipinfo.io</a>, <a href="https://ipquery.io/" target="_blank" rel="noopener noreferrer" class="">ipquery.io</a>, <a href="https://ip-api.com/docs/legal" target="_blank" rel="noopener noreferrer" class="">ip-api.com</a>, <a href="https://ipgeolocation.io/privacy.html" target="_blank" rel="noopener noreferrer" class="">IPGeoLocation</a>.</li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="ip-blacklist">IP Blacklist<a href="#ip-blacklist" class="hash-link" aria-label="Direct link to IP Blacklist" title="Direct link to IP Blacklist" translate="no"></a></h3>
|
||
<p>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 <a href="https://blacklistchecker.com/" target="_blank" rel="noopener noreferrer" class="">blacklistchecker.com</a>.</p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="600" src="https://pixelflare.cc/alicia/dashy/ip-blacklist" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-6">Options<a href="#options-6" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>ipAddress</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>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.</td></tr><tr><td><strong><code>apiKey</code></strong></td><td><code>string</code></td><td>Required</td><td>You can get your free API key from <a href="https://blacklistchecker.com/keys" target="_blank" rel="noopener noreferrer" class="">blacklistchecker.com</a></td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-6">Example<a href="#example-6" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> blacklist</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">check</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">apiKey</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">ipAddress</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> 1.1.1.1</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-6">Info<a href="#info-6" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<ul>
|
||
<li class=""><strong>CORS</strong>: 🟢 Enabled</li>
|
||
<li class=""><strong>Auth</strong>: 🔴 Required</li>
|
||
<li class=""><strong>Price</strong>: 🟠 Free Plan</li>
|
||
<li class=""><strong>Host</strong>: Managed Instance Only</li>
|
||
<li class=""><strong>Privacy</strong>: <em>See <a href="https://blacklistchecker.com/privacy" target="_blank" rel="noopener noreferrer" class="">BlacklistChecker Privacy Policy</a></em></li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="domain-monitor">Domain Monitor<a href="#domain-monitor" class="hash-link" aria-label="Direct link to Domain Monitor" title="Direct link to Domain Monitor" translate="no"></a></h3>
|
||
<p>Keep an eye on the expiry dates of your domain names, using public whois records fetched from <a href="https://whoapi.com/" target="_blank" rel="noopener noreferrer" class="">whoapi.com</a>. Click the domain name to view additional info, like registrar, name servers and date last updated.</p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="600" src="https://pixelflare.cc/alicia/dashy/domain-monitor" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-7">Options<a href="#options-7" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>domain</code></strong></td><td><code>string</code></td><td>Required</td><td>The domain to check</td></tr><tr><td><strong><code>apiKey</code></strong></td><td><code>string</code></td><td>Required</td><td>You can get your free API key from <a href="https://my.whoapi.com/user/signup" target="_blank" rel="noopener noreferrer" class="">my.whoapi.com</a></td></tr><tr><td><strong><code>showFullInfo</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>If set to true, the toggle-full-info panel will be open by default</td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-7">Example<a href="#example-7" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> domain</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">monitor</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">domain</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> example.com</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">apiKey</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> domain</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">monitor</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">domain</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> example2.com</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">apiKey</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-7">Info<a href="#info-7" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<ul>
|
||
<li class=""><strong>CORS</strong>: 🟢 Enabled</li>
|
||
<li class=""><strong>Auth</strong>: 🔴 Required</li>
|
||
<li class=""><strong>Price</strong>: 🟠 Free Plan (10,000 requests)</li>
|
||
<li class=""><strong>Host</strong>: Managed Instance Only</li>
|
||
<li class=""><strong>Privacy</strong>: <em>See <a href="https://whoapi.com/privacy-policy/" target="_blank" rel="noopener noreferrer" class="">WhoAPI Privacy Policy</a></em></li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="crypto-watch-list">Crypto Watch List<a href="#crypto-watch-list" class="hash-link" aria-label="Direct link to Crypto Watch List" title="Direct link to Crypto Watch List" translate="no"></a></h3>
|
||
<p>Keep track of price changes of your favorite crypto assets. Data is fetched from <a href="https://www.coingecko.com/" target="_blank" rel="noopener noreferrer" class="">CoinGecko</a>. All fields are optional.</p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="400" src="https://pixelflare.cc/alicia/dashy/crypto-prices" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-8">Options<a href="#options-8" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>assets</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>An array of cryptocurrencies, coins and tokens. See <a href="https://api.coingecko.com/api/v3/asset_platforms" target="_blank" rel="noopener noreferrer" class="">list of supported assets</a>. If none are specified, then the top coins by <code>sortBy</code> (defaults to market cap) will be returned</td></tr><tr><td><strong><code>currency</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>The fiat currency to display price in, expressed as an ISO-4217 alpha code (see <a href="https://www.iban.com/currency-codes" target="_blank" rel="noopener noreferrer" class="">list of currencies</a>). Defaults to <code>USD</code></td></tr><tr><td><strong><code>sortBy</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>The method of sorting results. Can be <code>marketCap</code>, <code>volume</code> or <code>alphabetical</code>. Defaults to <code>marketCap</code>.</td></tr><tr><td><strong><code>limit</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>Number of results to return, useful when no assets are specified. Defaults to either <code>all</code> or <code>100</code></td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-8">Example<a href="#example-8" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> crypto</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">watch</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">list</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">limit</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> </span><span class="token number">10</span><br></span></code></pre></div></div>
|
||
<p>Or</p>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> crypto</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">watch</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">list</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">currency</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> GBP</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">sortBy</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> marketCap</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">assets</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> bitcoin</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> ethereum</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> monero</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> cosmos</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> polkadot</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> dogecoin</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-8">Info<a href="#info-8" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<ul>
|
||
<li class=""><strong>CORS</strong>: 🟢 Enabled</li>
|
||
<li class=""><strong>Auth</strong>: 🟢 Not Required</li>
|
||
<li class=""><strong>Price</strong>: 🟢 Free</li>
|
||
<li class=""><strong>Privacy</strong>: <em>See <a href="https://www.coingecko.com/en/privacy" target="_blank" rel="noopener noreferrer" class="">CoinGecko Privacy Policy</a></em></li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="crypto-token-price-history">Crypto Token Price History<a href="#crypto-token-price-history" class="hash-link" aria-label="Direct link to Crypto Token Price History" title="Direct link to Crypto Token Price History" translate="no"></a></h3>
|
||
<p>Shows recent price history for a given crypto asset, using price data fetched from <a href="https://www.coingecko.com/" target="_blank" rel="noopener noreferrer" class="">CoinGecko</a></p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="400" src="https://pixelflare.cc/alicia/dashy/crypto-price-history" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-9">Options<a href="#options-9" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>asset</code></strong></td><td><code>string</code></td><td>Required</td><td>Name of a crypto asset, coin or token to fetch price data for, see <a href="https://api.coingecko.com/api/v3/asset_platforms" target="_blank" rel="noopener noreferrer" class="">list of supported assets</a></td></tr><tr><td><strong><code>currency</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>The fiat currency to display results in, expressed as an ISO-4217 alpha code (see <a href="https://www.iban.com/currency-codes" target="_blank" rel="noopener noreferrer" class="">list of currencies</a>). Defaults to <code>USD</code></td></tr><tr><td><strong><code>numDays</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>The number of days of price history to render. Defaults to <code>7</code>, min: <code>1</code>, max: <code>30</code> days</td></tr><tr><td><strong><code>chartColor</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>Color of the chart value. Defaults to <code>--widget-text-color</code> which inherits dashboard primary color</td></tr><tr><td><strong><code>chartHeight</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>The height of rendered chart in px. Defaults to <code>300</code></td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-9">Example<a href="#example-9" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> crypto</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">price</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">chart</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">asset</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> bitcoin</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">currency</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> GBP</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">numDays</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> </span><span class="token number">7</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-9">Info<a href="#info-9" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<ul>
|
||
<li class=""><strong>CORS</strong>: 🟢 Enabled</li>
|
||
<li class=""><strong>Auth</strong>: 🟢 Not Required</li>
|
||
<li class=""><strong>Price</strong>: 🟢 Free</li>
|
||
<li class=""><strong>Privacy</strong>: <em>See <a href="https://www.coingecko.com/en/privacy" target="_blank" rel="noopener noreferrer" class="">CoinGecko Privacy Policy</a></em></li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="wallet-balance">Wallet Balance<a href="#wallet-balance" class="hash-link" aria-label="Direct link to Wallet Balance" title="Direct link to Wallet Balance" translate="no"></a></h3>
|
||
<p>Keep track of your crypto balances and see recent transactions. Data is fetched from <a href="https://www.blockcypher.com/dev/" target="_blank" rel="noopener noreferrer" class="">BlockCypher</a></p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="600" src="https://pixelflare.cc/alicia/dashy/crypto-wallet" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-10">Options<a href="#options-10" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>coin</code></strong></td><td><code>string</code></td><td>Required</td><td>Symbol of coin or asset, e.g. <code>btc</code>, <code>eth</code> or <code>doge</code></td></tr><tr><td><strong><code>address</code></strong></td><td><code>string</code></td><td>Required</td><td>Address to monitor. This is your wallet's <strong>public</strong> / receiving address</td></tr><tr><td><strong><code>network</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>To use a different network, other than mainnet. Defaults to <code>main</code></td></tr><tr><td><strong><code>limit</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>Limit the number of transactions to display. Defaults to <code>10</code>, set to large number to show all</td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-10">Example<a href="#example-10" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> wallet</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">balance</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">coin</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> btc</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">address</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> 3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-10">Info<a href="#info-10" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<ul>
|
||
<li class=""><strong>CORS</strong>: 🟢 Enabled</li>
|
||
<li class=""><strong>Auth</strong>: 🟢 Not Required</li>
|
||
<li class=""><strong>Price</strong>: 🟢 Free</li>
|
||
<li class=""><strong>Privacy</strong>: <em>See <a href="https://www.blockcypher.com/privacy.html" target="_blank" rel="noopener noreferrer" class="">BlockCypher Privacy Policy</a></em></li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="code-stats">Code Stats<a href="#code-stats" class="hash-link" aria-label="Direct link to Code Stats" title="Direct link to Code Stats" translate="no"></a></h3>
|
||
<p>Display your coding summary. <a href="https://codestats.net/" target="_blank" rel="noopener noreferrer" class="">Code::Stats</a> 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.</p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="400" src="https://pixelflare.cc/alicia/dashy/code-stats" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-11">Options<a href="#options-11" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<table><thead><tr><th><strong>Field</strong></th><th><strong>Type</strong></th><th><strong>Required</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr><td><strong><code>username</code></strong></td><td><code>string</code></td><td>Required</td><td>Your CodeStats username</td></tr><tr><td><strong><code>hostname</code></strong></td><td><code>string</code></td><td><em>Optional</em></td><td>If your self-hosting CodeStats, then supply the host name. By default it will use the public hosted instance</td></tr><tr><td><strong><code>monthsToShow</code></strong></td><td><code>number</code></td><td><em>Optional</em></td><td>Specify the number of months to render in the historical data chart. Defaults to <code>6</code></td></tr><tr><td><strong><code>hideMeta</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>Optionally hide the meta section (username, level, all-time and recent XP)</td></tr><tr><td><strong><code>hideHistory</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>Optionally hide the historical calendar heat map</td></tr><tr><td><strong><code>hideLanguages</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>Optionally hide the programming languages pie chart</td></tr><tr><td><strong><code>hideMachines</code></strong></td><td><code>boolean</code></td><td><em>Optional</em></td><td>Optionally hide the machines percentage chart</td></tr></tbody></table>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-11">Example<a href="#example-11" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> code</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">stats</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token key atrule">username</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> alicia</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-11">Info<a href="#info-11" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<ul>
|
||
<li class=""><strong>CORS</strong>: 🟢 Enabled</li>
|
||
<li class=""><strong>Auth</strong>: 🟢 Not Required</li>
|
||
<li class=""><strong>Price</strong>: 🟢 Free</li>
|
||
<li class=""><strong>Host</strong>: Self-Hosted or Managed</li>
|
||
<li class=""><strong>Privacy</strong>: <em>See <a href="https://codestats.net/tos#privacy" target="_blank" rel="noopener noreferrer" class="">Code::Stats Privacy Policy</a></em></li>
|
||
</ul>
|
||
<hr>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="mullvad-status">Mullvad Status<a href="#mullvad-status" class="hash-link" aria-label="Direct link to Mullvad Status" title="Direct link to Mullvad Status" translate="no"></a></h3>
|
||
<p>Shows your Mullvad VPN connection status, as well as server info. Fetched from <a href="https://mullvad.net/en/check/" target="_blank" rel="noopener noreferrer" class="">am.i.mullvad.net</a></p>
|
||
<p align="center"><img decoding="async" loading="lazy" width="400" src="https://pixelflare.cc/alicia/dashy/mullvad" class="img_ev3q"></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-12">Options<a href="#options-12" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options" translate="no"></a></h4>
|
||
<p><em>No Options.</em></p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="example-12">Example<a href="#example-12" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain"> </span><span class="token key atrule">type</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> mullvad</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">status</span><br></span></code></pre></div></div>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="info-12">Info<a href="#info-12" class="hash-link" aria-label="Direct link to Info" title="Direct link to Info" translate="no"></a></h4>
|
||
<ul>
|
||
<li class=""><strong>CORS</strong>: |