# chen017/ip-quality-archive architecture

> Architecture diagram of the GitHub repository chen017/ip-quality-archive, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/chen017/ip-quality-archive
- Repository: https://github.com/chen017/ip-quality-archive

## Overview

IPQA is a Linux VPS tool for scheduled IP-quality checks, independent IPv4/IPv6 archives, historical analysis, and change alerts. Its documented workflow is to invoke the CLI interactively or on a schedule, run checks using the IPQuality core, save snapshots, then review trends and risk summaries; notable changes are recorded in an alert log. README also documents optional Komari synchronization. No source excerpts were provided, so implementation responsibilities use the listed `ipqa.sh` path and relationships are limited to README statements.

Main entry points: [`ipqa.sh`](https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh) (IPQA CLI)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["IPQA Runtime"]
  node_cli["IPQA CLI<br/>[ipqa.sh]"]
  node_menu["Interactive Menu<br/>[ipqa.sh]"]
  node_check["Quality Check<br/>[ipqa.sh]"]
  node_maintenance["Update Controls<br/>[ipqa.sh]"]
end

subgraph group_archive["Archive and Analysis"]
  node_archive_store[("Dual-Stack Archives<br/>[ipqa.sh]")]
  node_history["History Trends<br/>[ipqa.sh]"]
  node_risk["Risk Summary<br/>[ipqa.sh]"]
  node_alerts[("Alert Log<br/>[ipqa.sh]")]
end

subgraph group_integration["External Integration"]
  node_engine["IPQuality Core"]
  node_komari_plugin["IPQA Alert Plugin"]
  node_komari_server["Komari Server"]
end

node_operator(("Operator"))
node_cron(("Cron Scheduler"))

node_operator -->|"invokes"| node_cli
node_cli -->|"opens"| node_menu
node_operator -->|"requests checks"| node_cli
node_cron -->|"runs scheduled"| node_cli
node_cli -->|"runs check"| node_check
node_check -->|"uses core"| node_engine
node_check -->|"saves snapshots"| node_archive_store
node_menu -->|"views history"| node_history
node_menu -->|"views summary"| node_risk
node_check -->|"records changes"| node_alerts
node_menu -->|"offers updates"| node_maintenance
node_komari_plugin -->|"syncs archives"| node_archive_store
node_komari_plugin -->|"summarizes alerts"| node_alerts
node_komari_plugin -->|"sends data"| node_komari_server

click node_cli "https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh"
click node_menu "https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh"
click node_check "https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh"
click node_archive_store "https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh"
click node_history "https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh"
click node_risk "https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh"
click node_alerts "https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh"
click node_maintenance "https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_menu,node_check,node_maintenance toneBlue
class node_archive_store,node_history,node_risk,node_alerts toneAmber
class node_engine,node_komari_plugin,node_komari_server toneMint
class node_operator toneIndigo
class node_cron toneRose
```

## Components

### IPQA Runtime

- [IPQA CLI](https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh): `ipqa.sh`
- [Interactive Menu](https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh): `ipqa.sh`
- [Quality Check](https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh): `ipqa.sh`
- [Update Controls](https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh): `ipqa.sh`

### Archive and Analysis

- [Dual-Stack Archives](https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh): `ipqa.sh`
- [History Trends](https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh): `ipqa.sh`
- [Risk Summary](https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh): `ipqa.sh`
- [Alert Log](https://github.com/chen017/ip-quality-archive/blob/main/ipqa.sh): `ipqa.sh`

### External Integration

- **IPQuality Core**
- **IPQA Alert Plugin**
- **Komari Server**

### Other components

- **Operator**
- **Cron Scheduler**

## Connections

- Operator → IPQA CLI: invokes (evidence: `README.md`)
- IPQA CLI → Interactive Menu: opens (evidence: `README.md`)
- Operator → IPQA CLI: requests checks (evidence: `README.md`)
- Cron Scheduler → IPQA CLI: runs scheduled (evidence: `README.md`)
- IPQA CLI → Quality Check: runs check (evidence: `README.md`)
- Quality Check → IPQuality Core: uses core (evidence: `README.md`)
- Quality Check → Dual-Stack Archives: saves snapshots (evidence: `README.md`)
- Interactive Menu → History Trends: views history (evidence: `README.md`)
- Interactive Menu → Risk Summary: views summary (evidence: `README.md`)
- Quality Check → Alert Log: records changes (evidence: `README.md`)
- Interactive Menu → Update Controls: offers updates (evidence: `README.md`)
- IPQA Alert Plugin → Dual-Stack Archives: syncs archives (evidence: `README.md`)
- IPQA Alert Plugin → Alert Log: summarizes alerts (evidence: `README.md`)
- IPQA Alert Plugin → Komari Server: sends data (evidence: `README.md`)
