mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2025-12-06 17:15:38 -08:00
92 lines
4.5 KiB
YAML
Executable File
92 lines
4.5 KiB
YAML
Executable File
services:
|
|
netalertx:
|
|
network_mode: host # Use host networking for ARP scanning and other services
|
|
build:
|
|
context: . # Build context is the current directory
|
|
dockerfile: Dockerfile # Specify the Dockerfile to use
|
|
image: netalertx:latest
|
|
container_name: netalertx # The name when you docker contiainer ls
|
|
read_only: true # Make the container filesystem read-only
|
|
cap_drop: # Drop all capabilities for enhanced security
|
|
- ALL
|
|
cap_add: # Add only the necessary capabilities
|
|
- NET_ADMIN # Required for ARP scanning
|
|
- NET_RAW # Required for raw socket operations
|
|
- NET_BIND_SERVICE # Required to bind to privileged ports (nbtscan)
|
|
|
|
volumes:
|
|
- type: bind
|
|
source: ${APP_DATA_LOCATION}/netalertx/config
|
|
target: /app/config
|
|
read_only: false
|
|
|
|
- type: bind
|
|
source: ${APP_DATA_LOCATION}/netalertx/db
|
|
target: /app/db
|
|
read_only: false
|
|
|
|
- type: bind
|
|
source: /etc/localtime
|
|
target: /etc/localtime
|
|
read_only: true
|
|
|
|
# Retain logs - comment out tmpfs /app/log if you want to retain logs between container restarts
|
|
# - /path/on/host/log:/app/log
|
|
# Optional logs
|
|
# - type: bind
|
|
# source: ${LOGS_LOCATION}
|
|
# target: /app/log
|
|
# read_only: false
|
|
|
|
# Optional development mounts
|
|
- type: bind
|
|
source: ${DEV_LOCATION}
|
|
target: /app/front/plugins/custom
|
|
read_only: false
|
|
|
|
# Use a custom Enterprise-configured nginx config for ldap or other settings
|
|
# - /custom-enterprise.conf:/services/config/nginx/conf.active/netalertx.conf:ro
|
|
|
|
# Test your plugin on the production container
|
|
# - /path/on/host:/app/front/plugins/custom
|
|
|
|
# Tempfs mounts for writable directories in a read-only container and improve system performance
|
|
tmpfs:
|
|
# Speed up logging. This can be commented out to retain logs between container restarts
|
|
- "/app/log:uid=20211,gid=20211,mode=1700,rw,noexec,nosuid,nodev,async,noatime,nodiratime"
|
|
# Speed up API access as frontend/backend API is very chatty
|
|
- "/app/api:uid=20211,gid=20211,mode=1700,rw,noexec,nosuid,nodev,sync,noatime,nodiratime"
|
|
# Required for customization of the nginx listen addr/port without rebuilding the container
|
|
- "/services/config/nginx/conf.active:uid=20211,gid=20211,mode=1700,rw,noexec,nosuid,nodev,async,noatime,nodiratime"
|
|
# /services/config/nginx/conf.d is required for nginx and php to start
|
|
- "/services/run:uid=20211,gid=20211,mode=1700,rw,noexec,nosuid,nodev,async,noatime,nodiratime"
|
|
# /tmp is required by php for session save this should be reworked to /services/run/tmp
|
|
- "/tmp:uid=20211,gid=20211,mode=1700,rw,noexec,nosuid,nodev,async,noatime,nodiratime"
|
|
environment:
|
|
LISTEN_ADDR: 0.0.0.0 # Listen for connections on all interfaces
|
|
PORT: ${PORT} # Application port
|
|
ALWAYS_FRESH_INSTALL: ${ALWAYS_FRESH_INSTALL} # Set to true to reset your config and database on each container start
|
|
NETALERTX_DEBUG: 0 # 0=kill all services and restart if any dies. 1 keeps running dead services.
|
|
TZ: ${TZ} # Timezone, e.g. Europe/Paris
|
|
# APP_CONF_OVERRIDE={"SCAN_SUBNETS":"['192.168.1.0/24 --interface=eth1']","GRAPHQL_PORT":"20223","UI_theme":"Light"} # (optional) app.conf settings override
|
|
# LOADED_PLUGINS=["DHCPLSS","PIHOLE","ASUSWRT","FREEBOX"] # (optional) default plugins to load
|
|
|
|
# Resource limits to prevent resource exhaustion
|
|
mem_limit: 2048m # Maximum memory usage
|
|
mem_reservation: 1024m # Soft memory limit
|
|
cpu_shares: 512 # Relative CPU weight for CPU contention scenarios
|
|
pids_limit: 512 # Limit the number of processes/threads to prevent fork bombs
|
|
logging:
|
|
driver: "json-file" # Use JSON file logging driver
|
|
options:
|
|
max-size: "10m" # Rotate log files after they reach 10MB
|
|
max-file: "3" # Keep a maximum of 3 log files
|
|
|
|
# Always restart the container unless explicitly stopped
|
|
restart: unless-stopped
|
|
|
|
# volumes:
|
|
# netalertx_config:
|
|
# netalertx_db:
|
|
|