Merge pull request #1534 from MrMeatikins/feat/docker-install-docs

Docs: Add Docker install instructions for MCP Agents
This commit is contained in:
Jokob @NetAlertX
2026-02-23 15:00:26 +11:00
committed by GitHub
4 changed files with 96 additions and 1 deletions

1
.env
View File

@@ -6,7 +6,6 @@ LOGS_LOCATION=/path/to/docker_logs
#ENVIRONMENT VARIABLES
TZ=Europe/Paris
PORT=20211
#DEVELOPMENT VARIABLES

8
install/docker/README.md Normal file
View File

@@ -0,0 +1,8 @@
# 🐳 Docker Compose Installation
For complete and up-to-date instructions on how to install NetAlertX using Docker, including volumes, networking, and environment variables, please refer to the official documentation:
👉 **[NetAlertX Docker Installation Guide](https://docs.netalertx.com/DOCKER_INSTALLATION/)**
---
[⬅️ Back to Main Repo](../../README.md)

View File

@@ -0,0 +1,44 @@
services:
netalertx:
network_mode: host # Use host networking for ARP scanning and other services
image: ghcr.io/netalertx/netalertx-dev:latest
container_name: netalertx
read_only: true
cap_drop:
- ALL
cap_add:
- NET_ADMIN
- NET_RAW
- NET_BIND_SERVICE
- CHOWN
- SETUID
- SETGID
volumes:
- type: volume
source: netalertx_data
target: /data
read_only: false
- type: bind
source: /etc/localtime
target: /etc/localtime
read_only: true
tmpfs:
- "/tmp:mode=1777,rw,noexec,nosuid,nodev,async,noatime,nodiratime"
environment:
PUID: ${NETALERTX_UID:-20211}
PGID: ${NETALERTX_GID:-20211}
LISTEN_ADDR: ${LISTEN_ADDR:-0.0.0.0}
PORT: ${PORT:-20211}
GRAPHQL_PORT: ${GRAPHQL_PORT:-20212}
mem_limit: 2048m
mem_reservation: 1024m
cpu_shares: 512
pids_limit: 512
logging:
options:
max-size: "10m"
max-file: "3"
restart: unless-stopped
volumes:
netalertx_data:

View File

@@ -0,0 +1,44 @@
services:
netalertx:
network_mode: host # Use host networking for ARP scanning and other services
image: ghcr.io/netalertx/netalertx:latest
container_name: netalertx
read_only: true
cap_drop:
- ALL
cap_add:
- NET_ADMIN
- NET_RAW
- NET_BIND_SERVICE
- CHOWN
- SETUID
- SETGID
volumes:
- type: volume
source: netalertx_data
target: /data
read_only: false
- type: bind
source: /etc/localtime
target: /etc/localtime
read_only: true
tmpfs:
- "/tmp:mode=1777,rw,noexec,nosuid,nodev,async,noatime,nodiratime"
environment:
PUID: ${NETALERTX_UID:-20211}
PGID: ${NETALERTX_GID:-20211}
LISTEN_ADDR: ${LISTEN_ADDR:-0.0.0.0}
PORT: ${PORT:-20211}
GRAPHQL_PORT: ${GRAPHQL_PORT:-20212}
mem_limit: 2048m
mem_reservation: 1024m
cpu_shares: 512
pids_limit: 512
logging:
options:
max-size: "10m"
max-file: "3"
restart: unless-stopped
volumes:
netalertx_data: