# vbkunin/itop-docker architecture

> Architecture diagram of the GitHub repository vbkunin/itop-docker, 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/vbkunin/itop-docker
- Repository: https://github.com/vbkunin/itop-docker

## Overview

This repository packages Combodo iTop as Docker images: the base image provides Apache and PHP, while the full image adds MySQL. The principal workflow is a user opening the published container’s web endpoint and continuing iTop’s installation; configuration and database volumes can preserve state across recreations. The README also documents an external-database deployment, cron helpers, development scripts, and log forwarding. No source excerpts were provided, so relationships below rely on README statements; paths identify relevant tree locations, not inspected implementations.

Main entry points: [`full/service/mysql`](https://github.com/vbkunin/itop-docker/tree/master/full/service/mysql) (MySQL server), [`base/service/apache2`](https://github.com/vbkunin/itop-docker/tree/master/base/service/apache2) (Apache and PHP), [`base/artifacts/scripts/setup-itop-cron.sh`](https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/setup-itop-cron.sh) (Cron setup), [`base`](https://github.com/vbkunin/itop-docker/tree/master/base) (iTop image)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Container runtime"]
  node_container["iTop image"]
  node_web["Apache and PHP"]
  node_itop["iTop application"]
  node_mysql[("MySQL server")]
end

subgraph group_state["Persistent state"]
  node_conf["iTop configuration"]
  node_extensions["iTop extensions"]
  node_dbdata[("MySQL data")]
end

subgraph group_operations["Operations and helpers"]
  node_toolkit["Toolkit installer<br/>[install-toolkit.sh]"]
  node_cron["Cron setup<br/>[setup-itop-cron.sh]"]
  node_crondebug["Cron debugging"]
  node_xdebug["Xdebug installer<br/>[install-xdebug.sh]"]
  node_mysqladmin["MySQL admin setup"]
  node_remote["Remote MySQL setup"]
end

subgraph group_observability["Logging"]
  node_logs["Log forwarder<br/>[log-forwarder.sh]"]
  node_cronlog["Cron logging<br/>[setup-itop-cron.sh]"]
end

node_user(("iTop user"))
node_externaldb[("External MariaDB")]

node_user -->|"opens web UI"| node_web
node_web -->|"serves application"| node_itop
node_container -->|"includes in full image"| node_mysql
node_itop -->|"uses database"| node_mysql
node_itop -.->|"uses external database"| node_externaldb
node_itop -->|"persists configuration"| node_conf
node_itop -->|"loads extensions"| node_extensions
node_mysql -->|"persists database"| node_dbdata
node_user -->|"runs helper"| node_toolkit
node_user -->|"runs helper"| node_cron
node_user -->|"runs helper"| node_crondebug
node_user -->|"runs helper"| node_xdebug
node_user -->|"runs helper"| node_mysqladmin
node_user -->|"runs helper"| node_remote
node_itop -->|"forwards logs"| node_logs
node_cron -->|"configures log"| node_cronlog

click node_container "https://github.com/vbkunin/itop-docker/tree/master/base"
click node_web "https://github.com/vbkunin/itop-docker/tree/master/base/service/apache2"
click node_mysql "https://github.com/vbkunin/itop-docker/tree/master/full/service/mysql"
click node_conf "https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/make-itop-config-writable.sh"
click node_extensions "https://github.com/vbkunin/itop-docker/tree/master/base"
click node_dbdata "https://github.com/vbkunin/itop-docker/tree/master/full/service/mysql"
click node_toolkit "https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/install-toolkit.sh"
click node_cron "https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/setup-itop-cron.sh"
click node_crondebug "https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/start-itop-cron-debug.sh"
click node_xdebug "https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/install-xdebug.sh"
click node_mysqladmin "https://github.com/vbkunin/itop-docker/blob/master/full/artifacts/scripts/create-mysql-admin-user.sh"
click node_remote "https://github.com/vbkunin/itop-docker/blob/master/full/artifacts/scripts/enable-mysql-remote-connections.sh"
click node_logs "https://github.com/vbkunin/itop-docker/blob/master/base/service/log-forwarder/log-forwarder.sh"
click node_cronlog "https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/setup-itop-cron.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_container,node_web,node_itop,node_mysql,node_user toneBlue
class node_conf,node_extensions,node_dbdata,node_externaldb toneAmber
class node_toolkit,node_cron,node_crondebug,node_xdebug,node_mysqladmin,node_remote toneMint
class node_logs,node_cronlog toneRose
```

## Components

### Container runtime

- [iTop image](https://github.com/vbkunin/itop-docker/tree/master/base): `base`
- [Apache and PHP](https://github.com/vbkunin/itop-docker/tree/master/base/service/apache2): `base/service/apache2`
- **iTop application**
- [MySQL server](https://github.com/vbkunin/itop-docker/tree/master/full/service/mysql): `full/service/mysql`

### Persistent state

- [iTop configuration](https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/make-itop-config-writable.sh): `base/artifacts/scripts/make-itop-config-writable.sh`
- [iTop extensions](https://github.com/vbkunin/itop-docker/tree/master/base): `base`
- [MySQL data](https://github.com/vbkunin/itop-docker/tree/master/full/service/mysql): `full/service/mysql`

### Operations and helpers

- [Toolkit installer](https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/install-toolkit.sh): `base/artifacts/scripts/install-toolkit.sh`
- [Cron setup](https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/setup-itop-cron.sh): `base/artifacts/scripts/setup-itop-cron.sh`
- [Cron debugging](https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/start-itop-cron-debug.sh): `base/artifacts/scripts/start-itop-cron-debug.sh`
- [Xdebug installer](https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/install-xdebug.sh): `base/artifacts/scripts/install-xdebug.sh`
- [MySQL admin setup](https://github.com/vbkunin/itop-docker/blob/master/full/artifacts/scripts/create-mysql-admin-user.sh): `full/artifacts/scripts/create-mysql-admin-user.sh`
- [Remote MySQL setup](https://github.com/vbkunin/itop-docker/blob/master/full/artifacts/scripts/enable-mysql-remote-connections.sh): `full/artifacts/scripts/enable-mysql-remote-connections.sh`

### Logging

- [Log forwarder](https://github.com/vbkunin/itop-docker/blob/master/base/service/log-forwarder/log-forwarder.sh): `base/service/log-forwarder/log-forwarder.sh`
- [Cron logging](https://github.com/vbkunin/itop-docker/blob/master/base/artifacts/scripts/setup-itop-cron.sh): `base/artifacts/scripts/setup-itop-cron.sh`

### Other components

- **iTop user**
- **External MariaDB**

## Connections

- iTop user → Apache and PHP: opens web UI (evidence: `README.md`)
- Apache and PHP → iTop application: serves application (evidence: `README.md`)
- iTop image → MySQL server: includes in full image (evidence: `README.md`)
- iTop application → MySQL server: uses database (evidence: `README.md`)
- iTop application → External MariaDB: uses external database (evidence: `README.md`)
- iTop application → iTop configuration: persists configuration (evidence: `README.md`)
- iTop application → iTop extensions: loads extensions (evidence: `README.md`)
- MySQL server → MySQL data: persists database (evidence: `README.md`)
- iTop user → Toolkit installer: runs helper (evidence: `README.md`)
- iTop user → Cron setup: runs helper (evidence: `README.md`)
- iTop user → Cron debugging: runs helper (evidence: `README.md`)
- iTop user → Xdebug installer: runs helper (evidence: `README.md`)
- iTop user → MySQL admin setup: runs helper (evidence: `README.md`)
- iTop user → Remote MySQL setup: runs helper (evidence: `README.md`)
- iTop application → Log forwarder: forwards logs (evidence: `README.md`)
- Cron setup → Cron logging: configures log (evidence: `README.md`)
