82 lines
2.5 KiB
Markdown
82 lines
2.5 KiB
Markdown
# PXmon
|
|
|
|
> Current release: v0.2.0.
|
|
> The original GitHub repository is archived; active public source now lives on Gitea.
|
|
|
|
PXmon (Phylex Monitor) is a terminal-first SSH cluster manager and monitoring tool with a built-in TUI, agent bootstrap flow, alerting, reporting, backups, and runbook/scheduler automation.
|
|
|
|
## Highlights
|
|
- Bubble Tea dashboard (`overview`, `clusters`, `network`, `settings`, `docs`, `usage`, `live`)
|
|
- Secure encrypted local cluster registry
|
|
- SSH and optional SSH-tunneled agent transport (`direct` / `ipfabric`)
|
|
- Remote command execution and embedded SSH workflows
|
|
- Agent bootstrap, status checks, version checks, and updates
|
|
- Alerts (CPU/RAM/SWAP/DISK/NET), VM alerts, and alert routing
|
|
- Drift detection, SLO reporting, capacity forecast, and traffic p95
|
|
- Backup targets/plans (SFTP/S3), runbooks, and scheduled tasks
|
|
- RepoTunneling for temporary package repository access through a controlled gateway
|
|
- Telegram bot controls
|
|
- Encrypted export/import bundles, including referenced key files
|
|
|
|
## Requirements
|
|
- Go `1.25+`
|
|
- Linux/macOS terminal (interactive features require TTY)
|
|
- SSH reachability to target nodes
|
|
|
|
## Quick start
|
|
```bash
|
|
git clone https://git.datacoria.com/endssh/pxmon.git
|
|
cd pxmon
|
|
|
|
go build -o bin/pxmon ./cmd/pxmon
|
|
go build -o bin/pxmon-agent ./cmd/pxmon-agent
|
|
|
|
./bin/pxmon
|
|
```
|
|
|
|
Or run by command:
|
|
```bash
|
|
./bin/pxmon cluster help
|
|
./bin/pxmon tui
|
|
```
|
|
|
|
## Core commands
|
|
- `pxmon cluster ...`
|
|
- `pxmon tui`
|
|
- `pxmon clusters`
|
|
- `pxmon network`
|
|
- `pxmon cluster exec ...`
|
|
- `pxmon cluster repo-tunnel ...`
|
|
- `pxmon bot telegram ...`
|
|
- `pxmon locker ...`
|
|
- `pxmon config export|import ...`
|
|
- `pxmon explain --find <text>`
|
|
|
|
## Documentation
|
|
- [Install Guide](docs/INSTALL.md)
|
|
- [Usage Guide](docs/USAGE.md)
|
|
- [Command Reference](docs/COMMANDS.md)
|
|
- [TUI Guide](docs/TUI.md)
|
|
- [Architecture](docs/ARCHITECTURE.md)
|
|
- [Feature Overview](docs/FEATURES.md)
|
|
- [RepoTunneling](docs/REPOTUNNELING.md)
|
|
- [Releases and Versioning](docs/RELEASES.md)
|
|
- [Publish Guide](docs/PUBLISH.md)
|
|
|
|
## Default config location
|
|
By default PXmon stores encrypted registry data in:
|
|
- Linux: `~/.config/pxmon/clusters.enc`
|
|
- macOS: `~/Library/Application Support/pxmon/clusters.enc`
|
|
|
|
You can override using:
|
|
- `PXMON_CONFIG`
|
|
- `PXMON_MASTER_KEY`
|
|
- `--config /path/to/clusters.enc`
|
|
|
|
## Open source metadata
|
|
- License: [MIT](LICENSE)
|
|
- Version: [`VERSION`](VERSION)
|
|
- Changelog: [CHANGELOG.md](CHANGELOG.md)
|
|
- Security: [SECURITY.md](SECURITY.md)
|
|
- Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
|