Remove interactive features for remote-only execution

- Remove interactive menu (requires stdin)
- Remove --connect option (requires stdin)
- Remove --save option (not practical for remote execution)
- Show help when run without arguments
- Update help to show curl usage example
- Update README for remote-only usage

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
2026-01-24 17:22:37 -05:00
parent 575c60b1fa
commit d9e546f75d
2 changed files with 24 additions and 79 deletions

View File

@@ -5,7 +5,6 @@ ProxDoc is a comprehensive diagnostic tool for Proxmox server health monitoring
## Features
- Complete system diagnostics and health checks
- **Interactive menu system** when run without arguments
- **DriveAtlas integration** for physical drive bay mapping
- **Ceph cluster health** monitoring (OSD tree, pool usage, disk usage)
- **Node Exporter status** check for Prometheus monitoring
@@ -23,7 +22,6 @@ ProxDoc is a comprehensive diagnostic tool for Proxmox server health monitoring
- Hardware information
- Service status monitoring
- VM and Container status
- Remote host diagnostics capability
## Requirements
@@ -41,11 +39,25 @@ Optional tools for enhanced diagnostics:
## Usage
Run remotely via curl:
```bash
./proxdoc.sh [OPTIONS]
curl -sL "http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh" | bash -s -- [OPTION]
```
### Examples
```bash
# Full system diagnostics
curl -sL "http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh" | bash -s -- --diags
# Quick health check
curl -sL "http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh" | bash -s -- --quick
# Check services
curl -sL "http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh" | bash -s -- --services
# Show drive bay mapping
curl -sL "http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh" | bash -s -- --drives
```
### Available Options
@@ -61,16 +73,6 @@ curl -sL "http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh"
- `--vm-list`: Check VM vitals
- `--ct-list`: Check container vitals
- `--backup`: Review backup health
- `--connect`: Connect to a remote Proxmox host
- `--save`: Save examination results to a log file
### Interactive Mode
Run without arguments to display an interactive menu:
```bash
./proxDoc.sh
```
## Output Information
@@ -90,19 +92,12 @@ The script provides detailed information about:
- 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
- This script must be run as root
- Designed for Proxmox environments
- Supports Proxmox version 6.0 and above
- No local installation required - runs directly from Gitea
## Version
@@ -111,7 +106,6 @@ Current Version: 1.1.0
### Changelog
#### v1.1.0
- Added interactive menu system when run without arguments
- Added DriveAtlas integration (`--drives`) for physical drive bay mapping
- Added Ceph cluster health monitoring (`--ceph`)
- Added Node Exporter status check (`--node-exporter`)
@@ -120,6 +114,7 @@ Current Version: 1.1.0
- Added container list option (`--ct-list`)
- Full diagnostics now include all monitoring checks
- Improved error handling with graceful fallbacks
- Optimized for remote execution via curl
#### v1.0.0
- Initial release