# Settings

Code_Name: APPRISE_URL
Display_Name: Apprise notification URL
Type: text
Group: Apprise
Events: []
Value:
  mailto://smtp-relay.sendinblue.com:587?from=user@gmail.com&name=apprise&user=user@gmail.com&pass=password&to=user@gmail.com


Code_Name: NMAPSRV_CMD
Display_Name: SQL to run
Type: text
Options: []
Group: NMAPSRV
Events: []
Value:
  SELECT  ns.MAC as Object_PrimaryID, cast({s-quote}http://{s-quote} || dv.dev_LastIP as VARCHAR(100)) || {s-quote}:{s-quote} || cast( SUBSTR(ns.Port ,0, INSTR(ns.Port , {s-quote}/{s-quote})) as VARCHAR(100)) as Object_SecondaryID,  datetime() as DateTime,  ns.Service as Watched_Value1, ns.State as Watched_Value2, dv.dev_Name as Watched_Value3,        {s-quote}null{s-quote} as Watched_Value4,        ns.Extra as Extra, ns.MAC as ForeignKey FROM (SELECT * FROM Nmap_Scan) ns left JOIN (SELECT dev_Name, dev_MAC, dev_LastIP FROM Devices) dv  ON ns.MAC = dv.dev_MAC


Code_Name: UNFIMP_CMD
Display_Name: Command
Type: text
Options: []
Group: UNFIMP
Events: []
Value:
  python3 /home/pi/pialert/front/plugins/unifi_import/script.py username={username} password={password}  host={host} sites={sites}  protocol={protocol} port={port} version={version}


# Plugins_Language_Strings

Language_Code: en_us
String_Key: NMAPSRV_RUN_SCHD_description
String_Value:
  Only enabled if you select <code>schedule</code> in the <a href="#NMAPSRV_RUN"><code>NMAPSRV_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href="https://crontab.guru/" target="_blank">crontab.guru</a>). For example entering <code>0 4 * * *</code> will run the scan after 4 am in the <a onclick="toggleAllSettings()" href="#TIMEZONE"><code>TIMEZONE</code> you set above</a>. Will be run NEXT time the time passes.


Language_Code: en_us
String_Key: NMAPSRV_WATCH_description
String_Value:
  Send a notification if selected values change. Use <code>CTRL + Click</code> to select/deselect. <ul> <li><code>Watched_Value1</code> is service type (e.g.: http, ssh)</li><li><code>Watched_Value2</code> is Status (open or closed)</li><li><code>Watched_Value3</code> unused </li><li><code>Watched_Value4</code> unused </li></ul>


Language_Code: en_us
String_Key: NMAPSRV_REPORT_ON_description
String_Value:
  Send a notification only on these statuses. <code>new</code> means a new unique (unique combination of PrimaryId and SecondaryId) object was discovered. <code>watched-changed</code> means that selected <code>Watched_ValueN</code> columns changed.


Language_Code: en_us
String_Key: DHCPSRVS_RUN_description
String_Value:
  Enable a regular scan of rogue DHCP servers. If you select <code>schedule</code> the scheduling settings from below are applied. If you select <code>once</code> the scan is run only once on start of the application (container) or after you update your settings.


Language_Code: en_us
String_Key: DHCPSRVS_RUN_SCHD_description
String_Value:
  Only enabled if you select <code>schedule</code> in the <a href="#DHCPSRVS_RUN"><code>DHCPSRVS_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href="https://crontab.guru/" target="_blank">crontab.guru</a>). For example entering <code>0 4 * * *</code> will run the scan after 4 am in the <a onclick="toggleAllSettings()" href="#TIMEZONE"><code>TIMEZONE</code> you set above</a>. Will be run NEXT time the time passes.


Language_Code: en_us
String_Key: DHCPSRVS_RUN_TIMEOUT_description
String_Value:
  Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted.


Language_Code: en_us
String_Key: DHCPSRVS_WATCH_description
String_Value:
  Send a notification if selected values change. Use <code>CTRL + Click</code> to select/deselect. <ul> <li><code>Watched_Value1</code> is Domain Name Server</li><li><code>Watched_Value2</code> is IP Offered</li><li><code>Watched_Value3</code> is Interface </li><li><code>Watched_Value4</code> is Router </li></ul>


Language_Code: en_us
String_Key: UNDIS_RUN_description
String_Value:
  When enabled, "once" is the preferred option. It runs at startup and after every save of the config here.<br> Changes will only show in the devices <b> after the next scan!</b>


Language_Code: en_us
String_Key: DHCPLSS_RUN_description
String_Value:
  Enable import of devices from <code>dhcp.leases</code> files. If you select <code>schedule</code> the scheduling settings from below are applied. If you select <code>once</code> the scan is run only once on start of the application (container) or after you update your settings.


Language_Code: en_us
String_Key: DHCPLSS_paths_to_check_description
String_Value:
  Add all dhcp.leases mapped paths to watch. Enter full path within the container, e.g. <code>/mnt/dhcp2.leases</code>. You must map these files accordingly in your <code>docker-compose.yml</code> file.


Language_Code: en_us
String_Key: DHCPLSS_RUN_SCHD_description
String_Value:
  Only enabled if you select <code>schedule</code> in the <a href="#DHCPLSS_RUN"><code>DHCPLSS_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href="https://crontab.guru/" target="_blank">crontab.guru</a>). For example entering <code>0 4 * * *</code> will run the scan after 4 am in the <a onclick="toggleAllSettings()" href="#TIMEZONE"><code>TIMEZONE</code> you set above</a>. Will be run NEXT time the time passes.


Language_Code: en_us
String_Key: DHCPLSS_WATCH_description
String_Value:
  Send a notification if selected values change. Use <code>CTRL + Click</code> to select/deselect. <ul> <li><code>Watched_Value1</code> is Active </li><li><code>Watched_Value2</code> is Hostname </li><li><code>Watched_Value3</code> is hardware </li><li><code>Watched_Value4</code> is State </li></ul>


Language_Code: en_us
String_Key: SNMPDSC_description
String_Value:
  This plugin is used to discover devices via the arp table(s) of a RFC1213 compliant router or switch.


Language_Code: en_us
String_Key: SNMPDSC_RUN_description
String_Value:
  Enable import of devices from a SNMP enabled device. If you select <code>schedule</code> the scheduling settings from below are applied. If you select <code>once</code> the scan is run only once on start of the application (container) or after you update your settings.


Language_Code: en_us
String_Key: SNMPDSC_routers_description
String_Value:
  A list of <code>snmpwalk</code> commands to execute against IP addresses of roputers/switches with SNMP turned on. <br/> <br/> Example with the router on the IP <code>192.168.1.1</code>: <br/> <code>snmpwalk -v 2c -c public -OXsq 192.168.1.1 .1.3.6.1.2.1.3.1.1.2</code> <br/><br/> Only IPv4 supported. Authentication is not supported. More info on the plugin <a href='https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins/snmp_discovery' target='_blank'>here</a>.


Language_Code: en_us
String_Key: SNMPDSC_RUN_SCHD_description
String_Value:
  Only enabled if you select <code>schedule</code> in the <a href="#SNMPDSC_RUN"><code>SNMPDSC_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href="https://crontab.guru/" target="_blank">crontab.guru</a>). For example entering <code>0 4 * * *</code> will run the scan after 4 am in the <a onclick="toggleAllSettings()" href="#TIMEZONE"><code>TIMEZONE</code> you set above</a>. Will be run NEXT time the time passes.


Language_Code: en_us
String_Key: SNMPDSC_WATCH_description
String_Value:
  Send a notification if selected values change. Use <code>CTRL + Click</code> to select/deselect. <ul> <li><code>Watched_Value1</code> is Hostname (not discoverable) </li><li><code>Watched_Value2</code> is Router IP </li><li><code>Watched_Value3</code> is not used </li><li><code>Watched_Value4</code> is not used </li></ul>


