Merge pull request #1321 from jokob-sk/main

sync
This commit is contained in:
Jokob @NetAlertX
2025-11-30 00:23:45 +00:00
committed by GitHub
260 changed files with 9052 additions and 6426 deletions

View File

@@ -35,7 +35,7 @@ RUN apk add --no-cache bash shadow python3 python3-dev gcc musl-dev libffi-dev o
# Create virtual environment owned by root, but readable by everyone else. This makes it easy to copy # Create virtual environment owned by root, but readable by everyone else. This makes it easy to copy
# into hardened stage without worrying about permissions and keeps image size small. Keeping the commands # into hardened stage without worrying about permissions and keeps image size small. Keeping the commands
# together makes for a slightly smaller image size. # together makes for a slightly smaller image size.
RUN pip install -r /tmp/requirements.txt && \ RUN pip install --no-cache-dir -r /tmp/requirements.txt && \
chmod -R u-rwx,g-rwx /opt chmod -R u-rwx,g-rwx /opt
# second stage is the main runtime stage with just the minimum required to run the application # second stage is the main runtime stage with just the minimum required to run the application
@@ -71,7 +71,7 @@ ENV LOG_APP_PHP_ERRORS=${NETALERTX_LOG}/app.php_errors.log
ENV LOG_EXECUTION_QUEUE=${NETALERTX_LOG}/execution_queue.log ENV LOG_EXECUTION_QUEUE=${NETALERTX_LOG}/execution_queue.log
ENV LOG_REPORT_OUTPUT_JSON=${NETALERTX_LOG}/report_output.json ENV LOG_REPORT_OUTPUT_JSON=${NETALERTX_LOG}/report_output.json
ENV LOG_STDOUT=${NETALERTX_LOG}/stdout.log ENV LOG_STDOUT=${NETALERTX_LOG}/stdout.log
ENV LOG_CROND=${NETALERTX_LOG}/crond.log ENV LOG_CRON=${NETALERTX_LOG}/cron.log
ENV LOG_NGINX_ERROR=${NETALERTX_LOG}/nginx-error.log ENV LOG_NGINX_ERROR=${NETALERTX_LOG}/nginx-error.log
# System Services configuration files # System Services configuration files
@@ -80,11 +80,12 @@ ENV SYSTEM_SERVICES=/services
ENV SYSTEM_SERVICES_SCRIPTS=${SYSTEM_SERVICES}/scripts ENV SYSTEM_SERVICES_SCRIPTS=${SYSTEM_SERVICES}/scripts
ENV SYSTEM_SERVICES_CONFIG=${SYSTEM_SERVICES}/config ENV SYSTEM_SERVICES_CONFIG=${SYSTEM_SERVICES}/config
ENV SYSTEM_NGINX_CONFIG=${SYSTEM_SERVICES_CONFIG}/nginx ENV SYSTEM_NGINX_CONFIG=${SYSTEM_SERVICES_CONFIG}/nginx
ENV SYSTEM_NGINX_CONFIG_FILE=${SYSTEM_NGINX_CONFIG}/nginx.conf ENV SYSTEM_NGINX_CONFIG_TEMPLATE=${SYSTEM_NGINX_CONFIG}/netalertx.conf.template
ENV SYSTEM_SERVICES_CONFIG_CRON=${SYSTEM_SERVICES_CONFIG}/cron
ENV SYSTEM_SERVICES_ACTIVE_CONFIG=/tmp/nginx/active-config ENV SYSTEM_SERVICES_ACTIVE_CONFIG=/tmp/nginx/active-config
ENV SYSTEM_SERVICES_ACTIVE_CONFIG_FILE=${SYSTEM_SERVICES_ACTIVE_CONFIG}/nginx.conf
ENV SYSTEM_SERVICES_PHP_FOLDER=${SYSTEM_SERVICES_CONFIG}/php ENV SYSTEM_SERVICES_PHP_FOLDER=${SYSTEM_SERVICES_CONFIG}/php
ENV SYSTEM_SERVICES_PHP_FPM_D=${SYSTEM_SERVICES_PHP_FOLDER}/php-fpm.d ENV SYSTEM_SERVICES_PHP_FPM_D=${SYSTEM_SERVICES_PHP_FOLDER}/php-fpm.d
ENV SYSTEM_SERVICES_CROND=${SYSTEM_SERVICES_CONFIG}/crond
ENV SYSTEM_SERVICES_RUN=/tmp/run ENV SYSTEM_SERVICES_RUN=/tmp/run
ENV SYSTEM_SERVICES_RUN_TMP=${SYSTEM_SERVICES_RUN}/tmp ENV SYSTEM_SERVICES_RUN_TMP=${SYSTEM_SERVICES_RUN}/tmp
ENV SYSTEM_SERVICES_RUN_LOG=${SYSTEM_SERVICES_RUN}/logs ENV SYSTEM_SERVICES_RUN_LOG=${SYSTEM_SERVICES_RUN}/logs
@@ -118,7 +119,7 @@ ENV LANG=C.UTF-8
RUN apk add --no-cache bash mtr libbsd zip lsblk tzdata curl arp-scan iproute2 iproute2-ss nmap \ RUN apk add --no-cache bash mtr libbsd zip lsblk tzdata curl arp-scan iproute2 iproute2-ss nmap \
nmap-scripts traceroute nbtscan net-tools net-snmp-tools bind-tools awake ca-certificates \ nmap-scripts traceroute nbtscan net-tools net-snmp-tools bind-tools awake ca-certificates \
sqlite php83 php83-fpm php83-cgi php83-curl php83-sqlite3 php83-session python3 envsubst \ sqlite php83 php83-fpm php83-cgi php83-curl php83-sqlite3 php83-session python3 envsubst \
nginx shadow && \ nginx supercronic shadow && \
rm -Rf /var/cache/apk/* && \ rm -Rf /var/cache/apk/* && \
rm -Rf /etc/nginx && \ rm -Rf /etc/nginx && \
addgroup -g 20211 ${NETALERTX_GROUP} && \ addgroup -g 20211 ${NETALERTX_GROUP} && \
@@ -138,6 +139,9 @@ RUN install -d -o ${NETALERTX_USER} -g ${NETALERTX_GROUP} -m 700 ${READ_WRITE_FO
sh -c "find ${NETALERTX_APP} -type f \( -name '*.sh' -o -name 'speedtest-cli' \) \ sh -c "find ${NETALERTX_APP} -type f \( -name '*.sh' -o -name 'speedtest-cli' \) \
-exec chmod 750 {} \;" -exec chmod 750 {} \;"
# Copy version information into the image
COPY --chown=${NETALERTX_USER}:${NETALERTX_GROUP} .[V]ERSION ${NETALERTX_APP}/.VERSION
# Copy the virtualenv from the builder stage # Copy the virtualenv from the builder stage
COPY --from=builder --chown=20212:20212 ${VIRTUAL_ENV} ${VIRTUAL_ENV} COPY --from=builder --chown=20212:20212 ${VIRTUAL_ENV} ${VIRTUAL_ENV}
@@ -146,20 +150,26 @@ COPY --from=builder --chown=20212:20212 ${VIRTUAL_ENV} ${VIRTUAL_ENV}
# This is done after the copy of the venv to ensure the venv is in place # This is done after the copy of the venv to ensure the venv is in place
# although it may be quicker to do it before the copy, it keeps the image # although it may be quicker to do it before the copy, it keeps the image
# layers smaller to do it after. # layers smaller to do it after.
RUN apk add libcap && \ RUN if [ -f '.VERSION' ]; then \
cp '.VERSION' "${NETALERTX_APP}/.VERSION"; \
else \
echo "DEVELOPMENT 00000000" > "${NETALERTX_APP}/.VERSION"; \
fi && \
chown 20212:20212 "${NETALERTX_APP}/.VERSION" && \
apk add --no-cache libcap && \
setcap cap_net_raw+ep /bin/busybox && \ setcap cap_net_raw+ep /bin/busybox && \
setcap cap_net_raw,cap_net_admin+eip /usr/bin/nmap && \ setcap cap_net_raw,cap_net_admin+eip /usr/bin/nmap && \
setcap cap_net_raw,cap_net_admin+eip /usr/bin/arp-scan && \ setcap cap_net_raw,cap_net_admin+eip /usr/bin/arp-scan && \
setcap cap_net_raw,cap_net_admin,cap_net_bind_service+eip /usr/bin/nbtscan && \ setcap cap_net_raw,cap_net_admin,cap_net_bind_service+eip /usr/bin/nbtscan && \
setcap cap_net_raw,cap_net_admin+eip /usr/bin/traceroute && \ setcap cap_net_raw,cap_net_admin+eip /usr/bin/traceroute && \
setcap cap_net_raw,cap_net_admin+eip $(readlink -f ${VIRTUAL_ENV_BIN}/python) && \ setcap cap_net_raw,cap_net_admin+eip "$(readlink -f ${VIRTUAL_ENV_BIN}/python)" && \
/bin/sh /build/init-nginx.sh && \ /bin/sh /build/init-nginx.sh && \
/bin/sh /build/init-php-fpm.sh && \ /bin/sh /build/init-php-fpm.sh && \
/bin/sh /build/init-crond.sh && \ /bin/sh /build/init-cron.sh && \
/bin/sh /build/init-backend.sh && \ /bin/sh /build/init-backend.sh && \
rm -rf /build && \ rm -rf /build && \
apk del libcap && \ apk del libcap && \
date +%s > ${NETALERTX_FRONT}/buildtimestamp.txt date +%s > "${NETALERTX_FRONT}/buildtimestamp.txt"
ENTRYPOINT ["/bin/sh","/entrypoint.sh"] ENTRYPOINT ["/bin/sh","/entrypoint.sh"]
@@ -176,13 +186,15 @@ ENV UMASK=0077
# AI may claim this is stupid, but it's actually least possible permissions as # AI may claim this is stupid, but it's actually least possible permissions as
# read-only user cannot login, cannot sudo, has no write permission, and cannot even # read-only user cannot login, cannot sudo, has no write permission, and cannot even
# read the files it owns. The read-only user is ownership-as-a-lock hardening pattern. # read the files it owns. The read-only user is ownership-as-a-lock hardening pattern.
RUN addgroup -g 20212 ${READ_ONLY_GROUP} && \ RUN addgroup -g 20212 "${READ_ONLY_GROUP}" && \
adduser -u 20212 -G ${READ_ONLY_GROUP} -D -h /app ${READ_ONLY_USER} adduser -u 20212 -G "${READ_ONLY_GROUP}" -D -h /app "${READ_ONLY_USER}"
# reduce permissions to minimum necessary for all NetAlertX files and folders # reduce permissions to minimum necessary for all NetAlertX files and folders
# Permissions 005 and 004 are not typos, they enable read-only. Everyone can # Permissions 005 and 004 are not typos, they enable read-only. Everyone can
# read the read-only files, and nobody can write to them, even the readonly user. # read the read-only files, and nobody can write to them, even the readonly user.
# hadolint ignore=SC2114
RUN chown -R ${READ_ONLY_USER}:${READ_ONLY_GROUP} ${READ_ONLY_FOLDERS} && \ RUN chown -R ${READ_ONLY_USER}:${READ_ONLY_GROUP} ${READ_ONLY_FOLDERS} && \
chmod -R 004 ${READ_ONLY_FOLDERS} && \ chmod -R 004 ${READ_ONLY_FOLDERS} && \
find ${READ_ONLY_FOLDERS} -type d -exec chmod 005 {} + && \ find ${READ_ONLY_FOLDERS} -type d -exec chmod 005 {} + && \
@@ -201,7 +213,7 @@ RUN chown -R ${READ_ONLY_USER}:${READ_ONLY_GROUP} ${READ_ONLY_FOLDERS} && \
/srv /media && \ /srv /media && \
sed -i "/^\(${READ_ONLY_USER}\|${NETALERTX_USER}\):/!d" /etc/passwd && \ sed -i "/^\(${READ_ONLY_USER}\|${NETALERTX_USER}\):/!d" /etc/passwd && \
sed -i "/^\(${READ_ONLY_GROUP}\|${NETALERTX_GROUP}\):/!d" /etc/group && \ sed -i "/^\(${READ_ONLY_GROUP}\|${NETALERTX_GROUP}\):/!d" /etc/group && \
echo -ne '#!/bin/sh\n"$@"\n' > /usr/bin/sudo && chmod +x /usr/bin/sudo printf '#!/bin/sh\n"$@"\n' > /usr/bin/sudo && chmod +x /usr/bin/sudo
USER netalertx USER netalertx
@@ -220,6 +232,7 @@ HEALTHCHECK --interval=30s --timeout=10s --start-period=60s --retries=3 \
# Open and wide to avoid permission issues during development allowing max # Open and wide to avoid permission issues during development allowing max
# flexibility. # flexibility.
# hadolint ignore=DL3006
FROM runner AS netalertx-devcontainer FROM runner AS netalertx-devcontainer
ENV INSTALL_DIR=/app ENV INSTALL_DIR=/app
@@ -233,9 +246,14 @@ ENV PYDEVD_DISABLE_FILE_VALIDATION=1
COPY .devcontainer/resources/devcontainer-overlay/ / COPY .devcontainer/resources/devcontainer-overlay/ /
USER root USER root
# Install common tools, create user, and set up sudo # Install common tools, create user, and set up sudo
RUN apk add --no-cache git nano vim jq php83-pecl-xdebug py3-pip nodejs sudo gpgconf pytest \ RUN apk add --no-cache git nano vim jq php83-pecl-xdebug py3-pip nodejs sudo gpgconf pytest \
pytest-cov zsh alpine-zsh-config shfmt github-cli py3-yaml py3-docker-py docker-cli docker-cli-buildx \ pytest-cov zsh alpine-zsh-config shfmt github-cli py3-yaml py3-docker-py docker-cli docker-cli-buildx \
docker-cli-compose docker-cli-compose shellcheck
# Install hadolint (Dockerfile linter)
RUN curl -L https://github.com/hadolint/hadolint/releases/latest/download/hadolint-Linux-x86_64 -o /usr/local/bin/hadolint && \
chmod +x /usr/local/bin/hadolint
RUN install -d -o netalertx -g netalertx -m 755 /services/php/modules && \ RUN install -d -o netalertx -g netalertx -m 755 /services/php/modules && \
cp -a /usr/lib/php83/modules/. /services/php/modules/ && \ cp -a /usr/lib/php83/modules/. /services/php/modules/ && \

View File

@@ -75,7 +75,9 @@
"alexcvzz.vscode-sqlite", "alexcvzz.vscode-sqlite",
"mkhl.shfmt", "mkhl.shfmt",
"charliermarsh.ruff", "charliermarsh.ruff",
"ms-python.flake8" "ms-python.flake8",
"exiasr.hadolint",
"timonwong.shellcheck"
], ],
"settings": { "settings": {
"terminal.integrated.cwd": "${containerWorkspaceFolder}", "terminal.integrated.cwd": "${containerWorkspaceFolder}",

View File

@@ -7,6 +7,7 @@
# Open and wide to avoid permission issues during development allowing max # Open and wide to avoid permission issues during development allowing max
# flexibility. # flexibility.
# hadolint ignore=DL3006
FROM runner AS netalertx-devcontainer FROM runner AS netalertx-devcontainer
ENV INSTALL_DIR=/app ENV INSTALL_DIR=/app
@@ -20,9 +21,14 @@ ENV PYDEVD_DISABLE_FILE_VALIDATION=1
COPY .devcontainer/resources/devcontainer-overlay/ / COPY .devcontainer/resources/devcontainer-overlay/ /
USER root USER root
# Install common tools, create user, and set up sudo # Install common tools, create user, and set up sudo
RUN apk add --no-cache git nano vim jq php83-pecl-xdebug py3-pip nodejs sudo gpgconf pytest \ RUN apk add --no-cache git nano vim jq php83-pecl-xdebug py3-pip nodejs sudo gpgconf pytest \
pytest-cov zsh alpine-zsh-config shfmt github-cli py3-yaml py3-docker-py docker-cli docker-cli-buildx \ pytest-cov zsh alpine-zsh-config shfmt github-cli py3-yaml py3-docker-py docker-cli docker-cli-buildx \
docker-cli-compose docker-cli-compose shellcheck
# Install hadolint (Dockerfile linter)
RUN curl -L https://github.com/hadolint/hadolint/releases/latest/download/hadolint-Linux-x86_64 -o /usr/local/bin/hadolint && \
chmod +x /usr/local/bin/hadolint
RUN install -d -o netalertx -g netalertx -m 755 /services/php/modules && \ RUN install -d -o netalertx -g netalertx -m 755 /services/php/modules && \
cp -a /usr/lib/php83/modules/. /services/php/modules/ && \ cp -a /usr/lib/php83/modules/. /services/php/modules/ && \

View File

@@ -1,118 +0,0 @@
# DO NOT MODIFY THIS FILE DIRECTLY. IT IS AUTO-GENERATED BY .devcontainer/scripts/generate-configs.sh
# Generated from: install/production-filesystem/services/config/nginx/netalertx.conf.template
# Set number of worker processes automatically based on number of CPU cores.
worker_processes auto;
# Enables the use of JIT for regular expressions to speed-up their processing.
pcre_jit on;
# Configures default error logger.
error_log /tmp/log/nginx-error.log warn;
pid /tmp/run/nginx.pid;
events {
# The maximum number of simultaneous connections that can be opened by
# a worker process.
worker_connections 1024;
}
http {
# Mapping of temp paths for various nginx modules.
client_body_temp_path /tmp/nginx/client_body;
proxy_temp_path /tmp/nginx/proxy;
fastcgi_temp_path /tmp/nginx/fastcgi;
uwsgi_temp_path /tmp/nginx/uwsgi;
scgi_temp_path /tmp/nginx/scgi;
# Includes mapping of file name extensions to MIME types of responses
# and defines the default type.
include /services/config/nginx/mime.types;
default_type application/octet-stream;
# Name servers used to resolve names of upstream servers into addresses.
# It's also needed when using tcpsocket and udpsocket in Lua modules.
#resolver 1.1.1.1 1.0.0.1 [2606:4700:4700::1111] [2606:4700:4700::1001];
# Don't tell nginx version to the clients. Default is 'on'.
server_tokens off;
# Specifies the maximum accepted body size of a client request, as
# indicated by the request header Content-Length. If the stated content
# length is greater than this size, then the client receives the HTTP
# error code 413. Set to 0 to disable. Default is '1m'.
client_max_body_size 1m;
# Sendfile copies data between one FD and other from within the kernel,
# which is more efficient than read() + write(). Default is off.
sendfile on;
# Causes nginx to attempt to send its HTTP response head in one packet,
# instead of using partial frames. Default is 'off'.
tcp_nopush on;
# Enables the specified protocols. Default is TLSv1 TLSv1.1 TLSv1.2.
# TIP: If you're not obligated to support ancient clients, remove TLSv1.1.
ssl_protocols TLSv1.2 TLSv1.3;
# Path of the file with Diffie-Hellman parameters for EDH ciphers.
# TIP: Generate with: `openssl dhparam -out /etc/ssl/nginx/dh2048.pem 2048`
#ssl_dhparam /etc/ssl/nginx/dh2048.pem;
# Specifies that our cipher suits should be preferred over client ciphers.
# Default is 'off'.
ssl_prefer_server_ciphers on;
# Enables a shared SSL cache with size that can hold around 8000 sessions.
# Default is 'none'.
ssl_session_cache shared:SSL:2m;
# Specifies a time during which a client may reuse the session parameters.
# Default is '5m'.
ssl_session_timeout 1h;
# Disable TLS session tickets (they are insecure). Default is 'on'.
ssl_session_tickets off;
# Enable gzipping of responses.
gzip on;
# Set the Vary HTTP header as defined in the RFC 2616. Default is 'off'.
gzip_vary on;
# Specifies the main log format.
log_format main '$remote_addr - $remote_user [$time_local] "$request" '
'$status $body_bytes_sent "$http_referer" '
'"$http_user_agent" "$http_x_forwarded_for"';
# Sets the path, format, and configuration for a buffered log write.
access_log /tmp/log/nginx-access.log main;
# Virtual host config
server {
listen 0.0.0.0:20211 default_server;
large_client_header_buffers 4 16k;
root /app/front;
index index.php;
add_header X-Forwarded-Prefix "/app" always;
location ~* \.php$ {
# Set Cache-Control header to prevent caching on the first load
add_header Cache-Control "no-store";
fastcgi_pass unix:/tmp/run/php.sock;
include /services/config/nginx/fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_param SCRIPT_NAME $fastcgi_script_name;
fastcgi_param PHP_VALUE "xdebug.remote_enable=1";
fastcgi_connect_timeout 75;
fastcgi_send_timeout 600;
fastcgi_read_timeout 600;
}
}
}

View File

@@ -7,56 +7,28 @@
# the final .devcontainer/Dockerfile used by the devcontainer. # the final .devcontainer/Dockerfile used by the devcontainer.
echo "Generating .devcontainer/Dockerfile" echo "Generating .devcontainer/Dockerfile"
SCRIPT_DIR="$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)" SCRIPT_PATH=$(set -- "$0"; dirname -- "$1")
SCRIPT_DIR=$(cd "$SCRIPT_PATH" && pwd -P)
DEVCONTAINER_DIR="${SCRIPT_DIR%/scripts}" DEVCONTAINER_DIR="${SCRIPT_DIR%/scripts}"
ROOT_DIR="${DEVCONTAINER_DIR%/.devcontainer}" ROOT_DIR="${DEVCONTAINER_DIR%/.devcontainer}"
OUT_FILE="${DEVCONTAINER_DIR}/Dockerfile" OUT_FILE="${DEVCONTAINER_DIR}/Dockerfile"
echo "Adding base Dockerfile from $ROOT_DIR..." echo "Adding base Dockerfile from $ROOT_DIR and merging to devcontainer-Dockerfile"
{
echo "# DO NOT MODIFY THIS FILE DIRECTLY. IT IS AUTO-GENERATED BY .devcontainer/scripts/generate-configs.sh" > "$OUT_FILE" echo "# DO NOT MODIFY THIS FILE DIRECTLY. IT IS AUTO-GENERATED BY .devcontainer/scripts/generate-configs.sh"
echo "" >> "$OUT_FILE" echo ""
echo "# ---/Dockerfile---" >> "$OUT_FILE" echo "# ---/Dockerfile---"
cat "${ROOT_DIR}/Dockerfile" >> "$OUT_FILE" cat "${ROOT_DIR}/Dockerfile"
echo "" >> "$OUT_FILE" echo ""
echo "# ---/resources/devcontainer-Dockerfile---" >> "$OUT_FILE" echo "# ---/resources/devcontainer-Dockerfile---"
echo "" >> "$OUT_FILE" echo ""
cat "${DEVCONTAINER_DIR}/resources/devcontainer-Dockerfile"
} > "$OUT_FILE"
echo "Adding devcontainer-Dockerfile from $DEVCONTAINER_DIR/resources..." echo "Generated $OUT_FILE using root dir $ROOT_DIR"
cat "${DEVCONTAINER_DIR}/resources/devcontainer-Dockerfile" >> "$OUT_FILE"
echo "Generated $OUT_FILE using root dir $ROOT_DIR" >&2
# Generate devcontainer nginx config from production template
echo "Generating devcontainer nginx config"
NGINX_TEMPLATE="${ROOT_DIR}/install/production-filesystem/services/config/nginx/netalertx.conf.template"
NGINX_OUT="${DEVCONTAINER_DIR}/resources/devcontainer-overlay/services/config/nginx/netalertx.conf.template"
# Create output directory if it doesn't exist
mkdir -p "$(dirname "$NGINX_OUT")"
# Start with header comment
cat > "$NGINX_OUT" << 'EOF'
# DO NOT MODIFY THIS FILE DIRECTLY. IT IS AUTO-GENERATED BY .devcontainer/scripts/generate-configs.sh
# Generated from: install/production-filesystem/services/config/nginx/netalertx.conf.template
EOF
# Process the template: replace listen directive and inject Xdebug params
sed 's/${LISTEN_ADDR}:${PORT}/0.0.0.0:20211/g' "$NGINX_TEMPLATE" | \
awk '
/fastcgi_param SCRIPT_NAME \$fastcgi_script_name;/ {
print $0
print ""
print " fastcgi_param PHP_VALUE \"xdebug.remote_enable=1\";"
next
}
{ print }
' >> "$NGINX_OUT"
echo "Generated $NGINX_OUT from $NGINX_TEMPLATE" >&2
echo "Done." echo "Done."

View File

@@ -16,7 +16,6 @@
SOURCE_DIR=${SOURCE_DIR:-/workspaces/NetAlertX} SOURCE_DIR=${SOURCE_DIR:-/workspaces/NetAlertX}
PY_SITE_PACKAGES="${VIRTUAL_ENV:-/opt/venv}/lib/python3.12/site-packages" PY_SITE_PACKAGES="${VIRTUAL_ENV:-/opt/venv}/lib/python3.12/site-packages"
SOURCE_SERVICES_DIR="${SOURCE_DIR}/install/production-filesystem/services"
LOG_FILES=( LOG_FILES=(
LOG_APP LOG_APP
@@ -26,7 +25,7 @@ LOG_FILES=(
LOG_EXECUTION_QUEUE LOG_EXECUTION_QUEUE
LOG_APP_PHP_ERRORS LOG_APP_PHP_ERRORS
LOG_IP_CHANGES LOG_IP_CHANGES
LOG_CROND LOG_CRON
LOG_REPORT_OUTPUT_TXT LOG_REPORT_OUTPUT_TXT
LOG_REPORT_OUTPUT_HTML LOG_REPORT_OUTPUT_HTML
LOG_REPORT_OUTPUT_JSON LOG_REPORT_OUTPUT_JSON
@@ -50,9 +49,6 @@ sudo chmod 777 /tmp/log /tmp/api /tmp/run /tmp/nginx
sudo rm -rf "${SYSTEM_NGINX_CONFIG}/conf.active"
sudo ln -s "${SYSTEM_SERVICES_ACTIVE_CONFIG}" "${SYSTEM_NGINX_CONFIG}/conf.active"
sudo rm -rf /entrypoint.d sudo rm -rf /entrypoint.d
sudo ln -s "${SOURCE_DIR}/install/production-filesystem/entrypoint.d" /entrypoint.d sudo ln -s "${SOURCE_DIR}/install/production-filesystem/entrypoint.d" /entrypoint.d
@@ -67,6 +63,7 @@ for dir in \
"${SYSTEM_SERVICES_RUN_LOG}" \ "${SYSTEM_SERVICES_RUN_LOG}" \
"${SYSTEM_SERVICES_ACTIVE_CONFIG}" \ "${SYSTEM_SERVICES_ACTIVE_CONFIG}" \
"${NETALERTX_PLUGINS_LOG}" \ "${NETALERTX_PLUGINS_LOG}" \
"${SYSTEM_SERVICES_RUN_TMP}" \
"/tmp/nginx/client_body" \ "/tmp/nginx/client_body" \
"/tmp/nginx/proxy" \ "/tmp/nginx/proxy" \
"/tmp/nginx/fastcgi" \ "/tmp/nginx/fastcgi" \
@@ -75,9 +72,6 @@ for dir in \
sudo install -d -m 777 "${dir}" sudo install -d -m 777 "${dir}"
done done
# Create nginx temp subdirs with permissions
sudo mkdir -p "${SYSTEM_SERVICES_RUN_TMP}/client_body" "${SYSTEM_SERVICES_RUN_TMP}/proxy" "${SYSTEM_SERVICES_RUN_TMP}/fastcgi" "${SYSTEM_SERVICES_RUN_TMP}/uwsgi" "${SYSTEM_SERVICES_RUN_TMP}/scgi"
sudo chmod -R 777 "${SYSTEM_SERVICES_RUN_TMP}"
for var in "${LOG_FILES[@]}"; do for var in "${LOG_FILES[@]}"; do
path=${!var} path=${!var}

View File

@@ -44,7 +44,7 @@ body:
required: false required: false
- type: textarea - type: textarea
attributes: attributes:
label: app.conf label: Relevant `app.conf` settings
description: | description: |
Paste relevant `app.conf`settings (remove sensitive info) Paste relevant `app.conf`settings (remove sensitive info)
render: python render: python
@@ -55,7 +55,7 @@ body:
label: docker-compose.yml label: docker-compose.yml
description: | description: |
Paste your `docker-compose.yml` Paste your `docker-compose.yml`
render: python render: yaml
validations: validations:
required: false required: false
- type: dropdown - type: dropdown
@@ -79,7 +79,11 @@ body:
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: app.log label: Relevant `app.log` section
value: |
```
PASTE LOG HERE. Using the triple backticks preserves format.
```
description: | description: |
Logs with debug enabled (https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md) ⚠ Logs with debug enabled (https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md) ⚠
***Generally speaking, all bug reports should have logs provided.*** ***Generally speaking, all bug reports should have logs provided.***
@@ -93,6 +97,10 @@ body:
label: Docker Logs label: Docker Logs
description: | description: |
You can retrieve the logs from Portainer -> Containers -> your NetAlertX container -> Logs or by running `sudo docker logs netalertx`. You can retrieve the logs from Portainer -> Containers -> your NetAlertX container -> Logs or by running `sudo docker logs netalertx`.
value: |
```
PASTE DOCKER LOG HERE. Using the triple backticks preserves format.
```
validations: validations:
required: true required: true

View File

@@ -83,3 +83,9 @@ Backend loop phases (see `server/__main__.py` and `server/plugin.py`): `once`, `
- Be sure to offer choices when appropriate. - Be sure to offer choices when appropriate.
- Always understand the intent of the user's request and undo/redo as needed. - Always understand the intent of the user's request and undo/redo as needed.
- Above all, use the simplest possible code that meets the need so it can be easily audited and maintained. - Above all, use the simplest possible code that meets the need so it can be easily audited and maintained.
- Always leave logging enabled. If there is a possiblity it will be difficult to debug with current logging, add more logging.
- Always run the testFailure tool before executing any tests to gather current failure information and avoid redundant runs.
- Always prioritize using the appropriate tools in the environment first. As an example if a test is failing use `testFailure` then `runTests`. Never `runTests` first.
- Docker tests take an extremely long time to run. Avoid changes to docker or tests until you've examined the exisiting testFailures and runTests results.
- Environment tools are designed specifically for your use in this project and running them in this order will give you the best results.

View File

@@ -21,7 +21,8 @@ jobs:
run: | run: |
echo "🔍 Checking for incorrect absolute '/php/' URLs (should be 'php/' or './php/')..." echo "🔍 Checking for incorrect absolute '/php/' URLs (should be 'php/' or './php/')..."
MATCHES=$(grep -rE "['\"]\/php\/" --include=\*.{js,php,html} ./front | grep -E "\.get|\.post|\.ajax|fetch|url\s*:") || true MATCHES=$(grep -rE "['\"]/php/" --include=\*.{js,php,html} ./front \
| grep -E "\.get|\.post|\.ajax|fetch|url\s*:") || true
if [ -n "$MATCHES" ]; then if [ -n "$MATCHES" ]; then
echo "$MATCHES" echo "$MATCHES"
@@ -39,3 +40,60 @@ jobs:
echo "🔍 Checking Python syntax..." echo "🔍 Checking Python syntax..."
find . -name "*.py" -print0 | xargs -0 -n1 python3 -m py_compile find . -name "*.py" -print0 | xargs -0 -n1 python3 -m py_compile
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install linting tools
run: |
# Python linting
pip install flake8
# Docker linting
wget -O /tmp/hadolint https://github.com/hadolint/hadolint/releases/latest/download/hadolint-Linux-x86_64
chmod +x /tmp/hadolint
# PHP and shellcheck for syntax checking
sudo apt-get update && sudo apt-get install -y php-cli shellcheck
- name: Shell check
continue-on-error: true
run: |
echo "🔍 Checking shell scripts..."
find . -name "*.sh" -exec shellcheck {} \;
- name: Python lint
continue-on-error: true
run: |
echo "🔍 Linting Python code..."
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: PHP check
continue-on-error: true
run: |
echo "🔍 Checking PHP syntax..."
find . -name "*.php" -exec php -l {} \;
- name: Docker lint
continue-on-error: true
run: |
echo "🔍 Linting Dockerfiles..."
/tmp/hadolint --config .hadolint.yaml Dockerfile* || true
docker-tests:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Run Docker-based tests
run: |
echo "🐳 Running Docker-based tests..."
chmod +x ./test/docker_tests/run_docker_tests.sh
./test/docker_tests/run_docker_tests.sh

View File

@@ -3,12 +3,12 @@ name: docker
on: on:
push: push:
branches: branches:
- next_release - main
tags: tags:
- '*.*.*' - '*.*.*'
pull_request: pull_request:
branches: branches:
- next_release - main
jobs: jobs:
docker_dev: docker_dev:
@@ -83,7 +83,7 @@ jobs:
password: ${{ secrets.DOCKERHUB_TOKEN }} password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Build and push - name: Build and push
uses: docker/build-push-action@v3 uses: docker/build-push-action@v6
with: with:
context: . context: .
platforms: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6 platforms: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6

View File

@@ -32,6 +32,18 @@ jobs:
- name: Set up Docker Buildx - name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3 uses: docker/setup-buildx-action@v3
# --- Previous approach Get release version from tag
- name: Set up dynamic build ARGs
id: getargs
run: echo "version=$(cat ./stable/VERSION)" >> $GITHUB_OUTPUT
- name: Get release version
id: get_version_prev
run: echo "::set-output name=version::${GITHUB_REF#refs/tags/}"
- name: Create .VERSION file
run: echo "${{ steps.get_version.outputs.version }}" >> .VERSION_PREV
# --- Get release version from tag # --- Get release version from tag
- name: Get release version - name: Get release version
id: get_version id: get_version
@@ -72,7 +84,7 @@ jobs:
password: ${{ secrets.DOCKERHUB_TOKEN }} password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Build and push - name: Build and push
uses: docker/build-push-action@v3 uses: docker/build-push-action@v6
with: with:
context: . context: .
platforms: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6 platforms: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6

1
.gitignore vendored
View File

@@ -11,6 +11,7 @@ nohup.out
config/* config/*
.ash_history .ash_history
.VERSION .VERSION
.VERSION_PREV
config/pialert.conf config/pialert.conf
config/app.conf config/app.conf
db/* db/*

2
.hadolint.yaml Normal file
View File

@@ -0,0 +1,2 @@
ignored:
- DL3018

View File

@@ -1,16 +1,16 @@
# The NetAlertX Dockerfile has 3 stages: # The NetAlertX Dockerfile has 3 stages:
# #
# Stage 1. Builder - NetAlertX Requires special tools and packages to build our virtual environment, but # Stage 1. Builder - NetAlertX Requires special tools and packages to build our virtual environment, but
# which are not needed in future stages. We build the builder and extract the venv for runner to use as # which are not needed in future stages. We build the builder and extract the venv for runner to use as
# a base. # a base.
# #
# Stage 2. Runner builds the bare minimum requirements to create an operational NetAlertX. The primary # Stage 2. Runner builds the bare minimum requirements to create an operational NetAlertX. The primary
# reason for breaking at this stage is it leaves the system in a proper state for devcontainer operation # reason for breaking at this stage is it leaves the system in a proper state for devcontainer operation
# This image also provides a break-out point for uses who wish to execute the anti-pattern of using a # This image also provides a break-out point for uses who wish to execute the anti-pattern of using a
# docker container as a VM for experimentation and various development patterns. # docker container as a VM for experimentation and various development patterns.
# #
# Stage 3. Hardened removes root, sudoers, folders, permissions, and locks the system down into a read-only # Stage 3. Hardened removes root, sudoers, folders, permissions, and locks the system down into a read-only
# compatible image. While NetAlertX does require some read-write operations, this image can guarantee the # compatible image. While NetAlertX does require some read-write operations, this image can guarantee the
# code pushed out by the project is the only code which will run on the system after each container restart. # code pushed out by the project is the only code which will run on the system after each container restart.
# It reduces the chance of system hijacking and operates with all modern security protocols in place as is # It reduces the chance of system hijacking and operates with all modern security protocols in place as is
# expected from a security appliance. # expected from a security appliance.
@@ -29,10 +29,10 @@ COPY requirements.txt /tmp/requirements.txt
RUN apk add --no-cache bash shadow python3 python3-dev gcc musl-dev libffi-dev openssl-dev git \ RUN apk add --no-cache bash shadow python3 python3-dev gcc musl-dev libffi-dev openssl-dev git \
&& python -m venv /opt/venv && python -m venv /opt/venv
# Create virtual environment owned by root, but readable by everyone else. This makes it easy to copy # Create virtual environment owned by root, but readable by everyone else. This makes it easy to copy
# into hardened stage without worrying about permissions and keeps image size small. Keeping the commands # into hardened stage without worrying about permissions and keeps image size small. Keeping the commands
# together makes for a slightly smaller image size. # together makes for a slightly smaller image size.
RUN pip install -r /tmp/requirements.txt && \ RUN pip install --no-cache-dir -r /tmp/requirements.txt && \
chmod -R u-rwx,g-rwx /opt chmod -R u-rwx,g-rwx /opt
# second stage is the main runtime stage with just the minimum required to run the application # second stage is the main runtime stage with just the minimum required to run the application
@@ -68,7 +68,7 @@ ENV LOG_APP_PHP_ERRORS=${NETALERTX_LOG}/app.php_errors.log
ENV LOG_EXECUTION_QUEUE=${NETALERTX_LOG}/execution_queue.log ENV LOG_EXECUTION_QUEUE=${NETALERTX_LOG}/execution_queue.log
ENV LOG_REPORT_OUTPUT_JSON=${NETALERTX_LOG}/report_output.json ENV LOG_REPORT_OUTPUT_JSON=${NETALERTX_LOG}/report_output.json
ENV LOG_STDOUT=${NETALERTX_LOG}/stdout.log ENV LOG_STDOUT=${NETALERTX_LOG}/stdout.log
ENV LOG_CROND=${NETALERTX_LOG}/crond.log ENV LOG_CRON=${NETALERTX_LOG}/cron.log
ENV LOG_NGINX_ERROR=${NETALERTX_LOG}/nginx-error.log ENV LOG_NGINX_ERROR=${NETALERTX_LOG}/nginx-error.log
# System Services configuration files # System Services configuration files
@@ -77,11 +77,12 @@ ENV SYSTEM_SERVICES=/services
ENV SYSTEM_SERVICES_SCRIPTS=${SYSTEM_SERVICES}/scripts ENV SYSTEM_SERVICES_SCRIPTS=${SYSTEM_SERVICES}/scripts
ENV SYSTEM_SERVICES_CONFIG=${SYSTEM_SERVICES}/config ENV SYSTEM_SERVICES_CONFIG=${SYSTEM_SERVICES}/config
ENV SYSTEM_NGINX_CONFIG=${SYSTEM_SERVICES_CONFIG}/nginx ENV SYSTEM_NGINX_CONFIG=${SYSTEM_SERVICES_CONFIG}/nginx
ENV SYSTEM_NGINX_CONFIG_FILE=${SYSTEM_NGINX_CONFIG}/nginx.conf ENV SYSTEM_NGINX_CONFIG_TEMPLATE=${SYSTEM_NGINX_CONFIG}/netalertx.conf.template
ENV SYSTEM_SERVICES_CONFIG_CRON=${SYSTEM_SERVICES_CONFIG}/cron
ENV SYSTEM_SERVICES_ACTIVE_CONFIG=/tmp/nginx/active-config ENV SYSTEM_SERVICES_ACTIVE_CONFIG=/tmp/nginx/active-config
ENV SYSTEM_SERVICES_ACTIVE_CONFIG_FILE=${SYSTEM_SERVICES_ACTIVE_CONFIG}/nginx.conf
ENV SYSTEM_SERVICES_PHP_FOLDER=${SYSTEM_SERVICES_CONFIG}/php ENV SYSTEM_SERVICES_PHP_FOLDER=${SYSTEM_SERVICES_CONFIG}/php
ENV SYSTEM_SERVICES_PHP_FPM_D=${SYSTEM_SERVICES_PHP_FOLDER}/php-fpm.d ENV SYSTEM_SERVICES_PHP_FPM_D=${SYSTEM_SERVICES_PHP_FOLDER}/php-fpm.d
ENV SYSTEM_SERVICES_CROND=${SYSTEM_SERVICES_CONFIG}/crond
ENV SYSTEM_SERVICES_RUN=/tmp/run ENV SYSTEM_SERVICES_RUN=/tmp/run
ENV SYSTEM_SERVICES_RUN_TMP=${SYSTEM_SERVICES_RUN}/tmp ENV SYSTEM_SERVICES_RUN_TMP=${SYSTEM_SERVICES_RUN}/tmp
ENV SYSTEM_SERVICES_RUN_LOG=${SYSTEM_SERVICES_RUN}/logs ENV SYSTEM_SERVICES_RUN_LOG=${SYSTEM_SERVICES_RUN}/logs
@@ -94,11 +95,11 @@ ENV READ_WRITE_FOLDERS="${NETALERTX_DATA} ${NETALERTX_CONFIG} ${NETALERTX_DB} ${
${SYSTEM_SERVICES_ACTIVE_CONFIG}" ${SYSTEM_SERVICES_ACTIVE_CONFIG}"
#Python environment #Python environment
ENV PYTHONUNBUFFERED=1 ENV PYTHONUNBUFFERED=1
ENV VIRTUAL_ENV=/opt/venv ENV VIRTUAL_ENV=/opt/venv
ENV VIRTUAL_ENV_BIN=/opt/venv/bin ENV VIRTUAL_ENV_BIN=/opt/venv/bin
ENV PYTHONPATH=${NETALERTX_APP}:${NETALERTX_SERVER}:${NETALERTX_PLUGINS}:${VIRTUAL_ENV}/lib/python3.12/site-packages ENV PYTHONPATH=${NETALERTX_APP}:${NETALERTX_SERVER}:${NETALERTX_PLUGINS}:${VIRTUAL_ENV}/lib/python3.12/site-packages
ENV PATH="${SYSTEM_SERVICES}:${VIRTUAL_ENV_BIN}:$PATH" ENV PATH="${SYSTEM_SERVICES}:${VIRTUAL_ENV_BIN}:$PATH"
# App Environment # App Environment
ENV LISTEN_ADDR=0.0.0.0 ENV LISTEN_ADDR=0.0.0.0
@@ -109,13 +110,13 @@ ENV VENDORSPATH_NEWEST=${SYSTEM_SERVICES_RUN_TMP}/ieee-oui.txt
ENV ENVIRONMENT=alpine ENV ENVIRONMENT=alpine
ENV READ_ONLY_USER=readonly READ_ONLY_GROUP=readonly ENV READ_ONLY_USER=readonly READ_ONLY_GROUP=readonly
ENV NETALERTX_USER=netalertx NETALERTX_GROUP=netalertx ENV NETALERTX_USER=netalertx NETALERTX_GROUP=netalertx
ENV LANG=C.UTF-8 ENV LANG=C.UTF-8
RUN apk add --no-cache bash mtr libbsd zip lsblk tzdata curl arp-scan iproute2 iproute2-ss nmap \ RUN apk add --no-cache bash mtr libbsd zip lsblk tzdata curl arp-scan iproute2 iproute2-ss nmap \
nmap-scripts traceroute nbtscan net-tools net-snmp-tools bind-tools awake ca-certificates \ nmap-scripts traceroute nbtscan net-tools net-snmp-tools bind-tools awake ca-certificates \
sqlite php83 php83-fpm php83-cgi php83-curl php83-sqlite3 php83-session python3 envsubst \ sqlite php83 php83-fpm php83-cgi php83-curl php83-sqlite3 php83-session python3 envsubst \
nginx shadow && \ nginx supercronic shadow && \
rm -Rf /var/cache/apk/* && \ rm -Rf /var/cache/apk/* && \
rm -Rf /etc/nginx && \ rm -Rf /etc/nginx && \
addgroup -g 20211 ${NETALERTX_GROUP} && \ addgroup -g 20211 ${NETALERTX_GROUP} && \
@@ -136,7 +137,8 @@ RUN install -d -o ${NETALERTX_USER} -g ${NETALERTX_GROUP} -m 700 ${READ_WRITE_FO
-exec chmod 750 {} \;" -exec chmod 750 {} \;"
# Copy version information into the image # Copy version information into the image
COPY --chown=${NETALERTX_USER}:${NETALERTX_GROUP} .VERSION ${NETALERTX_APP}/.VERSION COPY --chown=${NETALERTX_USER}:${NETALERTX_GROUP} .[V]ERSION ${NETALERTX_APP}/.VERSION
COPY --chown=${NETALERTX_USER}:${NETALERTX_GROUP} .[V]ERSION ${NETALERTX_APP}/.VERSION_PREV
# Copy the virtualenv from the builder stage # Copy the virtualenv from the builder stage
COPY --from=builder --chown=20212:20212 ${VIRTUAL_ENV} ${VIRTUAL_ENV} COPY --from=builder --chown=20212:20212 ${VIRTUAL_ENV} ${VIRTUAL_ENV}
@@ -146,20 +148,26 @@ COPY --from=builder --chown=20212:20212 ${VIRTUAL_ENV} ${VIRTUAL_ENV}
# This is done after the copy of the venv to ensure the venv is in place # This is done after the copy of the venv to ensure the venv is in place
# although it may be quicker to do it before the copy, it keeps the image # although it may be quicker to do it before the copy, it keeps the image
# layers smaller to do it after. # layers smaller to do it after.
RUN apk add libcap && \ RUN for vfile in .VERSION .VERSION_PREV; do \
if [ ! -f "${NETALERTX_APP}/${vfile}" ]; then \
echo "DEVELOPMENT 00000000" > "${NETALERTX_APP}/${vfile}"; \
fi; \
chown 20212:20212 "${NETALERTX_APP}/${vfile}"; \
done && \
apk add --no-cache libcap && \
setcap cap_net_raw+ep /bin/busybox && \ setcap cap_net_raw+ep /bin/busybox && \
setcap cap_net_raw,cap_net_admin+eip /usr/bin/nmap && \ setcap cap_net_raw,cap_net_admin+eip /usr/bin/nmap && \
setcap cap_net_raw,cap_net_admin+eip /usr/bin/arp-scan && \ setcap cap_net_raw,cap_net_admin+eip /usr/bin/arp-scan && \
setcap cap_net_raw,cap_net_admin,cap_net_bind_service+eip /usr/bin/nbtscan && \ setcap cap_net_raw,cap_net_admin,cap_net_bind_service+eip /usr/bin/nbtscan && \
setcap cap_net_raw,cap_net_admin+eip /usr/bin/traceroute && \ setcap cap_net_raw,cap_net_admin+eip /usr/bin/traceroute && \
setcap cap_net_raw,cap_net_admin+eip $(readlink -f ${VIRTUAL_ENV_BIN}/python) && \ setcap cap_net_raw,cap_net_admin+eip "$(readlink -f ${VIRTUAL_ENV_BIN}/python)" && \
/bin/sh /build/init-nginx.sh && \ /bin/sh /build/init-nginx.sh && \
/bin/sh /build/init-php-fpm.sh && \ /bin/sh /build/init-php-fpm.sh && \
/bin/sh /build/init-crond.sh && \ /bin/sh /build/init-cron.sh && \
/bin/sh /build/init-backend.sh && \ /bin/sh /build/init-backend.sh && \
rm -rf /build && \ rm -rf /build && \
apk del libcap && \ apk del libcap && \
date +%s > ${NETALERTX_FRONT}/buildtimestamp.txt date +%s > "${NETALERTX_FRONT}/buildtimestamp.txt"
ENTRYPOINT ["/bin/sh","/entrypoint.sh"] ENTRYPOINT ["/bin/sh","/entrypoint.sh"]
@@ -173,16 +181,18 @@ ENV UMASK=0077
# Create readonly user and group with no shell access. # Create readonly user and group with no shell access.
# Readonly user marks folders that are created by NetAlertX, but should not be modified. # Readonly user marks folders that are created by NetAlertX, but should not be modified.
# AI may claim this is stupid, but it's actually least possible permissions as # AI may claim this is stupid, but it's actually least possible permissions as
# read-only user cannot login, cannot sudo, has no write permission, and cannot even # read-only user cannot login, cannot sudo, has no write permission, and cannot even
# read the files it owns. The read-only user is ownership-as-a-lock hardening pattern. # read the files it owns. The read-only user is ownership-as-a-lock hardening pattern.
RUN addgroup -g 20212 ${READ_ONLY_GROUP} && \ RUN addgroup -g 20212 "${READ_ONLY_GROUP}" && \
adduser -u 20212 -G ${READ_ONLY_GROUP} -D -h /app ${READ_ONLY_USER} adduser -u 20212 -G "${READ_ONLY_GROUP}" -D -h /app "${READ_ONLY_USER}"
# reduce permissions to minimum necessary for all NetAlertX files and folders # reduce permissions to minimum necessary for all NetAlertX files and folders
# Permissions 005 and 004 are not typos, they enable read-only. Everyone can # Permissions 005 and 004 are not typos, they enable read-only. Everyone can
# read the read-only files, and nobody can write to them, even the readonly user. # read the read-only files, and nobody can write to them, even the readonly user.
# hadolint ignore=SC2114
RUN chown -R ${READ_ONLY_USER}:${READ_ONLY_GROUP} ${READ_ONLY_FOLDERS} && \ RUN chown -R ${READ_ONLY_USER}:${READ_ONLY_GROUP} ${READ_ONLY_FOLDERS} && \
chmod -R 004 ${READ_ONLY_FOLDERS} && \ chmod -R 004 ${READ_ONLY_FOLDERS} && \
find ${READ_ONLY_FOLDERS} -type d -exec chmod 005 {} + && \ find ${READ_ONLY_FOLDERS} -type d -exec chmod 005 {} + && \
@@ -201,7 +211,7 @@ RUN chown -R ${READ_ONLY_USER}:${READ_ONLY_GROUP} ${READ_ONLY_FOLDERS} && \
/srv /media && \ /srv /media && \
sed -i "/^\(${READ_ONLY_USER}\|${NETALERTX_USER}\):/!d" /etc/passwd && \ sed -i "/^\(${READ_ONLY_USER}\|${NETALERTX_USER}\):/!d" /etc/passwd && \
sed -i "/^\(${READ_ONLY_GROUP}\|${NETALERTX_GROUP}\):/!d" /etc/group && \ sed -i "/^\(${READ_ONLY_GROUP}\|${NETALERTX_GROUP}\):/!d" /etc/group && \
echo -ne '#!/bin/sh\n"$@"\n' > /usr/bin/sudo && chmod +x /usr/bin/sudo printf '#!/bin/sh\n"$@"\n' > /usr/bin/sudo && chmod +x /usr/bin/sudo
USER netalertx USER netalertx

View File

@@ -72,7 +72,7 @@ ENV LOG_APP_PHP_ERRORS=${NETALERTX_LOG}/app.php_errors.log
ENV LOG_EXECUTION_QUEUE=${NETALERTX_LOG}/execution_queue.log ENV LOG_EXECUTION_QUEUE=${NETALERTX_LOG}/execution_queue.log
ENV LOG_REPORT_OUTPUT_JSON=${NETALERTX_LOG}/report_output.json ENV LOG_REPORT_OUTPUT_JSON=${NETALERTX_LOG}/report_output.json
ENV LOG_STDOUT=${NETALERTX_LOG}/stdout.log ENV LOG_STDOUT=${NETALERTX_LOG}/stdout.log
ENV LOG_CROND=${NETALERTX_LOG}/crond.log ENV LOG_CRON=${NETALERTX_LOG}/cron.log
ENV LOG_NGINX_ERROR=${NETALERTX_LOG}/nginx-error.log ENV LOG_NGINX_ERROR=${NETALERTX_LOG}/nginx-error.log
# System Services configuration files # System Services configuration files
@@ -132,25 +132,29 @@ COPY --chmod=775 --chown=${USER_ID}:${USER_GID} . ${INSTALL_DIR}/
# ❗ IMPORTANT - if you modify this file modify the /install/install_dependecies.debian.sh file as well ❗ # ❗ IMPORTANT - if you modify this file modify the /install/install_dependecies.debian.sh file as well ❗
RUN apt update && apt-get install -y \ # hadolint ignore=DL3008,DL3027
RUN apt-get update && apt-get install -y --no-install-recommends \
tini snmp ca-certificates curl libwww-perl arp-scan sudo gettext-base \ tini snmp ca-certificates curl libwww-perl arp-scan sudo gettext-base \
nginx-light php php-cgi php-fpm php-sqlite3 php-curl sqlite3 dnsutils net-tools \ nginx-light php php-cgi php-fpm php-sqlite3 php-curl sqlite3 dnsutils net-tools \
python3 python3-dev iproute2 nmap python3-pip zip git systemctl usbutils traceroute nbtscan openrc \ python3 python3-dev iproute2 nmap python3-pip zip git systemctl usbutils traceroute nbtscan openrc \
busybox nginx nginx-core mtr python3-venv busybox nginx nginx-core mtr python3-venv && \
rm -rf /var/lib/apt/lists/*
# While php8.3 is in debian bookworm repos, php-fpm is not included so we need to add sury.org repo # While php8.3 is in debian bookworm repos, php-fpm is not included so we need to add sury.org repo
# (Ondřej Surý maintains php packages for debian. This is temp until debian includes php-fpm in their # (Ondřej Surý maintains php packages for debian. This is temp until debian includes php-fpm in their
# repos. Likely it will be in Debian Trixie.). This keeps the image up-to-date with the alpine version. # repos. Likely it will be in Debian Trixie.). This keeps the image up-to-date with the alpine version.
# hadolint ignore=DL3008
RUN apt-get install -y --no-install-recommends \ RUN apt-get install -y --no-install-recommends \
apt-transport-https \ apt-transport-https \
ca-certificates \ ca-certificates \
lsb-release \ lsb-release \
wget && \ wget && \
wget -O /etc/apt/trusted.gpg.d/php.gpg https://packages.sury.org/php/apt.gpg && \ wget -q -O /etc/apt/trusted.gpg.d/php.gpg https://packages.sury.org/php/apt.gpg && \
echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" > /etc/apt/sources.list.d/php.list && \ echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" > /etc/apt/sources.list.d/php.list && \
apt-get update && \ apt-get update && \
apt-get install -y php8.3-fpm php8.3-cli php8.3-sqlite3 php8.3-common php8.3-curl php8.3-cgi && \ apt-get install -y --no-install-recommends php8.3-fpm php8.3-cli php8.3-sqlite3 php8.3-common php8.3-curl php8.3-cgi && \
ln -s /usr/sbin/php-fpm8.3 /usr/sbin/php-fpm83 # make it compatible with alpine version ln -s /usr/sbin/php-fpm8.3 /usr/sbin/php-fpm83 && \
rm -rf /var/lib/apt/lists/* # make it compatible with alpine version
# Setup virtual python environment and use pip3 to install packages # Setup virtual python environment and use pip3 to install packages
RUN python3 -m venv ${VIRTUAL_ENV} && \ RUN python3 -m venv ${VIRTUAL_ENV} && \

View File

@@ -34,23 +34,24 @@ Get visibility of what's going on on your WIFI/LAN network and enable presence d
## 🚀 Quick Start ## 🚀 Quick Start
> [!WARNING] > [!WARNING]
> ⚠️ **Important:** The documentation has been recently updated and some instructions may have changed. > ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://jokob-sk.github.io/NetAlertX/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions.
> If you are using the currently live production image, please follow the instructions on [Docker Hub](https://hub.docker.com/r/jokobsk/netalertx) for building and running the container.
> These docs reflect the latest development version and may differ from the production image.
Start NetAlertX in seconds with Docker: Start NetAlertX in seconds with Docker:
```bash ```bash
docker run -d --rm --network=host \ docker run -d \
-v local_path/config:/data/config \ --network=host \
-v local_path/db:/data/db \ --restart unless-stopped \
--mount type=tmpfs,target=/tmp/api \ -v /local_data_dir:/data \
-e PUID=200 -e PGID=300 \ -v /etc/localtime:/etc/localtime:ro \
-e TZ=Europe/Berlin \ --tmpfs /tmp:uid=20211,gid=20211,mode=1700 \
-e PORT=20211 \ -e PORT=20211 \
-e APP_CONF_OVERRIDE='{"GRAPHQL_PORT":"20214"}' \
ghcr.io/jokob-sk/netalertx:latest ghcr.io/jokob-sk/netalertx:latest
``` ```
Note: Your `/local_data_dir` should contain a `config` and `db` folder.
To deploy a containerized instance directly from the source repository, execute the following BASH sequence: To deploy a containerized instance directly from the source repository, execute the following BASH sequence:
```bash ```bash
git clone https://github.com/jokob-sk/NetAlertX.git git clone https://github.com/jokob-sk/NetAlertX.git
@@ -67,9 +68,9 @@ For other install methods, check the [installation docs](#-documentation)
| [📑 Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_INSTALLATION.md) | [🚀 Releases](https://github.com/jokob-sk/NetAlertX/releases) | [📚 Docs](https://jokob-sk.github.io/NetAlertX/) | [🔌 Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md) | [🤖 Ask AI](https://gurubase.io/g/netalertx) | [📑 Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_INSTALLATION.md) | [🚀 Releases](https://github.com/jokob-sk/NetAlertX/releases) | [📚 Docs](https://jokob-sk.github.io/NetAlertX/) | [🔌 Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md) | [🤖 Ask AI](https://gurubase.io/g/netalertx)
|----------------------| ----------------------| ----------------------| ----------------------| ----------------------| |----------------------| ----------------------| ----------------------| ----------------------| ----------------------|
![showcase][showcase] ![showcase][showcase]
<details> <details>
<summary>📷 Click for more screenshots</summary> <summary>📷 Click for more screenshots</summary>
@@ -87,15 +88,15 @@ For other install methods, check the [installation docs](#-documentation)
### Scanners ### Scanners
The app scans your network for **New devices**, **New connections** (re-connections), **Disconnections**, **"Always Connected" devices down**, Devices **IP changes** and **Internet IP address changes**. Discovery & scan methods include: **arp-scan**, **Pi-hole - DB import**, **Pi-hole - DHCP leases import**, **Generic DHCP leases import**, **UNIFI controller import**, **SNMP-enabled router import**. Check the [Plugins](https://github.com/jokob-sk/NetAlertX/tree/main/docs/PLUGINS.md#readme) docs for a full list of avaliable plugins. The app scans your network for **New devices**, **New connections** (re-connections), **Disconnections**, **"Always Connected" devices down**, Devices **IP changes** and **Internet IP address changes**. Discovery & scan methods include: **arp-scan**, **Pi-hole - DB import**, **Pi-hole - DHCP leases import**, **Generic DHCP leases import**, **UNIFI controller import**, **SNMP-enabled router import**. Check the [Plugins](https://github.com/jokob-sk/NetAlertX/tree/main/docs/PLUGINS.md#readme) docs for a full list of avaliable plugins.
### Notification gateways ### Notification gateways
Send notifications to more than 80+ services, including Telegram via [Apprise](https://hub.docker.com/r/caronc/apprise), or use native [Pushsafer](https://www.pushsafer.com/), [Pushover](https://www.pushover.net/), or [NTFY](https://ntfy.sh/) publishers. Send notifications to more than 80+ services, including Telegram via [Apprise](https://hub.docker.com/r/caronc/apprise), or use native [Pushsafer](https://www.pushsafer.com/), [Pushover](https://www.pushover.net/), or [NTFY](https://ntfy.sh/) publishers.
### Integrations and Plugins ### Integrations and Plugins
Feed your data and device changes into [Home Assistant](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HOME_ASSISTANT.md), read [API endpoints](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md), or use [Webhooks](https://github.com/jokob-sk/NetAlertX/blob/main/docs/WEBHOOK_N8N.md) to setup custom automation flows. You can also Feed your data and device changes into [Home Assistant](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HOME_ASSISTANT.md), read [API endpoints](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md), or use [Webhooks](https://github.com/jokob-sk/NetAlertX/blob/main/docs/WEBHOOK_N8N.md) to setup custom automation flows. You can also
build your own scanners with the [Plugin system](https://github.com/jokob-sk/NetAlertX/tree/main/docs/PLUGINS.md#readme) in as little as [15 minutes](https://www.youtube.com/watch?v=cdbxlwiWhv8). build your own scanners with the [Plugin system](https://github.com/jokob-sk/NetAlertX/tree/main/docs/PLUGINS.md#readme) in as little as [15 minutes](https://www.youtube.com/watch?v=cdbxlwiWhv8).
### Workflows ### Workflows
@@ -108,10 +109,10 @@ The [workflows module](https://github.com/jokob-sk/NetAlertX/blob/main/docs/WORK
Supported browsers: Chrome, Firefox Supported browsers: Chrome, Firefox
- [[Installation] Docker](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_INSTALLATION.md) - [[Installation] Docker](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_INSTALLATION.md)
- [[Installation] Home Assistant](https://github.com/alexbelgium/hassio-addons/tree/master/netalertx) - [[Installation] Home Assistant](https://github.com/alexbelgium/hassio-addons/tree/master/netalertx)
- [[Installation] Bare metal](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) - [[Installation] Bare metal](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md)
- [[Installation] Unraid App](https://unraid.net/community/apps) - [[Installation] Unraid App](https://unraid.net/community/apps)
- [[Setup] Usage and Configuration](https://github.com/jokob-sk/NetAlertX/blob/main/docs/README.md) - [[Setup] Usage and Configuration](https://github.com/jokob-sk/NetAlertX/blob/main/docs/README.md)
- [[Development] API docs](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md) - [[Development] API docs](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md)
- [[Development] Custom Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS_DEV.md) - [[Development] Custom Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS_DEV.md)
@@ -132,19 +133,19 @@ See [Security Best Practices](https://github.com/jokob-sk/NetAlertX/security) fo
## ❓ FAQ ## ❓ FAQ
**Q: Why dont I see any devices?** **Q: Why dont I see any devices?**
A: Ensure the container has proper network access (e.g., use `--network host` on Linux). Also check that your scan method is properly configured in the UI. A: Ensure the container has proper network access (e.g., use `--network host` on Linux). Also check that your scan method is properly configured in the UI.
**Q: Does this work on Wi-Fi-only devices like Raspberry Pi?** **Q: Does this work on Wi-Fi-only devices like Raspberry Pi?**
A: Yes, but some scanners (e.g. ARP) work best on Ethernet. For Wi-Fi, try SNMP, DHCP, or Pi-hole import. A: Yes, but some scanners (e.g. ARP) work best on Ethernet. For Wi-Fi, try SNMP, DHCP, or Pi-hole import.
**Q: Will this send any data to the internet?** **Q: Will this send any data to the internet?**
A: No. All scans and data remain local, unless you set up cloud-based notifications. A: No. All scans and data remain local, unless you set up cloud-based notifications.
**Q: Can I use this without Docker?** **Q: Can I use this without Docker?**
A: Yes! You can install it bare-metal. See the [bare metal installation guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md). A: Yes! You can install it bare-metal. See the [bare metal installation guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md).
**Q: Where is the data stored?** **Q: Where is the data stored?**
A: In the `/data/config` and `/data/db` folders. Back up these folders regularly. A: In the `/data/config` and `/data/db` folders. Back up these folders regularly.
@@ -162,9 +163,9 @@ Check the [GitHub Issues](https://github.com/jokob-sk/NetAlertX/issues) for the
### 📧 Get notified what's new ### 📧 Get notified what's new
Get notified about a new release, what new functionality you can use and about breaking changes. Get notified about a new release, what new functionality you can use and about breaking changes.
![Follow and star][follow_star] ![Follow and star][follow_star]
### 🔀 Other Alternative Apps ### 🔀 Other Alternative Apps
@@ -175,15 +176,15 @@ Get notified about a new release, what new functionality you can use and about b
### 💙 Donations ### 💙 Donations
Thank you to everyone who appreciates this tool and donates. Thank you to everyone who appreciates this tool and donates.
<details> <details>
<summary>Click for more ways to donate</summary> <summary>Click for more ways to donate</summary>
<hr> <hr>
| [![GitHub](https://i.imgur.com/emsRCPh.png)](https://github.com/sponsors/jokob-sk) | [![Buy Me A Coffee](https://i.imgur.com/pIM6YXL.png)](https://www.buymeacoffee.com/jokobsk) | [![Patreon](https://i.imgur.com/MuYsrq1.png)](https://www.patreon.com/user?u=84385063) | | [![GitHub](https://i.imgur.com/emsRCPh.png)](https://github.com/sponsors/jokob-sk) | [![Buy Me A Coffee](https://i.imgur.com/pIM6YXL.png)](https://www.buymeacoffee.com/jokobsk) | [![Patreon](https://i.imgur.com/MuYsrq1.png)](https://www.patreon.com/user?u=84385063) |
| --- | --- | --- | | --- | --- | --- |
- Bitcoin: `1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM` - Bitcoin: `1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM`
- Ethereum: `0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7` - Ethereum: `0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7`
@@ -194,11 +195,11 @@ Thank you to everyone who appreciates this tool and donates.
### 🏗 Contributors ### 🏗 Contributors
This project would be nothing without the amazing work of the community, with special thanks to: This project would be nothing without the amazing work of the community, with special thanks to:
> [pucherot/Pi.Alert](https://github.com/pucherot/Pi.Alert) (the original creator of PiAlert), [leiweibau](https://github.com/leiweibau/Pi.Alert): Dark mode (and much more), [Macleykun](https://github.com/Macleykun) (Help with Dockerfile clean-up), [vladaurosh](https://github.com/vladaurosh) for Alpine re-base help, [Final-Hawk](https://github.com/Final-Hawk) (Help with NTFY, styling and other fixes), [TeroRERO](https://github.com/terorero) (Spanish translations), [Data-Monkey](https://github.com/Data-Monkey), (Split-up of the python.py file and more), [cvc90](https://github.com/cvc90) (Spanish translation and various UI work) to name a few. Check out all the [amazing contributors](https://github.com/jokob-sk/NetAlertX/graphs/contributors). > [pucherot/Pi.Alert](https://github.com/pucherot/Pi.Alert) (the original creator of PiAlert), [leiweibau](https://github.com/leiweibau/Pi.Alert): Dark mode (and much more), [Macleykun](https://github.com/Macleykun) (Help with Dockerfile clean-up), [vladaurosh](https://github.com/vladaurosh) for Alpine re-base help, [Final-Hawk](https://github.com/Final-Hawk) (Help with NTFY, styling and other fixes), [TeroRERO](https://github.com/terorero) (Spanish translations), [Data-Monkey](https://github.com/Data-Monkey), (Split-up of the python.py file and more), [cvc90](https://github.com/cvc90) (Spanish translation and various UI work) to name a few. Check out all the [amazing contributors](https://github.com/jokob-sk/NetAlertX/graphs/contributors).
### 🌍 Translations ### 🌍 Translations
Proudly using [Weblate](https://hosted.weblate.org/projects/pialert/). Help out and suggest languages in the [online portal of Weblate](https://hosted.weblate.org/projects/pialert/core/). Proudly using [Weblate](https://hosted.weblate.org/projects/pialert/). Help out and suggest languages in the [online portal of Weblate](https://hosted.weblate.org/projects/pialert/core/).

View File

@@ -1,14 +1,17 @@
#!/bin/bash #!/bin/bash
export INSTALL_DIR=/app export INSTALL_DIR=/app
LOG_FILE="${INSTALL_DIR}/log/execution_queue.log" if [ -f "${LOG_EXECUTION_QUEUE}" ] && grep -q "cron_restart_backend" "${LOG_EXECUTION_QUEUE}"; then
echo "$(date): Restarting backend triggered by cron_restart_backend"
# Check if there are any entries with cron_restart_backend killall python3 || echo "killall python3 failed or no process found"
if grep -q "cron_restart_backend" "$LOG_FILE"; then sleep 2
# Restart python application using s6 /services/start-backend.sh &
s6-svc -r /var/run/s6-rc/servicedirs/netalertx
echo 'done'
# Remove all lines containing cron_restart_backend from the log file # Remove all lines containing cron_restart_backend from the log file
sed -i '/cron_restart_backend/d' "$LOG_FILE" # Atomic replacement with temp file. grep returns 1 if no lines selected (file becomes empty), which is valid here.
grep -v "cron_restart_backend" "${LOG_EXECUTION_QUEUE}" > "${LOG_EXECUTION_QUEUE}.tmp"
RC=$?
if [ $RC -eq 0 ] || [ $RC -eq 1 ]; then
mv "${LOG_EXECUTION_QUEUE}.tmp" "${LOG_EXECUTION_QUEUE}"
fi
fi fi

View File

@@ -1,4 +1,4 @@
# NetAlertX API Documentation # API Documentation
This API provides programmatic access to **devices, events, sessions, metrics, network tools, and sync** in NetAlertX. It is implemented as a **REST and GraphQL server**. All requests require authentication via **API Token** (`API_TOKEN` setting) unless explicitly noted. For example, to authorize a GraphQL request, you need to use a `Authorization: Bearer API_TOKEN` header as per example below: This API provides programmatic access to **devices, events, sessions, metrics, network tools, and sync** in NetAlertX. It is implemented as a **REST and GraphQL server**. All requests require authentication via **API Token** (`API_TOKEN` setting) unless explicitly noted. For example, to authorize a GraphQL request, you need to use a `Authorization: Bearer API_TOKEN` header as per example below:

View File

@@ -52,7 +52,7 @@ query GetDevices($options: PageQueryOptionsInput) {
} }
``` ```
See also: [Debugging GraphQL issues](./DEBUG_GRAPHQL.md) See also: [Debugging GraphQL issues](./DEBUG_API_SERVER.md)
### `curl` Command ### `curl` Command

View File

@@ -1,57 +1,114 @@
### Loading... # Troubleshooting Common Issues
Often if the application is misconfigured the `Loading...` dialog is continuously displayed. This is most likely caused by the backed failing to start. The **Maintenance -> Logs** section should give you more details on what's happening. If there is no exception, check the Portainer log, or start the container in the foreground (without the `-d` parameter) to observe any exceptions. It's advisable to enable `trace` or `debug`. Check the [Debug tips](./DEBUG_TIPS.md) on detailed instructions. > [!TIP]
> Before troubleshooting, ensure you have set the correct [Debugging and LOG_LEVEL](./DEBUG_TIPS.md).
### Incorrect SCAN_SUBNETS ---
One of the most common issues is not configuring `SCAN_SUBNETS` correctly. If this setting is misconfigured you will only see one or two devices in your devices list after a scan. Please read the [subnets docs](./SUBNETS.md) carefully to resolve this. ## Docker Container Doesn't Start
### Duplicate devices and notifications Initial setup issues are often caused by **missing permissions** or **incorrectly mapped volumes**. Always double-check your `docker run` or `docker-compose.yml` against the [official setup guide](./DOCKER_INSTALLATION.md) before proceeding.
The app uses the MAC address as an unique identifier for devices. If a new MAC is detected a new device is added to the application and corresponding notifications are triggered. This means that if the MAC of an existing device changes, the device will be logged as a new device. You can usually prevent this from happening by changing the device configuration (in Android, iOS, or Windows) for your network. See the [Random Macs](./RANDOM_MAC.md) guide for details.
### Permissions ### Permissions
Make sure you [File permissions](./FILE_PERMISSIONS.md) are set correctly. Make sure your [file permissions](./FILE_PERMISSIONS.md) are correctly set:
* If facing issues (AJAX errors, can't write to DB, empty screen, etc,) make sure permissions are set correctly, and check the logs under `/tmp/log`. * If you encounter AJAX errors, cannot write to the database, or see an empty screen, check that permissions are correct and review the logs under `/tmp/log`.
* To solve permission issues you can try setting the owner and group of the `app.db` by executing the following on the host system: `docker exec netalertx chown -R www-data:www-data /data/db/app.db`. * To fix permission issues with the database, update the owner and group of `app.db` as described in the [File Permissions guide](./FILE_PERMISSIONS.md).
* If still facing issues, try to map the app.db file (⚠ not folder) to `:/data/db/app.db` (see [docker-compose Examples](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md#-docker-composeyml-examples) for details)
### Container restarts / crashes ### Container Restarts / Crashes
* Check the logs for details. Often a required setting for a notification method is missing. * Check the logs for details. Often, required settings are missing.
* For more detailed troubleshooting, see [Debug and Troubleshooting Tips](./DEBUG_TIPS.md).
* To observe errors directly, run the container in the foreground instead of `-d`:
### unable to resolve host ```bash
docker run --rm -it <your_image>
```
* Check that your `SCAN_SUBNETS` variable is using the correct mask and `--interface`. See the [subnets docs for details](./SUBNETS.md). ---
### Invalid JSON ## Docker Container Starts, But the Application Misbehaves
Check the [Invalid JSON errors debug help](./DEBUG_INVALID_JSON.md) docs on how to proceed. If the container starts but the app shows unexpected behavior, the cause is often **data corruption**, **incorrect configuration**, or **unexpected input data**.
### sudo execution failing (e.g.: on arpscan) on a Raspberry Pi 4 ### Continuous "Loading..." Screen
> sudo: unexpected child termination condition: 0 A misconfigured application may display a persistent `Loading...` dialog. This is usually caused by the backend failing to start.
Resolution based on [this issue](https://github.com/linuxserver/docker-papermerge/issues/4#issuecomment-1003657581) **Steps to troubleshoot:**
1. Check **Maintenance → Logs** for exceptions.
2. If no exception is visible, check the Portainer logs.
3. Start the container in the foreground to observe exceptions.
4. Enable `trace` or `debug` logging for detailed output (see [Debug Tips](./DEBUG_TIPS.md)).
5. Verify that `GRAPHQL_PORT` is correctly configured.
6. Check browser logs (press `F12`):
* **Console tab** → refresh the page
* **Network tab** → refresh the page
If you are unsure how to resolve errors, provide screenshots or log excerpts in your issue report or Discord discussion.
---
### Common Configuration Issues
#### Incorrect `SCAN_SUBNETS`
If `SCAN_SUBNETS` is misconfigured, you may see only a few devices in your device list after a scan. See the [Subnets Documentation](./SUBNETS.md) for proper configuration.
#### Duplicate Devices and Notifications
* Devices are identified by their **MAC address**.
* If a device's MAC changes, it will be treated as a new device, triggering notifications.
* Prevent this by adjusting your device configuration for Android, iOS, or Windows. See the [Random MACs Guide](./RANDOM_MAC.md).
#### Unable to Resolve Host
* Ensure `SCAN_SUBNETS` uses the correct mask and `--interface`.
* Refer to the [Subnets Documentation](./SUBNETS.md) for detailed guidance.
#### Invalid JSON Errors
* Follow the steps in [Invalid JSON Errors Debug Help](./DEBUG_INVALID_JSON.md).
#### Sudo Execution Fails (e.g., on arpscan on Raspberry Pi 4)
Error:
``` ```
sudo: unexpected child termination condition: 0
```
**Resolution**:
```bash
wget ftp.us.debian.org/debian/pool/main/libs/libseccomp/libseccomp2_2.5.3-2_armhf.deb wget ftp.us.debian.org/debian/pool/main/libs/libseccomp/libseccomp2_2.5.3-2_armhf.deb
sudo dpkg -i libseccomp2_2.5.3-2_armhf.deb sudo dpkg -i libseccomp2_2.5.3-2_armhf.deb
``` ```
The link above will probably break in time too. Go to https://packages.debian.org/sid/armhf/libseccomp2/download to find the new version number and put that in the url. > ⚠️ The link may break over time. Check [Debian Packages](https://packages.debian.org/sid/armhf/libseccomp2/download) for the latest version.
### Only Router and own device show up #### Only Router and Own Device Show Up
Make sure that the subnet and interface in `SCAN_SUBNETS` are correct. If your device/NAS has multiple ethernet ports, you probably need to change `eth0` to something else. * Verify the subnet and interface in `SCAN_SUBNETS`.
* On devices with multiple Ethernet ports, you may need to change `eth0` to the correct interface.
### Losing my settings and devices after an update #### Losing Settings or Devices After Update
If you lose your devices and/or settings after an update that means you don't have the `/data/db` and `/data/config` folders mapped to a permanent storage. That means every time you update these folders are re-created. Make sure you have the [volumes specified correctly](./DOCKER_COMPOSE.md) in your `docker-compose.yml` or run command. * Ensure `/data/db` and `/data/config` are mapped to persistent storage.
* Without persistent volumes, these folders are recreated on every update.
* See [Docker Volumes Setup](./DOCKER_COMPOSE.md) for proper configuration.
#### Application Performance Issues
### The application is slow Slowness can be caused by:
* Incorrect settings (causing app restarts) → check `app.log`.
* Too many background processes → disable unnecessary scanners.
* Long scans → limit the number of scanned devices.
* Excessive disk operations or failing maintenance plugins.
> See [Performance Tips](./PERFORMANCE.md) for detailed optimization steps.
Slowness is usually caused by incorrect settings (the app might restart, so check the `app.log`), too many background processes (disable unnecessary scanners), too long scans (limit the number of scanned devices), too many disk operations, or some maintenance plugins might have failed. See the [Performance tips](./PERFORMANCE.md) docs for details.

21
docs/DEBUG_GRAPHQL.md → docs/DEBUG_API_SERVER.md Executable file → Normal file
View File

@@ -1,35 +1,34 @@
# Debugging GraphQL server issues # Debugging GraphQL server issues
The GraphQL server is an API middle layer, running on it's own port specified by `GRAPHQL_PORT`, to retrieve and show the data in the UI. It can also be used to retrieve data for custom third party integarions. Check the [API documentation](./API.md) for details. The GraphQL server is an API middle layer, running on it's own port specified by `GRAPHQL_PORT`, to retrieve and show the data in the UI. It can also be used to retrieve data for custom third party integarions. Check the [API documentation](./API.md) for details.
The most common issue is that the GraphQL server doesn't start properly, usually due to a **port conflict**. If you are running multiple NetAlertX instances, make sure to use **unique ports** by changing the `GRAPHQL_PORT` setting. The default is `20212`. The most common issue is that the GraphQL server doesn't start properly, usually due to a **port conflict**. If you are running multiple NetAlertX instances, make sure to use **unique ports** by changing the `GRAPHQL_PORT` setting. The default is `20212`.
## How to update the `GRAPHQL_PORT` in case of issues ## How to update the `GRAPHQL_PORT` in case of issues
As a first troubleshooting step try changing the default `GRAPHQL_PORT` setting. Please remember NetAlertX is running on the host so any application uising the same port will cause issues. As a first troubleshooting step try changing the default `GRAPHQL_PORT` setting. Please remember NetAlertX is running on the host so any application uising the same port will cause issues.
### Updating the setting via the Settings UI ### Updating the setting via the Settings UI
Ideally use the Settings UI to update the setting under General -> Core -> GraphQL port: Ideally use the Settings UI to update the setting under General -> Core -> GraphQL port:
![GrapQL settings](./img/DEBUG_GRAPHQL/graphql_settings_port_token.png) ![GrapQL settings](./img/DEBUG_API_SERVER/graphql_settings_port_token.png)
You might need to temporarily stop other applications or NetAlertX instances causing conflicts to update the setting. The `API_TOKEN` is used to authenticate any API calls, including GraphQL requests. You might need to temporarily stop other applications or NetAlertX instances causing conflicts to update the setting. The `API_TOKEN` is used to authenticate any API calls, including GraphQL requests.
### Updating the `app.conf` file ### Updating the `app.conf` file
If the UI is not accessible, you can directly edit the `app.conf` file in your `/config` folder: If the UI is not accessible, you can directly edit the `app.conf` file in your `/config` folder:
![Editing app.conf](./img/DEBUG_GRAPHQL/app_conf_graphql_port.png) ![Editing app.conf](./img/DEBUG_API_SERVER/app_conf_graphql_port.png)
### Using a docker variable ### Using a docker variable
All application settings can also be initialized via the `APP_CONF_OVERRIDE` docker env variable. All application settings can also be initialized via the `APP_CONF_OVERRIDE` docker env variable.
```yaml ```yaml
... ...
environment: environment:
- TZ=Europe/Berlin
- PORT=20213 - PORT=20213
- APP_CONF_OVERRIDE={"GRAPHQL_PORT":"20214"} - APP_CONF_OVERRIDE={"GRAPHQL_PORT":"20214"}
... ...
@@ -43,22 +42,22 @@ There are several ways to check if the GraphQL server is running.
You can navigate to Maintenance -> Init Check to see if `isGraphQLServerRunning` is ticked: You can navigate to Maintenance -> Init Check to see if `isGraphQLServerRunning` is ticked:
![Init Check](./img/DEBUG_GRAPHQL/Init_check.png) ![Init Check](./img/DEBUG_API_SERVER/Init_check.png)
### Checking the Logs ### Checking the Logs
You can navigate to Maintenance -> Logs and search for `graphql` to see if it started correctly and serving requests: You can navigate to Maintenance -> Logs and search for `graphql` to see if it started correctly and serving requests:
![GraphQL Logs](./img/DEBUG_GRAPHQL/graphql_running_logs.png) ![GraphQL Logs](./img/DEBUG_API_SERVER/graphql_running_logs.png)
### Inspecting the Browser console ### Inspecting the Browser console
In your browser open the dev console (usually F12) and navigate to the Network tab where you can filter GraphQL requests (e.g., reload the Devices page). In your browser open the dev console (usually F12) and navigate to the Network tab where you can filter GraphQL requests (e.g., reload the Devices page).
![Browser Network Tab](./img/DEBUG_GRAPHQL/network_graphql.png) ![Browser Network Tab](./img/DEBUG_API_SERVER/network_graphql.png)
You can then inspect any of the POST requests by opening them in a new tab. You can then inspect any of the POST requests by opening them in a new tab.
![Browser GraphQL Json](./img/DEBUG_GRAPHQL/dev_console_graphql_json.png) ![Browser GraphQL Json](./img/DEBUG_API_SERVER/dev_console_graphql_json.png)

View File

@@ -3,13 +3,13 @@
Check the the HTTP response of the failing backend call by following these steps: Check the the HTTP response of the failing backend call by following these steps:
- Open developer console in your browser (usually, e. g. for Chrome, key F12 on the keyboard). - Open developer console in your browser (usually, e. g. for Chrome, key F12 on the keyboard).
- Follow the steps in this screenshot: - Follow the steps in this screenshot:
![F12DeveloperConsole][F12DeveloperConsole] ![F12DeveloperConsole][F12DeveloperConsole]
- Copy the URL causing the error and enter it in the address bar of your browser directly and hit enter. The copied URLs could look something like this (notice the query strings at the end): - Copy the URL causing the error and enter it in the address bar of your browser directly and hit enter. The copied URLs could look something like this (notice the query strings at the end):
- `http://<NetAlertX URL>:20211/api/table_devices.json?nocache=1704141103121` - `http://<server>:20211/api/table_devices.json?nocache=1704141103121`
- `http://<NetAlertX URL>:20211/php/server/devices.php?action=getDevicesTotals` - `http://<server>:20211/php/server/devices.php?action=getDevicesTotals`
- Post the error response in the existing issue thread on GitHub or create a new issue and include the redacted response of the failing query. - Post the error response in the existing issue thread on GitHub or create a new issue and include the redacted response of the failing query.

View File

@@ -1,5 +1,8 @@
# Troubleshooting plugins # Troubleshooting plugins
> [!TIP]
> Before troubleshooting, please ensure you have the right [Debugging and LOG_LEVEL set](./DEBUG_TIPS.md).
## High-level overview ## High-level overview
If a Plugin supplies data to the main app it's done either vie a SQL query or via a script that updates the `last_result.log` file in the plugin log folder (`app/log/plugins/`). If a Plugin supplies data to the main app it's done either vie a SQL query or via a script that updates the `last_result.log` file in the plugin log folder (`app/log/plugins/`).
@@ -9,7 +12,7 @@ For a more in-depth overview on how plugins work check the [Plugins development
### Prerequisites ### Prerequisites
- Make sure you read and followed the specific plugin setup instructions. - Make sure you read and followed the specific plugin setup instructions.
- Ensure you have [debug enabled (see More Logging)](./DEBUG_TIPS.md) - Ensure you have [debug enabled (see More Logging)](./DEBUG_TIPS.md)
### Potential issues ### Potential issues
@@ -47,9 +50,9 @@ Input data from the plugin might cause mapping issues in specific edge cases. Lo
17:31:05 [Plugins] history_to_insert count: 4 17:31:05 [Plugins] history_to_insert count: 4
17:31:05 [Plugins] objects_to_insert count: 0 17:31:05 [Plugins] objects_to_insert count: 0
17:31:05 [Plugins] objects_to_update count: 4 17:31:05 [Plugins] objects_to_update count: 4
17:31:05 [Plugin utils] In pluginEvents there are 2 events with the status "watched-not-changed" 17:31:05 [Plugin utils] In pluginEvents there are 2 events with the status "watched-not-changed"
17:31:05 [Plugin utils] In pluginObjects there are 2 events with the status "missing-in-last-scan" 17:31:05 [Plugin utils] In pluginObjects there are 2 events with the status "missing-in-last-scan"
17:31:05 [Plugin utils] In pluginObjects there are 2 events with the status "watched-not-changed" 17:31:05 [Plugin utils] In pluginObjects there are 2 events with the status "watched-not-changed"
17:31:05 [Plugins] Mapping objects to database table: CurrentScan 17:31:05 [Plugins] Mapping objects to database table: CurrentScan
17:31:05 [Plugins] SQL query for mapping: INSERT into CurrentScan ( "cur_MAC", "cur_IP", "cur_LastQuery", "cur_Name", "cur_Vendor", "cur_ScanMethod") VALUES ( ?, ?, ?, ?, ?, ?) 17:31:05 [Plugins] SQL query for mapping: INSERT into CurrentScan ( "cur_MAC", "cur_IP", "cur_LastQuery", "cur_Name", "cur_Vendor", "cur_ScanMethod") VALUES ( ?, ?, ?, ?, ?, ?)
17:31:05 [Plugins] SQL sqlParams for mapping: [('01:01:01:01:01:01', '172.30.0.1', 0, 'aaaa', 'vvvvvvvvv', 'PIHOLE'), ('02:42:ac:1e:00:02', '172.30.0.2', 0, 'dddd', 'vvvvv2222', 'PIHOLE')] 17:31:05 [Plugins] SQL sqlParams for mapping: [('01:01:01:01:01:01', '172.30.0.1', 0, 'aaaa', 'vvvvvvvvv', 'PIHOLE'), ('02:42:ac:1e:00:02', '172.30.0.2', 0, 'dddd', 'vvvvv2222', 'PIHOLE')]
@@ -80,7 +83,7 @@ These values, if formatted correctly, will also show up in the UI:
### Sharing application state ### Sharing application state
Sometimes specific log sections are needed to debug issues. The Devices and CurrentScan table data is sometimes needed to figure out what's wrong. Sometimes specific log sections are needed to debug issues. The Devices and CurrentScan table data is sometimes needed to figure out what's wrong.
1. Please set `LOG_LEVEL` to `trace` (Disable it once you have the info as this produces big log files). 1. Please set `LOG_LEVEL` to `trace` (Disable it once you have the info as this produces big log files).
2. Wait for the issue to occur. 2. Wait for the issue to occur.

View File

@@ -1,30 +1,36 @@
# Debugging and troubleshooting # Debugging and troubleshooting
Please follow tips 1 - 4 to get a more detailed error. Please follow tips 1 - 4 to get a more detailed error.
## 1. More Logging ## 1. More Logging
When debugging an issue always set the highest log level: When debugging an issue always set the highest log level:
`LOG_LEVEL='trace'` `LOG_LEVEL='trace'`
## 2. Surfacing errors when container restarts ## 2. Surfacing errors when container restarts
Start the container via the **terminal** with a command similar to this one: Start the container via the **terminal** with a command similar to this one:
```bash ```bash
docker run --rm --network=host \ docker run \
-v local/path/netalertx/config:/data/config \ --network=host \
-v local/path/netalertx/db:/data/db \ --restart unless-stopped \
-e TZ=Europe/Berlin \ -v /local_data_dir:/data \
-v /etc/localtime:/etc/localtime:ro \
--tmpfs /tmp:uid=20211,gid=20211,mode=1700 \
-e PORT=20211 \ -e PORT=20211 \
-e APP_CONF_OVERRIDE='{"GRAPHQL_PORT":"20214"}' \
ghcr.io/jokob-sk/netalertx:latest ghcr.io/jokob-sk/netalertx:latest
``` ```
> ⚠ Please note, don't use the `-d` parameter so you see the error when the container crashes. Use this error in your issue description. Note: Your `/local_data_dir` should contain a `config` and `db` folder.
## 3. Check the _dev image and open issues > [!NOTE]
> ⚠ The most important part is NOT to use the `-d` parameter so you see the error when the container crashes. Use this error in your issue description.
## 3. Check the _dev image and open issues
If possible, check if your issue got fixed in the `_dev` image before opening a new issue. The container is: If possible, check if your issue got fixed in the `_dev` image before opening a new issue. The container is:
@@ -34,7 +40,7 @@ If possible, check if your issue got fixed in the `_dev` image before opening a
Please also search [open issues](https://github.com/jokob-sk/NetAlertX/issues). Please also search [open issues](https://github.com/jokob-sk/NetAlertX/issues).
## 4. Disable restart behavior ## 4. Disable restart behavior
To prevent a Docker container from automatically restarting in a Docker Compose file, specify the restart policy as `no`: To prevent a Docker container from automatically restarting in a Docker Compose file, specify the restart policy as `no`:
@@ -48,9 +54,14 @@ services:
# Other service configurations... # Other service configurations...
``` ```
## 5. Sharing application state ## 5. TMP mount directories to rule host out permission issues
Sometimes specific log sections are needed to debug issues. The Devices and CurrentScan table data is sometimes needed to figure out what's wrong. Try starting the container with all data to be in non-persistent volumes. If this works, the issue might be related to the permissions of your persistent data mount locations on your server. See teh [Permissions guide](./FILE_PERMISSIONS.md) for details.
## 6. Sharing application state
Sometimes specific log sections are needed to debug issues. The Devices and CurrentScan table data is sometimes needed to figure out what's wrong.
1. Please set `LOG_LEVEL` to `trace` (Disable it once you have the info as this produces big log files). 1. Please set `LOG_LEVEL` to `trace` (Disable it once you have the info as this produces big log files).
2. Wait for the issue to occur. 2. Wait for the issue to occur.
@@ -61,4 +72,4 @@ Sometimes specific log sections are needed to debug issues. The Devices and Curr
## Common issues ## Common issues
See [Common issues](./COMMON_ISSUES.md) for details. See [Common issues](./COMMON_ISSUES.md) for additional troubleshooting tips.

View File

@@ -4,8 +4,8 @@ NetAlertX allows you to mass-edit devices via a CSV export and import feature, o
## UI multi edit ## UI multi edit
> [!NOTE] > [!NOTE]
> Make sure you have your backups saved and restorable before doing any mass edits. Check [Backup strategies](./BACKUPS.md). > Make sure you have your backups saved and restorable before doing any mass edits. Check [Backup strategies](./BACKUPS.md).
You can select devices in the _Devices_ view by selecting devices to edit and then clicking the _Multi-edit_ button or via the _Maintenance_ > _Multi-Edit_ section. You can select devices in the _Devices_ view by selecting devices to edit and then clicking the _Multi-edit_ button or via the _Maintenance_ > _Multi-Edit_ section.
@@ -16,23 +16,23 @@ You can select devices in the _Devices_ view by selecting devices to edit and th
The database and device structure may change with new releases. When using the CSV import functionality, ensure the format matches what the application expects. To avoid issues, you can first export the devices and review the column formats before importing any custom data. The database and device structure may change with new releases. When using the CSV import functionality, ensure the format matches what the application expects. To avoid issues, you can first export the devices and review the column formats before importing any custom data.
> [!NOTE] > [!NOTE]
> As always, backup everything, just in case. > As always, backup everything, just in case.
1. In _Maintenance_ > _Backup / Restore_ click the _CSV Export_ button. 1. In _Maintenance_ > _Backup / Restore_ click the _CSV Export_ button.
2. A `devices.csv` is generated in the `/config` folder 2. A `devices.csv` is generated in the `/config` folder
3. Edit the `devices.csv` file however you like. 3. Edit the `devices.csv` file however you like.
![Maintenance > CSV Export](./img/DEVICES_BULK_EDITING/MAINTENANCE_CSV_EXPORT.png) ![Maintenance > CSV Export](./img/DEVICES_BULK_EDITING/MAINTENANCE_CSV_EXPORT.png)
> [!NOTE] > [!NOTE]
> The file containing a list of Devices including the Network relationships between Network Nodes and connected devices. You can also trigger this by acessing this URL: `<your netalertx url>/php/server/devices.php?action=ExportCSV` or via the `CSV Backup` plugin. (💡 You can schedule this) > The file containing a list of Devices including the Network relationships between Network Nodes and connected devices. You can also trigger this by acessing this URL: `<server>:20211/php/server/devices.php?action=ExportCSV` or via the `CSV Backup` plugin. (💡 You can schedule this)
![Settings > CSV Backup](./img/DEVICES_BULK_EDITING/CSV_BACKUP_SETTINGS.png) ![Settings > CSV Backup](./img/DEVICES_BULK_EDITING/CSV_BACKUP_SETTINGS.png)
### File encoding format ### File encoding format
> [!NOTE] > [!NOTE]
> Keep Linux line endings (suggested editors: Nano, Notepad++) > Keep Linux line endings (suggested editors: Nano, Notepad++)
![Nodepad++ line endings](./img/DEVICES_BULK_EDITING/NOTEPAD++.png) ![Nodepad++ line endings](./img/DEVICES_BULK_EDITING/NOTEPAD++.png)

View File

@@ -1,8 +1,8 @@
# NetAlertX - Device Management # Device Management
The Main Info section is where most of the device identifiable information is stored and edited. Some of the information is autodetected via various plugins. Initial values for most of the fields can be specified in the `NEWDEV` plugin. The Main Info section is where most of the device identifiable information is stored and edited. Some of the information is autodetected via various plugins. Initial values for most of the fields can be specified in the `NEWDEV` plugin.
> [!NOTE] > [!NOTE]
> >
> You can multi-edit devices by selecting them in the main Devices view, from the Mainetence section, or via the CSV Export functionality under Maintenance. More info can be found in the [Devices Bulk-editing docs](./DEVICES_BULK_EDITING.md). > You can multi-edit devices by selecting them in the main Devices view, from the Mainetence section, or via the CSV Export functionality under Maintenance. More info can be found in the [Devices Bulk-editing docs](./DEVICES_BULK_EDITING.md).
@@ -14,23 +14,23 @@ The Main Info section is where most of the device identifiable information is st
- **MAC**: MAC addres of the device. Not editable, unless creating a new dummy device. - **MAC**: MAC addres of the device. Not editable, unless creating a new dummy device.
- **Last IP**: IP addres of the device. Not editable, unless creating a new dummy device. - **Last IP**: IP addres of the device. Not editable, unless creating a new dummy device.
- **Name**: Friendly device name. Autodetected via various 🆎 Name discovery [plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md). The app attaches `(IP match)` if the name is discovered via an IP match and not MAC match which could mean the name could be incorrect as IPs might change. - **Name**: Friendly device name. Autodetected via various 🆎 Name discovery [plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md). The app attaches `(IP match)` if the name is discovered via an IP match and not MAC match which could mean the name could be incorrect as IPs might change.
- **Icon**: Partially autodetected. Select an existing or [add a custom icon](./ICONS.md). You can also auto-apply the same icon on all devices of the same type. - **Icon**: Partially autodetected. Select an existing or [add a custom icon](./ICONS.md). You can also auto-apply the same icon on all devices of the same type.
- **Owner**: Device owner (The list is self-populated with existing owners and you can add custom values). - **Owner**: Device owner (The list is self-populated with existing owners and you can add custom values).
- **Type**: Select a device type from the dropdown list (`Smartphone`, `Tablet`, - **Type**: Select a device type from the dropdown list (`Smartphone`, `Tablet`,
`Laptop`, `TV`, `router`, etc.) or add a new device type. If you want the device to act as a **Network device** (and be able to be a network node in the Network view), select a type under Network Devices or add a new Network Device type in Settings. More information can be found in the [Network Setup docs](./NETWORK_TREE.md). `Laptop`, `TV`, `router`, etc.) or add a new device type. If you want the device to act as a **Network device** (and be able to be a network node in the Network view), select a type under Network Devices or add a new Network Device type in Settings. More information can be found in the [Network Setup docs](./NETWORK_TREE.md).
- **Vendor**: The manufacturing vendor. Automatically updated by NetAlertX when empty or unknown, can be edited. - **Vendor**: The manufacturing vendor. Automatically updated by NetAlertX when empty or unknown, can be edited.
- **Group**: Select a group (`Always on`, `Personal`, `Friends`, etc.) or type - **Group**: Select a group (`Always on`, `Personal`, `Friends`, etc.) or type
your own Group name. your own Group name.
- **Location**: Select the location, usually a room, where the device is located (`Kitchen`, `Attic`, `Living room`, etc.) or add a custom Location. - **Location**: Select the location, usually a room, where the device is located (`Kitchen`, `Attic`, `Living room`, etc.) or add a custom Location.
- **Comments**: Add any comments for the device, such as a serial number, or maintenance information. - **Comments**: Add any comments for the device, such as a serial number, or maintenance information.
> [!NOTE] > [!NOTE]
> >
> Please note the above usage of the fields are only suggestions. You can use most of these fields for other purposes, such as storing the network interface, company owning a device, or similar. > Please note the above usage of the fields are only suggestions. You can use most of these fields for other purposes, such as storing the network interface, company owning a device, or similar.
## Dummy devices ## Dummy devices
You can create dummy devices from the Devices listing screen. You can create dummy devices from the Devices listing screen.
![Create Dummy Device](./img/DEVICE_MANAGEMENT/Devices_CreateDummyDevice.png) ![Create Dummy Device](./img/DEVICE_MANAGEMENT/Devices_CreateDummyDevice.png)
@@ -39,12 +39,12 @@ The **MAC** field and the **Last IP** field will then become editable.
![Save Dummy Device](./img/DEVICE_MANAGEMENT/DeviceEdit_SaveDummyDevice.png) ![Save Dummy Device](./img/DEVICE_MANAGEMENT/DeviceEdit_SaveDummyDevice.png)
> [!NOTE] > [!NOTE]
> >
> You can couple this with the `ICMP` plugin which can be used to monitor the status of these devices, if they are actual devices reachable with the `ping` command. If not, you can use a loopback IP address so they appear online, such as `0.0.0.0` or `127.0.0.1`. > You can couple this with the `ICMP` plugin which can be used to monitor the status of these devices, if they are actual devices reachable with the `ping` command. If not, you can use a loopback IP address so they appear online, such as `0.0.0.0` or `127.0.0.1`.
## Copying data from an existing device. ## Copying data from an existing device.
To speed up device population you can also copy data from an existing device. This can be done from the **Tools** tab on the Device details. To speed up device population you can also copy data from an existing device. This can be done from the **Tools** tab on the Device details.

View File

@@ -55,7 +55,6 @@ The file content should be following, with your custom values.
#-------------------------------- #--------------------------------
#NETALERTX #NETALERTX
#-------------------------------- #--------------------------------
TZ=Europe/Berlin
PORT=22222 # make sure this port is unique on your whole network PORT=22222 # make sure this port is unique on your whole network
DEV_LOCATION=/development/NetAlertX DEV_LOCATION=/development/NetAlertX
APP_DATA_LOCATION=/volume/docker_appdata APP_DATA_LOCATION=/volume/docker_appdata

View File

@@ -1,18 +1,16 @@
# NetAlertX and Docker Compose # NetAlertX and Docker Compose
> [!WARNING] > [!WARNING]
> ⚠️ **Important:** The documentation has been recently updated and some instructions may have changed. > ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://jokob-sk.github.io/NetAlertX/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions.
> If you are using the currently live production image, please follow the instructions on [Docker Hub](https://hub.docker.com/r/jokobsk/netalertx) for building and running the container.
> These docs reflect the latest development version and may differ from the production image.
Great care is taken to ensure NetAlertX meets the needs of everyone while being flexible enough for anyone. This document outlines how you can configure your docker-compose. There are many settings, so we recommend using the Baseline Docker Compose as-is, or modifying it for your system.Good care is taken to ensure NetAlertX meets the needs of everyone while being flexible enough for anyone. This document outlines how you can configure your docker-compose. There are many settings, so we recommend using the Baseline Docker Compose as-is, or modifying it for your system. Great care is taken to ensure NetAlertX meets the needs of everyone while being flexible enough for anyone. This document outlines how you can configure your docker-compose. There are many settings, so we recommend using the Baseline Docker Compose as-is, or modifying it for your system.Good care is taken to ensure NetAlertX meets the needs of everyone while being flexible enough for anyone. This document outlines how you can configure your docker-compose. There are many settings, so we recommend using the Baseline Docker Compose as-is, or modifying it for your system.
> [!NOTE] > [!NOTE]
> The container needs to run in `network_mode:"host"` to access Layer 2 networking such as arp, nmap and others. Due to lack of support for this feature, Windows host is not a supported operating system. > The container needs to run in `network_mode:"host"` to access Layer 2 networking such as arp, nmap and others. Due to lack of support for this feature, Windows host is not a supported operating system.
## Baseline Docker Compose ## Baseline Docker Compose
There is one baseline for NetAlertX. That's the default security-enabled official distribution. There is one baseline for NetAlertX. That's the default security-enabled official distribution.
```yaml ```yaml
services: services:
@@ -45,7 +43,7 @@ services:
# - /home/user/netalertx_data:/data:rw # - /home/user/netalertx_data:/data:rw
- type: bind # Bind mount for timezone consistency - type: bind # Bind mount for timezone consistency
source: /etc/localtime # Alternatively add environment TZ: America/New York source: /etc/localtime
target: /etc/localtime target: /etc/localtime
read_only: true read_only: true
@@ -125,15 +123,17 @@ docker compose up
### Modification 1: Use a Local Folder (Bind Mount) ### Modification 1: Use a Local Folder (Bind Mount)
By default, the baseline compose file uses "named volumes" (`netalertx_config`, `netalertx_db`). **This is the preferred method** because NetAlertX is designed to manage all configuration and database settings directly from its web UI. Named volumes let Docker handle this data cleanly without you needing to manage local file permissions or paths. By default, the baseline compose file uses a single named volume (netalertx_data) mounted at `/data`. This single-volume layout is preferred because NetAlertX manages both configuration and the database under `/data` (for example, `/data/config` and `/data/db`) via its web UI. Using one named volume simplifies permissions and portability: Docker manages the storage and NetAlertX manages the files inside `/data`.
A two-volume layout that mounts `/data/config` and `/data/db` separately (for example, `netalertx_config` and `netalertx_db`) is supported for backward compatibility and some advanced workflows, but it is an abnormal/legacy layout and not recommended for new deployments.
However, if you prefer to have direct, file-level access to your configuration for manual editing, a "bind mount" is a simple alternative. This tells Docker to use a specific folder from your computer (the "host") inside the container. However, if you prefer to have direct, file-level access to your configuration for manual editing, a "bind mount" is a simple alternative. This tells Docker to use a specific folder from your computer (the "host") inside the container.
**How to make the change:** **How to make the change:**
1. Choose a location on your computer. For example, `/home/adam/netalertx-files`. 1. Choose a location on your computer. For example, `/local_data_dir`.
2. Create the subfolders: `mkdir -p /home/adam/netalertx-files/config` and `mkdir -p /home/adam/netalertx-files/db`. 2. Create the subfolders: `mkdir -p /local_data_dir/config` and `mkdir -p /local_data_dir/db`.
3. Edit your `docker-compose.yml` and find the `volumes:` section (the one *inside* the `netalertx:` service). 3. Edit your `docker-compose.yml` and find the `volumes:` section (the one *inside* the `netalertx:` service).
@@ -152,19 +152,19 @@ However, if you prefer to have direct, file-level access to your configuration f
``` ```
**After (Using a Local Folder / Bind Mount):** **After (Using a Local Folder / Bind Mount):**
Make sure to replace `/home/adam/netalertx-files` with your actual path. The format is `<path_on_your_computer>:<path_inside_container>:<options>`. Make sure to replace `/local_data_dir` with your actual path. The format is `<path_on_your_computer>:<path_inside_container>:<options>`.
```yaml ```yaml
... ...
volumes: volumes:
# - netalertx_config:/data/config:rw # - netalertx_config:/data/config:rw
# - netalertx_db:/data/db:rw # - netalertx_db:/data/db:rw
- /home/adam/netalertx-files/config:/data/config:rw - /local_data_dir/config:/data/config:rw
- /home/adam/netalertx-files/db:/data/db:rw - /local_data_dir/db:/data/db:rw
... ...
``` ```
Now, any files created by NetAlertX in `/data/config` will appear in your `/home/adam/netalertx-files/config` folder. Now, any files created by NetAlertX in `/data/config` will appear in your `/local_data_dir/config` folder.
This same method works for mounting other things, like custom plugins or enterprise NGINX files, as shown in the commented-out examples in the baseline file. This same method works for mounting other things, like custom plugins or enterprise NGINX files, as shown in the commented-out examples in the baseline file.
@@ -183,20 +183,18 @@ This method is useful for keeping your paths and other settings separate from yo
services: services:
netalertx: netalertx:
environment: environment:
- TZ=${TZ}
- PORT=${PORT} - PORT=${PORT}
- GRAPHQL_PORT=${GRAPHQL_PORT}
... ...
``` ```
**`.env` file contents:** **`.env` file contents:**
```sh ```sh
TZ=Europe/Paris
PORT=20211 PORT=20211
NETALERTX_NETWORK_MODE=host NETALERTX_NETWORK_MODE=host
LISTEN_ADDR=0.0.0.0 LISTEN_ADDR=0.0.0.0
PORT=20211
GRAPHQL_PORT=20212 GRAPHQL_PORT=20212
``` ```

View File

@@ -7,7 +7,7 @@
# NetAlertX - Network scanner & notification framework # NetAlertX - Network scanner & notification framework
| [📑 Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_INSTALLATION.md) | [🚀 Releases](https://github.com/jokob-sk/NetAlertX/releases) | [📚 Docs](https://jokob-sk.github.io/NetAlertX/) | [🔌 Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md) | [🤖 Ask AI](https://gurubase.io/g/netalertx) | [📑 Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_INSTALLATION.md) | [🚀 Releases](https://github.com/jokob-sk/NetAlertX/releases) | [📚 Docs](https://jokob-sk.github.io/NetAlertX/) | [🔌 Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md) | [🤖 Ask AI](https://gurubase.io/g/netalertx)
|----------------------| ----------------------| ----------------------| ----------------------| ----------------------| |----------------------| ----------------------| ----------------------| ----------------------| ----------------------|
<a href="https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/GENERAL/github_social_image.jpg" target="_blank"> <a href="https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/GENERAL/github_social_image.jpg" target="_blank">
<img src="https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/GENERAL/github_social_image.jpg" width="1000px" /> <img src="https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/GENERAL/github_social_image.jpg" width="1000px" />
@@ -16,35 +16,38 @@
Head to [https://netalertx.com/](https://netalertx.com/) for more gifs and screenshots 📷. Head to [https://netalertx.com/](https://netalertx.com/) for more gifs and screenshots 📷.
> [!NOTE] > [!NOTE]
> There is also an experimental 🧪 [bare-metal install](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) method available. > There is also an experimental 🧪 [bare-metal install](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) method available.
## 📕 Basic Usage ## 📕 Basic Usage
> [!WARNING] > [!WARNING]
> You will have to run the container on the `host` network and specify `SCAN_SUBNETS` unless you use other [plugin scanners](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md). The initial scan can take a few minutes, so please wait 5-10 minutes for the initial discovery to finish. > You will have to run the container on the `host` network and specify `SCAN_SUBNETS` unless you use other [plugin scanners](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md). The initial scan can take a few minutes, so please wait 5-10 minutes for the initial discovery to finish.
```yaml ```bash
docker run -d --rm --network=host \ docker run -d --rm --network=host \
-v local_path/config:/data/config \ -v /local_data_dir:/data \
-v local_path/db:/data/db \ -v /etc/localtime:/etc/localtime \
--mount type=tmpfs,target=/tmp/api \ --tmpfs /tmp:uid=20211,gid=20211,mode=1700 \
-e PUID=200 -e PGID=300 \
-e TZ=Europe/Berlin \
-e PORT=20211 \ -e PORT=20211 \
-e APP_CONF_OVERRIDE={"GRAPHQL_PORT":"20214"} \
ghcr.io/jokob-sk/netalertx:latest ghcr.io/jokob-sk/netalertx:latest
``` ```
See alternative [docked-compose examples](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_COMPOSE.md). See alternative [docked-compose examples](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_COMPOSE.md).
### Default ports
| Default | Description | How to override |
| :------------- |:-------------------------------| ----------------------------------------------------------------------------------:|
| `20211` |Port of the web interface | `-e PORT=20222` |
| `20212` |Port of the backend API server | `-e APP_CONF_OVERRIDE={"GRAPHQL_PORT":"20214"}` or via the `GRAPHQL_PORT` Setting |
### Docker environment variables ### Docker environment variables
| Variable | Description | Example Value | | Variable | Description | Example Value |
| :------------- |:------------------------| -----:| | :------------- |:------------------------| -----:|
| `PORT` |Port of the web interface | `20211` | | `PORT` |Port of the web interface | `20211` |
| `PUID` |Application User UID | `102` |
| `PGID` |Application User GID | `82` |
| `LISTEN_ADDR` |Set the specific IP Address for the listener address for the nginx webserver (web interface). This could be useful when using multiple subnets to hide the web interface from all untrusted networks. | `0.0.0.0` | | `LISTEN_ADDR` |Set the specific IP Address for the listener address for the nginx webserver (web interface). This could be useful when using multiple subnets to hide the web interface from all untrusted networks. | `0.0.0.0` |
|`TZ` |Time zone to display stats correctly. Find your time zone [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) | `Europe/Berlin` |
|`LOADED_PLUGINS` | Default [plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md) to load. Plugins cannot be loaded with `APP_CONF_OVERRIDE`, you need to use this variable instead and then specify the plugins settings with `APP_CONF_OVERRIDE`. | `["PIHOLE","ASUSWRT"]` | |`LOADED_PLUGINS` | Default [plugins](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md) to load. Plugins cannot be loaded with `APP_CONF_OVERRIDE`, you need to use this variable instead and then specify the plugins settings with `APP_CONF_OVERRIDE`. | `["PIHOLE","ASUSWRT"]` |
|`APP_CONF_OVERRIDE` | JSON override for settings (except `LOADED_PLUGINS`). | `{"SCAN_SUBNETS":"['192.168.1.0/24 --interface=eth1']","GRAPHQL_PORT":"20212"}` | |`APP_CONF_OVERRIDE` | JSON override for settings (except `LOADED_PLUGINS`). | `{"SCAN_SUBNETS":"['192.168.1.0/24 --interface=eth1']","GRAPHQL_PORT":"20212"}` |
|`ALWAYS_FRESH_INSTALL` | ⚠ If `true` will delete the content of the `/db` & `/config` folders. For testing purposes. Can be coupled with [watchtower](https://github.com/containrrr/watchtower) to have an always freshly installed `netalertx`/`netalertx-dev` image. | `true` | |`ALWAYS_FRESH_INSTALL` | ⚠ If `true` will delete the content of the `/db` & `/config` folders. For testing purposes. Can be coupled with [watchtower](https://github.com/containrrr/watchtower) to have an always freshly installed `netalertx`/`netalertx-dev` image. | `true` |
@@ -54,48 +57,48 @@ See alternative [docked-compose examples](https://github.com/jokob-sk/NetAlertX/
### Docker paths ### Docker paths
> [!NOTE] > [!NOTE]
> See also [Backup strategies](https://github.com/jokob-sk/NetAlertX/blob/main/docs/BACKUPS.md). > See also [Backup strategies](https://github.com/jokob-sk/NetAlertX/blob/main/docs/BACKUPS.md).
| Required | Path | Description | | Required | Path | Description |
| :------------- | :------------- | :-------------| | :------------- | :------------- | :-------------|
| ✅ | `:/data/config` | Folder which will contain the `app.conf` & `devices.csv` ([read about devices.csv](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEVICES_BULK_EDITING.md)) files | | ✅ | `:/data` | Folder which will contain the `/db/app.db`, `/config/app.conf` & `/config/devices.csv` ([read about devices.csv](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEVICES_BULK_EDITING.md)) files |
| ✅ | `:/data/db` | Folder which will contain the `app.db` database file | | ✅ | `/etc/localtime:/etc/localtime:ro` | Ensuring the timezone is teh same as on teh server. |
| | `:/tmp/log` | Logs folder useful for debugging if you have issues setting up the container | | | `:/tmp/log` | Logs folder useful for debugging if you have issues setting up the container |
| | `:/tmp/api` | A simple [API endpoint](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md) containing static (but regularly updated) json and other files. Path configurable via `NETALERTX_API` environment variable. | | | `:/tmp/api` | The [API endpoint](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md) containing static (but regularly updated) json and other files. Path configurable via `NETALERTX_API` environment variable. |
| | `:/app/front/plugins/<plugin>/ignore_plugin` | Map a file `ignore_plugin` to ignore a plugin. Plugins can be soft-disabled via settings. More in the [Plugin docs](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md). | | | `:/app/front/plugins/<plugin>/ignore_plugin` | Map a file `ignore_plugin` to ignore a plugin. Plugins can be soft-disabled via settings. More in the [Plugin docs](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md). |
| | `:/etc/resolv.conf` | Use a custom `resolv.conf` file for [better name resolution](https://github.com/jokob-sk/NetAlertX/blob/main/docs/REVERSE_DNS.md). | | | `:/etc/resolv.conf` | Use a custom `resolv.conf` file for [better name resolution](https://github.com/jokob-sk/NetAlertX/blob/main/docs/REVERSE_DNS.md). |
> Use separate `db` and `config` directories, do not nest them. > Use separate `db` and `config` directories, do not nest them.
### Initial setup ### Initial setup
- If unavailable, the app generates a default `app.conf` and `app.db` file on the first run. - If unavailable, the app generates a default `app.conf` and `app.db` file on the first run.
- The preferred way is to manage the configuration via the Settings section in the UI, if UI is inaccessible you can modify [app.conf](https://github.com/jokob-sk/NetAlertX/tree/main/back) in the `/data/config/` folder directly - The preferred way is to manage the configuration via the Settings section in the UI, if UI is inaccessible you can modify [app.conf](https://github.com/jokob-sk/NetAlertX/tree/main/back) in the `/data/config/` folder directly
#### Setting up scanners #### Setting up scanners
You have to specify which network(s) should be scanned. This is done by entering subnets that are accessible from the host. If you use the default `ARPSCAN` plugin, you have to specify at least one valid subnet and interface in the `SCAN_SUBNETS` setting. See the documentation on [How to set up multiple SUBNETS, VLANs and what are limitations](https://github.com/jokob-sk/NetAlertX/blob/main/docs/SUBNETS.md) for troubleshooting and more advanced scenarios. You have to specify which network(s) should be scanned. This is done by entering subnets that are accessible from the host. If you use the default `ARPSCAN` plugin, you have to specify at least one valid subnet and interface in the `SCAN_SUBNETS` setting. See the documentation on [How to set up multiple SUBNETS, VLANs and what are limitations](https://github.com/jokob-sk/NetAlertX/blob/main/docs/SUBNETS.md) for troubleshooting and more advanced scenarios.
If you are running PiHole you can synchronize devices directly. Check the [PiHole configuration guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PIHOLE_GUIDE.md) for details. If you are running PiHole you can synchronize devices directly. Check the [PiHole configuration guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PIHOLE_GUIDE.md) for details.
> [!NOTE] > [!NOTE]
> You can bulk-import devices via the [CSV import method](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEVICES_BULK_EDITING.md). > You can bulk-import devices via the [CSV import method](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEVICES_BULK_EDITING.md).
#### Community guides #### Community guides
You can read or watch several [community configuration guides](https://github.com/jokob-sk/NetAlertX/blob/main/docs/COMMUNITY_GUIDES.md) in Chinese, Korean, German, or French. You can read or watch several [community configuration guides](https://github.com/jokob-sk/NetAlertX/blob/main/docs/COMMUNITY_GUIDES.md) in Chinese, Korean, German, or French.
> Please note these might be outdated. Rely on official documentation first.
> Please note these might be outdated. Rely on official documentation first.
#### Common issues #### Common issues
- Before creating a new issue, please check if a similar issue was [already resolved](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed). - Before creating a new issue, please check if a similar issue was [already resolved](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed).
- Check also common issues and [debugging tips](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md). - Check also common issues and [debugging tips](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md).
## 💙 Support me ## 💙 Support me
| [![GitHub](https://i.imgur.com/emsRCPh.png)](https://github.com/sponsors/jokob-sk) | [![Buy Me A Coffee](https://i.imgur.com/pIM6YXL.png)](https://www.buymeacoffee.com/jokobsk) | [![Patreon](https://i.imgur.com/MuYsrq1.png)](https://www.patreon.com/user?u=84385063) | | [![GitHub](https://i.imgur.com/emsRCPh.png)](https://github.com/sponsors/jokob-sk) | [![Buy Me A Coffee](https://i.imgur.com/pIM6YXL.png)](https://www.buymeacoffee.com/jokobsk) | [![Patreon](https://i.imgur.com/MuYsrq1.png)](https://www.patreon.com/user?u=84385063) |
| --- | --- | --- | | --- | --- | --- |
- Bitcoin: `1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM` - Bitcoin: `1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM`
- Ethereum: `0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7` - Ethereum: `0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7`

View File

@@ -1,20 +1,18 @@
# The NetAlertX Container Operator's Guide # The NetAlertX Container Operator's Guide
> [!WARNING] > [!WARNING]
> ⚠️ **Important:** The documentation has been recently updated and some instructions may have changed. > ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://jokob-sk.github.io/NetAlertX/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions.
> If you are using the currently live production image, please follow the instructions on [Docker Hub](https://hub.docker.com/r/jokobsk/netalertx) for building and running the container.
> These docs reflect the latest development version and may differ from the production image.
This guide assumes you are starting with the official `docker-compose.yml` file provided with the project. We strongly recommend you start with or migrate to this file as your baseline and modify it to suit your specific needs (e.g., changing file paths). While there are many ways to configure NetAlertX, the default file is designed to meet the mandatory security baseline with layer-2 networking capabilities while operating securely and without startup warnings. This guide assumes you are starting with the official `docker-compose.yml` file provided with the project. We strongly recommend you start with or migrate to this file as your baseline and modify it to suit your specific needs (e.g., changing file paths). While there are many ways to configure NetAlertX, the default file is designed to meet the mandatory security baseline with layer-2 networking capabilities while operating securely and without startup warnings.
This guide provides direct, concise solutions for common NetAlertX administrative tasks. It is structured to help you identify a problem, implement the solution, and understand the details. This guide provides direct, concise solutions for common NetAlertX administrative tasks. It is structured to help you identify a problem, implement the solution, and understand the details.
## Guide Contents ## Guide Contents
- Using a Local Folder for Configuration - Using a Local Folder for Configuration
- Migrating from a Local Folder to a Docker Volume - Migrating from a Local Folder to a Docker Volume
- Applying a Custom Nginx Configuration - Applying a Custom Nginx Configuration
- Mounting Additional Files for Plugins - Mounting Additional Files for Plugins
> [!NOTE] > [!NOTE]

View File

@@ -8,12 +8,12 @@ This guide shows you how to set up **NetAlertX** using Portainers **Stacks**
## 1. Prepare Your Host ## 1. Prepare Your Host
Before deploying, make sure you have a folder on your Docker host for NetAlertX data. Replace `APP_FOLDER` with your preferred location, for example `/opt` here: Before deploying, make sure you have a folder on your Docker host for NetAlertX data. Replace `APP_FOLDER` with your preferred location, for example `/local_data_dir` here:
```bash ```bash
mkdir -p /opt/netalertx/config mkdir -p /local_data_dir/netalertx/config
mkdir -p /opt/netalertx/db mkdir -p /local_data_dir/netalertx/db
mkdir -p /opt/netalertx/log mkdir -p /local_data_dir/netalertx/log
``` ```
--- ---
@@ -34,32 +34,27 @@ Copy and paste the following YAML into the **Web editor**:
services: services:
netalertx: netalertx:
container_name: netalertx container_name: netalertx
# Use this line for stable release # Use this line for stable release
image: "ghcr.io/jokob-sk/netalertx:latest" image: "ghcr.io/jokob-sk/netalertx:latest"
# Or, use this for the latest development build # Or, use this for the latest development build
# image: "ghcr.io/jokob-sk/netalertx-dev:latest" # image: "ghcr.io/jokob-sk/netalertx-dev:latest"
network_mode: "host" network_mode: "host"
restart: unless-stopped restart: unless-stopped
cap_drop: # Drop all capabilities for enhanced security
- ALL
cap_add: # Re-add necessary capabilities
- NET_RAW
- NET_ADMIN
- NET_BIND_SERVICE
volumes: volumes:
- ${APP_FOLDER}/netalertx/config:/data/config - ${APP_FOLDER}/netalertx/config:/data/config
- ${APP_FOLDER}/netalertx/db:/data/db - ${APP_FOLDER}/netalertx/db:/data/db
# Optional: logs (useful for debugging setup issues, comment out for performance) # to sync with system time
- ${APP_FOLDER}/netalertx/log:/tmp/log - /etc/localtime:/etc/localtime:ro
tmpfs:
# API storage options: # All writable runtime state resides under /tmp; comment out to persist logs between restarts
# (Option 1) tmpfs (default, best performance) - "/tmp:uid=20211,gid=20211,mode=1700,rw,noexec,nosuid,nodev,async,noatime,nodiratime"
- type: tmpfs
target: /tmp/api
# (Option 2) bind mount (useful for debugging)
# - ${APP_FOLDER}/netalertx/api:/tmp/api
environment: environment:
- TZ=${TZ}
- PORT=${PORT} - PORT=${PORT}
- APP_CONF_OVERRIDE=${APP_CONF_OVERRIDE} - APP_CONF_OVERRIDE=${APP_CONF_OVERRIDE}
``` ```
@@ -70,14 +65,26 @@ services:
In the **Environment variables** section of Portainer, add the following: In the **Environment variables** section of Portainer, add the following:
* `APP_FOLDER=/opt` (or wherever you created the directories in step 1) * `APP_FOLDER=/local_data_dir` (or wherever you created the directories in step 1)
* `TZ=Europe/Berlin` (replace with your timezone)
* `PORT=22022` (or another port if needed) * `PORT=22022` (or another port if needed)
* `APP_CONF_OVERRIDE={"GRAPHQL_PORT":"22023"}` (optional advanced settings) * `APP_CONF_OVERRIDE={"GRAPHQL_PORT":"22023"}` (optional advanced settings, otherwise the backend API server PORT defaults to `20212`)
--- ---
## 5. Deploy the Stack ## 5. Ensure permissions
> [!TIP]
> If you are facing permissions issues run the following commands on your server. This will change the owner and assure sufficient access to the database and config files that are stored in the `/local_data_dir/db` and `/local_data_dir/config` folders (replace `local_data_dir` with the location where your `/db` and `/config` folders are located).
>
> `sudo chown -R 20211:20211 /local_data_dir`
>
> `sudo chmod -R a+rwx /local_data_dir`
>
---
## 6. Deploy the Stack
1. Scroll down and click **Deploy the stack**. 1. Scroll down and click **Deploy the stack**.
2. Portainer will pull the image and start NetAlertX. 2. Portainer will pull the image and start NetAlertX.
@@ -89,9 +96,9 @@ http://<your-docker-host-ip>:22022
--- ---
## 6. Verify and Troubleshoot ## 7. Verify and Troubleshoot
* Check logs via Portainer → **Containers**`netalertx`**Logs**. * Check logs via Portainer → **Containers**`netalertx`**Logs**.
* Logs are stored under `${APP_FOLDER}/netalertx/log` if you enabled that volume. * Logs are stored under `${APP_FOLDER}/netalertx/log` if you enabled that volume.
Once the application is running, configure it by reading the [initial setup](INITIAL_SETUP.md) guide, or [troubleshoot common issues](COMMON_ISSUES.md). Once the application is running, configure it by reading the [initial setup](INITIAL_SETUP.md) guide, or [troubleshoot common issues](COMMON_ISSUES.md).

View File

@@ -41,15 +41,7 @@ Use the following Compose snippet to deploy NetAlertX with a **static LAN IP** a
services: services:
netalertx: netalertx:
image: ghcr.io/jokob-sk/netalertx:latest image: ghcr.io/jokob-sk/netalertx:latest
ports: ...
- 20211:20211
volumes:
- /mnt/YOUR_SERVER/netalertx/config:/data/config:rw
- /mnt/YOUR_SERVER/netalertx/db:/netalertx/data/db:rw
- /mnt/YOUR_SERVER/netalertx/logs:/netalertx/tmp/log:rw
environment:
- TZ=Europe/London
- PORT=20211
networks: networks:
swarm-ipvlan: swarm-ipvlan:
ipv4_address: 192.168.1.240 # ⚠️ Choose a free IP from your LAN ipv4_address: 192.168.1.240 # ⚠️ Choose a free IP from your LAN

View File

@@ -1,8 +1,23 @@
# Managing File Permissions for NetAlertX on a Read-Only Container # Managing File Permissions for NetAlertX on a Read-Only Container
Sometimes, permission issues arise if your existing host directories were created by a previous container running as root or another UID. The container will fail to start with "Permission Denied" errors.
> [!TIP] > [!TIP]
> NetAlertX runs in a **secure, read-only Alpine-based container** under a dedicated `netalertx` user (UID 20211, GID 20211). All writable paths are either mounted as **persistent volumes** or **`tmpfs` filesystems**. This ensures consistent file ownership and prevents privilege escalation. > NetAlertX runs in a **secure, read-only Alpine-based container** under a dedicated `netalertx` user (UID 20211, GID 20211). All writable paths are either mounted as **persistent volumes** or **`tmpfs` filesystems**. This ensures consistent file ownership and prevents privilege escalation.
Try starting the container with all data to be in non-persistent volumes. If this works, the issue might be related to the permissions of your persistent data mount locations on your server.
```bash
docker run --rm --network=host \
-v /etc/localtime:/etc/localtime:ro \
--tmpfs /tmp:uid=20211,gid=20211,mode=1700 \
-e PORT=20211 \
ghcr.io/jokob-sk/netalertx:latest
```
> [!WARNING]
> The above should be only used as a test - once the container restarts, all data is lost.
--- ---
## Writable Paths ## Writable Paths
@@ -25,18 +40,14 @@ NetAlertX requires certain paths to be writable at runtime. These paths should b
--- ---
## Fixing Permission Problems
Sometimes, permission issues arise if your existing host directories were created by a previous container running as root or another UID. The container will fail to start with "Permission Denied" errors.
### Solution ### Solution
1. **Run the container once as root** (`--user "0"`) to allow it to correct permissions automatically: 1. **Run the container once as root** (`--user "0"`) to allow it to correct permissions automatically:
```bash ```bash
docker run -it --rm --name netalertx --user "0" \ docker run -it --rm --name netalertx --user "0" \
-v local/path/config:/data/config \ -v /local_data_dir:/data \
-v local/path/db:/data/db \ --tmpfs /tmp:uid=20211,gid=20211,mode=1700 \
ghcr.io/jokob-sk/netalertx:latest ghcr.io/jokob-sk/netalertx:latest
``` ```
@@ -46,26 +57,35 @@ docker run -it --rm --name netalertx --user "0" \
> The container startup script detects `root` and runs `chown -R 20211:20211` on all volumes, fixing ownership for the secure `netalertx` user. > The container startup script detects `root` and runs `chown -R 20211:20211` on all volumes, fixing ownership for the secure `netalertx` user.
> [!TIP]
> If you are facing permissions issues run the following commands on your server. This will change the owner and assure sufficient access to the database and config files that are stored in the `/local_data_dir/db` and `/local_data_dir/config` folders (replace `local_data_dir` with the location where your `/db` and `/config` folders are located).
>
> `sudo chown -R 20211:20211 /local_data_dir`
>
> `sudo chmod -R a+rwx /local_data_dir`
>
--- ---
## Example: docker-compose.yml with `tmpfs` ## Example: docker-compose.yml with `tmpfs`
```yaml ```yaml
services: services:
netalertx: netalertx:
container_name: netalertx container_name: netalertx
image: "ghcr.io/jokob-sk/netalertx" image: "ghcr.io/jokob-sk/netalertx"
network_mode: "host" network_mode: "host"
cap_add: cap_drop: # Drop all capabilities for enhanced security
- NET_RAW - ALL
- NET_ADMIN cap_add: # Add only the necessary capabilities
- NET_BIND_SERVICE - NET_ADMIN # Required for ARP scanning
- NET_RAW # Required for raw socket operations
- NET_BIND_SERVICE # Required to bind to privileged ports (nbtscan)
restart: unless-stopped restart: unless-stopped
volumes: volumes:
- local/path/config:/data/config - /local_data_dir:/data
- local/path/db:/data/db - /etc/localtime:/etc/localtime
environment: environment:
- TZ=Europe/Berlin
- PORT=20211 - PORT=20211
tmpfs: tmpfs:
- "/tmp:uid=20211,gid=20211,mode=1700,rw,noexec,nosuid,nodev,async,noatime,nodiratime" - "/tmp:uid=20211,gid=20211,mode=1700,rw,noexec,nosuid,nodev,async,noatime,nodiratime"

View File

@@ -1,4 +1,4 @@
# NetAlertX Community Helper Scripts Overview # Community Helper Scripts Overview
This page provides an overview of community-contributed scripts for NetAlertX. These scripts are not actively maintained and are provided as-is. This page provides an overview of community-contributed scripts for NetAlertX. These scripts are not actively maintained and are provided as-is.
@@ -14,8 +14,8 @@ You can find all scripts in this [scripts GitHub folder](https://github.com/joko
## Important Notes ## Important Notes
> [!NOTE] > [!NOTE]
> These scripts are community-supplied and not actively maintained. Use at your own discretion. > These scripts are community-supplied and not actively maintained. Use at your own discretion.
For detailed usage instructions, refer to each script's documentation in each [scripts GitHub folder](https://github.com/jokob-sk/NetAlertX/tree/main/scripts). For detailed usage instructions, refer to each script's documentation in each [scripts GitHub folder](https://github.com/jokob-sk/NetAlertX/tree/main/scripts).

View File

@@ -5,7 +5,7 @@ To download and install NetAlertX on the hardware/server directly use the `curl`
> [!NOTE] > [!NOTE]
> This is an Experimental feature 🧪 and it relies on community support. > This is an Experimental feature 🧪 and it relies on community support.
> >
> 🙏 Looking for maintainers for this installation method 🙂 Current community volunteers: > 🙏 Looking for maintainers for this installation method 🙂 Current community volunteers:
> - [slammingprogramming](https://github.com/slammingprogramming) > - [slammingprogramming](https://github.com/slammingprogramming)
> - [ingoratsdorf](https://github.com/ingoratsdorf) > - [ingoratsdorf](https://github.com/ingoratsdorf)
> >
@@ -13,8 +13,7 @@ To download and install NetAlertX on the hardware/server directly use the `curl`
> Data loss is a possibility, **it is recommended to install NetAlertX using the supplied Docker image**. > Data loss is a possibility, **it is recommended to install NetAlertX using the supplied Docker image**.
> [!WARNING] > [!WARNING]
> A warning to the installation method below: Piping to bash is [controversial](https://pi-hole.net/2016/07/25/curling-and-piping-to-bash) and may > A warning to the installation method below: Piping to bash is [controversial](https://pi-hole.net/2016/07/25/curling-and-piping-to-bash) and may be dangerous, as you cannot see the code that's about to be executed on your system.
be dangerous, as you cannot see the code that's about to be executed on your system.
If you trust this repo, you can download the install script via one of the methods (curl/wget) below and it will fo its best to install NetAlertX on your system. If you trust this repo, you can download the install script via one of the methods (curl/wget) below and it will fo its best to install NetAlertX on your system.
@@ -40,7 +39,7 @@ Some facts about what and where something will be changed/installed by the HW in
- Only tested to work on the system listed in the install directory. - Only tested to work on the system listed in the install directory.
- **EXPERIMENTAL** and not recommended way to install NetAlertX. - **EXPERIMENTAL** and not recommended way to install NetAlertX.
> [!TIP] > [!TIP]
> If the below fails try grabbing and installing one of the [previous releases](https://github.com/jokob-sk/NetAlertX/releases) and run the installation from the zip package. > If the below fails try grabbing and installing one of the [previous releases](https://github.com/jokob-sk/NetAlertX/releases) and run the installation from the zip package.
These commands will download the `install.debian12.sh` script from the GitHub repository, make it executable with `chmod`, and then run it using `./install.debian12.sh`. These commands will download the `install.debian12.sh` script from the GitHub repository, make it executable with `chmod`, and then run it using `./install.debian12.sh`.
@@ -81,7 +80,7 @@ wget https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/install/ubuntu24/
> [!NOTE] > [!NOTE]
> Use this on a clean LXC/VM for Debian 13 OR Ubuntu 24. > Use this on a clean LXC/VM for Debian 13 OR Ubuntu 24.
> The Scipt will detect OS and build acordingly. > The Scipt will detect OS and build acordingly.
> Maintained by [JVKeller](https://github.com/JVKeller) > Maintained by [JVKeller](https://github.com/JVKeller)
### Installation via wget ### Installation via wget

View File

@@ -1,10 +1,4 @@
# Migration # Migration
> [!WARNING]
> ⚠️ **Important:** The documentation has been recently updated and some instructions may have changed.
> If you are using the currently live production image, please follow the instructions on [Docker Hub](https://hub.docker.com/r/jokobsk/netalertx) for building and running the container.
> These docs reflect the latest development version and may differ from the production image.
When upgrading from older versions of NetAlertX (or PiAlert by jokob-sk), follow the migration steps below to ensure your data and configuration are properly transferred. When upgrading from older versions of NetAlertX (or PiAlert by jokob-sk), follow the migration steps below to ensure your data and configuration are properly transferred.
@@ -13,13 +7,13 @@ When upgrading from older versions of NetAlertX (or PiAlert by jokob-sk), follow
## Migration scenarios ## Migration scenarios
- You are running PiAlert (by jokob-sk) - You are running PiAlert (by jokob-sk)
→ [Read the 1.1 Migration from PiAlert to NetAlertX `v25.5.24`](#11-migration-from-pialert-to-netalertx-v25524) → [Read the 1.1 Migration from PiAlert to NetAlertX `v25.5.24`](#11-migration-from-pialert-to-netalertx-v25524)
- You are running NetAlertX (by jokob-sk) `25.5.24` or older - You are running NetAlertX (by jokob-sk) `25.5.24` or older
→ [Read the 1.2 Migration from NetAlertX `v25.5.24`](#12-migration-from-netalertx-v25524) → [Read the 1.2 Migration from NetAlertX `v25.5.24`](#12-migration-from-netalertx-v25524)
- You are running NetAlertX (by jokob-sk) (`v25.6.7` to `v25.10.1`) - You are running NetAlertX (by jokob-sk) (`v25.6.7` to `v25.10.1`)
→ [Read the 1.3 Migration from NetAlertX `v25.10.1`](#13-migration-from-netalertx-v25101) → [Read the 1.3 Migration from NetAlertX `v25.10.1`](#13-migration-from-netalertx-v25101)
@@ -30,40 +24,40 @@ You can migrate data manually, for example by exporting and importing devices us
### 1.1 Migration from PiAlert to NetAlertX `v25.5.24` ### 1.1 Migration from PiAlert to NetAlertX `v25.5.24`
#### STEPS: #### STEPS:
The application will automatically migrate the database, configuration, and all device information. The application will automatically migrate the database, configuration, and all device information.
A banner message will appear at the top of the web UI reminding you to update your Docker mount points. A banner message will appear at the top of the web UI reminding you to update your Docker mount points.
1. Stop the container 1. Stop the container
2. [Back up your setup](./BACKUPS.md) 2. [Back up your setup](./BACKUPS.md)
3. Update the Docker file mount locations in your `docker-compose.yml` or docker run command (See below **New Docker mount locations**). 3. Update the Docker file mount locations in your `docker-compose.yml` or docker run command (See below **New Docker mount locations**).
4. Rename the DB and conf files to `app.db` and `app.conf` and place them in the appropriate location. 4. Rename the DB and conf files to `app.db` and `app.conf` and place them in the appropriate location.
5. Start the container 5. Start the container
> [!TIP] > [!TIP]
> If you have trouble accessing past backups, config or database files you can copy them into the newly mapped directories, for example by running this command in the container: `cp -r /data/config /home/pi/pialert/config/old_backup_files`. This should create a folder in the `config` directory called `old_backup_files` containing all the files in that location. Another approach is to map the old location and the new one at the same time to copy things over. > If you have trouble accessing past backups, config or database files you can copy them into the newly mapped directories, for example by running this command in the container: `cp -r /data/config /home/pi/pialert/config/old_backup_files`. This should create a folder in the `config` directory called `old_backup_files` containing all the files in that location. Another approach is to map the old location and the new one at the same time to copy things over.
#### New Docker mount locations #### New Docker mount locations
The internal application path in the container has changed from `/home/pi/pialert` to `/app`. Update your volume mounts as follows: The internal application path in the container has changed from `/home/pi/pialert` to `/app`. Update your volume mounts as follows:
| Old mount point | New mount point | | Old mount point | New mount point |
|----------------------|---------------| |----------------------|---------------|
| `/home/pi/pialert/config` | `/data/config` | | `/home/pi/pialert/config` | `/data/config` |
| `/home/pi/pialert/db` | `/data/db` | | `/home/pi/pialert/db` | `/data/db` |
If you were mounting files directly, please note the file names have changed: If you were mounting files directly, please note the file names have changed:
| Old file name | New file name | | Old file name | New file name |
|----------------------|---------------| |----------------------|---------------|
| `pialert.conf` | `app.conf` | | `pialert.conf` | `app.conf` |
| `pialert.db` | `app.db` | | `pialert.db` | `app.db` |
> [!NOTE] > [!NOTE]
> The application automatically creates symlinks from the old database and config locations to the new ones, so data loss should not occur. Read the [backup strategies](./BACKUPS.md) guide to backup your setup. > The application automatically creates symlinks from the old database and config locations to the new ones, so data loss should not occur. Read the [backup strategies](./BACKUPS.md) guide to backup your setup.
@@ -80,17 +74,17 @@ services:
pialert: pialert:
container_name: pialert container_name: pialert
# use the below line if you want to test the latest dev image # use the below line if you want to test the latest dev image
# image: "ghcr.io/jokob-sk/netalertx-dev:latest" # image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: "jokobsk/pialert:latest" image: "jokobsk/pialert:latest"
network_mode: "host" network_mode: "host"
restart: unless-stopped restart: unless-stopped
volumes: volumes:
- /local/path/config:/home/pi/pialert/config - /local_data_dir/config:/home/pi/pialert/config
- /local/path/db:/home/pi/pialert/db - /local_data_dir/db:/home/pi/pialert/db
# (optional) useful for debugging if you have issues setting up the container # (optional) useful for debugging if you have issues setting up the container
- /local/path/logs:/home/pi/pialert/front/log - /local_data_dir/logs:/home/pi/pialert/front/log
environment: environment:
- TZ=Europe/Berlin - TZ=Europe/Berlin
- PORT=20211 - PORT=20211
``` ```
@@ -98,26 +92,26 @@ services:
```yaml ```yaml
services: services:
netalertx: # 🆕 This has changed netalertx: # 🆕 This has changed
container_name: netalertx # 🆕 This has changed container_name: netalertx # 🆕 This has changed
image: "ghcr.io/jokob-sk/netalertx:25.5.24" # 🆕 This has changed image: "ghcr.io/jokob-sk/netalertx:25.5.24" # 🆕 This has changed
network_mode: "host" network_mode: "host"
restart: unless-stopped restart: unless-stopped
volumes: volumes:
- /local/path/config:/data/config # 🆕 This has changed - /local_data_dir/config:/data/config # 🆕 This has changed
- /local/path/db:/data/db # 🆕 This has changed - /local_data_dir/db:/data/db # 🆕 This has changed
# (optional) useful for debugging if you have issues setting up the container # (optional) useful for debugging if you have issues setting up the container
- /local/path/logs:/tmp/log # 🆕 This has changed - /local_data_dir/logs:/tmp/log # 🆕 This has changed
environment: environment:
- TZ=Europe/Berlin - TZ=Europe/Berlin
- PORT=20211 - PORT=20211
``` ```
##### Example 2: Mapping files ##### Example 2: Mapping files
> [!NOTE] > [!NOTE]
> The recommendation is to map folders as in Example 1, map files directly only when needed. > The recommendation is to map folders as in Example 1, map files directly only when needed.
###### Old docker-compose.yml ###### Old docker-compose.yml
@@ -126,17 +120,17 @@ services:
pialert: pialert:
container_name: pialert container_name: pialert
# use the below line if you want to test the latest dev image # use the below line if you want to test the latest dev image
# image: "ghcr.io/jokob-sk/netalertx-dev:latest" # image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: "jokobsk/pialert:latest" image: "jokobsk/pialert:latest"
network_mode: "host" network_mode: "host"
restart: unless-stopped restart: unless-stopped
volumes: volumes:
- /local/path/config/pialert.conf:/home/pi/pialert/config/pialert.conf - /local_data_dir/config/pialert.conf:/home/pi/pialert/config/pialert.conf
- /local/path/db/pialert.db:/home/pi/pialert/db/pialert.db - /local_data_dir/db/pialert.db:/home/pi/pialert/db/pialert.db
# (optional) useful for debugging if you have issues setting up the container # (optional) useful for debugging if you have issues setting up the container
- /local/path/logs:/home/pi/pialert/front/log - /local_data_dir/logs:/home/pi/pialert/front/log
environment: environment:
- TZ=Europe/Berlin - TZ=Europe/Berlin
- PORT=20211 - PORT=20211
``` ```
@@ -144,18 +138,18 @@ services:
```yaml ```yaml
services: services:
netalertx: # 🆕 This has changed netalertx: # 🆕 This has changed
container_name: netalertx # 🆕 This has changed container_name: netalertx # 🆕 This has changed
image: "ghcr.io/jokob-sk/netalertx:25.5.24" # 🆕 This has changed image: "ghcr.io/jokob-sk/netalertx:25.5.24" # 🆕 This has changed
network_mode: "host" network_mode: "host"
restart: unless-stopped restart: unless-stopped
volumes: volumes:
- /local/path/config/app.conf:/data/config/app.conf # 🆕 This has changed - /local_data_dir/config/app.conf:/data/config/app.conf # 🆕 This has changed
- /local/path/db/app.db:/data/db/app.db # 🆕 This has changed - /local_data_dir/db/app.db:/data/db/app.db # 🆕 This has changed
# (optional) useful for debugging if you have issues setting up the container # (optional) useful for debugging if you have issues setting up the container
- /local/path/logs:/tmp/log # 🆕 This has changed - /local_data_dir/logs:/tmp/log # 🆕 This has changed
environment: environment:
- TZ=Europe/Berlin - TZ=Europe/Berlin
- PORT=20211 - PORT=20211
``` ```
@@ -164,13 +158,13 @@ services:
Versions before `v25.10.1` require an intermediate migration through `v25.5.24` to ensure database compatibility. Skipping this step may cause compatibility issues due to database schema changes introduced after `v25.5.24`. Versions before `v25.10.1` require an intermediate migration through `v25.5.24` to ensure database compatibility. Skipping this step may cause compatibility issues due to database schema changes introduced after `v25.5.24`.
#### STEPS: #### STEPS:
1. Stop the container 1. Stop the container
2. [Back up your setup](./BACKUPS.md) 2. [Back up your setup](./BACKUPS.md)
3. Upgrade to `v25.5.24` by pinning the release version (See Examples below) 3. Upgrade to `v25.5.24` by pinning the release version (See Examples below)
4. Start the container and verify everything works as expected. 4. Start the container and verify everything works as expected.
5. Stop the container 5. Stop the container
6. Upgrade to `v25.10.1` by pinning the release version (See Examples below) 6. Upgrade to `v25.10.1` by pinning the release version (See Examples below)
7. Start the container and verify everything works as expected. 7. Start the container and verify everything works as expected.
@@ -184,62 +178,62 @@ Examples of docker files with the tagged version.
```yaml ```yaml
services: services:
netalertx: netalertx:
container_name: netalertx container_name: netalertx
image: "ghcr.io/jokob-sk/netalertx:25.5.24" # 🆕 This is important image: "ghcr.io/jokob-sk/netalertx:25.5.24" # 🆕 This is important
network_mode: "host" network_mode: "host"
restart: unless-stopped restart: unless-stopped
volumes: volumes:
- /local/path/config:/data/config - /local_data_dir/config:/data/config
- /local/path/db:/data/db - /local_data_dir/db:/data/db
# (optional) useful for debugging if you have issues setting up the container # (optional) useful for debugging if you have issues setting up the container
- /local/path/logs:/tmp/log - /local_data_dir/logs:/tmp/log
environment: environment:
- TZ=Europe/Berlin - TZ=Europe/Berlin
- PORT=20211 - PORT=20211
``` ```
```yaml ```yaml
services: services:
netalertx: netalertx:
container_name: netalertx container_name: netalertx
image: "ghcr.io/jokob-sk/netalertx:25.10.1" # 🆕 This is important image: "ghcr.io/jokob-sk/netalertx:25.10.1" # 🆕 This is important
network_mode: "host" network_mode: "host"
restart: unless-stopped restart: unless-stopped
volumes: volumes:
- /local/path/config:/data/config - /local_data_dir/config:/data/config
- /local/path/db:/data/db - /local_data_dir/db:/data/db
# (optional) useful for debugging if you have issues setting up the container # (optional) useful for debugging if you have issues setting up the container
- /local/path/logs:/tmp/log - /local_data_dir/logs:/tmp/log
environment: environment:
- TZ=Europe/Berlin - TZ=Europe/Berlin
- PORT=20211 - PORT=20211
``` ```
### 1.3 Migration from NetAlertX `v25.10.1` ### 1.3 Migration from NetAlertX `v25.10.1`
Starting from v25.10.1, the container uses a [more secure, read-only runtime environment](./SECURITY_FEATURES.md), which requires all writable paths (e.g., logs, API cache, temporary data) to be mounted as `tmpfs` or permanent writable volumes, with sufficient access [permissions](./FILE_PERMISSIONS.md). Starting from v25.10.1, the container uses a [more secure, read-only runtime environment](./SECURITY_FEATURES.md), which requires all writable paths (e.g., logs, API cache, temporary data) to be mounted as `tmpfs` or permanent writable volumes, with sufficient access [permissions](./FILE_PERMISSIONS.md). The data location has also hanged from `/app/db` and `/app/config` to `/data/db` and `/data/config`. See detailed steps below.
#### STEPS: #### STEPS:
1. Stop the container 1. Stop the container
2. [Back up your setup](./BACKUPS.md) 2. [Back up your setup](./BACKUPS.md)
3. Upgrade to `v25.10.1` by pinning the release version (See the example below) 3. Upgrade to `v25.10.1` by pinning the release version (See the example below)
```yaml ```yaml
services: services:
netalertx: netalertx:
container_name: netalertx container_name: netalertx
image: "ghcr.io/jokob-sk/netalertx:25.10.1" # 🆕 This is important image: "ghcr.io/jokob-sk/netalertx:25.10.1" # 🆕 This is important
network_mode: "host" network_mode: "host"
restart: unless-stopped restart: unless-stopped
volumes: volumes:
- /local/path/config:/data/config - /local_data_dir/config:/app/config
- /local/path/db:/data/db - /local_data_dir/db:/app/db
# (optional) useful for debugging if you have issues setting up the container # (optional) useful for debugging if you have issues setting up the container
- /local/path/logs:/tmp/log - /local_data_dir/logs:/tmp/log
environment: environment:
- TZ=Europe/Berlin - TZ=Europe/Berlin
- PORT=20211 - PORT=20211
``` ```
@@ -248,22 +242,22 @@ services:
6. Perform a one-off migration to the latest `netalertx` image and `20211` user: 6. Perform a one-off migration to the latest `netalertx` image and `20211` user:
> [!NOTE] > [!NOTE]
> The example below assumes your `/config` and `/db` folders are stored in `local/path`. > The example below assumes your `/config` and `/db` folders are stored in `local_data_dir`.
> Replace this path with your actual configuration directory. `netalertx` is the container name, which might differ from your setup. > Replace this path with your actual configuration directory. `netalertx` is the container name, which might differ from your setup.
```sh ```sh
docker run -it --rm --name netalertx --user "0" \ docker run -it --rm --name netalertx --user "0" \
-v /local/path/config:/data/config \ -v /local_data_dir/config:/data/config \
-v /local/path/db:/data/db \ -v /local_data_dir/db:/data/db \
--tmpfs /tmp:uid=20211,gid=20211,mode=1700 \
ghcr.io/jokob-sk/netalertx:latest ghcr.io/jokob-sk/netalertx:latest
``` ```
..or alternatively execute: ...or alternatively execute:
```bash ```bash
sudo chown -R 20211:20211 /local/path/config sudo chown -R 20211:20211 /local_data_dir
sudo chown -R 20211:20211 /local/path/db sudo chmod -R a+rwx /local_data_dir
sudo chmod -R a+rwx /local/path/
``` ```
7. Stop the container 7. Stop the container
@@ -271,22 +265,22 @@ sudo chmod -R a+rwx /local/path/
```yaml ```yaml
services: services:
netalertx: netalertx:
container_name: netalertx container_name: netalertx
image: "ghcr.io/jokob-sk/netalertx" # 🆕 This is important image: "ghcr.io/jokob-sk/netalertx" # 🆕 This has changed
network_mode: "host" network_mode: "host"
cap_add: # 🆕 New line cap_drop: # 🆕 New line
- NET_RAW # 🆕 New line - ALL # 🆕 New line
- NET_ADMIN # 🆕 New line cap_add: # 🆕 New line
- NET_BIND_SERVICE # 🆕 New line - NET_RAW # 🆕 New line
- NET_ADMIN # 🆕 New line
- NET_BIND_SERVICE # 🆕 New line
restart: unless-stopped restart: unless-stopped
volumes: volumes:
- /local/path/config:/data/config - /local_data_dir:/data # 🆕 This folder contains your /db and /config directories and the parent changed from /app to /data
- /local/path/db:/data/db # Ensuring the timezone is the same as on the server - make sure also the TIMEZONE setting is configured
# (optional) useful for debugging if you have issues setting up the container - /etc/localtime:/etc/localtime:ro # 🆕 New line
#- /local/path/logs:/tmp/log
environment: environment:
- TZ=Europe/Berlin
- PORT=20211 - PORT=20211
# 🆕 New "tmpfs" section START 🔽 # 🆕 New "tmpfs" section START 🔽
tmpfs: tmpfs:

View File

@@ -1,6 +1,6 @@
## How to Set Up Your Network Page ## How to Set Up Your Network Page
The **Network** page lets you map how devices connect — visually and logically. The **Network** page lets you map how devices connect — visually and logically.
Its especially useful for planning infrastructure, assigning parent-child relationships, and spotting gaps. Its especially useful for planning infrastructure, assigning parent-child relationships, and spotting gaps.
![Network tree details](./img/NETWORK_TREE/Network_Sample.png) ![Network tree details](./img/NETWORK_TREE/Network_Sample.png)
@@ -9,11 +9,11 @@ To get started, youll need to define at least one root node and mark certain
--- ---
Start by creating a root device with the MAC address `Internet`, if the application didnt create one already. Start by creating a root device with the MAC address `Internet`, if the application didnt create one already.
This special MAC address (`Internet`) is required for the root network node — no other value is currently supported. This special MAC address (`Internet`) is required for the root network node — no other value is currently supported.
Set its **Type** to a valid network type — such as `Router` or `Gateway`. Set its **Type** to a valid network type — such as `Router` or `Gateway`.
> [!TIP] > [!TIP]
> If you dont have one, use the [Create new device](./DEVICE_MANAGEMENT.md#dummy-devices) button on the **Devices** page to add a root device. > If you dont have one, use the [Create new device](./DEVICE_MANAGEMENT.md#dummy-devices) button on the **Devices** page to add a root device.
--- ---
@@ -21,15 +21,15 @@ Set its **Type** to a valid network type — such as `Router` or `Gateway`.
## ⚡ Quick Setup ## ⚡ Quick Setup
1. Open the device you want to use as a network node (e.g. a Switch). 1. Open the device you want to use as a network node (e.g. a Switch).
2. Set its **Type** to one of the following: 2. Set its **Type** to one of the following:
`AP`, `Firewall`, `Gateway`, `PLC`, `Powerline`, `Router`, `Switch`, `USB LAN Adapter`, `USB WIFI Adapter`, `WLAN` `AP`, `Firewall`, `Gateway`, `PLC`, `Powerline`, `Router`, `Switch`, `USB LAN Adapter`, `USB WIFI Adapter`, `WLAN`
*(Or add custom types under **Settings → General → `NETWORK_DEVICE_TYPES`**.)* *(Or add custom types under **Settings → General → `NETWORK_DEVICE_TYPES`**.)*
3. Save the device. 3. Save the device.
4. Go to the **Network** page — supported device types will appear as tabs. 4. Go to the **Network** page — supported device types will appear as tabs.
5. Use the **Assign** button to connect unassigned devices to a network node. 5. Use the **Assign** button to connect unassigned devices to a network node.
6. If the **Port** is `0` or empty, a Wi-Fi icon is shown. Otherwise, an Ethernet icon appears. 6. If the **Port** is `0` or empty, a Wi-Fi icon is shown. Otherwise, an Ethernet icon appears.
> [!NOTE] > [!NOTE]
> Use [bulk editing](./DEVICES_BULK_EDITING.md) with _CSV Export_ to fix `Internet` root assignments or update many devices at once. > Use [bulk editing](./DEVICES_BULK_EDITING.md) with _CSV Export_ to fix `Internet` root assignments or update many devices at once.
--- ---
@@ -42,20 +42,22 @@ Lets walk through setting up a device named `raspberrypi` to act as a network
### 1. Set Device Type and Parent ### 1. Set Device Type and Parent
- Go to the **Devices** page - Go to the **Devices** page
- Open the device detail view for `raspberrypi` - Open the device detail view for `raspberrypi`
- In the **Type** dropdown, select `Switch` - In the **Type** dropdown, select `Switch`
![Device details](./img/NETWORK_TREE/Network_Device_Details.png) ![Device details](./img/NETWORK_TREE/Network_Device_Details.png)
- Optionally assign a **Parent Node** (where this device connects to) and the **Relationship type** of the connection. - Optionally assign a **Parent Node** (where this device connects to) and the **Relationship type** of the connection.
The `nic` relationship type can affect parent notifications — see the setting description and [Notifications documentation](./NOTIFICATIONS.md) for more. The `nic` relationship type can affect parent notifications — see the setting description and [Notifications documentation](./NOTIFICATIONS.md) for more.
- A devices parent MAC will be overwritten by plugins if its current value is any of the following: "null", "(unknown)" "(Unknown)".
- If you want plugins to be able to overwrite the parent value (for example, when mixing plugins that do not provide parent MACs like `ARPSCAN` with those that do, like `UNIFIAPI`), you must set the setting `NEWDEV_devParentMAC` to None.
![Device details](./img/NETWORK_TREE/Network_Device_Details_Parent.png) ![Device details](./img/NETWORK_TREE/Network_Device_Details_Parent.png)
> [!NOTE] > [!NOTE]
> Only certain device types can act as network nodes: > Only certain device types can act as network nodes:
> `AP`, `Firewall`, `Gateway`, `Hypervisor`, `PLC`, `Powerline`, `Router`, `Switch`, `USB LAN Adapter`, `USB WIFI Adapter`, `WLAN` > `AP`, `Firewall`, `Gateway`, `Hypervisor`, `PLC`, `Powerline`, `Router`, `Switch`, `USB LAN Adapter`, `USB WIFI Adapter`, `WLAN`
> You can add custom types via the `NETWORK_DEVICE_TYPES` setting. > You can add custom types via the `NETWORK_DEVICE_TYPES` setting.
- Click **Save** - Click **Save**
@@ -81,7 +83,7 @@ You can confirm that `raspberrypi` now acts as a network device in two places:
### 3. Assign Connected Devices ### 3. Assign Connected Devices
- Use the **Assign** button to link other devices (e.g. PCs) to `raspberrypi`. - Use the **Assign** button to link other devices (e.g. PCs) to `raspberrypi`.
- After assigning, connected devices will appear beneath the `raspberrypi` switch node. - After assigning, connected devices will appear beneath the `raspberrypi` switch node.
![Assigned nodes](./img/NETWORK_TREE/Network_Assigned_Nodes.png) ![Assigned nodes](./img/NETWORK_TREE/Network_Assigned_Nodes.png)
@@ -92,9 +94,9 @@ You can confirm that `raspberrypi` now acts as a network device in two places:
> Hovering over devices in the tree reveals connection details and tooltips for quick inspection. > Hovering over devices in the tree reveals connection details and tooltips for quick inspection.
> [!NOTE] > [!NOTE]
> Selecting certain relationship types hides the device in the default device views. > Selecting certain relationship types hides the device in the default device views.
> You can change this behavior by adjusting the `UI_hide_rel_types` setting, which by default is set to `["nic","virtual"]`. > You can change this behavior by adjusting the `UI_hide_rel_types` setting, which by default is set to `["nic","virtual"]`.
> This means devices with `devParentRelType` set to `nic` or `virtual` will not be shown. > This means devices with `devParentRelType` set to `nic` or `virtual` will not be shown.
> All devices, regardless of relationship type, are always accessible in the **All devices** view. > All devices, regardless of relationship type, are always accessible in the **All devices** view.
--- ---

View File

@@ -1,47 +1,50 @@
# Performance Optimization Guide # Performance Optimization Guide
There are several ways to improve the application's performance. The application has been tested on a range of devices, from a Raspberry Pi 4 to NAS and NUC systems. If you are running the application on a lower-end device, carefully fine-tune the performance settings to ensure an optimal user experience. There are several ways to improve the application's performance. The application has been tested on a range of devices, from Raspberry Pi 4 units to NAS and NUC systems. If you are running the application on a lower-end device, fine-tuning the performance settings can significantly improve the user experience.
## Common Causes of Slowness ## Common Causes of Slowness
Performance issues are usually caused by: Performance issues are usually caused by:
- **Incorrect settings** The app may restart unexpectedly. Check `app.log` under **Maintenance → Logs** for details. * **Incorrect settings** The app may restart unexpectedly. Check `app.log` under **Maintenance → Logs** for details.
- **Too many background processes** Disable unnecessary scanners. * **Too many background processes** Disable unnecessary scanners.
- **Long scan durations** Limit the number of scanned devices. * **Long scan durations** Limit the number of scanned devices.
- **Excessive disk operations** Optimize scanning and logging settings. * **Excessive disk operations** Optimize scanning and logging settings.
- **Failed maintenance plugins** Ensure maintenance tasks are running properly. * **Maintenance plugin failures** If cleanup tasks fail, performance can degrade over time.
The application performs regular maintenance and database cleanup. If these tasks fail, performance may degrade. The application performs regular maintenance and database cleanup. If these tasks are failing, you will see slowdowns.
### Database and Log File Size ### Database and Log File Size
A large database or oversized log files can slow down performance. You can check database and table sizes on the **Maintenance** page. A large database or oversized log files can impact performance. You can check database and table sizes on the **Maintenance** page.
![DB size check](./img/PERFORMANCE/db_size_check.png) ![DB size check](./img/PERFORMANCE/db_size_check.png)
> [!NOTE] > [!NOTE]
> - For **~100 devices**, the database should be around **50MB**. >
> - No table should exceed **10,000 rows** in a healthy system. > * For **~100 devices**, the database should be around **50 MB**.
> - These numbers vary based on network activity and settings. > * No table should exceed **10,000 rows** in a healthy system.
> * Actual values vary based on network activity and plugin settings.
--- ---
## Maintenance Plugins ## Maintenance Plugins
Two plugins help maintain the applications performance: Two plugins help maintain the systems performance:
### **1. Database Cleanup (DBCLNP)** ### **1. Database Cleanup (DBCLNP)**
- Responsible for database maintenance.
- Check settings in the [DB Cleanup Plugin Docs](/front/plugins/db_cleanup/README.md). * Handles database maintenance and cleanup.
- Ensure its not failing by checking logs. * See the [DB Cleanup Plugin Docs](/front/plugins/db_cleanup/README.md).
- Adjust the schedule (`DBCLNP_RUN_SCHD`) and timeout (`DBCLNP_RUN_TIMEOUT`) if needed. * Ensure its not failing by checking logs.
* Adjust the schedule (`DBCLNP_RUN_SCHD`) and timeout (`DBCLNP_RUN_TIMEOUT`) if necessary.
### **2. Maintenance (MAINT)** ### **2. Maintenance (MAINT)**
- Handles log cleanup and other maintenance tasks.
- Check settings in the [Maintenance Plugin Docs](/front/plugins/maintenance/README.md). * Cleans logs and performs general maintenance tasks.
- Ensure its running correctly by checking logs. * See the [Maintenance Plugin Docs](/front/plugins/maintenance/README.md).
- Adjust the schedule (`MAINT_RUN_SCHD`) and timeout (`MAINT_RUN_TIMEOUT`) if needed. * Verify proper operation via logs.
* Adjust the schedule (`MAINT_RUN_SCHD`) and timeout (`MAINT_RUN_TIMEOUT`) if needed.
--- ---
@@ -50,47 +53,56 @@ Two plugins help maintain the applications performance:
Frequent scans increase resource usage, network traffic, and database read/write cycles. Frequent scans increase resource usage, network traffic, and database read/write cycles.
### **Optimizations** ### **Optimizations**
- **Increase scan intervals** (`<PLUGIN>_RUN_SCHD`) on busy networks or low-end hardware.
- **Extend scan timeouts** (`<PLUGIN>_RUN_TIMEOUT`) to prevent failures.
- **Reduce the subnet size** e.g., from `/16` to `/24` to lower scan loads.
Some plugins have additional options to limit the number of scanned devices. If certain plugins take too long to complete, check if you can optimize scan times by selecting a scan range. * **Increase scan intervals** (`<PLUGIN>_RUN_SCHD`) on busy networks or low-end hardware.
* **Increase timeouts** (`<PLUGIN>_RUN_TIMEOUT`) to avoid plugin failures.
* **Reduce subnet size** e.g., use `/24` instead of `/16` to reduce scan load.
For example, the **ICMP plugin** allows you to specify a regular expression to scan only IPs that match a specific pattern. Some plugins also include options to limit which devices are scanned. If certain plugins consistently run long, consider narrowing their scope.
For example, the **ICMP plugin** allows scanning only IPs that match a specific regular expression.
--- ---
## Storing Temporary Files in Memory ## Storing Temporary Files in Memory
On systems with slower I/O speeds, you can optimize performance by storing temporary files in memory. This primarily applies to the API directory (default: `/tmp/api`, configurable via `NETALERTX_API`) and `/tmp/log` folders. On devices with slower I/O, you can improve performance by storing temporary files (and optionally the database) in memory using `tmpfs`.
Using `tmpfs` reduces disk writes and improves performance. However, it should be **disabled** if persistent logs or API data storage are required. > [!WARNING]
> Storing the **database** in `tmpfs` is generally discouraged. Use this only if device data and historical records are not required to persist. If needed, you can pair this setup with the `SYNC` plugin to store important persistent data on another node. See the [Plugins docs](./PLUGINS.md) for details.
Below is an optimized `docker-compose.yml` snippet: Using `tmpfs` reduces disk writes and speeds up I/O, but **all data stored in memory will be lost on restart**.
Below is an optimized `docker-compose.yml` snippet using non-persistent logs, API data, and DB:
```yaml ```yaml
version: "3"
services: services:
netalertx: netalertx:
container_name: netalertx container_name: netalertx
# Uncomment the line below to test the latest dev image # Use this line for the stable release
image: "ghcr.io/jokob-sk/netalertx:latest"
# Or use this line for the latest development build
# image: "ghcr.io/jokob-sk/netalertx-dev:latest" # image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: "ghcr.io/jokob-sk/netalertx:latest" network_mode: "host"
network_mode: "host"
restart: unless-stopped restart: unless-stopped
volumes:
- local/path/config:/data/config
- local/path/db:/data/db
# (Optional) Useful for debugging setup issues
- local/path/logs:/tmp/log
# (API: OPTION 1) Store temporary files in memory (recommended for performance)
- type: tmpfs # ◀ 🔺
target: /tmp/api # ◀ 🔺
# (API: OPTION 2) Store API data on disk (useful for debugging)
# - local/path/api:/tmp/api
environment:
- TZ=Europe/Berlin
- PORT=20211
cap_drop: # Drop all capabilities for enhanced security
- ALL
cap_add: # Re-add necessary capabilities
- NET_RAW
- NET_ADMIN
- NET_BIND_SERVICE
volumes:
- ${APP_FOLDER}/netalertx/config:/data/config
- /etc/localtime:/etc/localtime:ro
tmpfs:
# All writable runtime state resides under /tmp; comment out to persist logs between restarts
- "/tmp:uid=20211,gid=20211,mode=1700,rw,noexec,nosuid,nodev,async,noatime,nodiratime"
- "/data/db:uid=20211,gid=20211,mode=1700" # ⚠ You will lose historical data on restart
environment:
- PORT=${PORT}
- APP_CONF_OVERRIDE=${APP_CONF_OVERRIDE}
``` ```

View File

@@ -64,6 +64,7 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T
| `LUCIRPC` | [luci_import](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/luci_import/) | 🔍 | Import connected devices from OpenWRT | | | | `LUCIRPC` | [luci_import](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/luci_import/) | 🔍 | Import connected devices from OpenWRT | | |
| `MAINT` | [maintenance](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/maintenance/) | ⚙ | Maintenance of logs, etc. | | | | `MAINT` | [maintenance](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/maintenance/) | ⚙ | Maintenance of logs, etc. | | |
| `MQTT` | [_publisher_mqtt](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/_publisher_mqtt/) | ▶️ | MQTT for synching to Home Assistant | | | | `MQTT` | [_publisher_mqtt](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/_publisher_mqtt/) | ▶️ | MQTT for synching to Home Assistant | | |
| `MTSCAN` | [mikrotik_scan](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/mikrotik_scan/) | 🔍 | Mikrotik device import & sync | | |
| `NBTSCAN` | [nbtscan_scan](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/nbtscan_scan/) | 🆎 | Nbtscan (NetBIOS-based) name resolution | | | | `NBTSCAN` | [nbtscan_scan](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/nbtscan_scan/) | 🆎 | Nbtscan (NetBIOS-based) name resolution | | |
| `NEWDEV` | [newdev_template](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/newdev_template/) | ⚙ | New device template | | Yes | | `NEWDEV` | [newdev_template](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/newdev_template/) | ⚙ | New device template | | Yes |
| `NMAP` | [nmap_scan](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/nmap_scan/) | ♻ | Nmap port scanning & discovery | | | | `NMAP` | [nmap_scan](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/nmap_scan/) | ♻ | Nmap port scanning & discovery | | |
@@ -74,6 +75,7 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T
| `OMDSDN` | [omada_sdn_imp](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/omada_sdn_imp/) | 📥/🆎 ❌ | UNMAINTAINED use `OMDSDNOPENAPI` | 🖧 🔄 | | | `OMDSDN` | [omada_sdn_imp](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/omada_sdn_imp/) | 📥/🆎 ❌ | UNMAINTAINED use `OMDSDNOPENAPI` | 🖧 🔄 | |
| `OMDSDNOPENAPI` | [omada_sdn_openapi](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/omada_sdn_openapi/) | 📥/🆎 | OMADA TP-Link import via OpenAPI | 🖧 | | | `OMDSDNOPENAPI` | [omada_sdn_openapi](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/omada_sdn_openapi/) | 📥/🆎 | OMADA TP-Link import via OpenAPI | 🖧 | |
| `PIHOLE` | [pihole_scan](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/pihole_scan/) | 🔍/🆎/📥 | Pi-hole device import & sync | | | | `PIHOLE` | [pihole_scan](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/pihole_scan/) | 🔍/🆎/📥 | Pi-hole device import & sync | | |
| `PIHOLEAPI` | [pihole_api_scan](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/pihole_api_scan/) | 🔍/🆎/📥 | Pi-hole device import & sync via API v6+ | | |
| `PUSHSAFER` | [_publisher_pushsafer](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/_publisher_pushsafer/) | ▶️ | Pushsafer notifications | | | | `PUSHSAFER` | [_publisher_pushsafer](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/_publisher_pushsafer/) | ▶️ | Pushsafer notifications | | |
| `PUSHOVER` | [_publisher_pushover](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/_publisher_pushover/) | ▶️ | Pushover notifications | | | | `PUSHOVER` | [_publisher_pushover](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/_publisher_pushover/) | ▶️ | Pushover notifications | | |
| `SETPWD` | [set_password](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/set_password/) | ⚙ | Set password | | Yes | | `SETPWD` | [set_password](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/set_password/) | ⚙ | Set password | | Yes |

View File

@@ -13,13 +13,13 @@ There is also an in-app Help / FAQ section that should be answering frequently a
#### 🐳 Docker (Fully supported) #### 🐳 Docker (Fully supported)
- The main installation method is as a [docker container - follow these instructions here](./DOCKER_INSTALLATION.md). - The main installation method is as a [docker container - follow these instructions here](./DOCKER_INSTALLATION.md).
#### 💻 Bare-metal / On-server (Experimental/community supported 🧪) #### 💻 Bare-metal / On-server (Experimental/community supported 🧪)
- [(Experimental 🧪) On-hardware instructions](./HW_INSTALL.md) - [(Experimental 🧪) On-hardware instructions](./HW_INSTALL.md)
- Alternative bare-metal install forks: - Alternative bare-metal install forks:
- [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) (maintained) - [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) (maintained)
- [pucherot's original code](https://github.com/pucherot/Pi.Alert/) (un-maintained) - [pucherot's original code](https://github.com/pucherot/Pi.Alert/) (un-maintained)
@@ -63,7 +63,6 @@ There is also an in-app Help / FAQ section that should be answering frequently a
#### ♻ Misc #### ♻ Misc
- [Version history (legacy)](./VERSIONS_HISTORY.md)
- [Reverse proxy (Nginx, Apache, SWAG)](./REVERSE_PROXY.md) - [Reverse proxy (Nginx, Apache, SWAG)](./REVERSE_PROXY.md)
- [Installing Updates](./UPDATES.md) - [Installing Updates](./UPDATES.md)
- [Setting up Authelia](./AUTHELIA.md) (DRAFT) - [Setting up Authelia](./AUTHELIA.md) (DRAFT)
@@ -80,27 +79,27 @@ There is also an in-app Help / FAQ section that should be answering frequently a
- [Frontend development tips](./FRONTEND_DEVELOPMENT.md) - [Frontend development tips](./FRONTEND_DEVELOPMENT.md)
- [Webhook secrets](./WEBHOOK_SECRET.md) - [Webhook secrets](./WEBHOOK_SECRET.md)
Feel free to suggest or submit new docs via a PR. Feel free to suggest or submit new docs via a PR.
## 👨‍💻 Development priorities ## 👨‍💻 Development priorities
Priorities from highest to lowest: Priorities from highest to lowest:
* 🔼 Fixing core functionality bugs not solvable with workarounds * 🔼 Fixing core functionality bugs not solvable with workarounds
* 🔵 New core functionality unlocking other opportunities (e.g.: plugins) * 🔵 New core functionality unlocking other opportunities (e.g.: plugins)
* 🔵 Refactoring enabling faster implementation of future functionality * 🔵 Refactoring enabling faster implementation of future functionality
* 🔽 (low) UI functionality & improvements (PRs welcome 😉) * 🔽 (low) UI functionality & improvements (PRs welcome 😉)
Design philosophy: Focus on core functionality and leverage existing apps and tools to make NetAlertX integrate into other workflows. Design philosophy: Focus on core functionality and leverage existing apps and tools to make NetAlertX integrate into other workflows.
Examples: Examples:
1. Supporting apprise makes more sense than implementing multiple individual notification gateways 1. Supporting apprise makes more sense than implementing multiple individual notification gateways
2. Implementing regular expression support across settings for validation makes more sense than validating one setting with a specific expression. 2. Implementing regular expression support across settings for validation makes more sense than validating one setting with a specific expression.
UI-specific requests are a low priority as the framework picked by the original developer is not very extensible (and afaik doesn't support components) and has limited mobile support. Also, I argue the value proposition is smaller than working on something else. UI-specific requests are a low priority as the framework picked by the original developer is not very extensible (and afaik doesn't support components) and has limited mobile support. Also, I argue the value proposition is smaller than working on something else.
Feel free to submit PRs if interested. try to **keep the PRs small/on-topic** so they are easier to review and approve. Feel free to submit PRs if interested. try to **keep the PRs small/on-topic** so they are easier to review and approve.
That being said, I'd reconsider if more people and or recurring sponsors file a request 😉. That being said, I'd reconsider if more people and or recurring sponsors file a request 😉.
@@ -112,8 +111,8 @@ Please be as detailed as possible with **workarounds** you considered and why a
If you submit a PR please: If you submit a PR please:
1. Check that your changes are backward compatible with existing installations and with a blank setup. 1. Check that your changes are backward compatible with existing installations and with a blank setup.
2. Existing features should always be preserved. 2. Existing features should always be preserved.
3. Keep the PR small, on-topic and don't change code that is not necessary for the PR to work 3. Keep the PR small, on-topic and don't change code that is not necessary for the PR to work
4. New features code should ideally be re-usable for different purposes, not for a very narrow use case. 4. New features code should ideally be re-usable for different purposes, not for a very narrow use case.
5. New functionality should ideally be implemented via the Plugins system, if possible. 5. New functionality should ideally be implemented via the Plugins system, if possible.
@@ -131,13 +130,13 @@ Suggested test cases:
Some additional context: Some additional context:
* Permanent settings/config is stored in the `app.conf` file * Permanent settings/config is stored in the `app.conf` file
* Currently temporary (session?) settings are stored in the `Parameters` DB table as key-value pairs. This table is wiped during a container rebuild/restart and its values are re-initialized from cookies/session data from the browser. * Currently temporary (session?) settings are stored in the `Parameters` DB table as key-value pairs. This table is wiped during a container rebuild/restart and its values are re-initialized from cookies/session data from the browser.
## 🐛 Submitting an issue or bug ## 🐛 Submitting an issue or bug
Before submitting a new issue please spend a couple of minutes on research: Before submitting a new issue please spend a couple of minutes on research:
* Check [🛑 Common issues](./DEBUG_TIPS.md#common-issues) * Check [🛑 Common issues](./DEBUG_TIPS.md#common-issues)
* Check [💡 Closed issues](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed) if a similar issue was solved in the past. * Check [💡 Closed issues](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed) if a similar issue was solved in the past.
* When submitting an issue ❗[enable debug](./DEBUG_TIPS.md)❗ * When submitting an issue ❗[enable debug](./DEBUG_TIPS.md)❗

View File

@@ -2,21 +2,21 @@
If you are running a DNS server, such as **AdGuard**, set up **Private reverse DNS servers** for a better name resolution on your network. Enabling this setting will enable NetAlertX to execute dig and nslookup commands to automatically resolve device names based on their IP addresses. If you are running a DNS server, such as **AdGuard**, set up **Private reverse DNS servers** for a better name resolution on your network. Enabling this setting will enable NetAlertX to execute dig and nslookup commands to automatically resolve device names based on their IP addresses.
> [!TIP] > [!TIP]
> Before proceeding, ensure that [name resolution plugins](./NAME_RESOLUTION.md) are enabled. > Before proceeding, ensure that [name resolution plugins](/local_data_dir/NAME_RESOLUTION.md) are enabled.
> You can customize how names are cleaned using the `NEWDEV_NAME_CLEANUP_REGEX` setting. > You can customize how names are cleaned using the `NEWDEV_NAME_CLEANUP_REGEX` setting.
> To auto-update Fully Qualified Domain Names (FQDN), enable the `REFRESH_FQDN` setting. > To auto-update Fully Qualified Domain Names (FQDN), enable the `REFRESH_FQDN` setting.
> Example 1: Reverse DNS `disabled` > Example 1: Reverse DNS `disabled`
> >
> ``` > ```
> jokob@Synology-NAS:/$ nslookup 192.168.1.58 > jokob@Synology-NAS:/$ nslookup 192.168.1.58
> ** server can't find 58.1.168.192.in-addr.arpa: NXDOMAIN > ** server can't find 58.1.168.192.in-addr.arpa: NXDOMAIN
> ``` > ```
> Example 2: Reverse DNS `enabled` > Example 2: Reverse DNS `enabled`
> >
> ``` > ```
> jokob@Synology-NAS:/$ nslookup 192.168.1.58 > jokob@Synology-NAS:/$ nslookup 192.168.1.58
> 45.1.168.192.in-addr.arpa name = jokob-NUC.localdomain. > 45.1.168.192.in-addr.arpa name = jokob-NUC.localdomain.
@@ -33,22 +33,14 @@ If you are running a DNS server, such as **AdGuard**, set up **Private reverse D
### Specifying the DNS in the container ### Specifying the DNS in the container
You can specify the DNS server in the docker-compose to improve name resolution on your network. You can specify the DNS server in the docker-compose to improve name resolution on your network.
```yaml ```yaml
services: services:
netalertx: netalertx:
container_name: netalertx container_name: netalertx
image: "ghcr.io/jokob-sk/netalertx:latest" image: "ghcr.io/jokob-sk/netalertx:latest"
restart: unless-stopped ...
volumes:
- /home/netalertx/config:/data/config
- /home/netalertx/db:/data/db
- /home/netalertx/log:/tmp/log
environment:
- TZ=Europe/Berlin
- PORT=20211
network_mode: host
dns: # specifying the DNS servers used for the container dns: # specifying the DNS servers used for the container
- 10.8.0.1 - 10.8.0.1
- 10.8.0.17 - 10.8.0.17
@@ -56,7 +48,7 @@ services:
### Using a custom resolv.conf file ### Using a custom resolv.conf file
You can configure a custom **/etc/resolv.conf** file in **docker-compose.yml** and set the nameserver to your LAN DNS server (e.g.: Pi-Hole). See the relevant [resolv.conf man](https://www.man7.org/linux/man-pages/man5/resolv.conf.5.html) entry for details. You can configure a custom **/etc/resolv.conf** file in **docker-compose.yml** and set the nameserver to your LAN DNS server (e.g.: Pi-Hole). See the relevant [resolv.conf man](https://www.man7.org/linux/man-pages/man5/resolv.conf.5.html) entry for details.
#### docker-compose.yml: #### docker-compose.yml:
@@ -65,22 +57,13 @@ version: "3"
services: services:
netalertx: netalertx:
container_name: netalertx container_name: netalertx
image: "ghcr.io/jokob-sk/netalertx:latest"
restart: unless-stopped
volumes: volumes:
- ./config/app.conf:/data/config/app.conf ...
- ./db:/data/db - /local_data_dir/config/resolv.conf:/etc/resolv.conf # ⚠ Mapping the /resolv.conf file for better name resolution
- ./log:/tmp/log ...
- ./config/resolv.conf:/etc/resolv.conf # Mapping the /resolv.conf file for better name resolution
environment:
- TZ=Europe/Berlin
- PORT=20211
ports:
- "20211:20211"
network_mode: host
``` ```
#### ./config/resolv.conf: #### /local_data_dir/config/resolv.conf:
The most important below is the `nameserver` entry (you can add multiple): The most important below is the `nameserver` entry (you can add multiple):

View File

@@ -2,9 +2,9 @@
> Submitted by amazing [cvc90](https://github.com/cvc90) 🙏 > Submitted by amazing [cvc90](https://github.com/cvc90) 🙏
> [!NOTE] > [!NOTE]
> There are various NGINX config files for NetAlertX, some for the bare-metal install, currently Debian 12 and Ubuntu 24 (`netalertx.conf`), and one for the docker container (`netalertx.template.conf`). > There are various NGINX config files for NetAlertX, some for the bare-metal install, currently Debian 12 and Ubuntu 24 (`netalertx.conf`), and one for the docker container (`netalertx.template.conf`).
> >
> The first one you can find in the respective bare metal installer folder `/app/install/\<system\>/netalertx.conf`. > The first one you can find in the respective bare metal installer folder `/app/install/\<system\>/netalertx.conf`.
> The docker one can be found in the [install](https://github.com/jokob-sk/NetAlertX/tree/main/install) folder. Map, or use, the one appropriate for your setup. > The docker one can be found in the [install](https://github.com/jokob-sk/NetAlertX/tree/main/install) folder. Map, or use, the one appropriate for your setup.
@@ -17,14 +17,14 @@
2. In this file, paste the following code: 2. In this file, paste the following code:
``` ```
server { server {
listen 80; listen 80;
server_name netalertx; server_name netalertx;
proxy_preserve_host on; proxy_preserve_host on;
proxy_pass http://localhost:20211/; proxy_pass http://localhost:20211/;
proxy_pass_reverse http://localhost:20211/; proxy_pass_reverse http://localhost:20211/;
} }
``` ```
3. Activate the new website by running the following command: 3. Activate the new website by running the following command:
@@ -43,18 +43,18 @@
2. In this file, paste the following code: 2. In this file, paste the following code:
``` ```
server { server {
listen 80; listen 80;
server_name netalertx; server_name netalertx;
proxy_preserve_host on; proxy_preserve_host on;
location ^~ /netalertx/ { location ^~ /netalertx/ {
proxy_pass http://localhost:20211/; proxy_pass http://localhost:20211/;
proxy_pass_reverse http://localhost:20211/; proxy_pass_reverse http://localhost:20211/;
proxy_redirect ~^/(.*)$ /netalertx/$1; proxy_redirect ~^/(.*)$ /netalertx/$1;
rewrite ^/netalertx/?(.*)$ /$1 break; rewrite ^/netalertx/?(.*)$ /$1 break;
} }
} }
``` ```
3. Check your config with `nginx -t`. If there are any issues, it will tell you. 3. Check your config with `nginx -t`. If there are any issues, it will tell you.
@@ -73,13 +73,13 @@
2. In this file, paste the following code: 2. In this file, paste the following code:
``` ```
server { server {
listen 80; listen 80;
server_name netalertx; server_name netalertx;
proxy_preserve_host on; proxy_preserve_host on;
location ^~ /netalertx/ { location ^~ /netalertx/ {
proxy_pass http://localhost:20211/; proxy_pass http://localhost:20211/;
proxy_pass_reverse http://localhost:20211/; proxy_pass_reverse http://localhost:20211/;
proxy_redirect ~^/(.*)$ /netalertx/$1; proxy_redirect ~^/(.*)$ /netalertx/$1;
rewrite ^/netalertx/?(.*)$ /$1 break; rewrite ^/netalertx/?(.*)$ /$1 break;
sub_filter_once off; sub_filter_once off;
@@ -89,13 +89,13 @@
sub_filter '(?>$host)/js' '/netalertx/js'; sub_filter '(?>$host)/js' '/netalertx/js';
sub_filter '/img' '/netalertx/img'; sub_filter '/img' '/netalertx/img';
sub_filter '/lib' '/netalertx/lib'; sub_filter '/lib' '/netalertx/lib';
sub_filter '/php' '/netalertx/php'; sub_filter '/php' '/netalertx/php';
} }
} }
``` ```
3. Check your config with `nginx -t`. If there are any issues, it will tell you. 3. Check your config with `nginx -t`. If there are any issues, it will tell you.
4. Activate the new website by running the following command: 4. Activate the new website by running the following command:
`nginx -s reload` or `systemctl restart nginx` `nginx -s reload` or `systemctl restart nginx`
@@ -111,17 +111,17 @@
2. In this file, paste the following code: 2. In this file, paste the following code:
``` ```
server { server {
listen 443; listen 443;
server_name netalertx; server_name netalertx;
SSLEngine On; SSLEngine On;
SSLCertificateFile /etc/ssl/certs/netalertx.pem; SSLCertificateFile /etc/ssl/certs/netalertx.pem;
SSLCertificateKeyFile /etc/ssl/private/netalertx.key; SSLCertificateKeyFile /etc/ssl/private/netalertx.key;
proxy_preserve_host on; proxy_preserve_host on;
proxy_pass http://localhost:20211/; proxy_pass http://localhost:20211/;
proxy_pass_reverse http://localhost:20211/; proxy_pass_reverse http://localhost:20211/;
} }
``` ```
3. Check your config with `nginx -t`. If there are any issues, it will tell you. 3. Check your config with `nginx -t`. If there are any issues, it will tell you.
@@ -140,23 +140,23 @@
2. In this file, paste the following code: 2. In this file, paste the following code:
``` ```
server { server {
listen 443; listen 443;
server_name netalertx; server_name netalertx;
SSLEngine On; SSLEngine On;
SSLCertificateFile /etc/ssl/certs/netalertx.pem; SSLCertificateFile /etc/ssl/certs/netalertx.pem;
SSLCertificateKeyFile /etc/ssl/private/netalertx.key; SSLCertificateKeyFile /etc/ssl/private/netalertx.key;
location ^~ /netalertx/ { location ^~ /netalertx/ {
proxy_pass http://localhost:20211/; proxy_pass http://localhost:20211/;
proxy_pass_reverse http://localhost:20211/; proxy_pass_reverse http://localhost:20211/;
proxy_redirect ~^/(.*)$ /netalertx/$1; proxy_redirect ~^/(.*)$ /netalertx/$1;
rewrite ^/netalertx/?(.*)$ /$1 break; rewrite ^/netalertx/?(.*)$ /$1 break;
} }
} }
``` ```
3. Check your config with `nginx -t`. If there are any issues, it will tell you. 3. Check your config with `nginx -t`. If there are any issues, it will tell you.
4. Activate the new website by running the following command: 4. Activate the new website by running the following command:
`nginx -s reload` or `systemctl restart nginx` `nginx -s reload` or `systemctl restart nginx`
@@ -172,15 +172,15 @@
2. In this file, paste the following code: 2. In this file, paste the following code:
``` ```
server { server {
listen 443; listen 443;
server_name netalertx; server_name netalertx;
SSLEngine On; SSLEngine On;
SSLCertificateFile /etc/ssl/certs/netalertx.pem; SSLCertificateFile /etc/ssl/certs/netalertx.pem;
SSLCertificateKeyFile /etc/ssl/private/netalertx.key; SSLCertificateKeyFile /etc/ssl/private/netalertx.key;
location ^~ /netalertx/ { location ^~ /netalertx/ {
proxy_pass http://localhost:20211/; proxy_pass http://localhost:20211/;
proxy_pass_reverse http://localhost:20211/; proxy_pass_reverse http://localhost:20211/;
proxy_redirect ~^/(.*)$ /netalertx/$1; proxy_redirect ~^/(.*)$ /netalertx/$1;
rewrite ^/netalertx/?(.*)$ /$1 break; rewrite ^/netalertx/?(.*)$ /$1 break;
sub_filter_once off; sub_filter_once off;
@@ -190,13 +190,13 @@
sub_filter '(?>$host)/js' '/netalertx/js'; sub_filter '(?>$host)/js' '/netalertx/js';
sub_filter '/img' '/netalertx/img'; sub_filter '/img' '/netalertx/img';
sub_filter '/lib' '/netalertx/lib'; sub_filter '/lib' '/netalertx/lib';
sub_filter '/php' '/netalertx/php'; sub_filter '/php' '/netalertx/php';
} }
} }
``` ```
3. Check your config with `nginx -t`. If there are any issues, it will tell you. 3. Check your config with `nginx -t`. If there are any issues, it will tell you.
4. Activate the new website by running the following command: 4. Activate the new website by running the following command:
`nginx -s reload` or `systemctl restart nginx` `nginx -s reload` or `systemctl restart nginx`
@@ -218,10 +218,10 @@
ProxyPass / http://localhost:20211/ ProxyPass / http://localhost:20211/
ProxyPassReverse / http://localhost:20211/ ProxyPassReverse / http://localhost:20211/
</VirtualHost> </VirtualHost>
``` ```
3. Check your config with `httpd -t` (or `apache2ctl -t` on Debian/Ubuntu). If there are any issues, it will tell you. 3. Check your config with `httpd -t` (or `apache2ctl -t` on Debian/Ubuntu). If there are any issues, it will tell you.
4. Activate the new website by running the following command: 4. Activate the new website by running the following command:
`a2ensite netalertx` or `service apache2 reload` `a2ensite netalertx` or `service apache2 reload`
@@ -245,10 +245,10 @@
ProxyPassReverse / http://localhost:20211/ ProxyPassReverse / http://localhost:20211/
} }
</VirtualHost> </VirtualHost>
``` ```
3. Check your config with `httpd -t` (or `apache2ctl -t` on Debian/Ubuntu). If there are any issues, it will tell you. 3. Check your config with `httpd -t` (or `apache2ctl -t` on Debian/Ubuntu). If there are any issues, it will tell you.
4. Activate the new website by running the following command: 4. Activate the new website by running the following command:
`a2ensite netalertx` or `service apache2 reload` `a2ensite netalertx` or `service apache2 reload`
@@ -273,10 +273,10 @@
ProxyPass / http://localhost:20211/ ProxyPass / http://localhost:20211/
ProxyPassReverse / http://localhost:20211/ ProxyPassReverse / http://localhost:20211/
</VirtualHost> </VirtualHost>
``` ```
3. Check your config with `httpd -t` (or `apache2ctl -t` on Debian/Ubuntu). If there are any issues, it will tell you. 3. Check your config with `httpd -t` (or `apache2ctl -t` on Debian/Ubuntu). If there are any issues, it will tell you.
4. Activate the new website by running the following command: 4. Activate the new website by running the following command:
`a2ensite netalertx` or `service apache2 reload` `a2ensite netalertx` or `service apache2 reload`
@@ -290,11 +290,11 @@
1. On your Apache server, create a new file called /etc/apache2/sites-available/netalertx.conf. 1. On your Apache server, create a new file called /etc/apache2/sites-available/netalertx.conf.
2. In this file, paste the following code: 2. In this file, paste the following code:
``` ```
<VirtualHost *:443> <VirtualHost *:443>
ServerName netalertx ServerName netalertx
SSLEngine On SSLEngine On
SSLCertificateFile /etc/ssl/certs/netalertx.pem SSLCertificateFile /etc/ssl/certs/netalertx.pem
SSLCertificateKeyFile /etc/ssl/private/netalertx.key SSLCertificateKeyFile /etc/ssl/private/netalertx.key
location ^~ /netalertx/ { location ^~ /netalertx/ {
@@ -303,10 +303,10 @@
ProxyPassReverse / http://localhost:20211/ ProxyPassReverse / http://localhost:20211/
} }
</VirtualHost> </VirtualHost>
``` ```
3. Check your config with `httpd -t` (or `apache2ctl -t` on Debian/Ubuntu). If there are any issues, it will tell you. 3. Check your config with `httpd -t` (or `apache2ctl -t` on Debian/Ubuntu). If there are any issues, it will tell you.
4. Activate the new website by running the following command: 4. Activate the new website by running the following command:
`a2ensite netalertx` or `service apache2 reload` `a2ensite netalertx` or `service apache2 reload`
@@ -381,7 +381,7 @@ location ^~ /netalertx/ {
> Submitted by [Isegrimm](https://github.com/Isegrimm) 🙏 (based on this [discussion](https://github.com/jokob-sk/NetAlertX/discussions/449#discussioncomment-7281442)) > Submitted by [Isegrimm](https://github.com/Isegrimm) 🙏 (based on this [discussion](https://github.com/jokob-sk/NetAlertX/discussions/449#discussioncomment-7281442))
Assuming the user already has a working Traefik setup, this is what's needed to make NetAlertX work at a URL like www.domain.com/netalertx/. Assuming the user already has a working Traefik setup, this is what's needed to make NetAlertX work at a URL like www.domain.com/netalertx/.
Note: Everything in these configs assumes '**www.domain.com**' as your domainname and '**section31**' as an arbitrary name for your certificate setup. You will have to substitute these with your own. Note: Everything in these configs assumes '**www.domain.com**' as your domainname and '**section31**' as an arbitrary name for your certificate setup. You will have to substitute these with your own.
@@ -496,14 +496,9 @@ server {
Mapping the updated file (on the local filesystem at `/appl/docker/netalertx/default`) into the docker container: Mapping the updated file (on the local filesystem at `/appl/docker/netalertx/default`) into the docker container:
```bash ```yaml
docker run -d --rm --network=host \ ...
--name=netalertx \ volumes:
-v /appl/docker/netalertx/config:/data/config \ - /appl/docker/netalertx/default:/etc/nginx/sites-available/default
-v /appl/docker/netalertx/db:/data/db \ ...
-v /appl/docker/netalertx/default:/etc/nginx/sites-available/default \
-e TZ=Europe/Amsterdam \
-e PORT=20211 \
ghcr.io/jokob-sk/netalertx:latest
``` ```

View File

@@ -1,62 +1,64 @@
# Sessions Section in Device View # Sessions Section Device View
The **Sessions Section** provides details about a device's connection history. This data is automatically detected and cannot be edited by the user. The **Sessions Section** shows a devices connection history. All data is automatically detected and **cannot be edited**.
![Session info](./img/SESSION_INFO/DeviceDetails_SessionInfo.png) ![Session info](./img/SESSION_INFO/DeviceDetails_SessionInfo.png)
--- ---
## Key Fields ## Key Fields
1. **Date and Time of First Connection** | Field | Description | Editable? |
- **Description:** Displays the first detected connection time for the device. | ------------------------------ | ------------------------------------------------------------------------------------------------ | --------------- |
- **Editability:** Uneditable (auto-detected). | **First Connection** | The first time the device was detected on the network. | ❌ Auto-detected |
- **Source:** Automatically captured when the device is first added to the system. | **Last Connection** | The most recent time the device was online. | ❌ Auto-detected |
2. **Date and Time of Last Connection**
- **Description:** Shows the most recent time the device was online.
- **Editability:** Uneditable (auto-detected).
- **Source:** Updated with every new connection event.
3. **Offline Devices with Missing or Conflicting Data**
- **Description:** Handles cases where a device is offline but has incomplete or conflicting session data (e.g., missing start times).
- **Handling:** The system flags these cases for review and attempts to infer missing details.
--- ---
## How Sessions are Discovered and Calculated ## How Session Information Works
### 1. Detecting New Devices ### 1. Detecting New Devices
When a device is first detected in the network, the system logs it in the events table:
`INSERT INTO Events (eve_MAC, eve_IP, eve_DateTime, eve_EventType, eve_AdditionalInfo, eve_PendingAlertEmail) SELECT cur_MAC, cur_IP, '{startTime}', 'New Device', cur_Vendor, 1 FROM CurrentScan WHERE NOT EXISTS (SELECT 1 FROM Devices WHERE devMac = cur_MAC)` * New devices are automatically detected when they first appear on the network.
* A **New Device** record is created, capturing the MAC, IP, vendor, and detection time.
- Devices scanned in the current cycle (**CurrentScan**) are checked against the **Devices** table. ### 2. Recording Connection Sessions
- If a device is new:
- A **New Device** event is logged.
- The devices MAC, IP, vendor, and detection time are recorded.
### 2. Logging Connection Sessions * Every time a device connects, a session entry is created.
When a new connection is detected, the system creates a session record: * Captured details include:
`INSERT INTO Sessions (ses_MAC, ses_IP, ses_EventTypeConnection, ses_DateTimeConnection, ses_EventTypeDisconnection, ses_DateTimeDisconnection, ses_StillConnected, ses_AdditionalInfo) SELECT cur_MAC, cur_IP, 'Connected', '{startTime}', NULL, NULL, 1, cur_Vendor FROM CurrentScan WHERE NOT EXISTS (SELECT 1 FROM Sessions WHERE ses_MAC = cur_MAC)` * Connection type (wired or wireless)
* Connection time
- A new session is logged in the **Sessions** table if no prior session exists. * Device details (MAC, IP, vendor)
- Fields like `MAC`, `IP`, `Connection Type`, and `Connection Time` are populated.
- The `Still Connected` flag is set to `1` (active connection).
### 3. Handling Missing or Conflicting Data ### 3. Handling Missing or Conflicting Data
- Devices with incomplete or conflicting session data (e.g., missing start times) are detected.
- The system flags these records and attempts corrections by inferring details from available data. * **Triggers:**
Devices are flagged when session data is incomplete, inconsistent, or conflicting. Examples include:
* Missing first or last connection timestamps
* Overlapping session records
* Sessions showing a device as connected and disconnected at the same time
* **System response:**
* Automatically highlights affected devices in the **Sessions Section**.
* Attempts to **infer missing information** from available data, such as:
* Estimating first or last connection times from nearby session events
* Correcting overlapping session periods
* Reconciling conflicting connection statuses
* **User impact:**
* Users do **not** need to manually fix session data.
* The system ensures the devices connection history remains as accurate as possible for monitoring and reporting.
### 4. Updating Sessions ### 4. Updating Sessions
- When a device reconnects, its session is updated with a new connection timestamp.
- When a device disconnects:
- The **Disconnection Time** is recorded.
- The `Still Connected` flag is set to `0`.
The session information is then used to display the device presence under **Monitoring** -> **Presence**. * **Reconnect:** Updates session with the new connection timestamp.
* **Disconnect:** Records disconnection time and marks the device as offline.
This session information feeds directly into **Monitoring → Presence**, providing a live view of which devices are currently online.
![Monitoring Device Presence](./img/SESSION_INFO/Monitoring_Presence.png) ![Monitoring Device Presence](./img/SESSION_INFO/Monitoring_Presence.png)

View File

@@ -1,10 +1,10 @@
# Installation on a Synology NAS # Installation on a Synology NAS
There are different ways to install NetAlertX on a Synology, including SSH-ing into the machine and using the command line. For this guide, we will use the Project option in Container manager. There are different ways to install NetAlertX on a Synology, including SSH-ing into the machine and using the command line. For this guide, we will use the Project option in Container manager.
## Create the folder structure ## Create the folder structure
The folders you are creating below will contain the configuration and the database. Back them up regularly. The folders you are creating below will contain the configuration and the database. Back them up regularly.
1. Create a parent folder named `netalertx` 1. Create a parent folder named `netalertx`
2. Create a `db` sub-folder 2. Create a `db` sub-folder
@@ -29,23 +29,31 @@ The folders you are creating below will contain the configuration and the databa
- Path: `/app_storage/netalertx` (will differ from yours) - Path: `/app_storage/netalertx` (will differ from yours)
- Paste in the following template: - Paste in the following template:
```yaml ```yaml
version: "3" version: "3"
services: services:
netalertx: netalertx:
container_name: netalertx container_name: netalertx
# use the below line if you want to test the latest dev image # use the below line if you want to test the latest dev image
# image: "ghcr.io/jokob-sk/netalertx-dev:latest" # image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: "ghcr.io/jokob-sk/netalertx:latest" image: "ghcr.io/jokob-sk/netalertx:latest"
network_mode: "host" network_mode: "host"
restart: unless-stopped restart: unless-stopped
cap_drop: # Drop all capabilities for enhanced security
- ALL
cap_add: # Re-add necessary capabilities
- NET_RAW
- NET_ADMIN
- NET_BIND_SERVICE
volumes: volumes:
- local/path/config:/data/config - /app_storage/netalertx:/data
- local/path/db:/data/db # to sync with system time
# (optional) useful for debugging if you have issues setting up the container - /etc/localtime:/etc/localtime:ro
- local/path/logs:/tmp/log tmpfs:
# All writable runtime state resides under /tmp; comment out to persist logs between restarts
- "/tmp:uid=20211,gid=20211,mode=1700,rw,noexec,nosuid,nodev,async,noatime,nodiratime"
environment: environment:
- TZ=Europe/Berlin
- PORT=20211 - PORT=20211
``` ```
@@ -57,10 +65,7 @@ services:
```yaml ```yaml
volumes: volumes:
- /volume1/app_storage/netalertx/config:/data/config - /volume1/app_storage/netalertx:/data
- /volume1/app_storage/netalertx/db:/data/db
# (optional) useful for debugging if you have issues setting up the container
# - local/path/logs:/tmp/log <- commented out with # ⚠
``` ```
![Adjusting docker-compose](./img/SYNOLOGY/08_Adjust_docker_compose_volumes.png) ![Adjusting docker-compose](./img/SYNOLOGY/08_Adjust_docker_compose_volumes.png)
@@ -71,4 +76,13 @@ services:
![Build](./img/SYNOLOGY/09_Run_and_build.png) ![Build](./img/SYNOLOGY/09_Run_and_build.png)
10. Navigate to `<Synology URL>:20211` (or your custom port). 10. Navigate to `<Synology URL>:20211` (or your custom port).
11. Read the [Subnets](./SUBNETS.md) and [Plugins](/docs/PLUGINS.md) docs to complete your setup. 11. Read the [Subnets](./SUBNETS.md) and [Plugins](/docs/PLUGINS.md) docs to complete your setup.
> [!TIP]
> If you are facing permissions issues run the following commands on your server. This will change the owner and assure sufficient access to the database and config files that are stored in the `/local_data_dir/db` and `/local_data_dir/config` folders (replace `local_data_dir` with the location where your `/db` and `/config` folders are located).
>
> `sudo chown -R 20211:20211 /local_data_dir`
>
> `sudo chmod -R a+rwx /local_data_dir`
>

View File

@@ -1,7 +1,8 @@
# Docker Update Strategies to upgrade NetAlertX # Docker Update Strategies to upgrade NetAlertX
> [!WARNING] > [!WARNING]
> For versions prior to `v25.6.7` upgrade to version `v25.5.24` first (`docker pull ghcr.io/jokob-sk/netalertx:25.5.24`) as later versions don't support a full upgrade. Alternatively, devices and settings can be migrated manually, e.g. via [CSV import](./DEVICES_BULK_EDITING.md). > For versions prior to `v25.6.7` upgrade to version `v25.5.24` first (`docker pull ghcr.io/jokob-sk/netalertx:25.5.24`) as later versions don't support a full upgrade. Alternatively, devices and settings can be migrated manually, e.g. via [CSV import](./DEVICES_BULK_EDITING.md).
> See the [Migration guide](./MIGRATION.md) for details.
This guide outlines approaches for updating Docker containers, usually when upgrading to a newer version of NetAlertX. Each method offers different benefits depending on the situation. Here are the methods: This guide outlines approaches for updating Docker containers, usually when upgrading to a newer version of NetAlertX. Each method offers different benefits depending on the situation. Here are the methods:
@@ -15,7 +16,7 @@ You can choose any approach that fits your workflow.
> In the examples I assume that the container name is `netalertx` and the image name is `netalertx` as well. > In the examples I assume that the container name is `netalertx` and the image name is `netalertx` as well.
> [!NOTE] > [!NOTE]
> See also [Backup strategies](./BACKUPS.md) to be on the safe side. > See also [Backup strategies](./BACKUPS.md) to be on the safe side.
## 1. Manual Updates ## 1. Manual Updates
@@ -48,7 +49,7 @@ sudo docker-compose up --pull always -d
## 2. Dockcheck for Bulk Container Updates ## 2. Dockcheck for Bulk Container Updates
Always check the [Dockcheck](https://github.com/mag37/dockcheck) docs if encountering issues with the guide below. Always check the [Dockcheck](https://github.com/mag37/dockcheck) docs if encountering issues with the guide below.
Dockcheck is a useful tool if you have multiple containers to update and some flexibility for handling potential issues that might arise during mass updates. Dockcheck allows you to inspect each container and decide when to update. Dockcheck is a useful tool if you have multiple containers to update and some flexibility for handling potential issues that might arise during mass updates. Dockcheck allows you to inspect each container and decide when to update.
@@ -74,7 +75,7 @@ sudo ./dockcheck.sh
## 3. Automated Updates with Watchtower ## 3. Automated Updates with Watchtower
Always check the [watchtower](https://github.com/containrrr/watchtower) docs if encountering issues with the guide below. Always check the [watchtower](https://github.com/containrrr/watchtower) docs if encountering issues with the guide below.
Watchtower monitors your Docker containers and automatically updates them when new images are available. This is ideal for ongoing updates without manual intervention. Watchtower monitors your Docker containers and automatically updates them when new images are available. This is ideal for ongoing updates without manual intervention.
@@ -96,7 +97,7 @@ docker run -d \
--interval 300 # Check for updates every 5 minutes --interval 300 # Check for updates every 5 minutes
``` ```
#### 3. Run Watchtower to update only NetAlertX: #### 3. Run Watchtower to update only NetAlertX:
You can specify which containers to monitor by listing them. For example, to monitor netalertx only: You can specify which containers to monitor by listing them. For example, to monitor netalertx only:

View File

@@ -2,7 +2,7 @@
The application uses the following default ports: The application uses the following default ports:
- **Web UI**: `20211` - **Web UI**: `20211`
- **GraphQL API**: `20212` - **GraphQL API**: `20212`
The **Web UI** is served by an **nginx** server, while the **API backend** runs on a **Flask (Python)** server. The **Web UI** is served by an **nginx** server, while the **API backend** runs on a **Flask (Python)** server.
@@ -25,8 +25,8 @@ Follow all of the below in order to disqualify potential causes of issues and to
When opening an issue or debugging: When opening an issue or debugging:
1. Include a screenshot of what you see when accessing `HTTP://<your rpi IP>/20211` (or your custom port) 1. Include a screenshot of what you see when accessing `HTTP://<your_server>:20211` (or your custom port)
1. [Follow steps 1, 2, 3, 4 on this page](./DEBUG_TIPS.md) 1. [Follow steps 1, 2, 3, 4 on this page](./DEBUG_TIPS.md)
1. Execute the following in the container to see the processes and their ports and submit a screenshot of the result: 1. Execute the following in the container to see the processes and their ports and submit a screenshot of the result:
- `sudo apk add lsof` - `sudo apk add lsof`
- `sudo lsof -i` - `sudo lsof -i`
@@ -36,21 +36,21 @@ When opening an issue or debugging:
![lsof ports](./img/WEB_UI_PORT_DEBUG/container_port.png) ![lsof ports](./img/WEB_UI_PORT_DEBUG/container_port.png)
### 2. JavaScript issues ### 2. JavaScript issues
Check for browser console (F12 browser dev console) errors + check different browsers. Check for browser console (F12 browser dev console) errors + check different browsers.
### 3. Clear the app cache and cached JavaScript files ### 3. Clear the app cache and cached JavaScript files
Refresh the browser cache (usually shoft + refresh), try a private window, or different browsers. Please also refresh the app cache by clicking the 🔃 (reload) button in the header of the application. Refresh the browser cache (usually shoft + refresh), try a private window, or different browsers. Please also refresh the app cache by clicking the 🔃 (reload) button in the header of the application.
### 4. Disable proxies ### 4. Disable proxies
If you have any reverse proxy or similar, try disabling it. If you have any reverse proxy or similar, try disabling it.
### 5. Disable your firewall ### 5. Disable your firewall
If you are using a firewall, try to temporarily disabling it. If you are using a firewall, try to temporarily disabling it.
### 6. Post your docker start details ### 6. Post your docker start details
@@ -67,6 +67,6 @@ In the container execute and investigate:
### 8. Make sure permissions are correct ### 8. Make sure permissions are correct
> [!TIP] > [!TIP]
> You can try to start the container without mapping the `/data/config` and `/data/db` dirs and if the UI shows up then the issue is most likely related to your file system permissions or file ownership. > You can try to start the container without mapping the `/data/config` and `/data/db` dirs and if the UI shows up then the issue is most likely related to your file system permissions or file ownership.
Please read the [Permissions troubleshooting guide](./FILE_PERMISSIONS.md) and provide a screesnhot of the permissions and ownership in the `/data/db` and `app/config` directories. Please read the [Permissions troubleshooting guide](./FILE_PERMISSIONS.md) and provide a screesnhot of the permissions and ownership in the `/data/db` and `app/config` directories.

View File

@@ -1,22 +1,22 @@
# Workflows debugging and troubleshooting # Workflows debugging and troubleshooting
> [!TIP] > [!TIP]
> Before troubleshooting, please ensure you have [Debugging enabled](./DEBUG_TIPS.md). > Before troubleshooting, please ensure you have the right [Debugging and LOG_LEVEL set](./DEBUG_TIPS.md).
Workflows are triggered by various events. These events are captured and listed in the _Integrations -> App Events_ section of the application. Workflows are triggered by various events. These events are captured and listed in the _Integrations -> App Events_ section of the application.
## Troubleshooting triggers ## Troubleshooting triggers
> [!NOTE] > [!NOTE]
> Workflow events are processed once every 5 seconds. However, if a scan or other background tasks are running, this can cause a delay up to a few minutes. > Workflow events are processed once every 5 seconds. However, if a scan or other background tasks are running, this can cause a delay up to a few minutes.
If an event doesn't trigger a workflow as expected, check the _App Events_ section for the event. You can filter these by the ID of the device (`devMAC` or `devGUID`). If an event doesn't trigger a workflow as expected, check the _App Events_ section for the event. You can filter these by the ID of the device (`devMAC` or `devGUID`).
![App events search](./img/WORKFLOWS/workflows_app_events_search.png) ![App events search](./img/WORKFLOWS/workflows_app_events_search.png)
Once you find the _Event Guid_ and _Object GUID_, use them to find relevant debug entries. Once you find the _Event Guid_ and _Object GUID_, use them to find relevant debug entries.
Navigate to _Mainetenace -> Logs_ where you can filter the logs based on the _Event or Object GUID_. Navigate to _Mainetenace -> Logs_ where you can filter the logs based on the _Event or Object GUID_.
![Log events search](./img/WORKFLOWS/workflows_logs_search.png) ![Log events search](./img/WORKFLOWS/workflows_logs_search.png)
@@ -24,9 +24,9 @@ Below you can find some example `app.log` entries that will help you understand
```bash ```bash
16:27:03 [WF] Checking if '13f0ce26-1835-4c48-ae03-cdaf38f328fe' triggers the workflow 'Sample Device Update Workflow' 16:27:03 [WF] Checking if '13f0ce26-1835-4c48-ae03-cdaf38f328fe' triggers the workflow 'Sample Device Update Workflow'
16:27:03 [WF] self.triggered 'False' for event '[[155], ['13f0ce26-1835-4c48-ae03-cdaf38f328fe'], [0], ['2025-04-02 05:26:56'], ['Devices'], ['050b6980-7af6-4409-950d-08e9786b7b33'], ['DEVICES'], ['00:11:32:ef:a5:6c'], ['192.168.1.82'], ['050b6980-7af6-4409-950d-08e9786b7b33'], [None], [0], [0], ['devPresentLastScan'], ['online'], ['update'], [None], [None], [None], [None]] and trigger {"object_type": "Devices", "event_type": "insert"}' 16:27:03 [WF] self.triggered 'False' for event '[[155], ['13f0ce26-1835-4c48-ae03-cdaf38f328fe'], [0], ['2025-04-02 05:26:56'], ['Devices'], ['050b6980-7af6-4409-950d-08e9786b7b33'], ['DEVICES'], ['00:11:32:ef:a5:6c'], ['192.168.1.82'], ['050b6980-7af6-4409-950d-08e9786b7b33'], [None], [0], [0], ['devPresentLastScan'], ['online'], ['update'], [None], [None], [None], [None]] and trigger {"object_type": "Devices", "event_type": "insert"}'
16:27:03 [WF] Checking if '13f0ce26-1835-4c48-ae03-cdaf38f328fe' triggers the workflow 'Location Change' 16:27:03 [WF] Checking if '13f0ce26-1835-4c48-ae03-cdaf38f328fe' triggers the workflow 'Location Change'
16:27:03 [WF] self.triggered 'True' for event '[[155], ['13f0ce26-1835-4c48-ae03-cdaf38f328fe'], [0], ['2025-04-02 05:26:56'], ['Devices'], ['050b6980-7af6-4409-950d-08e9786b7b33'], ['DEVICES'], ['00:11:32:ef:a5:6c'], ['192.168.1.82'], ['050b6980-7af6-4409-950d-08e9786b7b33'], [None], [0], [0], ['devPresentLastScan'], ['online'], ['update'], [None], [None], [None], [None]] and trigger {"object_type": "Devices", "event_type": "update"}' 16:27:03 [WF] self.triggered 'True' for event '[[155], ['13f0ce26-1835-4c48-ae03-cdaf38f328fe'], [0], ['2025-04-02 05:26:56'], ['Devices'], ['050b6980-7af6-4409-950d-08e9786b7b33'], ['DEVICES'], ['00:11:32:ef:a5:6c'], ['192.168.1.82'], ['050b6980-7af6-4409-950d-08e9786b7b33'], [None], [0], [0], ['devPresentLastScan'], ['online'], ['update'], [None], [None], [None], [None]] and trigger {"object_type": "Devices", "event_type": "update"}'
16:27:03 [WF] Event with GUID '13f0ce26-1835-4c48-ae03-cdaf38f328fe' triggered the workflow 'Location Change' 16:27:03 [WF] Event with GUID '13f0ce26-1835-4c48-ae03-cdaf38f328fe' triggered the workflow 'Location Change'
``` ```

View File

Before

Width:  |  Height:  |  Size: 135 KiB

After

Width:  |  Height:  |  Size: 135 KiB

View File

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

View File

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

View File

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

View File

@@ -1,6 +1,6 @@
/* ----------------------------------------------------------------------------- /* -----------------------------------------------------------------------------
# NetAlertX # NetAlertX
# Open Source Network Guard / WIFI & LAN intrusion detector # Open Source Network Guard / WIFI & LAN intrusion detector
# #
# app.css - Front module. CSS styles # app.css - Front module. CSS styles
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
@@ -36,7 +36,7 @@ a[target="_blank"] {
display: inline-block; /* Needed for positioning */ display: inline-block; /* Needed for positioning */
padding-right: 0.6em; /* Space for the icon */ padding-right: 0.6em; /* Space for the icon */
} }
a[target="_blank"]::after { a[target="_blank"]::after {
content: '↗'; content: '↗';
position: absolute; position: absolute;
@@ -55,7 +55,7 @@ a[target="_blank"] {
right: -7px; right: -7px;
top: 1px; top: 1px;
} */ } */
/* .select2-container--default .select2-selection--multiple .select2-selection__choice /* .select2-container--default .select2-selection--multiple .select2-selection__choice
{ {
padding-right: 15px !important; padding-right: 15px !important;
@@ -70,6 +70,11 @@ a[target="_blank"] {
opacity: 1; opacity: 1;
} }
[data-is-valid="0"] {
/* border: 1px solid red; */
background-color: #ff4b4b !important;
}
/* ----------------------------------------------------------------------------- /* -----------------------------------------------------------------------------
Helper Classes Helper Classes
----------------------------------------------------------------------------- */ ----------------------------------------------------------------------------- */
@@ -100,7 +105,7 @@ a[target="_blank"] {
background-color: black; background-color: black;
font-family: 'Courier New', monospace; font-family: 'Courier New', monospace;
font-size: .85em; font-size: .85em;
} }
.logs-row textarea .logs-row textarea
{ {
@@ -110,12 +115,12 @@ a[target="_blank"] {
display:contents; display:contents;
position: relative; position: relative;
padding: 0.4em padding: 0.4em
} }
#tab_Logging .actions .toggle{ #tab_Logging .actions .toggle{
margin: 0.5em; margin: 0.5em;
height: 3em; height: 3em;
} }
@@ -134,8 +139,8 @@ a[target="_blank"] {
} }
.log-area .log-area
{ {
padding: 3px; padding: 3px;
width:100%; width:100%;
border-bottom-width: 1px; border-bottom-width: 1px;
border-bottom-style: solid; border-bottom-style: solid;
border-color: #606060; border-color: #606060;
@@ -246,7 +251,7 @@ a[target="_blank"] {
{ {
padding:8px; padding:8px;
color: white; color: white;
} }
.header-status .header-status
{ {
@@ -262,7 +267,7 @@ a[target="_blank"] {
position: absolute; position: absolute;
top: 3px; top: 3px;
margin-left: 15px; margin-left: 15px;
display: none; display: none;
} }
@@ -298,9 +303,9 @@ body
.NetAlertX-logo .NetAlertX-logo
{ {
border-color:transparent !important; border-color:transparent !important;
height: 50px !important; height: 50px !important;
width: 50px !important; width: 50px !important;
margin-top:15px !important; margin-top:15px !important;
border-radius: 1px !important; border-radius: 1px !important;
} }
@@ -327,7 +332,7 @@ body
.content-wrapper, .content-wrapper,
.right-side, .right-side,
.main-footer { .main-footer {
margin-left: 150px; margin-left: 150px;
} }
@@ -740,7 +745,7 @@ body
text-decoration: underline; text-decoration: underline;
} }
#ticker-message #ticker-message
{ {
color:#FFFFFF; color:#FFFFFF;
} }
@@ -774,7 +779,7 @@ body
.file-checking .icon-wrap{ .file-checking .icon-wrap{
width: 200px; width: 200px;
overflow: hidden; overflow: hidden;
text-overflow: ellipsis; text-overflow: ellipsis;
display: block; display: block;
} }
@@ -788,7 +793,7 @@ body
.file-checking .file-name-wrap{ .file-checking .file-name-wrap{
overflow: hidden; overflow: hidden;
text-overflow: ellipsis; text-overflow: ellipsis;
display: flex; display: flex;
padding: 5px; padding: 5px;
} }
@@ -796,7 +801,7 @@ body
.file-checking{ .file-checking{
display: block; display: block;
overflow: hidden; overflow: hidden;
text-overflow: ellipsis; text-overflow: ellipsis;
} }
@@ -854,16 +859,16 @@ body
.db_tools_table_cell_a { .db_tools_table_cell_a {
display: table-cell; display: table-cell;
text-align: center; text-align: center;
padding: 10px; padding: 10px;
min-width: 180px; min-width: 180px;
width: 20%; width: 20%;
vertical-align: middle; vertical-align: middle;
} }
.db_tools_table_cell_b { .db_tools_table_cell_b {
display: table-cell; display: table-cell;
text-align: justify; text-align: justify;
font-size: 16px; font-size: 16px;
vertical-align: middle; vertical-align: middle;
padding: 10px; padding: 10px;
} }
@@ -876,12 +881,12 @@ height: 50px;
} }
.nav-tabs-custom .tab-content { .nav-tabs-custom .tab-content {
background-color: white; background-color: white;
} }
@media (max-width: 767px) { @media (max-width: 767px) {
.nav-tabs-custom .tab-content { .nav-tabs-custom .tab-content {
overflow: scroll; overflow: scroll;
} }
} }
@@ -898,7 +903,7 @@ height: 50px;
font-size: 16px !important; font-size: 16px !important;
} }
.deviceSelector .deviceSelector
{ {
display: block; display: block;
} }
@@ -935,7 +940,7 @@ height: 50px;
height: 10px; height: 10px;
display: inline-block; display: inline-block;
/* background: #fff; */ /* background: #fff; */
opacity: .75; opacity: .75;
} }
/* --------------------------------------------------------- */ /* --------------------------------------------------------- */
@@ -979,32 +984,32 @@ height: 50px;
} }
/* .setting_input{ /* .setting_input{
width:70%; width:70%;
} }
.setting_name .setting_name
{ {
width:30%; width:30%;
} */ } */
} }
@media (min-width: 768px) { @media (min-width: 768px) {
.setting_description { .setting_description {
/* color: green; */ /* color: green; */
display: block; display: block;
} }
/* .setting_input{ /* .setting_input{
width:40%; width:40%;
} }
.setting_name .setting_name
{ {
width:19%; width:19%;
} */ } */
} }
/* Hide unusable buttons on the settings page for the NEWDEV plugin*/ /* Hide unusable buttons on the settings page for the NEWDEV plugin*/
#settingsPage #add_option_NEWDEV_devGroup, #settingsPage #add_option_NEWDEV_devGroup,
#settingsPage #add_option_NEWDEV_devLocation, #settingsPage #add_option_NEWDEV_devLocation,
#settingsPage #add_option_NEWDEV_devOwner, #settingsPage #add_option_NEWDEV_devOwner,
#settingsPage #copy_icons_NEWDEV_devIcon, #settingsPage #copy_icons_NEWDEV_devIcon,
#settingsPage #add_icon_NEWDEV_devIcon, #settingsPage #add_icon_NEWDEV_devIcon,
@@ -1024,11 +1029,11 @@ height: 50px;
#settingsPage .small-box .inner .card-title { #settingsPage .small-box .inner .card-title {
overflow: hidden; overflow: hidden;
text-overflow: ellipsis; text-overflow: ellipsis;
white-space: nowrap; white-space: nowrap;
color: white; color: white;
} }
.settingswrap .settingswrap
{ {
@@ -1048,13 +1053,13 @@ height: 50px;
.padding-bottom .padding-bottom
{ {
padding-bottom: 100px; padding-bottom: 100px;
} }
.settings-group .settings-group
{ {
font-size: 20px; font-size: 20px;
padding-top: 7px; padding-top: 7px;
padding-bottom: 9px; padding-bottom: 9px;
} }
.overview-section .small-box .icon .overview-section .small-box .icon
@@ -1069,7 +1074,7 @@ height: 50px;
} }
.overview-group .overview-group
{ {
font-size: 20px; font-size: 20px;
padding-top: 7px; padding-top: 7px;
padding-bottom: 9px; padding-bottom: 9px;
@@ -1082,8 +1087,8 @@ height: 50px;
} }
#settingsPage .table_row { #settingsPage .table_row {
padding: 3px; padding: 3px;
/* width:100%; */ /* width:100%; */
/* display: flex; */ /* display: flex; */
border-bottom-width: 1px; border-bottom-width: 1px;
@@ -1102,7 +1107,7 @@ height: 50px;
.setting_name .setting_name
{ {
/* width:19%; */ /* width:19%; */
font-weight: 300; font-weight: 300;
} }
@@ -1111,24 +1116,24 @@ height: 50px;
display:none !important; display:none !important;
} }
.center .center
{ {
margin: 0; margin: 0;
position: relative; position: relative;
left: 50%; left: 50%;
-ms-transform: translate(-50%, -50%); -ms-transform: translate(-50%, -50%);
transform: translate(-50%, -50%); transform: translate(-50%, -50%);
} }
.top-margin .top-margin
{ {
margin-top: 50px; margin-top: 50px;
} }
/* Settings */ /* Settings */
#settingsPage .overview-setting-value{ #settingsPage .overview-setting-value{
display:unset; display:unset;
} }
@@ -1165,7 +1170,7 @@ height: 50px;
} }
.text-overflow-hidden .text-overflow-hidden
{ {
overflow: hidden; overflow: hidden;
text-overflow: clip; text-overflow: clip;
} }
@@ -1175,9 +1180,9 @@ height: 50px;
padding: 10px; padding: 10px;
/* background-color: #272c30; */ /* background-color: #272c30; */
margin: 10px; margin: 10px;
} }
#settingsPage .panel-heading:hover{ #settingsPage .panel-heading:hover{
background-color: #272c30; background-color: #272c30;
} }
@@ -1185,12 +1190,12 @@ height: 50px;
font-size: medium; font-size: medium;
/* background-color: #272c30; */ /* background-color: #272c30; */
margin: 10px; margin: 10px;
} }
.settings_content input[type=checkbox] .settings_content input[type=checkbox]
{ {
width: auto width: auto
} }
.override{ .override{
@@ -1212,7 +1217,7 @@ height: 50px;
input[readonly] { input[readonly] {
/* Apply styles to the readonly input */ /* Apply styles to the readonly input */
background-color: #646566 !important; background-color: #646566 !important;
color: #e6e6e6; color: #e6e6e6;
cursor: not-allowed; cursor: not-allowed;
} }
@@ -1300,7 +1305,7 @@ input[readonly] {
/* margin-bottom:20px; */ /* margin-bottom:20px; */
} }
#settingsPage .select2-selection #settingsPage .select2-selection
{ {
width: initial; width: initial;
display: inline-block; display: inline-block;
@@ -1314,8 +1319,8 @@ input[readonly] {
#settingsPage .select2-selection #settingsPage .select2-selection
{ {
background-color: rgb(96, 96, 96); background-color: rgb(96, 96, 96);
} }
#settingsPage .select2-container #settingsPage .select2-container
{ {
width: 100% !important; width: 100% !important;
} }
@@ -1398,7 +1403,7 @@ input[readonly] {
backdrop-filter: brightness(50%); backdrop-filter: brightness(50%);
} }
.iconPreviewSelector .iconPreviewSelector
{ {
text-align: center; text-align: center;
padding: 15px; padding: 15px;
@@ -1440,7 +1445,7 @@ input[readonly] {
} }
.dummyDevice .dummyDevice
{ {
text-align: end; text-align: end;
} }
@@ -1461,7 +1466,7 @@ input[readonly] {
} }
.info-icon-nav .info-icon-nav
{ {
top: -6px; top: -6px;
position: absolute; position: absolute;
z-index: 1; z-index: 1;
@@ -1538,7 +1543,7 @@ input[readonly] {
} }
#panDetails .input-group { #panDetails .input-group {
min-height: 40px; min-height: 40px;
} }
@@ -1583,7 +1588,7 @@ input[readonly] {
} }
.devicePropAction .devicePropAction
{ {
width: 1.2em; width: 1.2em;
height: 1.2em; height: 1.2em;
display: inline-block; display: inline-block;
@@ -1593,11 +1598,11 @@ input[readonly] {
} }
.devicePropAction:hover .devicePropAction:hover
{ {
font-size: larger; font-size: larger;
padding: 0em; padding: 0em;
margin: 0em; margin: 0em;
} }
@@ -1607,7 +1612,7 @@ input[readonly] {
display: block; display: block;
float:inline-end; float:inline-end;
height: 2em; height: 2em;
} }
#panDetails .dataTables_wrapper .bottom .dataTables_info #panDetails .dataTables_wrapper .bottom .dataTables_info
{ {
@@ -1636,22 +1641,22 @@ input[readonly] {
height: 14px; height: 14px;
} }
#deviceDetailsEdit .select2-container--default .select2-selection--multiple .select2-selection__choice #deviceDetailsEdit .select2-container--default .select2-selection--multiple .select2-selection__choice
{ {
height: 20px; height: 20px;
} }
#deviceDetailsEdit .select2-container--disabled #deviceDetailsEdit .select2-container--disabled
{ {
background-color: #606060; background-color: #606060;
} }
#deviceDetailsEdit .select2-container--default .select2-selection--multiple .select2-selection__choice span #deviceDetailsEdit .select2-container--default .select2-selection--multiple .select2-selection__choice span
{ {
font-size: 14px; font-size: 14px;
} }
#deviceDetailsEdit .select2-selection #deviceDetailsEdit .select2-selection
{ {
width: initial; width: initial;
display: inline-block; display: inline-block;
@@ -1681,7 +1686,7 @@ input[readonly] {
font-size: 14px; font-size: 14px;
} }
.custom-badge .custom-badge
{ {
border: 1px solid #aaa; border: 1px solid #aaa;
border-radius: 4px; border-radius: 4px;
border-style: solid; border-style: solid;
@@ -1716,7 +1721,7 @@ input[readonly] {
} }
#deviceDetailsEdit .select2-container #deviceDetailsEdit .select2-container
{ {
width: 100% !important; width: 100% !important;
} }
@@ -1799,7 +1804,7 @@ input[readonly] {
z-index: 5; z-index: 5;
} }
#networkTree .netNodeText #networkTree .netNodeText
{ {
position: absolute; position: absolute;
} }
#networkTree .netPort #networkTree .netPort
@@ -1812,7 +1817,7 @@ input[readonly] {
#networkTree .portBckgIcon #networkTree .portBckgIcon
{ {
opacity: 0.3; opacity: 0.3;
display: initial; display: initial;
float: left; float: left;
width: 1em; width: 1em;
} }
@@ -1822,7 +1827,7 @@ input[readonly] {
margin-left: 16px; margin-left: 16px;
/* border: solid; /* border: solid;
border-color:#606060; */ border-color:#606060; */
position: relative; position: relative;
} }
#networkTree .netIcon #networkTree .netIcon
{ {
@@ -1850,8 +1855,8 @@ input[readonly] {
} }
#hover-box .devName #hover-box .devName
{ {
font-size: larger; font-size: larger;
display: contents; display: contents;
} }
@@ -1910,7 +1915,7 @@ input[readonly] {
#networkTree .highlightedNode #networkTree .highlightedNode
{ {
/* border: solid; */ /* border: solid; */
border-color:var(--color-lightblue); border-color:var(--color-lightblue);
box-shadow: var(--color-lightblue) 0px 0px 20px; box-shadow: var(--color-lightblue) 0px 0px 20px;
} }
@@ -1968,7 +1973,7 @@ input[readonly] {
} }
.sort-btn { .sort-btn {
right: 5px; right: 5px;
top: 50%; top: 50%;
transform: translateY(-50%); transform: translateY(-50%);
@@ -2020,7 +2025,7 @@ input[readonly] {
} }
.plugin-filters .plugin-filters
{ {
margin: 7px; margin: 7px;
margin-right: 7px; margin-right: 7px;
margin-bottom: 9px; margin-bottom: 9px;
@@ -2054,7 +2059,7 @@ input[readonly] {
} }
.plugin-content #tabs-content-location .plugin-content #tabs-content-location
{ {
margin: 0px; margin: 0px;
padding-top: 0; padding-top: 0;
} }
@@ -2066,7 +2071,7 @@ input[readonly] {
} }
.plugin-content .tab-content .plugin-content .tab-content
{ {
padding-top: 10px; padding-top: 10px;
} }
@@ -2103,7 +2108,7 @@ input[readonly] {
@media (max-width: 500px) { @media (max-width: 500px) {
.header-server-time { .header-server-time {
display: none; display: none;
} }
} }
@@ -2234,12 +2239,12 @@ input[readonly] {
display: grid; display: grid;
} }
#workflowContainerWrap .panel-collapse #workflowContainerWrap .panel-collapse
{ {
padding: 5px; padding: 5px;
} }
.workflows .workflows
{ {
max-width: 800px; max-width: 800px;
} }
@@ -2285,7 +2290,7 @@ input[readonly] {
color: #000; color: #000;
} }
.workflows .button-container .workflows .button-container
{ {
/* display: contents; */ /* display: contents; */
text-align: center; text-align: center;
@@ -2305,7 +2310,7 @@ input[readonly] {
margin: 5px; margin: 5px;
} }
.workflows .button-container .workflows .button-container
{ {
padding-right: 0px !important; padding-right: 0px !important;
padding-left: 0px !important; padding-left: 0px !important;
@@ -2318,19 +2323,19 @@ input[readonly] {
/* .button-container button /* .button-container button
{ {
width:100%; width:100%;
} */ } */
.red-hover-text:hover .red-hover-text:hover
{ {
color: var(--color-red) !important; color: var(--color-red) !important;
} }
.green-hover-text:hover .green-hover-text:hover
{ {
color: var(--color-green) !important; color: var(--color-green) !important;
} }
.workflows .bckg-icon-1-line .workflows .bckg-icon-1-line
{ {
font-size: 3em; font-size: 3em;
@@ -2362,7 +2367,7 @@ input[readonly] {
z-index: 1; z-index: 1;
} }
.workflows .workflow-card .workflows .workflow-card
{ {
display: block; display: block;
} }
@@ -2372,7 +2377,7 @@ input[readonly] {
padding: 10px; padding: 10px;
} }
.workflow-card, .actions-list .workflow-card, .actions-list
{ {
display: contents; display: contents;
padding: 5px; padding: 5px;
@@ -2384,7 +2389,7 @@ input[readonly] {
z-index:1; z-index:1;
} }
.condition .condition
{ {
padding: 5px; padding: 5px;
padding-left: 10px; padding-left: 10px;

View File

@@ -1,7 +1,7 @@
<!-- <!--
#---------------------------------------------------------------------------------# #---------------------------------------------------------------------------------#
# NetAlertX # # NetAlertX #
# Open Source Network Guard / WIFI & LAN intrusion detector # # Open Source Network Guard / WIFI & LAN intrusion detector #
# # # #
# devices.php - Front module. Devices list page # # devices.php - Front module. Devices list page #
#---------------------------------------------------------------------------------# #---------------------------------------------------------------------------------#
@@ -15,7 +15,7 @@
<?php <?php
require 'php/templates/header.php'; require 'php/templates/header.php';
// check permissions // check permissions
// Use environment-aware paths with fallback to legacy locations // Use environment-aware paths with fallback to legacy locations
$dbFolderPath = rtrim(getenv('NETALERTX_DB') ?: '/data/db', '/'); $dbFolderPath = rtrim(getenv('NETALERTX_DB') ?: '/data/db', '/');
@@ -36,7 +36,7 @@
?> ?>
<!-- ----------------------------------------------------------------------- --> <!-- ----------------------------------------------------------------------- -->
<!-- Page ------------------------------------------------------------------ --> <!-- Page ------------------------------------------------------------------ -->
<div class="content-wrapper"> <div class="content-wrapper">
@@ -55,15 +55,15 @@
<div class="col-md-12"> <div class="col-md-12">
<div class="box" id="clients"> <div class="box" id="clients">
<div class="box-header "> <div class="box-header ">
<h3 class="box-title col-md-12"><?= lang('Device_Shortcut_OnlineChart');?> </h3> <h3 class="box-title col-md-12"><?= lang('Device_Shortcut_OnlineChart');?> </h3>
</div> </div>
<div class="box-body"> <div class="box-body">
<div class="chart"> <div class="chart">
<script src="lib/chart.js/Chart.js?v=<?php include 'php/templates/version.php'; ?>"></script> <script src="lib/chart.js/Chart.js?v=<?php include 'php/templates/version.php'; ?>"></script>
<!-- presence chart --> <!-- presence chart -->
<?php <?php
require 'php/components/graph_online_history.php'; require 'php/components/graph_online_history.php';
?> ?>
</div> </div>
</div> </div>
<!-- /.box-body --> <!-- /.box-body -->
@@ -74,7 +74,7 @@
<!-- Device Filters ------------------------------------------------------- --> <!-- Device Filters ------------------------------------------------------- -->
<div class="box box-aqua hidden" id="columnFiltersWrap"> <div class="box box-aqua hidden" id="columnFiltersWrap">
<div class="box-header "> <div class="box-header ">
<h3 class="box-title col-md-12"><?= lang('Devices_Filters');?> </h3> <h3 class="box-title col-md-12"><?= lang('Devices_Filters');?> </h3>
</div> </div>
<!-- Placeholder ------------------------------------------------------- --> <!-- Placeholder ------------------------------------------------------- -->
<div id="columnFilters" ></div> <div id="columnFilters" ></div>
@@ -88,8 +88,8 @@
<!-- box-header --> <!-- box-header -->
<div class="box-header"> <div class="box-header">
<div class=" col-sm-8 "> <div class=" col-sm-8 ">
<h3 id="tableDevicesTitle" class="box-title text-gray "></h3> <h3 id="tableDevicesTitle" class="box-title text-gray "></h3>
</div> </div>
<div class="dummyDevice col-sm-4 "> <div class="dummyDevice col-sm-4 ">
<span id="multiEditPlc"> <span id="multiEditPlc">
<!-- multi edit button placeholder --> <!-- multi edit button placeholder -->
@@ -104,8 +104,8 @@
<div class="box-body table-responsive"> <div class="box-body table-responsive">
<table id="tableDevices" class="table table-bordered table-hover table-striped"> <table id="tableDevices" class="table table-bordered table-hover table-striped">
<thead> <thead>
<tr> <tr>
</tr> </tr>
</thead> </thead>
</table> </table>
@@ -122,7 +122,7 @@
<!-- ----------------------------------------------------------------------- --> <!-- ----------------------------------------------------------------------- -->
</section> </section>
<!-- /.content --> <!-- /.content -->
</div> </div>
<!-- /.content-wrapper --> <!-- /.content-wrapper -->
@@ -136,9 +136,9 @@
<!-- page script ----------------------------------------------------------- --> <!-- page script ----------------------------------------------------------- -->
<script> <script>
var deviceStatus = 'all'; var deviceStatus = 'all';
var tableRows = getCache ("nax_parTableRows") == "" ? parseInt(getSetting("UI_DEFAULT_PAGE_SIZE")) : getCache ("nax_parTableRows") ;
var tableOrder = getCache ("nax_parTableOrder") == "" ? [[3,'desc'], [0,'asc']] : JSON.parse(getCache ("nax_parTableOrder")) ; var tableOrder = getCache ("nax_parTableOrder") == "" ? [[3,'desc'], [0,'asc']] : JSON.parse(getCache ("nax_parTableOrder")) ;
var tableColumnHide = []; var tableColumnHide = [];
var tableColumnOrder = []; var tableColumnOrder = [];
var tableColumnVisible = []; var tableColumnVisible = [];
@@ -161,7 +161,7 @@ function main () {
//initialize the table headers in the correct order //initialize the table headers in the correct order
var availableColumns = getSettingOptions("UI_device_columns").split(","); var availableColumns = getSettingOptions("UI_device_columns").split(",");
headersDefaultOrder = availableColumns.map(val => getString(val)); headersDefaultOrder = availableColumns.map(val => getString(val));
var selectedColumns = JSON.parse(getSetting("UI_device_columns").replace(/'/g, '"')); var selectedColumns = JSON.parse(getSetting("UI_device_columns").replace(/'/g, '"'));
@@ -190,10 +190,10 @@ function main () {
// Initialize components with parameters // Initialize components with parameters
initializeDatatable(getUrlAnchor('my_devices')); initializeDatatable(getUrlAnchor('my_devices'));
// check if data outdated and show spinner if so // check if data outdated and show spinner if so
handleLoadingDialog() handleLoadingDialog()
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
@@ -202,7 +202,7 @@ function mapIndx(oldIndex)
{ {
// console.log(oldIndex); // console.log(oldIndex);
// console.log(tableColumnOrder); // console.log(tableColumnOrder);
for(i=0;i<tableColumnOrder.length;i++) for(i=0;i<tableColumnOrder.length;i++)
{ {
if(tableColumnOrder[i] == oldIndex) if(tableColumnOrder[i] == oldIndex)
@@ -311,7 +311,7 @@ function processDeviceTotals(devicesData) {
} }
}); });
// Render info boxes/tile cards // Render info boxes/tile cards
renderInfoboxes(dataArray); renderInfoboxes(dataArray);
} }
@@ -350,9 +350,9 @@ function initFilters() {
nocache: Date.now() // Prevent caching with a timestamp nocache: Date.now() // Prevent caching with a timestamp
}, },
success: function(response) { success: function(response) {
if (response && response.data) { if (response && response.data) {
let resultJSON = response.data; let resultJSON = response.data;
// Save the result to cache // Save the result to cache
setCache("devicesFilters", JSON.stringify(resultJSON)); setCache("devicesFilters", JSON.stringify(resultJSON));
@@ -381,7 +381,7 @@ function initFilters() {
}); });
// Filter resultJSON to include only entries with columnName in columnFilters // Filter resultJSON to include only entries with columnName in columnFilters
resultJSON = resultJSON.filter(entry => resultJSON = resultJSON.filter(entry =>
columnFilters.some(filter => filter[0] === entry.columnName) columnFilters.some(filter => filter[0] === entry.columnName)
); );
@@ -451,7 +451,7 @@ function initFilters() {
function renderFilters(customData) { function renderFilters(customData) {
// console.log(JSON.stringify(customData)); // console.log(JSON.stringify(customData));
// Load filter data from the JSON file // Load filter data from the JSON file
$.ajax({ $.ajax({
url: 'php/components/devices_filters.php', // PHP script URL url: 'php/components/devices_filters.php', // PHP script URL
@@ -471,7 +471,7 @@ function renderFilters(customData) {
// Update DataTable with the new filters or search value (if applicable) // Update DataTable with the new filters or search value (if applicable)
$('#tableDevices').DataTable().draw(); $('#tableDevices').DataTable().draw();
// Optionally, apply column filters (if using filters for individual columns) // Optionally, apply column filters (if using filters for individual columns)
const table = $('#tableDevices').DataTable(); const table = $('#tableDevices').DataTable();
table.columnFilters = columnFilters; // Apply your column filters logic table.columnFilters = columnFilters; // Apply your column filters logic
@@ -493,11 +493,11 @@ function collectFilters() {
// Loop through each filter group // Loop through each filter group
document.querySelectorAll('.filter-group').forEach(filterGroup => { document.querySelectorAll('.filter-group').forEach(filterGroup => {
const dropdown = filterGroup.querySelector('.filter-dropdown'); const dropdown = filterGroup.querySelector('.filter-dropdown');
if (dropdown) { if (dropdown) {
const filterColumn = dropdown.getAttribute('data-column'); const filterColumn = dropdown.getAttribute('data-column');
const filterValue = dropdown.value; const filterValue = dropdown.value;
if (filterValue && filterColumn) { if (filterValue && filterColumn) {
columnFilters.push({ columnFilters.push({
filterColumn: filterColumn, filterColumn: filterColumn,
@@ -548,7 +548,7 @@ function mapColumnIndexToFieldName(index, tableColumnVisible) {
"devReqNicsOnline" // 29 "devReqNicsOnline" // 29
]; ];
// console.log("OrderBy: " + columnNames[tableColumnOrder[index]]); // console.log("OrderBy: " + columnNames[tableColumnOrder[index]]);
return columnNames[tableColumnOrder[index]] || null; return columnNames[tableColumnOrder[index]] || null;
} }
@@ -557,12 +557,15 @@ function mapColumnIndexToFieldName(index, tableColumnVisible) {
// --------------------------------------------------------- // ---------------------------------------------------------
// Initializes the main devices list datatable // Initializes the main devices list datatable
function initializeDatatable (status) { function initializeDatatable (status) {
if(!status) if(!status)
{ {
status = 'my_devices' status = 'my_devices'
} }
// retrieve page size
var tableRows = getCache ("nax_parTableRows") == "" ? parseInt(getSetting("UI_DEFAULT_PAGE_SIZE")) : getCache ("nax_parTableRows") ;
// Save status selected // Save status selected
deviceStatus = status; deviceStatus = status;
@@ -579,7 +582,7 @@ function initializeDatatable (status) {
case 'all_devices': tableTitle = getString('Gen_All_Devices'); color = 'gray'; break; case 'all_devices': tableTitle = getString('Gen_All_Devices'); color = 'gray'; break;
case 'network_devices': tableTitle = getString('Network_Devices'); color = 'aqua'; break; case 'network_devices': tableTitle = getString('Network_Devices'); color = 'aqua'; break;
default: tableTitle = getString('Device_Shortcut_Devices'); color = 'gray'; break; default: tableTitle = getString('Device_Shortcut_Devices'); color = 'gray'; break;
} }
// Set title and color // Set title and color
$('#tableDevicesTitle')[0].className = 'box-title text-'+ color; $('#tableDevicesTitle')[0].className = 'box-title text-'+ color;
@@ -588,23 +591,23 @@ function initializeDatatable (status) {
// render table headers // render table headers
html = ''; html = '';
for(index = 0; index < tableColumnOrder.length; index++) for(index = 0; index < tableColumnOrder.length; index++)
{ {
html += '<th>' + headersDefaultOrder[tableColumnOrder[index]] + '</th>'; html += '<th>' + headersDefaultOrder[tableColumnOrder[index]] + '</th>';
} }
$('#tableDevices tr').html(html); $('#tableDevices tr').html(html);
hideUIelements("UI_DEV_SECTIONS") hideUIelements("UI_DEV_SECTIONS")
for(i = 0; i < tableColumnOrder.length; i++) for(i = 0; i < tableColumnOrder.length; i++)
{ {
// hide this column if not in the tableColumnVisible variable (we need to keep the MAC address (index 11) for functionality reasons) // hide this column if not in the tableColumnVisible variable (we need to keep the MAC address (index 11) for functionality reasons)
if(tableColumnVisible.includes(tableColumnOrder[i]) == false) if(tableColumnVisible.includes(tableColumnOrder[i]) == false)
{ {
tableColumnHide.push(mapIndx(tableColumnOrder[i])); tableColumnHide.push(mapIndx(tableColumnOrder[i]));
} }
} }
var table = $('#tableDevices').DataTable({ var table = $('#tableDevices').DataTable({
@@ -690,7 +693,7 @@ function initializeDatatable (status) {
"status": deviceStatus, "status": deviceStatus,
"filters" : columnFilters "filters" : columnFilters
} }
} }
}; };
@@ -766,8 +769,8 @@ function initializeDatatable (status) {
// Parameters // Parameters
'pageLength' : tableRows, 'pageLength' : tableRows,
'order' : tableOrder, 'order' : tableOrder,
'select' : true, // Enable selection 'select' : true, // Enable selection
'fixedHeader': true, 'fixedHeader': true,
'fixedHeader': { 'fixedHeader': {
@@ -776,19 +779,19 @@ function initializeDatatable (status) {
}, },
'columnDefs' : [ 'columnDefs' : [
{visible: false, targets: tableColumnHide }, {visible: false, targets: tableColumnHide },
{className: 'text-center', targets: [mapIndx(4), mapIndx(9), mapIndx(10), mapIndx(15), mapIndx(18)] }, {className: 'text-center', targets: [mapIndx(4), mapIndx(9), mapIndx(10), mapIndx(15), mapIndx(18)] },
{className: 'iconColumn text-center', targets: [mapIndx(3)]}, {className: 'iconColumn text-center', targets: [mapIndx(3)]},
{width: '80px', targets: [mapIndx(6), mapIndx(7), mapIndx(15), mapIndx(27)] }, {width: '80px', targets: [mapIndx(6), mapIndx(7), mapIndx(15), mapIndx(27)] },
{width: '85px', targets: [mapIndx(9)] }, {width: '85px', targets: [mapIndx(9)] },
{width: '30px', targets: [mapIndx(3), mapIndx(10), mapIndx(13), mapIndx(18)] }, {width: '30px', targets: [mapIndx(3), mapIndx(10), mapIndx(13), mapIndx(18)] },
{orderData: [mapIndx(12)], targets: mapIndx(8) }, {orderData: [mapIndx(12)], targets: mapIndx(8) },
// Device Name and FQDN // Device Name and FQDN
{targets: [mapIndx(0), mapIndx(27)], {targets: [mapIndx(0), mapIndx(27)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
// console.log(cellData) // console.log(cellData)
$(td).html ( $(td).html (
`<b class="anonymizeDev " `<b class="anonymizeDev "
> >
@@ -811,9 +814,9 @@ function initializeDatatable (status) {
); );
} }, } },
// Connected Devices // Connected Devices
{targets: [mapIndx(15)], {targets: [mapIndx(15)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
// check if this is a network device // check if this is a network device
if(getSetting("NETWORK_DEVICE_TYPES").includes(`'${rowData[mapIndx(2)]}'`) ) if(getSetting("NETWORK_DEVICE_TYPES").includes(`'${rowData[mapIndx(2)]}'`) )
{ {
@@ -823,13 +826,13 @@ function initializeDatatable (status) {
{ {
$(td).html (`<i class="fa-solid fa-xmark" title="${getString("Device_Table_Not_Network_Device")}"></i>`) $(td).html (`<i class="fa-solid fa-xmark" title="${getString("Device_Table_Not_Network_Device")}"></i>`)
} }
} }, } },
// Icon // Icon
{targets: [mapIndx(3)], {targets: [mapIndx(3)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
if (!emptyArr.includes(cellData)){ if (!emptyArr.includes(cellData)){
$(td).html (atob(cellData)); $(td).html (atob(cellData));
} else { } else {
@@ -837,7 +840,7 @@ function initializeDatatable (status) {
} }
} }, } },
// Full MAC // Full MAC
{targets: [mapIndx(11)], {targets: [mapIndx(11)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
if (!emptyArr.includes(cellData)){ if (!emptyArr.includes(cellData)){
@@ -846,8 +849,8 @@ function initializeDatatable (status) {
$(td).html (''); $(td).html ('');
} }
} }, } },
// IP address // IP address
{targets: [mapIndx(8)], {targets: [mapIndx(8)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
if (!emptyArr.includes(cellData)){ if (!emptyArr.includes(cellData)){
@@ -864,9 +867,9 @@ function initializeDatatable (status) {
} else { } else {
$(td).html (''); $(td).html ('');
} }
} }
}, },
// IP address (ordeable) // IP address (ordeable)
{targets: [mapIndx(12)], {targets: [mapIndx(12)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
if (!emptyArr.includes(cellData)){ if (!emptyArr.includes(cellData)){
@@ -874,10 +877,10 @@ function initializeDatatable (status) {
} else { } else {
$(td).html (''); $(td).html ('');
} }
} }
}, },
// Custom Properties // Custom Properties
{targets: [mapIndx(26)], {targets: [mapIndx(26)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
if (!emptyArr.includes(cellData)){ if (!emptyArr.includes(cellData)){
@@ -885,10 +888,10 @@ function initializeDatatable (status) {
} else { } else {
$(td).html (''); $(td).html ('');
} }
} }
}, },
// Favorite // Favorite
{targets: [mapIndx(4)], {targets: [mapIndx(4)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
if (cellData == 1){ if (cellData == 1){
@@ -897,8 +900,8 @@ function initializeDatatable (status) {
$(td).html (''); $(td).html ('');
} }
} }, } },
// Dates // Dates
{targets: [mapIndx(6), mapIndx(7)], {targets: [mapIndx(6), mapIndx(7)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
var result = cellData.toString(); // Convert to string var result = cellData.toString(); // Convert to string
@@ -908,7 +911,7 @@ function initializeDatatable (status) {
$(td).html (translateHTMLcodes (result)); $(td).html (translateHTMLcodes (result));
} }, } },
// Random MAC // Random MAC
{targets: [mapIndx(9)], {targets: [mapIndx(9)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
// console.log(cellData) // console.log(cellData)
@@ -919,7 +922,7 @@ function initializeDatatable (status) {
} }
} }, } },
// Parent Mac // Parent Mac
{targets: [mapIndx(14)], {targets: [mapIndx(14)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
if (!isValidMac(cellData)) { if (!isValidMac(cellData)) {
@@ -938,13 +941,13 @@ function initializeDatatable (status) {
const chipHtml = renderDeviceLink(data, spanWrap, true); // pass the td as container const chipHtml = renderDeviceLink(data, spanWrap, true); // pass the td as container
$(spanWrap).append(chipHtml); $(spanWrap).append(chipHtml);
} }
}, },
// Status color // Status color
{targets: [mapIndx(10)], {targets: [mapIndx(10)],
'createdCell': function (td, cellData, rowData, row, col) { 'createdCell': function (td, cellData, rowData, row, col) {
tmp_devPresentLastScan = rowData[mapIndx(24)] tmp_devPresentLastScan = rowData[mapIndx(24)]
tmp_devAlertDown = rowData[mapIndx(25)] tmp_devAlertDown = rowData[mapIndx(25)]
@@ -954,11 +957,11 @@ function initializeDatatable (status) {
rowData[mapIndx(11)], // MAC rowData[mapIndx(11)], // MAC
cellData // optional text cellData // optional text
); );
$(td).html (`<a href="${badge.url}" class="badge ${badge.cssClass}">${badge.iconHtml} ${badge.text}</a>`); $(td).html (`<a href="${badge.url}" class="badge ${badge.cssClass}">${badge.iconHtml} ${badge.text}</a>`);
} }, } },
], ],
// Processing // Processing
'processing' : true, 'processing' : true,
'language' : { 'language' : {
@@ -978,7 +981,7 @@ function initializeDatatable (status) {
$('#tableDevices').on( 'length.dt', function ( e, settings, len ) { $('#tableDevices').on( 'length.dt', function ( e, settings, len ) {
setCache ("nax_parTableRows", len, 129600); // save for 90 days setCache ("nax_parTableRows", len, 129600); // save for 90 days
} ); } );
$('#tableDevices').on( 'order.dt', function () { $('#tableDevices').on( 'order.dt', function () {
setCache ("nax_parTableOrder", JSON.stringify (table.order()), 129600); // save for 90 days setCache ("nax_parTableOrder", JSON.stringify (table.order()), 129600); // save for 90 days
} ); } );
@@ -998,7 +1001,7 @@ function initializeDatatable (status) {
// Toggle visibility of element with ID 'multiEdit' // Toggle visibility of element with ID 'multiEdit'
$('#multiEdit').toggle(anyRowSelected); $('#multiEdit').toggle(anyRowSelected);
}, 100); }, 100);
}); });
// search only after idle // search only after idle
@@ -1014,59 +1017,59 @@ function initializeDatatable (status) {
}, debounceTime); }, debounceTime);
}); });
initHoverNodeInfo(); initHoverNodeInfo();
hideSpinner(); hideSpinner();
}, },
createdRow: function(row, data, dataIndex) { createdRow: function(row, data, dataIndex) {
// add devMac to the table row // add devMac to the table row
$(row).attr('my-devMac', data[mapIndx(11)]); $(row).attr('my-devMac', data[mapIndx(11)]);
} }
}); });
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function handleLoadingDialog(needsReload = false) function handleLoadingDialog(needsReload = false)
{ {
// console.log(`needsReload: ${needsReload}`); // console.log(`needsReload: ${needsReload}`);
$.get('php/server/query_logs.php?file=execution_queue.log&nocache=' + Date.now(), function(data) { $.get('php/server/query_logs.php?file=execution_queue.log&nocache=' + Date.now(), function(data) {
if(data.includes("update_api|devices")) if(data.includes("update_api|devices"))
{ {
showSpinner("devices_old") showSpinner("devices_old")
setTimeout(handleLoadingDialog(true), 1000); setTimeout(handleLoadingDialog(true), 1000);
} else if (needsReload) } else if (needsReload)
{ {
location.reload(); location.reload();
}else }else
{ {
// hideSpinner(); // hideSpinner();
} }
}) })
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Function collects selected devices in the DataTable and redirects the user to // Function collects selected devices in the DataTable and redirects the user to
// the Miantenance section with a 'macs' query string identifying selected devices // the Miantenance section with a 'macs' query string identifying selected devices
function multiEditDevices() function multiEditDevices()
{ {
// get selected devices // get selected devices
var selectedDevicesDataTableData = $('#tableDevices').DataTable().rows({ selected: true, page: 'current' }).data().toArray(); var selectedDevicesDataTableData = $('#tableDevices').DataTable().rows({ selected: true, page: 'current' }).data().toArray();
console.log(selectedDevicesDataTableData); console.log(selectedDevicesDataTableData);
macs = "" macs = ""
for (var j = 0; j < selectedDevicesDataTableData.length; j++) { for (var j = 0; j < selectedDevicesDataTableData.length; j++) {
macs += selectedDevicesDataTableData[j][mapIndx(11)] + ","; // [11] == MAC macs += selectedDevicesDataTableData[j][mapIndx(11)] + ","; // [11] == MAC
} }
// redirect to the Maintenance section // redirect to the Maintenance section
@@ -1075,7 +1078,7 @@ function multiEditDevices()
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Function collects shown devices from the DataTable // Function collects shown devices from the DataTable
function getMacsOfShownDevices() { function getMacsOfShownDevices() {
var table = $('#tableDevices').DataTable(); var table = $('#tableDevices').DataTable();
@@ -1096,15 +1099,15 @@ function getMacsOfShownDevices() {
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Handle custom actions/properties on a device // Handle custom actions/properties on a device
function renderCustomProps(custProps, mac) { function renderCustomProps(custProps, mac) {
// Decode and parse the custom properties // Decode and parse the custom properties
if (!isBase64(custProps)) { if (!isBase64(custProps)) {
console.error(`Unable to decode CustomProps for ${mac}`); console.error(`Unable to decode CustomProps for ${mac}`);
console.error(custProps); console.error(custProps);
} else{ } else{
const props = JSON.parse(atob(custProps)); const props = JSON.parse(atob(custProps));
let html = ""; let html = "";
@@ -1150,13 +1153,13 @@ function renderCustomProps(custProps, mac) {
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Update cache with shown devices before navigating away // Update cache with shown devices before navigating away
window.addEventListener('beforeunload', function(event) { window.addEventListener('beforeunload', function(event) {
// Call your function here // Call your function here
macs = getMacsOfShownDevices(); macs = getMacsOfShownDevices();
setCache("ntx_visible_macs", macs) setCache("ntx_visible_macs", macs)
}); });
</script> </script>

View File

@@ -1,6 +1,6 @@
/* ----------------------------------------------------------------------------- /* -----------------------------------------------------------------------------
* NetAlertX * NetAlertX
* Open Source Network Guard / WIFI & LAN intrusion detector * Open Source Network Guard / WIFI & LAN intrusion detector
* *
* common.js - Front module. Common Javascript functions * common.js - Front module. Common Javascript functions
*------------------------------------------------------------------------------- *-------------------------------------------------------------------------------
@@ -12,7 +12,7 @@ var timerRefreshData = ''
var emptyArr = ['undefined', "", undefined, null, 'null']; var emptyArr = ['undefined', "", undefined, null, 'null'];
var UI_LANG = "English (en_us)"; var UI_LANG = "English (en_us)";
const allLanguages = ["ar_ar","ca_ca","cs_cz","de_de","en_us","es_es","fa_fa","fr_fr","it_it","nb_no","pl_pl","pt_br","pt_pt","ru_ru","sv_sv","tr_tr","uk_ua","zh_cn"]; // needs to be same as in lang.php const allLanguages = ["ar_ar","ca_ca","cs_cz","de_de","en_us","es_es","fa_fa","fr_fr","it_it","ja_jp","nb_no","pl_pl","pt_br","pt_pt","ru_ru","sv_sv","tr_tr","uk_ua","zh_cn"]; // needs to be same as in lang.php
var settingsJSON = {} var settingsJSON = {}
@@ -35,16 +35,16 @@ function getCache(key, noCookie = false)
// } // }
} }
return ""; return "";
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function setCache(key, data, expirationMinutes='') function setCache(key, data, expirationMinutes='')
{ {
localStorage.setItem(key, data); localStorage.setItem(key, data);
// // create cookie if expiration set to handle refresh of data // // create cookie if expiration set to handle refresh of data
// if (expirationMinutes != '') // if (expirationMinutes != '')
// { // {
// setCookie ('cache_session_expiry', 'OK', 1) // setCookie ('cache_session_expiry', 'OK', 1)
// } // }
@@ -57,7 +57,7 @@ function setCookie (cookie, value, expirationMinutes='') {
var expires = ''; var expires = '';
if (typeof expirationMinutes === 'number') { if (typeof expirationMinutes === 'number') {
expires = ';expires=' + new Date(Date.now() + expirationMinutes *60*1000).toUTCString(); expires = ';expires=' + new Date(Date.now() + expirationMinutes *60*1000).toUTCString();
} }
// Save Cookie // Save Cookie
document.cookie = cookie + "=" + value + expires; document.cookie = cookie + "=" + value + expires;
@@ -107,42 +107,42 @@ function deleteAllCookies() {
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Get settings from the .json file generated by the python backend // Get settings from the .json file generated by the python backend
// and cache them, if available, with options // and cache them, if available, with options
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function cacheSettings() function cacheSettings()
{ {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
if(!getCache('cacheSettings_completed') === true) if(!getCache('cacheSettings_completed') === true)
{ {
$.get('php/server/query_json.php', { file: 'table_settings.json', nocache: Date.now() }, function(resSet) { $.get('php/server/query_json.php', { file: 'table_settings.json', nocache: Date.now() }, function(resSet) {
$.get('php/server/query_json.php', { file: 'plugins.json', nocache: Date.now() }, function(resPlug) { $.get('php/server/query_json.php', { file: 'plugins.json', nocache: Date.now() }, function(resPlug) {
pluginsData = resPlug["data"];
settingsData = resSet["data"];
settingsData.forEach((set) => { pluginsData = resPlug["data"];
settingsData = resSet["data"];
settingsData.forEach((set) => {
resolvedOptions = createArray(set.setOptions) resolvedOptions = createArray(set.setOptions)
resolvedOptionsOld = resolvedOptions resolvedOptionsOld = resolvedOptions
setPlugObj = {}; setPlugObj = {};
options_params = []; options_params = [];
resolved = "" resolved = ""
// proceed only if first option item contains something to resolve // proceed only if first option item contains something to resolve
if( !set.setKey.includes("__metadata") && if( !set.setKey.includes("__metadata") &&
resolvedOptions.length != 0 && resolvedOptions.length != 0 &&
resolvedOptions[0].includes("{value}")) resolvedOptions[0].includes("{value}"))
{ {
// get setting definition from the plugin config if available // get setting definition from the plugin config if available
setPlugObj = getPluginSettingObject(pluginsData, set.setKey) setPlugObj = getPluginSettingObject(pluginsData, set.setKey)
// check if options contains parameters and resolve // check if options contains parameters and resolve
if(setPlugObj != {} && setPlugObj["options_params"]) if(setPlugObj != {} && setPlugObj["options_params"])
{ {
// get option_params for {value} resolution // get option_params for {value} resolution
options_params = setPlugObj["options_params"] options_params = setPlugObj["options_params"]
if(options_params != []) if(options_params != [])
{ {
@@ -154,19 +154,19 @@ function cacheSettings()
{ {
resolvedOptions = `[${resolved}]` resolvedOptions = `[${resolved}]`
} else // one value only } else // one value only
{ {
resolvedOptions = `["${resolved}"]` resolvedOptions = `["${resolved}"]`
} }
} }
} }
} }
setCache(`nax_set_${set.setKey}`, set.setValue) setCache(`nax_set_${set.setKey}`, set.setValue)
setCache(`nax_set_opt_${set.setKey}`, resolvedOptions) setCache(`nax_set_opt_${set.setKey}`, resolvedOptions)
}); });
}).then(() => handleSuccess('cacheSettings', resolve())).catch(() => handleFailure('cacheSettings', reject("cacheSettings already completed"))); // handle AJAX synchronization }).then(() => handleSuccess('cacheSettings', resolve())).catch(() => handleFailure('cacheSettings', reject("cacheSettings already completed"))); // handle AJAX synchronization
}) })
} }
}); });
} }
@@ -176,7 +176,7 @@ function getSettingOptions (key) {
// handle initial load to make sure everything is set-up and cached // handle initial load to make sure everything is set-up and cached
// handleFirstLoad() // handleFirstLoad()
result = getCache(`nax_set_opt_${key}`, true); result = getCache(`nax_set_opt_${key}`, true);
if (result == "") if (result == "")
@@ -194,7 +194,7 @@ function getSetting (key) {
// handle initial load to make sure everything is set-up and cached // handle initial load to make sure everything is set-up and cached
// handleFirstLoad() // handleFirstLoad()
result = getCache(`nax_set_${key}`, true); result = getCache(`nax_set_${key}`, true);
if (result == "") if (result == "")
@@ -210,7 +210,7 @@ function getSetting (key) {
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function cacheStrings() { function cacheStrings() {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
// Create a promise for each language (include en_us by default as fallback) // Create a promise for each language (include en_us by default as fallback)
languagesToLoad = ['en_us'] languagesToLoad = ['en_us']
@@ -222,11 +222,11 @@ function cacheStrings() {
} }
console.log(languagesToLoad); console.log(languagesToLoad);
const languagePromises = languagesToLoad.map((language_code) => { const languagePromises = languagesToLoad.map((language_code) => {
return new Promise((resolveLang, rejectLang) => { return new Promise((resolveLang, rejectLang) => {
// Fetch core strings and translations // Fetch core strings and translations
$.get(`php/templates/language/${language_code}.json?nocache=${Date.now()}`) $.get(`php/templates/language/${language_code}.json?nocache=${Date.now()}`)
.done((res) => { .done((res) => {
// Iterate over each key-value pair and store the translations // Iterate over each key-value pair and store the translations
@@ -238,7 +238,7 @@ function cacheStrings() {
$.get('php/server/query_json.php', { file: 'table_plugins_language_strings.json', nocache: Date.now() }) $.get('php/server/query_json.php', { file: 'table_plugins_language_strings.json', nocache: Date.now() })
.done((pluginRes) => { .done((pluginRes) => {
const data = pluginRes["data"]; const data = pluginRes["data"];
// Store plugin translations // Store plugin translations
data.forEach((langString) => { data.forEach((langString) => {
setCache(`pia_lang_${langString.String_Key}_${langString.Language_Code}`, langString.String_Value); setCache(`pia_lang_${langString.String_Key}_${langString.Language_Code}`, langString.String_Value);
@@ -269,7 +269,7 @@ function cacheStrings() {
// Handle failure in any of the language processing // Handle failure in any of the language processing
handleFailure('cacheStrings', reject); handleFailure('cacheStrings', reject);
}); });
}); });
} }
@@ -278,7 +278,7 @@ function cacheStrings() {
function getString(key) { function getString(key) {
function fetchString(key) { function fetchString(key) {
lang_code = getLangCode(); lang_code = getLangCode();
let result = getCache(`pia_lang_${key}_${lang_code}`, true); let result = getCache(`pia_lang_${key}_${lang_code}`, true);
@@ -343,6 +343,9 @@ function getLangCode() {
case 'Italian (it_it)': case 'Italian (it_it)':
lang_code = 'it_it'; lang_code = 'it_it';
break; break;
case 'Japanese (ja_jp)':
lang_code = 'ja_jp';
break;
case 'Russian (ru_ru)': case 'Russian (ru_ru)':
lang_code = 'ru_ru'; lang_code = 'ru_ru';
break; break;
@@ -375,7 +378,7 @@ function localizeTimestamp(input) {
let tz = getSetting("TIMEZONE") || 'Europe/Berlin'; let tz = getSetting("TIMEZONE") || 'Europe/Berlin';
input = String(input || '').trim(); input = String(input || '').trim();
// 1. Unix timestamps (10 or 13 digits) // 1. Unix timestamps (10 or 13 digits)
if (/^\d+$/.test(input)) { if (/^\d+$/.test(input)) {
const ms = input.length === 10 ? parseInt(input, 10) * 1000 : parseInt(input, 10); const ms = input.length === 10 ? parseInt(input, 10) * 1000 : parseInt(input, 10);
return new Intl.DateTimeFormat('default', { return new Intl.DateTimeFormat('default', {
@@ -386,39 +389,53 @@ function localizeTimestamp(input) {
}).format(new Date(ms)); }).format(new Date(ms));
} }
// 2. European DD/MM/YYYY // 2. European DD/MM/YYYY
let match = input.match(/^(\d{1,2})\/(\d{1,2})\/(\d{4})(?:[ ,]+(\d{1,2}:\d{2}(?::\d{2})?))?(.*)$/); let match = input.match(/^(\d{1,2})\/(\d{1,2})\/(\d{4})(?:[ ,]+(\d{1,2}:\d{2}(?::\d{2})?))?(.*)$/);
if (match) { if (match) {
let [ , d, m, y, t = "00:00:00", tzPart = "" ] = match; let [, d, m, y, t = "00:00:00", tzPart = ""] = match;
const iso = `${y}-${m.padStart(2,'0')}-${d.padStart(2,'0')}T${t.length===5?t+":00":t}${tzPart}`; const iso = `${y}-${m.padStart(2,'0')}-${d.padStart(2,'0')}T${t.length===5?t+":00":t}${tzPart}`;
return formatSafe(iso, tz); return formatSafe(iso, tz);
} }
// 3. US MM/DD/YYYY // 3. US MM/DD/YYYY
match = input.match(/^(\d{1,2})\/(\d{1,2})\/(\d{4})(?:[ ,]+(\d{1,2}:\d{2}(?::\d{2})?))?(.*)$/); match = input.match(/^(\d{1,2})\/(\d{1,2})\/(\d{4})(?:[ ,]+(\d{1,2}:\d{2}(?::\d{2})?))?(.*)$/);
if (match) { if (match) {
let [ , m, d, y, t = "00:00:00", tzPart = "" ] = match; let [, m, d, y, t = "00:00:00", tzPart = ""] = match;
const iso = `${y}-${m.padStart(2,'0')}-${d.padStart(2,'0')}T${t.length===5?t+":00":t}${tzPart}`; const iso = `${y}-${m.padStart(2,'0')}-${d.padStart(2,'0')}T${t.length===5?t+":00":t}${tzPart}`;
return formatSafe(iso, tz); return formatSafe(iso, tz);
} }
// 4. ISO-style (with T, Z, offsets) // 4. ISO YYYY-MM-DD with optional Z/+offset
match = input.match(/^(\d{4}-\d{1,2}-\d{1,2})[ T](\d{1,2}:\d{2}(?::\d{2})?)(Z|[+-]\d{2}:?\d{2})?$/); match = input.match(/^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])[ T](\d{1,2}:\d{2}(?::\d{2})?)(Z|[+-]\d{2}:?\d{2})?$/);
if (match) { if (match) {
let [ , ymd, time, offset = "" ] = match; let [, y, m, d, time, offset = ""] = match;
// normalize to YYYY-MM-DD
let [y, m, d] = ymd.split('-').map(x => x.padStart(2,'0'));
const iso = `${y}-${m}-${d}T${time.length===5?time+":00":time}${offset}`; const iso = `${y}-${m}-${d}T${time.length===5?time+":00":time}${offset}`;
return formatSafe(iso, tz); return formatSafe(iso, tz);
} }
// 5. RFC2822 / "25 Aug 2025 13:45:22 +0200" // 5. RFC2822 / "25 Aug 2025 13:45:22 +0200"
match = input.match(/^\d{1,2} [A-Za-z]{3,} \d{4}/); match = input.match(/^\d{1,2} [A-Za-z]{3,} \d{4}/);
if (match) { if (match) {
return formatSafe(input, tz); return formatSafe(input, tz);
} }
// 6. Fallback (whatever Date() can parse) // 6. DD-MM-YYYY with optional time
match = input.match(/^(\d{1,2})-(\d{1,2})-(\d{4})(?:[ T](\d{1,2}:\d{2}(?::\d{2})?))?$/);
if (match) {
let [, d, m, y, time = "00:00:00"] = match;
const iso = `${y}-${m.padStart(2,'0')}-${d.padStart(2,'0')}T${time.length===5?time+":00":time}`;
return formatSafe(iso, tz);
}
// 7. Strict YYYY-DD-MM with optional time
match = input.match(/^(\d{4})-(0[1-9]|[12]\d|3[01])-(0[1-9]|1[0-2])(?:[ T](\d{1,2}:\d{2}(?::\d{2})?))?$/);
if (match) {
let [, y, d, m, time = "00:00:00"] = match;
const iso = `${y}-${m}-${d}T${time.length === 5 ? time + ":00" : time}`;
return formatSafe(iso, tz);
}
// 8. Fallback
return formatSafe(input, tz); return formatSafe(input, tz);
function formatSafe(str, tz) { function formatSafe(str, tz) {
@@ -437,6 +454,7 @@ function localizeTimestamp(input) {
} }
// ---------------------------------------------------- // ----------------------------------------------------
/** /**
* Replaces double quotes within single-quoted strings, then converts all single quotes to double quotes, * Replaces double quotes within single-quoted strings, then converts all single quotes to double quotes,
@@ -497,11 +515,39 @@ function isValidBase64(str) {
// ------------------------------------------------------------------- // -------------------------------------------------------------------
// Utility function to check if the value is already Base64 // Utility function to check if the value is already Base64
function isBase64(value) { function isBase64(value) {
const base64Regex = if (typeof value !== "string" || value.trim() === "") return false;
/^(?:[A-Za-z0-9+\/]{4})*?(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/;
return base64Regex.test(value); // Must have valid length
if (value.length % 4 !== 0) return false;
// Valid Base64 characters
const base64Regex = /^[A-Za-z0-9+/]+={0,2}$/;
if (!base64Regex.test(value)) return false;
try {
const decoded = atob(value);
// Re-encode
const reencoded = btoa(decoded);
if (reencoded !== value) return false;
// Extra verification:
// Ensure decoding didn't silently drop bytes (atob bug)
// Encode raw bytes: check if large char codes exist (invalid UTF-16)
for (let i = 0; i < decoded.length; i++) {
const code = decoded.charCodeAt(i);
if (code > 255) return false; // invalid binary byte
}
return true;
} catch (e) {
return false;
}
} }
// ---------------------------------------------------- // ----------------------------------------------------
function isValidJSON(jsonString) { function isValidJSON(jsonString) {
try { try {
@@ -537,7 +583,7 @@ function decodeSpecialChars(str) {
function utf8ToBase64(str) { function utf8ToBase64(str) {
// Convert the string to a Uint8Array using TextEncoder // Convert the string to a Uint8Array using TextEncoder
const utf8Bytes = new TextEncoder().encode(str); const utf8Bytes = new TextEncoder().encode(str);
// Convert the Uint8Array to a base64-encoded string // Convert the Uint8Array to a base64-encoded string
return btoa(String.fromCharCode(...utf8Bytes)); return btoa(String.fromCharCode(...utf8Bytes));
} }
@@ -566,31 +612,31 @@ function handle_locked_DB(data)
{ {
if(data.includes('database is locked')) if(data.includes('database is locked'))
{ {
// console.log(data) // console.log(data)
showSpinner() showSpinner()
setTimeout(function() { setTimeout(function() {
console.warn("Database locked - reload") console.warn("Database locked - reload")
location.reload(); location.reload();
}, 5000); }, 5000);
} }
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function numberArrayFromString(data) function numberArrayFromString(data)
{ {
data = JSON.parse(sanitize(data)); data = JSON.parse(sanitize(data));
return data.replace(/\[|\]/g, '').split(',').map(Number); return data.replace(/\[|\]/g, '').split(',').map(Number);
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function saveData(functionName, id, value) { function saveData(functionName, id, value) {
$.ajax({ $.ajax({
method: "GET", method: "GET",
url: "php/server/devices.php", url: "php/server/devices.php",
data: { action: functionName, id: id, value:value }, data: { action: functionName, id: id, value:value },
success: function(data) { success: function(data) {
if(sanitize(data) == 'OK') if(sanitize(data) == 'OK')
{ {
showMessage("Saved") showMessage("Saved")
@@ -599,7 +645,7 @@ function saveData(functionName, id, value) {
} else } else
{ {
showMessage("ERROR") showMessage("ERROR")
} }
} }
}); });
@@ -639,13 +685,13 @@ function sleep(milliseconds) {
} while (currentDate - date < milliseconds); } while (currentDate - date < milliseconds);
} }
// --------------------------------------------------------- // ---------------------------------------------------------
somethingChanged = false; somethingChanged = false;
function settingsChanged() function settingsChanged()
{ {
somethingChanged = true; somethingChanged = true;
// Enable navigation prompt ... "Are you sure you want to leave..." // Enable navigation prompt ... "Are you sure you want to leave..."
window.onbeforeunload = function() { window.onbeforeunload = function() {
return true; return true;
}; };
} }
@@ -663,16 +709,16 @@ function getUrlAnchor(defaultValue){
selectedTab = defaultValue selectedTab = defaultValue
// the #target from the url // the #target from the url
target = window.location.hash.substr(1) target = window.location.hash.substr(1)
// get only the part between #...? // get only the part between #...?
if(target.includes('?')) if(target.includes('?'))
{ {
target = target.split('?')[0] target = target.split('?')[0]
} }
return target return target
} }
} }
@@ -684,7 +730,7 @@ function getQueryString(key){
get: (searchParams, prop) => searchParams.get(prop), get: (searchParams, prop) => searchParams.get(prop),
}); });
tmp = params[key] tmp = params[key]
if(emptyArr.includes(tmp)) if(emptyArr.includes(tmp))
{ {
@@ -695,17 +741,17 @@ function getQueryString(key){
if (fullUrl.includes('?')) { if (fullUrl.includes('?')) {
var queryString = fullUrl.split('?')[1]; var queryString = fullUrl.split('?')[1];
// Split the query string into individual parameters // Split the query string into individual parameters
var paramsArray = queryString.split('&'); var paramsArray = queryString.split('&');
// Loop through the parameters array // Loop through the parameters array
paramsArray.forEach(function(param) { paramsArray.forEach(function(param) {
// Split each parameter into key and value // Split each parameter into key and value
var keyValue = param.split('='); var keyValue = param.split('=');
var keyTmp = decodeURIComponent(keyValue[0]); var keyTmp = decodeURIComponent(keyValue[0]);
var value = decodeURIComponent(keyValue[1] || ''); var value = decodeURIComponent(keyValue[1] || '');
// Store key-value pair in the queryParams object // Store key-value pair in the queryParams object
queryParams[keyTmp] = value; queryParams[keyTmp] = value;
}); });
@@ -719,7 +765,7 @@ function getQueryString(key){
result = emptyArr.includes(tmp) ? "" : tmp; result = emptyArr.includes(tmp) ? "" : tmp;
return result return result
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function translateHTMLcodes (text) { function translateHTMLcodes (text) {
if (text == null || emptyArr.includes(text)) { if (text == null || emptyArr.includes(text)) {
@@ -738,14 +784,14 @@ function translateHTMLcodes (text) {
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function stopTimerRefreshData () { function stopTimerRefreshData () {
try { try {
clearTimeout (timerRefreshData); clearTimeout (timerRefreshData);
} catch (e) {} } catch (e) {}
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function newTimerRefreshData (refeshFunction, timeToRefresh) { function newTimerRefreshData (refeshFunction, timeToRefresh) {
if(timeToRefresh && (timeToRefresh != 0 || timeToRefresh != "")) if(timeToRefresh && (timeToRefresh != 0 || timeToRefresh != ""))
{ {
time = parseInt(timeToRefresh) time = parseInt(timeToRefresh)
@@ -782,7 +828,7 @@ function openInNewTab (url) {
window.open(url, "_blank"); window.open(url, "_blank");
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Navigate to URL if the current URL is not in the provided list of URLs // Navigate to URL if the current URL is not in the provided list of URLs
function openUrl(urls) { function openUrl(urls) {
var currentUrl = window.location.href; var currentUrl = window.location.href;
@@ -813,21 +859,21 @@ function openUrl(urls) {
function forceLoadUrl(relativeUrl) { function forceLoadUrl(relativeUrl) {
window.location.replace(relativeUrl); window.location.replace(relativeUrl);
window.location.reload() window.location.reload()
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function navigateToDeviceWithIp (ip) { function navigateToDeviceWithIp (ip) {
$.get('php/server/query_json.php', { file: 'table_devices.json', nocache: Date.now() }, function(res) { $.get('php/server/query_json.php', { file: 'table_devices.json', nocache: Date.now() }, function(res) {
devices = res["data"]; devices = res["data"];
mac = "" mac = ""
$.each(devices, function(index, obj) { $.each(devices, function(index, obj) {
if(obj.devLastIP.trim() == ip.trim()) if(obj.devLastIP.trim() == ip.trim())
{ {
mac = obj.devMac; mac = obj.devMac;
@@ -835,7 +881,7 @@ function navigateToDeviceWithIp (ip) {
window.open('./deviceDetails.php?mac=' + mac , "_blank"); window.open('./deviceDetails.php?mac=' + mac , "_blank");
} }
}); });
}); });
} }
@@ -867,7 +913,7 @@ function getMac(){
}); });
return params.mac return params.mac
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// A function used to make the IP address orderable // A function used to make the IP address orderable
@@ -919,7 +965,7 @@ function isRandomMAC(mac)
{ {
isRandom = false; isRandom = false;
isRandom = ["2", "6", "A", "E", "a", "e"].includes(mac[1]); isRandom = ["2", "6", "A", "E", "a", "e"].includes(mac[1]);
// if detected as random, make sure it doesn't start with a prefix which teh suer doesn't want to mark as random // if detected as random, make sure it doesn't start with a prefix which teh suer doesn't want to mark as random
if(isRandom) if(isRandom)
@@ -928,17 +974,17 @@ function isRandomMAC(mac)
if(mac.startsWith(prefix)) if(mac.startsWith(prefix))
{ {
isRandom = false; isRandom = false;
} }
}); });
} }
return isRandom; return isRandom;
} }
// --------------------------------------------------------- // ---------------------------------------------------------
// Generate an array object from a string representation of an array // Generate an array object from a string representation of an array
function createArray(input) { function createArray(input) {
// Is already array, return // Is already array, return
@@ -949,25 +995,25 @@ function isRandomMAC(mac)
if (input === '[]' || input === '') { if (input === '[]' || input === '') {
return []; return [];
} }
// handle integer // handle integer
if (typeof input === 'number') { if (typeof input === 'number') {
input = input.toString(); input = input.toString();
} }
// Regex pattern for brackets // Regex pattern for brackets
const patternBrackets = /(^\s*\[)|(\]\s*$)/g; const patternBrackets = /(^\s*\[)|(\]\s*$)/g;
const replacement = ''; const replacement = '';
// Remove brackets // Remove brackets
const noBrackets = input.replace(patternBrackets, replacement); const noBrackets = input.replace(patternBrackets, replacement);
const options = []; const options = [];
// Detect the type of quote used after the opening bracket // Detect the type of quote used after the opening bracket
const firstChar = noBrackets.trim()[0]; const firstChar = noBrackets.trim()[0];
const isDoubleQuoted = firstChar === '"'; const isDoubleQuoted = firstChar === '"';
const isSingleQuoted = firstChar === "'"; const isSingleQuoted = firstChar === "'";
// Create array while handling commas within quoted segments // Create array while handling commas within quoted segments
let currentSegment = ''; let currentSegment = '';
let withinQuotes = false; let withinQuotes = false;
@@ -985,7 +1031,7 @@ function isRandomMAC(mac)
} }
// Push the last segment // Push the last segment
options.push(currentSegment.trim()); options.push(currentSegment.trim());
// Remove quotes based on detected type // Remove quotes based on detected type
options.forEach((item, index) => { options.forEach((item, index) => {
let trimmedItem = item.trim(); let trimmedItem = item.trim();
@@ -997,7 +1043,7 @@ function isRandomMAC(mac)
} }
options[index] = trimmedItem; options[index] = trimmedItem;
}); });
return options; return options;
} }
@@ -1006,7 +1052,7 @@ function isRandomMAC(mac)
// for the value to be returned // for the value to be returned
function getDevDataByMac(macAddress, dbColumn) { function getDevDataByMac(macAddress, dbColumn) {
const sessionDataKey = 'devicesListAll_JSON'; const sessionDataKey = 'devicesListAll_JSON';
const devicesCache = getCache(sessionDataKey); const devicesCache = getCache(sessionDataKey);
if (!devicesCache || devicesCache == "") { if (!devicesCache || devicesCache == "") {
@@ -1037,11 +1083,11 @@ function getDevDataByMac(macAddress, dbColumn) {
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Cache the devices as one JSON // Cache the devices as one JSON
function cacheDevices() function cacheDevices()
{ {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
$.get('php/server/query_json.php', { file: 'table_devices.json', nocache: Date.now() }, function(data) { $.get('php/server/query_json.php', { file: 'table_devices.json', nocache: Date.now() }, function(data) {
// console.log(data) // console.log(data)
devicesListAll_JSON = data["data"] devicesListAll_JSON = data["data"]
@@ -1062,11 +1108,11 @@ function cacheDevices()
// console.log(getCache('devicesListAll_JSON')) // console.log(getCache('devicesListAll_JSON'))
}).then(() => handleSuccess('cacheDevices', resolve())).catch(() => handleFailure('cacheDevices', reject("cacheDevices already completed"))); // handle AJAX synchronization }).then(() => handleSuccess('cacheDevices', resolve())).catch(() => handleFailure('cacheDevices', reject("cacheDevices already completed"))); // handle AJAX synchronization
} }
); );
} }
var devicesListAll_JSON = []; // this will contain a list off all devices var devicesListAll_JSON = []; // this will contain a list off all devices
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function isEmpty(value) function isEmpty(value)
@@ -1096,7 +1142,7 @@ function getGuid() {
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// UI // UI
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
@@ -1199,7 +1245,7 @@ function hideSpinner() {
}); });
} }
// -------------------------------------------------------- // --------------------------------------------------------
// Calls a backend function to add a front-end event to an execution queue // Calls a backend function to add a front-end event to an execution queue
function updateApi(apiEndpoints) function updateApi(apiEndpoints)
@@ -1219,9 +1265,9 @@ function updateApi(apiEndpoints)
}) })
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// handling smooth scrolling // handling smooth scrolling
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
function setupSmoothScrolling() { function setupSmoothScrolling() {
// Function to scroll to the element // Function to scroll to the element
function scrollToElement(id) { function scrollToElement(id) {
@@ -1279,17 +1325,17 @@ function getPluginSettingObject(pluginsData, setting_key, unique_prefix ) {
result = {} result = {}
unique_prefix == undefined ? unique_prefix = setting_key.split("_")[0] : unique_prefix = unique_prefix; unique_prefix == undefined ? unique_prefix = setting_key.split("_")[0] : unique_prefix = unique_prefix;
$.each(pluginsData, function (i, plgnObj){ $.each(pluginsData, function (i, plgnObj){
// go thru plugins // go thru plugins
if(plgnObj.unique_prefix == unique_prefix) if(plgnObj.unique_prefix == unique_prefix)
{ {
// go thru plugin settings // go thru plugin settings
$.each(plgnObj["settings"], function (j, setObj){ $.each(plgnObj["settings"], function (j, setObj){
if(`${unique_prefix}_${setObj.function}` == setting_key) if(`${unique_prefix}_${setObj.function}` == setting_key)
{ {
result = setObj result = setObj
} }
}); });
@@ -1341,7 +1387,7 @@ function arraysContainSameValues(arr1, arr2) {
if (!Array.isArray(arr1) || !Array.isArray(arr2)) { if (!Array.isArray(arr1) || !Array.isArray(arr2)) {
return false; return false;
} else } else
{ {
// Sort and stringify arrays, then compare // Sort and stringify arrays, then compare
return JSON.stringify(arr1.slice().sort()) === JSON.stringify(arr2.slice().sort()); return JSON.stringify(arr1.slice().sort()) === JSON.stringify(arr2.slice().sort());
} }
@@ -1352,7 +1398,7 @@ function arraysContainSameValues(arr1, arr2) {
function hideUIelements(setKey) { function hideUIelements(setKey) {
hiddenSectionsSetting = getSetting(setKey) hiddenSectionsSetting = getSetting(setKey)
if(hiddenSectionsSetting != "") // handle if settings not yet initialized if(hiddenSectionsSetting != "") // handle if settings not yet initialized
{ {
@@ -1367,9 +1413,9 @@ function hideUIelements(setKey) {
if($('#' + hiddenSection)) if($('#' + hiddenSection))
{ {
$('#' + hiddenSection).hide() $('#' + hiddenSection).hide()
} }
}); });
} }
@@ -1380,7 +1426,7 @@ function getDevicesList()
{ {
// Read cache (skip cookie expiry check) // Read cache (skip cookie expiry check)
devicesList = getCache('devicesListAll_JSON', true); devicesList = getCache('devicesListAll_JSON', true);
if (devicesList != '') { if (devicesList != '') {
devicesList = JSON.parse (devicesList); devicesList = JSON.parse (devicesList);
} else { } else {
@@ -1437,7 +1483,7 @@ $(document).ready(function() {
// Restart Backend Python Server // Restart Backend Python Server
function askRestartBackend() { function askRestartBackend() {
// Ask // Ask
showModalWarning(getString('Maint_RestartServer'), getString('Maint_Restart_Server_noti_text'), showModalWarning(getString('Maint_RestartServer'), getString('Maint_Restart_Server_noti_text'),
getString('Gen_Cancel'), getString('Maint_RestartServer'), 'restartBackend'); getString('Gen_Cancel'), getString('Maint_RestartServer'), 'restartBackend');
} }
@@ -1446,7 +1492,7 @@ function askRestartBackend() {
function restartBackend() { function restartBackend() {
modalEventStatusId = 'modal-message-front-event' modalEventStatusId = 'modal-message-front-event'
// Execute // Execute
$.ajax({ $.ajax({
method: "POST", method: "POST",
@@ -1492,7 +1538,7 @@ function clearCache() {
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Function to check if cache needs to be refreshed because of setting changes // Function to check if cache needs to be refreshed because of setting changes
function checkSettingChanges() { function checkSettingChanges() {
$.get('php/server/query_json.php', { file: 'app_state.json', nocache: Date.now() }, function(appState) { $.get('php/server/query_json.php', { file: 'app_state.json', nocache: Date.now() }, function(appState) {
const importedMilliseconds = parseInt(appState["settingsImported"] * 1000); const importedMilliseconds = parseInt(appState["settingsImported"] * 1000);
const lastReloaded = parseInt(sessionStorage.getItem(sessionStorageKey + '_time')); const lastReloaded = parseInt(sessionStorage.getItem(sessionStorageKey + '_time'));
@@ -1563,7 +1609,7 @@ function isAppInitialized() {
lang_shouldBeCompletedCalls = getLangCode() == 'en_us' ? 1 : 2; lang_shouldBeCompletedCalls = getLangCode() == 'en_us' ? 1 : 2;
// check if each ajax call completed succesfully // check if each ajax call completed succesfully
$.each(completedCalls_final, function(index, call_name){ $.each(completedCalls_final, function(index, call_name){
if(getCache(call_name + "_completed") != "true") if(getCache(call_name + "_completed") != "true")
@@ -1591,15 +1637,14 @@ async function executeOnce() {
if (!isAppInitialized()) { if (!isAppInitialized()) {
try { try {
console.log("HERE");
await waitForGraphQLServer(); // Wait for the server to start await waitForGraphQLServer(); // Wait for the server to start
await cacheDevices(); await cacheDevices();
await cacheSettings(); await cacheSettings();
await cacheStrings(); await cacheStrings();
console.log("All AJAX callbacks have completed"); console.log("All AJAX callbacks have completed");
onAllCallsComplete(); onAllCallsComplete();
} catch (error) { } catch (error) {
console.error("Error:", error); console.error("Error:", error);
@@ -1649,7 +1694,7 @@ const onAllCallsComplete = () => {
// setTimeout(() => { // setTimeout(() => {
// location.reload() // location.reload()
// }, 10); // }, 10);
} else { } else {
// If not all strings are initialized, retry initialization // If not all strings are initialized, retry initialization
console.log('❌ Not all strings are initialized. Retrying...'); console.log('❌ Not all strings are initialized. Retrying...');
@@ -1671,7 +1716,7 @@ const areAllStringsInitialized = () => {
// Call the function to execute the code // Call the function to execute the code
executeOnce(); executeOnce();
// Set timer for regular UI refresh if enabled // Set timer for regular UI refresh if enabled
setTimeout(() => { setTimeout(() => {
// page refresh if configured // page refresh if configured

View File

@@ -96,7 +96,7 @@ function showModalInput(
btnOK = getString("Gen_Okay"), btnOK = getString("Gen_Okay"),
callbackFunction = null, callbackFunction = null,
triggeredBy = null, triggeredBy = null,
defaultValue = "" defaultValue = ""
) { ) {
prefix = "modal-input"; prefix = "modal-input";
@@ -121,7 +121,7 @@ function showModalInput(
setTimeout(function () { setTimeout(function () {
$(`#${prefix}-textarea`).focus(); $(`#${prefix}-textarea`).focus();
}, 500); }, 500);
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
@@ -143,7 +143,7 @@ function showModalFieldInput(
$(`#${prefix}-OK`).html(btnOK); $(`#${prefix}-OK`).html(btnOK);
if (callbackFunction != null) { if (callbackFunction != null) {
modalCallbackFunction = callbackFunction; modalCallbackFunction = callbackFunction;
} }
@@ -181,11 +181,11 @@ function showModalPopupForm(
$(`#${prefix}-cancel`).html(btnCancel); $(`#${prefix}-cancel`).html(btnCancel);
$(`#${prefix}-OK`).html(btnOK); $(`#${prefix}-OK`).html(btnOK);
// if curValue not null // if curValue not null
if (curValue) if (curValue)
{ {
initialValues = JSON.parse(atob(curValue)); initialValues = JSON.parse(atob(curValue));
} }
outputHtml = ""; outputHtml = "";
@@ -193,7 +193,7 @@ function showModalPopupForm(
if (Array.isArray(popupFormJson)) { if (Array.isArray(popupFormJson)) {
popupFormJson.forEach((field, index) => { popupFormJson.forEach((field, index) => {
// You'll need to define these or map them from `field` // You'll need to define these or map them from `field`
const setKey = field.function || `field_${index}`; const setKey = field.function || `field_${index}`;
const setName = getString(`${parentSettingKey}_popupform_${setKey}_name`); const setName = getString(`${parentSettingKey}_popupform_${setKey}_name`);
const labelClasses = "col-sm-2"; // example, or from your obj.labelClasses const labelClasses = "col-sm-2"; // example, or from your obj.labelClasses
const inputClasses = "col-sm-10"; // example, or from your obj.inputClasses const inputClasses = "col-sm-10"; // example, or from your obj.inputClasses
@@ -207,9 +207,9 @@ function showModalPopupForm(
} }
} }
const fieldOptionsOverride = field.type?.elements[0]?.elementOptions || []; const fieldOptionsOverride = field.type?.elements[0]?.elementOptions || [];
const setValue = initialValue; const setValue = initialValue;
const setType = JSON.stringify(field.type); const setType = JSON.stringify(field.type);
const setEvents = field.events || []; // default to empty array if missing const setEvents = field.events || []; // default to empty array if missing
const setObj = { setKey, setValue, setType, setEvents }; const setObj = { setKey, setValue, setType, setEvents };
@@ -218,17 +218,17 @@ function showModalPopupForm(
<div class="form-group col-xs-12"> <div class="form-group col-xs-12">
<label id="${setKey}_label" class="${labelClasses}"> ${setName} <label id="${setKey}_label" class="${labelClasses}"> ${setName}
<i my-set-key="${parentSettingKey}_popupform_${setKey}" <i my-set-key="${parentSettingKey}_popupform_${setKey}"
title="${getString("Settings_Show_Description")}" title="${getString("Settings_Show_Description")}"
class="fa fa-circle-info pointer helpIconSmallTopRight" class="fa fa-circle-info pointer helpIconSmallTopRight"
onclick="showDescriptionPopup(this)"> onclick="showDescriptionPopup(this)">
</i> </i>
</label> </label>
<div class="${inputClasses}"> <div class="${inputClasses}">
${generateFormHtml( ${generateFormHtml(
null, // settingsData only required for datatables null, // settingsData only required for datatables
setObj, setObj,
null, null,
fieldOptionsOverride, fieldOptionsOverride,
null null
)} )}
</div> </div>
@@ -239,7 +239,7 @@ function showModalPopupForm(
outputHtml += inputFormHtml; outputHtml += inputFormHtml;
}); });
} }
$(`#modal-form-plc`).html(outputHtml); $(`#modal-form-plc`).html(outputHtml);
// Bind OK button click event // Bind OK button click event
@@ -247,12 +247,19 @@ function showModalPopupForm(
let settingsArray = []; let settingsArray = [];
if (Array.isArray(popupFormJson)) { if (Array.isArray(popupFormJson)) {
popupFormJson.forEach(field => { popupFormJson.forEach(field => {
collectSetting( const result = collectSetting(
`${parentSettingKey}_popupform`, // prefix `${parentSettingKey}_popupform`, // prefix
field.function, // setCodeName field.function, // setCodeName
field.type, // setType (object) field.type, // setType (object)
settingsArray settingsArray
); );
settingsArray = result.settingsArray;
if (!result.dataIsValid) {
msg = getString("Gen_Invalid_Value") + ":" + result.failedSettingKey;
console.error(msg);
showModalOk("ERROR", msg);
}
}); });
} }
@@ -276,7 +283,7 @@ function showModalPopupForm(
const newOption = $("<option class='interactable-option'></option>") const newOption = $("<option class='interactable-option'></option>")
.attr("value", encodedValue) .attr("value", encodedValue)
.text(label); .text(label);
$("#" + selectId).append(newOption); $("#" + selectId).append(newOption);
initListInteractionOptions(newOption); initListInteractionOptions(newOption);
} }
@@ -429,10 +436,10 @@ function safeDecodeURIComponent(content) {
return content; // Return the original content if decoding fails return content; // Return the original content if decoding fails
} }
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Backend notification Polling // Backend notification Polling
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Function to check for notifications // Function to check for notifications
function checkNotification() { function checkNotification() {
@@ -440,7 +447,7 @@ function checkNotification() {
const phpEndpoint = 'php/server/utilNotification.php'; const phpEndpoint = 'php/server/utilNotification.php';
$.ajax({ $.ajax({
url: notificationEndpoint, url: notificationEndpoint,
type: 'GET', type: 'GET',
success: function(response) { success: function(response) {
// console.log(response); // console.log(response);
@@ -492,7 +499,7 @@ function checkNotification() {
}, },
error: function() { error: function() {
console.warn(`🟥 Error checking ${notificationEndpoint}`) console.warn(`🟥 Error checking ${notificationEndpoint}`)
} }
}); });
} }
@@ -582,7 +589,7 @@ const phpEndpoint = 'php/server/utilNotification.php';
// -------------------------------------------------- // --------------------------------------------------
// Write a notification // Write a notification
function write_notification(content, level) { function write_notification(content, level) {
$.ajax({ $.ajax({
url: phpEndpoint, // Change this to the path of your PHP script url: phpEndpoint, // Change this to the path of your PHP script
@@ -603,8 +610,8 @@ function write_notification(content, level) {
// -------------------------------------------------- // --------------------------------------------------
// Write a notification // Write a notification
function markNotificationAsRead(guid) { function markNotificationAsRead(guid) {
$.ajax({ $.ajax({
url: phpEndpoint, url: phpEndpoint,
type: 'GET', type: 'GET',
@@ -628,8 +635,8 @@ function markNotificationAsRead(guid) {
// -------------------------------------------------- // --------------------------------------------------
// Remove a notification // Remove a notification
function removeNotification(guid) { function removeNotification(guid) {
$.ajax({ $.ajax({
url: phpEndpoint, url: phpEndpoint,
type: 'GET', type: 'GET',

View File

@@ -71,7 +71,7 @@ function getPluginConfig(pluginsData, prefix) {
// Show the description of a setting // Show the description of a setting
function showDescriptionPopup(e) { function showDescriptionPopup(e) {
console.log($(e).attr("my-set-key")); console.log($(e).attr("my-set-key"));
showModalOK("Info", getString($(e).attr("my-set-key") + '_description')) showModalOK("Info", getString($(e).attr("my-set-key") + '_description'))
} }
@@ -92,13 +92,13 @@ function pluginCards(prefixesOfEnabledPlugins, includeSettings) {
prefix + "_" + set prefix + "_" + set
}"> }">
<code>${getSetting(prefix + "_" + set)}</code> <code>${getSetting(prefix + "_" + set)}</code>
</div> </div>
</a> </a>
</div> </div>
`; `;
}); });
html += ` html += `
<div class="col-xs-6 col-sm-4 col-md-3 col-lg-2 col-xxl-1 padding-5px"> <div class="col-xs-6 col-sm-4 col-md-3 col-lg-2 col-xxl-1 padding-5px">
<div class="small-box bg-green col-sm-12 " > <div class="small-box bg-green col-sm-12 " >
<div class="inner col-sm-12"> <div class="inner col-sm-12">
@@ -110,10 +110,10 @@ function pluginCards(prefixesOfEnabledPlugins, includeSettings) {
${includeSettings_html} ${includeSettings_html}
</div> </div>
<a href="#${prefix}_header" onclick="toggleAllSettings('open')"> <a href="#${prefix}_header" onclick="toggleAllSettings('open')">
<div class="icon"> ${getString(prefix + "_icon")} </div> <div class="icon"> ${getString(prefix + "_icon")} </div>
</a> </a>
</div> </div>
</div> </div>
`; `;
}); });
@@ -251,17 +251,17 @@ function settingsCollectedCorrectly(settingsArray, settingsJSON_DB) {
function cloneDataTableRow(el){ function cloneDataTableRow(el){
console.log(el); console.log(el);
const id = "NEWDEV_devCustomProps_table"; // Your table ID const id = "NEWDEV_devCustomProps_table"; // Your table ID
const table = $('#'+id).DataTable(); const table = $('#'+id).DataTable();
// Get the 'my-index' attribute from the closest tr element // Get the 'my-index' attribute from the closest tr element
const myIndex = parseInt($(el).closest("tr").attr("my-index")); const myIndex = parseInt($(el).closest("tr").attr("my-index"));
// Find the row in the table with the matching 'my-index' // Find the row in the table with the matching 'my-index'
const row = table.rows().nodes().to$().filter(`[my-index="${myIndex}"]`).first().get(0); const row = table.rows().nodes().to$().filter(`[my-index="${myIndex}"]`).first().get(0);
// Clone the row (including its data and controls) // Clone the row (including its data and controls)
let clonedRow = $(row).clone(true, true); // The true arguments copy the data and event handlers let clonedRow = $(row).clone(true, true); // The true arguments copy the data and event handlers
@@ -270,7 +270,7 @@ function cloneDataTableRow(el){
console.log(clonedRow); console.log(clonedRow);
// Add the cloned row to the DataTable // Add the cloned row to the DataTable
table.row.add(clonedRow[0]).draw(); table.row.add(clonedRow[0]).draw();
@@ -291,13 +291,13 @@ function removeDataTableRow(el) {
// Find the row in the table with the matching 'my-index' // Find the row in the table with the matching 'my-index'
const row = table.rows().nodes().to$().filter(`[my-index="${myIndex}"]`).first().get(0); const row = table.rows().nodes().to$().filter(`[my-index="${myIndex}"]`).first().get(0);
// Remove the row from the DataTable // Remove the row from the DataTable
table.row(row).remove().draw(); table.row(row).remove().draw();
} }
else else
{ {
showMessage (getString("CustProps_cant_remove"), 3000, "modal_red"); showMessage (getString("CustProps_cant_remove"), 3000, "modal_red");
} }
} }
@@ -308,9 +308,9 @@ function addViaPopupForm(element) {
const toId = $(element).attr("my-input-to"); const toId = $(element).attr("my-input-to");
const curValue = $(`#${toId}`).val(); const curValue = $(`#${toId}`).val();
const parsed = JSON.parse(atob($(`#${toId}`).data("elementoptionsbase64"))); const parsed = JSON.parse(atob($(`#${toId}`).data("elementoptionsbase64")));
const popupFormJson = parsed.find(obj => "popupForm" in obj)?.popupForm ?? null; const popupFormJson = parsed.find(obj => "popupForm" in obj)?.popupForm ?? null;
console.log(`toId | curValue: ${toId} | ${curValue}`); console.log(`toId | curValue: ${toId} | ${curValue}`);
showModalPopupForm( showModalPopupForm(
@@ -393,7 +393,7 @@ function selectAll(element) {
settingsChanged(); settingsChanged();
var selectElement = $(`#${$(element).attr("my-input-to")}`); var selectElement = $(`#${$(element).attr("my-input-to")}`);
// Iterate over each option within the select element // Iterate over each option within the select element
selectElement.find('option').each(function() { selectElement.find('option').each(function() {
// Mark each option as selected // Mark each option as selected
@@ -409,13 +409,13 @@ function selectAll(element) {
function unselectAll(element) { function unselectAll(element) {
settingsChanged(); settingsChanged();
var selectElement = $(`#${$(element).attr("my-input-to")}`); var selectElement = $(`#${$(element).attr("my-input-to")}`);
// Iterate over each option within the select element // Iterate over each option within the select element
selectElement.find('option').each(function() { selectElement.find('option').each(function() {
// Unselect each option // Unselect each option
$(this).prop('selected', false); $(this).prop('selected', false);
}); });
// Trigger the 'change' event to notify Bootstrap Select of the changes // Trigger the 'change' event to notify Bootstrap Select of the changes
selectElement.trigger('change'); selectElement.trigger('change');
} }
@@ -426,7 +426,7 @@ function selectChange(element) {
settingsChanged(); settingsChanged();
var selectElement = $(`#${$(element).attr("my-input-to")}`); var selectElement = $(`#${$(element).attr("my-input-to")}`);
selectElement.parent().find("input").focus().click(); selectElement.parent().find("input").focus().click();
} }
@@ -464,9 +464,9 @@ function initListInteractionOptions(element) {
// Parent has my-transformers="name|base64" // Parent has my-transformers="name|base64"
const toId = $parent.attr("id"); const toId = $parent.attr("id");
const curValue = $option.val(); const curValue = $option.val();
const parsed = JSON.parse(atob($parent.data("elementoptionsbase64"))); const parsed = JSON.parse(atob($parent.data("elementoptionsbase64")));
const popupFormJson = parsed.find(obj => "popupForm" in obj)?.popupForm ?? null; const popupFormJson = parsed.find(obj => "popupForm" in obj)?.popupForm ?? null;
showModalPopupForm( showModalPopupForm(
`<i class="fa fa-pen-to-square"></i> ${getString("Gen_Update_Value")}`, // title `<i class="fa fa-pen-to-square"></i> ${getString("Gen_Update_Value")}`, // title
"", // message "", // message
@@ -515,8 +515,8 @@ function filterRows(inputText) {
var $panelHeader = $panel.find('.panel-heading'); var $panelHeader = $panel.find('.panel-heading');
var $panelBody = $panel.find('.panel-collapse'); var $panelBody = $panel.find('.panel-collapse');
$panel.show() $panel.show()
$panelHeader.show() $panelHeader.show()
$panelBody.collapse('show'); $panelBody.collapse('show');
$panelBody.find(".table_row:not(.docs)").each(function () { $panelBody.find(".table_row:not(.docs)").each(function () {
@@ -525,11 +525,11 @@ function filterRows(inputText) {
var isMetadataRow = rowId && rowId.endsWith("__metadata"); var isMetadataRow = rowId && rowId.endsWith("__metadata");
if (!isMetadataRow) { if (!isMetadataRow) {
$row.show() $row.show()
} }
}); });
}); });
} else{ } else{
// filter // filter
@@ -537,25 +537,25 @@ function filterRows(inputText) {
var $panel = $(this); var $panel = $(this);
var $panelHeader = $panel.find('.panel-heading'); var $panelHeader = $panel.find('.panel-heading');
var $panelBody = $panel.find('.panel-collapse'); var $panelBody = $panel.find('.panel-collapse');
var anyVisible = false; // Flag to check if any row is visible var anyVisible = false; // Flag to check if any row is visible
$panelBody.find(".table_row:not(.docs)").each(function () { $panelBody.find(".table_row:not(.docs)").each(function () {
var $row = $(this); var $row = $(this);
// Check if the row ID ends with "__metadata" // Check if the row ID ends with "__metadata"
var rowId = $row.attr("id"); var rowId = $row.attr("id");
var isMetadataRow = rowId && rowId.endsWith("__metadata"); var isMetadataRow = rowId && rowId.endsWith("__metadata");
// Always hide metadata rows // Always hide metadata rows
if (isMetadataRow) { if (isMetadataRow) {
$row.hide(); $row.hide();
return; // Skip further processing for metadata rows return; // Skip further processing for metadata rows
} }
var description = $row.find(".setting_description").text().toLowerCase(); var description = $row.find(".setting_description").text().toLowerCase();
var setKey = $row.find(".setting_name code").text().toLowerCase(); var setKey = $row.find(".setting_name code").text().toLowerCase();
if ( if (
description.includes(inputText.toLowerCase()) || description.includes(inputText.toLowerCase()) ||
setKey.includes(inputText.toLowerCase()) setKey.includes(inputText.toLowerCase())
@@ -566,7 +566,7 @@ function filterRows(inputText) {
$row.hide(); $row.hide();
} }
}); });
// Determine whether to hide or show the panel based on visibility of rows // Determine whether to hide or show the panel based on visibility of rows
if (anyVisible) { if (anyVisible) {
$panelBody.collapse('show'); // Ensure the panel body is shown if there are visible rows $panelBody.collapse('show'); // Ensure the panel body is shown if there are visible rows
@@ -582,7 +582,7 @@ function filterRows(inputText) {
} }
} }
@@ -661,7 +661,7 @@ function generateOptionsOrSetOptions(
processDataCallback, // Callback function to generate entries based on options processDataCallback, // Callback function to generate entries based on options
targetField, // Target field or element where selected value should be applied or updated targetField, // Target field or element where selected value should be applied or updated
transformers = [], // Transformers to be applied to the values transformers = [], // Transformers to be applied to the values
overrideOptions = null // override options if available overrideOptions = null // override options if available
) { ) {
// console.log(setKey); // console.log(setKey);
@@ -712,7 +712,7 @@ function applyTransformers(val, transformers) {
break; break;
case "getString": case "getString":
// no change // no change
val = val; val = val;
break; break;
default: default:
console.warn(`Unknown transformer: ${transformer}`); console.warn(`Unknown transformer: ${transformer}`);
@@ -745,13 +745,13 @@ function reverseTransformers(val, transformers) {
break; break;
case "getString": case "getString":
// retrieve string // retrieve string
val = getString(val); val = getString(val);
break; break;
case "deviceChip": case "deviceChip":
mac = val // value is mac mac = val // value is mac
val = `${getDevDataByMac(mac, "devName")}` val = `${getDevDataByMac(mac, "devName")}`
break; break;
case "deviceRelType": case "deviceRelType":
val = val; // nothing to do val = val; // nothing to do
break; break;
default: default:
@@ -779,10 +779,11 @@ const handleElementOptions = (setKey, elementOptions, transformers, val) => {
let getStringKey = ""; let getStringKey = "";
let onClick = "console.log('onClick - Not implemented');"; let onClick = "console.log('onClick - Not implemented');";
let onChange = "console.log('onChange - Not implemented');"; let onChange = "console.log('onChange - Not implemented');";
let focusout = "console.log('focusout - Not implemented');";
let customParams = ""; let customParams = "";
let customId = ""; let customId = "";
let columns = []; let columns = [];
let base64Regex = ""; let base64Regex = "";
let elementOptionsBase64 = btoa(JSON.stringify(elementOptions)); let elementOptionsBase64 = btoa(JSON.stringify(elementOptions));
elementOptions.forEach((option) => { elementOptions.forEach((option) => {
@@ -830,6 +831,9 @@ const handleElementOptions = (setKey, elementOptions, transformers, val) => {
if (option.onChange) { if (option.onChange) {
onChange = option.onChange; onChange = option.onChange;
} }
if (option.focusout) {
focusout = option.focusout;
}
if (option.customParams) { if (option.customParams) {
customParams = option.customParams; customParams = option.customParams;
} }
@@ -867,7 +871,8 @@ const handleElementOptions = (setKey, elementOptions, transformers, val) => {
customId, customId,
columns, columns,
base64Regex, base64Regex,
elementOptionsBase64 elementOptionsBase64,
focusout
}; };
}; };
@@ -877,7 +882,7 @@ const handleElementOptions = (setKey, elementOptions, transformers, val) => {
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// -------------------------------------------------- // --------------------------------------------------
// Creates an object from an array // Creates an object from an array
function arrayToObject(array) { function arrayToObject(array) {
const obj = []; const obj = [];
array.forEach((item, index) => { array.forEach((item, index) => {
@@ -895,18 +900,18 @@ function generateOptions(options, valuesArray, targetField, transformers, placeh
resultArray = [] resultArray = []
selectedArray = [] selectedArray = []
cssClass = "" cssClass = ""
// determine if options or values are used in the listing // determine if options or values are used in the listing
if (valuesArray.length > 0 && options.length > 0){ if (valuesArray.length > 0 && options.length > 0){
// multiselect list -> options only + selected the ones in valuesArray // multiselect list -> options only + selected the ones in valuesArray
resultArray = options; resultArray = options;
selectedArray = valuesArray selectedArray = valuesArray
} else if (valuesArray.length > 0 && options.length == 0){ } else if (valuesArray.length > 0 && options.length == 0){
// editable list -> values only // editable list -> values only
resultArray = arrayToObject(valuesArray) resultArray = arrayToObject(valuesArray)
cssClass = "interactable-option" // generates [1x 📝 | 2x 🚮] cssClass = "interactable-option" // generates [1x 📝 | 2x 🚮]
} else if (options.length > 0){ } else if (options.length > 0){
@@ -914,7 +919,7 @@ function generateOptions(options, valuesArray, targetField, transformers, placeh
// dropdown -> options only (value == 1 STRING not ARRAY) // dropdown -> options only (value == 1 STRING not ARRAY)
resultArray = options; resultArray = options;
} }
// Create a map to track the index of each item in valuesArray // Create a map to track the index of each item in valuesArray
const orderMap = new Map(valuesArray.map((item, index) => [item, index])); const orderMap = new Map(valuesArray.map((item, index) => [item, index]));
@@ -961,7 +966,7 @@ function generateList(options, valuesArray, targetField, transformers, placehold
listHtml += `<li ${selected}>${labelName}</li>`; listHtml += `<li ${selected}>${labelName}</li>`;
}); });
// Place the resulting HTML into the specified placeholder div // Place the resulting HTML into the specified placeholder div
$("#" + placeholder).replaceWith(listHtml); $("#" + placeholder).replaceWith(listHtml);
} }
@@ -972,7 +977,7 @@ function genListWithInputSet(options, valuesArray, targetField, transformers, pl
var listHtml = ""; var listHtml = "";
options.forEach(function(item) { options.forEach(function(item) {
let selected = valuesArray.includes(item.id) ? 'selected' : ''; let selected = valuesArray.includes(item.id) ? 'selected' : '';
@@ -988,9 +993,9 @@ function genListWithInputSet(options, valuesArray, targetField, transformers, pl
} }
listHtml += `<li ${selected}> listHtml += `<li ${selected}>
<a href="javascript:void(0)" onclick="setTextValue('${targetField}','${item.id}')">${labelName}</a> <a href="javascript:void(0)" onclick="setTextValue('${targetField}','${item.id}')">${labelName}</a>
</li>`; </li>`;
}); });
// Place the resulting HTML into the specified placeholder div // Place the resulting HTML into the specified placeholder div
@@ -1001,8 +1006,8 @@ function genListWithInputSet(options, valuesArray, targetField, transformers, pl
// Collects a setting based on code name // Collects a setting based on code name
function collectSetting(prefix, setCodeName, setType, settingsArray) { function collectSetting(prefix, setCodeName, setType, settingsArray) {
// Parse setType if it's a JSON string // Parse setType if it's a JSON string
const setTypeObject = (typeof setType === "string") const setTypeObject = (typeof setType === "string")
? JSON.parse(processQuotes(setType)) ? JSON.parse(processQuotes(setType))
: setType; : setType;
const dataType = setTypeObject.dataType; const dataType = setTypeObject.dataType;
@@ -1015,6 +1020,20 @@ function collectSetting(prefix, setCodeName, setType, settingsArray) {
const { elementType, elementOptions = [], transformers = [] } = elementWithInputValue; const { elementType, elementOptions = [], transformers = [] } = elementWithInputValue;
// Check if validation failed
if (
$(`#${setCodeName}`)
&& $(`#${setCodeName}`).attr("data-is-valid")
&& $(`#${setCodeName}`).attr("data-is-valid") == 0
)
{
return {
"settingsArray": settingsArray,
"dataIsValid": false,
"failedSettingKey": setCodeName
};
}
const opts = handleElementOptions('none', elementOptions, transformers, val = ""); const opts = handleElementOptions('none', elementOptions, transformers, val = "");
// Map of handlers // Map of handlers
@@ -1038,7 +1057,7 @@ function collectSetting(prefix, setCodeName, setType, settingsArray) {
let temps = []; let temps = [];
if (opts.isOrdeable) { if (opts.isOrdeable) {
temps = $(`#${setCodeName}`).val(); temps = $(`#${setCodeName}`).val();
} else { } else {
const sel = $(`#${setCodeName}`).attr("my-editable") === "true" ? "" : ":selected"; const sel = $(`#${setCodeName}`).attr("my-editable") === "true" ? "" : ":selected";
$(`#${setCodeName} option${sel}`).each(function() { $(`#${setCodeName} option${sel}`).each(function() {
const vl = $(this).val(); const vl = $(this).val();
@@ -1066,7 +1085,7 @@ function collectSetting(prefix, setCodeName, setType, settingsArray) {
let handlerKey; let handlerKey;
if (dataType === "string" && elementType === "datatable") { if (dataType === "string" && elementType === "datatable") {
handlerKey = "datatableString"; handlerKey = "datatableString";
} else if (dataType === "string" || } else if (dataType === "string" ||
(dataType === "integer" && (opts.inputType === "number" || opts.inputType === "text"))) { (dataType === "integer" && (opts.inputType === "number" || opts.inputType === "text"))) {
handlerKey = "simpleValue"; handlerKey = "simpleValue";
} else if (opts.inputType === "checkbox") { } else if (opts.inputType === "checkbox") {
@@ -1084,7 +1103,11 @@ function collectSetting(prefix, setCodeName, setType, settingsArray) {
const value = handlers[handlerKey](); const value = handlers[handlerKey]();
settingsArray.push([prefix, setCodeName, dataType, value]); settingsArray.push([prefix, setCodeName, dataType, value]);
return settingsArray; return {
"settingsArray": settingsArray,
"dataIsValid": true,
"failedSettingKey": ""
};
} }
@@ -1093,22 +1116,22 @@ function collectSetting(prefix, setCodeName, setType, settingsArray) {
function generateFormHtml(settingsData, set, overrideValue, overrideOptions, originalSetKey) { function generateFormHtml(settingsData, set, overrideValue, overrideOptions, originalSetKey) {
let inputHtml = ''; let inputHtml = '';
isEmpty(overrideValue) ? inVal = set['setValue'] : inVal = overrideValue; isEmpty(overrideValue) ? inVal = set['setValue'] : inVal = overrideValue;
const setKey = set['setKey']; const setKey = set['setKey'];
const setType = set['setType']; const setType = set['setType'];
// if (setKey == '') { // if (setKey == '') {
// console.log(setType); // console.log(setType);
// console.log(setKey); // console.log(setKey);
// console.log(overrideValue); // console.log(overrideValue);
// console.log(inVal); // console.log(inVal);
// } // }
// Parse the setType JSON string // Parse the setType JSON string
// console.log(processQuotes(setType)); // console.log(processQuotes(setType));
const setTypeObject = JSON.parse(processQuotes(setType)) const setTypeObject = JSON.parse(processQuotes(setType))
const dataType = setTypeObject.dataType; const dataType = setTypeObject.dataType;
const elements = setTypeObject.elements || []; const elements = setTypeObject.elements || [];
@@ -1137,20 +1160,21 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
customId, customId,
columns, columns,
base64Regex, base64Regex,
elementOptionsBase64 elementOptionsBase64,
focusout
} = handleElementOptions(setKey, elementOptions, transformers, inVal); } = handleElementOptions(setKey, elementOptions, transformers, inVal);
// Override value // Override value
let val = valRes; let val = valRes;
// if (setKey == '') { // if (setKey == '') {
// console.log(setType); // console.log(setType);
// console.log(setKey); // console.log(setKey);
// console.log(overrideValue); // console.log(overrideValue);
// console.log(inVal); // console.log(inVal);
// console.log(val); // console.log(val);
// } // }
// Generate HTML based on elementType // Generate HTML based on elementType
@@ -1159,16 +1183,17 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
const multi = isMultiSelect ? "multiple" : ""; const multi = isMultiSelect ? "multiple" : "";
const addCss = isOrdeable ? "select2 select2-hidden-accessible" : ""; const addCss = isOrdeable ? "select2 select2-hidden-accessible" : "";
inputHtml += `<select onChange="settingsChanged();${onChange}" inputHtml += `<select onChange="settingsChanged();${onChange}"
my-data-type="${dataType}" onfocusout="${focusout}"
my-editable="${editable}" my-data-type="${dataType}"
class="form-control ${addCss} ${cssClasses}" my-editable="${editable}"
name="${setKey}" class="form-control ${addCss} ${cssClasses}"
id="${setKey}" name="${setKey}"
id="${setKey}"
my-transformers=${transformers} my-transformers=${transformers}
my-customparams="${customParams}" my-customparams="${customParams}"
my-customid="${customId}" my-customid="${customId}"
my-originalSetKey="${originalSetKey}" my-originalSetKey="${originalSetKey}"
data-elementoptionsbase64="${elementOptionsBase64}" data-elementoptionsbase64="${elementOptionsBase64}"
${multi} ${multi}
${readOnly ? "disabled" : ""}> ${readOnly ? "disabled" : ""}>
@@ -1182,31 +1207,32 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
const checked = val === 'True' || val === 'true' || val === '1' ? 'checked' : ''; const checked = val === 'True' || val === 'true' || val === '1' ? 'checked' : '';
const inputClass = inputType === 'checkbox' ? 'checkbox' : 'form-control'; const inputClass = inputType === 'checkbox' ? 'checkbox' : 'form-control';
inputHtml += `<input inputHtml += `<input
class="${inputClass} ${cssClasses}" class="${inputClass} ${cssClasses}"
onChange="settingsChanged();${onChange}" onChange="settingsChanged();${onChange}"
my-data-type="${dataType}" onfocusout="${focusout}"
my-customparams="${customParams}" my-data-type="${dataType}"
my-customid="${customId}" my-customparams="${customParams}"
my-customid="${customId}"
my-originalSetKey="${originalSetKey}" my-originalSetKey="${originalSetKey}"
my-base64Regex="${base64Regex}" my-base64Regex="${base64Regex}"
id="${setKey}${suffix}" id="${setKey}${suffix}"
type="${inputType}" type="${inputType}"
value="${val}" value="${val}"
${readOnly} ${readOnly}
${checked} ${checked}
placeholder="${placeholder}" placeholder="${placeholder}"
/>`; />`;
break; break;
case 'button': case 'button':
inputHtml += `<button inputHtml += `<button
class="btn btn-primary ${cssClasses}" class="btn btn-primary ${cssClasses}"
my-customparams="${customParams}" my-customparams="${customParams}"
my-customid="${customId}" my-customid="${customId}"
my-originalSetKey="${originalSetKey}" my-originalSetKey="${originalSetKey}"
my-input-from="${sourceIds}" my-input-from="${sourceIds}"
my-input-to="${setKey}" my-input-to="${setKey}"
data-elementoptionsbase64="${elementOptionsBase64}" data-elementoptionsbase64="${elementOptionsBase64}"
onclick="${onClick}"> onclick="${onClick}">
${getString(getStringKey)} ${getString(getStringKey)}
@@ -1214,21 +1240,23 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
break; break;
case 'textarea': case 'textarea':
inputHtml += `<textarea inputHtml += `<textarea
class="form-control input" class="form-control input"
my-customparams="${customParams}" onChange="settingsChanged();${onChange}"
my-customid="${customId}" onfocusout="${focusout}"
my-customparams="${customParams}"
my-customid="${customId}"
my-originalSetKey="${originalSetKey}" my-originalSetKey="${originalSetKey}"
my-data-type="${dataType}" my-data-type="${dataType}"
id="${setKey}" id="${setKey}"
${readOnly}>${val}</textarea>`; ${readOnly}>${val}</textarea>`;
break; break;
case 'span': case 'span':
inputHtml += `<span inputHtml += `<span
class="${cssClasses}" class="${cssClasses}"
my-data-type="${dataType}" my-data-type="${dataType}"
my-customparams="${customParams}" my-customparams="${customParams}"
my-customid="${customId}" my-customid="${customId}"
my-originalSetKey="${originalSetKey}" my-originalSetKey="${originalSetKey}"
onclick="${onClick}"> onclick="${onClick}">
@@ -1264,13 +1292,13 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
columnSetting["setOptions"] = getSetting(column.optionsOverride.replace("setting.","")); columnSetting["setOptions"] = getSetting(column.optionsOverride.replace("setting.",""));
} else { } else {
columnSetting["setOptions"] = column.optionsOverride; columnSetting["setOptions"] = column.optionsOverride;
} }
} }
columnSettings.push(columnSetting) columnSettings.push(columnSetting)
// helper for if val is empty // helper for if val is empty
emptyVal.push(''); emptyVal.push('');
}); });
datatableHtml += '</tr></thead>'; datatableHtml += '</tr></thead>';
@@ -1290,7 +1318,7 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
let index = 0; let index = 0;
val.forEach(rowData => { val.forEach(rowData => {
datatableHtml += `<tr my-index="${index}">`; datatableHtml += `<tr my-index="${index}">`;
let j = 0; let j = 0;
columnSettings.forEach(set => { columnSettings.forEach(set => {
// Extract the value for the current column based on the new structure // Extract the value for the current column based on the new structure
@@ -1300,11 +1328,11 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
{ {
columnOverrideValue = "" columnOverrideValue = ""
} }
// Create unique key to prevent dropdown data duplication // Create unique key to prevent dropdown data duplication
const oldKey = set["setKey"]; const oldKey = set["setKey"];
set["setKey"] = oldKey + "_" + index; set["setKey"] = oldKey + "_" + index;
// Generate the cell HTML using the extracted value // Generate the cell HTML using the extracted value
const cellHtml = generateFormHtml( const cellHtml = generateFormHtml(
settingsData, settingsData,
@@ -1314,17 +1342,17 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
oldKey oldKey
); );
datatableHtml += `<td> <div class="input-group"> ${cellHtml} </div></td>`; datatableHtml += `<td> <div class="input-group"> ${cellHtml} </div></td>`;
// Restore the original key // Restore the original key
set["setKey"] = oldKey; set["setKey"] = oldKey;
j++; j++;
}); });
datatableHtml += '</tr>'; datatableHtml += '</tr>';
index++; index++;
}); });
datatableHtml += '</tbody></table>'; datatableHtml += '</tbody></table>';
inputHtml += datatableHtml; inputHtml += datatableHtml;
@@ -1347,8 +1375,8 @@ function generateFormHtml(settingsData, set, overrideValue, overrideOptions, ori
// Generate event HTML if applicable // Generate event HTML if applicable
let eventsHtml = ''; let eventsHtml = '';
const eventsList = createArray(set['setEvents']); const eventsList = createArray(set['setEvents']);
// inline buttons events // inline buttons events
if (eventsList.length > 0) { if (eventsList.length > 0) {
eventsList.forEach(event => { eventsList.forEach(event => {
@@ -1387,7 +1415,7 @@ if (eventsList.length > 0) {
data-myparam-setkey="${setKey}" data-myparam-setkey="${setKey}"
data-myparam="${setKey}" data-myparam="${setKey}"
data-myparam-plugin="${setKey.split('_')[0] || ''}" data-myparam-plugin="${setKey.split('_')[0] || ''}"
data-myevent="${event}" data-myevent="${event}"
onclick="execute_settingEvent(this)"> onclick="execute_settingEvent(this)">
<i title="${getString(event + "_event_tooltip")}" class="fa ${eventIcon}"></i> <i title="${getString(event + "_event_tooltip")}" class="fa ${eventIcon}"></i>
</span>`; </span>`;
@@ -1406,15 +1434,15 @@ function getSetObject(settingsData, setKey) {
result = "" result = ""
settingsData.forEach(function(set) { settingsData.forEach(function(set) {
if (set.setKey == setKey) { if (set.setKey == setKey) {
// console.log(set); // console.log(set);
result = set; result = set;
return; return;
} }
}); });
if(result == "") if(result == "")
@@ -1439,7 +1467,7 @@ function collectTableData(tableSelector) {
cells.each((index, cell) => { cells.each((index, cell) => {
const input = $(cell).find('input, select, textarea'); const input = $(cell).find('input, select, textarea');
if (input.length) { if (input.length) {
if (input.attr('type') === 'checkbox') { if (input.attr('type') === 'checkbox') {
// For checkboxes, check if they are checked // For checkboxes, check if they are checked
@@ -1455,10 +1483,10 @@ function collectTableData(tableSelector) {
} }
}); });
tableData.push(rowData); tableData.push(rowData);
}); });
return tableData; return tableData;
} }

View File

@@ -1,6 +1,6 @@
/* ----------------------------------------------------------------------------- /* -----------------------------------------------------------------------------
* NetAlertX * NetAlertX
* Open Source Network Guard / WIFI & LAN intrusion detector * Open Source Network Guard / WIFI & LAN intrusion detector
* *
* ui_components.js - Front module. Common UI components * ui_components.js - Front module. Common UI components
*------------------------------------------------------------------------------- *-------------------------------------------------------------------------------
@@ -56,7 +56,7 @@ function getRandomBytes(elem, length) {
window.crypto.getRandomValues(array); window.crypto.getRandomValues(array);
// Convert bytes to hexadecimal string // Convert bytes to hexadecimal string
let hexString = Array.from(array, byte => let hexString = Array.from(array, byte =>
byte.toString(16).padStart(2, '0') byte.toString(16).padStart(2, '0')
).join(''); ).join('');
@@ -71,7 +71,7 @@ function getRandomBytes(elem, length) {
} }
// ---------------------------------------------- // ----------------------------------------------
// Updates the icon preview // Updates the icon preview
function updateAllIconPreviews() { function updateAllIconPreviews() {
$(".iconInputVal").each((index, el)=>{ $(".iconInputVal").each((index, el)=>{
updateIconPreview(el) updateIconPreview(el)
@@ -79,7 +79,7 @@ function updateAllIconPreviews() {
} }
// ---------------------------------------------- // ----------------------------------------------
// Updates the icon preview // Updates the icon preview
function updateIconPreview(elem) { function updateIconPreview(elem) {
const previewSpan = $(elem).parent().find(".iconPreview"); const previewSpan = $(elem).parent().find(".iconPreview");
@@ -97,7 +97,7 @@ function updateIconPreview(elem) {
previewSpan.html(atob(newValue)); previewSpan.html(atob(newValue));
}); });
return; // Stop retrying if successful return; // Stop retrying if successful
} }
attempts++; attempts++;
if (attempts < 10) { if (attempts < 10) {
@@ -119,9 +119,9 @@ function validateRegex(elem) {
const iconSpan = $(elem).parent().find(".validityCheck"); const iconSpan = $(elem).parent().find(".validityCheck");
const inputElem = $(elem); const inputElem = $(elem);
const regexTmp = atob($(inputElem).attr("my-base64Regex")); // Decode base64 regex const regexTmp = atob($(inputElem).attr("my-base64Regex")); // Decode base64 regex
const regex = new RegExp(regexTmp); // Convert to a valid RegExp object const regex = new RegExp(regexTmp); // Convert to a valid RegExp object
let attempts = 0; let attempts = 0;
function tryUpdateValidityResultIcon() { function tryUpdateValidityResultIcon() {
@@ -140,8 +140,11 @@ function validateRegex(elem) {
// Validate against regex // Validate against regex
if (regex.test(value)) { if (regex.test(value)) {
iconSpan.html("<i class='fa fa-check'></i>"); iconSpan.html("<i class='fa fa-check'></i>");
inputElem.attr("data-is-valid", "1");
} else { } else {
iconSpan.html("<i class='fa fa-xmark'></i>"); iconSpan.html("<i class='fa fa-xmark'></i>");
showModalOk('WARNING', getString("Gen_Invalid_Value"));
inputElem.attr("data-is-valid", "0");
} }
} }
@@ -175,7 +178,7 @@ function initializeiCheck () {
increaseArea: '20%' increaseArea: '20%'
}); });
} }
@@ -206,7 +209,7 @@ function copyToClipboard(buttonElement) {
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Simple Sortable Table columns // Simple Sortable Table columns
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Function to handle column sorting when a user clicks on a table header // Function to handle column sorting when a user clicks on a table header
@@ -268,9 +271,9 @@ function ipToNum(ip) {
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// handling events // handling events
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
modalEventStatusId = 'modal-message-front-event' modalEventStatusId = 'modal-message-front-event'
@@ -301,41 +304,41 @@ function execute_settingEvent(element) {
updateModalState() updateModalState()
} }
}) })
} else if (["add_option"].includes(feEvent)) { } else if (["add_option"].includes(feEvent)) {
showModalFieldInput ( showModalFieldInput (
'<i class="fa fa-square-plus pointer"></i> ' + getString('Gen_Add'), '<i class="fa fa-square-plus pointer"></i> ' + getString('Gen_Add'),
getString('Gen_Add'), getString('Gen_Add'),
getString('Gen_Cancel'), getString('Gen_Cancel'),
getString('Gen_Okay'), getString('Gen_Okay'),
'', // curValue '', // curValue
'addOptionFromModalInput', 'addOptionFromModalInput',
feSourceId // triggered by id feSourceId // triggered by id
); );
} else if (["add_icon"].includes(feEvent)) { } else if (["add_icon"].includes(feEvent)) {
// Add new icon as base64 string // Add new icon as base64 string
showModalInput ( showModalInput (
'<i class="fa fa-square-plus pointer"></i> ' + getString('DevDetail_button_AddIcon'), '<i class="fa fa-square-plus pointer"></i> ' + getString('DevDetail_button_AddIcon'),
getString('DevDetail_button_AddIcon_Help'), getString('DevDetail_button_AddIcon_Help'),
getString('Gen_Cancel'), getString('Gen_Cancel'),
getString('Gen_Okay'), getString('Gen_Okay'),
() => addIconAsBase64(element), // Wrap in an arrow function () => addIconAsBase64(element), // Wrap in an arrow function
feSourceId // triggered by id feSourceId // triggered by id
); );
} else if (["select_icon"].includes(feEvent)) { } else if (["select_icon"].includes(feEvent)) {
showIconSelection(feSetKey) showIconSelection(feSetKey)
// myparam-setkey // myparam-setkey
} else if (["copy_icons"].includes(feEvent)) { } else if (["copy_icons"].includes(feEvent)) {
// Ask overwrite icon types // Ask overwrite icon types
showModalWarning ( showModalWarning (
getString('DevDetail_button_OverwriteIcons'), getString('DevDetail_button_OverwriteIcons'),
getString('DevDetail_button_OverwriteIcons_Warning'), getString('DevDetail_button_OverwriteIcons_Warning'),
getString('Gen_Cancel'), getString('Gen_Cancel'),
getString('Gen_Okay'), getString('Gen_Okay'),
'overwriteIconType', 'overwriteIconType',
feSourceId // triggered by id feSourceId // triggered by id
); );
@@ -343,30 +346,30 @@ function execute_settingEvent(element) {
goToDevice(feValue); goToDevice(feValue);
} else if (["go_to_node"].includes(feEvent)) { } else if (["go_to_node"].includes(feEvent)) {
goToNetworkNode(feValue); goToNetworkNode(feValue);
} else { } else {
console.warn(`🔺Not implemented: ${feEvent}`) console.warn(`🔺Not implemented: ${feEvent}`)
} }
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Go to the correct network node in the Network section // Go to the correct network node in the Network section
function overwriteIconType() function overwriteIconType()
{ {
const mac = getMac(); const mac = getMac();
if (!isValidMac(mac)) { if (!isValidMac(mac)) {
showModalOK("Error", getString("Gen_InvalidMac")) showModalOK("Error", getString("Gen_InvalidMac"))
return; return;
} }
// Construct SQL query // Construct SQL query
const rawSql = ` const rawSql = `
UPDATE Devices UPDATE Devices
SET devIcon = ( SET devIcon = (
SELECT devIcon FROM Devices WHERE devMac = "${mac}" SELECT devIcon FROM Devices WHERE devMac = "${mac}"
) )
@@ -391,24 +394,24 @@ function overwriteIconType()
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Go to the correct network node in the Network section // Go to the correct network node in the Network section
function goToNetworkNode(mac) function goToNetworkNode(mac)
{ {
setCache('activeNetworkTab', mac.replaceAll(":","_")+'_id'); setCache('activeNetworkTab', mac.replaceAll(":","_")+'_id');
window.location.href = './network.php'; window.location.href = './network.php';
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Go to the device // Go to the device
function goToDevice(mac, newtab = false) { function goToDevice(mac, newtab = false) {
const url = './deviceDetails.php?mac=' + encodeURIComponent(mac); const url = './deviceDetails.php?mac=' + encodeURIComponent(mac);
if (newtab) { if (newtab) {
window.open(url, '_blank'); window.open(url, '_blank');
} else { } else {
window.location.href = url; window.location.href = url;
} }
} }
// -------------------------------------------------------- // --------------------------------------------------------
// Updating the execution queue in in modal pop-up // Updating the execution queue in in modal pop-up
@@ -437,7 +440,7 @@ function updateModalState() {
function addOptionFromModalInput() { function addOptionFromModalInput() {
var inputVal = $(`#modal-field-input-field`).val(); var inputVal = $(`#modal-field-input-field`).val();
console.log($('#modal-field-input-field')); console.log($('#modal-field-input-field'));
var triggeredBy = $('#modal-field-input').attr("data-myparam-triggered-by"); var triggeredBy = $('#modal-field-input').attr("data-myparam-triggered-by");
var targetId = $('#' + triggeredBy).attr("data-myparam-setkey"); var targetId = $('#' + triggeredBy).attr("data-myparam-setkey");
@@ -475,16 +478,16 @@ function addIconAsBase64 (el) {
console.log($('#modal-field-input-field')); console.log($('#modal-field-input-field'));
var triggeredBy = $('#modal-input').attr("data-myparam-triggered-by"); var triggeredBy = $('#modal-input').attr("data-myparam-triggered-by");
var targetId = $('#' + triggeredBy).attr("data-myparam-setkey"); var targetId = $('#' + triggeredBy).attr("data-myparam-setkey");
// $('#'+targetId).val(iconHtmlBase64); // $('#'+targetId).val(iconHtmlBase64);
// Add new option and set it as selected // Add new option and set it as selected
$('#' + targetId).append(new Option(iconHtmlBase64, iconHtmlBase64)).val(iconHtmlBase64); $('#' + targetId).append(new Option(iconHtmlBase64, iconHtmlBase64)).val(iconHtmlBase64);
updateIconPreview(el) updateIconPreview(el)
} }
@@ -522,8 +525,8 @@ function showIconSelection(setKey) {
// Populate the icon list // Populate the icon list
Array.from(selectElement.options).forEach(option => { Array.from(selectElement.options).forEach(option => {
if (option.value != "") { if (option.value != "") {
const value = option.value; const value = option.value;
// Decode the base64 value // Decode the base64 value
@@ -566,7 +569,7 @@ function showIconSelection(setKey) {
}); });
// //
} }
@@ -661,7 +664,7 @@ function getRelationshipConf(relType) {
// --color-red: #dd4b39; // --color-red: #dd4b39;
switch (relType) { switch (relType) {
case "child": case "child":
color = "#f39c12"; // yellow color = "#f39c12"; // yellow
cssClass = "text-yellow"; cssClass = "text-yellow";
@@ -673,11 +676,11 @@ function getRelationshipConf(relType) {
case "virtual": case "virtual":
color = "#0060df"; // blue color = "#0060df"; // blue
cssClass = "text-blue"; cssClass = "text-blue";
break; break;
case "logical": case "logical":
color = "#00a65a"; // green color = "#00a65a"; // green
cssClass = "text-green"; cssClass = "text-green";
break; break;
default: default:
color = "#5B5B66"; // grey color = "#5B5B66"; // grey
cssClass = "text-light-grey"; cssClass = "text-light-grey";
@@ -703,13 +706,13 @@ function initSelect2() {
// check if cache ready // check if cache ready
if(isValidJSON(devicesListAll_JSON)) if(isValidJSON(devicesListAll_JSON))
{ {
// -------------------------------------------------------- // --------------------------------------------------------
//Initialize Select2 Elements and make them sortable //Initialize Select2 Elements and make them sortable
$(function () { $(function () {
// Iterate over each Select2 dropdown // Iterate over each Select2 dropdown
$('.select2').each(function() { $('.select2').each(function() {
// handle Device chips, if my-transformers="deviceChip" // handle Device chips, if my-transformers="deviceChip"
if($(this).attr("my-transformers") == "deviceChip") if($(this).attr("my-transformers") == "deviceChip")
{ {
@@ -721,7 +724,7 @@ function initSelect2() {
return m; // Allow HTML return m; // Allow HTML
} }
}); });
} else if($(this).attr("my-transformers") == "deviceRelType") // handling dropdown for relationships } else if($(this).attr("my-transformers") == "deviceRelType") // handling dropdown for relationships
{ {
var selectEl = $(this).select2({ var selectEl = $(this).select2({
@@ -730,26 +733,26 @@ function initSelect2() {
if (!data.id) return data.text; // default for placeholder etc. if (!data.id) return data.text; // default for placeholder etc.
const relConf = getRelationshipConf(data.text); const relConf = getRelationshipConf(data.text);
// Custom HTML // Custom HTML
const html = $(` const html = $(`
<span class="custom-chip ${relConf.cssClass}" > <span class="custom-chip ${relConf.cssClass}" >
${data.text} ${data.text}
</span> </span>
`); `);
return html; return html;
}, },
escapeMarkup: function (m) { escapeMarkup: function (m) {
return m; // Allow HTML return m; // Allow HTML
} }
}); });
} else // default handling - default template } else // default handling - default template
{ {
var selectEl = $(this).select2(); var selectEl = $(this).select2();
} }
// Apply sortable functionality to the dropdown's dropdown-container // Apply sortable functionality to the dropdown's dropdown-container
selectEl.next().children().children().children().sortable({ selectEl.next().children().children().children().sortable({
containment: 'parent', containment: 'parent',
@@ -757,14 +760,14 @@ function initSelect2() {
var sortedValues = $(this).children().map(function() { var sortedValues = $(this).children().map(function() {
return $(this).attr('title'); return $(this).attr('title');
}).get(); }).get();
var sortedOptions = selectEl.find('option').sort(function(a, b) { var sortedOptions = selectEl.find('option').sort(function(a, b) {
return sortedValues.indexOf($(a).text()) - sortedValues.indexOf($(b).text()); return sortedValues.indexOf($(a).text()) - sortedValues.indexOf($(b).text());
}); });
// Replace all options in selectEl // Replace all options in selectEl
selectEl.empty().append(sortedOptions); selectEl.empty().append(sortedOptions);
// Trigger change event on Select2 // Trigger change event on Select2
selectEl.trigger('change'); selectEl.trigger('change');
} }
@@ -776,7 +779,7 @@ function initSelect2() {
setTimeout(() => { setTimeout(() => {
initSelect2() initSelect2()
}, 1000); }, 1000);
} }
} }
// ------------------------------------------ // ------------------------------------------
@@ -816,7 +819,7 @@ function renderDeviceLink(data, container, useName = false) {
'data-alert': device.devAlertDown, 'data-alert': device.devAlertDown,
'data-icon': device.devIcon 'data-icon': device.devIcon
}); });
return ` return `
<a href="${badge.url}" target="_blank"> <a href="${badge.url}" target="_blank">
<span class="custom-chip"> <span class="custom-chip">
@@ -866,7 +869,7 @@ function initHoverNodeInfo() {
$(document).on('mouseenter', '.hover-node-info', function (e) { $(document).on('mouseenter', '.hover-node-info', function (e) {
const $el = $(this); const $el = $(this);
lastTarget = this; lastTarget = this;
// use timeout to prevent a quick hover and exit toi flash a card when navigating to a target node with your mouse // use timeout to prevent a quick hover and exit toi flash a card when navigating to a target node with your mouse
clearTimeout(hoverTimeout); clearTimeout(hoverTimeout);
@@ -893,25 +896,25 @@ function initHoverNodeInfo() {
<div class="line"> <div class="line">
<b>Status:</b> <span>${status}</span><br> <b>Status:</b> <span>${status}</span><br>
</div> </div>
<div class="line"> <div class="line">
<b>IP:</b> <span>${ip}</span><br> <b>IP:</b> <span>${ip}</span><br>
</div> </div>
<div class="line"> <div class="line">
<b>MAC:</b> <span>${mac}</span><br> <b>MAC:</b> <span>${mac}</span><br>
</div> </div>
<div class="line"> <div class="line">
<b>Vendor:</b> <span>${vendor}</span><br> <b>Vendor:</b> <span>${vendor}</span><br>
</div> </div>
<div class="line"> <div class="line">
<b>Type:</b> <span>${type}</span><br> <b>Type:</b> <span>${type}</span><br>
</div> </div>
<div class="line"> <div class="line">
<b>First seen:</b> <span>${firstseen}</span><br> <b>First seen:</b> <span>${firstseen}</span><br>
</div> </div>
<div class="line"> <div class="line">
<b>Last seen:</b> <span>${lastseen}</span><br> <b>Last seen:</b> <span>${lastseen}</span><br>
</div> </div>
<div class="line"> <div class="line">
<b>Relationship:</b> <span class="${getRelationshipConf(relationship).cssClass}">${relationship}</span> <b>Relationship:</b> <span class="${getRelationshipConf(relationship).cssClass}">${relationship}</span>
</div> </div>
`; `;

View File

@@ -18,19 +18,19 @@
</div> </div>
<div class="deviceSelector col-md-11 col-sm-11" style="z-index:5"> <div class="deviceSelector col-md-11 col-sm-11" style="z-index:5">
<div class="db_info_table_row col-sm-12" > <div class="db_info_table_row col-sm-12" >
<div class="form-group" > <div class="form-group" >
<div class="input-group col-sm-12 " > <div class="input-group col-sm-12 " >
<select class="form-control select2 select2-hidden-accessible" multiple="" style="width: 100%;" tabindex="-1" aria-hidden="true"> <select class="form-control select2 select2-hidden-accessible" multiple="" style="width: 100%;" tabindex="-1" aria-hidden="true">
</select> </select>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<div class="col-md-1 hoverHighlight"> <div class="col-md-1 hoverHighlight">
<i class="fa-solid fa-circle-check hoverHighlight pointer" onclick="markAllSelected()" title="<?= lang('Gen_Add_All');?>"></i> <i class="fa-solid fa-circle-check hoverHighlight pointer" onclick="markAllSelected()" title="<?= lang('Gen_Add_All');?>"></i>
<i class="fa-solid fa-circle-xmark hoverHighlight pointer" onclick="markAllNotSelected()" title="<?= lang('Gen_Remove_All');?>"></i> <i class="fa-solid fa-circle-xmark hoverHighlight pointer" onclick="markAllNotSelected()" title="<?= lang('Gen_Remove_All');?>"></i>
</div> </div>
</div> </div>
@@ -69,19 +69,19 @@
<script defer> <script defer>
// ------------------------------------------------------------------- // -------------------------------------------------------------------
// Get plugin and settings data from API endpoints // Get plugin and settings data from API endpoints
function getData(){ function getData(){
// some race condition, need to implement delay // some race condition, need to implement delay
setTimeout(() => { setTimeout(() => {
$.get('php/server/query_json.php', { file: 'table_settings.json', nocache: Date.now() }, function(res) { $.get('php/server/query_json.php', { file: 'table_settings.json', nocache: Date.now() }, function(res) {
settingsData = res["data"]; settingsData = res["data"];
excludedColumns = ["NEWDEV_devMac", "NEWDEV_devFirstConnection", "NEWDEV_devLastConnection", "NEWDEV_devLastNotification", "NEWDEV_devScan", "NEWDEV_devPresentLastScan", "NEWDEV_devCustomProps", "NEWDEV_devChildrenNicsDynamic", "NEWDEV_devChildrenDynamic" ] excludedColumns = ["NEWDEV_devMac", "NEWDEV_devFirstConnection", "NEWDEV_devLastConnection", "NEWDEV_devLastNotification", "NEWDEV_devScan", "NEWDEV_devPresentLastScan", "NEWDEV_devCustomProps", "NEWDEV_devChildrenNicsDynamic", "NEWDEV_devChildrenDynamic" ]
const relevantColumns = settingsData.filter(set => const relevantColumns = settingsData.filter(set =>
set.setGroup === "NEWDEV" && set.setGroup === "NEWDEV" &&
set.setKey.includes("_dev") && set.setKey.includes("_dev") &&
@@ -103,7 +103,7 @@
// Append form groups to the column // Append form groups to the column
for (let j = i * elementsPerColumn; j < Math.min((i + 1) * elementsPerColumn, multiEditColumns.length); j++) { for (let j = i * elementsPerColumn; j < Math.min((i + 1) * elementsPerColumn, multiEditColumns.length); j++) {
const setTypeObject = JSON.parse(multiEditColumns[j].setType.replace(/'/g, '"')); const setTypeObject = JSON.parse(multiEditColumns[j].setType.replace(/'/g, '"'));
// get the element with the input value(s) // get the element with the input value(s)
let elements = setTypeObject.elements.filter(element => element.elementHasInputValue === 1); let elements = setTypeObject.elements.filter(element => element.elementHasInputValue === 1);
@@ -118,7 +118,7 @@
} }
const { elementType, elementOptions = [], transformers = [] } = elementWithInputValue; const { elementType, elementOptions = [], transformers = [] } = elementWithInputValue;
const { const {
inputType, inputType,
readOnly, readOnly,
isMultiSelect, isMultiSelect,
@@ -137,10 +137,11 @@
customId, customId,
columns, columns,
base64Regex, base64Regex,
elementOptionsBase64 elementOptionsBase64,
focusout
} = handleElementOptions('none', elementOptions, transformers, val = ""); } = handleElementOptions('none', elementOptions, transformers, val = "");
// render based on element type // render based on element type
if (elementType === 'select') { if (elementType === 'select') {
targetLocation = multiEditColumns[j].setKey + "_generateSetOptions" targetLocation = multiEditColumns[j].setKey + "_generateSetOptions"
@@ -148,7 +149,7 @@
generateOptionsOrSetOptions(multiEditColumns[j].setKey, [], targetLocation, generateOptions, null) generateOptionsOrSetOptions(multiEditColumns[j].setKey, [], targetLocation, generateOptions, null)
console.log(multiEditColumns[j].setKey) console.log(multiEditColumns[j].setKey)
// Handle Icons as they need a preview // Handle Icons as they need a preview
if(multiEditColumns[j].setKey == 'NEWDEV_devIcon') if(multiEditColumns[j].setKey == 'NEWDEV_devIcon')
{ {
input = ` input = `
@@ -157,37 +158,37 @@
onChange="updateIconPreview(this)" onChange="updateIconPreview(this)"
my-customparams="NEWDEV_devIcon,NEWDEV_devIcon_preview" my-customparams="NEWDEV_devIcon,NEWDEV_devIcon_preview"
id="${multiEditColumns[j].setKey}" id="${multiEditColumns[j].setKey}"
data-my-column="${multiEditColumns[j].setKey}" data-my-column="${multiEditColumns[j].setKey}"
data-my-targetColumns="${multiEditColumns[j].setKey.replace('NEWDEV_','')}" > data-my-targetColumns="${multiEditColumns[j].setKey.replace('NEWDEV_','')}" >
<option id="${targetLocation}"></option> <option id="${targetLocation}"></option>
</select>` </select>`
} else{ } else{
input = `<select class="form-control" input = `<select class="form-control"
id="${multiEditColumns[j].setKey}" id="${multiEditColumns[j].setKey}"
data-my-column="${multiEditColumns[j].setKey}" data-my-column="${multiEditColumns[j].setKey}"
data-my-targetColumns="${multiEditColumns[j].setKey.replace('NEWDEV_','')}" > data-my-targetColumns="${multiEditColumns[j].setKey.replace('NEWDEV_','')}" >
<option id="${targetLocation}"></option> <option id="${targetLocation}"></option>
</select>` </select>`
} }
} else if (elementType === 'input'){ } else if (elementType === 'input'){
// Add classes specifically for checkboxes // Add classes specifically for checkboxes
inputType === 'checkbox' ? inputClass = 'checkbox' : inputClass = 'form-control'; inputType === 'checkbox' ? inputClass = 'checkbox' : inputClass = 'form-control';
input = `<input class="${inputClass}"
id="${multiEditColumns[j].setKey}" input = `<input class="${inputClass}"
my-customid="${multiEditColumns[j].setKey}" id="${multiEditColumns[j].setKey}"
data-my-column="${multiEditColumns[j].setKey}" my-customid="${multiEditColumns[j].setKey}"
data-my-targetColumns="${multiEditColumns[j].setKey.replace('NEWDEV_','')}" data-my-column="${multiEditColumns[j].setKey}"
data-my-targetColumns="${multiEditColumns[j].setKey.replace('NEWDEV_','')}"
type="${inputType}">` type="${inputType}">`
} }
const inputEntry = `<div class="form-group col-sm-12" > const inputEntry = `<div class="form-group col-sm-12" >
<label class="col-sm-3 control-label">${multiEditColumns[j].setName}</label> <label class="col-sm-3 control-label">${multiEditColumns[j].setName}</label>
<div class="col-sm-9"> <div class="col-sm-9">
@@ -200,7 +201,7 @@
</div> </div>
</div>` </div>`
column.append(inputEntry); column.append(inputEntry);
} }
@@ -215,11 +216,11 @@
initSelect2(); initSelect2();
initDeviceSelectors(); initDeviceSelectors();
}) })
}, 100); }, 100);
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
@@ -262,10 +263,10 @@
var option = new Option($('.deviceSelector select option[value="' + mac + '"]').html(), mac, true, true); var option = new Option($('.deviceSelector select option[value="' + mac + '"]').html(), mac, true, true);
$('.deviceSelector select').append(option).trigger('change'); $('.deviceSelector select').append(option).trigger('change');
}); });
}
}
}, 10); }, 10);
} }
@@ -282,7 +283,7 @@
function markAllSelected() { function markAllSelected() {
// Get the <select> element with the class 'deviceSelector' // Get the <select> element with the class 'deviceSelector'
var selectElement = $('.deviceSelector select'); var selectElement = $('.deviceSelector select');
// Iterate over each option within the select element // Iterate over each option within the select element
selectElement.find('option').each(function() { selectElement.find('option').each(function() {
// Mark each option as selected // Mark each option as selected
@@ -298,13 +299,13 @@
function markAllNotSelected() { function markAllNotSelected() {
// Get the <select> element with the class 'deviceSelector' // Get the <select> element with the class 'deviceSelector'
var selectElement = $('.deviceSelector select'); var selectElement = $('.deviceSelector select');
// Iterate over each option within the select element // Iterate over each option within the select element
selectElement.find('option').each(function() { selectElement.find('option').each(function() {
// Unselect each option // Unselect each option
$(this).prop('selected', false); $(this).prop('selected', false);
}); });
// Trigger the 'change' event to notify Bootstrap Select of the changes // Trigger the 'change' event to notify Bootstrap Select of the changes
selectElement.trigger('change'); selectElement.trigger('change');
} }
@@ -341,13 +342,13 @@
// update selected // update selected
if(selectorMacs() != "") if(selectorMacs() != "")
{ {
executeAction('update', 'devMac', selectorMacs(), targetColumns, columnValue ) executeAction('update', 'devMac', selectorMacs(), targetColumns, columnValue )
} }
else else
{ {
showModalWarning(getString("Gen_Error"), getString('Device_MultiEdit_No_Devices')); showModalWarning(getString("Gen_Error"), getString('Device_MultiEdit_No_Devices'));
} }
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
@@ -380,21 +381,21 @@ function executeAction(action, whereColumnName, key, targetColumns, newTargetCol
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Ask to delete selected devices // Ask to delete selected devices
function askDeleteSelectedDevices () { function askDeleteSelectedDevices () {
// Ask // Ask
showModalWarning( showModalWarning(
getString('Maintenance_Tool_del_alldev_noti'), getString('Maintenance_Tool_del_alldev_noti'),
getString('Gen_AreYouSure'), getString('Gen_AreYouSure'),
getString('Gen_Cancel'), getString('Gen_Cancel'),
getString('Gen_Delete'), getString('Gen_Delete'),
'deleteSelectedDevices'); 'deleteSelectedDevices');
} }
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// Delete selected devices // Delete selected devices
function deleteSelectedDevices() function deleteSelectedDevices()
{ {
macs_tmp = selectorMacs() macs_tmp = selectorMacs()
executeAction('delete', 'devMac', macs_tmp ) executeAction('delete', 'devMac', macs_tmp )
write_notification('[Multi edit] Manually deleted devices with MACs:' + macs_tmp, 'info') write_notification('[Multi edit] Manually deleted devices with MACs:' + macs_tmp, 'info')

View File

@@ -1,26 +1,26 @@
<?php <?php
require 'php/templates/header.php'; require 'php/templates/header.php';
require 'php/templates/modals.php'; require 'php/templates/modals.php';
?> ?>
<script> <script>
// show spinning icon // show spinning icon
showSpinner() showSpinner()
</script> </script>
<!-- Page ------------------------------------------------------------------ --> <!-- Page ------------------------------------------------------------------ -->
<div class="content-wrapper"> <div class="content-wrapper">
<span class="helpIcon"> <span class="helpIcon">
<a target="_blank" href="https://github.com/jokob-sk/NetAlertX/blob/main/docs/NETWORK_TREE.md"> <a target="_blank" href="https://github.com/jokob-sk/NetAlertX/blob/main/docs/NETWORK_TREE.md">
<i class="fa fa-circle-question"></i> <i class="fa fa-circle-question"></i>
</a> </a>
</span> </span>
<div id="toggleFilters" class=""> <div id="toggleFilters" class="">
<div class="checkbox icheck col-xs-12"> <div class="checkbox icheck col-xs-12">
<label> <label>
<input type="checkbox" name="showOffline" checked> <input type="checkbox" name="showOffline" checked>
<div style="margin-left: 10px; display: inline-block; vertical-align: top;"> <div style="margin-left: 10px; display: inline-block; vertical-align: top;">
<?= lang('Network_ShowOffline');?> <?= lang('Network_ShowOffline');?>
<span id="showOfflineNumber"> <span id="showOfflineNumber">
<!-- placeholder --> <!-- placeholder -->
@@ -31,14 +31,14 @@
<div class="checkbox icheck col-xs-12"> <div class="checkbox icheck col-xs-12">
<label> <label>
<input type="checkbox" name="showArchived"> <input type="checkbox" name="showArchived">
<div style="margin-left: 10px; display: inline-block; vertical-align: top;"> <div style="margin-left: 10px; display: inline-block; vertical-align: top;">
<?= lang('Network_ShowArchived');?> <?= lang('Network_ShowArchived');?>
<span id="showArchivedNumber"> <span id="showArchivedNumber">
<!-- placeholder --> <!-- placeholder -->
</span> </span>
</div> </div>
</label> </label>
</div> </div>
</div> </div>
<div id="networkTree" class="drag"> <div id="networkTree" class="drag">
@@ -55,8 +55,8 @@
</div> </div>
<div class="tab-content"> <div class="tab-content">
<!-- Placeholder --> <!-- Placeholder -->
</div> </div>
</section> </section>
<section id="unassigned-devices-wrapper"> <section id="unassigned-devices-wrapper">
<!-- Placeholder --> <!-- Placeholder -->
</section> </section>
@@ -69,7 +69,7 @@
require 'php/templates/footer.php'; require 'php/templates/footer.php';
?> ?>
<script src="lib/treeviz/bundle.js"></script> <script src="lib/treeviz/bundle.js"></script>
<script defer> <script defer>
@@ -78,12 +78,12 @@
// Create Top level tabs (List of network devices), explanation of the terminology below: // Create Top level tabs (List of network devices), explanation of the terminology below:
// //
// Switch 1 (node) // Switch 1 (node)
// /(p1) \ (p2) <----- port numbers // /(p1) \ (p2) <----- port numbers
// / \ // / \
// Smart TV (leaf) Switch 2 (node (for the PC) and leaf (for Switch 1)) // Smart TV (leaf) Switch 2 (node (for the PC) and leaf (for Switch 1))
// \ // \
// PC (leaf) <------- leafs are not included in this SQL query // PC (leaf) <------- leafs are not included in this SQL query
const rawSql = ` const rawSql = `
SELECT node_name, node_mac, online, node_type, node_ports_count, parent_mac, node_icon, node_alert SELECT node_name, node_mac, online, node_type, node_ports_count, parent_mac, node_icon, node_alert
FROM ( FROM (
@@ -120,7 +120,7 @@
const portLabel = node.node_ports_count ? ` (${node.node_ports_count})` : ''; const portLabel = node.node_ports_count ? ` (${node.node_ports_count})` : '';
const icon = atob(node.node_icon); const icon = atob(node.node_icon);
const id = node.node_mac.replace(/:/g, '_'); const id = node.node_mac.replace(/:/g, '_');
html += ` html += `
<li class="networkNodeTabHeaders ${i === 0 ? 'active' : ''}"> <li class="networkNodeTabHeaders ${i === 0 ? 'active' : ''}">
@@ -137,13 +137,13 @@
renderNetworkTabContent(nodes); renderNetworkTabContent(nodes);
// init selected (first) tab // init selected (first) tab
initTab(); initTab();
// init selected node highlighting // init selected node highlighting
initSelectedNodeHighlighting() initSelectedNodeHighlighting()
// Register events on tab change // Register events on tab change
$('a[data-toggle="tab"]').on('shown.bs.tab', function (e) { $('a[data-toggle="tab"]').on('shown.bs.tab', function (e) {
initSelectedNodeHighlighting() initSelectedNodeHighlighting()
}); });
} }
@@ -205,10 +205,10 @@
<hr/> <hr/>
<div class="box box-aqua box-body" id="connected"> <div class="box box-aqua box-body" id="connected">
<h5> <h5>
<i class="fa fa-sitemap fa-rotate-270"></i> <i class="fa fa-sitemap fa-rotate-270"></i>
${getString('Network_Connected')} ${getString('Network_Connected')}
</h5> </h5>
<div id="leafs_${id}" class="table-responsive"></div> <div id="leafs_${id}" class="table-responsive"></div>
</div> </div>
</div> </div>
@@ -234,9 +234,9 @@
return; return;
} }
$container.html(wrapperHtml); $container.html(wrapperHtml);
const $table = $(`#${tableId}`); const $table = $(`#${tableId}`);
const columns = [ const columns = [
@@ -298,7 +298,7 @@
title: getString('Device_TableHead_Vendor'), title: getString('Device_TableHead_Vendor'),
data: 'devVendor', data: 'devVendor',
width: '20%' width: '20%'
} }
].filter(Boolean); ].filter(Boolean);
@@ -356,7 +356,7 @@
function loadConnectedDevices(node_mac) { function loadConnectedDevices(node_mac) {
const sql = ` const sql = `
SELECT devName, devMac, devLastIP, devVendor, devPresentLastScan, devAlertDown, devParentPort, SELECT devName, devMac, devLastIP, devVendor, devPresentLastScan, devAlertDown, devParentPort,
CASE CASE
WHEN devIsNew = 1 THEN 'New' WHEN devIsNew = 1 THEN 'New'
WHEN devPresentLastScan = 1 THEN 'On-line' WHEN devPresentLastScan = 1 THEN 'On-line'
WHEN devPresentLastScan = 0 AND devAlertDown != 0 THEN 'Down' WHEN devPresentLastScan = 0 AND devAlertDown != 0 THEN 'Down'
@@ -371,7 +371,7 @@
const wrapperHtml = ` const wrapperHtml = `
<table class="table table-bordered table-striped node-leafs-table " id="table_leafs_${id}" data-node-mac="${node_mac}"> <table class="table table-bordered table-striped node-leafs-table " id="table_leafs_${id}" data-node-mac="${node_mac}">
</table>`; </table>`;
loadDeviceTable({ loadDeviceTable({
@@ -414,12 +414,12 @@
$.get(apiUrl, function (data) { $.get(apiUrl, function (data) {
console.log(data); console.log(data);
const parsed = JSON.parse(data); const parsed = JSON.parse(data);
const allDevices = parsed; const allDevices = parsed;
console.log(allDevices); console.log(allDevices);
if (!allDevices || allDevices.length === 0) { if (!allDevices || allDevices.length === 0) {
showModalOK(getString('Gen_Warning'), getString('Network_NoDevices')); showModalOK(getString('Gen_Warning'), getString('Network_NoDevices'));
@@ -439,7 +439,7 @@
{ {
$('#showArchivedNumber').text(`(${archivedCount})`); $('#showArchivedNumber').text(`(${archivedCount})`);
} }
if(offlineCount > 0) if(offlineCount > 0)
{ {
$('#showOfflineNumber').text(`(${offlineCount})`); $('#showOfflineNumber').text(`(${offlineCount})`);
@@ -462,10 +462,17 @@
switch (orderTopologyBy[0]) { switch (orderTopologyBy[0]) {
case "Name": case "Name":
const nameCompare = a.devName.localeCompare(b.devName); // ensuring string
return nameCompare !== 0 ? nameCompare : parsePort(a.devParentPort) - parsePort(b.devParentPort); const nameA = (a.devName ?? "").toString();
const nameB = (b.devName ?? "").toString();
const nameCompare = nameA.localeCompare(nameB);
return nameCompare !== 0
? nameCompare
: parsePort(a.devParentPort) - parsePort(b.devParentPort);
case "Port": case "Port":
return parsePort(a.devParentPort) - parsePort(b.devParentPort); return parsePort(a.devParentPort) - parsePort(b.devParentPort);
default: default:
return a.rowid - b.rowid; return a.rowid - b.rowid;
} }
@@ -494,7 +501,7 @@ var visibleNodesCount = 0;
var parentNodesCount = 0; var parentNodesCount = 0;
var hiddenMacs = []; // hidden children var hiddenMacs = []; // hidden children
var hiddenChildren = []; var hiddenChildren = [];
var deviceListGlobal = null; var deviceListGlobal = null;
// --------------------------------------------------------------------------- // ---------------------------------------------------------------------------
// Recursively get children nodes and build a tree // Recursively get children nodes and build a tree
@@ -514,13 +521,17 @@ function getChildren(node, list, path, visited = [])
// Loop through all items to find children of the current node // Loop through all items to find children of the current node
for (var i in list) { for (var i in list) {
if (list[i].devParentMAC.toLowerCase() == node.devMac.toLowerCase() && !hiddenMacs.includes(list[i].devParentMAC)) { const item = list[i];
const parentMac = item.devParentMAC || ""; // null-safe
const nodeMac = node.devMac || ""; // null-safe
visibleNodesCount++; if (parentMac != "" && parentMac.toLowerCase() == nodeMac.toLowerCase() && !hiddenMacs.includes(parentMac)) {
// Process children recursively, passing a copy of the visited list visibleNodesCount++;
children.push(getChildren(list[i], list, path + ((path == "") ? "" : '|') + list[i].devParentMAC, visited));
} // Process children recursively, passing a copy of the visited list
children.push(getChildren(list[i], list, path + ((path == "") ? "" : '|') + parentMac, visited));
}
} }
// Track leaf and parent node counts // Track leaf and parent node counts
@@ -530,7 +541,7 @@ function getChildren(node, list, path, visited = [])
parentNodesCount++; parentNodesCount++;
} }
return { return {
name: node.devName, name: node.devName,
path: path, path: path,
mac: node.devMac, mac: node.devMac,
@@ -555,19 +566,32 @@ function getChildren(node, list, path, visited = [])
}; };
} }
// --------------------------------------------------------------------------- // ---------------------------------------------------------------------------
function getHierarchy() function getHierarchy()
{ {
let internetNode = null;
for(i in deviceListGlobal) for(i in deviceListGlobal)
{ {
if(deviceListGlobal[i].devMac == 'Internet') if(deviceListGlobal[i].devMac == 'Internet')
{ {
return (getChildren(deviceListGlobal[i], deviceListGlobal, '')) internetNode = deviceListGlobal[i];
return (getChildren(internetNode, deviceListGlobal, ''))
break; break;
} }
} }
if (!internetNode) {
showModalOk(
getString('Network_Configuration_Error'),
getString('Network_Root_Not_Configured')
);
console.error("getHierarchy(): Internet node not found");
return null;
}
} }
//--------------------------------------------------------------------------- //---------------------------------------------------------------------------
function toggleSubTree(parentMac, treePath) function toggleSubTree(parentMac, treePath)
{ {
@@ -586,33 +610,33 @@ function toggleSubTree(parentMac, treePath)
myTree.refresh(updatedTree); myTree.refresh(updatedTree);
// re-attach any onclick events // re-attach any onclick events
attachTreeEvents(); attachTreeEvents();
} }
// --------------------------------------------------------------------------- // ---------------------------------------------------------------------------
function attachTreeEvents() function attachTreeEvents()
{ {
// toggle subtree functionality // toggle subtree functionality
$("div[data-mytreemac]").each(function(){ $("div[data-mytreemac]").each(function(){
$(this).attr('onclick', 'toggleSubTree("'+$(this).attr('data-mytreemac')+'","'+ $(this).attr('data-mytreepath')+'")') $(this).attr('onclick', 'toggleSubTree("'+$(this).attr('data-mytreemac')+'","'+ $(this).attr('data-mytreepath')+'")')
}); });
} }
// --------------------------------------------------------------------------- // ---------------------------------------------------------------------------
// Handle network node click - select correct tab in the bottom table // Handle network node click - select correct tab in the bottom table
function handleNodeClick(el) function handleNodeClick(el)
{ {
isNetworkDevice = $(el).data("devisnetworknodedynamic") == 1; isNetworkDevice = $(el).data("devisnetworknodedynamic") == 1;
targetTabMAC = "" targetTabMAC = ""
thisDevMac= $(el).data("mac"); thisDevMac= $(el).data("mac");
if (isNetworkDevice == false) if (isNetworkDevice == false)
{ {
targetTabMAC = $(el).data("parentmac"); targetTabMAC = $(el).data("parentmac");
} else } else
{ {
targetTabMAC = thisDevMac; targetTabMAC = thisDevMac;
} }
var targetTab = $(`a[data-mytabmac="${targetTabMAC}"]`); var targetTab = $(`a[data-mytabmac="${targetTabMAC}"]`);
@@ -621,8 +645,8 @@ function handleNodeClick(el)
// Simulate a click event on the target tab // Simulate a click event on the target tab
targetTab.click(); targetTab.click();
} }
if (isNetworkDevice) { if (isNetworkDevice) {
// Smooth scroll to the tab content // Smooth scroll to the tab content
@@ -632,7 +656,7 @@ function handleNodeClick(el)
} else { } else {
$("tr.selected").removeClass("selected"); $("tr.selected").removeClass("selected");
$(`tr[data-mac="${thisDevMac}"]`).addClass("selected"); $(`tr[data-mac="${thisDevMac}"]`).addClass("selected");
const tableId = "table_leafs_" + targetTabMAC.replace(/:/g, '_'); const tableId = "table_leafs_" + targetTabMAC.replace(/:/g, '_');
const $table = $(`#${tableId}`).DataTable(); const $table = $(`#${tableId}`).DataTable();
@@ -662,10 +686,8 @@ function handleNodeClick(el)
} }
} }
// --------------------------------------------------------------------------- // ---------------------------------------------------------------------------
var myTree; var myTree;
var emSize; var emSize;
var nodeHeight; var nodeHeight;
// var sizeCoefficient = 1.4 // var sizeCoefficient = 1.4
@@ -682,140 +704,139 @@ function emToPx(em, element) {
function initTree(myHierarchy) function initTree(myHierarchy)
{ {
// calculate the drawing area based on teh tree width and available screen size if(myHierarchy && myHierarchy.type !== "")
let baseFontSize = parseFloat($('html').css('font-size'));
let treeAreaHeight = ($(window).height() - 155); ;
// calculate the font size of the leaf nodes to fit everything into the tree area
leafNodesCount == 0 ? 1 : leafNodesCount;
emSize = pxToEm((treeAreaHeight/(leafNodesCount)).toFixed(2));
let screenWidthEm = pxToEm($('.networkTable').width()-15);
// init the drawing area size
$("#networkTree").attr('style', `height:${treeAreaHeight}px; width:${emToPx(screenWidthEm)}px`)
if(myHierarchy.type == "")
{ {
showModalOk(getString('Network_Configuration_Error'), getString('Network_Root_Not_Configured')) // calculate the drawing area based on the tree width and available screen size
let baseFontSize = parseFloat($('html').css('font-size'));
return; let treeAreaHeight = ($(window).height() - 155); ;
// calculate the font size of the leaf nodes to fit everything into the tree area
leafNodesCount == 0 ? 1 : leafNodesCount;
emSize = pxToEm((treeAreaHeight/(leafNodesCount)).toFixed(2));
let screenWidthEm = pxToEm($('.networkTable').width()-15);
// init the drawing area size
$("#networkTree").attr('style', `height:${treeAreaHeight}px; width:${emToPx(screenWidthEm)}px`)
// handle canvas and node size if only a few nodes
emSize > 1 ? emSize = 1 : emSize = emSize;
let nodeHeightPx = emToPx(emSize*1);
let nodeWidthPx = emToPx(screenWidthEm / (parentNodesCount));
// handle if only a few nodes
nodeWidthPx > 160 ? nodeWidthPx = 160 : nodeWidthPx = nodeWidthPx;
console.log(Treeviz);
myTree = Treeviz.create({
htmlId: "networkTree",
renderNode: nodeData => {
(!emptyArr.includes(nodeData.data.port )) ? port = nodeData.data.port : port = "";
(port == "" || port == 0 || port == 'None' ) ? portBckgIcon = `<i class="fa fa-wifi"></i>` : portBckgIcon = `<i class="fa fa-ethernet"></i>`;
portHtml = (port == "" || port == 0 || port == 'None' ) ? " &nbsp " : port;
// Build HTML for individual nodes in the network diagram
deviceIcon = (!emptyArr.includes(nodeData.data.icon )) ?
`<div class="netIcon">
${atob(nodeData.data.icon)}
</div>` : "";
devicePort = `<div class="netPort"
style="width:${emSize}em;height:${emSize}em">
${portHtml}</div>
<div class="portBckgIcon"
style="margin-left:-${emSize*0.7}em;">
${portBckgIcon}
</div>`;
collapseExpandIcon = nodeData.data.hiddenChildren ?
"square-plus" : "square-minus";
// generate +/- icon if node has children nodes
collapseExpandHtml = nodeData.data.hasChildren ?
`<div class="netCollapse"
style="font-size:${nodeHeightPx/2}px;top:${Math.floor(nodeHeightPx / 4)}px"
data-mytreepath="${nodeData.data.path}"
data-mytreemac="${nodeData.data.mac}">
<i class="fa fa-${collapseExpandIcon} pointer"></i>
</div>` : "";
selectedNodeMac = $(".nav-tabs-custom .active a").attr('data-mytabmac')
highlightedCss = nodeData.data.mac == selectedNodeMac ?
" highlightedNode " : "";
cssNodeType = nodeData.data.devIsNetworkNodeDynamic ?
" node-network-device " : " node-standard-device ";
networkHardwareIcon = nodeData.data.devIsNetworkNodeDynamic ? `<span class="network-hw-icon">
<i class="fa-solid fa-hard-drive"></i>
</span>` : "";
const badgeConf = getStatusBadgeParts(nodeData.data.presentLastScan, nodeData.data.alertDown, nodeData.data.mac, statusText = '')
return result = `<div
class="node-inner hover-node-info box pointer ${highlightedCss} ${cssNodeType}"
style="height:${nodeHeightPx}px;font-size:${nodeHeightPx-5}px;"
onclick="handleNodeClick(this)"
data-mac="${nodeData.data.mac}"
data-parentMac="${nodeData.data.parentMac}"
data-name="${nodeData.data.name}"
data-ip="${nodeData.data.ip}"
data-mac="${nodeData.data.mac}"
data-vendor="${nodeData.data.vendor}"
data-type="${nodeData.data.type}"
data-devIsNetworkNodeDynamic="${nodeData.data.devIsNetworkNodeDynamic}"
data-lastseen="${nodeData.data.lastseen}"
data-firstseen="${nodeData.data.firstseen}"
data-relationship="${nodeData.data.relType}"
data-status="${nodeData.data.status}"
data-present="${nodeData.data.presentLastScan}"
data-alert="${nodeData.data.alertDown}"
data-icon="${nodeData.data.icon}"
>
<div class="netNodeText">
<strong><span>${devicePort} <span class="${badgeConf.cssText}">${deviceIcon}</span></span>
<span class="spanNetworkTree anonymizeDev" style="width:${nodeWidthPx-50}px">${nodeData.data.name}</span>
${networkHardwareIcon}
</strong>
</div>
</div>
${collapseExpandHtml}`;
},
mainAxisNodeSpacing: 'auto',
// secondaryAxisNodeSpacing: 0.3,
nodeHeight: nodeHeightPx,
nodeWidth: nodeWidthPx,
marginTop: '5',
isHorizontal : true,
hasZoom: true,
hasPan: true,
marginLeft: '10',
marginRight: '10',
idKey: "mac",
hasFlatData: false,
relationnalField: "children",
linkWidth: (nodeData) => 2,
linkColor: (nodeData) => {
relConf = getRelationshipConf(nodeData.data.relType)
return relConf.color;
}
// onNodeClick: (nodeData) => handleNodeClick(nodeData),
});
console.log(deviceListGlobal);
myTree.refresh(myHierarchy);
// hide spinning icon
hideSpinner()
} else
{
console.error("getHierarchy() not returning expected result");
} }
// handle canvas and node size if only a few nodes
emSize > 1 ? emSize = 1 : emSize = emSize;
let nodeHeightPx = emToPx(emSize*1);
let nodeWidthPx = emToPx(screenWidthEm / (parentNodesCount));
// handle if only a few nodes
nodeWidthPx > 160 ? nodeWidthPx = 160 : nodeWidthPx = nodeWidthPx;
console.log(Treeviz);
myTree = Treeviz.create({
htmlId: "networkTree",
renderNode: nodeData => {
(!emptyArr.includes(nodeData.data.port )) ? port = nodeData.data.port : port = "";
(port == "" || port == 0 || port == 'None' ) ? portBckgIcon = `<i class="fa fa-wifi"></i>` : portBckgIcon = `<i class="fa fa-ethernet"></i>`;
portHtml = (port == "" || port == 0 || port == 'None' ) ? " &nbsp " : port;
// Build HTML for individual nodes in the network diagram
deviceIcon = (!emptyArr.includes(nodeData.data.icon )) ?
`<div class="netIcon">
${atob(nodeData.data.icon)}
</div>` : "";
devicePort = `<div class="netPort"
style="width:${emSize}em;height:${emSize}em">
${portHtml}</div>
<div class="portBckgIcon"
style="margin-left:-${emSize*0.7}em;">
${portBckgIcon}
</div>`;
collapseExpandIcon = nodeData.data.hiddenChildren ?
"square-plus" : "square-minus";
// generate +/- icon if node has children nodes
collapseExpandHtml = nodeData.data.hasChildren ?
`<div class="netCollapse"
style="font-size:${nodeHeightPx/2}px;top:${Math.floor(nodeHeightPx / 4)}px"
data-mytreepath="${nodeData.data.path}"
data-mytreemac="${nodeData.data.mac}">
<i class="fa fa-${collapseExpandIcon} pointer"></i>
</div>` : "";
selectedNodeMac = $(".nav-tabs-custom .active a").attr('data-mytabmac')
highlightedCss = nodeData.data.mac == selectedNodeMac ?
" highlightedNode " : "";
cssNodeType = nodeData.data.devIsNetworkNodeDynamic ?
" node-network-device " : " node-standard-device ";
networkHardwareIcon = nodeData.data.devIsNetworkNodeDynamic ? `<span class="network-hw-icon">
<i class="fa-solid fa-hard-drive"></i>
</span>` : "";
const badgeConf = getStatusBadgeParts(nodeData.data.presentLastScan, nodeData.data.alertDown, nodeData.data.mac, statusText = '')
return result = `<div
class="node-inner hover-node-info box pointer ${highlightedCss} ${cssNodeType}"
style="height:${nodeHeightPx}px;font-size:${nodeHeightPx-5}px;"
onclick="handleNodeClick(this)"
data-mac="${nodeData.data.mac}"
data-parentMac="${nodeData.data.parentMac}"
data-name="${nodeData.data.name}"
data-ip="${nodeData.data.ip}"
data-mac="${nodeData.data.mac}"
data-vendor="${nodeData.data.vendor}"
data-type="${nodeData.data.type}"
data-devIsNetworkNodeDynamic="${nodeData.data.devIsNetworkNodeDynamic}"
data-lastseen="${nodeData.data.lastseen}"
data-firstseen="${nodeData.data.firstseen}"
data-relationship="${nodeData.data.relType}"
data-status="${nodeData.data.status}"
data-present="${nodeData.data.presentLastScan}"
data-alert="${nodeData.data.alertDown}"
data-icon="${nodeData.data.icon}"
>
<div class="netNodeText">
<strong><span>${devicePort} <span class="${badgeConf.cssText}">${deviceIcon}</span></span>
<span class="spanNetworkTree anonymizeDev" style="width:${nodeWidthPx-50}px">${nodeData.data.name}</span>
${networkHardwareIcon}
</strong>
</div>
</div>
${collapseExpandHtml}`;
},
mainAxisNodeSpacing: 'auto',
// secondaryAxisNodeSpacing: 0.3,
nodeHeight: nodeHeightPx,
nodeWidth: nodeWidthPx,
marginTop: '5',
isHorizontal : true,
hasZoom: true,
hasPan: true,
marginLeft: '10',
marginRight: '10',
idKey: "mac",
hasFlatData: false,
relationnalField: "children",
linkWidth: (nodeData) => 2,
linkColor: (nodeData) => {
relConf = getRelationshipConf(nodeData.data.relType)
return relConf.color;
}
// onNodeClick: (nodeData) => handleNodeClick(nodeData),
});
console.log(deviceListGlobal);
myTree.refresh(myHierarchy);
// hide spinning icon
hideSpinner()
} }
@@ -832,11 +853,11 @@ function initTab()
selectedTab = "Internet_id" selectedTab = "Internet_id"
// the #target from the url // the #target from the url
target = getQueryString('mac') target = getQueryString('mac')
// update cookie if target specified // update cookie if target specified
if(target != "") if(target != "")
{ {
setCache(key, target.replaceAll(":","_")+'_id') // _id is added so it doesn't conflict with AdminLTE tab behavior setCache(key, target.replaceAll(":","_")+'_id') // _id is added so it doesn't conflict with AdminLTE tab behavior
} }
@@ -853,12 +874,12 @@ function initTab()
$('a[data-toggle="tab"]').on('shown.bs.tab', function (e) { $('a[data-toggle="tab"]').on('shown.bs.tab', function (e) {
setCache(key, $(e.target).attr('id')) setCache(key, $(e.target).attr('id'))
}); });
} }
// --------------------------------------------------------------------------- // ---------------------------------------------------------------------------
function initSelectedNodeHighlighting() function initSelectedNodeHighlighting()
{ {
var currentNodeMac = $(".networkNodeTabHeaders.active a").data("mytabmac"); var currentNodeMac = $(".networkNodeTabHeaders.active a").data("mytabmac");
@@ -875,7 +896,7 @@ function initSelectedNodeHighlighting()
newSelNode = $("#networkTree div[data-mac='"+currentNodeMac+"']")[0] newSelNode = $("#networkTree div[data-mac='"+currentNodeMac+"']")[0]
console.log(newSelNode) console.log(newSelNode)
$(newSelNode).attr('class', $(newSelNode).attr('class') + ' highlightedNode') $(newSelNode).attr('class', $(newSelNode).attr('class') + ' highlightedNode')
} }
@@ -906,7 +927,7 @@ function updateLeaf(leafMac, action) {
} }
// --------------------------------------------------------------------------- // ---------------------------------------------------------------------------
// showing icons or device names in tabs depending on available screen size // showing icons or device names in tabs depending on available screen size
function checkTabsOverflow() { function checkTabsOverflow() {
const $ul = $('.nav-tabs'); const $ul = $('.nav-tabs');
const $lis = $ul.find('li'); const $lis = $ul.find('li');

View File

@@ -107,11 +107,11 @@
"buttons": [ "buttons": [
{ {
"labelStringCode": "Maint_PurgeLog", "labelStringCode": "Maint_PurgeLog",
"event": "logManage('crond.log', 'cleanLog')" "event": "logManage('cron.log', 'cleanLog')"
} }
], ],
"fileName": "crond.log", "fileName": "cron.log",
"filePath": "__NETALERTX_LOG__/crond.log", "filePath": "__NETALERTX_LOG__/cron.log",
"textAreaCssClass": "logs logs-small" "textAreaCssClass": "logs logs-small"
} }
] ]

View File

@@ -1,7 +1,7 @@
<?php <?php
//------------------------------------------------------------------------------ //------------------------------------------------------------------------------
// NetAlertX // NetAlertX
// Open Source Network Guard / WIFI & LAN intrusion detector // Open Source Network Guard / WIFI & LAN intrusion detector
// //
// util.php - Front module. Server side. Common generic functions // util.php - Front module. Server side. Common generic functions
//------------------------------------------------------------------------------ //------------------------------------------------------------------------------
@@ -22,8 +22,8 @@ $ACTION = "";
// init request params // init request params
if(array_key_exists('function', $_REQUEST) != FALSE) if(array_key_exists('function', $_REQUEST) != FALSE)
{ {
$FUNCTION = $_REQUEST['function']; $FUNCTION = $_REQUEST['function'];
} }
if(array_key_exists('settings', $_REQUEST) != FALSE) if(array_key_exists('settings', $_REQUEST) != FALSE)
{ {
@@ -33,13 +33,13 @@ if(array_key_exists('settings', $_REQUEST) != FALSE)
// call functions based on requested params // call functions based on requested params
switch ($FUNCTION) { switch ($FUNCTION) {
case 'savesettings': case 'savesettings':
saveSettings(); saveSettings();
break; break;
case 'cleanLog': case 'cleanLog':
cleanLog($SETTINGS); cleanLog($SETTINGS);
break; break;
@@ -66,7 +66,7 @@ switch ($FUNCTION) {
// Creates a PHP array from a string representing a python array (input format ['...','...']) // Creates a PHP array from a string representing a python array (input format ['...','...'])
// Only supports: // Only supports:
// - one level arrays, not nested ones // - one level arrays, not nested ones
// - single quotes // - single quotes
function createArray($input){ function createArray($input){
// empty array // empty array
@@ -81,9 +81,9 @@ function createArray($input){
$replacement = ''; $replacement = '';
// remove brackets // remove brackets
$noBrackets = preg_replace($patternBrackets, $replacement, $input); $noBrackets = preg_replace($patternBrackets, $replacement, $input);
$options = array(); $options = array();
// create array // create array
$optionsTmp = explode(",", $noBrackets); $optionsTmp = explode(",", $noBrackets);
@@ -99,7 +99,7 @@ function createArray($input){
{ {
array_push($options, preg_replace($patternQuotes, $replacement, $item) ); array_push($options, preg_replace($patternQuotes, $replacement, $item) );
} }
return $options; return $options;
} }
@@ -117,7 +117,7 @@ function printArray ($array) {
{ {
echo $val.', '; echo $val.', ';
} }
} }
echo ']<br/>'; echo ']<br/>';
} }
@@ -171,9 +171,9 @@ function checkPermissions($files)
if(file_exists($file) != 1) if(file_exists($file) != 1)
{ {
$message = "File '".$file."' not found or inaccessible. Correct file permissions, create one yourself or generate a new one in 'Settings' by clicking the 'Save' button."; $message = "File '".$file."' not found or inaccessible. Correct file permissions, create one yourself or generate a new one in 'Settings' by clicking the 'Save' button.";
displayMessage($message, TRUE); displayMessage($message, TRUE);
} }
} }
} }
// ---------------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------------
@@ -189,8 +189,8 @@ function displayMessage($message, $logAlert = FALSE, $logConsole = TRUE, $logFil
$message = str_replace(array("\n", "\r", PHP_EOL), '', $message); $message = str_replace(array("\n", "\r", PHP_EOL), '', $message);
echo "<script>function escape(html, encode) { echo "<script>function escape(html, encode) {
return html.replace(!encode ? /&(?!#?\w+;)/g : /&/g, '&amp;') return html.replace(!encode ? /&(?!#?\w+;)/g : /&/g, '&amp;')
.replace(/\t/g, '') .replace(/\t/g, '')
}</script>"; }</script>";
// Javascript Alert pop-up // Javascript Alert pop-up
@@ -210,7 +210,7 @@ function displayMessage($message, $logAlert = FALSE, $logConsole = TRUE, $logFil
{ {
if (is_writable($logFolderPath.$log_file)) { if (is_writable($logFolderPath.$log_file)) {
if(file_exists($logFolderPath.$log_file) != 1) // file doesn't exist, create one if(file_exists($logFolderPath.$log_file) != 1) // file doesn't exist, create one
{ {
@@ -219,7 +219,7 @@ function displayMessage($message, $logAlert = FALSE, $logConsole = TRUE, $logFil
{ {
$log = fopen($logFolderPath.$log_file, "a") or die("Unable to open file - Permissions issue!"); $log = fopen($logFolderPath.$log_file, "a") or die("Unable to open file - Permissions issue!");
} }
fwrite($log, "[".$timestamp. "] " . str_replace('<br>',"\n ",str_replace('<br/>',"\n ",$message)).PHP_EOL."" ); fwrite($log, "[".$timestamp. "] " . str_replace('<br>',"\n ",str_replace('<br/>',"\n ",$message)).PHP_EOL."" );
fclose($log); fclose($log);
@@ -269,13 +269,13 @@ function addToExecutionQueue($action)
// equivalent: /logs DELETE // equivalent: /logs DELETE
// 🔺----- API ENDPOINTS SUPERSEDED -----🔺 // 🔺----- API ENDPOINTS SUPERSEDED -----🔺
function cleanLog($logFile) function cleanLog($logFile)
{ {
global $logFolderPath, $timestamp; global $logFolderPath, $timestamp;
$path = ""; $path = "";
$allowedFiles = ['app.log', 'app_front.log', 'IP_changes.log', 'stdout.log', 'stderr.log', 'app.php_errors.log', 'execution_queue.log', 'db_is_locked.log', 'nginx-error.log', 'crond.log']; $allowedFiles = ['app.log', 'app_front.log', 'IP_changes.log', 'stdout.log', 'stderr.log', 'app.php_errors.log', 'execution_queue.log', 'db_is_locked.log', 'nginx-error.log', 'cron.log'];
if(in_array($logFile, $allowedFiles)) if(in_array($logFile, $allowedFiles))
{ {
$path = $logFolderPath.$logFile; $path = $logFolderPath.$logFile;
@@ -287,11 +287,11 @@ function cleanLog($logFile)
$file = fopen($path, "w") or die("Unable to open file!"); $file = fopen($path, "w") or die("Unable to open file!");
fwrite($file, ""); fwrite($file, "");
fclose($file); fclose($file);
displayMessage('File <code>'.$logFile.'</code> purged.', FALSE, TRUE, TRUE, TRUE); displayMessage('File <code>'.$logFile.'</code> purged.', FALSE, TRUE, TRUE, TRUE);
} else } else
{ {
displayMessage('File <code>'.$logFile.'</code> is not allowed to be purged.', FALSE, TRUE, TRUE, TRUE); displayMessage('File <code>'.$logFile.'</code> is not allowed to be purged.', FALSE, TRUE, TRUE, TRUE);
} }
} }
@@ -299,23 +299,23 @@ function cleanLog($logFile)
// ---------------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------------
function saveSettings() function saveSettings()
{ {
global $SETTINGS, $FUNCTION, $config_file, $fullConfPath, $configFolderPath, $timestamp; global $SETTINGS, $FUNCTION, $config_file, $fullConfPath, $configFolderPath, $timestamp;
// save to the file // save to the file
$new_name = $config_file.'_'.$timestamp.'.backup'; $new_name = $config_file.'_'.$timestamp.'.backup';
$new_location = $configFolderPath.$new_name; $new_location = $configFolderPath.'/'.$new_name;
if(file_exists( $fullConfPath) != 1) if(file_exists( $fullConfPath) != 1)
{ {
displayMessage('File "'.$fullConfPath.'" not found or missing read permissions. Creating a new <code>'.$config_file.'</code> file.', FALSE, TRUE, TRUE, TRUE); displayMessage('File "'.$fullConfPath.'" not found or missing read permissions. Creating a new <code>'.$config_file.'</code> file.', FALSE, TRUE, TRUE, TRUE);
} }
// create a backup copy // create a backup copy
elseif (!copy($fullConfPath, $new_location)) elseif (!copy($fullConfPath, $new_location))
{ {
displayMessage("Failed to copy file ".$fullConfPath." to ".$new_location." <br/> Check your permissions to allow read/write access to the /config folder.", FALSE, TRUE, TRUE, TRUE); displayMessage("Failed to copy file ".$fullConfPath." to ".$new_location." <br/> Check your permissions to allow read/write access to the /config folder.", FALSE, TRUE, TRUE, TRUE);
} }
// generate a clean .conf file // generate a clean .conf file
$groups = []; $groups = [];
@@ -339,12 +339,12 @@ function saveSettings()
return; return;
} }
foreach ($decodedSettings as $setting) { foreach ($decodedSettings as $setting) {
if( in_array($setting[0] , $groups) == false) { if( in_array($setting[0] , $groups) == false) {
array_push($groups ,$setting[0]); array_push($groups ,$setting[0]);
} }
} }
// go thru the groups and prepare settings to write to file // go thru the groups and prepare settings to write to file
foreach ($groups as $group) { foreach ($groups as $group) {
$txt .= "\n\n# " . $group; $txt .= "\n\n# " . $group;
@@ -353,20 +353,20 @@ function saveSettings()
foreach ($decodedSettings as $setting) { foreach ($decodedSettings as $setting) {
$settingGroup = $setting[0]; $settingGroup = $setting[0];
$setKey = $setting[1]; $setKey = $setting[1];
$dataType = $setting[2]; $dataType = $setting[2];
$settingValue = $setting[3]; $settingValue = $setting[3];
// // Parse the settingType JSON // // Parse the settingType JSON
// $settingType = json_decode($settingTypeJson, true); // $settingType = json_decode($settingTypeJson, true);
// Sanity check // Sanity check
if($setKey == "UI_LANG" && $settingValue == "") { if($setKey == "UI_LANG" && $settingValue == "") {
echo "🔴 Error: important settings missing. Refresh the page with 🔃 on the top and try again."; echo "🔴 Error: important settings missing. Refresh the page with 🔃 on the top and try again.";
return; return;
} }
if ($group == $settingGroup) { if ($group == $settingGroup) {
if ($dataType == 'string' ) { if ($dataType == 'string' ) {
$val = encode_single_quotes($settingValue); $val = encode_single_quotes($settingValue);
$txt .= $setKey . "='" . $val . "'\n"; $txt .= $setKey . "='" . $val . "'\n";
@@ -381,7 +381,7 @@ function saveSettings()
$txt .= $setKey . "=" . $val . "\n"; $txt .= $setKey . "=" . $val . "\n";
} elseif ($dataType == 'array' ) { } elseif ($dataType == 'array' ) {
$temp = ''; $temp = '';
if(is_array($settingValue) == FALSE) if(is_array($settingValue) == FALSE)
{ {
$settingValue = json_decode($settingValue); $settingValue = json_decode($settingValue);
@@ -397,22 +397,22 @@ function saveSettings()
$temp = '['.$temp.']'; // wrap brackets $temp = '['.$temp.']'; // wrap brackets
$txt .= $setKey . "=" . $temp . "\n"; $txt .= $setKey . "=" . $temp . "\n";
} else { } else {
$txt .= $setKey . "='⭕Not handled⭕'\n"; $txt .= $setKey . "='⭕Not handled⭕'\n";
} }
} }
} }
} }
$txt = $txt."\n\n"; $txt = $txt."\n\n";
$txt = $txt."#-------------------IMPORTANT INFO-------------------#\n"; $txt = $txt."#-------------------IMPORTANT INFO-------------------#\n";
$txt = $txt."# This file is ingested by a python script, so if #\n"; $txt = $txt."# This file is ingested by a python script, so if #\n";
$txt = $txt."# modified it needs to use python syntax #\n"; $txt = $txt."# modified it needs to use python syntax #\n";
$txt = $txt."#-------------------IMPORTANT INFO-------------------#\n"; $txt = $txt."#-------------------IMPORTANT INFO-------------------#\n";
// open new file and write the new configuration // open new file and write the new configuration
// Create a temporary file // Create a temporary file
$tempConfPath = $fullConfPath . ".tmp"; $tempConfPath = $fullConfPath . ".tmp";
@@ -426,8 +426,8 @@ function saveSettings()
fwrite($file, $txt); fwrite($file, $txt);
fclose($file); fclose($file);
// displayMessage(lang('settings_saved'), // displayMessage(lang('settings_saved'),
// FALSE, TRUE, TRUE, TRUE); // FALSE, TRUE, TRUE, TRUE);
echo "OK"; echo "OK";
@@ -445,7 +445,7 @@ function getString ($setKey, $default) {
if ($result ) if ($result )
{ {
return $result; return $result;
} }
return $default; return $default;
} }
@@ -520,14 +520,14 @@ function getDateFromPeriod () {
$days = "3650"; //10 years $days = "3650"; //10 years
break; break;
default: default:
$days = "1"; $days = "1";
} }
$periodDateSQL = "-".$days." day"; $periodDateSQL = "-".$days." day";
return " date('now', '".$periodDateSQL."') "; return " date('now', '".$periodDateSQL."') ";
// $period = $_REQUEST['period']; // $period = $_REQUEST['period'];
// return '"'. date ('Y-m-d', strtotime ('+2 day -'. $period) ) .'"'; // return '"'. date ('Y-m-d', strtotime ('+2 day -'. $period) ) .'"';
} }
@@ -537,13 +537,13 @@ function getDateFromPeriod () {
function quotes ($text) { function quotes ($text) {
return str_replace ('"','""',$text); return str_replace ('"','""',$text);
} }
// ------------------------------------------------------------------------------------------- // -------------------------------------------------------------------------------------------
function logServerConsole ($text) { function logServerConsole ($text) {
$x = array(); $x = array();
$y = $x['__________'. $text .'__________']; $y = $x['__________'. $text .'__________'];
} }
// ------------------------------------------------------------------------------------------- // -------------------------------------------------------------------------------------------
function handleNull ($text, $default = "") { function handleNull ($text, $default = "") {
if($text == NULL || $text == 'NULL') if($text == NULL || $text == 'NULL')
@@ -553,7 +553,7 @@ function handleNull ($text, $default = "") {
{ {
return $text; return $text;
} }
} }
// ------------------------------------------------------------------------------------------- // -------------------------------------------------------------------------------------------
@@ -581,14 +581,14 @@ function decodeSpecialChars($str) {
// used in Export CSV // used in Export CSV
function getDevicesColumns(){ function getDevicesColumns(){
$columns = ["devMac", $columns = ["devMac",
"devName", "devName",
"devOwner", "devOwner",
"devType", "devType",
"devVendor", "devVendor",
"devFavorite", "devFavorite",
"devGroup", "devGroup",
"devComments", "devComments",
"devFirstConnection", "devFirstConnection",
"devLastConnection", "devLastConnection",
"devLastIP", "devLastIP",
@@ -615,8 +615,8 @@ function getDevicesColumns(){
"devFQDN", "devFQDN",
"devParentRelType", "devParentRelType",
"devReqNicsOnline" "devReqNicsOnline"
]; ];
return $columns; return $columns;
} }
@@ -646,7 +646,7 @@ function getCache($key) {
} }
// ------------------------------------------------------------------------------------------- // -------------------------------------------------------------------------------------------
function setCache($key, $value, $expireMinutes = 5) { function setCache($key, $value, $expireMinutes = 5) {
setcookie($key, $value, time()+$expireMinutes*60, "/","", 0); setcookie($key, $value, time()+$expireMinutes*60, "/","", 0);
} }

1
front/php/templates/language/ar_ar.json Executable file → Normal file
View File

@@ -311,6 +311,7 @@
"Gen_Filter": "تصفية", "Gen_Filter": "تصفية",
"Gen_Generate": "إنشاء", "Gen_Generate": "إنشاء",
"Gen_InvalidMac": "", "Gen_InvalidMac": "",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "قاعدة البيانات مقفلة", "Gen_LockedDB": "قاعدة البيانات مقفلة",
"Gen_NetworkMask": "", "Gen_NetworkMask": "",
"Gen_Offline": "غير متصل", "Gen_Offline": "غير متصل",

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "Filtrar", "Gen_Filter": "Filtrar",
"Gen_Generate": "Generar", "Gen_Generate": "Generar",
"Gen_InvalidMac": "Mac address invàlida.", "Gen_InvalidMac": "Mac address invàlida.",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "ERROR - DB podria estar bloquejada - Fes servir F12 Eines desenvolupament -> Consola o provar-ho més tard.", "Gen_LockedDB": "ERROR - DB podria estar bloquejada - Fes servir F12 Eines desenvolupament -> Consola o provar-ho més tard.",
"Gen_NetworkMask": "Màscara de xarxa", "Gen_NetworkMask": "Màscara de xarxa",
"Gen_Offline": "Fora de línia", "Gen_Offline": "Fora de línia",

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "Filtr", "Gen_Filter": "Filtr",
"Gen_Generate": "Vygenerovat", "Gen_Generate": "Vygenerovat",
"Gen_InvalidMac": "", "Gen_InvalidMac": "",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "CHYBA - Databáze je možná zamčená - Zkontrolujte F12 -> Nástroje pro vývojáře -> Konzole. nebo to zkuste později.", "Gen_LockedDB": "CHYBA - Databáze je možná zamčená - Zkontrolujte F12 -> Nástroje pro vývojáře -> Konzole. nebo to zkuste později.",
"Gen_NetworkMask": "", "Gen_NetworkMask": "",
"Gen_Offline": "Offline", "Gen_Offline": "Offline",
@@ -761,4 +762,4 @@
"settings_system_label": "", "settings_system_label": "",
"settings_update_item_warning": "", "settings_update_item_warning": "",
"test_event_tooltip": "" "test_event_tooltip": ""
} }

View File

@@ -315,6 +315,7 @@
"Gen_Filter": "Filter", "Gen_Filter": "Filter",
"Gen_Generate": "Generieren", "Gen_Generate": "Generieren",
"Gen_InvalidMac": "Ungültige MAC-Adresse.", "Gen_InvalidMac": "Ungültige MAC-Adresse.",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "ERROR - DB eventuell gesperrt - Nutze die Konsole in den Entwickler Werkzeugen (F12) zur Überprüfung oder probiere es später erneut.", "Gen_LockedDB": "ERROR - DB eventuell gesperrt - Nutze die Konsole in den Entwickler Werkzeugen (F12) zur Überprüfung oder probiere es später erneut.",
"Gen_NetworkMask": "", "Gen_NetworkMask": "",
"Gen_Offline": "Offline", "Gen_Offline": "Offline",
@@ -834,4 +835,4 @@
"settings_system_label": "System", "settings_system_label": "System",
"settings_update_item_warning": "", "settings_update_item_warning": "",
"test_event_tooltip": "Speichere die Änderungen, bevor Sie die Einstellungen testen." "test_event_tooltip": "Speichere die Änderungen, bevor Sie die Einstellungen testen."
} }

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "Filter", "Gen_Filter": "Filter",
"Gen_Generate": "Generate", "Gen_Generate": "Generate",
"Gen_InvalidMac": "Invalid Mac address.", "Gen_InvalidMac": "Invalid Mac address.",
"Gen_Invalid_Value": "An invalid value was entered",
"Gen_LockedDB": "ERROR - DB might be locked - Check F12 Dev tools -> Console or try later.", "Gen_LockedDB": "ERROR - DB might be locked - Check F12 Dev tools -> Console or try later.",
"Gen_NetworkMask": "Network mask", "Gen_NetworkMask": "Network mask",
"Gen_Offline": "Offline", "Gen_Offline": "Offline",

View File

@@ -313,6 +313,7 @@
"Gen_Filter": "Filtro", "Gen_Filter": "Filtro",
"Gen_Generate": "Generar", "Gen_Generate": "Generar",
"Gen_InvalidMac": "", "Gen_InvalidMac": "",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "Fallo - La base de datos puede estar bloqueada - Pulsa F1 -> Ajustes de desarrolladores -> Consola o prueba más tarde.", "Gen_LockedDB": "Fallo - La base de datos puede estar bloqueada - Pulsa F1 -> Ajustes de desarrolladores -> Consola o prueba más tarde.",
"Gen_NetworkMask": "", "Gen_NetworkMask": "",
"Gen_Offline": "Desconectado", "Gen_Offline": "Desconectado",

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "", "Gen_Filter": "",
"Gen_Generate": "", "Gen_Generate": "",
"Gen_InvalidMac": "", "Gen_InvalidMac": "",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "", "Gen_LockedDB": "",
"Gen_NetworkMask": "", "Gen_NetworkMask": "",
"Gen_Offline": "", "Gen_Offline": "",
@@ -761,4 +762,4 @@
"settings_system_label": "", "settings_system_label": "",
"settings_update_item_warning": "", "settings_update_item_warning": "",
"test_event_tooltip": "" "test_event_tooltip": ""
} }

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "Filtrer", "Gen_Filter": "Filtrer",
"Gen_Generate": "Générer", "Gen_Generate": "Générer",
"Gen_InvalidMac": "Adresse MAC invalide.", "Gen_InvalidMac": "Adresse MAC invalide.",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "Erreur - La base de données est peut-être verrouillée - Vérifier avec les outils de dév via F12 -> Console ou essayer plus tard.", "Gen_LockedDB": "Erreur - La base de données est peut-être verrouillée - Vérifier avec les outils de dév via F12 -> Console ou essayer plus tard.",
"Gen_NetworkMask": "Masque réseau", "Gen_NetworkMask": "Masque réseau",
"Gen_Offline": "Hors ligne", "Gen_Offline": "Hors ligne",

3
front/php/templates/language/it_it.json Executable file → Normal file
View File

@@ -311,6 +311,7 @@
"Gen_Filter": "Filtro", "Gen_Filter": "Filtro",
"Gen_Generate": "Genera", "Gen_Generate": "Genera",
"Gen_InvalidMac": "Indirizzo Mac non valido.", "Gen_InvalidMac": "Indirizzo Mac non valido.",
"Gen_Invalid_Value": "È stato inserito un valore non valido",
"Gen_LockedDB": "ERRORE: il DB potrebbe essere bloccato, controlla F12 Strumenti di sviluppo -> Console o riprova più tardi.", "Gen_LockedDB": "ERRORE: il DB potrebbe essere bloccato, controlla F12 Strumenti di sviluppo -> Console o riprova più tardi.",
"Gen_NetworkMask": "Maschera di rete", "Gen_NetworkMask": "Maschera di rete",
"Gen_Offline": "Offline", "Gen_Offline": "Offline",
@@ -761,4 +762,4 @@
"settings_system_label": "Sistema", "settings_system_label": "Sistema",
"settings_update_item_warning": "Aggiorna il valore qui sotto. Fai attenzione a seguire il formato precedente. <b>La convalida non viene eseguita.</b>", "settings_update_item_warning": "Aggiorna il valore qui sotto. Fai attenzione a seguire il formato precedente. <b>La convalida non viene eseguita.</b>",
"test_event_tooltip": "Salva le modifiche prima di provare le nuove impostazioni." "test_event_tooltip": "Salva le modifiche prima di provare le nuove impostazioni."
} }

View File

@@ -0,0 +1,765 @@
{
"API_CUSTOM_SQL_description": "",
"API_CUSTOM_SQL_name": "",
"API_TOKEN_description": "",
"API_TOKEN_name": "",
"API_display_name": "",
"API_icon": "",
"About_Design": "",
"About_Exit": "",
"About_Title": "",
"AppEvents_AppEventProcessed": "",
"AppEvents_DateTimeCreated": "",
"AppEvents_Extra": "",
"AppEvents_GUID": "",
"AppEvents_Helper1": "",
"AppEvents_Helper2": "",
"AppEvents_Helper3": "",
"AppEvents_ObjectForeignKey": "",
"AppEvents_ObjectIndex": "",
"AppEvents_ObjectIsArchived": "",
"AppEvents_ObjectIsNew": "",
"AppEvents_ObjectPlugin": "",
"AppEvents_ObjectPrimaryID": "",
"AppEvents_ObjectSecondaryID": "",
"AppEvents_ObjectStatus": "",
"AppEvents_ObjectStatusColumn": "",
"AppEvents_ObjectType": "",
"AppEvents_Plugin": "",
"AppEvents_Type": "",
"BackDevDetail_Actions_Ask_Run": "",
"BackDevDetail_Actions_Not_Registered": "",
"BackDevDetail_Actions_Title_Run": "",
"BackDevDetail_Copy_Ask": "",
"BackDevDetail_Copy_Title": "",
"BackDevDetail_Tools_WOL_error": "",
"BackDevDetail_Tools_WOL_okay": "",
"BackDevices_Arpscan_disabled": "",
"BackDevices_Arpscan_enabled": "",
"BackDevices_Backup_CopError": "",
"BackDevices_Backup_Failed": "",
"BackDevices_Backup_okay": "",
"BackDevices_DBTools_DelDevError_a": "",
"BackDevices_DBTools_DelDevError_b": "",
"BackDevices_DBTools_DelDev_a": "",
"BackDevices_DBTools_DelDev_b": "",
"BackDevices_DBTools_DelEvents": "",
"BackDevices_DBTools_DelEventsError": "",
"BackDevices_DBTools_ImportCSV": "",
"BackDevices_DBTools_ImportCSVError": "",
"BackDevices_DBTools_ImportCSVMissing": "",
"BackDevices_DBTools_Purge": "",
"BackDevices_DBTools_UpdDev": "",
"BackDevices_DBTools_UpdDevError": "",
"BackDevices_DBTools_Upgrade": "",
"BackDevices_DBTools_UpgradeError": "",
"BackDevices_Device_UpdDevError": "",
"BackDevices_Restore_CopError": "",
"BackDevices_Restore_Failed": "",
"BackDevices_Restore_okay": "",
"BackDevices_darkmode_disabled": "",
"BackDevices_darkmode_enabled": "",
"CLEAR_NEW_FLAG_description": "",
"CLEAR_NEW_FLAG_name": "",
"CustProps_cant_remove": "",
"DAYS_TO_KEEP_EVENTS_description": "",
"DAYS_TO_KEEP_EVENTS_name": "",
"DISCOVER_PLUGINS_description": "",
"DISCOVER_PLUGINS_name": "",
"DevDetail_Children_Title": "",
"DevDetail_Copy_Device_Title": "",
"DevDetail_Copy_Device_Tooltip": "",
"DevDetail_CustomProperties_Title": "",
"DevDetail_CustomProps_reset_info": "",
"DevDetail_DisplayFields_Title": "",
"DevDetail_EveandAl_AlertAllEvents": "",
"DevDetail_EveandAl_AlertDown": "",
"DevDetail_EveandAl_Archived": "",
"DevDetail_EveandAl_NewDevice": "",
"DevDetail_EveandAl_NewDevice_Tooltip": "",
"DevDetail_EveandAl_RandomMAC": "",
"DevDetail_EveandAl_ScanCycle": "",
"DevDetail_EveandAl_ScanCycle_a": "",
"DevDetail_EveandAl_ScanCycle_z": "",
"DevDetail_EveandAl_Skip": "",
"DevDetail_EveandAl_Title": "",
"DevDetail_Events_CheckBox": "",
"DevDetail_GoToNetworkNode": "",
"DevDetail_Icon": "",
"DevDetail_Icon_Descr": "",
"DevDetail_Loading": "",
"DevDetail_MainInfo_Comments": "",
"DevDetail_MainInfo_Favorite": "",
"DevDetail_MainInfo_Group": "",
"DevDetail_MainInfo_Location": "",
"DevDetail_MainInfo_Name": "",
"DevDetail_MainInfo_Network": "",
"DevDetail_MainInfo_Network_Port": "",
"DevDetail_MainInfo_Network_Site": "",
"DevDetail_MainInfo_Network_Title": "",
"DevDetail_MainInfo_Owner": "",
"DevDetail_MainInfo_SSID": "",
"DevDetail_MainInfo_Title": "",
"DevDetail_MainInfo_Type": "",
"DevDetail_MainInfo_Vendor": "",
"DevDetail_MainInfo_mac": "",
"DevDetail_NavToChildNode": "",
"DevDetail_Network_Node_hover": "",
"DevDetail_Network_Port_hover": "",
"DevDetail_Nmap_Scans": "",
"DevDetail_Nmap_Scans_desc": "",
"DevDetail_Nmap_buttonDefault": "",
"DevDetail_Nmap_buttonDefault_text": "",
"DevDetail_Nmap_buttonDetail": "",
"DevDetail_Nmap_buttonDetail_text": "",
"DevDetail_Nmap_buttonFast": "",
"DevDetail_Nmap_buttonFast_text": "",
"DevDetail_Nmap_buttonSkipDiscovery": "",
"DevDetail_Nmap_buttonSkipDiscovery_text": "",
"DevDetail_Nmap_resultsLink": "",
"DevDetail_Owner_hover": "",
"DevDetail_Periodselect_All": "",
"DevDetail_Periodselect_LastMonth": "",
"DevDetail_Periodselect_LastWeek": "",
"DevDetail_Periodselect_LastYear": "",
"DevDetail_Periodselect_today": "",
"DevDetail_Run_Actions_Title": "",
"DevDetail_Run_Actions_Tooltip": "",
"DevDetail_SessionInfo_FirstSession": "",
"DevDetail_SessionInfo_LastIP": "",
"DevDetail_SessionInfo_LastSession": "",
"DevDetail_SessionInfo_StaticIP": "",
"DevDetail_SessionInfo_Status": "",
"DevDetail_SessionInfo_Title": "",
"DevDetail_SessionTable_Additionalinfo": "",
"DevDetail_SessionTable_Connection": "",
"DevDetail_SessionTable_Disconnection": "",
"DevDetail_SessionTable_Duration": "",
"DevDetail_SessionTable_IP": "",
"DevDetail_SessionTable_Order": "",
"DevDetail_Shortcut_CurrentStatus": "",
"DevDetail_Shortcut_DownAlerts": "",
"DevDetail_Shortcut_Presence": "",
"DevDetail_Shortcut_Sessions": "",
"DevDetail_Tab_Details": "",
"DevDetail_Tab_Events": "",
"DevDetail_Tab_EventsTableDate": "",
"DevDetail_Tab_EventsTableEvent": "",
"DevDetail_Tab_EventsTableIP": "",
"DevDetail_Tab_EventsTableInfo": "",
"DevDetail_Tab_Nmap": "",
"DevDetail_Tab_NmapEmpty": "",
"DevDetail_Tab_NmapTableExtra": "",
"DevDetail_Tab_NmapTableHeader": "",
"DevDetail_Tab_NmapTableIndex": "",
"DevDetail_Tab_NmapTablePort": "",
"DevDetail_Tab_NmapTableService": "",
"DevDetail_Tab_NmapTableState": "",
"DevDetail_Tab_NmapTableText": "",
"DevDetail_Tab_NmapTableTime": "",
"DevDetail_Tab_Plugins": "",
"DevDetail_Tab_Presence": "",
"DevDetail_Tab_Sessions": "",
"DevDetail_Tab_Tools": "",
"DevDetail_Tab_Tools_Internet_Info_Description": "",
"DevDetail_Tab_Tools_Internet_Info_Error": "",
"DevDetail_Tab_Tools_Internet_Info_Start": "",
"DevDetail_Tab_Tools_Internet_Info_Title": "",
"DevDetail_Tab_Tools_Nslookup_Description": "",
"DevDetail_Tab_Tools_Nslookup_Error": "",
"DevDetail_Tab_Tools_Nslookup_Start": "",
"DevDetail_Tab_Tools_Nslookup_Title": "",
"DevDetail_Tab_Tools_Speedtest_Description": "",
"DevDetail_Tab_Tools_Speedtest_Start": "",
"DevDetail_Tab_Tools_Speedtest_Title": "",
"DevDetail_Tab_Tools_Traceroute_Description": "",
"DevDetail_Tab_Tools_Traceroute_Error": "",
"DevDetail_Tab_Tools_Traceroute_Start": "",
"DevDetail_Tab_Tools_Traceroute_Title": "",
"DevDetail_Tools_WOL": "",
"DevDetail_Tools_WOL_noti": "",
"DevDetail_Tools_WOL_noti_text": "",
"DevDetail_Type_hover": "",
"DevDetail_Vendor_hover": "",
"DevDetail_WOL_Title": "",
"DevDetail_button_AddIcon": "",
"DevDetail_button_AddIcon_Help": "",
"DevDetail_button_AddIcon_Tooltip": "",
"DevDetail_button_Delete": "",
"DevDetail_button_DeleteEvents": "",
"DevDetail_button_DeleteEvents_Warning": "",
"DevDetail_button_Delete_ask": "",
"DevDetail_button_OverwriteIcons": "",
"DevDetail_button_OverwriteIcons_Tooltip": "",
"DevDetail_button_OverwriteIcons_Warning": "",
"DevDetail_button_Reset": "",
"DevDetail_button_Save": "",
"DeviceEdit_ValidMacIp": "",
"Device_MultiEdit": "",
"Device_MultiEdit_Backup": "",
"Device_MultiEdit_Fields": "",
"Device_MultiEdit_MassActions": "",
"Device_MultiEdit_No_Devices": "",
"Device_MultiEdit_Tooltip": "",
"Device_Searchbox": "",
"Device_Shortcut_AllDevices": "",
"Device_Shortcut_AllNodes": "",
"Device_Shortcut_Archived": "",
"Device_Shortcut_Connected": "",
"Device_Shortcut_Devices": "",
"Device_Shortcut_DownAlerts": "",
"Device_Shortcut_DownOnly": "",
"Device_Shortcut_Favorites": "",
"Device_Shortcut_NewDevices": "",
"Device_Shortcut_OnlineChart": "",
"Device_TableHead_AlertDown": "",
"Device_TableHead_Connected_Devices": "",
"Device_TableHead_CustomProps": "",
"Device_TableHead_FQDN": "",
"Device_TableHead_Favorite": "",
"Device_TableHead_FirstSession": "",
"Device_TableHead_GUID": "",
"Device_TableHead_Group": "",
"Device_TableHead_Icon": "",
"Device_TableHead_LastIP": "",
"Device_TableHead_LastIPOrder": "",
"Device_TableHead_LastSession": "",
"Device_TableHead_Location": "",
"Device_TableHead_MAC": "",
"Device_TableHead_MAC_full": "",
"Device_TableHead_Name": "",
"Device_TableHead_NetworkSite": "",
"Device_TableHead_Owner": "",
"Device_TableHead_ParentRelType": "",
"Device_TableHead_Parent_MAC": "",
"Device_TableHead_Port": "",
"Device_TableHead_PresentLastScan": "",
"Device_TableHead_ReqNicsOnline": "",
"Device_TableHead_RowID": "",
"Device_TableHead_Rowid": "",
"Device_TableHead_SSID": "",
"Device_TableHead_SourcePlugin": "",
"Device_TableHead_Status": "",
"Device_TableHead_SyncHubNodeName": "",
"Device_TableHead_Type": "",
"Device_TableHead_Vendor": "",
"Device_Table_Not_Network_Device": "",
"Device_Table_info": "",
"Device_Table_nav_next": "",
"Device_Table_nav_prev": "",
"Device_Tablelenght": "",
"Device_Tablelenght_all": "",
"Device_Title": "",
"Devices_Filters": "",
"ENABLE_PLUGINS_description": "",
"ENABLE_PLUGINS_name": "",
"ENCRYPTION_KEY_description": "",
"ENCRYPTION_KEY_name": "",
"Email_display_name": "",
"Email_icon": "",
"Events_Loading": "",
"Events_Periodselect_All": "",
"Events_Periodselect_LastMonth": "",
"Events_Periodselect_LastWeek": "",
"Events_Periodselect_LastYear": "",
"Events_Periodselect_today": "",
"Events_Searchbox": "",
"Events_Shortcut_AllEvents": "",
"Events_Shortcut_DownAlerts": "",
"Events_Shortcut_Events": "",
"Events_Shortcut_MissSessions": "",
"Events_Shortcut_NewDevices": "",
"Events_Shortcut_Sessions": "",
"Events_Shortcut_VoidSessions": "",
"Events_TableHead_AdditionalInfo": "",
"Events_TableHead_Connection": "",
"Events_TableHead_Date": "",
"Events_TableHead_Device": "",
"Events_TableHead_Disconnection": "",
"Events_TableHead_Duration": "",
"Events_TableHead_DurationOrder": "",
"Events_TableHead_EventType": "",
"Events_TableHead_IP": "",
"Events_TableHead_IPOrder": "",
"Events_TableHead_Order": "",
"Events_TableHead_Owner": "",
"Events_TableHead_PendingAlert": "",
"Events_Table_info": "",
"Events_Table_nav_next": "",
"Events_Table_nav_prev": "",
"Events_Tablelenght": "",
"Events_Tablelenght_all": "",
"Events_Title": "",
"GRAPHQL_PORT_description": "",
"GRAPHQL_PORT_name": "",
"Gen_Action": "",
"Gen_Add": "",
"Gen_AddDevice": "",
"Gen_Add_All": "",
"Gen_All_Devices": "",
"Gen_AreYouSure": "",
"Gen_Backup": "",
"Gen_Cancel": "",
"Gen_Change": "",
"Gen_Copy": "",
"Gen_CopyToClipboard": "",
"Gen_DataUpdatedUITakesTime": "",
"Gen_Delete": "",
"Gen_DeleteAll": "",
"Gen_Description": "",
"Gen_Error": "",
"Gen_Filter": "",
"Gen_Generate": "",
"Gen_InvalidMac": "",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "",
"Gen_NetworkMask": "",
"Gen_Offline": "",
"Gen_Okay": "",
"Gen_Online": "",
"Gen_Purge": "",
"Gen_ReadDocs": "",
"Gen_Remove_All": "",
"Gen_Remove_Last": "",
"Gen_Reset": "",
"Gen_Restore": "",
"Gen_Run": "",
"Gen_Save": "",
"Gen_Saved": "",
"Gen_Search": "",
"Gen_Select": "",
"Gen_SelectIcon": "",
"Gen_SelectToPreview": "",
"Gen_Selected_Devices": "",
"Gen_Subnet": "",
"Gen_Switch": "",
"Gen_Upd": "",
"Gen_Upd_Fail": "",
"Gen_Update": "",
"Gen_Update_Value": "",
"Gen_ValidIcon": "",
"Gen_Warning": "",
"Gen_Work_In_Progress": "",
"Gen_create_new_device": "",
"Gen_create_new_device_info": "",
"General_display_name": "",
"General_icon": "",
"HRS_TO_KEEP_NEWDEV_description": "",
"HRS_TO_KEEP_NEWDEV_name": "",
"HRS_TO_KEEP_OFFDEV_description": "",
"HRS_TO_KEEP_OFFDEV_name": "",
"LOADED_PLUGINS_description": "",
"LOADED_PLUGINS_name": "",
"LOG_LEVEL_description": "",
"LOG_LEVEL_name": "",
"Loading": "",
"Login_Box": "",
"Login_Default_PWD": "",
"Login_Info": "",
"Login_Psw-box": "",
"Login_Psw_alert": "",
"Login_Psw_folder": "",
"Login_Psw_new": "",
"Login_Psw_run": "",
"Login_Remember": "",
"Login_Remember_small": "",
"Login_Submit": "",
"Login_Toggle_Alert_headline": "",
"Login_Toggle_Info": "",
"Login_Toggle_Info_headline": "",
"Maint_PurgeLog": "",
"Maint_RestartServer": "",
"Maint_Restart_Server_noti_text": "",
"Maintenance_InitCheck": "",
"Maintenance_InitCheck_Checking": "",
"Maintenance_InitCheck_QuickSetupGuide": "",
"Maintenance_InitCheck_Success": "",
"Maintenance_ReCheck": "",
"Maintenance_Running_Version": "",
"Maintenance_Status": "",
"Maintenance_Title": "",
"Maintenance_Tool_DownloadConfig": "",
"Maintenance_Tool_DownloadConfig_text": "",
"Maintenance_Tool_DownloadWorkflows": "",
"Maintenance_Tool_DownloadWorkflows_text": "",
"Maintenance_Tool_ExportCSV": "",
"Maintenance_Tool_ExportCSV_noti": "",
"Maintenance_Tool_ExportCSV_noti_text": "",
"Maintenance_Tool_ExportCSV_text": "",
"Maintenance_Tool_ImportCSV": "",
"Maintenance_Tool_ImportCSV_noti": "",
"Maintenance_Tool_ImportCSV_noti_text": "",
"Maintenance_Tool_ImportCSV_text": "",
"Maintenance_Tool_ImportConfig_noti": "",
"Maintenance_Tool_ImportPastedCSV": "",
"Maintenance_Tool_ImportPastedCSV_noti_text": "",
"Maintenance_Tool_ImportPastedCSV_text": "",
"Maintenance_Tool_ImportPastedConfig": "",
"Maintenance_Tool_ImportPastedConfig_noti_text": "",
"Maintenance_Tool_ImportPastedConfig_text": "",
"Maintenance_Tool_arpscansw": "",
"Maintenance_Tool_arpscansw_noti": "",
"Maintenance_Tool_arpscansw_noti_text": "",
"Maintenance_Tool_arpscansw_text": "",
"Maintenance_Tool_backup": "",
"Maintenance_Tool_backup_noti": "",
"Maintenance_Tool_backup_noti_text": "",
"Maintenance_Tool_backup_text": "",
"Maintenance_Tool_check_visible": "",
"Maintenance_Tool_darkmode": "",
"Maintenance_Tool_darkmode_noti": "",
"Maintenance_Tool_darkmode_noti_text": "",
"Maintenance_Tool_darkmode_text": "",
"Maintenance_Tool_del_ActHistory": "",
"Maintenance_Tool_del_ActHistory_noti": "",
"Maintenance_Tool_del_ActHistory_noti_text": "",
"Maintenance_Tool_del_ActHistory_text": "",
"Maintenance_Tool_del_alldev": "",
"Maintenance_Tool_del_alldev_noti": "",
"Maintenance_Tool_del_alldev_noti_text": "",
"Maintenance_Tool_del_alldev_text": "",
"Maintenance_Tool_del_allevents": "",
"Maintenance_Tool_del_allevents30": "",
"Maintenance_Tool_del_allevents30_noti": "",
"Maintenance_Tool_del_allevents30_noti_text": "",
"Maintenance_Tool_del_allevents30_text": "",
"Maintenance_Tool_del_allevents_noti": "",
"Maintenance_Tool_del_allevents_noti_text": "",
"Maintenance_Tool_del_allevents_text": "",
"Maintenance_Tool_del_empty_macs": "",
"Maintenance_Tool_del_empty_macs_noti": "",
"Maintenance_Tool_del_empty_macs_noti_text": "",
"Maintenance_Tool_del_empty_macs_text": "",
"Maintenance_Tool_del_selecteddev": "",
"Maintenance_Tool_del_selecteddev_text": "",
"Maintenance_Tool_del_unknowndev": "",
"Maintenance_Tool_del_unknowndev_noti": "",
"Maintenance_Tool_del_unknowndev_noti_text": "",
"Maintenance_Tool_del_unknowndev_text": "",
"Maintenance_Tool_displayed_columns_text": "",
"Maintenance_Tool_drag_me": "",
"Maintenance_Tool_order_columns_text": "",
"Maintenance_Tool_purgebackup": "",
"Maintenance_Tool_purgebackup_noti": "",
"Maintenance_Tool_purgebackup_noti_text": "",
"Maintenance_Tool_purgebackup_text": "",
"Maintenance_Tool_restore": "",
"Maintenance_Tool_restore_noti": "",
"Maintenance_Tool_restore_noti_text": "",
"Maintenance_Tool_restore_text": "",
"Maintenance_Tool_upgrade_database_noti": "",
"Maintenance_Tool_upgrade_database_noti_text": "",
"Maintenance_Tool_upgrade_database_text": "",
"Maintenance_Tools_Tab_BackupRestore": "",
"Maintenance_Tools_Tab_Logging": "",
"Maintenance_Tools_Tab_Settings": "",
"Maintenance_Tools_Tab_Tools": "",
"Maintenance_Tools_Tab_UISettings": "",
"Maintenance_arp_status": "",
"Maintenance_arp_status_off": "",
"Maintenance_arp_status_on": "",
"Maintenance_built_on": "",
"Maintenance_current_version": "",
"Maintenance_database_backup": "",
"Maintenance_database_backup_found": "",
"Maintenance_database_backup_total": "",
"Maintenance_database_lastmod": "",
"Maintenance_database_path": "",
"Maintenance_database_rows": "",
"Maintenance_database_size": "",
"Maintenance_lang_selector_apply": "",
"Maintenance_lang_selector_empty": "",
"Maintenance_lang_selector_lable": "",
"Maintenance_lang_selector_text": "",
"Maintenance_new_version": "",
"Maintenance_themeselector_apply": "",
"Maintenance_themeselector_empty": "",
"Maintenance_themeselector_lable": "",
"Maintenance_themeselector_text": "",
"Maintenance_version": "",
"NETWORK_DEVICE_TYPES_description": "",
"NETWORK_DEVICE_TYPES_name": "",
"Navigation_About": "",
"Navigation_AppEvents": "",
"Navigation_Devices": "",
"Navigation_Donations": "",
"Navigation_Events": "",
"Navigation_Integrations": "",
"Navigation_Maintenance": "",
"Navigation_Monitoring": "",
"Navigation_Network": "",
"Navigation_Notifications": "",
"Navigation_Plugins": "",
"Navigation_Presence": "",
"Navigation_Report": "",
"Navigation_Settings": "",
"Navigation_SystemInfo": "",
"Navigation_Workflows": "",
"Network_Assign": "",
"Network_Cant_Assign": "",
"Network_Cant_Assign_No_Node_Selected": "",
"Network_Configuration_Error": "",
"Network_Connected": "",
"Network_Devices": "",
"Network_ManageAdd": "",
"Network_ManageAdd_Name": "",
"Network_ManageAdd_Name_text": "",
"Network_ManageAdd_Port": "",
"Network_ManageAdd_Port_text": "",
"Network_ManageAdd_Submit": "",
"Network_ManageAdd_Type": "",
"Network_ManageAdd_Type_text": "",
"Network_ManageAssign": "",
"Network_ManageDel": "",
"Network_ManageDel_Name": "",
"Network_ManageDel_Name_text": "",
"Network_ManageDel_Submit": "",
"Network_ManageDevices": "",
"Network_ManageEdit": "",
"Network_ManageEdit_ID": "",
"Network_ManageEdit_ID_text": "",
"Network_ManageEdit_Name": "",
"Network_ManageEdit_Name_text": "",
"Network_ManageEdit_Port": "",
"Network_ManageEdit_Port_text": "",
"Network_ManageEdit_Submit": "",
"Network_ManageEdit_Type": "",
"Network_ManageEdit_Type_text": "",
"Network_ManageLeaf": "",
"Network_ManageUnassign": "",
"Network_NoAssignedDevices": "",
"Network_NoDevices": "",
"Network_Node": "",
"Network_Node_Name": "",
"Network_Parent": "",
"Network_Root": "",
"Network_Root_Not_Configured": "",
"Network_Root_Unconfigurable": "",
"Network_ShowArchived": "",
"Network_ShowOffline": "",
"Network_Table_Hostname": "",
"Network_Table_IP": "",
"Network_Table_State": "",
"Network_Title": "",
"Network_UnassignedDevices": "",
"Notifications_All": "",
"Notifications_Mark_All_Read": "",
"PIALERT_WEB_PASSWORD_description": "",
"PIALERT_WEB_PASSWORD_name": "",
"PIALERT_WEB_PROTECTION_description": "",
"PIALERT_WEB_PROTECTION_name": "",
"PLUGINS_KEEP_HIST_description": "",
"PLUGINS_KEEP_HIST_name": "",
"Plugins_DeleteAll": "",
"Plugins_Filters_Mac": "",
"Plugins_History": "",
"Plugins_Obj_DeleteListed": "",
"Plugins_Objects": "",
"Plugins_Out_of": "",
"Plugins_Unprocessed_Events": "",
"Plugins_no_control": "",
"Presence_CalHead_day": "",
"Presence_CalHead_lang": "",
"Presence_CalHead_month": "",
"Presence_CalHead_quarter": "",
"Presence_CalHead_week": "",
"Presence_CalHead_year": "",
"Presence_CallHead_Devices": "",
"Presence_Key_OnlineNow": "",
"Presence_Key_OnlineNow_desc": "",
"Presence_Key_OnlinePast": "",
"Presence_Key_OnlinePastMiss": "",
"Presence_Key_OnlinePastMiss_desc": "",
"Presence_Key_OnlinePast_desc": "",
"Presence_Loading": "",
"Presence_Shortcut_AllDevices": "",
"Presence_Shortcut_Archived": "",
"Presence_Shortcut_Connected": "",
"Presence_Shortcut_Devices": "",
"Presence_Shortcut_DownAlerts": "",
"Presence_Shortcut_Favorites": "",
"Presence_Shortcut_NewDevices": "",
"Presence_Title": "",
"REFRESH_FQDN_description": "",
"REFRESH_FQDN_name": "",
"REPORT_DASHBOARD_URL_description": "",
"REPORT_DASHBOARD_URL_name": "",
"REPORT_ERROR": "",
"REPORT_MAIL_description": "",
"REPORT_MAIL_name": "",
"REPORT_TITLE": "",
"RandomMAC_hover": "",
"Reports_Sent_Log": "",
"SCAN_SUBNETS_description": "",
"SCAN_SUBNETS_name": "",
"SYSTEM_TITLE": "",
"Setting_Override": "",
"Setting_Override_Description": "",
"Settings_Metadata_Toggle": "",
"Settings_Show_Description": "",
"Settings_device_Scanners_desync": "",
"Settings_device_Scanners_desync_popup": "",
"Speedtest_Results": "",
"Systeminfo_AvailableIps": "",
"Systeminfo_CPU": "",
"Systeminfo_CPU_Cores": "",
"Systeminfo_CPU_Name": "",
"Systeminfo_CPU_Speed": "",
"Systeminfo_CPU_Temp": "",
"Systeminfo_CPU_Vendor": "",
"Systeminfo_Client_Resolution": "",
"Systeminfo_Client_User_Agent": "",
"Systeminfo_General": "",
"Systeminfo_General_Date": "",
"Systeminfo_General_Date2": "",
"Systeminfo_General_Full_Date": "",
"Systeminfo_General_TimeZone": "",
"Systeminfo_Memory": "",
"Systeminfo_Memory_Total_Memory": "",
"Systeminfo_Memory_Usage": "",
"Systeminfo_Memory_Usage_Percent": "",
"Systeminfo_Motherboard": "",
"Systeminfo_Motherboard_BIOS": "",
"Systeminfo_Motherboard_BIOS_Date": "",
"Systeminfo_Motherboard_BIOS_Vendor": "",
"Systeminfo_Motherboard_Manufactured": "",
"Systeminfo_Motherboard_Name": "",
"Systeminfo_Motherboard_Revision": "",
"Systeminfo_Network": "",
"Systeminfo_Network_Accept_Encoding": "",
"Systeminfo_Network_Accept_Language": "",
"Systeminfo_Network_Connection_Port": "",
"Systeminfo_Network_HTTP_Host": "",
"Systeminfo_Network_HTTP_Referer": "",
"Systeminfo_Network_HTTP_Referer_String": "",
"Systeminfo_Network_Hardware": "",
"Systeminfo_Network_Hardware_Interface_Mask": "",
"Systeminfo_Network_Hardware_Interface_Name": "",
"Systeminfo_Network_Hardware_Interface_RX": "",
"Systeminfo_Network_Hardware_Interface_TX": "",
"Systeminfo_Network_IP": "",
"Systeminfo_Network_IP_Connection": "",
"Systeminfo_Network_IP_Server": "",
"Systeminfo_Network_MIME": "",
"Systeminfo_Network_Request_Method": "",
"Systeminfo_Network_Request_Time": "",
"Systeminfo_Network_Request_URI": "",
"Systeminfo_Network_Secure_Connection": "",
"Systeminfo_Network_Secure_Connection_String": "",
"Systeminfo_Network_Server_Name": "",
"Systeminfo_Network_Server_Name_String": "",
"Systeminfo_Network_Server_Query": "",
"Systeminfo_Network_Server_Query_String": "",
"Systeminfo_Network_Server_Version": "",
"Systeminfo_Services": "",
"Systeminfo_Services_Description": "",
"Systeminfo_Services_Name": "",
"Systeminfo_Storage": "",
"Systeminfo_Storage_Device": "",
"Systeminfo_Storage_Mount": "",
"Systeminfo_Storage_Size": "",
"Systeminfo_Storage_Type": "",
"Systeminfo_Storage_Usage": "",
"Systeminfo_Storage_Usage_Free": "",
"Systeminfo_Storage_Usage_Mount": "",
"Systeminfo_Storage_Usage_Total": "",
"Systeminfo_Storage_Usage_Used": "",
"Systeminfo_System": "",
"Systeminfo_System_AVG": "",
"Systeminfo_System_Architecture": "",
"Systeminfo_System_Kernel": "",
"Systeminfo_System_OSVersion": "",
"Systeminfo_System_Running_Processes": "",
"Systeminfo_System_System": "",
"Systeminfo_System_Uname": "",
"Systeminfo_System_Uptime": "",
"Systeminfo_This_Client": "",
"Systeminfo_USB_Devices": "",
"TICKER_MIGRATE_TO_NETALERTX": "",
"TIMEZONE_description": "",
"TIMEZONE_name": "",
"UI_DEV_SECTIONS_description": "",
"UI_DEV_SECTIONS_name": "",
"UI_ICONS_description": "",
"UI_ICONS_name": "",
"UI_LANG_description": "",
"UI_LANG_name": "",
"UI_MY_DEVICES_description": "",
"UI_MY_DEVICES_name": "",
"UI_NOT_RANDOM_MAC_description": "",
"UI_NOT_RANDOM_MAC_name": "",
"UI_PRESENCE_description": "",
"UI_PRESENCE_name": "",
"UI_REFRESH_description": "",
"UI_REFRESH_name": "",
"VERSION_description": "",
"VERSION_name": "",
"WF_Action_Add": "",
"WF_Action_field": "",
"WF_Action_type": "",
"WF_Action_value": "",
"WF_Actions": "",
"WF_Add": "",
"WF_Add_Condition": "",
"WF_Add_Group": "",
"WF_Condition_field": "",
"WF_Condition_operator": "",
"WF_Condition_value": "",
"WF_Conditions": "",
"WF_Conditions_logic_rules": "",
"WF_Duplicate": "",
"WF_Enabled": "",
"WF_Export": "",
"WF_Export_Copy": "",
"WF_Import": "",
"WF_Import_Copy": "",
"WF_Name": "",
"WF_Remove": "",
"WF_Remove_Copy": "",
"WF_Save": "",
"WF_Trigger": "",
"WF_Trigger_event_type": "",
"WF_Trigger_type": "",
"add_icon_event_tooltip": "",
"add_option_event_tooltip": "",
"copy_icons_event_tooltip": "",
"devices_old": "",
"general_event_description": "",
"general_event_title": "",
"go_to_device_event_tooltip": "",
"go_to_node_event_tooltip": "",
"new_version_available": "",
"report_guid": "",
"report_guid_missing": "",
"report_select_format": "",
"report_time": "",
"run_event_tooltip": "",
"select_icon_event_tooltip": "",
"settings_core_icon": "",
"settings_core_label": "",
"settings_device_scanners": "",
"settings_device_scanners_icon": "",
"settings_device_scanners_info": "",
"settings_device_scanners_label": "",
"settings_enabled": "",
"settings_enabled_icon": "",
"settings_expand_all": "",
"settings_imported": "",
"settings_imported_label": "",
"settings_missing": "",
"settings_missing_block": "",
"settings_old": "",
"settings_other_scanners": "",
"settings_other_scanners_icon": "",
"settings_other_scanners_label": "",
"settings_publishers": "",
"settings_publishers_icon": "",
"settings_publishers_info": "",
"settings_publishers_label": "",
"settings_readonly": "",
"settings_saved": "",
"settings_system_icon": "",
"settings_system_label": "",
"settings_update_item_warning": "",
"test_event_tooltip": ""
}

View File

@@ -5,7 +5,7 @@
// ################################### // ###################################
$defaultLang = "en_us"; $defaultLang = "en_us";
$allLanguages = [ "ar_ar", "ca_ca", "cs_cz", "de_de", "en_us", "es_es", "fa_fa", "fr_fr", "it_it", "nb_no", "pl_pl", "pt_br", "pt_pt", "ru_ru", "sv_sv", "tr_tr", "uk_ua", "zh_cn"]; $allLanguages = [ "ar_ar", "ca_ca", "cs_cz", "de_de", "en_us", "es_es", "fa_fa", "fr_fr", "it_it", "ja_jp", "nb_no", "pl_pl", "pt_br", "pt_pt", "ru_ru", "sv_sv", "tr_tr", "uk_ua", "zh_cn"];
global $db; global $db;
@@ -23,6 +23,7 @@ switch($result){
case 'Farsi (fa_fa)': $pia_lang_selected = 'fa_fa'; break; case 'Farsi (fa_fa)': $pia_lang_selected = 'fa_fa'; break;
case 'French (fr_fr)': $pia_lang_selected = 'fr_fr'; break; case 'French (fr_fr)': $pia_lang_selected = 'fr_fr'; break;
case 'Italian (it_it)': $pia_lang_selected = 'it_it'; break; case 'Italian (it_it)': $pia_lang_selected = 'it_it'; break;
case 'Japanese (ja_jp)': $pia_lang_selected = 'ja_jp'; break;
case 'Norwegian (nb_no)': $pia_lang_selected = 'nb_no'; break; case 'Norwegian (nb_no)': $pia_lang_selected = 'nb_no'; break;
case 'Polish (pl_pl)': $pia_lang_selected = 'pl_pl'; break; case 'Polish (pl_pl)': $pia_lang_selected = 'pl_pl'; break;
case 'Portuguese (pt_br)': $pia_lang_selected = 'pt_br'; break; case 'Portuguese (pt_br)': $pia_lang_selected = 'pt_br'; break;

View File

@@ -1,6 +1,6 @@
import json import json
import os import os
import sys
def merge_translations(main_file, other_files): def merge_translations(main_file, other_files):
# Load main file # Load main file
@@ -30,10 +30,14 @@ def merge_translations(main_file, other_files):
json.dump(data, f, indent=4, ensure_ascii=False) json.dump(data, f, indent=4, ensure_ascii=False)
f.truncate() f.truncate()
if __name__ == "__main__": if __name__ == "__main__":
current_path = os.path.dirname(os.path.abspath(__file__)) current_path = os.path.dirname(os.path.abspath(__file__))
# language codes can be found here: http://www.lingoes.net/en/translator/langcode.htm # language codes can be found here: http://www.lingoes.net/en/translator/langcode.htm
# "en_us.json" has to be first! # "en_us.json" has to be first!
json_files = [ "en_us.json", "ar_ar.json", "ca_ca.json", "cs_cz.json", "de_de.json", "es_es.json", "fa_fa.json", "fr_fr.json", "it_it.json", "nb_no.json", "pl_pl.json", "pt_br.json", "pt_pt.json", "ru_ru.json", "sv_sv.json", "tr_tr.json", "uk_ua.json", "zh_cn.json"] json_files = ["en_us.json", "ar_ar.json", "ca_ca.json", "cs_cz.json", "de_de.json",
"es_es.json", "fa_fa.json", "fr_fr.json", "it_it.json", "ja_jp.json",
"nb_no.json", "pl_pl.json", "pt_br.json", "pt_pt.json", "ru_ru.json",
"sv_sv.json", "tr_tr.json", "uk_ua.json", "zh_cn.json"]
file_paths = [os.path.join(current_path, file) for file in json_files] file_paths = [os.path.join(current_path, file) for file in json_files]
merge_translations(file_paths[0], file_paths[1:]) merge_translations(file_paths[0], file_paths[1:])

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "Filter", "Gen_Filter": "Filter",
"Gen_Generate": "", "Gen_Generate": "",
"Gen_InvalidMac": "", "Gen_InvalidMac": "",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "FEIL - DB kan være låst - Sjekk F12 Dev tools -> Konsoll eller prøv senere.", "Gen_LockedDB": "FEIL - DB kan være låst - Sjekk F12 Dev tools -> Konsoll eller prøv senere.",
"Gen_NetworkMask": "", "Gen_NetworkMask": "",
"Gen_Offline": "Frakoblet", "Gen_Offline": "Frakoblet",

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "Filtr", "Gen_Filter": "Filtr",
"Gen_Generate": "Wygeneruj", "Gen_Generate": "Wygeneruj",
"Gen_InvalidMac": "", "Gen_InvalidMac": "",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "Błąd - Baza danych może być zablokowana - Sprawdź narzędzia deweloperskie F12 -> Konsola lub spróbuj później.", "Gen_LockedDB": "Błąd - Baza danych może być zablokowana - Sprawdź narzędzia deweloperskie F12 -> Konsola lub spróbuj później.",
"Gen_NetworkMask": "", "Gen_NetworkMask": "",
"Gen_Offline": "Niedostępne", "Gen_Offline": "Niedostępne",

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "Filtro", "Gen_Filter": "Filtro",
"Gen_Generate": "Gerar", "Gen_Generate": "Gerar",
"Gen_InvalidMac": "", "Gen_InvalidMac": "",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "ERRO - O banco de dados pode estar bloqueado - Verifique F12 Ferramentas de desenvolvimento -> Console ou tente mais tarde.", "Gen_LockedDB": "ERRO - O banco de dados pode estar bloqueado - Verifique F12 Ferramentas de desenvolvimento -> Console ou tente mais tarde.",
"Gen_NetworkMask": "", "Gen_NetworkMask": "",
"Gen_Offline": "Offline", "Gen_Offline": "Offline",

View File

@@ -60,7 +60,7 @@
"BackDevices_darkmode_disabled": "Modo Noturno Desativado", "BackDevices_darkmode_disabled": "Modo Noturno Desativado",
"BackDevices_darkmode_enabled": "Modo Noturno Ativado", "BackDevices_darkmode_enabled": "Modo Noturno Ativado",
"CLEAR_NEW_FLAG_description": "Se ativado (<code>0</code> está desativado), dispositivos marcados como<b>Novo Dispositivo</b> serão desmarcados se o limite (especificado em horas) exceder o tempo da <b>Primeira Sessão </b>.", "CLEAR_NEW_FLAG_description": "Se ativado (<code>0</code> está desativado), dispositivos marcados como<b>Novo Dispositivo</b> serão desmarcados se o limite (especificado em horas) exceder o tempo da <b>Primeira Sessão </b>.",
"CLEAR_NEW_FLAG_name": "", "CLEAR_NEW_FLAG_name": "Limpar a flag nova",
"CustProps_cant_remove": "Não é possível remover, é necessária pelo menos uma propriedade.", "CustProps_cant_remove": "Não é possível remover, é necessária pelo menos uma propriedade.",
"DAYS_TO_KEEP_EVENTS_description": "Esta é uma definição de manutenção. Especifica o número de dias de entradas de eventos que serão mantidas. Todos os eventos mais antigos serão apagados periodicamente. Também se aplica ao Histórico de eventos do plug-in.", "DAYS_TO_KEEP_EVENTS_description": "Esta é uma definição de manutenção. Especifica o número de dias de entradas de eventos que serão mantidas. Todos os eventos mais antigos serão apagados periodicamente. Também se aplica ao Histórico de eventos do plug-in.",
"DAYS_TO_KEEP_EVENTS_name": "Apagar eventos mais antigos que", "DAYS_TO_KEEP_EVENTS_name": "Apagar eventos mais antigos que",
@@ -73,10 +73,10 @@
"DevDetail_CustomProps_reset_info": "Isto irá remover as suas propriedades personalizadas neste dispositivo e repô-las para o valor predefinido.", "DevDetail_CustomProps_reset_info": "Isto irá remover as suas propriedades personalizadas neste dispositivo e repô-las para o valor predefinido.",
"DevDetail_DisplayFields_Title": "Visualização", "DevDetail_DisplayFields_Title": "Visualização",
"DevDetail_EveandAl_AlertAllEvents": "Eventos de alerta", "DevDetail_EveandAl_AlertAllEvents": "Eventos de alerta",
"DevDetail_EveandAl_AlertDown": "", "DevDetail_EveandAl_AlertDown": "Alerta apagado",
"DevDetail_EveandAl_Archived": "Arquivado", "DevDetail_EveandAl_Archived": "Arquivado",
"DevDetail_EveandAl_NewDevice": "Novo dispositivo", "DevDetail_EveandAl_NewDevice": "Novo dispositivo",
"DevDetail_EveandAl_NewDevice_Tooltip": "", "DevDetail_EveandAl_NewDevice_Tooltip": "Mostrará o estado “Novo” para o dispositivo e irá incluí-lo nas listas quando o filtro de “Novos dispositivos” estiver ativo. Não afeta as notificações.",
"DevDetail_EveandAl_RandomMAC": "MAC Aleatório", "DevDetail_EveandAl_RandomMAC": "MAC Aleatório",
"DevDetail_EveandAl_ScanCycle": "Rastrear dispositivo", "DevDetail_EveandAl_ScanCycle": "Rastrear dispositivo",
"DevDetail_EveandAl_ScanCycle_a": "Rastear dispositivo", "DevDetail_EveandAl_ScanCycle_a": "Rastear dispositivo",
@@ -103,11 +103,11 @@
"DevDetail_MainInfo_Type": "Tipo", "DevDetail_MainInfo_Type": "Tipo",
"DevDetail_MainInfo_Vendor": "Fornecedor", "DevDetail_MainInfo_Vendor": "Fornecedor",
"DevDetail_MainInfo_mac": "MAC", "DevDetail_MainInfo_mac": "MAC",
"DevDetail_NavToChildNode": "", "DevDetail_NavToChildNode": "Expandir subelemento",
"DevDetail_Network_Node_hover": "Selecione o dispositivo de rede principal ao qual o dispositivo atual está conectado, para preencher a árvore Rede.", "DevDetail_Network_Node_hover": "Selecione o dispositivo de rede principal ao qual o dispositivo atual está conectado, para preencher a árvore Rede.",
"DevDetail_Network_Port_hover": "A porta a que este dispositivo está ligado no dispositivo de rede principal. Se for deixado vazio, é apresentado um ícone wifi na árvore Rede.", "DevDetail_Network_Port_hover": "A porta a que este dispositivo está ligado no dispositivo de rede principal. Se for deixado vazio, é apresentado um ícone wifi na árvore Rede.",
"DevDetail_Nmap_Scans": "Varreduras manuais do Nmap", "DevDetail_Nmap_Scans": "Varreduras manuais do Nmap",
"DevDetail_Nmap_Scans_desc": "", "DevDetail_Nmap_Scans_desc": "Aqui pode executar análises NMAP manuais. Também pode agendar análises NMAP automáticas regulares através do plugin Serviços & Portos (NMAP). Aceda à https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/nmap_scan para saber mais",
"DevDetail_Nmap_buttonDefault": "Verificação predefinida", "DevDetail_Nmap_buttonDefault": "Verificação predefinida",
"DevDetail_Nmap_buttonDefault_text": "Scan padrão: Nmap verifica as 1.000 portas superiores para cada protocolo de digitalização solicitado. Isto atinge cerca de 93% das portas TCP e 49% das portas UDP. (cerca de 5 segundos)", "DevDetail_Nmap_buttonDefault_text": "Scan padrão: Nmap verifica as 1.000 portas superiores para cada protocolo de digitalização solicitado. Isto atinge cerca de 93% das portas TCP e 49% das portas UDP. (cerca de 5 segundos)",
"DevDetail_Nmap_buttonDetail": "Verificação Detalhada", "DevDetail_Nmap_buttonDetail": "Verificação Detalhada",
@@ -155,34 +155,34 @@
"DevDetail_Tab_NmapTablePort": "Porta", "DevDetail_Tab_NmapTablePort": "Porta",
"DevDetail_Tab_NmapTableService": "Serviço", "DevDetail_Tab_NmapTableService": "Serviço",
"DevDetail_Tab_NmapTableState": "Estado", "DevDetail_Tab_NmapTableState": "Estado",
"DevDetail_Tab_NmapTableText": "", "DevDetail_Tab_NmapTableText": "Configurar uma programação em <a href=\"/settings.php#NMAP_ACTIVE\">Definições</a>",
"DevDetail_Tab_NmapTableTime": "Tempo", "DevDetail_Tab_NmapTableTime": "Tempo",
"DevDetail_Tab_Plugins": "Plugins", "DevDetail_Tab_Plugins": "Plugins",
"DevDetail_Tab_Presence": "Presença", "DevDetail_Tab_Presence": "Presença",
"DevDetail_Tab_Sessions": "Sessões", "DevDetail_Tab_Sessions": "Sessões",
"DevDetail_Tab_Tools": "Ferramentas", "DevDetail_Tab_Tools": "Ferramentas",
"DevDetail_Tab_Tools_Internet_Info_Description": "", "DevDetail_Tab_Tools_Internet_Info_Description": "A ferramenta de informações da Internet apresenta dados sobre a ligação à Internet, como endereço IP, cidade, país, código de área e fuso horário.",
"DevDetail_Tab_Tools_Internet_Info_Error": "Ocorreu um erro", "DevDetail_Tab_Tools_Internet_Info_Error": "Ocorreu um erro",
"DevDetail_Tab_Tools_Internet_Info_Start": "", "DevDetail_Tab_Tools_Internet_Info_Start": "Start Internet Info",
"DevDetail_Tab_Tools_Internet_Info_Title": "", "DevDetail_Tab_Tools_Internet_Info_Title": "Internet Info",
"DevDetail_Tab_Tools_Nslookup_Description": "", "DevDetail_Tab_Tools_Nslookup_Description": "Nslookup é uma ferramenta de linha de comandos usada para consultar o Sistema de Nomes de Domínio (DNS). O DNS é um sistema que traduz nomes de domínio, como www.google.com, em endereços IP, como 172.217.0.142.",
"DevDetail_Tab_Tools_Nslookup_Error": "", "DevDetail_Tab_Tools_Nslookup_Error": "Erro: O endereço IP não é válido",
"DevDetail_Tab_Tools_Nslookup_Start": "", "DevDetail_Tab_Tools_Nslookup_Start": "Inicia Nslookup",
"DevDetail_Tab_Tools_Nslookup_Title": "", "DevDetail_Tab_Tools_Nslookup_Title": "Nslookup",
"DevDetail_Tab_Tools_Speedtest_Description": "", "DevDetail_Tab_Tools_Speedtest_Description": "A ferramenta Speedtest mede a velocidade de download, a velocidade de upload e a latência da ligação à Internet.",
"DevDetail_Tab_Tools_Speedtest_Start": "", "DevDetail_Tab_Tools_Speedtest_Start": "Iniciar Speedtest",
"DevDetail_Tab_Tools_Speedtest_Title": "", "DevDetail_Tab_Tools_Speedtest_Title": "Speedtest Online",
"DevDetail_Tab_Tools_Traceroute_Description": "", "DevDetail_Tab_Tools_Traceroute_Description": "Traceroute é um comando de diagnóstico de rede usado para rastrear o caminho que os pacotes de dados percorrem de um anfitrião para outro.<br><br>O comando utiliza o Protocolo de Mensagens de Controlo da Internet (ICMP) para enviar pacotes aos nós intermédios na rota, cada node intermédio responde com um pacote ICMP de tempo limite (TTL expirado).<br><br>O comando utiliza o Protocolo de Mensagens de Controlo da Internet (ICMP) para enviar pacotes aos nodes intermédios na rota, cada node intermédio responde com um pacote ICMP de tempo limite (TTL expirado).<br><br>A saída do comando traceroute apresenta o endereço IP de cada node intermédio na rota.<br><br>O comando traceroute pode ser usado para diagnosticar problemas de rede, como atrasos, perda de pacotes e rotas bloqueadas.",
"DevDetail_Tab_Tools_Traceroute_Error": "", "DevDetail_Tab_Tools_Traceroute_Error": "Erro: O endereço IP não é válido",
"DevDetail_Tab_Tools_Traceroute_Start": "", "DevDetail_Tab_Tools_Traceroute_Start": "Iniciar Traceroute",
"DevDetail_Tab_Tools_Traceroute_Title": "", "DevDetail_Tab_Tools_Traceroute_Title": "Traceroute",
"DevDetail_Tools_WOL": "", "DevDetail_Tools_WOL": "Enviar comando WoL para ",
"DevDetail_Tools_WOL_noti": "", "DevDetail_Tools_WOL_noti": "Wake-on-LAN",
"DevDetail_Tools_WOL_noti_text": "", "DevDetail_Tools_WOL_noti_text": "O comando Wake-on-LAN é enviado para o endereço de broadcast. Se o destino não estiver na sub-rede/VLAN do NetAlertX, o dispositivo de destino não irá responder.",
"DevDetail_Type_hover": "", "DevDetail_Type_hover": "O tipo do dispositivo. Se selecionar um dos dispositivos de rede predefinidos (por exemplo: AP, Firewall, Router, Switch…), eles aparecerão na configuração da árvore de rede como possíveis nós de rede principais.",
"DevDetail_Vendor_hover": "", "DevDetail_Vendor_hover": "O fabricante deve ser detetado automaticamente. Pode substituir ou adicionar um valor personalizado.",
"DevDetail_WOL_Title": "", "DevDetail_WOL_Title": "<i class=\"fa fa-power-off\"></i> Wake-on-LAN",
"DevDetail_button_AddIcon": "", "DevDetail_button_AddIcon": "Adicionar novo ícone",
"DevDetail_button_AddIcon_Help": "Cole uma tag HTML SVG ou um ícone de tag HTML Font Awesome. Leia a <a href=\"https://github.com/jokob-sk/NetAlertX/blob/main/docs/ICONS.md\" target=\"_blank\">documentação sobre ícones</a> para obter pormenores.", "DevDetail_button_AddIcon_Help": "Cole uma tag HTML SVG ou um ícone de tag HTML Font Awesome. Leia a <a href=\"https://github.com/jokob-sk/NetAlertX/blob/main/docs/ICONS.md\" target=\"_blank\">documentação sobre ícones</a> para obter pormenores.",
"DevDetail_button_AddIcon_Tooltip": "Adicione um novo ícone a este dispositivo que ainda não esteja disponível no menu suspenso.", "DevDetail_button_AddIcon_Tooltip": "Adicione um novo ícone a este dispositivo que ainda não esteja disponível no menu suspenso.",
"DevDetail_button_Delete": "Apagar dispositivo", "DevDetail_button_Delete": "Apagar dispositivo",
@@ -199,23 +199,23 @@
"Device_MultiEdit_Backup": "", "Device_MultiEdit_Backup": "",
"Device_MultiEdit_Fields": "Editar campos:", "Device_MultiEdit_Fields": "Editar campos:",
"Device_MultiEdit_MassActions": "Ações em massa:", "Device_MultiEdit_MassActions": "Ações em massa:",
"Device_MultiEdit_No_Devices": "", "Device_MultiEdit_No_Devices": "Nenhum dispositivo selecionado.",
"Device_MultiEdit_Tooltip": "Cuidadoso. Clicar aqui aplicará o valor à esquerda a todos os dispositivos selecionados acima.", "Device_MultiEdit_Tooltip": "Cuidadoso. Clicar aqui aplicará o valor à esquerda a todos os dispositivos selecionados acima.",
"Device_Searchbox": "Procurar", "Device_Searchbox": "Procurar",
"Device_Shortcut_AllDevices": "", "Device_Shortcut_AllDevices": "Os meus dispositivos",
"Device_Shortcut_AllNodes": "", "Device_Shortcut_AllNodes": "Todos os Nodes",
"Device_Shortcut_Archived": "Arquivado", "Device_Shortcut_Archived": "Arquivado",
"Device_Shortcut_Connected": "Conectado", "Device_Shortcut_Connected": "Conectado",
"Device_Shortcut_Devices": "Dispositivos", "Device_Shortcut_Devices": "Dispositivos",
"Device_Shortcut_DownAlerts": "Inativo e off-line", "Device_Shortcut_DownAlerts": "Inativo e off-line",
"Device_Shortcut_DownOnly": "Inativo", "Device_Shortcut_DownOnly": "Inativo",
"Device_Shortcut_Favorites": "Favoritos", "Device_Shortcut_Favorites": "Favoritos",
"Device_Shortcut_NewDevices": "", "Device_Shortcut_NewDevices": "Novo dispostivo",
"Device_Shortcut_OnlineChart": "Presença do dispositivo", "Device_Shortcut_OnlineChart": "Presença do dispositivo",
"Device_TableHead_AlertDown": "Alerta em baixo", "Device_TableHead_AlertDown": "Alerta em baixo",
"Device_TableHead_Connected_Devices": "Conexões", "Device_TableHead_Connected_Devices": "Conexões",
"Device_TableHead_CustomProps": "", "Device_TableHead_CustomProps": "Propriedades / Ações",
"Device_TableHead_FQDN": "", "Device_TableHead_FQDN": "FQDN",
"Device_TableHead_Favorite": "Favorito", "Device_TableHead_Favorite": "Favorito",
"Device_TableHead_FirstSession": "Primeira sessão", "Device_TableHead_FirstSession": "Primeira sessão",
"Device_TableHead_GUID": "GUID", "Device_TableHead_GUID": "GUID",
@@ -230,11 +230,11 @@
"Device_TableHead_Name": "Nome", "Device_TableHead_Name": "Nome",
"Device_TableHead_NetworkSite": "Site da rede", "Device_TableHead_NetworkSite": "Site da rede",
"Device_TableHead_Owner": "Proprietário", "Device_TableHead_Owner": "Proprietário",
"Device_TableHead_ParentRelType": "", "Device_TableHead_ParentRelType": "Tipo de relação",
"Device_TableHead_Parent_MAC": "", "Device_TableHead_Parent_MAC": "Node de rede anterior",
"Device_TableHead_Port": "Porta", "Device_TableHead_Port": "Porta",
"Device_TableHead_PresentLastScan": "Presença", "Device_TableHead_PresentLastScan": "Presença",
"Device_TableHead_ReqNicsOnline": "", "Device_TableHead_ReqNicsOnline": "Exigir NICs online",
"Device_TableHead_RowID": "ID da linha", "Device_TableHead_RowID": "ID da linha",
"Device_TableHead_Rowid": "ID da linha", "Device_TableHead_Rowid": "ID da linha",
"Device_TableHead_SSID": "SSID", "Device_TableHead_SSID": "SSID",
@@ -257,7 +257,7 @@
"ENCRYPTION_KEY_name": "Chave de encriptação", "ENCRYPTION_KEY_name": "Chave de encriptação",
"Email_display_name": "Email", "Email_display_name": "Email",
"Email_icon": "<i class=\"fa fa-at\"></i>", "Email_icon": "<i class=\"fa fa-at\"></i>",
"Events_Loading": "", "Events_Loading": "A carregar…",
"Events_Periodselect_All": "Todas as informações", "Events_Periodselect_All": "Todas as informações",
"Events_Periodselect_LastMonth": "Mês passado", "Events_Periodselect_LastMonth": "Mês passado",
"Events_Periodselect_LastWeek": "Semana passada", "Events_Periodselect_LastWeek": "Semana passada",
@@ -268,7 +268,7 @@
"Events_Shortcut_DownAlerts": "Alertas de queda", "Events_Shortcut_DownAlerts": "Alertas de queda",
"Events_Shortcut_Events": "Eventos", "Events_Shortcut_Events": "Eventos",
"Events_Shortcut_MissSessions": "Sessões ausentes", "Events_Shortcut_MissSessions": "Sessões ausentes",
"Events_Shortcut_NewDevices": "", "Events_Shortcut_NewDevices": "Novos dispositivos",
"Events_Shortcut_Sessions": "Sessões", "Events_Shortcut_Sessions": "Sessões",
"Events_Shortcut_VoidSessions": "Sessões anuladas", "Events_Shortcut_VoidSessions": "Sessões anuladas",
"Events_TableHead_AdditionalInfo": "Informação adicional", "Events_TableHead_AdditionalInfo": "Informação adicional",
@@ -278,7 +278,7 @@
"Events_TableHead_Disconnection": "Desconexão", "Events_TableHead_Disconnection": "Desconexão",
"Events_TableHead_Duration": "Duração", "Events_TableHead_Duration": "Duração",
"Events_TableHead_DurationOrder": "Duração do pedido", "Events_TableHead_DurationOrder": "Duração do pedido",
"Events_TableHead_EventType": "", "Events_TableHead_EventType": "Tipos de eventos",
"Events_TableHead_IP": "IP", "Events_TableHead_IP": "IP",
"Events_TableHead_IPOrder": "Pedido de IP", "Events_TableHead_IPOrder": "Pedido de IP",
"Events_TableHead_Order": "Ordem", "Events_TableHead_Order": "Ordem",
@@ -294,15 +294,15 @@
"GRAPHQL_PORT_name": "Porta GraphQL", "GRAPHQL_PORT_name": "Porta GraphQL",
"Gen_Action": "Ação", "Gen_Action": "Ação",
"Gen_Add": "Adicionar", "Gen_Add": "Adicionar",
"Gen_AddDevice": "", "Gen_AddDevice": "Adicionar dispositivo",
"Gen_Add_All": "Adicionar todos", "Gen_Add_All": "Adicionar todos",
"Gen_All_Devices": "", "Gen_All_Devices": "Todos os dispostivos",
"Gen_AreYouSure": "Tem certeza?", "Gen_AreYouSure": "Tem certeza?",
"Gen_Backup": "Executar backup", "Gen_Backup": "Executar backup",
"Gen_Cancel": "Cancelar", "Gen_Cancel": "Cancelar",
"Gen_Change": "Alterar", "Gen_Change": "Alterar",
"Gen_Copy": "Executar", "Gen_Copy": "Executar",
"Gen_CopyToClipboard": "", "Gen_CopyToClipboard": "Copiar para a área de transferência",
"Gen_DataUpdatedUITakesTime": "OK - Pode levar um tempo para a interface do utilizador ser atualizada se uma verificação estiver em execução.", "Gen_DataUpdatedUITakesTime": "OK - Pode levar um tempo para a interface do utilizador ser atualizada se uma verificação estiver em execução.",
"Gen_Delete": "Apagar", "Gen_Delete": "Apagar",
"Gen_DeleteAll": "Apagar todos", "Gen_DeleteAll": "Apagar todos",
@@ -310,9 +310,10 @@
"Gen_Error": "Erro", "Gen_Error": "Erro",
"Gen_Filter": "Filtro", "Gen_Filter": "Filtro",
"Gen_Generate": "Gerar", "Gen_Generate": "Gerar",
"Gen_InvalidMac": "", "Gen_Invalid_Value": "",
"Gen_InvalidMac": "Endereço MAC Inválido.",
"Gen_LockedDB": "ERRO - A base de dados pode estar bloqueada - Verifique F12 Ferramentas de desenvolvimento -> Console ou tente mais tarde.", "Gen_LockedDB": "ERRO - A base de dados pode estar bloqueada - Verifique F12 Ferramentas de desenvolvimento -> Console ou tente mais tarde.",
"Gen_NetworkMask": "", "Gen_NetworkMask": "Máscara de Rede",
"Gen_Offline": "Offline", "Gen_Offline": "Offline",
"Gen_Okay": "Ok", "Gen_Okay": "Ok",
"Gen_Online": "Online", "Gen_Online": "Online",
@@ -329,8 +330,8 @@
"Gen_Select": "Selecionar", "Gen_Select": "Selecionar",
"Gen_SelectIcon": "<i class=\"fa-solid fa-chevron-down fa-fade\"></i>", "Gen_SelectIcon": "<i class=\"fa-solid fa-chevron-down fa-fade\"></i>",
"Gen_SelectToPreview": "Selecionar para pré-visualizar", "Gen_SelectToPreview": "Selecionar para pré-visualizar",
"Gen_Selected_Devices": "", "Gen_Selected_Devices": "Seleciona dispostivos:",
"Gen_Subnet": "", "Gen_Subnet": "Sub-rede",
"Gen_Switch": "Trocar", "Gen_Switch": "Trocar",
"Gen_Upd": "Atualizado com sucesso", "Gen_Upd": "Atualizado com sucesso",
"Gen_Upd_Fail": "A atualização falhou", "Gen_Upd_Fail": "A atualização falhou",
@@ -344,14 +345,14 @@
"General_display_name": "Geral", "General_display_name": "Geral",
"General_icon": "<i class=\"fa fa-gears\"></i>", "General_icon": "<i class=\"fa fa-gears\"></i>",
"HRS_TO_KEEP_NEWDEV_description": "", "HRS_TO_KEEP_NEWDEV_description": "",
"HRS_TO_KEEP_NEWDEV_name": "", "HRS_TO_KEEP_NEWDEV_name": "Remover novos dispostivos depois",
"HRS_TO_KEEP_OFFDEV_description": "", "HRS_TO_KEEP_OFFDEV_description": "",
"HRS_TO_KEEP_OFFDEV_name": "Apagar dispositivos offline após", "HRS_TO_KEEP_OFFDEV_name": "Apagar dispositivos offline após",
"LOADED_PLUGINS_description": "Quais plugins carregar. Adicionar plugins pode deixar a aplicação lenta. Leia mais sobre quais plugins precisam ser ativados, tipos ou opções de escaneamento na <a target=\"_blank\" href=\"https://github.com/jokob-sk/NetAlertX/tree/main/docs/PLUGINS.md\">documentação de plugins</a>. Plugins descarregados perderão as suas configurações. Somente plugins <code>desativados</code> podem ser descarregados.", "LOADED_PLUGINS_description": "Quais plugins carregar. Adicionar plugins pode deixar a aplicação lenta. Leia mais sobre quais plugins precisam ser ativados, tipos ou opções de escaneamento na <a target=\"_blank\" href=\"https://github.com/jokob-sk/NetAlertX/tree/main/docs/PLUGINS.md\">documentação de plugins</a>. Plugins descarregados perderão as suas configurações. Somente plugins <code>desativados</code> podem ser descarregados.",
"LOADED_PLUGINS_name": "Plugins carregados", "LOADED_PLUGINS_name": "Plugins carregados",
"LOG_LEVEL_description": "Esta definição permite um registo mais detalhado. Útil para depurar eventos gravados na base de dados.", "LOG_LEVEL_description": "Esta definição permite um registo mais detalhado. Útil para depurar eventos gravados na base de dados.",
"LOG_LEVEL_name": "Imprimir registo adicional", "LOG_LEVEL_name": "Imprimir registo adicional",
"Loading": "", "Loading": "A carregar…",
"Login_Box": "Introduza a sua palavra-passe", "Login_Box": "Introduza a sua palavra-passe",
"Login_Default_PWD": "A palavra-passe predefinida “123456” ainda está ativa.", "Login_Default_PWD": "A palavra-passe predefinida “123456” ainda está ativa.",
"Login_Info": "As palavra-passes são definidas por meio do plugin Definir palavra-passe. Verifique a <a target=\"_blank\" href=\"https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/set_password\">documentação do SETPWD</a> se tiver problemas para fazer login.", "Login_Info": "As palavra-passes são definidas por meio do plugin Definir palavra-passe. Verifique a <a target=\"_blank\" href=\"https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/set_password\">documentação do SETPWD</a> se tiver problemas para fazer login.",
@@ -369,20 +370,20 @@
"Maint_PurgeLog": "Limpar o registo", "Maint_PurgeLog": "Limpar o registo",
"Maint_RestartServer": "Reiniciar o servidor", "Maint_RestartServer": "Reiniciar o servidor",
"Maint_Restart_Server_noti_text": "Tem certeza de que deseja reiniciar o servidor backend? Isto pode causar inconsistência na app. Faça primeiro um backup da sua configuração. <br/> <br/> Nota: Isto pode levar alguns minutos.", "Maint_Restart_Server_noti_text": "Tem certeza de que deseja reiniciar o servidor backend? Isto pode causar inconsistência na app. Faça primeiro um backup da sua configuração. <br/> <br/> Nota: Isto pode levar alguns minutos.",
"Maintenance_InitCheck": "", "Maintenance_InitCheck": "Verificação inicial",
"Maintenance_InitCheck_Checking": "", "Maintenance_InitCheck_Checking": "A verificar…",
"Maintenance_InitCheck_QuickSetupGuide": "", "Maintenance_InitCheck_QuickSetupGuide": "Certifique-se de que seguiu o <a href=\"https://jokob-sk.github.io/NetAlertX/INITIAL_SETUP/\" target=\"_blank\">guia de configuração rápida</a>.",
"Maintenance_InitCheck_Success": "", "Maintenance_InitCheck_Success": "Aplicação inicializada com sucesso!",
"Maintenance_ReCheck": "", "Maintenance_ReCheck": "Verificar novamente",
"Maintenance_Running_Version": "Versão instalada", "Maintenance_Running_Version": "Versão instalada",
"Maintenance_Status": "Situação", "Maintenance_Status": "Situação",
"Maintenance_Title": "Ferramentas de manutenção", "Maintenance_Title": "Ferramentas de manutenção",
"Maintenance_Tool_DownloadConfig": "", "Maintenance_Tool_DownloadConfig": "Exportar Definições",
"Maintenance_Tool_DownloadConfig_text": "Descarregue um backup completo da configuração das Configurações armazenada no ficheiro <code>app.conf</code>.", "Maintenance_Tool_DownloadConfig_text": "Descarregue um backup completo da configuração das Configurações armazenada no ficheiro <code>app.conf</code>.",
"Maintenance_Tool_DownloadWorkflows": "", "Maintenance_Tool_DownloadWorkflows": "Exportar Workflows",
"Maintenance_Tool_DownloadWorkflows_text": "", "Maintenance_Tool_DownloadWorkflows_text": "Descarregue uma cópia completa de segurança dos seus Workflows armazenados no ficheiro <code>workflows.json</code> .",
"Maintenance_Tool_ExportCSV": "", "Maintenance_Tool_ExportCSV": "Exportar dispostivos (csv)",
"Maintenance_Tool_ExportCSV_noti": "", "Maintenance_Tool_ExportCSV_noti": "Exportar dispostivos (csv)",
"Maintenance_Tool_ExportCSV_noti_text": "Tem a certeza de que pretende gerar um ficheiro CSV?", "Maintenance_Tool_ExportCSV_noti_text": "Tem a certeza de que pretende gerar um ficheiro CSV?",
"Maintenance_Tool_ExportCSV_text": "Gere um ficheiro CSV (valor separado por vírgula) contendo a lista de dispositivos, incluindo os relacionamentos de rede entre os nós de rede e os dispositivos conectados. Também pode acionar isto a aceder esta URL <code>your_NetAlertX_url/php/server/devices.php?action=ExportCSV</code> ou ativando o plugin <a href=\"settings.php#CSVBCKP_header\">CSV Backup</a>.", "Maintenance_Tool_ExportCSV_text": "Gere um ficheiro CSV (valor separado por vírgula) contendo a lista de dispositivos, incluindo os relacionamentos de rede entre os nós de rede e os dispositivos conectados. Também pode acionar isto a aceder esta URL <code>your_NetAlertX_url/php/server/devices.php?action=ExportCSV</code> ou ativando o plugin <a href=\"settings.php#CSVBCKP_header\">CSV Backup</a>.",
"Maintenance_Tool_ImportCSV": "Importação de dispositivos (csv)", "Maintenance_Tool_ImportCSV": "Importação de dispositivos (csv)",
@@ -413,31 +414,31 @@
"Maintenance_Tool_del_ActHistory_noti": "Apagar atividade de rede", "Maintenance_Tool_del_ActHistory_noti": "Apagar atividade de rede",
"Maintenance_Tool_del_ActHistory_noti_text": "Tem certeza de que deseja redefinir a atividade da rede?", "Maintenance_Tool_del_ActHistory_noti_text": "Tem certeza de que deseja redefinir a atividade da rede?",
"Maintenance_Tool_del_ActHistory_text": "O gráfico de atividade da rede é redefinido. Isto não afeta os eventos.", "Maintenance_Tool_del_ActHistory_text": "O gráfico de atividade da rede é redefinido. Isto não afeta os eventos.",
"Maintenance_Tool_del_alldev": "", "Maintenance_Tool_del_alldev": "Remover todos os dispositivo",
"Maintenance_Tool_del_alldev_noti": "", "Maintenance_Tool_del_alldev_noti": "Remover dispositivos",
"Maintenance_Tool_del_alldev_noti_text": "Tem certeza de que deseja apagar todos os dispositivos?", "Maintenance_Tool_del_alldev_noti_text": "Tem certeza de que deseja apagar todos os dispositivos?",
"Maintenance_Tool_del_alldev_text": "Antes de usar esta função, faça um backup. Apagar não pode ser desfeito. Todos os dispositivos serão apagados da base de dados.", "Maintenance_Tool_del_alldev_text": "Antes de usar esta função, faça um backup. Apagar não pode ser desfeito. Todos os dispositivos serão apagados da base de dados.",
"Maintenance_Tool_del_allevents": "Apagar eventos (Repor presença)", "Maintenance_Tool_del_allevents": "Apagar eventos (Repor presença)",
"Maintenance_Tool_del_allevents30": "Apagar todos os eventos com mais que 30 dias", "Maintenance_Tool_del_allevents30": "Apagar todos os eventos com mais que 30 dias",
"Maintenance_Tool_del_allevents30_noti": "Apagar eventos", "Maintenance_Tool_del_allevents30_noti": "Apagar eventos",
"Maintenance_Tool_del_allevents30_noti_text": "", "Maintenance_Tool_del_allevents30_noti_text": "Tem a certeza de que pretende eliminar todos os Eventos com mais de 30 dias? Isto repõe a presença de todos os dispositivos.",
"Maintenance_Tool_del_allevents30_text": "Antes de utilizar esta função, faça uma cópia de segurança. Apagar não pode ser anulado. Todos os eventos com mais que 30 dias na base de dados serão eliminados. Nesse momento, a presença de todos os dispositivos será reiniciada. Este facto pode dar origem a sessões inválidas. Isto significa que os dispositivos são apresentados como “presentes” apesar de estarem offline. Uma verificação enquanto o dispositivo em questão está online resolve o problema.", "Maintenance_Tool_del_allevents30_text": "Antes de utilizar esta função, faça uma cópia de segurança. Apagar não pode ser anulado. Todos os eventos com mais que 30 dias na base de dados serão eliminados. Nesse momento, a presença de todos os dispositivos será reiniciada. Este facto pode dar origem a sessões inválidas. Isto significa que os dispositivos são apresentados como “presentes” apesar de estarem offline. Uma verificação enquanto o dispositivo em questão está online resolve o problema.",
"Maintenance_Tool_del_allevents_noti": "Apagar eventos", "Maintenance_Tool_del_allevents_noti": "Apagar eventos",
"Maintenance_Tool_del_allevents_noti_text": "", "Maintenance_Tool_del_allevents_noti_text": "Tem a certeza de que pretende eliminar todos os Eventos? Isto repõe a presença de todos os dispositivos.",
"Maintenance_Tool_del_allevents_text": "Antes de usar esta função, faça um backup. Apagar não pode ser desfeito. Todos os eventos na base de dados serão apagados. Nesse momento, a presença de todos os dispositivos será redefinida. Isto pode levar a sessões inválidas. Isto significa que os dispositivos são exibidos como \"presente\" embora estejam offline. Uma varredura enquanto o dispositivo em questão é on-line resolve o problema.", "Maintenance_Tool_del_allevents_text": "Antes de usar esta função, faça um backup. Apagar não pode ser desfeito. Todos os eventos na base de dados serão apagados. Nesse momento, a presença de todos os dispositivos será redefinida. Isto pode levar a sessões inválidas. Isto significa que os dispositivos são exibidos como \"presente\" embora estejam offline. Uma varredura enquanto o dispositivo em questão é on-line resolve o problema.",
"Maintenance_Tool_del_empty_macs": "", "Maintenance_Tool_del_empty_macs": "Eliminar dispositivos com endereços MACs vazios",
"Maintenance_Tool_del_empty_macs_noti": "", "Maintenance_Tool_del_empty_macs_noti": "Elimitar dispositivos",
"Maintenance_Tool_del_empty_macs_noti_text": "Tem certeza que deseja apagar todos os dispositivos com endereços MAC vazios?<br>(talvez prefira arquivá-los)", "Maintenance_Tool_del_empty_macs_noti_text": "Tem certeza que deseja apagar todos os dispositivos com endereços MAC vazios?<br>(talvez prefira arquivá-los)",
"Maintenance_Tool_del_empty_macs_text": "Antes de usar esta função, faça um backup. Apagar não pode ser desfeito. Todos os dispositivos sem MAC serão apagados da base de dados.", "Maintenance_Tool_del_empty_macs_text": "Antes de usar esta função, faça um backup. Apagar não pode ser desfeito. Todos os dispositivos sem MAC serão apagados da base de dados.",
"Maintenance_Tool_del_selecteddev": "Apagar dispositivos selecionados", "Maintenance_Tool_del_selecteddev": "Apagar dispositivos selecionados",
"Maintenance_Tool_del_selecteddev_text": "Antes de usar esta função, faça um backup. Apagar não pode ser desfeito. Dispositivos selecionados serão apagados da base de dados.", "Maintenance_Tool_del_selecteddev_text": "Antes de usar esta função, faça um backup. Apagar não pode ser desfeito. Dispositivos selecionados serão apagados da base de dados.",
"Maintenance_Tool_del_unknowndev": "", "Maintenance_Tool_del_unknowndev": "Eliminar dispositivos desconhecidos",
"Maintenance_Tool_del_unknowndev_noti": "", "Maintenance_Tool_del_unknowndev_noti": "Eliminar dispositivos desconhecidos",
"Maintenance_Tool_del_unknowndev_noti_text": "Tem certeza que deseja apagar todos (desconhecidos) e (nome não encontrados) dispositivos?", "Maintenance_Tool_del_unknowndev_noti_text": "Tem certeza que deseja apagar todos (desconhecidos) e (nome não encontrados) dispositivos?",
"Maintenance_Tool_del_unknowndev_text": "Antes de usar esta função, faça um backup. Apagar não pode ser desfeito. Todos os dispositivos nomeados (não conhecidos) serão apagados da base de dados.", "Maintenance_Tool_del_unknowndev_text": "Antes de usar esta função, faça um backup. Apagar não pode ser desfeito. Todos os dispositivos nomeados (não conhecidos) serão apagados da base de dados.",
"Maintenance_Tool_displayed_columns_text": "Altere a visibilidade e a ordem das colunas na página <a href=\"devices.php\"><b> <i class=\"fa fa-portátil\"></i> Dispositivos</b></a>.", "Maintenance_Tool_displayed_columns_text": "Altere a visibilidade e a ordem das colunas na página <a href=\"devices.php\"><b> <i class=\"fa fa-portátil\"></i> Dispositivos</b></a>.",
"Maintenance_Tool_drag_me": "Arraste-me para reordenar colunas.", "Maintenance_Tool_drag_me": "Arraste-me para reordenar colunas.",
"Maintenance_Tool_order_columns_text": "", "Maintenance_Tool_order_columns_text": "Maintenance_Tool_order_columns_text",
"Maintenance_Tool_purgebackup": "Limpar cópias de segurança", "Maintenance_Tool_purgebackup": "Limpar cópias de segurança",
"Maintenance_Tool_purgebackup_noti": "Limpar cópias de segurança", "Maintenance_Tool_purgebackup_noti": "Limpar cópias de segurança",
"Maintenance_Tool_purgebackup_noti_text": "Tem certeza que deseja apagar todos os backups exceto os últimos 3?", "Maintenance_Tool_purgebackup_noti_text": "Tem certeza que deseja apagar todos os backups exceto os últimos 3?",
@@ -450,13 +451,13 @@
"Maintenance_Tool_upgrade_database_noti_text": "Tem certeza de que deseja atualizar a base de dados?<br>(talvez prefira arquivá-la)", "Maintenance_Tool_upgrade_database_noti_text": "Tem certeza de que deseja atualizar a base de dados?<br>(talvez prefira arquivá-la)",
"Maintenance_Tool_upgrade_database_text": "Este botão atualizará a base de dados para ativar o gráfico Atividade de rede nas últimas 12 horas. Faça uma cópia de segurança da sua base de dados em caso de problemas.", "Maintenance_Tool_upgrade_database_text": "Este botão atualizará a base de dados para ativar o gráfico Atividade de rede nas últimas 12 horas. Faça uma cópia de segurança da sua base de dados em caso de problemas.",
"Maintenance_Tools_Tab_BackupRestore": "Backup / Restauração", "Maintenance_Tools_Tab_BackupRestore": "Backup / Restauração",
"Maintenance_Tools_Tab_Logging": "", "Maintenance_Tools_Tab_Logging": "Logs",
"Maintenance_Tools_Tab_Settings": "Configurações", "Maintenance_Tools_Tab_Settings": "Configurações",
"Maintenance_Tools_Tab_Tools": "Ferramentas", "Maintenance_Tools_Tab_Tools": "Ferramentas",
"Maintenance_Tools_Tab_UISettings": "Configurações de interface", "Maintenance_Tools_Tab_UISettings": "Configurações de interface",
"Maintenance_arp_status": "Estado de digitalização", "Maintenance_arp_status": "Estado de digitalização",
"Maintenance_arp_status_off": "está atualmente desativado", "Maintenance_arp_status_off": "está atualmente desativado",
"Maintenance_arp_status_on": "", "Maintenance_arp_status_on": "Scan em curso",
"Maintenance_built_on": "Construído em", "Maintenance_built_on": "Construído em",
"Maintenance_current_version": "Você está atualizado. Confira o que <a href=\"https://github.com/jokob-sk/NetAlertX/issues/138\" target=\"_blank\"> estou a trabalhar em</a>.", "Maintenance_current_version": "Você está atualizado. Confira o que <a href=\"https://github.com/jokob-sk/NetAlertX/issues/138\" target=\"_blank\"> estou a trabalhar em</a>.",
"Maintenance_database_backup": "Backups DB", "Maintenance_database_backup": "Backups DB",
@@ -467,8 +468,8 @@
"Maintenance_database_rows": "Tabela (linhas)", "Maintenance_database_rows": "Tabela (linhas)",
"Maintenance_database_size": "Tamanho da base de dados", "Maintenance_database_size": "Tamanho da base de dados",
"Maintenance_lang_selector_apply": "Aplicar", "Maintenance_lang_selector_apply": "Aplicar",
"Maintenance_lang_selector_empty": "", "Maintenance_lang_selector_empty": "Escolha a lingua",
"Maintenance_lang_selector_lable": "", "Maintenance_lang_selector_lable": "Escolha a lingua",
"Maintenance_lang_selector_text": "A mudança ocorre no lado do cliente, por isso afeta apenas o navegador atual.", "Maintenance_lang_selector_text": "A mudança ocorre no lado do cliente, por isso afeta apenas o navegador atual.",
"Maintenance_new_version": "Uma nova versão está disponível. Confira as <a href=\"https://github.com/jokob-sk/NetAlertX/releases\" target=\"_blank\">notas de lançamento</a>.", "Maintenance_new_version": "Uma nova versão está disponível. Confira as <a href=\"https://github.com/jokob-sk/NetAlertX/releases\" target=\"_blank\">notas de lançamento</a>.",
"Maintenance_themeselector_apply": "Aplicar", "Maintenance_themeselector_apply": "Aplicar",
@@ -476,10 +477,10 @@
"Maintenance_themeselector_lable": "Selecionar Skin", "Maintenance_themeselector_lable": "Selecionar Skin",
"Maintenance_themeselector_text": "A mudança ocorre no lado do servidor, por isso afeta todos os dispositivos em uso.", "Maintenance_themeselector_text": "A mudança ocorre no lado do servidor, por isso afeta todos os dispositivos em uso.",
"Maintenance_version": "Atualizações de apps", "Maintenance_version": "Atualizações de apps",
"NETWORK_DEVICE_TYPES_description": "", "NETWORK_DEVICE_TYPES_description": "Quais os tipos de dispositivos que podem ser usados como dispositivos de rede na vista de Rede. O tipo de dispositivo tem de corresponder exatamente à definição <code>Type</code> um dispositivo específico em Detalhes do dispositivo. Adicione-o ao dispositivo através do botão <code>+</code>. Não remova tipos existentes, apenas adicione novos.",
"NETWORK_DEVICE_TYPES_name": "Tipos de dispositivo de rede", "NETWORK_DEVICE_TYPES_name": "Tipos de dispositivo de rede",
"Navigation_About": "Sobre a", "Navigation_About": "Sobre a",
"Navigation_AppEvents": "", "Navigation_AppEvents": "Eventos de aplicações",
"Navigation_Devices": "Dispositivos", "Navigation_Devices": "Dispositivos",
"Navigation_Donations": "Doações", "Navigation_Donations": "Doações",
"Navigation_Events": "Eventos", "Navigation_Events": "Eventos",
@@ -489,38 +490,38 @@
"Navigation_Network": "Rede", "Navigation_Network": "Rede",
"Navigation_Notifications": "Notificações", "Navigation_Notifications": "Notificações",
"Navigation_Plugins": "Plugins", "Navigation_Plugins": "Plugins",
"Navigation_Presence": "", "Navigation_Presence": "Presença",
"Navigation_Report": "", "Navigation_Report": "Reports enviados",
"Navigation_Settings": "", "Navigation_Settings": "Definições",
"Navigation_SystemInfo": "", "Navigation_SystemInfo": "Informação de sistema",
"Navigation_Workflows": "", "Navigation_Workflows": "Workflows",
"Network_Assign": "", "Network_Assign": "Conectar ao nodo de network <i class=\"fa fa-server\"></i> em cima",
"Network_Cant_Assign": "", "Network_Cant_Assign": "Não é possível atribuir o node raiz da Internet como um node folha filho.",
"Network_Cant_Assign_No_Node_Selected": "", "Network_Cant_Assign_No_Node_Selected": "Não é possível atribuir, nenhum node pai selecionado.",
"Network_Configuration_Error": "", "Network_Configuration_Error": "Erro de configuração",
"Network_Connected": "", "Network_Connected": "Dispositivos conectados",
"Network_Devices": "", "Network_Devices": "Dispositivos de rede",
"Network_ManageAdd": "", "Network_ManageAdd": "Adicionar dispositivo",
"Network_ManageAdd_Name": "", "Network_ManageAdd_Name": "Nome do dispositivo",
"Network_ManageAdd_Name_text": "", "Network_ManageAdd_Name_text": "Nome sem caracteres especiais",
"Network_ManageAdd_Port": "", "Network_ManageAdd_Port": "Contagem de portas",
"Network_ManageAdd_Port_text": "", "Network_ManageAdd_Port_text": "Deixe em branco para Wi-Fi e Powerline",
"Network_ManageAdd_Submit": "", "Network_ManageAdd_Submit": "Adicionar dispositivo",
"Network_ManageAdd_Type": "", "Network_ManageAdd_Type": "Tipo de dispositivo",
"Network_ManageAdd_Type_text": "", "Network_ManageAdd_Type_text": "-- Selecionar Tipo --",
"Network_ManageAssign": "", "Network_ManageAssign": "Asignar",
"Network_ManageDel": "", "Network_ManageDel": "Eliminar dispositivo",
"Network_ManageDel_Name": "", "Network_ManageDel_Name": "Dispositivo a eliminar",
"Network_ManageDel_Name_text": "", "Network_ManageDel_Name_text": "-- Seleciona dispositivo --",
"Network_ManageDel_Submit": "", "Network_ManageDel_Submit": "Eliminar",
"Network_ManageDevices": "", "Network_ManageDevices": "Gerir dispositivos",
"Network_ManageEdit": "", "Network_ManageEdit": "Actualizar dispositivos",
"Network_ManageEdit_ID": "", "Network_ManageEdit_ID": "Dispositivos a actualizar",
"Network_ManageEdit_ID_text": "", "Network_ManageEdit_ID_text": "-- Selecionar dispositivo para edição --",
"Network_ManageEdit_Name": "", "Network_ManageEdit_Name": "Novo nome de dispositivo",
"Network_ManageEdit_Name_text": "", "Network_ManageEdit_Name_text": "Nome sem caracteres especiais",
"Network_ManageEdit_Port": "", "Network_ManageEdit_Port": " Nova contagem de portas",
"Network_ManageEdit_Port_text": "", "Network_ManageEdit_Port_text": "Deixe em branco para Wi-Fi e Powerline.",
"Network_ManageEdit_Submit": "", "Network_ManageEdit_Submit": "",
"Network_ManageEdit_Type": "", "Network_ManageEdit_Type": "",
"Network_ManageEdit_Type_text": "", "Network_ManageEdit_Type_text": "",
@@ -761,4 +762,4 @@
"settings_system_label": "", "settings_system_label": "",
"settings_update_item_warning": "", "settings_update_item_warning": "",
"test_event_tooltip": "Guarde as alterações antes de testar as definições." "test_event_tooltip": "Guarde as alterações antes de testar as definições."
} }

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "Фильтр", "Gen_Filter": "Фильтр",
"Gen_Generate": "Генерировать", "Gen_Generate": "Генерировать",
"Gen_InvalidMac": "Неверный Mac-адрес.", "Gen_InvalidMac": "Неверный Mac-адрес.",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "ОШИБКА - Возможно, база данных заблокирована. Проверьте инструменты разработчика F12 -> Консоль или повторите попытку позже.", "Gen_LockedDB": "ОШИБКА - Возможно, база данных заблокирована. Проверьте инструменты разработчика F12 -> Консоль или повторите попытку позже.",
"Gen_NetworkMask": "Маска сети", "Gen_NetworkMask": "Маска сети",
"Gen_Offline": "Оффлайн", "Gen_Offline": "Оффлайн",
@@ -761,4 +762,4 @@
"settings_system_label": "Система", "settings_system_label": "Система",
"settings_update_item_warning": "Обновить значение ниже. Будьте осторожны, следуя предыдущему формату. <b>Проверка не выполняется.</b>", "settings_update_item_warning": "Обновить значение ниже. Будьте осторожны, следуя предыдущему формату. <b>Проверка не выполняется.</b>",
"test_event_tooltip": "Сначала сохраните изменения, прежде чем проверять настройки." "test_event_tooltip": "Сначала сохраните изменения, прежде чем проверять настройки."
} }

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "", "Gen_Filter": "",
"Gen_Generate": "", "Gen_Generate": "",
"Gen_InvalidMac": "", "Gen_InvalidMac": "",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "", "Gen_LockedDB": "",
"Gen_NetworkMask": "", "Gen_NetworkMask": "",
"Gen_Offline": "", "Gen_Offline": "",

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "Filtre", "Gen_Filter": "Filtre",
"Gen_Generate": "Oluştur", "Gen_Generate": "Oluştur",
"Gen_InvalidMac": "", "Gen_InvalidMac": "",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "HATA - Veritabanı kilitlenmiş olabilir - F12 Geliştirici araçlarını -> Konsol kısmını kontrol edin veya daha sonra tekrar deneyin.", "Gen_LockedDB": "HATA - Veritabanı kilitlenmiş olabilir - F12 Geliştirici araçlarını -> Konsol kısmını kontrol edin veya daha sonra tekrar deneyin.",
"Gen_NetworkMask": "", "Gen_NetworkMask": "",
"Gen_Offline": "Çevrimdışı", "Gen_Offline": "Çevrimdışı",

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "Фільтр", "Gen_Filter": "Фільтр",
"Gen_Generate": "Генерувати", "Gen_Generate": "Генерувати",
"Gen_InvalidMac": "Недійсна Mac-адреса.", "Gen_InvalidMac": "Недійсна Mac-адреса.",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "ПОМИЛКА БД може бути заблоковано перевірте F12 Інструменти розробника -> Консоль або спробуйте пізніше.", "Gen_LockedDB": "ПОМИЛКА БД може бути заблоковано перевірте F12 Інструменти розробника -> Консоль або спробуйте пізніше.",
"Gen_NetworkMask": "Маска мережі", "Gen_NetworkMask": "Маска мережі",
"Gen_Offline": "Офлайн", "Gen_Offline": "Офлайн",

View File

@@ -311,6 +311,7 @@
"Gen_Filter": "筛选", "Gen_Filter": "筛选",
"Gen_Generate": "生成", "Gen_Generate": "生成",
"Gen_InvalidMac": "无效的 Mac 地址。", "Gen_InvalidMac": "无效的 Mac 地址。",
"Gen_Invalid_Value": "",
"Gen_LockedDB": "错误 - DB 可能被锁定 - 检查 F12 开发工具 -> 控制台或稍后重试。", "Gen_LockedDB": "错误 - DB 可能被锁定 - 检查 F12 开发工具 -> 控制台或稍后重试。",
"Gen_NetworkMask": "网络掩码", "Gen_NetworkMask": "网络掩码",
"Gen_Offline": "离线", "Gen_Offline": "离线",

View File

@@ -91,7 +91,7 @@
"elementType": "input", "elementType": "input",
"elementOptions": [ "elementOptions": [
{ {
"onChange": "validateRegex(this)" "focusout": "validateRegex(this)"
}, },
{ {
"base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ=" "base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ="

View File

@@ -8,12 +8,12 @@ from pytz import timezone
INSTALL_PATH = os.getenv('NETALERTX_APP', '/app') INSTALL_PATH = os.getenv('NETALERTX_APP', '/app')
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
from const import logPath from const import logPath # noqa: E402, E261 [flake8 lint suppression]
from plugin_helper import Plugin_Objects from plugin_helper import Plugin_Objects # noqa: E402, E261 [flake8 lint suppression]
from logger import mylog, Logger from logger import mylog, Logger # noqa: E402, E261 [flake8 lint suppression]
from helper import get_setting_value from helper import get_setting_value # noqa: E402, E261 [flake8 lint suppression]
import conf import conf # noqa: E402, E261 [flake8 lint suppression]
# Make sure the TIMEZONE for logging is correct # Make sure the TIMEZONE for logging is correct
conf.tz = timezone(get_setting_value('TIMEZONE')) conf.tz = timezone(get_setting_value('TIMEZONE'))
@@ -32,9 +32,8 @@ RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log')
plugin_objects = Plugin_Objects(RESULT_FILE) plugin_objects = Plugin_Objects(RESULT_FILE)
def main(): def main():
mylog('verbose', [f'[{pluginName}] In script']) mylog('verbose', [f'[{pluginName}] In script'])
# Retrieve configuration settings # Retrieve configuration settings
some_setting = get_setting_value('SYNC_plugins') some_setting = get_setting_value('SYNC_plugins')
@@ -47,14 +46,14 @@ def main():
# Process the data into native application tables # Process the data into native application tables
if len(device_data) > 0: if len(device_data) > 0:
# insert devices into the lats_result.log # insert devices into the lats_result.log
# make sure the below mapping is mapped in config.json, for example: # make sure the below mapping is mapped in config.json, for example:
# "database_column_definitions": [ # "database_column_definitions": [
# { # {
# "column": "Object_PrimaryID", <--------- the value I save into primaryId # "column": "Object_PrimaryID", <--------- the value I save into primaryId
# "mapped_to_column": "cur_MAC", <--------- gets inserted into the CurrentScan DB # "mapped_to_column": "cur_MAC", <--------- gets inserted into the CurrentScan DB
# table column cur_MAC # table column cur_MAC
# #
for device in device_data: for device in device_data:
plugin_objects.add_object( plugin_objects.add_object(
primaryId = device['mac_address'], primaryId = device['mac_address'],
@@ -65,11 +64,11 @@ def main():
watched4 = device['last_seen'], watched4 = device['last_seen'],
extra = '', extra = '',
foreignKey = device['mac_address'] foreignKey = device['mac_address']
# helpVal1 = "Something1", # Optional Helper values to be passed for mapping into the app # helpVal1 = "Something1", # Optional Helper values to be passed for mapping into the app
# helpVal2 = "Something1", # If you need to use even only 1, add the remaining ones too # helpVal2 = "Something1", # If you need to use even only 1, add the remaining ones too
# helpVal3 = "Something1", # and set them to 'null'. Check the the docs for details: # helpVal3 = "Something1", # and set them to 'null'. Check the the docs for details:
# helpVal4 = "Something1", # https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS_DEV.md # helpVal4 = "Something1", # https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS_DEV.md
) )
mylog('verbose', [f'[{pluginName}] New entries: "{len(device_data)}"']) mylog('verbose', [f'[{pluginName}] New entries: "{len(device_data)}"'])
@@ -78,14 +77,15 @@ def main():
return 0 return 0
# retrieve data # retrieve data
def get_device_data(some_setting): def get_device_data(some_setting):
device_data = [] device_data = []
# do some processing, call exteranl APIs, and return a device_data list # do some processing, call exteranl APIs, and return a device_data list
# ... # ...
# #
# Sample data for testing purposes, you can adjust the processing in main() as needed # Sample data for testing purposes, you can adjust the processing in main() as needed
# ... before adding it to the plugin_objects.add_object(...) # ... before adding it to the plugin_objects.add_object(...)
device_data = [ device_data = [
@@ -113,8 +113,9 @@ def get_device_data(some_setting):
} }
] ]
# Return the data to be detected by the main application # Return the data to be detected by the main application
return device_data return device_data
if __name__ == '__main__': if __name__ == '__main__':
main() main()

View File

@@ -11,10 +11,10 @@ INSTALL_PATH = os.getenv('NETALERTX_APP', '/app')
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
# NetAlertX modules # NetAlertX modules
from const import logPath from const import logPath # noqa: E402 [flake8 lint suppression]
from plugin_helper import Plugin_Objects from plugin_helper import Plugin_Objects # noqa: E402 [flake8 lint suppression]
from logger import mylog from logger import mylog # noqa: E402 [flake8 lint suppression]
from helper import get_setting_value from helper import get_setting_value # noqa: E402 [flake8 lint suppression]
pluginName = 'TESTONLY' pluginName = 'TESTONLY'
@@ -28,14 +28,11 @@ plugin_objects = Plugin_Objects(RESULT_FILE)
md5_hash = hashlib.md5() md5_hash = hashlib.md5()
# globals # globals
def main(): def main():
# START # START
mylog('verbose', [f'[{pluginName}] In script']) mylog('verbose', [f'[{pluginName}] In script'])
# SPACE FOR TESTING 🔽 # SPACE FOR TESTING 🔽
str = "ABC-MBP._another.localdomain." str = "ABC-MBP._another.localdomain."
@@ -43,28 +40,23 @@ def main():
# result = cleanDeviceName(str, True) # result = cleanDeviceName(str, True)
regexes = get_setting_value('NEWDEV_NAME_CLEANUP_REGEX') regexes = get_setting_value('NEWDEV_NAME_CLEANUP_REGEX')
print(regexes) print(regexes)
subnets = get_setting_value('SCAN_SUBNETS') subnets = get_setting_value('SCAN_SUBNETS')
print(subnets) print(subnets)
for rgx in regexes: for rgx in regexes:
mylog('trace', ["[cleanDeviceName] applying regex : " + rgx]) mylog('trace', ["[cleanDeviceName] applying regex : " + rgx])
mylog('trace', ["[cleanDeviceName] name before regex : " + str]) mylog('trace', ["[cleanDeviceName] name before regex : " + str])
str = re.sub(rgx, "", str) str = re.sub(rgx, "", str)
mylog('trace', ["[cleanDeviceName] name after regex : " + str]) mylog('trace', ["[cleanDeviceName] name after regex : " + str])
mylog('debug', ["[cleanDeviceName] output: " + str]) mylog('debug', ["[cleanDeviceName] output: " + str])
# SPACE FOR TESTING 🔼 # SPACE FOR TESTING 🔼
# END # END
mylog('verbose', [f'[{pluginName}] result "{str}"']) mylog('verbose', [f'[{pluginName}] result "{str}"'])
# -------------INIT--------------------- # -------------INIT---------------------

View File

@@ -9,15 +9,15 @@ import sys
INSTALL_PATH = os.getenv("NETALERTX_APP", "/app") INSTALL_PATH = os.getenv("NETALERTX_APP", "/app")
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
import conf import conf # noqa: E402 [flake8 lint suppression]
from const import confFileName, logPath from const import confFileName, logPath # noqa: E402 [flake8 lint suppression]
from utils.datetime_utils import timeNowDB from utils.datetime_utils import timeNowDB # noqa: E402 [flake8 lint suppression]
from plugin_helper import Plugin_Objects from plugin_helper import Plugin_Objects # noqa: E402 [flake8 lint suppression]
from logger import mylog, Logger from logger import mylog, Logger # noqa: E402 [flake8 lint suppression]
from helper import get_setting_value from helper import get_setting_value # noqa: E402 [flake8 lint suppression]
from models.notification_instance import NotificationInstance from models.notification_instance import NotificationInstance # noqa: E402 [flake8 lint suppression]
from database import DB from database import DB # noqa: E402 [flake8 lint suppression]
from pytz import timezone from pytz import timezone # noqa: E402 [flake8 lint suppression]
# Make sure the TIMEZONE for logging is correct # Make sure the TIMEZONE for logging is correct
conf.tz = timezone(get_setting_value("TIMEZONE")) conf.tz = timezone(get_setting_value("TIMEZONE"))
@@ -35,13 +35,8 @@ def main():
mylog("verbose", [f"[{pluginName}](publisher) In script"]) mylog("verbose", [f"[{pluginName}](publisher) In script"])
# Check if basic config settings supplied # Check if basic config settings supplied
if check_config() == False: if check_config() is False:
mylog( mylog("none", f"[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.")
"none",
[
f"[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables."
],
)
return return
# Create a database connection # Create a database connection
@@ -65,9 +60,9 @@ def main():
# Log result # Log result
plugin_objects.add_object( plugin_objects.add_object(
primaryId = pluginName, primaryId = pluginName,
secondaryId = timeNowDB(), secondaryId = timeNowDB(),
watched1 = notification["GUID"], watched1 = notification["GUID"],
watched2 = result, watched2 = result,
watched3 = 'null', watched3 = 'null',
watched4 = 'null', watched4 = 'null',
extra = 'null', extra = 'null',
@@ -80,8 +75,7 @@ def main():
# ------------------------------------------------------------------------------- # -------------------------------------------------------------------------------
def check_config(): def check_config():
if get_setting_value("APPRISE_HOST") == "" or ( if get_setting_value("APPRISE_HOST") == "" or (
get_setting_value("APPRISE_URL") == "" get_setting_value("APPRISE_URL") == "" and get_setting_value("APPRISE_TAG") == ""
and get_setting_value("APPRISE_TAG") == ""
): ):
return False return False
else: else:

View File

@@ -16,15 +16,15 @@ INSTALL_PATH = os.getenv('NETALERTX_APP', '/app')
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
# NetAlertX modules # NetAlertX modules
import conf import conf # noqa: E402 [flake8 lint suppression]
from const import confFileName, logPath from const import confFileName, logPath # noqa: E402 [flake8 lint suppression]
from plugin_helper import Plugin_Objects from plugin_helper import Plugin_Objects # noqa: E402 [flake8 lint suppression]
from utils.datetime_utils import timeNowDB from utils.datetime_utils import timeNowDB # noqa: E402 [flake8 lint suppression]
from logger import mylog, Logger from logger import mylog, Logger # noqa: E402 [flake8 lint suppression]
from helper import get_setting_value, hide_email from helper import get_setting_value, hide_email # noqa: E402 [flake8 lint suppression]
from models.notification_instance import NotificationInstance from models.notification_instance import NotificationInstance # noqa: E402 [flake8 lint suppression]
from database import DB from database import DB # noqa: E402 [flake8 lint suppression]
from pytz import timezone from pytz import timezone # noqa: E402 [flake8 lint suppression]
# Make sure the TIMEZONE for logging is correct # Make sure the TIMEZONE for logging is correct
conf.tz = timezone(get_setting_value('TIMEZONE')) conf.tz = timezone(get_setting_value('TIMEZONE'))
@@ -38,13 +38,12 @@ LOG_PATH = logPath + '/plugins'
RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log') RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log')
def main(): def main():
mylog('verbose', [f'[{pluginName}](publisher) In script']) mylog('verbose', [f'[{pluginName}](publisher) In script'])
# Check if basic config settings supplied # Check if basic config settings supplied
if check_config() == False: if check_config() is False:
mylog('none', [f'[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.']) mylog('none', [f'[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.'])
return return
@@ -61,7 +60,7 @@ def main():
# Retrieve new notifications # Retrieve new notifications
new_notifications = notifications.getNew() new_notifications = notifications.getNew()
# mylog('verbose', [f'[{pluginName}] new_notifications: ', new_notifications]) # mylog('verbose', [f'[{pluginName}] new_notifications: ', new_notifications])
mylog('verbose', [f'[{pluginName}] SMTP_SERVER: ', get_setting_value("SMTP_SERVER")]) mylog('verbose', [f'[{pluginName}] SMTP_SERVER: ', get_setting_value("SMTP_SERVER")])
mylog('verbose', [f'[{pluginName}] SMTP_PORT: ', get_setting_value("SMTP_PORT")]) mylog('verbose', [f'[{pluginName}] SMTP_PORT: ', get_setting_value("SMTP_PORT")])
mylog('verbose', [f'[{pluginName}] SMTP_SKIP_LOGIN: ', get_setting_value("SMTP_SKIP_LOGIN")]) mylog('verbose', [f'[{pluginName}] SMTP_SKIP_LOGIN: ', get_setting_value("SMTP_SKIP_LOGIN")])
@@ -72,19 +71,18 @@ def main():
# mylog('verbose', [f'[{pluginName}] SMTP_REPORT_TO: ', get_setting_value("SMTP_REPORT_TO")]) # mylog('verbose', [f'[{pluginName}] SMTP_REPORT_TO: ', get_setting_value("SMTP_REPORT_TO")])
# mylog('verbose', [f'[{pluginName}] SMTP_REPORT_FROM: ', get_setting_value("SMTP_REPORT_FROM")]) # mylog('verbose', [f'[{pluginName}] SMTP_REPORT_FROM: ', get_setting_value("SMTP_REPORT_FROM")])
# Process the new notifications (see the Notifications DB table for structure or check the /php/server/query_json.php?file=table_notifications.json endpoint) # Process the new notifications (see the Notifications DB table for structure or check the /php/server/query_json.php?file=table_notifications.json endpoint)
for notification in new_notifications: for notification in new_notifications:
# Send notification # Send notification
result = send(notification["HTML"], notification["Text"]) result = send(notification["HTML"], notification["Text"])
# Log result # Log result
plugin_objects.add_object( plugin_objects.add_object(
primaryId = pluginName, primaryId = pluginName,
secondaryId = timeNowDB(), secondaryId = timeNowDB(),
watched1 = notification["GUID"], watched1 = notification["GUID"],
watched2 = result, watched2 = result,
watched3 = 'null', watched3 = 'null',
watched4 = 'null', watched4 = 'null',
extra = 'null', extra = 'null',
@@ -93,25 +91,33 @@ def main():
plugin_objects.write_result_file() plugin_objects.write_result_file()
#-------------------------------------------------------------------------------
def check_config (): # -------------------------------------------------------------------------------
def check_config():
server = get_setting_value('SMTP_SERVER') server = get_setting_value('SMTP_SERVER')
report_to = get_setting_value("SMTP_REPORT_TO") report_to = get_setting_value("SMTP_REPORT_TO")
report_from = get_setting_value("SMTP_REPORT_FROM") report_from = get_setting_value("SMTP_REPORT_FROM")
if server == '' or report_from == '' or report_to == '': if server == '' or report_from == '' or report_to == '':
mylog('none', [f'[Email Check Config] ⚠ ERROR: Email service not set up correctly. Check your {confFileName} SMTP_*, SMTP_REPORT_FROM and SMTP_REPORT_TO variables.']) mylog('none', [f'[Email Check Config] ⚠ ERROR: Email service not set up correctly. Check your {confFileName} SMTP_*, SMTP_REPORT_FROM and SMTP_REPORT_TO variables.'])
return False return False
else: else:
return True return True
#-------------------------------------------------------------------------------
# -------------------------------------------------------------------------------
def send(pHTML, pText): def send(pHTML, pText):
mylog('debug', [f'[{pluginName}] SMTP_REPORT_TO: {hide_email(str(get_setting_value("SMTP_REPORT_TO")))} SMTP_USER: {hide_email(str(get_setting_value("SMTP_USER")))}']) mylog('debug', [f'[{pluginName}] SMTP_REPORT_TO: {hide_email(str(get_setting_value("SMTP_REPORT_TO")))} SMTP_USER: {hide_email(str(get_setting_value("SMTP_USER")))}'])
subject, from_email, to_email, message_html, message_text = sanitize_email_content(str(get_setting_value("SMTP_SUBJECT")), get_setting_value("SMTP_REPORT_FROM"), get_setting_value("SMTP_REPORT_TO"), pHTML, pText) subject, from_email, to_email, message_html, message_text = sanitize_email_content(
str(get_setting_value("SMTP_SUBJECT")),
get_setting_value("SMTP_REPORT_FROM"),
get_setting_value("SMTP_REPORT_TO"),
pHTML,
pText
)
emails = [] emails = []
@@ -132,10 +138,10 @@ def send(pHTML, pText):
msg['Subject'] = subject msg['Subject'] = subject
msg['From'] = from_email msg['From'] = from_email
msg['To'] = mail_addr msg['To'] = mail_addr
msg['Date'] = formatdate(localtime=True) msg['Date'] = formatdate(localtime=True)
msg.attach (MIMEText (message_text, 'plain')) msg.attach(MIMEText(message_text, 'plain'))
msg.attach (MIMEText (message_html, 'html')) msg.attach(MIMEText(message_html, 'html'))
# Set a timeout for the SMTP connection (in seconds) # Set a timeout for the SMTP connection (in seconds)
smtp_timeout = 30 smtp_timeout = 30
@@ -144,30 +150,31 @@ def send(pHTML, pText):
if get_setting_value("LOG_LEVEL") == 'debug': if get_setting_value("LOG_LEVEL") == 'debug':
send_email(msg,smtp_timeout) send_email(msg, smtp_timeout)
else: else:
try: try:
send_email(msg,smtp_timeout) send_email(msg, smtp_timeout)
except smtplib.SMTPAuthenticationError as e: except smtplib.SMTPAuthenticationError as e:
mylog('none', [' ERROR: Couldn\'t connect to the SMTP server (SMTPAuthenticationError)']) mylog('none', [' ERROR: Couldn\'t connect to the SMTP server (SMTPAuthenticationError)'])
mylog('none', [' ERROR: Double-check your SMTP_USER and SMTP_PASS settings.)']) mylog('none', [' ERROR: Double-check your SMTP_USER and SMTP_PASS settings.)'])
mylog('none', [' ERROR: ', str(e)]) mylog('none', [' ERROR: ', str(e)])
except smtplib.SMTPServerDisconnected as e: except smtplib.SMTPServerDisconnected as e:
mylog('none', [' ERROR: Couldn\'t connect to the SMTP server (SMTPServerDisconnected)']) mylog('none', [' ERROR: Couldn\'t connect to the SMTP server (SMTPServerDisconnected)'])
mylog('none', [' ERROR: ', str(e)]) mylog('none', [' ERROR: ', str(e)])
except socket.gaierror as e: except socket.gaierror as e:
mylog('none', [' ERROR: Could not resolve hostname (socket.gaierror)']) mylog('none', [' ERROR: Could not resolve hostname (socket.gaierror)'])
mylog('none', [' ERROR: ', str(e)]) mylog('none', [' ERROR: ', str(e)])
except ssl.SSLError as e: except ssl.SSLError as e:
mylog('none', [' ERROR: Could not establish SSL connection (ssl.SSLError)']) mylog('none', [' ERROR: Could not establish SSL connection (ssl.SSLError)'])
mylog('none', [' ERROR: Are you sure you need SMTP_FORCE_SSL enabled? Check your SMTP provider docs.']) mylog('none', [' ERROR: Are you sure you need SMTP_FORCE_SSL enabled? Check your SMTP provider docs.'])
mylog('none', [' ERROR: ', str(e)]) mylog('none', [' ERROR: ', str(e)])
# ---------------------------------------------------------------------------------- # ----------------------------------------------------------------------------------
def send_email(msg,smtp_timeout): def send_email(msg, smtp_timeout):
# Send mail # Send mail
if get_setting_value('SMTP_FORCE_SSL'): if get_setting_value('SMTP_FORCE_SSL'):
mylog('debug', ['SMTP_FORCE_SSL == True so using .SMTP_SSL()']) mylog('debug', ['SMTP_FORCE_SSL == True so using .SMTP_SSL()'])
@@ -182,10 +189,10 @@ def send_email(msg,smtp_timeout):
mylog('debug', ['SMTP_FORCE_SSL == False so using .SMTP()']) mylog('debug', ['SMTP_FORCE_SSL == False so using .SMTP()'])
if get_setting_value("SMTP_PORT") == 0: if get_setting_value("SMTP_PORT") == 0:
mylog('debug', ['SMTP_PORT == 0 so sending .SMTP(SMTP_SERVER)']) mylog('debug', ['SMTP_PORT == 0 so sending .SMTP(SMTP_SERVER)'])
smtp_connection = smtplib.SMTP (get_setting_value('SMTP_SERVER')) smtp_connection = smtplib.SMTP(get_setting_value('SMTP_SERVER'))
else: else:
mylog('debug', ['SMTP_PORT == 0 so sending .SMTP(SMTP_SERVER, SMTP_PORT)']) mylog('debug', ['SMTP_PORT == 0 so sending .SMTP(SMTP_SERVER, SMTP_PORT)'])
smtp_connection = smtplib.SMTP (get_setting_value('SMTP_SERVER'), get_setting_value('SMTP_PORT')) smtp_connection = smtplib.SMTP(get_setting_value('SMTP_SERVER'), get_setting_value('SMTP_PORT'))
mylog('debug', ['Setting SMTP debug level']) mylog('debug', ['Setting SMTP debug level'])
@@ -193,7 +200,7 @@ def send_email(msg,smtp_timeout):
if get_setting_value('LOG_LEVEL') == 'debug': if get_setting_value('LOG_LEVEL') == 'debug':
smtp_connection.set_debuglevel(1) smtp_connection.set_debuglevel(1)
mylog('debug', [ 'Sending .ehlo()']) mylog('debug', ['Sending .ehlo()'])
smtp_connection.ehlo() smtp_connection.ehlo()
if not get_setting_value('SMTP_SKIP_TLS'): if not get_setting_value('SMTP_SKIP_TLS'):
@@ -203,12 +210,13 @@ def send_email(msg,smtp_timeout):
smtp_connection.ehlo() smtp_connection.ehlo()
if not get_setting_value('SMTP_SKIP_LOGIN'): if not get_setting_value('SMTP_SKIP_LOGIN'):
mylog('debug', ['SMTP_SKIP_LOGIN == False so sending .login()']) mylog('debug', ['SMTP_SKIP_LOGIN == False so sending .login()'])
smtp_connection.login (get_setting_value('SMTP_USER'), get_setting_value('SMTP_PASS')) smtp_connection.login(get_setting_value('SMTP_USER'), get_setting_value('SMTP_PASS'))
mylog('debug', ['Sending .sendmail()']) mylog('debug', ['Sending .sendmail()'])
smtp_connection.sendmail (get_setting_value("SMTP_REPORT_FROM"), get_setting_value("SMTP_REPORT_TO"), msg.as_string()) smtp_connection.sendmail(get_setting_value("SMTP_REPORT_FROM"), get_setting_value("SMTP_REPORT_TO"), msg.as_string())
smtp_connection.quit() smtp_connection.quit()
# ---------------------------------------------------------------------------------- # ----------------------------------------------------------------------------------
def sanitize_email_content(subject, from_email, to_email, message_html, message_text): def sanitize_email_content(subject, from_email, to_email, message_html, message_text):
# Validate and sanitize subject # Validate and sanitize subject
@@ -229,6 +237,7 @@ def sanitize_email_content(subject, from_email, to_email, message_html, message_
return subject, from_email, to_email, message_html, message_text return subject, from_email, to_email, message_html, message_text
# ---------------------------------------------------------------------------------- # ----------------------------------------------------------------------------------
if __name__ == '__main__': if __name__ == '__main__':
sys.exit(main()) sys.exit(main())

View File

@@ -377,7 +377,7 @@
"elementType": "input", "elementType": "input",
"elementOptions": [ "elementOptions": [
{ {
"onChange": "validateRegex(this)" "focusout": "validateRegex(this)"
}, },
{ {
"base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ=" "base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ="

View File

@@ -18,15 +18,14 @@ INSTALL_PATH = os.getenv('NETALERTX_APP', '/app')
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
# NetAlertX modules # NetAlertX modules
import conf import conf # noqa: E402 [flake8 lint suppression]
from const import confFileName, logPath from const import confFileName, logPath # noqa: E402 [flake8 lint suppression]
from utils.plugin_utils import getPluginObject from utils.plugin_utils import getPluginObject # noqa: E402 [flake8 lint suppression]
from plugin_helper import Plugin_Objects from plugin_helper import Plugin_Objects # noqa: E402 [flake8 lint suppression]
from logger import mylog, Logger from logger import mylog, Logger # noqa: E402 [flake8 lint suppression]
from helper import get_setting_value, bytes_to_string, \ from helper import get_setting_value, bytes_to_string, \
sanitize_string, normalize_string sanitize_string, normalize_string # noqa: E402 [flake8 lint suppression]
from utils.datetime_utils import timeNowDB from database import DB, get_device_stats # noqa: E402 [flake8 lint suppression]
from database import DB, get_device_stats
# Make sure the TIMEZONE for logging is correct # Make sure the TIMEZONE for logging is correct
@@ -234,7 +233,6 @@ class sensor_config:
Store the sensor configuration in the global plugin_objects, which tracks sensors based on a unique combination Store the sensor configuration in the global plugin_objects, which tracks sensors based on a unique combination
of attributes including deviceId, sensorName, hash, and MAC. of attributes including deviceId, sensorName, hash, and MAC.
""" """
global plugin_objects
# Add the sensor to the global plugin_objects # Add the sensor to the global plugin_objects
plugin_objects.add_object( plugin_objects.add_object(
@@ -287,11 +285,11 @@ def publish_mqtt(mqtt_client, topic, message):
# mylog('verbose', [f"[{pluginName}] mqtt_client.is_connected(): {mqtt_client.is_connected()} "]) # mylog('verbose', [f"[{pluginName}] mqtt_client.is_connected(): {mqtt_client.is_connected()} "])
result = mqtt_client.publish( result = mqtt_client.publish(
topic=topic, topic=topic,
payload=message, payload=message,
qos=qos, qos=qos,
retain=True, retain=True,
) )
status = result[0] status = result[0]
@@ -303,6 +301,7 @@ def publish_mqtt(mqtt_client, topic, message):
time.sleep(0.1) time.sleep(0.1)
return True return True
# ------------------------------------------------------------------------------ # ------------------------------------------------------------------------------
# Create a generic device for overal stats # Create a generic device for overal stats
def create_generic_device(mqtt_client, deviceId, deviceName): def create_generic_device(mqtt_client, deviceId, deviceName):
@@ -318,7 +317,6 @@ def create_generic_device(mqtt_client, deviceId, deviceName):
# ------------------------------------------------------------------------------ # ------------------------------------------------------------------------------
# Register sensor config on the broker # Register sensor config on the broker
def create_sensor(mqtt_client, deviceId, deviceName, sensorType, sensorName, icon, mac=""): def create_sensor(mqtt_client, deviceId, deviceName, sensorType, sensorName, icon, mac=""):
global mqtt_sensors
# check previous configs # check previous configs
sensorConfig = sensor_config(deviceId, deviceName, sensorType, sensorName, icon, mac) sensorConfig = sensor_config(deviceId, deviceName, sensorType, sensorName, icon, mac)
@@ -429,12 +427,11 @@ def mqtt_create_client():
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
def mqtt_start(db): def mqtt_start(db):
global mqtt_client, mqtt_connected_to_broker global mqtt_client
if not mqtt_connected_to_broker: if not mqtt_connected_to_broker:
mqtt_client = mqtt_create_client() mqtt_client = mqtt_create_client()
deviceName = get_setting_value('MQTT_DEVICE_NAME') deviceName = get_setting_value('MQTT_DEVICE_NAME')
deviceId = get_setting_value('MQTT_DEVICE_ID') deviceId = get_setting_value('MQTT_DEVICE_ID')
@@ -449,16 +446,18 @@ def mqtt_start(db):
row = get_device_stats(db) row = get_device_stats(db)
# Publish (wrap into {} and remove last ',' from above) # Publish (wrap into {} and remove last ',' from above)
publish_mqtt(mqtt_client, f"{topic_root}/sensor/{deviceId}/state", publish_mqtt(
{ mqtt_client,
"online": row[0], f"{topic_root}/sensor/{deviceId}/state",
"down": row[1], {
"all": row[2], "online": row[0],
"archived": row[3], "down": row[1],
"new": row[4], "all": row[2],
"unknown": row[5] "archived": row[3],
} "new": row[4],
) "unknown": row[5]
}
)
# Generate device-specific MQTT messages if enabled # Generate device-specific MQTT messages if enabled
if get_setting_value('MQTT_SEND_DEVICES'): if get_setting_value('MQTT_SEND_DEVICES'):
@@ -466,11 +465,11 @@ def mqtt_start(db):
# Specific devices processing # Specific devices processing
# Get all devices # Get all devices
devices = db.read(get_setting_value('MQTT_DEVICES_SQL').replace('{s-quote}',"'")) devices = db.read(get_setting_value('MQTT_DEVICES_SQL').replace('{s-quote}', "'"))
sec_delay = len(devices) * int(get_setting_value('MQTT_DELAY_SEC'))*5 sec_delay = len(devices) * int(get_setting_value('MQTT_DELAY_SEC')) * 5
mylog('verbose', [f"[{pluginName}] Estimated delay: ", (sec_delay), 's ', '(', round(sec_delay/60, 1), 'min)']) mylog('verbose', [f"[{pluginName}] Estimated delay: ", (sec_delay), 's ', '(', round(sec_delay / 60, 1), 'min)'])
for device in devices: for device in devices:
@@ -495,27 +494,29 @@ def mqtt_start(db):
# handle device_tracker # handle device_tracker
# IMPORTANT: shared payload - device_tracker attributes and individual sensors # IMPORTANT: shared payload - device_tracker attributes and individual sensors
devJson = { devJson = {
"last_ip": device["devLastIP"], "last_ip": device["devLastIP"],
"is_new": str(device["devIsNew"]), "is_new": str(device["devIsNew"]),
"alert_down": str(device["devAlertDown"]), "alert_down": str(device["devAlertDown"]),
"vendor": sanitize_string(device["devVendor"]), "vendor": sanitize_string(device["devVendor"]),
"mac_address": str(device["devMac"]), "mac_address": str(device["devMac"]),
"model": devDisplayName, "model": devDisplayName,
"last_connection": prepTimeStamp(str(device["devLastConnection"])), "last_connection": prepTimeStamp(str(device["devLastConnection"])),
"first_connection": prepTimeStamp(str(device["devFirstConnection"])), "first_connection": prepTimeStamp(str(device["devFirstConnection"])),
"sync_node": device["devSyncHubNode"], "sync_node": device["devSyncHubNode"],
"group": device["devGroup"], "group": device["devGroup"],
"location": device["devLocation"], "location": device["devLocation"],
"network_parent_mac": device["devParentMAC"], "network_parent_mac": device["devParentMAC"],
"network_parent_name": next((dev["devName"] for dev in devices if dev["devMAC"] == device["devParentMAC"]), "") "network_parent_name": next((dev["devName"] for dev in devices if dev["devMAC"] == device["devParentMAC"]), "")
} }
# bulk update device sensors in home assistant # bulk update device sensors in home assistant
publish_mqtt(mqtt_client, sensorConfig.state_topic, devJson) # REQUIRED, DON'T DELETE publish_mqtt(mqtt_client, sensorConfig.state_topic, devJson) # REQUIRED, DON'T DELETE
# create and update is_present sensor # create and update is_present sensor
sensorConfig = create_sensor(mqtt_client, deviceId, devDisplayName, 'binary_sensor', 'is_present', 'wifi', device["devMac"]) sensorConfig = create_sensor(mqtt_client, deviceId, devDisplayName, 'binary_sensor', 'is_present', 'wifi', device["devMac"])
publish_mqtt(mqtt_client, sensorConfig.state_topic, publish_mqtt(
mqtt_client,
sensorConfig.state_topic,
{ {
"is_present": to_binary_sensor(str(device["devPresentLastScan"])) "is_present": to_binary_sensor(str(device["devPresentLastScan"]))
} }
@@ -547,7 +548,7 @@ def to_binary_sensor(input):
elif isinstance(input, bool) and input: elif isinstance(input, bool) and input:
return "ON" return "ON"
elif isinstance(input, str) and input == "1": elif isinstance(input, str) and input == "1":
return "ON" return "ON"
elif isinstance(input, bytes) and bytes_to_string(input) == "1": elif isinstance(input, bytes) and bytes_to_string(input) == "1":
return "ON" return "ON"
return "OFF" return "OFF"

View File

@@ -1,4 +1,3 @@
#!/usr/bin/env python #!/usr/bin/env python
import json import json
@@ -11,15 +10,15 @@ from base64 import b64encode
INSTALL_PATH = os.getenv('NETALERTX_APP', '/app') INSTALL_PATH = os.getenv('NETALERTX_APP', '/app')
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
import conf import conf # noqa: E402 [flake8 lint suppression]
from const import confFileName, logPath from const import confFileName, logPath # noqa: E402 [flake8 lint suppression]
from plugin_helper import Plugin_Objects, handleEmpty from plugin_helper import Plugin_Objects, handleEmpty # noqa: E402 [flake8 lint suppression]
from utils.datetime_utils import timeNowDB from utils.datetime_utils import timeNowDB # noqa: E402 [flake8 lint suppression]
from logger import mylog, Logger from logger import mylog, Logger # noqa: E402 [flake8 lint suppression]
from helper import get_setting_value from helper import get_setting_value # noqa: E402 [flake8 lint suppression]
from models.notification_instance import NotificationInstance from models.notification_instance import NotificationInstance # noqa: E402 [flake8 lint suppression]
from database import DB from database import DB # noqa: E402 [flake8 lint suppression]
from pytz import timezone from pytz import timezone # noqa: E402 [flake8 lint suppression]
# Make sure the TIMEZONE for logging is correct # Make sure the TIMEZONE for logging is correct
conf.tz = timezone(get_setting_value('TIMEZONE')) conf.tz = timezone(get_setting_value('TIMEZONE'))
@@ -33,13 +32,12 @@ LOG_PATH = logPath + '/plugins'
RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log') RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log')
def main(): def main():
mylog('verbose', [f'[{pluginName}](publisher) In script']) mylog('verbose', [f'[{pluginName}](publisher) In script'])
# Check if basic config settings supplied # Check if basic config settings supplied
if check_config() == False: if check_config() is False:
mylog('none', [f'[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.']) mylog('none', [f'[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.'])
return return
@@ -65,9 +63,9 @@ def main():
# Log result # Log result
plugin_objects.add_object( plugin_objects.add_object(
primaryId = pluginName, primaryId = pluginName,
secondaryId = timeNowDB(), secondaryId = timeNowDB(),
watched1 = notification["GUID"], watched1 = notification["GUID"],
watched2 = handleEmpty(response_text), watched2 = handleEmpty(response_text),
watched3 = response_status_code, watched3 = response_status_code,
watched4 = 'null', watched4 = 'null',
extra = 'null', extra = 'null',
@@ -77,15 +75,15 @@ def main():
plugin_objects.write_result_file() plugin_objects.write_result_file()
# -------------------------------------------------------------------------------
#-------------------------------------------------------------------------------
def check_config(): def check_config():
if get_setting_value('NTFY_HOST') == '' or get_setting_value('NTFY_TOPIC') == '': if get_setting_value('NTFY_HOST') == '' or get_setting_value('NTFY_TOPIC') == '':
return False return False
else: else:
return True return True
#-------------------------------------------------------------------------------
# -------------------------------------------------------------------------------
def send(html, text): def send(html, text):
response_text = '' response_text = ''
@@ -100,7 +98,7 @@ def send(html, text):
# prepare request headers # prepare request headers
headers = { headers = {
"Title": "NetAlertX Notification", "Title": "NetAlertX Notification",
"Actions": "view, Open Dashboard, "+ get_setting_value('REPORT_DASHBOARD_URL'), "Actions": "view, Open Dashboard, " + get_setting_value('REPORT_DASHBOARD_URL'),
"Priority": get_setting_value('NTFY_PRIORITY'), "Priority": get_setting_value('NTFY_PRIORITY'),
"Tags": "warning" "Tags": "warning"
} }
@@ -109,37 +107,39 @@ def send(html, text):
if token != '': if token != '':
headers["Authorization"] = "Bearer {}".format(token) headers["Authorization"] = "Bearer {}".format(token)
elif user != "" and pwd != "": elif user != "" and pwd != "":
# Generate hash for basic auth # Generate hash for basic auth
basichash = b64encode(bytes(user + ':' + pwd, "utf-8")).decode("ascii") basichash = b64encode(bytes(user + ':' + pwd, "utf-8")).decode("ascii")
# add authorization header with hash # add authorization header with hash
headers["Authorization"] = "Basic {}".format(basichash) headers["Authorization"] = "Basic {}".format(basichash)
# call NTFY service # call NTFY service
try: try:
response = requests.post("{}/{}".format( get_setting_value('NTFY_HOST'), response = requests.post("{}/{}".format(
get_setting_value('NTFY_TOPIC')), get_setting_value('NTFY_HOST'),
data = text, get_setting_value('NTFY_TOPIC')),
headers = headers, data = text,
verify = verify_ssl) headers = headers,
verify = verify_ssl,
timeout = get_setting_value('NTFY_RUN_TIMEOUT')
)
response_status_code = response.status_code response_status_code = response.status_code
# Check if the request was successful (status code 200) # Check if the request was successful (status code 200)
if response_status_code == 200: if response_status_code == 200:
response_text = response.text # This captures the response body/message response_text = response.text # This captures the response body/message
else: else:
response_text = json.dumps(response.text) response_text = json.dumps(response.text)
except requests.exceptions.RequestException as e: except requests.exceptions.RequestException as e:
mylog('none', [f'[{pluginName}] ⚠ ERROR: ', e]) mylog('none', [f'[{pluginName}] ⚠ ERROR: ', e])
response_text = e response_text = e
return response_text, response_status_code return response_text, response_status_code
return response_text, response_status_code return response_text, response_status_code
if __name__ == '__main__': if __name__ == '__main__':
sys.exit(main()) sys.exit(main())

View File

@@ -1,6 +1,6 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
import conf import conf
from const import confFileName, logPath from const import logPath
from pytz import timezone from pytz import timezone
import os import os
@@ -12,12 +12,12 @@ import requests
INSTALL_PATH = os.getenv("NETALERTX_APP", "/app") INSTALL_PATH = os.getenv("NETALERTX_APP", "/app")
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
from plugin_helper import Plugin_Objects, handleEmpty # noqa: E402 from plugin_helper import Plugin_Objects, handleEmpty # noqa: E402 [flake8 lint suppression]
from logger import mylog, Logger # noqa: E402 from logger import mylog, Logger # noqa: E402 [flake8 lint suppression]
from helper import get_setting_value, hide_string # noqa: E402 from helper import get_setting_value, hide_string # noqa: E402 [flake8 lint suppression]
from utils.datetime_utils import timeNowDB from utils.datetime_utils import timeNowDB # noqa: E402 [flake8 lint suppression]
from models.notification_instance import NotificationInstance # noqa: E402 from models.notification_instance import NotificationInstance # noqa: E402 [flake8 lint suppression]
from database import DB # noqa: E402 from database import DB # noqa: E402 [flake8 lint suppression]
# Make sure the TIMEZONE for logging is correct # Make sure the TIMEZONE for logging is correct
conf.tz = timezone(get_setting_value("TIMEZONE")) conf.tz = timezone(get_setting_value("TIMEZONE"))
@@ -36,11 +36,7 @@ def main():
# Check if basic config settings supplied # Check if basic config settings supplied
if not validate_config(): if not validate_config():
mylog( mylog("none", f"[{pluginName}] ⚠ ERROR: Publisher not set up correctly. Check your {pluginName}_* variables.",)
"none",
f"[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. "
f"Check your {confFileName} {pluginName}_* variables.",
)
return return
# Create a database connection # Create a database connection

View File

@@ -1,6 +1,4 @@
#!/usr/bin/env python #!/usr/bin/env python
import json import json
import os import os
import sys import sys
@@ -10,15 +8,15 @@ import requests
INSTALL_PATH = os.getenv('NETALERTX_APP', '/app') INSTALL_PATH = os.getenv('NETALERTX_APP', '/app')
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
import conf import conf # noqa: E402 [flake8 lint suppression]
from const import confFileName, logPath from const import confFileName, logPath # noqa: E402 [flake8 lint suppression]
from plugin_helper import Plugin_Objects, handleEmpty from plugin_helper import Plugin_Objects, handleEmpty # noqa: E402 [flake8 lint suppression]
from logger import mylog, Logger from logger import mylog, Logger # noqa: E402 [flake8 lint suppression]
from helper import get_setting_value, hide_string from helper import get_setting_value, hide_string # noqa: E402 [flake8 lint suppression]
from utils.datetime_utils import timeNowDB from utils.datetime_utils import timeNowDB # noqa: E402 [flake8 lint suppression]
from models.notification_instance import NotificationInstance from models.notification_instance import NotificationInstance # noqa: E402 [flake8 lint suppression]
from database import DB from database import DB # noqa: E402 [flake8 lint suppression]
from pytz import timezone from pytz import timezone # noqa: E402 [flake8 lint suppression]
# Make sure the TIMEZONE for logging is correct # Make sure the TIMEZONE for logging is correct
conf.tz = timezone(get_setting_value('TIMEZONE')) conf.tz = timezone(get_setting_value('TIMEZONE'))
@@ -32,13 +30,12 @@ LOG_PATH = logPath + '/plugins'
RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log') RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log')
def main(): def main():
mylog('verbose', [f'[{pluginName}](publisher) In script']) mylog('verbose', [f'[{pluginName}](publisher) In script'])
# Check if basic config settings supplied # Check if basic config settings supplied
if check_config() == False: if check_config() is False:
mylog('none', [f'[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.']) mylog('none', [f'[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.'])
return return
@@ -59,14 +56,14 @@ def main():
for notification in new_notifications: for notification in new_notifications:
# Send notification # Send notification
response_text, response_status_code = send(notification["Text"]) response_text, response_status_code = send(notification["Text"])
# Log result # Log result
plugin_objects.add_object( plugin_objects.add_object(
primaryId = pluginName, primaryId = pluginName,
secondaryId = timeNowDB(), secondaryId = timeNowDB(),
watched1 = notification["GUID"], watched1 = notification["GUID"],
watched2 = handleEmpty(response_text), watched2 = handleEmpty(response_text),
watched3 = response_status_code, watched3 = response_status_code,
watched4 = 'null', watched4 = 'null',
extra = 'null', extra = 'null',
@@ -76,8 +73,7 @@ def main():
plugin_objects.write_result_file() plugin_objects.write_result_file()
# -------------------------------------------------------------------------------
#-------------------------------------------------------------------------------
def send(text): def send(text):
response_text = '' response_text = ''
@@ -85,8 +81,7 @@ def send(text):
token = get_setting_value('PUSHSAFER_TOKEN') token = get_setting_value('PUSHSAFER_TOKEN')
mylog('verbose', [f'[{pluginName}] PUSHSAFER_TOKEN: "{hide_string(token)}"']) mylog('verbose', [f'[{pluginName}] PUSHSAFER_TOKEN: "{hide_string(token)}"'])
try: try:
url = 'https://www.pushsafer.com/api' url = 'https://www.pushsafer.com/api'
@@ -101,40 +96,34 @@ def send(text):
"u" : get_setting_value('REPORT_DASHBOARD_URL'), "u" : get_setting_value('REPORT_DASHBOARD_URL'),
"ut" : 'Open NetAlertX', "ut" : 'Open NetAlertX',
"k" : token, "k" : token,
} }
response = requests.post(url, data=post_fields) response = requests.post(url, data=post_fields, timeout=get_setting_value("PUSHSAFER_RUN_TIMEOUT"))
response_status_code = response.status_code response_status_code = response.status_code
# Check if the request was successful (status code 200) # Check if the request was successful (status code 200)
if response_status_code == 200: if response_status_code == 200:
response_text = response.text # This captures the response body/message response_text = response.text # This captures the response body/message
else: else:
response_text = json.dumps(response.text) response_text = json.dumps(response.text)
except requests.exceptions.RequestException as e: except requests.exceptions.RequestException as e:
mylog('none', [f'[{pluginName}] ⚠ ERROR: ', e]) mylog('none', [f'[{pluginName}] ⚠ ERROR: ', e])
response_text = e response_text = e
return response_text, response_status_code return response_text, response_status_code
return response_text, response_status_code return response_text, response_status_code
# -------------------------------------------------------------------------------
#-------------------------------------------------------------------------------
def check_config(): def check_config():
if get_setting_value('PUSHSAFER_TOKEN') == 'ApiKey': if get_setting_value('PUSHSAFER_TOKEN') == 'ApiKey':
return False return False
else: else:
return True return True
# ------------------------------------------------------- # -------------------------------------------------------
if __name__ == '__main__': if __name__ == '__main__':
sys.exit(main()) sys.exit(main())

View File

@@ -8,15 +8,15 @@ import sys
INSTALL_PATH = os.getenv('NETALERTX_APP', '/app') INSTALL_PATH = os.getenv('NETALERTX_APP', '/app')
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
import conf import conf # noqa: E402 [flake8 lint suppression]
from const import confFileName, logPath from const import confFileName, logPath # noqa: E402 [flake8 lint suppression]
from plugin_helper import Plugin_Objects from plugin_helper import Plugin_Objects # noqa: E402 [flake8 lint suppression]
from utils.datetime_utils import timeNowDB from utils.datetime_utils import timeNowDB # noqa: E402 [flake8 lint suppression]
from logger import mylog, Logger from logger import mylog, Logger # noqa: E402 [flake8 lint suppression]
from helper import get_setting_value from helper import get_setting_value # noqa: E402 [flake8 lint suppression]
from models.notification_instance import NotificationInstance from models.notification_instance import NotificationInstance # noqa: E402 [flake8 lint suppression]
from database import DB from database import DB # noqa: E402 [flake8 lint suppression]
from pytz import timezone from pytz import timezone # noqa: E402 [flake8 lint suppression]
# Make sure the TIMEZONE for logging is correct # Make sure the TIMEZONE for logging is correct
conf.tz = timezone(get_setting_value('TIMEZONE')) conf.tz = timezone(get_setting_value('TIMEZONE'))
@@ -30,13 +30,11 @@ LOG_PATH = logPath + '/plugins'
RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log') RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log')
def main(): def main():
mylog('verbose', [f'[{pluginName}](publisher) In script']) mylog('verbose', [f'[{pluginName}](publisher) In script'])
# Check if basic config settings supplied # Check if basic config settings supplied
if check_config() == False: if check_config() is False:
mylog('none', [ mylog('none', [
f'[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.']) f'[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.'])
return return

View File

@@ -1,4 +1,3 @@
#!/usr/bin/env python #!/usr/bin/env python
import json import json
@@ -13,15 +12,15 @@ INSTALL_PATH = os.getenv('NETALERTX_APP', '/app')
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
import conf import conf # noqa: E402 [flake8 lint suppression]
from const import logPath, confFileName from const import logPath, confFileName # noqa: E402 [flake8 lint suppression]
from plugin_helper import Plugin_Objects, handleEmpty from plugin_helper import Plugin_Objects, handleEmpty # noqa: E402 [flake8 lint suppression]
from utils.datetime_utils import timeNowDB from utils.datetime_utils import timeNowDB # noqa: E402 [flake8 lint suppression]
from logger import mylog, Logger from logger import mylog, Logger # noqa: E402 [flake8 lint suppression]
from helper import get_setting_value, write_file from helper import get_setting_value, write_file # noqa: E402 [flake8 lint suppression]
from models.notification_instance import NotificationInstance from models.notification_instance import NotificationInstance # noqa: E402 [flake8 lint suppression]
from database import DB from database import DB # noqa: E402 [flake8 lint suppression]
from pytz import timezone from pytz import timezone # noqa: E402 [flake8 lint suppression]
# Make sure the TIMEZONE for logging is correct # Make sure the TIMEZONE for logging is correct
conf.tz = timezone(get_setting_value('TIMEZONE')) conf.tz = timezone(get_setting_value('TIMEZONE'))
@@ -35,13 +34,12 @@ LOG_PATH = logPath + '/plugins'
RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log') RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log')
def main(): def main():
mylog('verbose', [f'[{pluginName}](publisher) In script']) mylog('verbose', [f'[{pluginName}](publisher) In script'])
# Check if basic config settings supplied # Check if basic config settings supplied
if check_config() == False: if check_config() is False:
mylog('none', [f'[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.']) mylog('none', [f'[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.'])
return return
@@ -62,15 +60,19 @@ def main():
for notification in new_notifications: for notification in new_notifications:
# Send notification # Send notification
response_stdout, response_stderr = send(notification["Text"], notification["HTML"], notification["JSON"]) response_stdout, response_stderr = send(
notification["Text"],
notification["HTML"],
notification["JSON"]
)
# Log result # Log result
plugin_objects.add_object( plugin_objects.add_object(
primaryId = pluginName, primaryId = pluginName,
secondaryId = timeNowDB(), secondaryId = timeNowDB(),
watched1 = notification["GUID"], watched1 = notification["GUID"],
watched2 = handleEmpty(response_stdout), watched2 = handleEmpty(response_stdout),
watched3 = handleEmpty(response_stderr), watched3 = handleEmpty(response_stderr),
watched4 = 'null', watched4 = 'null',
extra = 'null', extra = 'null',
foreignKey = notification["GUID"] foreignKey = notification["GUID"]
@@ -79,16 +81,16 @@ def main():
plugin_objects.write_result_file() plugin_objects.write_result_file()
#------------------------------------------------------------------------------- # -------------------------------------------------------------------------------
def check_config(): def check_config():
if get_setting_value('WEBHOOK_URL') == '': if get_setting_value('WEBHOOK_URL') == '':
return False return False
else: else:
return True return True
#-------------------------------------------------------------------------------
def send (text_data, html_data, json_data):
# -------------------------------------------------------------------------------
def send(text_data, html_data, json_data):
response_stderr = '' response_stderr = ''
response_stdout = '' response_stdout = ''
@@ -102,9 +104,9 @@ def send (text_data, html_data, json_data):
# use data type based on specified payload type # use data type based on specified payload type
if payloadType == 'json': if payloadType == 'json':
# In this code, the truncate_json function is used to recursively traverse the JSON object # In this code, the truncate_json function is used to recursively traverse the JSON object
# and remove nodes that exceed the size limit. It checks the size of each node's JSON representation # and remove nodes that exceed the size limit. It checks the size of each node's JSON representation
# using json.dumps and includes only the nodes that are within the limit. # using json.dumps and includes only the nodes that are within the limit.
json_str = json.dumps(json_data) json_str = json.dumps(json_data)
if len(json_str) <= limit: if len(json_str) <= limit:
@@ -127,45 +129,48 @@ def send (text_data, html_data, json_data):
return obj return obj
payloadData = truncate_json(json_data) payloadData = truncate_json(json_data)
if payloadType == 'html': if payloadType == 'html':
if len(html_data) > limit: if len(html_data) > limit:
payloadData = html_data[:limit] + " <h1>(text was truncated)</h1>" payloadData = html_data[:limit] + " <h1>(text was truncated)</h1>"
else: else:
payloadData = html_data payloadData = html_data
if payloadType == 'text': if payloadType == 'text':
if len(text_data) > limit: if len(text_data) > limit:
payloadData = text_data[:limit] + " (text was truncated)" payloadData = text_data[:limit] + " (text was truncated)"
else: else:
payloadData = text_data payloadData = text_data
# Define slack-compatible payload # Define slack-compatible payload
_json_payload = { "text": payloadData } if payloadType == 'text' else { if payloadType == 'text':
"username": "NetAlertX", _json_payload = {"text": payloadData}
"text": "There are new notifications", else:
"attachments": [{ _json_payload = {
"title": "NetAlertX Notifications", "username": "NetAlertX",
"title_link": get_setting_value('REPORT_DASHBOARD_URL'), "text": "There are new notifications",
"text": payloadData "attachments": [{
}] "title": "NetAlertX Notifications",
} "title_link": get_setting_value('REPORT_DASHBOARD_URL'),
"text": payloadData
}]
}
# DEBUG - Write the json payload into a log file for debugging # DEBUG - Write the json payload into a log file for debugging
write_file (logPath + '/webhook_payload.json', json.dumps(_json_payload)) write_file(logPath + '/webhook_payload.json', json.dumps(_json_payload))
# Using the Slack-Compatible Webhook endpoint for Discord so that the same payload can be used for both # Using the Slack-Compatible Webhook endpoint for Discord so that the same payload can be used for both
# Consider: curl has the ability to load in data to POST from a file + piping # Consider: curl has the ability to load in data to POST from a file + piping
if(endpointUrl.startswith('https://discord.com/api/webhooks/') and not endpointUrl.endswith("/slack")): if (endpointUrl.startswith('https://discord.com/api/webhooks/') and not endpointUrl.endswith("/slack")):
_WEBHOOK_URL = f"{endpointUrl}/slack" _WEBHOOK_URL = f"{endpointUrl}/slack"
curlParams = ["curl","-i","-H", "Content-Type:application/json" ,"-d", json.dumps(_json_payload), _WEBHOOK_URL] curlParams = ["curl", "-i", "-H", "Content-Type:application/json", "-d", json.dumps(_json_payload), _WEBHOOK_URL]
else: else:
_WEBHOOK_URL = endpointUrl _WEBHOOK_URL = endpointUrl
curlParams = ["curl","-i","-X", requestMethod , "-H", "Content-Type:application/json", "-d", json.dumps(_json_payload), _WEBHOOK_URL] curlParams = ["curl", "-i", "-X", requestMethod , "-H", "Content-Type:application/json", "-d", json.dumps(_json_payload), _WEBHOOK_URL]
# Add HMAC signature if configured # Add HMAC signature if configured
if(secret != ''): if (secret != ''):
h = hmac.new(secret.encode("UTF-8"), json.dumps(_json_payload, separators=(',', ':')).encode(), hashlib.sha256).hexdigest() h = hmac.new(secret.encode("UTF-8"), json.dumps(_json_payload, separators=(',', ':')).encode(), hashlib.sha256).hexdigest()
curlParams.insert(4,"-H") curlParams.insert(4, "-H")
curlParams.insert(5,f"X-Webhook-Signature: sha256={h}") curlParams.insert(5, f"X-Webhook-Signature: sha256={h}")
try: try:
# Execute CURL call # Execute CURL call
@@ -173,13 +178,11 @@ def send (text_data, html_data, json_data):
result = subprocess.run(curlParams, capture_output=True, text=True) result = subprocess.run(curlParams, capture_output=True, text=True)
response_stderr = result.stderr response_stderr = result.stderr
response_stdout = result.stdout response_stdout = result.stdout
# Write stdout and stderr into .log files for debugging if needed # Write stdout and stderr into .log files for debugging if needed
mylog('debug', [f'[{pluginName}] stdout: ', response_stdout]) mylog('debug', [f'[{pluginName}] stdout: ', response_stdout])
mylog('debug', [f'[{pluginName}] stderr: ', response_stderr]) mylog('debug', [f'[{pluginName}] stderr: ', response_stderr])
except subprocess.CalledProcessError as e: except subprocess.CalledProcessError as e:
# An error occurred, handle it # An error occurred, handle it
@@ -187,10 +190,9 @@ def send (text_data, html_data, json_data):
response_stderr = e.output response_stderr = e.output
return response_stdout, response_stderr
return response_stdout, response_stderr
# ------------------------------------------------------- # -------------------------------------------------------
if __name__ == '__main__': if __name__ == '__main__':
sys.exit(main()) sys.exit(main())

View File

@@ -225,7 +225,7 @@
"elementType": "input", "elementType": "input",
"elementOptions": [ "elementOptions": [
{ {
"onChange": "validateRegex(this)" "focusout": "validateRegex(this)"
}, },
{ {
"base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ=" "base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ="

View File

@@ -1,7 +1,6 @@
#!/usr/bin/env python #!/usr/bin/env python
import os import os
import time import time
import pathlib
import argparse import argparse
import sys import sys
import re import re
@@ -9,16 +8,16 @@ import base64
import subprocess import subprocess
# Register NetAlertX directories # Register NetAlertX directories
INSTALL_PATH="/app" INSTALL_PATH = os.getenv('NETALERTX_APP', '/app')
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
from database import DB from database import DB # noqa: E402 [flake8 lint suppression]
from plugin_helper import Plugin_Objects, handleEmpty from plugin_helper import Plugin_Objects, handleEmpty # noqa: E402 [flake8 lint suppression]
from logger import mylog, Logger, append_line_to_file from logger import mylog, Logger # noqa: E402 [flake8 lint suppression]
from helper import get_setting_value from helper import get_setting_value # noqa: E402 [flake8 lint suppression]
from const import logPath, applicationPath from const import logPath # noqa: E402 [flake8 lint suppression]
import conf import conf # noqa: E402 [flake8 lint suppression]
from pytz import timezone from pytz import timezone # noqa: E402 [flake8 lint suppression]
# Make sure the TIMEZONE for logging is correct # Make sure the TIMEZONE for logging is correct
conf.tz = timezone(get_setting_value("TIMEZONE")) conf.tz = timezone(get_setting_value("TIMEZONE"))
@@ -139,10 +138,7 @@ def execute_arpscan(userSubnets):
mylog("verbose", [f"[{pluginName}] All devices List len:", len(devices_list)]) mylog("verbose", [f"[{pluginName}] All devices List len:", len(devices_list)])
mylog("verbose", [f"[{pluginName}] Devices List:", devices_list]) mylog("verbose", [f"[{pluginName}] Devices List:", devices_list])
mylog( mylog("verbose", [f"[{pluginName}] Found: Devices without duplicates ", len(unique_devices)],)
"verbose",
[f"[{pluginName}] Found: Devices without duplicates ", len(unique_devices)],
)
return unique_devices return unique_devices
@@ -175,10 +171,7 @@ def execute_arpscan_on_interface(interface):
except subprocess.CalledProcessError: except subprocess.CalledProcessError:
result = "" result = ""
except subprocess.TimeoutExpired: except subprocess.TimeoutExpired:
mylog( mylog("warning", [f"[{pluginName}] arp-scan timed out after {timeout_seconds}s"],)
"warning",
[f"[{pluginName}] arp-scan timed out after {timeout_seconds}s"],
)
result = "" result = ""
# stop looping if duration not set or expired # stop looping if duration not set or expired
if scan_duration == 0 or (time.time() - start_time) > scan_duration: if scan_duration == 0 or (time.time() - start_time) > scan_duration:

View File

@@ -100,7 +100,7 @@
"elementType": "input", "elementType": "input",
"elementOptions": [ "elementOptions": [
{ {
"onChange": "validateRegex(this)" "focusout": "validateRegex(this)"
}, },
{ {
"base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ=" "base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ="

View File

@@ -6,17 +6,16 @@ INSTALL_PATH = os.getenv('NETALERTX_APP', '/app')
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"]) sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
pluginName = "ASUSWRT" pluginName = "ASUSWRT"
import asyncio import asyncio # noqa: E402 [flake8 lint suppression]
import aiohttp # noqa: E402 [flake8 lint suppression]
import aiohttp import conf # noqa: E402 [flake8 lint suppression]
import conf from asusrouter import AsusData, AsusRouter # noqa: E402 [flake8 lint suppression]
from asusrouter import AsusData, AsusRouter from asusrouter.modules.connection import ConnectionState # noqa: E402 [flake8 lint suppression]
from asusrouter.modules.connection import ConnectionState from const import logPath # noqa: E402 [flake8 lint suppression]
from const import logPath from helper import get_setting_value # noqa: E402 [flake8 lint suppression]
from helper import get_setting_value from logger import Logger, mylog # noqa: E402 [flake8 lint suppression]
from logger import Logger, mylog from plugin_helper import (Plugin_Objects, handleEmpty) # noqa: E402 [flake8 lint suppression]
from plugin_helper import (Plugin_Objects, handleEmpty) from pytz import timezone # noqa: E402 [flake8 lint suppression]
from pytz import timezone
conf.tz = timezone(get_setting_value("TIMEZONE")) conf.tz = timezone(get_setting_value("TIMEZONE"))
@@ -34,10 +33,7 @@ def main():
device_data = get_device_data() device_data = get_device_data()
mylog( mylog("verbose", f"[{pluginName}] Found '{len(device_data)}' devices")
"verbose",
[f"[{pluginName}] Found '{len(device_data)}' devices"],
)
filtered_devices = [ filtered_devices = [
(key, device) (key, device)
@@ -45,10 +41,7 @@ def main():
if device.state == ConnectionState.CONNECTED if device.state == ConnectionState.CONNECTED
] ]
mylog( mylog("verbose", f"[{pluginName}] Processing '{len(filtered_devices)}' connected devices")
"verbose",
[f"[{pluginName}] Processing '{len(filtered_devices)}' connected devices"],
)
for mac, device in filtered_devices: for mac, device in filtered_devices:
entry_mac = str(device.description.mac).lower() entry_mac = str(device.description.mac).lower()

Some files were not shown because too many files have changed in this diff Show More