mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2025-12-07 09:36:05 -08:00
Resolve merge: keep proxmox installer and add README for Proxmox installer
This commit is contained in:
215
install/proxmox/README.md
Normal file
215
install/proxmox/README.md
Normal file
@@ -0,0 +1,215 @@
|
|||||||
|
# NetAlertX Proxmox Installer
|
||||||
|
|
||||||
|
A comprehensive installer script for deploying NetAlertX on Proxmox VE (Debian-based) systems. This installer automates the complete setup including dependencies, NGINX configuration, systemd service, and security hardening.
|
||||||
|
|
||||||
|
## 🚀 Quick Start
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
- Proxmox VE (Debian-based)
|
||||||
|
- Root access
|
||||||
|
- Internet connection
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Download and run the installer
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/JVKeller/NetAlertX/main/install/proxmox/proxmox-install-netalertx.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
### Non-Interactive Installation
|
||||||
|
```bash
|
||||||
|
# Skip all prompts and use defaults
|
||||||
|
NETALERTX_ASSUME_YES=1 curl -fsSL https://raw.githubusercontent.com/JVKeller/NetAlertX/main/install/proxmox/proxmox-install-netalertx.sh | bash
|
||||||
|
|
||||||
|
# Custom port
|
||||||
|
PORT=8080 NETALERTX_ASSUME_YES=1 curl -fsSL https://raw.githubusercontent.com/JVKeller/NetAlertX/main/install/proxmox/proxmox-install-netalertx.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📋 What This Installer Does
|
||||||
|
|
||||||
|
### System Dependencies
|
||||||
|
- **PHP 8.4** with FPM, SQLite3, cURL extensions
|
||||||
|
- **NGINX** with custom configuration
|
||||||
|
- **Python 3** with virtual environment
|
||||||
|
- **Network tools**: nmap, arp-scan, traceroute, mtr, speedtest-cli
|
||||||
|
- **Additional tools**: git, build-essential, avahi-daemon
|
||||||
|
|
||||||
|
### Security Features
|
||||||
|
- **Hardened permissions**: Proper user/group ownership
|
||||||
|
- **TMPFS mounts**: Log and API directories mounted as tmpfs for security
|
||||||
|
- **NGINX user**: Configured to run as www-data
|
||||||
|
- **Strict bash options**: Error handling and security
|
||||||
|
|
||||||
|
### Service Management
|
||||||
|
- **Systemd service**: Auto-start on boot with restart policies
|
||||||
|
- **Service monitoring**: Built-in health checks and logging
|
||||||
|
- **Dependency management**: Waits for network and NGINX
|
||||||
|
|
||||||
|
## 🔧 Configuration
|
||||||
|
|
||||||
|
### Port Configuration
|
||||||
|
The installer prompts for a custom port (default: 20211) with a 10-second countdown:
|
||||||
|
|
||||||
|
```
|
||||||
|
Enter HTTP port for NetAlertX [20211] (auto-continue in 10s):
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
| Variable | Description | Default |
|
||||||
|
|----------|-------------|---------|
|
||||||
|
| `NETALERTX_ASSUME_YES` | Skip all prompts | `false` |
|
||||||
|
| `NETALERTX_FORCE` | Force installation | `false` |
|
||||||
|
| `PORT` | Custom HTTP port | `20211` |
|
||||||
|
| `LISTEN_ADDR` | Bind address | `0.0.0.0` |
|
||||||
|
| `ALWAYS_FRESH_INSTALL` | Clear existing data | `false` |
|
||||||
|
|
||||||
|
### Service Management
|
||||||
|
```bash
|
||||||
|
# Check service status
|
||||||
|
systemctl status netalertx
|
||||||
|
|
||||||
|
# View logs
|
||||||
|
journalctl -u netalertx -f
|
||||||
|
|
||||||
|
# Restart service
|
||||||
|
systemctl restart netalertx
|
||||||
|
|
||||||
|
# Stop service
|
||||||
|
systemctl stop netalertx
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🌐 Access
|
||||||
|
|
||||||
|
After installation, access NetAlertX at:
|
||||||
|
```
|
||||||
|
http://[SERVER_IP]:[PORT]
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔒 Security Considerations
|
||||||
|
|
||||||
|
### TMPFS Mounts
|
||||||
|
- `/app/log` - Mounted as tmpfs (no persistent logs)
|
||||||
|
- `/app/api` - Mounted as tmpfs (temporary API data)
|
||||||
|
|
||||||
|
### File Permissions
|
||||||
|
- Application files: `www-data:www-data` with appropriate permissions
|
||||||
|
- NGINX runs as `www-data` user
|
||||||
|
- Log directories: Secure permissions with tmpfs
|
||||||
|
|
||||||
|
### Network Security
|
||||||
|
- NGINX configured for internal network access
|
||||||
|
- No external firewall rules added (configure manually if needed)
|
||||||
|
|
||||||
|
## 🛠️ Troubleshooting
|
||||||
|
|
||||||
|
### Common Issues
|
||||||
|
|
||||||
|
#### 403 Forbidden Error
|
||||||
|
```bash
|
||||||
|
# Check file permissions
|
||||||
|
ls -la /var/www/html/netalertx
|
||||||
|
ls -la /app/front
|
||||||
|
|
||||||
|
# Fix permissions
|
||||||
|
chown -R www-data:www-data /app/front
|
||||||
|
chmod -R 755 /app/front
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Service Won't Start
|
||||||
|
```bash
|
||||||
|
# Check service status
|
||||||
|
systemctl status netalertx
|
||||||
|
|
||||||
|
# View detailed logs
|
||||||
|
journalctl -u netalertx --no-pager -l
|
||||||
|
|
||||||
|
# Check if port is in use
|
||||||
|
ss -tlnp | grep :20211
|
||||||
|
```
|
||||||
|
|
||||||
|
#### GraphQL Connection Issues
|
||||||
|
```bash
|
||||||
|
# Check API token in config
|
||||||
|
grep API_TOKEN /app/config/app.conf
|
||||||
|
|
||||||
|
# Verify GraphQL port
|
||||||
|
grep GRAPHQL_PORT /app/config/app.conf
|
||||||
|
|
||||||
|
# Check backend logs
|
||||||
|
tail -f /app/log/app.log
|
||||||
|
```
|
||||||
|
|
||||||
|
### Log Locations
|
||||||
|
- **Service logs**: `journalctl -u netalertx`
|
||||||
|
- **Application logs**: `/app/log/` (tmpfs)
|
||||||
|
- **NGINX logs**: `/var/log/nginx/`
|
||||||
|
- **PHP logs**: `/app/log/app.php_errors.log`
|
||||||
|
|
||||||
|
### Manual Service Start
|
||||||
|
If systemd service fails:
|
||||||
|
```bash
|
||||||
|
# Activate Python environment
|
||||||
|
source /opt/myenv/bin/activate
|
||||||
|
|
||||||
|
# Start manually
|
||||||
|
cd /app
|
||||||
|
python server/
|
||||||
|
```
|
||||||
|
or
|
||||||
|
```
|
||||||
|
./start.netalertx.sh
|
||||||
|
```
|
||||||
|
## 🔄 Updates
|
||||||
|
|
||||||
|
### Updating NetAlertX
|
||||||
|
```bash
|
||||||
|
# Stop service
|
||||||
|
systemctl stop netalertx
|
||||||
|
|
||||||
|
# Update from repository
|
||||||
|
cd /app
|
||||||
|
git pull origin main
|
||||||
|
|
||||||
|
# Restart service
|
||||||
|
systemctl start netalertx
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## 📁 File Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
/app/ # Main application directory
|
||||||
|
├── front/ # Web interface (symlinked to /var/www/html/netalertx)
|
||||||
|
├── server/ # Python backend
|
||||||
|
├── config/ # Configuration files
|
||||||
|
├── db/ # Database files
|
||||||
|
├── log/ # Log files (tmpfs)
|
||||||
|
├── api/ # API files (tmpfs)
|
||||||
|
└── start.netalertx.sh # Service startup script
|
||||||
|
|
||||||
|
/etc/systemd/system/
|
||||||
|
└── netalertx.service # Systemd service definition
|
||||||
|
|
||||||
|
/etc/nginx/conf.d/
|
||||||
|
└── netalertx.conf # NGINX configuration
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🤝 Contributing
|
||||||
|
This installer will need a maintainer
|
||||||
|
|
||||||
|
1. Fork the repository
|
||||||
|
2. Create a feature branch
|
||||||
|
3. Make your changes
|
||||||
|
4. Test thoroughly
|
||||||
|
5. Submit a pull request
|
||||||
|
|
||||||
|
## 🙏 Acknowledgments
|
||||||
|
|
||||||
|
- NetAlertX development team
|
||||||
|
- Proxmox VE community
|
||||||
|
- Debian/Ubuntu maintainers
|
||||||
|
- Open source contributors
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Note**: This installer was designed for a Proxmox LXC Debian 13 container. For other systems, please use the appropriate installer or manual installation instructions.
|
||||||
505
install/proxmox/proxmox-install-netalertx.sh
Executable file
505
install/proxmox/proxmox-install-netalertx.sh
Executable file
@@ -0,0 +1,505 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
# Exit immediately if a command exits with a non-zero status.
|
||||||
|
set -e
|
||||||
|
# Treat unset variables as an error when substituting
|
||||||
|
set -u
|
||||||
|
# Consider failures in a pipeline
|
||||||
|
set -o pipefail
|
||||||
|
# Safe IFS
|
||||||
|
IFS=$' \t\n'
|
||||||
|
|
||||||
|
# 🛑 Important: This is only used for the bare-metal install 🛑
|
||||||
|
# Colors (guarded)
|
||||||
|
if [ -t 1 ] && [ -z "${NO_COLOR:-}" ]; then
|
||||||
|
RESET='\e[0m'
|
||||||
|
GREEN='\e[38;5;2m'
|
||||||
|
BOLD='\e[1m'
|
||||||
|
WHITE='\e[97m'
|
||||||
|
RED='\e[31m'
|
||||||
|
else
|
||||||
|
RESET=''; GREEN=''; BOLD=''; WHITE=''; RED=''
|
||||||
|
fi
|
||||||
|
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Running proxmox-install-netalertx.sh"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
# Set environment variables
|
||||||
|
INSTALL_DIR=/app # default installation directory
|
||||||
|
# DO NOT CHANGE ANYTHING BELOW THIS LINE!
|
||||||
|
INSTALLER_DIR="$INSTALL_DIR/install/proxmox"
|
||||||
|
CONF_FILE=app.conf
|
||||||
|
DB_FILE=app.db
|
||||||
|
NGINX_CONF_NAME=netalertx.conf
|
||||||
|
WEB_UI_DIR=/var/www/html/netalertx
|
||||||
|
NGINX_CONFIG_FILE="/etc/nginx/conf.d/${NGINX_CONF_NAME}"
|
||||||
|
OUI_FILE="/usr/share/arp-scan/ieee-oui.txt"
|
||||||
|
FILEDB=$INSTALL_DIR/db/$DB_FILE
|
||||||
|
# DO NOT CHANGE ANYTHING ABOVE THIS LINE!
|
||||||
|
|
||||||
|
# Check if script is run as root
|
||||||
|
if [[ $EUID -ne 0 ]]; then
|
||||||
|
echo "This script must be run as root."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Interactive confirmation: warn about overwriting/removing existing installation and NGINX config
|
||||||
|
if [ -z "${NETALERTX_ASSUME_YES:-}" ] && [ -z "${ASSUME_YES:-}" ] && [ -z "${NETALERTX_FORCE:-}" ]; then
|
||||||
|
printf "%b\n" "------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${RED}[WARNING] ${RESET}This script should be run on a fresh server"
|
||||||
|
printf "%b\n" "${RED}[WARNING] ${RESET}This script will install NetAlertX and will: "
|
||||||
|
printf "%b\n" "${RED}[WARNING] ${RESET}• Overwrite existing files under ${INSTALL_DIR} "
|
||||||
|
printf "%b\n" "${RED}[WARNING] ${RESET}• Wipe any existing database "
|
||||||
|
printf "%b\n" "${RED}[WARNING] ${RESET}• Wipe/Set up NGINX configuration under /etc/nginx"
|
||||||
|
printf "%b\n" "${RED}[WARNING] ${RESET}• Set up systemd services. "
|
||||||
|
read -r -p "Proceed with installation? [y/N]: " _reply
|
||||||
|
case "${_reply}" in
|
||||||
|
y|Y|yes|YES) ;;
|
||||||
|
*) echo "Aborting by user choice."; exit 1;;
|
||||||
|
esac
|
||||||
|
else
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Non-interactive mode detected; proceeding without confirmation."
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Prompt for HTTP port (default 20211) with countdown fallback
|
||||||
|
DEFAULT_PORT=20211
|
||||||
|
if [ -z "${NETALERTX_ASSUME_YES:-}" ] && [ -z "${ASSUME_YES:-}" ] && [ -z "${NETALERTX_FORCE:-}" ]; then
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
# Countdown-based prompt
|
||||||
|
_entered_port=""
|
||||||
|
for _sec in 10 9 8 7 6 5 4 3 2 1; do
|
||||||
|
printf "\rEnter HTTP port for NetAlertX [${DEFAULT_PORT}] (auto-continue in %2ds): " "${_sec}"
|
||||||
|
if read -t 1 -r _entered_port; then
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
printf "\n"
|
||||||
|
if [ -z "${_entered_port}" ]; then
|
||||||
|
PORT="${DEFAULT_PORT}"
|
||||||
|
elif printf '%s' "${_entered_port}" | grep -Eq '^[0-9]+$' && [ "${_entered_port}" -ge 1 ] && [ "${_entered_port}" -le 65535 ]; then
|
||||||
|
PORT="${_entered_port}"
|
||||||
|
else
|
||||||
|
printf "%b\n" "${RED}[WARNING] ${RESET}Invalid port. Falling back to ${DEFAULT_PORT}"
|
||||||
|
PORT="${DEFAULT_PORT}"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
PORT="${PORT-}"; PORT="${PORT:-${DEFAULT_PORT}}"
|
||||||
|
fi
|
||||||
|
export PORT
|
||||||
|
|
||||||
|
# Detect primary server IP for final prompt/use
|
||||||
|
SERVER_IP="$(ip -4 route get 1.1.1.1 2>/dev/null | awk '{for(i=1;i<=NF;i++) if ($i=="src") {print $(i+1); exit}}')"
|
||||||
|
if [ -z "${SERVER_IP}" ]; then
|
||||||
|
SERVER_IP="$(hostname -I 2>/dev/null | awk '{print $1}')"
|
||||||
|
fi
|
||||||
|
if [ -z "${SERVER_IP}" ]; then
|
||||||
|
SERVER_IP="127.0.0.1"
|
||||||
|
fi
|
||||||
|
export SERVER_IP
|
||||||
|
|
||||||
|
# Remove existing installation directory immediately (no prompt), with safety guard
|
||||||
|
if [ -d "$INSTALL_DIR" ]; then
|
||||||
|
printf "%b\n" "Removing existing directory: $INSTALL_DIR"
|
||||||
|
rm -rf "$INSTALL_DIR"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# 1. INSTALL SYSTEM DEPENDENCIES & ADD PHP REPOSITORY
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Installing system dependencies"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
export DEBIAN_FRONTEND=noninteractive
|
||||||
|
apt-get update -y
|
||||||
|
# software-properties-common is not available and not needed
|
||||||
|
apt-get install -y --no-install-recommends \
|
||||||
|
ca-certificates apt-transport-https lsb-release curl gnupg
|
||||||
|
|
||||||
|
# Detect OS
|
||||||
|
. /etc/os-release
|
||||||
|
OS_ID="${ID:-}"
|
||||||
|
OS_VER="${VERSION_ID:-}"
|
||||||
|
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Detected OS: ${OS_ID} ${OS_VER}"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
if [ "${OS_ID}" = "debian" ] && printf '%s' "${OS_VER}" | grep -q '^13'; then
|
||||||
|
# Debian 13 (trixie) ships PHP 8.4 in main repos; no extra repo needed
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Debian 13 detected - using built-in PHP 8.4"
|
||||||
|
apt-get install -y --no-install-recommends \
|
||||||
|
tini snmp ca-certificates curl libwww-perl arp-scan perl apt-utils cron sudo \
|
||||||
|
php8.4 php8.4-cgi php8.4-fpm php8.4-sqlite3 php8.4-curl sqlite3 dnsutils net-tools mtr \
|
||||||
|
python3 python3-dev iproute2 nmap python3-pip zip usbutils traceroute nbtscan \
|
||||||
|
avahi-daemon avahi-utils build-essential git gnupg2 lsb-release \
|
||||||
|
debian-archive-keyring python3-venv
|
||||||
|
elif [ "${OS_ID}" = "ubuntu" ] && printf '%s' "${OS_VER}" | grep -q '^24'; then
|
||||||
|
# Ubuntu 24.x typically ships PHP 8.3; add ondrej/php PPA and set 8.4
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Ubuntu 24 detected - enabling ondrej/php PPA for PHP 8.4"
|
||||||
|
apt-get install -y --no-install-recommends software-properties-common || true
|
||||||
|
if command -v add-apt-repository >/dev/null 2>&1; then
|
||||||
|
add-apt-repository -y ppa:ondrej/php || true
|
||||||
|
else
|
||||||
|
# Fallback: manually add ondrej/php PPA for the current codename
|
||||||
|
CODENAME=$(lsb_release -sc 2>/dev/null || echo noble)
|
||||||
|
curl -fsSL https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x4F4EA0AAE5267A6C | gpg --dearmor | tee /usr/share/keyrings/ondrej-php.gpg >/dev/null
|
||||||
|
echo "deb [signed-by=/usr/share/keyrings/ondrej-php.gpg] http://ppa.launchpad.net/ondrej/php/ubuntu ${CODENAME} main" > /etc/apt/sources.list.d/ondrej-php.list
|
||||||
|
fi
|
||||||
|
apt-get update -y
|
||||||
|
apt-get install -y --no-install-recommends \
|
||||||
|
tini snmp ca-certificates curl libwww-perl arp-scan perl apt-utils cron sudo \
|
||||||
|
php8.4 php8.4-cgi php8.4-fpm php8.4-sqlite3 php8.4-curl sqlite3 dnsutils net-tools mtr \
|
||||||
|
python3 python3-dev iproute2 nmap python3-pip zip usbutils traceroute nbtscan \
|
||||||
|
avahi-daemon avahi-utils build-essential git gnupg2 lsb-release \
|
||||||
|
python3-venv
|
||||||
|
# Set PHP 8.4 as the default alternatives where applicable
|
||||||
|
update-alternatives --set php /usr/bin/php8.4 || true
|
||||||
|
systemctl enable php8.4-fpm || true
|
||||||
|
systemctl restart php8.4-fpm || true
|
||||||
|
else
|
||||||
|
# Generic fallback: try installing PHP 8.4, may require external repo on older OSes
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Generic install path - attempting PHP 8.4 from current repos"
|
||||||
|
apt-get install -y --no-install-recommends \
|
||||||
|
tini snmp ca-certificates curl libwww-perl arp-scan perl apt-utils cron sudo \
|
||||||
|
php8.4 php8.4-cgi php8.4-fpm php8.4-sqlite3 php8.4-curl sqlite3 dnsutils net-tools mtr \
|
||||||
|
python3 python3-dev iproute2 nmap python3-pip zip usbutils traceroute nbtscan \
|
||||||
|
avahi-daemon avahi-utils build-essential git gnupg2 lsb-release \
|
||||||
|
python3-venv || true
|
||||||
|
fi
|
||||||
|
|
||||||
|
# 2. SET UP NGINX REPOSITORY AND INSTALL
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Setting up NGINX"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
curl -fsSL https://nginx.org/keys/nginx_signing.key | gpg --dearmor \
|
||||||
|
| tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
|
||||||
|
|
||||||
|
|
||||||
|
echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] http://nginx.org/packages/debian $(lsb_release -cs) nginx" \
|
||||||
|
| tee /etc/apt/sources.list.d/nginx.list
|
||||||
|
|
||||||
|
printf "Package: *\\nPin: origin nginx.org\\nPin: release o=nginx\\nPin-Priority: 900\\n" \
|
||||||
|
| tee /etc/apt/preferences.d/99nginx
|
||||||
|
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Setting up NGINX - Might take a minute!"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
apt-get update -y
|
||||||
|
apt-get install -y nginx
|
||||||
|
|
||||||
|
# Enable and start nginx
|
||||||
|
if command -v systemctl >/dev/null 2>&1; then
|
||||||
|
systemctl enable nginx || true
|
||||||
|
systemctl restart nginx || true
|
||||||
|
fi
|
||||||
|
|
||||||
|
# 3. SET UP PYTHON VIRTUAL ENVIRONMENT & DEPENDENCIES
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Setting up Python environment"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
python3 -m venv /opt/myenv
|
||||||
|
source /opt/myenv/bin/activate
|
||||||
|
|
||||||
|
update-alternatives --install /usr/bin/python python /usr/bin/python3 10
|
||||||
|
|
||||||
|
# Create requirements.txt on-the-fly
|
||||||
|
cat > /tmp/requirements.txt << EOF
|
||||||
|
openwrt-luci-rpc
|
||||||
|
asusrouter
|
||||||
|
asyncio
|
||||||
|
aiohttp
|
||||||
|
graphene
|
||||||
|
flask
|
||||||
|
flask-cors
|
||||||
|
unifi-sm-api
|
||||||
|
tplink-omada-client
|
||||||
|
wakeonlan
|
||||||
|
pycryptodome
|
||||||
|
requests
|
||||||
|
paho-mqtt
|
||||||
|
scapy
|
||||||
|
cron-converter
|
||||||
|
pytz
|
||||||
|
json2table
|
||||||
|
dhcp-leases
|
||||||
|
pyunifi
|
||||||
|
speedtest-cli
|
||||||
|
chardet
|
||||||
|
python-nmap
|
||||||
|
dnspython
|
||||||
|
librouteros
|
||||||
|
yattag
|
||||||
|
git+https://github.com/foreign-sub/aiofreepybox.git
|
||||||
|
EOF
|
||||||
|
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
python -m pip install -r /tmp/requirements.txt
|
||||||
|
rm /tmp/requirements.txt
|
||||||
|
|
||||||
|
# 4. CLONE OR UPDATE APPLICATION REPOSITORY
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Cloning application repository"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
mkdir -p "$INSTALL_DIR"
|
||||||
|
git clone https://github.com/JVKeller/NetAlertX.git "$INSTALL_DIR/" #change after testing
|
||||||
|
|
||||||
|
# 5. FINAL SETUP
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Starting NetAlertX"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
if [ ! -f "$INSTALL_DIR/front/buildtimestamp.txt" ]; then
|
||||||
|
date +%s > "$INSTALL_DIR/front/buildtimestamp.txt"
|
||||||
|
fi
|
||||||
|
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}NetAlertX Installation complete"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Installing NGINX and setting up the web server"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Stopping any NGINX web server"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
service nginx stop 2>/dev/null || true
|
||||||
|
pkill -f "python ${INSTALL_DIR}/server" 2>/dev/null || true
|
||||||
|
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Updating the existing installation..."
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
# Remove default NGINX site if it is symlinked, or backup it otherwise
|
||||||
|
if [ -L /etc/nginx/sites-enabled/default ] ; then
|
||||||
|
echo "Disabling default NGINX site, removing symlink in /etc/nginx/sites-enabled"
|
||||||
|
rm /etc/nginx/sites-enabled/default
|
||||||
|
elif [ -f /etc/nginx/sites-enabled/default ]; then
|
||||||
|
echo "Disabling default NGINX site, moving config to /etc/nginx/sites-available"
|
||||||
|
mv /etc/nginx/sites-enabled/default /etc/nginx/sites-available/default.bkp_netalertx
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Clear existing directories and files
|
||||||
|
if [ -d "$WEB_UI_DIR" ]; then
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Removing existing NetAlertX web-UI"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
rm -R "$WEB_UI_DIR"
|
||||||
|
fi
|
||||||
|
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Removing existing NetAlertX NGINX config"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
rm "$NGINX_CONFIG_FILE" 2>/dev/null || true
|
||||||
|
|
||||||
|
# Create web directory if it doesn't exist
|
||||||
|
mkdir -p /var/www/html
|
||||||
|
|
||||||
|
# create symbolic link to the installer directory
|
||||||
|
ln -sfn "${INSTALL_DIR}/front" "$WEB_UI_DIR"
|
||||||
|
# create symbolic link to NGINX configuration coming with NetAlertX
|
||||||
|
ln -sfn "${INSTALLER_DIR}/${NGINX_CONF_NAME}" "${NGINX_CONFIG_FILE}"
|
||||||
|
|
||||||
|
# Use selected port (may be default 20211)
|
||||||
|
if [ -n "${PORT-}" ]; then
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "Setting webserver to port ($PORT)"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
sed -i "s/listen 20211;/listen ${PORT};/g" "${NGINX_CONFIG_FILE}"
|
||||||
|
# Also update the template file so it reflects the chosen port
|
||||||
|
sed -i "s/listen 20211;/listen ${PORT};/g" "${INSTALLER_DIR}/${NGINX_CONF_NAME}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Change web interface address if set
|
||||||
|
if [ -n "${LISTEN_ADDR-}" ]; then
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "Setting webserver to user-supplied address (${LISTEN_ADDR})"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
sed -i "s/listen /listen ${LISTEN_ADDR}:/g" "${NGINX_CONFIG_FILE}"
|
||||||
|
sed -i "s/listen /listen ${LISTEN_ADDR}:/g" "${INSTALLER_DIR}/${NGINX_CONF_NAME}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Run the hardware vendors update at least once
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Run the hardware vendors update"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
# Check if ieee-oui.txt or ieee-iab.txt exist
|
||||||
|
if [ -f "$OUI_FILE" ]; then
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "The file ieee-oui.txt exists. Skipping update_vendors.sh..."
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
else
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "The file ieee-oui.txt does not exist. Running update_vendors..."
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
# Run the update_vendors.sh script
|
||||||
|
if [ -f "${INSTALL_DIR}/back/update_vendors.sh" ]; then
|
||||||
|
"${INSTALL_DIR}/back/update_vendors.sh"
|
||||||
|
else
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" " update_vendors.sh script not found in $INSTALL_DIR."
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Create empty log files
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Creating log and api mounts"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
printf "%b\n" "Cleaning up old mounts if any"
|
||||||
|
umount "${INSTALL_DIR}/log" 2>/dev/null || true
|
||||||
|
umount "${INSTALL_DIR}/api" 2>/dev/null || true
|
||||||
|
|
||||||
|
printf "%b\n" "Creating log and api folders if they don't exist"
|
||||||
|
mkdir -p "${INSTALL_DIR}/log" "${INSTALL_DIR}/api"
|
||||||
|
|
||||||
|
printf "%b\n" "Mounting log and api folders as tmpfs"
|
||||||
|
mount -t tmpfs -o noexec,nosuid,nodev tmpfs "${INSTALL_DIR}/log"
|
||||||
|
mount -t tmpfs -o noexec,nosuid,nodev tmpfs "${INSTALL_DIR}/api"
|
||||||
|
|
||||||
|
# Create the execution_queue.log file if it doesn't exist
|
||||||
|
touch "${INSTALL_DIR}"/log/{app.log,execution_queue.log,app_front.log,app.php_errors.log,stderr.log,stdout.log,db_is_locked.log}
|
||||||
|
touch "${INSTALL_DIR}"/api/user_notifications.json
|
||||||
|
# Create plugins sub-directory if it doesn't exist in case a custom log folder is used
|
||||||
|
mkdir -p "${INSTALL_DIR}"/log/plugins
|
||||||
|
|
||||||
|
# Fixing file permissions
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Fixing file permissions"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
chown root:www-data "${INSTALL_DIR}"/api/user_notifications.json
|
||||||
|
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Fixing WEB_UI_DIR: ${WEB_UI_DIR}"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
chmod -R a+rwx "$WEB_UI_DIR"
|
||||||
|
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Fixing INSTALL_DIR: ${INSTALL_DIR}"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
chmod -R a+rw "$INSTALL_DIR/log"
|
||||||
|
chmod -R a+rwx "$INSTALL_DIR"
|
||||||
|
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Copy starter $DB_FILE and $CONF_FILE if they don't exist"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
# DANGER ZONE: ALWAYS_FRESH_INSTALL
|
||||||
|
if [ "${ALWAYS_FRESH_INSTALL:-false}" = true ]; then
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}❗ ALERT /db and /config folders are cleared because the"
|
||||||
|
printf "%b\n" " ALWAYS_FRESH_INSTALL is set to: ${ALWAYS_FRESH_INSTALL}❗"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
# Delete content of "/config/"
|
||||||
|
rm -rf "${INSTALL_DIR}/config/"*
|
||||||
|
|
||||||
|
# Delete content of "/db/"
|
||||||
|
rm -rf "${INSTALL_DIR}/db/"*
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
# Copy starter $DB_FILE and $CONF_FILE if they don't exist
|
||||||
|
mkdir -p "${INSTALL_DIR}/config" "${INSTALL_DIR}/db"
|
||||||
|
cp -u "${INSTALL_DIR}/back/${CONF_FILE}" "${INSTALL_DIR}/config/${CONF_FILE}"
|
||||||
|
cp -u "${INSTALL_DIR}/back/${DB_FILE}" "${FILEDB}"
|
||||||
|
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Fixing permissions after copied starter config & DB"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
if [ -f "$FILEDB" ]; then
|
||||||
|
chown -R www-data:www-data "$FILEDB"
|
||||||
|
fi
|
||||||
|
# Change Nginx User
|
||||||
|
sed -i '2s/.*/user www-data;/' /etc/nginx/nginx.conf
|
||||||
|
|
||||||
|
# Change Nginx User
|
||||||
|
sed -i '2s/.*/user www-data;/' /etc/nginx/nginx.conf
|
||||||
|
|
||||||
|
chmod -R a+rwx "$INSTALL_DIR" # second time after we copied the files
|
||||||
|
chmod -R a+rw "$INSTALL_DIR/config"
|
||||||
|
chgrp -R www-data "$INSTALL_DIR"
|
||||||
|
|
||||||
|
# Check if buildtimestamp.txt doesn't exist
|
||||||
|
if [ ! -f "${INSTALL_DIR}/front/buildtimestamp.txt" ]; then
|
||||||
|
# Create buildtimestamp.txt
|
||||||
|
date +%s > "${INSTALL_DIR}/front/buildtimestamp.txt"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# start PHP
|
||||||
|
/etc/init.d/php8.4-fpm start
|
||||||
|
nginx -t || { printf "%b\n" "${RED}[INSTALLING] ${RESET}NGINX config test failed"; exit 1; }
|
||||||
|
/etc/init.d/nginx start
|
||||||
|
|
||||||
|
# Add nginx to www-data
|
||||||
|
usermod -aG www-data nginx || true
|
||||||
|
|
||||||
|
# Make a start script
|
||||||
|
cat > "$INSTALL_DIR/start.netalertx.sh" << 'EOF'
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
# Activate the virtual python environment
|
||||||
|
source /opt/myenv/bin/activate
|
||||||
|
|
||||||
|
echo -e "--------------------------------------------------------------------------"
|
||||||
|
echo -e "Starting NetAlertX - navigate to http://${SERVER_IP}:${PORT}"
|
||||||
|
echo -e "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
# Start the NetAlertX python script
|
||||||
|
python server/
|
||||||
|
EOF
|
||||||
|
|
||||||
|
chmod +x "$INSTALL_DIR/start.netalertx.sh"
|
||||||
|
|
||||||
|
# Install and manage systemd service if available, otherwise fallback to direct start
|
||||||
|
if command -v systemctl >/dev/null 2>&1; then
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Setting up systemd service"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
|
||||||
|
cat > /etc/systemd/system/netalertx.service << 'EOF'
|
||||||
|
[Unit]
|
||||||
|
Description=NetAlertX Service
|
||||||
|
After=network-online.target nginx.service
|
||||||
|
Wants=network-online.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
User=www-data
|
||||||
|
Group=www-data
|
||||||
|
ExecStart=/bin/bash -lc '/app/start.netalertx.sh'
|
||||||
|
WorkingDirectory=/app
|
||||||
|
Restart=on-failure
|
||||||
|
RestartSec=5
|
||||||
|
StandardOutput=journal
|
||||||
|
StandardError=journal
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
|
EOF
|
||||||
|
|
||||||
|
# Reload systemd and enable/start service
|
||||||
|
systemctl daemon-reload
|
||||||
|
systemctl enable netalertx.service
|
||||||
|
systemctl start netalertx.service
|
||||||
|
|
||||||
|
# Verify service is running
|
||||||
|
if systemctl is-active --quiet netalertx.service; then
|
||||||
|
printf "%b\n" "${GREEN}[SUCCESS] ${RESET}NetAlertX service started successfully"
|
||||||
|
else
|
||||||
|
printf "%b\n" "${RED}[WARNING] ${RESET}NetAlertX service may not have started properly"
|
||||||
|
systemctl status netalertx.service --no-pager -l
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
printf "%b\n" "${GREEN}[INSTALLING] ${RESET}Starting NetAlertX (no systemd)"
|
||||||
|
printf "%b\n" "--------------------------------------------------------------------------"
|
||||||
|
"$INSTALL_DIR/start.netalertx.sh" &
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo -e "--------------------------------------------------------------------------"
|
||||||
|
echo -e "${GREEN}[Service] 🚀 Starting app - navigate to http://${SERVER_IP}:${PORT}"
|
||||||
|
echo -e "--------------------------------------------------------------------------"
|
||||||
Reference in New Issue
Block a user