diff --git a/README.md b/README.md index 3e54804f5..620fb474d 100755 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ Get visibility of what's going on on your WIFI/LAN network. Schedule scans for d | ![Main screen][main] | ![Screen 1][screen1] | ![Screen 5][screen5] | |----------------------|----------------------| ----------------------| + ![network_setup][network_setup] +
๐Ÿ“ท Click for more screenshots @@ -132,19 +134,20 @@ Help out and suggest languages in the [online portal of Weblate](https://hosted. -[main]: ./docs/img/devices_split.png "Main screen" -[screen1]: ./docs/img/device_details.png "Screen 1" -[screen2]: ./docs/img/events.png "Screen 2" -[screen3]: ./docs/img/presence.png "Screen 3" -[screen4]: ./docs/img/maintenance.png "Screen 4" -[screen5]: ./docs/img/network.png "Screen 5" -[screen6]: ./docs/img/settings.png "Screen 6" -[screen7]: ./docs/img/help_faq.png "Screen 7" -[screen8]: ./docs/img/plugins_rogue_dhcp.png "Screen 8" -[screen9]: ./docs/img/device_nmap.png "Screen 9" -[report1]: ./docs/img/4_report_1.jpg "Report sample 1" -[report2]: ./docs/img/4_report_2.jpg "Report sample 2" -[main_dark]: /docs/img/1_devices_dark.jpg "Main screen dark" -[maintain_dark]: /docs/img/5_maintain.jpg "Maintain screen dark" -[follow_star]: /docs/img/Follow_Releases_and_Star.gif "Follow and Star" +[main]: ./docs/img/devices_split.png "Main screen" +[screen1]: ./docs/img/device_details.png "Screen 1" +[screen2]: ./docs/img/events.png "Screen 2" +[screen3]: ./docs/img/presence.png "Screen 3" +[screen4]: ./docs/img/maintenance.png "Screen 4" +[screen5]: ./docs/img/network.png "Screen 5" +[screen6]: ./docs/img/settings.png "Screen 6" +[network_setup]: ./docs/img/network_setup.gif "Screen 6" +[screen7]: ./docs/img/help_faq.png "Screen 7" +[screen8]: ./docs/img/sync_hub.png "Screen 8" +[screen9]: ./docs/img/device_nmap.png "Screen 9" +[report1]: ./docs/img/4_report_1.jpg "Report sample 1" +[report2]: ./docs/img/4_report_2.jpg "Report sample 2" +[main_dark]: /docs/img/1_devices_dark.jpg "Main screen dark" +[maintain_dark]: /docs/img/5_maintain.jpg "Maintain screen dark" +[follow_star]: /docs/img/Follow_Releases_and_Star.gif "Follow and Star" diff --git a/docs/img/2_4_device_nmap.jpg b/docs/img/2_4_device_nmap.jpg deleted file mode 100755 index d9f295fe3..000000000 Binary files a/docs/img/2_4_device_nmap.jpg and /dev/null differ diff --git a/docs/img/2_5_device_nmap_ready.jpg b/docs/img/2_5_device_nmap_ready.jpg deleted file mode 100755 index 8d6baa70c..000000000 Binary files a/docs/img/2_5_device_nmap_ready.jpg and /dev/null differ diff --git a/docs/img/device_details.png b/docs/img/device_details.png index e7b7e8ebe..6c4308fd1 100755 Binary files a/docs/img/device_details.png and b/docs/img/device_details.png differ diff --git a/docs/img/device_nmap.png b/docs/img/device_nmap.png index 71ffae167..c1208edb1 100755 Binary files a/docs/img/device_nmap.png and b/docs/img/device_nmap.png differ diff --git a/docs/img/devices_dark.png b/docs/img/devices_dark.png index 9316353db..5ecbdfd49 100755 Binary files a/docs/img/devices_dark.png and b/docs/img/devices_dark.png differ diff --git a/docs/img/devices_light.png b/docs/img/devices_light.png index 552e0c711..ee48506ab 100755 Binary files a/docs/img/devices_light.png and b/docs/img/devices_light.png differ diff --git a/docs/img/devices_split.png b/docs/img/devices_split.png index b8df5cb9d..4a27a1bb7 100755 Binary files a/docs/img/devices_split.png and b/docs/img/devices_split.png differ diff --git a/docs/img/events.png b/docs/img/events.png index 2c8ce8618..0c6a4d537 100755 Binary files a/docs/img/events.png and b/docs/img/events.png differ diff --git a/docs/img/help_faq.png b/docs/img/help_faq.png index cbea16f8c..67ade01d0 100755 Binary files a/docs/img/help_faq.png and b/docs/img/help_faq.png differ diff --git a/docs/img/maintenance.png b/docs/img/maintenance.png index 6f08b1015..939586867 100755 Binary files a/docs/img/maintenance.png and b/docs/img/maintenance.png differ diff --git a/docs/img/multi_edit.png b/docs/img/multi_edit.png new file mode 100755 index 000000000..9ee8c2b0e Binary files /dev/null and b/docs/img/multi_edit.png differ diff --git a/docs/img/network.png b/docs/img/network.png index f480e35bc..b87d42f5e 100755 Binary files a/docs/img/network.png and b/docs/img/network.png differ diff --git a/docs/img/network_setup.gif b/docs/img/network_setup.gif new file mode 100755 index 000000000..a95faf481 Binary files /dev/null and b/docs/img/network_setup.gif differ diff --git a/docs/img/notification_center.png b/docs/img/notification_center.png new file mode 100755 index 000000000..dbe421d9a Binary files /dev/null and b/docs/img/notification_center.png differ diff --git a/docs/img/plugins.png b/docs/img/plugins.png index c7d2d7245..c5514d3d1 100755 Binary files a/docs/img/plugins.png and b/docs/img/plugins.png differ diff --git a/docs/img/plugins_device_details.png b/docs/img/plugins_device_details.png index 0a7300829..ba32078a0 100755 Binary files a/docs/img/plugins_device_details.png and b/docs/img/plugins_device_details.png differ diff --git a/docs/img/plugins_rogue_dhcp.png b/docs/img/plugins_rogue_dhcp.png deleted file mode 100755 index 1e0f9849a..000000000 Binary files a/docs/img/plugins_rogue_dhcp.png and /dev/null differ diff --git a/docs/img/plugins_webmon.png b/docs/img/plugins_webmon.png index 9743d5f19..f5facab33 100755 Binary files a/docs/img/plugins_webmon.png and b/docs/img/plugins_webmon.png differ diff --git a/docs/img/presence.png b/docs/img/presence.png index dafaaa989..dce12bbd5 100755 Binary files a/docs/img/presence.png and b/docs/img/presence.png differ diff --git a/docs/img/sent_reports_text.png b/docs/img/sent_reports_text.png new file mode 100755 index 000000000..81c44651c Binary files /dev/null and b/docs/img/sent_reports_text.png differ diff --git a/docs/img/settings.png b/docs/img/settings.png index 3cdfee058..7feb6d340 100755 Binary files a/docs/img/settings.png and b/docs/img/settings.png differ diff --git a/docs/img/sync_hub.png b/docs/img/sync_hub.png new file mode 100755 index 000000000..dc452e2db Binary files /dev/null and b/docs/img/sync_hub.png differ diff --git a/front/plugins/README.md b/front/plugins/README.md index 6f58056dd..15fe95d39 100755 --- a/front/plugins/README.md +++ b/front/plugins/README.md @@ -1,10 +1,15 @@ # ๐Ÿ”Œ Plugins +NetAlertX supports additional plugins to extend its functionality, each with its own settings and options. Plugins can be loaded via the General -> `LOADED_PLUGINS` setting by using Ctrl + Click. For custom plugin development, refer to the [Plugin development guide](/docs/PLUGINS_DEV.md). + >[!NOTE] > Please check this [Plugins debugging guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_PLUGINS.md) and the corresponding Plugin documentation in the below table if you are facing issues. ## โšก Quick start +> [!TIP] +> You can load additional Plugins via the General -> `LOADED_PLUGINS` setting. Use `Ctrl + Click` to select/deselect. + 1. Pick your `๐Ÿ” dev scanner` plugin (e.g. `ARPSCAN` or `NMAPDEV`), or import devices into the application with an `๐Ÿ“ฅ importer` plugin. (See **โœ…Enabling plugins** below) 1. Pick a `โ–ถ๏ธ publisher` plugin, if you want to send notifications. If you don't see a publisher you'd like to use, look at the [๐Ÿ“š_publisher_apprise](/front/plugins/_publisher_apprise/) plugin which is a proxy for over 80 notification services. 1. Setup your [Network topology diagram](/docs/NETWORK_TREE.md)