first commit

README.md

@@ -0,0 +1,75 @@
+# ProxDoc - The Proxmox System Doctor
+
+ProxDoc is a comprehensive diagnostic tool for Proxmox server health monitoring and system examination.
+
+## Features
+
+- Complete system diagnostics and health checks
+- Temperature monitoring
+- Disk health status
+- CPU and RAM information
+- Storage information including ZFS pools
+- Network diagnostics
+- Hardware information
+- Service status monitoring
+- VM and Container status
+- Remote host diagnostics capability
+
+## Requirements
+
+The script requires the following tools to be installed:
+- dmidecode
+- lscpu
+- ip
+- smartctl
+- sensors
+- netstat
+
+## Usage
+
+```bash
+./proxdoc.sh [OPTIONS]
+```
+
+### Available Options
+
+- `--help`: Show the help guide
+- `--diags`: Perform full system examination
+- `--connect`: Connect to a remote Proxmox host
+- `--services`: Check vital services
+- `--vm-list`: Check VM vitals
+- `--backup`: Review backup health
+- `--save`: Save examination results to a log file
+
+## Output Information
+
+The script provides detailed information about:
+- System information and Proxmox version
+- CPU model, cores, and frequency
+- RAM usage
+- Storage status
+- Disk health
+- Network configuration
+- Hardware details
+- System load
+- Service status
+- Recent system errors
+- VM and container status
+
+## Installation
+
+1. Download the script
+2. Make it executable:
+```bash
+chmod +x proxdoc.sh
+```
+
+## Note
+
+    This script must be run as root
+    Designed for Proxmox environments
+    Supports Proxmox version 6.0 and above
+
+## Version
+
+Current Version: 1.0.0