# nethesis/ns8-nethvoice architecture

> Architecture diagram of the GitHub repository nethesis/ns8-nethvoice, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nethesis/ns8-nethvoice
- Repository: https://github.com/nethesis/ns8-nethvoice

## Overview

NethVoice is an NS8-hosted telephony product whose cluster-admin UI configures the module and presents status, integration, hotel, settings, and rebranding pages. Its setup wizard provisions account/identity and proxy configuration before NethVoice configuration; the UI also issues module and cluster tasks. The tree shows complementary FreePBX, REST, hotel/FIAS, and phonebook runtimes. README-documented phonebook access and report-branding propagation are included; unsampled runtime wiring is not inferred beyond those statements.

Main entry points: [`ui/src/App.vue`](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/App.vue) (Admin application), [`ui/src/components/first-configuration/FirstConfigurationModal.vue`](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/components/first-configuration/FirstConfigurationModal.vue) (Setup wizard), [`ui/src/views/Rebranding.vue`](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/views/Rebranding.vue) (Rebranding settings), [`phonebook/phonebook.js`](https://github.com/nethesis/ns8-nethvoice/blob/main/phonebook/phonebook.js) (Phonebook service)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_admin_ui["Cluster Admin UI"]
  node_admin["Admin application<br/>[App.vue]"]
  node_router["Page routing<br/>[index.js]"]
  node_store["Shared state<br/>[index.js]"]
  node_status["Status dashboard<br/>[Status.vue]"]
  node_integrations_page["Integrations page<br/>[Integrations.vue]"]
  node_rebranding["Rebranding settings<br/>[Rebranding.vue]"]
  node_hotel_page["Hotel settings page<br/>[Hotel.vue]"]
  node_settings["Module settings<br/>[Settings.vue]"]
end

subgraph group_setup["Initial Setup"]
  node_setup_modal["Setup wizard"]
  node_account_step["Account provider step"]
  node_ldap_step["OpenLDAP step<br/>[OpenldapStep.vue]"]
  node_proxy_step["Proxy configuration<br/>[ProxyStep.vue]"]
  node_nethvoice_step["NethVoice configuration<br/>[NethvoiceStep.vue]"]
end

subgraph group_telephony["Telephony Runtime"]
  node_rest_api["FreePBX REST API"]
  node_wizard_ui["FreePBX wizard UI"]
end

subgraph group_hotel["Hotel Operations"]
  node_hotel_admin["Hotel administration"]
  node_fias["Hotel FIAS interface"]
end

subgraph group_integrations["Phonebook and Reports"]
  node_phonebook["Phonebook service<br/>[phonebook.js]"]
  node_phonebook_export["Phonebook exports"]
  node_report_config["Reports branding runtime"]
end

node_cluster_admin(("Cluster administrator"))
node_phonebook_consumer(("Phonebook consumer"))
node_reports_ui["Reports UI container"]

node_admin -->|"uses routes"| node_router
node_admin -->|"uses state"| node_store
node_admin -->|"shows wizard"| node_setup_modal
node_admin -->|"renders route"| node_status
node_admin -->|"renders route"| node_integrations_page
node_admin -->|"renders route"| node_rebranding
node_admin -->|"renders route"| node_hotel_page
node_admin -->|"renders route"| node_settings
node_setup_modal -->|"renders step"| node_account_step
node_setup_modal -->|"renders step"| node_ldap_step
node_setup_modal -->|"renders step"| node_proxy_step
node_setup_modal -->|"renders step"| node_nethvoice_step
node_cluster_admin -->|"configures module"| node_admin
node_cluster_admin -->|"sets branding"| node_rebranding
node_rebranding -->|"sets task variables"| node_report_config
node_report_config -->|"exposes configuration"| node_reports_ui
node_phonebook_consumer -->|"requests credentials"| node_phonebook
node_phonebook -->|"raises change event"| node_phonebook_consumer

click node_admin "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/App.vue"
click node_router "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/router/index.js"
click node_store "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/store/index.js"
click node_status "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/views/Status.vue"
click node_integrations_page "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/views/Integrations.vue"
click node_rebranding "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/views/Rebranding.vue"
click node_hotel_page "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/views/Hotel.vue"
click node_settings "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/views/Settings.vue"
click node_setup_modal "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/components/first-configuration/FirstConfigurationModal.vue"
click node_account_step "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/components/first-configuration/AccountProviderStep.vue"
click node_ldap_step "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/components/first-configuration/OpenldapStep.vue"
click node_proxy_step "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/components/first-configuration/ProxyStep.vue"
click node_nethvoice_step "https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/components/first-configuration/NethvoiceStep.vue"
click node_rest_api "https://github.com/nethesis/ns8-nethvoice/tree/main/freepbx/var/www/html/freepbx/rest/modules"
click node_wizard_ui "https://github.com/nethesis/ns8-nethvoice/tree/main/freepbx/wizard-ui/app/scripts/controllers"
click node_hotel_admin "https://github.com/nethesis/ns8-nethvoice/tree/main/freepbx/var/www/html/freepbx/admin/modules/nethhotel/htdocs"
click node_fias "https://github.com/nethesis/ns8-nethvoice/tree/main/freepbx/usr/share/neth-hotel-fias"
click node_phonebook "https://github.com/nethesis/ns8-nethvoice/blob/main/phonebook/phonebook.js"
click node_phonebook_export "https://github.com/nethesis/ns8-nethvoice/tree/main/freepbx/usr/share/phonebooks"
click node_report_config "https://github.com/nethesis/ns8-nethvoice/tree/main/reports"

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_admin,node_router,node_store,node_status,node_integrations_page,node_rebranding,node_hotel_page,node_settings,node_reports_ui toneBlue
class node_setup_modal,node_account_step,node_ldap_step,node_proxy_step,node_nethvoice_step toneAmber
class node_rest_api,node_wizard_ui toneMint
class node_hotel_admin,node_fias toneRose
class node_phonebook,node_phonebook_export,node_report_config,node_cluster_admin,node_phonebook_consumer toneIndigo
```

## Components

### Cluster Admin UI

- [Admin application](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/App.vue): `ui/src/App.vue`
- [Page routing](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/router/index.js): `ui/src/router/index.js`
- [Shared state](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/store/index.js): `ui/src/store/index.js`
- [Status dashboard](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/views/Status.vue): `ui/src/views/Status.vue`
- [Integrations page](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/views/Integrations.vue): `ui/src/views/Integrations.vue`
- [Rebranding settings](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/views/Rebranding.vue): `ui/src/views/Rebranding.vue`
- [Hotel settings page](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/views/Hotel.vue): `ui/src/views/Hotel.vue`
- [Module settings](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/views/Settings.vue): `ui/src/views/Settings.vue`

### Initial Setup

- [Setup wizard](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/components/first-configuration/FirstConfigurationModal.vue): `ui/src/components/first-configuration/FirstConfigurationModal.vue`
- [Account provider step](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/components/first-configuration/AccountProviderStep.vue): `ui/src/components/first-configuration/AccountProviderStep.vue`
- [OpenLDAP step](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/components/first-configuration/OpenldapStep.vue): `ui/src/components/first-configuration/OpenldapStep.vue`
- [Proxy configuration](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/components/first-configuration/ProxyStep.vue): `ui/src/components/first-configuration/ProxyStep.vue`
- [NethVoice configuration](https://github.com/nethesis/ns8-nethvoice/blob/main/ui/src/components/first-configuration/NethvoiceStep.vue): `ui/src/components/first-configuration/NethvoiceStep.vue`

### Telephony Runtime

- [FreePBX REST API](https://github.com/nethesis/ns8-nethvoice/tree/main/freepbx/var/www/html/freepbx/rest/modules): `freepbx/var/www/html/freepbx/rest/modules`
- [FreePBX wizard UI](https://github.com/nethesis/ns8-nethvoice/tree/main/freepbx/wizard-ui/app/scripts/controllers): `freepbx/wizard-ui/app/scripts/controllers`

### Hotel Operations

- [Hotel administration](https://github.com/nethesis/ns8-nethvoice/tree/main/freepbx/var/www/html/freepbx/admin/modules/nethhotel/htdocs): `freepbx/var/www/html/freepbx/admin/modules/nethhotel/htdocs`
- [Hotel FIAS interface](https://github.com/nethesis/ns8-nethvoice/tree/main/freepbx/usr/share/neth-hotel-fias): `freepbx/usr/share/neth-hotel-fias`

### Phonebook and Reports

- [Phonebook service](https://github.com/nethesis/ns8-nethvoice/blob/main/phonebook/phonebook.js): `phonebook/phonebook.js`
- [Phonebook exports](https://github.com/nethesis/ns8-nethvoice/tree/main/freepbx/usr/share/phonebooks): `freepbx/usr/share/phonebooks`
- [Reports branding runtime](https://github.com/nethesis/ns8-nethvoice/tree/main/reports): `reports`

### Other components

- **Cluster administrator**
- **Phonebook consumer**
- **Reports UI container**

## Connections

- Admin application → Page routing: uses routes (evidence: `ui/src/main.js`)
- Admin application → Shared state: uses state (evidence: `ui/src/main.js`)
- Admin application → Setup wizard: shows wizard (evidence: `ui/src/App.vue`)
- Admin application → Status dashboard: renders route
- Admin application → Integrations page: renders route
- Admin application → Rebranding settings: renders route
- Admin application → Hotel settings page: renders route
- Admin application → Module settings: renders route
- Setup wizard → Account provider step: renders step (evidence: `ui/src/components/first-configuration/FirstConfigurationModal.vue`)
- Setup wizard → OpenLDAP step: renders step (evidence: `ui/src/components/first-configuration/FirstConfigurationModal.vue`)
- Setup wizard → Proxy configuration: renders step (evidence: `ui/src/components/first-configuration/FirstConfigurationModal.vue`)
- Setup wizard → NethVoice configuration: renders step (evidence: `ui/src/components/first-configuration/FirstConfigurationModal.vue`)
- Cluster administrator → Admin application: configures module
- Cluster administrator → Rebranding settings: sets branding
- Rebranding settings → Reports branding runtime: sets task variables
- Reports branding runtime → Reports UI container: exposes configuration
- Phonebook consumer → Phonebook service: requests credentials
- Phonebook service → Phonebook consumer: raises change event
