mirror/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2026-01-20 20:58:21 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
NetAlertX/PLUGINS_DEV/index.html

6091 lines
115 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="The main documentation resource for NetAlertX - a network scanner and presence detector">
<link rel="canonical" href="https://docs.netalertx.com/PLUGINS_DEV/">
<link rel="prev" href="../DEV_PORTS_HOST_MODE/">
<link rel="next" href="../PLUGINS_DEV_QUICK_START/">
<link rel="icon" href="../img/netalertx_docs.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
<title>Overview - NetAlertX Documentation</title>
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<!-- Google Tag Manager -->
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-KCRSGLP8J2"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-KCRSGLP8J2');
</script>
<!-- End Google Tag Manager -->
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="deep-purple">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#plugin-development-guide" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KCRSGLP8J2"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="NetAlertX Documentation" class="md-header__button md-logo" aria-label="NetAlertX Documentation" data-md-component="logo">
<img src="../img/netalertx_docs.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
NetAlertX Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Overview
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="deep-purple" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9z"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="deep-purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 1 7 7c0 2.38-1.19 4.47-3 5.74V17a1 1 0 0 1-1 1H9a1 1 0 0 1-1-1v-2.26C6.19 13.47 5 11.38 5 9a7 7 0 0 1 7-7M9 21v-1h6v1a1 1 0 0 1-1 1h-4a1 1 0 0 1-1-1m3-17a5 5 0 0 0-5 5c0 2.05 1.23 3.81 3 4.58V16h4v-2.42c1.77-.77 3-2.53 3-4.58a5 5 0 0 0-5-5"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/jokob-sk/NetAlertX/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../INSTALLATION/" class="md-tabs__link">
Installation
</a>
</li>
<li class="md-tabs__item">
<a href="../SUBNETS/" class="md-tabs__link">
Setup
</a>
</li>
<li class="md-tabs__item">
<a href="../DEVICE_MANAGEMENT/" class="md-tabs__link">
Device guides
</a>
</li>
<li class="md-tabs__item">
<a href="../DEBUG_TIPS/" class="md-tabs__link">
Troubleshooting
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../DEV_ENV_SETUP/" class="md-tabs__link">
Development
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="NetAlertX Documentation" class="md-nav__button md-logo" aria-label="NetAlertX Documentation" data-md-component="logo">
<img src="../img/netalertx_docs.png" alt="logo">
</a>
NetAlertX Documentation
</label>
<div class="md-nav__source">
<a href="https://github.com/jokob-sk/NetAlertX/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Installation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Installation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../INSTALLATION/" class="md-nav__link">
<span class="md-ellipsis">
Installation options
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../INITIAL_SETUP/" class="md-nav__link">
<span class="md-ellipsis">
Quick setup
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3" >
<label class="md-nav__link" for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
<span class="md-ellipsis">
Docker
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_3">
<span class="md-nav__icon md-icon"></span>
Docker
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../DOCKER_INSTALLATION/" class="md-nav__link">
<span class="md-ellipsis">
Docker Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DOCKER_COMPOSE/" class="md-nav__link">
<span class="md-ellipsis">
Docker Compose
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../FILE_PERMISSIONS/" class="md-nav__link">
<span class="md-ellipsis">
Docker File Permissions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../UPDATES/" class="md-nav__link">
<span class="md-ellipsis">
Docker Updates
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DOCKER_MAINTENANCE/" class="md-nav__link">
<span class="md-ellipsis">
Docker Maintenance
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" >
<label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
<span class="md-ellipsis">
Docker Startup Troubleshooting
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_4">
<span class="md-nav__icon md-icon"></span>
Docker Startup Troubleshooting
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../docker-troubleshooting/aufs-capabilities/" class="md-nav__link">
<span class="md-ellipsis">
Aufs capabilities
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docker-troubleshooting/excessive-capabilities/" class="md-nav__link">
<span class="md-ellipsis">
Excessive capabilities
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docker-troubleshooting/file-permissions/" class="md-nav__link">
<span class="md-ellipsis">
File permissions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docker-troubleshooting/incorrect-user/" class="md-nav__link">
<span class="md-ellipsis">
Incorrect user
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docker-troubleshooting/missing-capabilities/" class="md-nav__link">
<span class="md-ellipsis">
Missing capabilities
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docker-troubleshooting/mount-configuration-issues/" class="md-nav__link">
<span class="md-ellipsis">
Mount issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docker-troubleshooting/network-mode/" class="md-nav__link">
<span class="md-ellipsis">
Network mode
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docker-troubleshooting/nginx-configuration-mount/" class="md-nav__link">
<span class="md-ellipsis">
Nginx mount
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docker-troubleshooting/port-conflicts/" class="md-nav__link">
<span class="md-ellipsis">
Port conflicts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docker-troubleshooting/read-only-filesystem/" class="md-nav__link">
<span class="md-ellipsis">
Read only
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docker-troubleshooting/running-as-root/" class="md-nav__link">
<span class="md-ellipsis">
Running as root
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
<label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
<span class="md-ellipsis">
Other
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_5">
<span class="md-nav__icon md-icon"></span>
Other
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../SYNOLOGY_GUIDE/" class="md-nav__link">
<span class="md-ellipsis">
Synology Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DOCKER_PORTAINER/" class="md-nav__link">
<span class="md-ellipsis">
Portainer Stacks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../COMMUNITY_GUIDES/" class="md-nav__link">
<span class="md-ellipsis">
Community Guides
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../HW_INSTALL/" class="md-nav__link">
<span class="md-ellipsis">
Bare-metal (Experimental)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../MIGRATION/" class="md-nav__link">
<span class="md-ellipsis">
Migration Guide
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_6" >
<label class="md-nav__link" for="__nav_2_6" id="__nav_2_6_label" tabindex="0">
<span class="md-ellipsis">
Help
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_6">
<span class="md-nav__icon md-icon"></span>
Help
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../COMMON_ISSUES/" class="md-nav__link">
<span class="md-ellipsis">
Common issues
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Setup
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Setup
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_1" >
<label class="md-nav__link" for="__nav_3_1" id="__nav_3_1_label" tabindex="0">
<span class="md-ellipsis">
Getting started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_1">
<span class="md-nav__icon md-icon"></span>
Getting started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../SUBNETS/" class="md-nav__link">
<span class="md-ellipsis">
Subnets
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../PLUGINS/" class="md-nav__link">
<span class="md-ellipsis">
Enable Plugins
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../PIHOLE_GUIDE/" class="md-nav__link">
<span class="md-ellipsis">
Pi-hole Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../HOME_ASSISTANT/" class="md-nav__link">
<span class="md-ellipsis">
Home Assistant
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../SMTP/" class="md-nav__link">
<span class="md-ellipsis">
Emails
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../BACKUPS/" class="md-nav__link">
<span class="md-ellipsis">
Backups
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../SECURITY_FEATURES/" class="md-nav__link">
<span class="md-ellipsis">
Security Features
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../SECURITY/" class="md-nav__link">
<span class="md-ellipsis">
Security Considerations
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" >
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
<span class="md-ellipsis">
Advanced guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2">
<span class="md-nav__icon md-icon"></span>
Advanced guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../REMOTE_NETWORKS/" class="md-nav__link">
<span class="md-ellipsis">
Remote Networks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../NOTIFICATIONS/" class="md-nav__link">
<span class="md-ellipsis">
Notifications Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../PUID_PGID_SECURITY/" class="md-nav__link">
<span class="md-ellipsis">
Custom PUID/GUID
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../NAME_RESOLUTION/" class="md-nav__link">
<span class="md-ellipsis">
Name Resolution
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../AUTHELIA/" class="md-nav__link">
<span class="md-ellipsis">
Authelia
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../PERFORMANCE/" class="md-nav__link">
<span class="md-ellipsis">
Performance
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../REVERSE_DNS/" class="md-nav__link">
<span class="md-ellipsis">
Reverse DNS
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../REVERSE_PROXY/" class="md-nav__link">
<span class="md-ellipsis">
Reverse Proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../WEBHOOK_N8N/" class="md-nav__link">
<span class="md-ellipsis">
Webhooks (n8n)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../WORKFLOWS/" class="md-nav__link">
<span class="md-ellipsis">
Workflows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../WORKFLOW_EXAMPLES/" class="md-nav__link">
<span class="md-ellipsis">
Workflow Examples
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DOCKER_SWARM/" class="md-nav__link">
<span class="md-ellipsis">
Docker Swarm
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_3" >
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">
<span class="md-ellipsis">
Help
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
Help
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../COMMON_ISSUES/" class="md-nav__link">
<span class="md-ellipsis">
Common issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../RANDOM_MAC/" class="md-nav__link">
<span class="md-ellipsis">
Random MAC
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../FIX_OFFLINE_DETECTION/" class="md-nav__link">
<span class="md-ellipsis">
Incorrect Offline Detection
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Device guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Device guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_1" >
<label class="md-nav__link" for="__nav_4_1" id="__nav_4_1_label" tabindex="0">
<span class="md-ellipsis">
Editing Devices
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_1">
<span class="md-nav__icon md-icon"></span>
Editing Devices
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../DEVICE_MANAGEMENT/" class="md-nav__link">
<span class="md-ellipsis">
Management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DEVICES_BULK_EDITING/" class="md-nav__link">
<span class="md-ellipsis">
Bulk Editing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../CUSTOM_PROPERTIES/" class="md-nav__link">
<span class="md-ellipsis">
Custom Properties
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DEVICE_DISPLAY_SETTINGS/" class="md-nav__link">
<span class="md-ellipsis">
Device Display Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../SESSION_INFO/" class="md-nav__link">
<span class="md-ellipsis">
Session Info
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" >
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Icons and Topology
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Icons and Topology
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../ICONS/" class="md-nav__link">
<span class="md-ellipsis">
Icons
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../NETWORK_TREE/" class="md-nav__link">
<span class="md-ellipsis">
Network Topology
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Troubleshooting
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Troubleshooting
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../DEBUG_TIPS/" class="md-nav__link">
<span class="md-ellipsis">
General Tips
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../COMMON_ISSUES/" class="md-nav__link">
<span class="md-ellipsis">
Common issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LOGGING/" class="md-nav__link">
<span class="md-ellipsis">
Inspecting Logs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DEBUG_API_SERVER/" class="md-nav__link">
<span class="md-ellipsis">
API Server Issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DEBUG_INVALID_JSON/" class="md-nav__link">
<span class="md-ellipsis">
Invalid JSON Issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DEBUG_PHP/" class="md-nav__link">
<span class="md-ellipsis">
PHP Issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DEBUG_PLUGINS/" class="md-nav__link">
<span class="md-ellipsis">
Plugin Issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../WEB_UI_PORT_DEBUG/" class="md-nav__link">
<span class="md-ellipsis">
Web UI Port Issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../WORKFLOWS_DEBUGGING/" class="md-nav__link">
<span class="md-ellipsis">
Workflows Issues
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis">
Development
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Development
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
<label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="">
<span class="md-ellipsis">
Plugin and app development
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span>
Plugin and app development
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../DEV_ENV_SETUP/" class="md-nav__link">
<span class="md-ellipsis">
Environment Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../BUILDS/" class="md-nav__link">
<span class="md-ellipsis">
Builds
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DEV_DEVCONTAINER/" class="md-nav__link">
<span class="md-ellipsis">
Devcontainer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DEV_PORTS_HOST_MODE/" class="md-nav__link">
<span class="md-ellipsis">
Devcontainer Ports
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1_5" checked>
<label class="md-nav__link" for="__nav_6_1_5" id="__nav_6_1_5_label" tabindex="0">
<span class="md-ellipsis">
Custom Plugins
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_6_1_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6_1_5">
<span class="md-nav__icon md-icon"></span>
Custom Plugins
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Overview
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Overview
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#quick-links" class="md-nav__link">
<span class="md-ellipsis">
Quick Links
</span>
</a>
<nav class="md-nav" aria-label="Quick Links">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
<span class="md-ellipsis">
🚀 Getting Started
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#core-concepts" class="md-nav__link">
<span class="md-ellipsis">
📚 Core Concepts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#architecture" class="md-nav__link">
<span class="md-ellipsis">
🏗️ Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
🐛 Troubleshooting
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#video-tutorial" class="md-nav__link">
<span class="md-ellipsis">
🎥 Video Tutorial
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#screenshots" class="md-nav__link">
<span class="md-ellipsis">
📸 Screenshots
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#use-cases" class="md-nav__link">
<span class="md-ellipsis">
Use Cases
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#limitations-notes" class="md-nav__link">
<span class="md-ellipsis">
Limitations &amp; Notes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#plugin-development-workflow" class="md-nav__link">
<span class="md-ellipsis">
Plugin Development Workflow
</span>
</a>
<nav class="md-nav" aria-label="Plugin Development Workflow">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#step-1-understand-the-basics" class="md-nav__link">
<span class="md-ellipsis">
Step 1: Understand the Basics
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-2-create-your-plugin" class="md-nav__link">
<span class="md-ellipsis">
Step 2: Create Your Plugin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-3-configure-display" class="md-nav__link">
<span class="md-ellipsis">
Step 3: Configure &amp; Display
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-4-deploy-test" class="md-nav__link">
<span class="md-ellipsis">
Step 4: Deploy &amp; Test
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#plugin-file-structure" class="md-nav__link">
<span class="md-ellipsis">
Plugin File Structure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#plugin-manifest-configjson" class="md-nav__link">
<span class="md-ellipsis">
Plugin Manifest (config.json)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#full-reference-below" class="md-nav__link">
<span class="md-ellipsis">
Full Reference (Below)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#data-contract-output-format" class="md-nav__link">
<span class="md-ellipsis">
Data Contract &amp; Output Format
</span>
</a>
<nav class="md-nav" aria-label="Data Contract &amp; Output Format">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#the-9-mandatory-columns" class="md-nav__link">
<span class="md-ellipsis">
The 9 Mandatory Columns
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#configjson-settings-configuration" class="md-nav__link">
<span class="md-ellipsis">
Config.json: Settings &amp; Configuration
</span>
</a>
<nav class="md-nav" aria-label="Config.json: Settings &amp; Configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#setting-object-structure" class="md-nav__link">
<span class="md-ellipsis">
Setting Object Structure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reserved-function-names" class="md-nav__link">
<span class="md-ellipsis">
Reserved Function Names
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#filters-data-display" class="md-nav__link">
<span class="md-ellipsis">
Filters &amp; Data Display
</span>
</a>
<nav class="md-nav" aria-label="Filters &amp; Data Display">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#filters" class="md-nav__link">
<span class="md-ellipsis">
Filters
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#database-mapping" class="md-nav__link">
<span class="md-ellipsis">
Database Mapping
</span>
</a>
<nav class="md-nav" aria-label="Database Mapping">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#static-value-mapping" class="md-nav__link">
<span class="md-ellipsis">
Static Value Mapping
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#ui-component-types" class="md-nav__link">
<span class="md-ellipsis">
UI Component Types
</span>
</a>
<nav class="md-nav" aria-label="UI Component Types">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#common-display-types" class="md-nav__link">
<span class="md-ellipsis">
Common Display Types
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#quick-reference-key-concepts" class="md-nav__link">
<span class="md-ellipsis">
Quick Reference: Key Concepts
</span>
</a>
<nav class="md-nav" aria-label="Quick Reference: Key Concepts">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#plugin-output-format" class="md-nav__link">
<span class="md-ellipsis">
Plugin Output Format
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#plugin-metadata-configjson" class="md-nav__link">
<span class="md-ellipsis">
Plugin Metadata (config.json)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reserved-settings" class="md-nav__link">
<span class="md-ellipsis">
Reserved Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#display-types" class="md-nav__link">
<span class="md-ellipsis">
Display Types
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#tools-references" class="md-nav__link">
<span class="md-ellipsis">
Tools &amp; References
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../PLUGINS_DEV_QUICK_START/" class="md-nav__link">
<span class="md-ellipsis">
Quick Start
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../PLUGINS_DEV_DATA_CONTRACT/" class="md-nav__link">
<span class="md-ellipsis">
Data Contract
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../PLUGINS_DEV_SETTINGS/" class="md-nav__link">
<span class="md-ellipsis">
Settings System
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../PLUGINS_DEV_DATASOURCES/" class="md-nav__link">
<span class="md-ellipsis">
Data Sources
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../PLUGINS_DEV_UI_COMPONENTS/" class="md-nav__link">
<span class="md-ellipsis">
UI Components
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../PLUGINS_DEV_CONFIG/" class="md-nav__link">
<span class="md-ellipsis">
Config Lifecycle
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../FRONTEND_DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Frontend Development
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DATABASE/" class="md-nav__link">
<span class="md-ellipsis">
Database
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../SETTINGS_SYSTEM/" class="md-nav__link">
<span class="md-ellipsis">
Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../VERSIONS/" class="md-nav__link">
<span class="md-ellipsis">
Versions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../DEVICE_HEURISTICS/" class="md-nav__link">
<span class="md-ellipsis">
Icon and Type guessing
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
<label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="">
<span class="md-ellipsis">
API
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_2">
<span class="md-nav__icon md-icon"></span>
API
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../API/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_DEVICES/" class="md-nav__link">
<span class="md-ellipsis">
Devices Collection
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_DEVICE/" class="md-nav__link">
<span class="md-ellipsis">
Device
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_SESSIONS/" class="md-nav__link">
<span class="md-ellipsis">
Sessions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_SETTINGS/" class="md-nav__link">
<span class="md-ellipsis">
Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_EVENTS/" class="md-nav__link">
<span class="md-ellipsis">
Events
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_MESSAGING_IN_APP/" class="md-nav__link">
<span class="md-ellipsis">
Messaging in-app
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_METRICS/" class="md-nav__link">
<span class="md-ellipsis">
Metrics
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_NETTOOLS/" class="md-nav__link">
<span class="md-ellipsis">
Net Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_ONLINEHISTORY/" class="md-nav__link">
<span class="md-ellipsis">
Online History
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_SYNC/" class="md-nav__link">
<span class="md-ellipsis">
Sync
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_LOGS/" class="md-nav__link">
<span class="md-ellipsis">
Logs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_SSE/" class="md-nav__link">
<span class="md-ellipsis">
SSE
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_GRAPHQL/" class="md-nav__link">
<span class="md-ellipsis">
GraphQL
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_DBQUERY/" class="md-nav__link">
<span class="md-ellipsis">
DB query
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_MCP/" class="md-nav__link">
<span class="md-ellipsis">
MCP
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_TESTS/" class="md-nav__link">
<span class="md-ellipsis">
Tests
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API_OLD/" class="md-nav__link">
<span class="md-ellipsis">
SUPERSEDED OLD API Overview
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
<label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="">
<span class="md-ellipsis">
Integrations
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_3">
<span class="md-nav__icon md-icon"></span>
Integrations
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../WEBHOOK_SECRET/" class="md-nav__link">
<span class="md-ellipsis">
Webhook Secret
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../HELPER_SCRIPTS/" class="md-nav__link">
<span class="md-ellipsis">
Helper scripts
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#quick-links" class="md-nav__link">
<span class="md-ellipsis">
Quick Links
</span>
</a>
<nav class="md-nav" aria-label="Quick Links">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
<span class="md-ellipsis">
🚀 Getting Started
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#core-concepts" class="md-nav__link">
<span class="md-ellipsis">
📚 Core Concepts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#architecture" class="md-nav__link">
<span class="md-ellipsis">
🏗️ Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
🐛 Troubleshooting
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#video-tutorial" class="md-nav__link">
<span class="md-ellipsis">
🎥 Video Tutorial
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#screenshots" class="md-nav__link">
<span class="md-ellipsis">
📸 Screenshots
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#use-cases" class="md-nav__link">
<span class="md-ellipsis">
Use Cases
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#limitations-notes" class="md-nav__link">
<span class="md-ellipsis">
Limitations &amp; Notes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#plugin-development-workflow" class="md-nav__link">
<span class="md-ellipsis">
Plugin Development Workflow
</span>
</a>
<nav class="md-nav" aria-label="Plugin Development Workflow">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#step-1-understand-the-basics" class="md-nav__link">
<span class="md-ellipsis">
Step 1: Understand the Basics
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-2-create-your-plugin" class="md-nav__link">
<span class="md-ellipsis">
Step 2: Create Your Plugin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-3-configure-display" class="md-nav__link">
<span class="md-ellipsis">
Step 3: Configure &amp; Display
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-4-deploy-test" class="md-nav__link">
<span class="md-ellipsis">
Step 4: Deploy &amp; Test
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#plugin-file-structure" class="md-nav__link">
<span class="md-ellipsis">
Plugin File Structure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#plugin-manifest-configjson" class="md-nav__link">
<span class="md-ellipsis">
Plugin Manifest (config.json)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#full-reference-below" class="md-nav__link">
<span class="md-ellipsis">
Full Reference (Below)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#data-contract-output-format" class="md-nav__link">
<span class="md-ellipsis">
Data Contract &amp; Output Format
</span>
</a>
<nav class="md-nav" aria-label="Data Contract &amp; Output Format">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#the-9-mandatory-columns" class="md-nav__link">
<span class="md-ellipsis">
The 9 Mandatory Columns
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#configjson-settings-configuration" class="md-nav__link">
<span class="md-ellipsis">
Config.json: Settings &amp; Configuration
</span>
</a>
<nav class="md-nav" aria-label="Config.json: Settings &amp; Configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#setting-object-structure" class="md-nav__link">
<span class="md-ellipsis">
Setting Object Structure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reserved-function-names" class="md-nav__link">
<span class="md-ellipsis">
Reserved Function Names
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#filters-data-display" class="md-nav__link">
<span class="md-ellipsis">
Filters &amp; Data Display
</span>
</a>
<nav class="md-nav" aria-label="Filters &amp; Data Display">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#filters" class="md-nav__link">
<span class="md-ellipsis">
Filters
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#database-mapping" class="md-nav__link">
<span class="md-ellipsis">
Database Mapping
</span>
</a>
<nav class="md-nav" aria-label="Database Mapping">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#static-value-mapping" class="md-nav__link">
<span class="md-ellipsis">
Static Value Mapping
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#ui-component-types" class="md-nav__link">
<span class="md-ellipsis">
UI Component Types
</span>
</a>
<nav class="md-nav" aria-label="UI Component Types">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#common-display-types" class="md-nav__link">
<span class="md-ellipsis">
Common Display Types
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#quick-reference-key-concepts" class="md-nav__link">
<span class="md-ellipsis">
Quick Reference: Key Concepts
</span>
</a>
<nav class="md-nav" aria-label="Quick Reference: Key Concepts">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#plugin-output-format" class="md-nav__link">
<span class="md-ellipsis">
Plugin Output Format
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#plugin-metadata-configjson" class="md-nav__link">
<span class="md-ellipsis">
Plugin Metadata (config.json)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reserved-settings" class="md-nav__link">
<span class="md-ellipsis">
Reserved Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#display-types" class="md-nav__link">
<span class="md-ellipsis">
Display Types
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#tools-references" class="md-nav__link">
<span class="md-ellipsis">
Tools &amp; References
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS_DEV.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
</a>
<a href="https://github.com/jokob-sk/NetAlertX/raw/main/docs/PLUGINS_DEV.md" title="View source of this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg>
</a>
<h1 id="plugin-development-guide">Plugin Development Guide</h1>
<p>This comprehensive guide covers how to build plugins for NetAlertX.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p><strong>New to plugin development?</strong> Start with the <a href="../PLUGINS_DEV_QUICK_START/">Quick Start Guide</a> to get a working plugin in 5 minutes.</p>
</div>
<p>NetAlertX comes with a plugin system to feed events from third-party scripts into the UI and then send notifications, if desired. The highlighted core functionality this plugin system supports:</p>
<ul>
<li><strong>Dynamic UI generation</strong> - Automatically create tables for discovered objects</li>
<li><strong>Data filtering</strong> - Filter and link values in the Devices UI</li>
<li><strong>User settings</strong> - Surface plugin configuration in the Settings UI</li>
<li><strong>Rich display types</strong> - Color-coded badges, links, formatted text, and more</li>
<li><strong>Database integration</strong> - Import plugin data into NetAlertX tables like <code>CurrentScan</code> or <code>Devices</code></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For a high-level overview of how the <code>config.json</code> is used and its lifecycle, see the <a href="../PLUGINS_DEV_CONFIG/">config.json Lifecycle Guide</a>.</p>
</div>
<h2 id="quick-links">Quick Links</h2>
<h3 id="getting-started">🚀 Getting Started</h3>
<ul>
<li><strong><a href="../PLUGINS_DEV_QUICK_START/">Quick Start Guide</a></strong> - Create a working plugin in 5 minutes</li>
<li><strong><a href="../DEV_ENV_SETUP/">Development Environment Setup</a></strong> - Set up your local development environment</li>
</ul>
<h3 id="core-concepts">📚 Core Concepts</h3>
<ul>
<li><strong><a href="../PLUGINS_DEV_DATA_CONTRACT/">Data Contract</a></strong> - The exact output format plugins must follow (9-13 columns, pipe-delimited)</li>
<li><strong><a href="../PLUGINS_DEV_DATASOURCES/">Data Sources</a></strong> - How plugins retrieve data (scripts, databases, templates)</li>
<li><strong><a href="../PLUGINS_DEV_SETTINGS/">Plugin Settings System</a></strong> - Let users configure your plugin via the UI</li>
<li><strong><a href="../PLUGINS_DEV_UI_COMPONENTS/">UI Components</a></strong> - Display plugin results with color coding, links, and more</li>
</ul>
<h3 id="architecture">🏗️ Architecture</h3>
<ul>
<li><strong><a href="../PLUGINS_DEV_CONFIG/">Plugin Config Lifecycle</a></strong> - How <code>config.json</code> is loaded and used</li>
<li><strong><a href="#full-reference-below">Full Plugin Development Reference</a></strong> - Comprehensive details on all aspects</li>
</ul>
<h3 id="troubleshooting">🐛 Troubleshooting</h3>
<ul>
<li><strong><a href="../DEBUG_PLUGINS/">Debugging Plugins</a></strong> - Troubleshoot plugin issues</li>
<li><strong><a href="../front/plugins">Plugin Examples</a></strong> - Study existing plugins as reference implementations</li>
</ul>
<h3 id="video-tutorial">🎥 Video Tutorial</h3>
<p><a href="https://youtu.be/cdbxlwiWhv8"><img alt="Watch the video" src="../img/YouTube_thumbnail.png" /></a></p>
<h3 id="screenshots">📸 Screenshots</h3>
<table>
<thead>
<tr>
<th><img alt="Screen 1" src="https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins.png" title="Screen 1" /></th>
<th><img alt="Screen 2" src="https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins_settings.png" title="Screen 2" /></th>
<th><img alt="Screen 3" src="https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins_json_settings.png" title="Screen 3" /></th>
</tr>
</thead>
<tbody>
<tr>
<td><img alt="Screen 4" src="https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins_json_ui.png" title="Screen 4" /></td>
<td><img alt="Screen 5" src="https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins_device_details.png" title="Screen 5" /></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="use-cases">Use Cases</h2>
<p>Plugins are infinitely flexible. Here are some examples:</p>
<ul>
<li><strong>Device Discovery</strong> - Scan networks using ARP, mDNS, DHCP leases, or custom protocols</li>
<li><strong>Service Monitoring</strong> - Monitor web services, APIs, or network services for availability</li>
<li><strong>Integration</strong> - Import devices from PiHole, Home Assistant, Unifi, or other systems</li>
<li><strong>Enrichment</strong> - Add data like geolocation, threat intelligence, or asset metadata</li>
<li><strong>Alerting</strong> - Send notifications to Slack, Discord, Telegram, email, or webhooks</li>
<li><strong>Reporting</strong> - Generate insights from existing NetAlertX database (open ports, recent changes, etc.)</li>
<li><strong>Custom Logic</strong> - Create fake devices, trigger automations, or implement custom heuristics</li>
</ul>
<p>If you can imagine it and script it, you can build a plugin.</p>
<h2 id="limitations-notes">Limitations &amp; Notes</h2>
<ul>
<li>Plugin data is deduplicated hourly (same Primary ID + Secondary ID + User Data = duplicate removed)</li>
<li>Currently, only <code>CurrentScan</code> table supports update/overwrite of existing objects</li>
<li>Plugin results must follow the strict <a href="../PLUGINS_DEV_DATA_CONTRACT/">Data Contract</a></li>
<li>Plugins run with the same permissions as the NetAlertX process</li>
<li>External dependencies must be installed in the container</li>
</ul>
<h2 id="plugin-development-workflow">Plugin Development Workflow</h2>
<h3 id="step-1-understand-the-basics">Step 1: Understand the Basics</h3>
<ol>
<li>Read <a href="../PLUGINS_DEV_QUICK_START/">Quick Start Guide</a> - 5 minute overview</li>
<li>Study the <a href="../PLUGINS_DEV_DATA_CONTRACT/">Data Contract</a> - Understand the output format</li>
<li>Choose a <a href="../PLUGINS_DEV_DATASOURCES/">Data Source</a> - Where does your data come from?</li>
</ol>
<h3 id="step-2-create-your-plugin">Step 2: Create Your Plugin</h3>
<ol>
<li>Copy the <code>__template</code> plugin folder (see below for structure)</li>
<li>Update <code>config.json</code> with your plugin metadata</li>
<li>Implement <code>script.py</code> (or configure alternative data source)</li>
<li>Test locally in the devcontainer</li>
</ol>
<h3 id="step-3-configure-display">Step 3: Configure &amp; Display</h3>
<ol>
<li>Define <a href="../PLUGINS_DEV_SETTINGS/">Settings</a> for user configuration</li>
<li>Design <a href="../PLUGINS_DEV_UI_COMPONENTS/">UI Components</a> for result display</li>
<li>Map to database tables if needed (for notifications, etc.)</li>
</ol>
<h3 id="step-4-deploy-test">Step 4: Deploy &amp; Test</h3>
<ol>
<li>Restart the backend</li>
<li>Test via Settings → Plugin Settings</li>
<li>Verify results in UI and logs</li>
<li>Check <code>/tmp/log/plugins/last_result.&lt;PREFIX&gt;.log</code></li>
</ol>
<p>See <a href="../PLUGINS_DEV_QUICK_START/">Quick Start Guide</a> for detailed step-by-step instructions.</p>
<h2 id="plugin-file-structure">Plugin File Structure</h2>
<p>Every plugin lives in its own folder under <code>/app/front/plugins/</code>.</p>
<blockquote>
<p><strong>Important:</strong> Folder name must match the <code>"code_name"</code> value in <code>config.json</code></p>
</blockquote>
<div class="highlight"><pre><span></span><code>/app/front/plugins/
├── __template/ # Copy this as a starting point
│ ├── config.json # Plugin manifest (configuration)
│ ├── script.py # Your plugin logic (optional, depends on data_source)
│ └── README.md # Setup and usage documentation
├── my_plugin/ # Your new plugin
│ ├── config.json # REQUIRED - Plugin manifest
│ ├── script.py # OPTIONAL - Python script (if using script data source)
│ ├── README.md # REQUIRED - Documentation for users
│ └── other_files... # Your supporting files
</code></pre></div>
<h2 id="plugin-manifest-configjson">Plugin Manifest (config.json)</h2>
<p>The <code>config.json</code> file is the <strong>plugin manifest</strong> - it tells NetAlertX everything about your plugin:</p>
<ul>
<li><strong>Metadata:</strong> Plugin name, description, icon</li>
<li><strong>Execution:</strong> When to run, what command to run, timeout</li>
<li><strong>Settings:</strong> User-configurable options</li>
<li><strong>Data contract:</strong> Column definitions and how to display results</li>
<li><strong>Integration:</strong> Database mappings, notifications, filters</li>
</ul>
<p><strong>Example minimal config.json:</strong></p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;code_name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;my_plugin&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;unique_prefix&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MYPLN&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;display_name&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="nt">&quot;language_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;en_us&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;string&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;My Plugin&quot;</span><span class="p">}],</span>
<span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="nt">&quot;language_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;en_us&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;string&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;My awesome plugin&quot;</span><span class="p">}],</span>
<span class="w"> </span><span class="nt">&quot;icon&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;fa-plug&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;data_source&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;script&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;execution_order&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Layer_0&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;settings&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;function&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;RUN&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;dataType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;elements&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="nt">&quot;elementType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;select&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;elementOptions&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w"> </span><span class="nt">&quot;transformers&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[]}]},</span>
<span class="w"> </span><span class="nt">&quot;default_value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;disabled&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;options&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;disabled&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;once&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;schedule&quot;</span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;localized&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;name&quot;</span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="nt">&quot;language_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;en_us&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;string&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;When to run&quot;</span><span class="p">}]</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;function&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;CMD&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;dataType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;elements&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="nt">&quot;elementType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;input&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;elementOptions&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w"> </span><span class="nt">&quot;transformers&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[]}]},</span>
<span class="w"> </span><span class="nt">&quot;default_value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;python3 /app/front/plugins/my_plugin/script.py&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;localized&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;name&quot;</span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="nt">&quot;language_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;en_us&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;string&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Command&quot;</span><span class="p">}]</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;database_column_definitions&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span>
<span class="p">}</span>
</code></pre></div>
<blockquote>
<p>For comprehensive <code>config.json</code> documentation, see <a href="../PLUGINS_DEV_CONFIG/">PLUGINS_DEV_CONFIG.md</a></p>
</blockquote>
<h2 id="full-reference-below">Full Reference (Below)</h2>
<p>The sections below provide complete reference documentation for all plugin development topics. Use the quick links above to jump to specific sections, or read sequentially for a deep dive.</p>
<p>More on specifics below.</p>
<hr />
<h2 id="data-contract-output-format">Data Contract &amp; Output Format</h2>
<p>For detailed information on plugin output format, see <strong><a href="../PLUGINS_DEV_DATA_CONTRACT/">PLUGINS_DEV_DATA_CONTRACT.md</a></strong>.</p>
<p>Quick reference:
- <strong>Format:</strong> Pipe-delimited (<code>|</code>) text file
- <strong>Location:</strong> <code>/tmp/log/plugins/last_result.&lt;PREFIX&gt;.log</code>
- <strong>Columns:</strong> 9 required + 4 optional = 13 maximum
- <strong>Helper:</strong> Use <code>plugin_helper.py</code> for easy formatting</p>
<h3 id="the-9-mandatory-columns">The 9 Mandatory Columns</h3>
<table>
<thead>
<tr>
<th>Column</th>
<th>Name</th>
<th>Required</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>0</td>
<td>Object_PrimaryID</td>
<td><strong>YES</strong></td>
<td><code>"device_name"</code> or <code>"192.168.1.1"</code></td>
</tr>
<tr>
<td>1</td>
<td>Object_SecondaryID</td>
<td>no</td>
<td><code>"secondary_id"</code> or <code>null</code></td>
</tr>
<tr>
<td>2</td>
<td>DateTime</td>
<td><strong>YES</strong></td>
<td><code>"2023-01-02 15:56:30"</code></td>
</tr>
<tr>
<td>3</td>
<td>Watched_Value1</td>
<td><strong>YES</strong></td>
<td><code>"online"</code> or <code>"200"</code></td>
</tr>
<tr>
<td>4</td>
<td>Watched_Value2</td>
<td>no</td>
<td><code>"ip_address"</code> or <code>null</code></td>
</tr>
<tr>
<td>5</td>
<td>Watched_Value3</td>
<td>no</td>
<td><code>null</code></td>
</tr>
<tr>
<td>6</td>
<td>Watched_Value4</td>
<td>no</td>
<td><code>null</code></td>
</tr>
<tr>
<td>7</td>
<td>Extra</td>
<td>no</td>
<td><code>"additional data"</code> or <code>null</code></td>
</tr>
<tr>
<td>8</td>
<td>ForeignKey</td>
<td>no</td>
<td><code>"aa:bb:cc:dd:ee:ff"</code> or <code>null</code></td>
</tr>
</tbody>
</table>
<p>See <a href="../PLUGINS_DEV_DATA_CONTRACT/">Data Contract</a> for examples, validation, and debugging tips.</p>
<hr />
<h2 id="configjson-settings-configuration">Config.json: Settings &amp; Configuration</h2>
<p>For detailed settings documentation, see <strong><a href="../PLUGINS_DEV_SETTINGS/">PLUGINS_DEV_SETTINGS.md</a></strong> and <strong><a href="../PLUGINS_DEV_DATASOURCES/">PLUGINS_DEV_DATASOURCES.md</a></strong>.</p>
<h3 id="setting-object-structure">Setting Object Structure</h3>
<p>Every setting in your plugin has this structure:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;function&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;UNIQUE_CODE&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;dataType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;elements&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="err">...</span><span class="p">]},</span>
<span class="w"> </span><span class="nt">&quot;default_value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;...&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;options&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="err">...</span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;localized&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;name&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;description&quot;</span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="nt">&quot;language_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;en_us&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;string&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Display Name&quot;</span><span class="p">}],</span>
<span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="nt">&quot;language_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;en_us&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;string&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Help text&quot;</span><span class="p">}]</span>
<span class="p">}</span>
</code></pre></div>
<h3 id="reserved-function-names">Reserved Function Names</h3>
<p>These control core plugin behavior:</p>
<table>
<thead>
<tr>
<th>Function</th>
<th>Purpose</th>
<th>Required</th>
<th>Options</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>RUN</code></td>
<td>When to execute</td>
<td><strong>YES</strong></td>
<td><code>disabled</code>, <code>once</code>, <code>schedule</code>, <code>always_after_scan</code>, <code>before_name_updates</code>, <code>on_new_device</code></td>
</tr>
<tr>
<td><code>RUN_SCHD</code></td>
<td>Cron schedule</td>
<td>If <code>RUN=schedule</code></td>
<td>Cron format: <code>"0 * * * *"</code></td>
</tr>
<tr>
<td><code>CMD</code></td>
<td>Command to run</td>
<td><strong>YES</strong></td>
<td>Shell command or script path</td>
</tr>
<tr>
<td><code>RUN_TIMEOUT</code></td>
<td>Max execution time</td>
<td>optional</td>
<td>Seconds: <code>"60"</code></td>
</tr>
<tr>
<td><code>WATCH</code></td>
<td>Monitor for changes</td>
<td>optional</td>
<td>Column names</td>
</tr>
<tr>
<td><code>REPORT_ON</code></td>
<td>When to notify</td>
<td>optional</td>
<td><code>new</code>, <code>watched-changed</code>, <code>watched-not-changed</code>, <code>missing-in-last-scan</code></td>
</tr>
<tr>
<td><code>DB_PATH</code></td>
<td>External DB path</td>
<td>If using SQLite</td>
<td><code>/path/to/db.db</code></td>
</tr>
</tbody>
</table>
<p>See <a href="../PLUGINS_DEV_SETTINGS/">PLUGINS_DEV_SETTINGS.md</a> for full component types and examples.</p>
<hr />
<h2 id="filters-data-display">Filters &amp; Data Display</h2>
<p>For comprehensive display configuration, see <strong><a href="../PLUGINS_DEV_UI_COMPONENTS/">PLUGINS_DEV_UI_COMPONENTS.md</a></strong>.</p>
<h3 id="filters">Filters</h3>
<p>Control which rows display in the UI:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;data_filters&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;compare_column&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Object_PrimaryID&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;compare_operator&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;==&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;compare_field_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;txtMacFilter&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;compare_js_template&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&#39;{value}&#39;.toString()&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;compare_use_quotes&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">]</span>
<span class="p">}</span>
</code></pre></div>
<p>See <a href="../PLUGINS_DEV_UI_COMPONENTS/#filters">UI Components: Filters</a> for full documentation.</p>
<hr />
<h2 id="database-mapping">Database Mapping</h2>
<p>To import plugin data into NetAlertX tables for device discovery or notifications:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;mapped_to_table&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;CurrentScan&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;database_column_definitions&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;column&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Object_PrimaryID&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;mapped_to_column&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;cur_MAC&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;show&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;device_mac&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;localized&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;name&quot;</span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="nt">&quot;language_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;en_us&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;string&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MAC Address&quot;</span><span class="p">}]</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">]</span>
<span class="p">}</span>
</code></pre></div>
<p>See <a href="../PLUGINS_DEV_UI_COMPONENTS/#mapping-to-database-tables">UI Components: Database Mapping</a> for full documentation.</p>
<h3 id="static-value-mapping">Static Value Mapping</h3>
<p>To always map a static value (not read from plugin output):</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;column&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;NameDoesntMatter&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;mapped_to_column&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;cur_ScanMethod&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;mapped_to_column_data&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MYPLN&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<hr />
<h2 id="ui-component-types">UI Component Types</h2>
<p>Plugin results are displayed in the web interface using various component types. See <strong><a href="../PLUGINS_DEV_UI_COMPONENTS/">PLUGINS_DEV_UI_COMPONENTS.md</a></strong> for complete documentation.</p>
<h3 id="common-display-types">Common Display Types</h3>
<p><strong>Read settings in your Python script:</strong></p>
<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">helper</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_setting_value</span>
<span class="c1"># Read a setting by code name (prefix + function)</span>
<span class="n">api_url</span> <span class="o">=</span> <span class="n">get_setting_value</span><span class="p">(</span><span class="s1">&#39;MYPLN_API_URL&#39;</span><span class="p">)</span>
<span class="n">api_key</span> <span class="o">=</span> <span class="n">get_setting_value</span><span class="p">(</span><span class="s1">&#39;MYPLN_API_KEY&#39;</span><span class="p">)</span>
<span class="n">watch_columns</span> <span class="o">=</span> <span class="n">get_setting_value</span><span class="p">(</span><span class="s1">&#39;MYPLN_WATCH&#39;</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Connecting to </span><span class="si">{</span><span class="n">api_url</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</code></pre></div>
<p><strong>Pass settings as command parameters:</strong></p>
<p>Define <code>params</code> in config to pass settings as script arguments:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;params&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;api_url&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;setting&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MYPLN_API_URL&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">]</span>
<span class="p">}</span>
</code></pre></div>
<p>Then use in <code>CMD</code>: <code>python3 script.py --url={api_url}</code></p>
<p>See <a href="../PLUGINS_DEV_SETTINGS/">PLUGINS_DEV_SETTINGS.md</a> for complete settings documentation, and <a href="../PLUGINS_DEV_DATASOURCES/">PLUGINS_DEV_DATASOURCES.md</a> for data source details.</p>
<h2 id="quick-reference-key-concepts">Quick Reference: Key Concepts</h2>
<h3 id="plugin-output-format">Plugin Output Format</h3>
<p><div class="highlight"><pre><span></span><code>Object_PrimaryID|Object_SecondaryID|DateTime|Watched_Value1|Watched_Value2|Watched_Value3|Watched_Value4|Extra|ForeignKey
</code></pre></div>
9 required columns, 4 optional helpers = 13 max</p>
<p>See: <a href="../PLUGINS_DEV_DATA_CONTRACT/">Data Contract</a></p>
<h3 id="plugin-metadata-configjson">Plugin Metadata (config.json)</h3>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;code_name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;my_plugin&quot;</span><span class="p">,</span><span class="w"> </span><span class="c1">// Folder name</span>
<span class="w"> </span><span class="nt">&quot;unique_prefix&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MYPLN&quot;</span><span class="p">,</span><span class="w"> </span><span class="c1">// Settings prefix</span>
<span class="w"> </span><span class="nt">&quot;display_name&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="err">...</span><span class="p">],</span><span class="w"> </span><span class="c1">// UI label</span>
<span class="w"> </span><span class="nt">&quot;data_source&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;script&quot;</span><span class="p">,</span><span class="w"> </span><span class="c1">// Where data comes from</span>
<span class="w"> </span><span class="nt">&quot;settings&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="err">...</span><span class="p">],</span><span class="w"> </span><span class="c1">// User configurable</span>
<span class="w"> </span><span class="nt">&quot;database_column_definitions&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="err">...</span><span class="p">]</span><span class="w"> </span><span class="c1">// How to display</span>
<span class="p">}</span>
</code></pre></div>
<p>See: <a href="./">Full Guide</a>, <a href="../PLUGINS_DEV_SETTINGS/">Settings</a></p>
<h3 id="reserved-settings">Reserved Settings</h3>
<ul>
<li><code>RUN</code> - When to execute (disabled, once, schedule, always_after_scan, etc.)</li>
<li><code>RUN_SCHD</code> - Cron schedule</li>
<li><code>CMD</code> - Command/script to execute</li>
<li><code>RUN_TIMEOUT</code> - Max execution time</li>
<li><code>WATCH</code> - Monitor for changes</li>
<li><code>REPORT_ON</code> - Notification trigger</li>
</ul>
<p>See: <a href="../PLUGINS_DEV_SETTINGS/">Settings System</a></p>
<h3 id="display-types">Display Types</h3>
<p><code>label</code>, <code>device_mac</code>, <code>device_ip</code>, <code>url</code>, <code>threshold</code>, <code>replace</code>, <code>regex</code>, <code>textbox_save</code>, and more.</p>
<p>See: <a href="../PLUGINS_DEV_UI_COMPONENTS/">UI Components</a></p>
<hr />
<h2 id="tools-references">Tools &amp; References</h2>
<ul>
<li><strong>Template Plugin:</strong> <code>/app/front/plugins/__template/</code> - Start here!</li>
<li><strong>Helper Library:</strong> <code>/app/front/plugins/plugin_helper.py</code> - Use for output formatting</li>
<li><strong>Settings Helper:</strong> <code>/app/server/helper.py</code> - Use <code>get_setting_value()</code> in scripts</li>
<li><strong>Example Plugins:</strong> <code>/app/front/plugins/*/</code> - Study working implementations</li>
<li><strong>Logs:</strong> <code>/tmp/log/plugins/</code> - Plugin output and execution logs</li>
<li><strong>Backend Logs:</strong> <code>/tmp/log/stdout.log</code> - Core system logs</li>
</ul>
<hr />
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../DEV_PORTS_HOST_MODE/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Devcontainer Ports">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</div>
<div class="md-footer__title">
<span class="md-footer__direction">
Previous
</span>
<div class="md-ellipsis">
Devcontainer Ports
</div>
</div>
</a>
<a href="../PLUGINS_DEV_QUICK_START/" class="md-footer__link md-footer__link--next" aria-label="Next: Quick Start">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Quick Start
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["announce.dismiss", "content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.tooltips", "navigation.footer", "navigation.indexes", "navigation.sections", "navigation.tabs", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink