# itiligent/easy-openvas-installer architecture

> Architecture diagram of the GitHub repository itiligent/easy-openvas-installer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/itiligent/easy-openvas-installer
- Repository: https://github.com/itiligent/easy-openvas-installer

## Overview

##### Project type and purpose
- This is not a web or mobile app but a collection of automation scripts (bash + PowerShell) whose sole purpose is to install, upgrade, configure, and maintain a Greenbone OpenVAS (GVM) vulnerability scanner on a supported Linux host, as well as to prepare Windows targets for authenticated SMB‐based scans and enable email reporting via Office 365.

##### File structure
- Top level:
- README.md – project overview, prerequisites, usage.
- openvas-install.sh – full build & install of OpenVAS from GitHub sources.
- openvas-upgrade.sh – upgrade existing OpenVAS installation.
- update-certificates.sh – regenerate/apply TLS certificates for the web console.
- -email-reports-o365.sh – configure Postfix and templates for PDF scan reports via O365 SMTP.
- prepare-smb-cred-scan.ps1 – PowerShell script to prepare Windows hosts for credentialed SMB scans.
- No subdirectories: each script is a self-contained automation module.

##### README for additional insights
- Supported OS, required packages (curl, sudo), hardware, IPv6 requirement, no multiple NICs.
- Scripts fetch the latest GitHub releases for GVM components unless overridden.
- Cron is used to schedule CVE feed updates.
- Optional features: private DNS for HTTPS console, email reporting via O365, Windows authenticated scans.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Linux Host"
        direction TB
        README["README.md"]:::doc
        subgraph "Orchestration Scripts"
            direction TB
            Install["openvas-install.sh"]:::script
            Upgrade["openvas-upgrade.sh"]:::script
            CertScript["update-certificates.sh"]:::script
            EmailScript["add-email-reports-o365.sh"]:::script
            WindowsPrep["prepare-smb-cred-scan.ps1"]:::script
        end
        subgraph "Core Services"
            direction TB
            Build["Build & Compile Pipeline"]:::service
            subgraph "GVM Core Services"
                direction TB
                DB["Database (PostgreSQL/SQLite)"]:::db
                Manager["gvmd"]:::service
                Scanner["ospd-scanner / openvassd"]:::service
                GUI["GSA (Web GUI)"]:::service
            end
            Postfix["Postfix MTA"]:::service
        end
        Cron["Cron Scheduler"]:::scheduler
    end

    WindowsHost["Windows Hosts"]:::target

    subgraph "External Services"
        direction TB
        GitHub["GitHub Releases API"]:::external
        Office365["Office 365 SMTP Relay"]:::external
        DNS["DNS for Console"]:::external
    end

    %% Relationships
    README --> Install
    Install --> GitHub
    GitHub --> Build
    Build --> Manager
    Build --> Scanner
    Build --> DB
    Build --> GUI

    Install --> CertScript
    CertScript --> GUI
    GUI --> DNS

    Install --> EmailScript
    EmailScript --> Postfix
    Postfix --> Office365

    Cron --> Manager
    Cron --> DB

    Upgrade --> GitHub
    GitHub --> Build

    WindowsPrep <--> WindowsHost
    Manager --> WindowsHost
    Scanner --> WindowsHost

    %% Click Events
    click README "https://github.com/itiligent/easy-openvas-installer/blob/main/README.md"
    click Install "https://github.com/itiligent/easy-openvas-installer/blob/main/openvas-install.sh"
    click Upgrade "https://github.com/itiligent/easy-openvas-installer/blob/main/openvas-upgrade.sh"
    click CertScript "https://github.com/itiligent/easy-openvas-installer/blob/main/update-certificates.sh"
    click EmailScript "https://github.com/itiligent/easy-openvas-installer/blob/main/add-email-reports-o365.sh"
    click WindowsPrep "https://github.com/itiligent/easy-openvas-installer/blob/main/prepare-smb-cred-scan.ps1"

    %% Styles
    classDef script fill:#fff2cc,stroke:#e6b800;
    classDef service fill:#d9ead3,stroke:#6aa84f;
    classDef db fill:#c9daf8,stroke:#3d85c6,stroke-width:2px,shape:cylinder;
    classDef scheduler fill:#f4cccc,stroke:#cc0000;
    classDef target fill:#fce5cd,stroke:#e69138;
    classDef external fill:#cfe2f3,stroke:#3c78d8,stroke-dasharray: 5 5;
    classDef doc fill:#ead1dc,stroke:#a64d79;
```