Language_Code: en_us
String_Key: UNFIMP_RUN_description
String_Value:
  Enable import of devices from a UNIFI controller. If you select <code>schedule</code> the scheduling settings from below are applied. If you select <code>once</code> the scan is run only once on start of the application (container) or after you update your settings.


Language_Code: en_us
String_Key: UNFIMP_username_description
String_Value:
  The username used to login into your UNIFI controller. It is recommended to create a read-only user account.


Language_Code: en_us
String_Key: UNFIMP_host_description
String_Value:
  The host (IP) where the UNIFI controller is runnig. Do NOT include the protocol (e.g. <code>https://</code>)


Language_Code: en_us
String_Key: UNFIMP_version_description
String_Value:
  The base version of the Unify controller API. Supported values as of time of writing are <code>v4|v5|unifiOS|UDMP-unifiOS</code>.


Language_Code: en_us
String_Key: UNFIMP_sites_description
String_Value:
  The sites you want to connect to. Usually it is only one and the name is <code>default</code>. Check the URL in your UniFi controller UI if unsure.


Language_Code: en_us
String_Key: UNFIMP_RUN_SCHD_description
String_Value:
  Only enabled if you select <code>schedule</code> in the <a href="#UNFIMP_RUN"><code>UNFIMP_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href="https://crontab.guru/" target="_blank">crontab.guru</a>). For example entering <code>0 4 * * *</code> will run the scan after 4 am in the <a onclick="toggleAllSettings()" href="#TIMEZONE"><code>TIMEZONE</code> you set above</a>. Will be run NEXT time the time passes.


Language_Code: en_us
String_Key: UNFIMP_WATCH_description
String_Value:
  Send a notification if selected values change. Use <code>CTRL + Click</code> to select/deselect. <ul> <li><code>Watched_Value1</code> is Hostname </li><li><code>Watched_Value2</code> is Vendor </li><li><code>Watched_Value3</code> is Type </li><li><code>Watched_Value4</code> is Network </li></ul>


Language_Code: en_us
String_Key: WEBMON_RUN_description
String_Value:
  Enable a regular scan of your services. If you select <code>schedule</code> the scheduling settings from below are applied. If you select <code>once</code> the scan is run only once on start of the application (container) for the time specified in <a href="#WEBMON_RUN_TIMEOUT"><code>WEBMON_RUN_TIMEOUT</code> setting</a>.


Language_Code: en_us
String_Key: WEBMON_RUN_SCHD_description
String_Value:
  Only enabled if you select <code>schedule</code> in the <a href="#WEBMON_RUN"><code>WEBMON_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href="https://crontab.guru/" target="_blank">crontab.guru</a>). For example entering <code>0 4 * * *</code> will run the scan after 4 am in the <a onclick="toggleAllSettings()" href="#TIMEZONE"><code>TIMEZONE</code> you set above</a>. Will be run NEXT time the time passes.


Language_Code: en_us
String_Key: WEBMON_API_SQL_description
String_Value:
  You can specify a custom SQL query which will generate a JSON file and then expose it via the <a href="/api/plugin_website_monitor.json" target="_blank"><code>plugin_website_monitor.json</code> file endpoint</a>.


Language_Code: en_us
String_Key: WEBMON_WATCH_description
String_Value:
  Send a notification if selected values change. Use <code>CTRL + Click</code> to select/deselect. <ul> <li><code>Watched_Value1</code> is response status code (e.g.: 200, 404)</li><li><code>Watched_Value2</code> is Latency (not recommended)</li><li><code>Watched_Value3</code> unused </li><li><code>Watched_Value4</code> unused </li></ul>


Language_Code: en_us
String_Key: WEBMON_urls_to_check_description
String_Value:
  Services to watch. Enter full URL, e.g. <code>https://google.com</code>. The values from this setting will be used to replace the <code>{urls}</code> wildcard in the <code>WEBMON_CMD</code> setting.


