cron s6 rollback #945

better readme for the MikroTik plugin

dockerfiles/start.sh

@@ -13,13 +13,14 @@ sed -i "/^user/c\user = nginx" /etc/php83/php-fpm.d/www.conf
 sed -i "/^group/c\group = www-data" /etc/php83/php-fpm.d/www.conf
 
 # s6 overlay setup
-mkdir -p /etc/s6-overlay/s6-rc.d/{SetupOneshot,php-fpm/dependencies.d,nginx/dependencies.d}
-mkdir -p /etc/s6-overlay/s6-rc.d/{SetupOneshot,php-fpm/dependencies.d,nginx/dependencies.d,$APP_NAME/dependencies.d}
+mkdir -p /etc/s6-overlay/s6-rc.d/{SetupOneshot,crond/dependencies.d,php-fpm/dependencies.d,nginx/dependencies.d,$APP_NAME/dependencies.d}
 echo "oneshot" > /etc/s6-overlay/s6-rc.d/SetupOneshot/type
+echo "longrun" > /etc/s6-overlay/s6-rc.d/crond/type
 echo "longrun" > /etc/s6-overlay/s6-rc.d/php-fpm/type
 echo "longrun" > /etc/s6-overlay/s6-rc.d/nginx/type
 echo "longrun" > /etc/s6-overlay/s6-rc.d/$APP_NAME/type
 echo -e "${INSTALL_DIR}/dockerfiles/init.sh" > /etc/s6-overlay/s6-rc.d/SetupOneshot/up
+echo -e "#!/bin/execlineb -P\n/usr/sbin/crond -f -d 8" > /etc/s6-overlay/s6-rc.d/crond/run
 echo -e "#!/bin/execlineb -P\n/usr/sbin/php-fpm83 -F" > /etc/s6-overlay/s6-rc.d/php-fpm/run
 echo -e '#!/bin/execlineb -P\nnginx -g "daemon off;"' > /etc/s6-overlay/s6-rc.d/nginx/run
 echo -e '#!/bin/execlineb -P
@@ -33,8 +34,7 @@ echo -e '#!/bin/execlineb -P
 
         " }' > /etc/s6-overlay/s6-rc.d/$APP_NAME/run
 echo -e "python ${INSTALL_DIR}/server" >> /etc/s6-overlay/s6-rc.d/$APP_NAME/run
-touch /etc/s6-overlay/s6-rc.d/user/contents.d/{SetupOneshot,php-fpm,nginx} /etc/s6-overlay/s6-rc.d/{php-fpm,nginx}/dependencies.d/SetupOneshot
-touch /etc/s6-overlay/s6-rc.d/user/contents.d/{SetupOneshot,php-fpm,nginx,$APP_NAME} /etc/s6-overlay/s6-rc.d/{php-fpm,nginx,$APP_NAME}/dependencies.d/SetupOneshot
+touch /etc/s6-overlay/s6-rc.d/user/contents.d/{SetupOneshot,crond,php-fpm,nginx,$APP_NAME} /etc/s6-overlay/s6-rc.d/{crond,php-fpm,nginx,$APP_NAME}/dependencies.d/SetupOneshot
 touch /etc/s6-overlay/s6-rc.d/nginx/dependencies.d/php-fpm
 touch /etc/s6-overlay/s6-rc.d/$APP_NAME/dependencies.d/nginx
 

front/plugins/mikrotik_scan/README.md

@@ -1,7 +1,27 @@
 ## Overview
 
-Plugin for device name discovery via the Mikrotik dhcp-server leases
+The plugin uses the MikroTik API to discover devices by retrieving DHCP lease information.
+
+### Prerequisites
+
+- API must be enabled in `API > Interfaces` on your MikroTik router.
+- A user must be created in `System > Users` on your MikroTik router. Read-only permissions are recommended for security.
 
 ### Usage
 
-- Check the Settings page for details.
+It is recommended to use this plugin in scheduled mode for continuous device discovery and monitoring.
+
+In the Settings section of NetAlertX, provide the following parameters:
+
+- **MTSCAN_MT_HOST**: IP address of the MikroTik router (default: `192.168.88.1`).
+- **MTSCAN_MT_PORT**: Port for the MikroTik API (default: `8728`).
+- **MTSCAN_MT_USER**: Username for the MikroTik router.
+- **MTSCAN_MT_PASS**: Password for the MikroTik router.
+
+### Device name resolution order
+
+To assign a meaningful device name, the plugin resolves it in the following order:
+
+- **Comment**: The `comment` field in the MikroTik router's DHCP lease configuration. This is useful for naming static leases of known devies.
+- **Hostname**: The hostname provided by the device during DHCP negotiation.
+- **"(unknown)"**: as the fallback name, allowing other plugins to resolve the device name later.