# mr-joep/feeb-streaming-server architecture

> Architecture diagram of the GitHub repository mr-joep/feeb-streaming-server, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mr-joep/feeb-streaming-server
- Repository: https://github.com/mr-joep/feeb-streaming-server

## Overview

OBS Hosting provisions an individual OBS container for each streamer. A browser user signs up through the public site or portal; a portal admin approves the account, and the client dashboard can then request deployment. The controller coordinates node and regional ingest capacity and publishes the OBS Blade address; phones send streams through ingest to the client’s OBS. The controller also supports account and server administration, settings, mail, and remote viewing. The README documents these product interactions; unsampled subsystem internals are represented only at supported directory paths.

Main entry points: [`controller/app/lib/deploy.php`](https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/lib/deploy.php) (Deployment coordinator), [`controller/app/public`](https://github.com/mr-joep/feeb-streaming-server/tree/main/controller/app/public) (Portal pages), [`website/app/public/index.php`](https://github.com/mr-joep/feeb-streaming-server/blob/main/website/app/public/index.php) (Marketing pages), [`node/public/api.php`](https://github.com/mr-joep/feeb-streaming-server/blob/main/node/public/api.php) (Node API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_public["Public website"]
  node_site["Marketing pages<br/>[index.php]"]
  node_sitecontent["Site content"]
  node_siteincludes["Shared site UI"]
  node_signup["Signup form<br/>[signup-form.php]"]
end

subgraph group_portal["Controller portal"]
  node_portalpages["Portal pages"]
  node_accountflow["Account approval<br/>[accounts.php]"]
  node_portalcore["Portal sessions<br/>[bootstrap.php]"]
  node_admin["Admin management<br/>[admin.php]"]
  node_dashboard["Client dashboard<br/>[dashboard.php]"]
  node_controllerdb[("Controller database")]
end

subgraph group_provision["Deployment infrastructure"]
  node_deploy["Deployment coordinator<br/>[deploy.php]"]
  node_controllerapi["Server API client<br/>[api.php]"]
  node_nodeapi["Node API<br/>[api.php]"]
  node_nodedashboard["Node dashboard<br/>[index.php]"]
  node_nodecommon["Node manager core<br/>[common.php]"]
end

subgraph group_stream["Streaming and access"]
  node_ingestapi["Ingest API<br/>[api.php]"]
  node_ingestpages["Ingest setup<br/>[pages.php]"]
  node_ingestsupervisor["Go-irl services<br/>[supervisor.php]"]
  node_obs["Client OBS container"]
  node_remotenode["OBS remote view"]
end

node_browser(("Browser user"))
node_phone(("Streamer phone"))
node_cloudflare{{"Cloudflare DNS"}}
node_mail{{"SMTP mail service"}}

node_browser -->|"visits"| node_site
node_site -->|"renders with"| node_siteincludes
node_site -->|"offers signup"| node_signup
node_siteincludes -->|"frames pages"| node_sitecontent
node_signup -->|"links signup"| node_portalpages
node_browser -->|"uses portal"| node_portalpages
node_portalpages -->|"uses sessions"| node_portalcore
node_portalpages -->|"handles account actions"| node_accountflow
node_admin -->|"decides accounts"| node_accountflow
node_admin -->|"manages deployments"| node_deploy
node_dashboard -->|"requests deployment"| node_deploy
node_portalcore -->|"reads and writes"| node_controllerdb
node_accountflow -->|"sends account mail"| node_mail
node_deploy -->|"calls server APIs"| node_controllerapi
node_deploy -->|"provisions ingest"| node_ingestapi
node_deploy -->|"provisions OBS"| node_nodeapi
node_deploy -->|"publishes Blade address"| node_cloudflare
node_ingestapi -->|"uses pages"| node_ingestpages
node_ingestapi -.->|"manages go-irl"| node_ingestsupervisor
node_nodeapi -->|"uses manager core"| node_nodecommon
node_nodedashboard -->|"uses manager core"| node_nodecommon
node_nodeapi -->|"manages containers"| node_obs
node_phone -->|"sends SRTLA"| node_ingestsupervisor
node_ingestsupervisor -->|"feeds SRT"| node_obs
node_browser -->|"views OBS remotely"| node_remotenode
node_portalpages -->|"proxies remote view"| node_remotenode

click node_site "https://github.com/mr-joep/feeb-streaming-server/blob/main/website/app/public/index.php"
click node_sitecontent "https://github.com/mr-joep/feeb-streaming-server/tree/main/website/app/public"
click node_siteincludes "https://github.com/mr-joep/feeb-streaming-server/tree/main/website/app/includes"
click node_signup "https://github.com/mr-joep/feeb-streaming-server/blob/main/website/app/includes/signup-form.php"
click node_portalpages "https://github.com/mr-joep/feeb-streaming-server/tree/main/controller/app/public"
click node_accountflow "https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/lib/accounts.php"
click node_portalcore "https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/lib/bootstrap.php"
click node_admin "https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/public/admin.php"
click node_dashboard "https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/public/dashboard.php"
click node_deploy "https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/lib/deploy.php"
click node_controllerapi "https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/lib/api.php"
click node_ingestapi "https://github.com/mr-joep/feeb-streaming-server/blob/main/ingest/app/api.php"
click node_ingestpages "https://github.com/mr-joep/feeb-streaming-server/blob/main/ingest/app/pages.php"
click node_ingestsupervisor "https://github.com/mr-joep/feeb-streaming-server/blob/main/ingest/app/supervisor.php"
click node_nodeapi "https://github.com/mr-joep/feeb-streaming-server/blob/main/node/public/api.php"
click node_nodedashboard "https://github.com/mr-joep/feeb-streaming-server/blob/main/node/public/index.php"
click node_nodecommon "https://github.com/mr-joep/feeb-streaming-server/blob/main/node/lib/common.php"
click node_obs "https://github.com/mr-joep/feeb-streaming-server/tree/main/image"
click node_remotenode "https://github.com/mr-joep/feeb-streaming-server/tree/main/node"

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_site,node_sitecontent,node_siteincludes,node_signup,node_browser toneBlue
class node_portalpages,node_accountflow,node_portalcore,node_admin,node_dashboard,node_controllerdb toneAmber
class node_deploy,node_controllerapi,node_nodeapi,node_nodedashboard,node_nodecommon toneMint
class node_ingestapi,node_ingestpages,node_ingestsupervisor,node_obs,node_remotenode toneRose
class node_phone,node_cloudflare,node_mail toneIndigo
```

## Components

### Public website

- [Marketing pages](https://github.com/mr-joep/feeb-streaming-server/blob/main/website/app/public/index.php): `website/app/public/index.php`
- [Site content](https://github.com/mr-joep/feeb-streaming-server/tree/main/website/app/public): `website/app/public`
- [Shared site UI](https://github.com/mr-joep/feeb-streaming-server/tree/main/website/app/includes): `website/app/includes`
- [Signup form](https://github.com/mr-joep/feeb-streaming-server/blob/main/website/app/includes/signup-form.php): `website/app/includes/signup-form.php`

### Controller portal

- [Portal pages](https://github.com/mr-joep/feeb-streaming-server/tree/main/controller/app/public): `controller/app/public`
- [Account approval](https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/lib/accounts.php): `controller/app/lib/accounts.php`
- [Portal sessions](https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/lib/bootstrap.php): `controller/app/lib/bootstrap.php`
- [Admin management](https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/public/admin.php): `controller/app/public/admin.php`
- [Client dashboard](https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/public/dashboard.php): `controller/app/public/dashboard.php`
- **Controller database**

### Deployment infrastructure

- [Deployment coordinator](https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/lib/deploy.php): `controller/app/lib/deploy.php`
- [Server API client](https://github.com/mr-joep/feeb-streaming-server/blob/main/controller/app/lib/api.php): `controller/app/lib/api.php`
- [Node API](https://github.com/mr-joep/feeb-streaming-server/blob/main/node/public/api.php): `node/public/api.php`
- [Node dashboard](https://github.com/mr-joep/feeb-streaming-server/blob/main/node/public/index.php): `node/public/index.php`
- [Node manager core](https://github.com/mr-joep/feeb-streaming-server/blob/main/node/lib/common.php): `node/lib/common.php`

### Streaming and access

- [Ingest API](https://github.com/mr-joep/feeb-streaming-server/blob/main/ingest/app/api.php): `ingest/app/api.php`
- [Ingest setup](https://github.com/mr-joep/feeb-streaming-server/blob/main/ingest/app/pages.php): `ingest/app/pages.php`
- [Go-irl services](https://github.com/mr-joep/feeb-streaming-server/blob/main/ingest/app/supervisor.php): `ingest/app/supervisor.php`
- [Client OBS container](https://github.com/mr-joep/feeb-streaming-server/tree/main/image): `image`
- [OBS remote view](https://github.com/mr-joep/feeb-streaming-server/tree/main/node): `node`

### Other components

- **Browser user**
- **Streamer phone**
- **Cloudflare DNS**
- **SMTP mail service**

## Connections

- Browser user → Marketing pages: visits
- Marketing pages → Shared site UI: renders with (evidence: `website/app/public/index.php`)
- Marketing pages → Signup form: offers signup (evidence: `website/app/public/index.php`)
- Shared site UI → Site content: frames pages (evidence: `website/app/public/index.php`)
- Signup form → Portal pages: links signup (evidence: `website/app/includes/signup-form.php`)
- Browser user → Portal pages: uses portal
- Portal pages → Portal sessions: uses sessions (evidence: `controller/app/public/admin.php`)
- Portal pages → Account approval: handles account actions (evidence: `controller/app/public/admin.php`)
- Admin management → Account approval: decides accounts (evidence: `controller/app/public/admin.php`)
- Admin management → Deployment coordinator: manages deployments (evidence: `controller/app/public/admin.php`)
- Client dashboard → Deployment coordinator: requests deployment (evidence: `controller/app/public/dashboard.php`)
- Portal sessions → Controller database: reads and writes (evidence: `controller/app/lib/bootstrap.php`)
- Account approval → SMTP mail service: sends account mail (evidence: `controller/app/lib/accounts.php`)
- Deployment coordinator → Server API client: calls server APIs (evidence: `controller/app/lib/deploy.php`)
- Deployment coordinator → Ingest API: provisions ingest
- Deployment coordinator → Node API: provisions OBS
- Deployment coordinator → Cloudflare DNS: publishes Blade address
- Ingest API → Ingest setup: uses pages (evidence: `ingest/app/api.php`)
- Ingest API → Go-irl services: manages go-irl
- Node API → Node manager core: uses manager core (evidence: `node/public/api.php`)
- Node dashboard → Node manager core: uses manager core (evidence: `node/public/index.php`)
- Node API → Client OBS container: manages containers
- Streamer phone → Go-irl services: sends SRTLA
- Go-irl services → Client OBS container: feeds SRT
- Browser user → OBS remote view: views OBS remotely
- Portal pages → OBS remote view: proxies remote view
