README.md

RBT documentation index

This folder contains project documentation for rbt.

About the project

RoBoT / RBT — open IP intercom & video platform (standalone server + SPA). Upstream the codebase is known as SmartYard-Server.

• Website: sesameware.com
• Upstream notes: important.md
• Wiki: GitHub Wiki
• Generated API docs (WiP, upstream): SERVER API, MOBILE API
• Changelog (upstream)

Index

Project pillars (what the system stands on)

• Client: a SPA (single-page application) that talks to the server only via HTTP API. There is no server-side rendering (SSR) in this project.
• Server: a set of mostly vanilla PHP scripts with minimal dependencies (Composer is used, but intentionally kept small).

Roadmap (target table of contents)

The items below are the documentation structure we aim to complete. Some pages may not exist yet — the links are the plan.

Architecture

• Overview
• Domain glossary
• Data model overview

API

• Web UI API (frontend)
• Mobile API
• Billing API
• API conventions (routing, auth, errors, caching)

Client / Customization

• Client overview (SPA, modules, routing)
• Client configuration
• Client modules
• SPA modules (client/modules)
• Customization: customFields
• Customization examples

Server / Utilities

• Server overview (vanilla PHP, entrypoints)
• Entrypoints
  • frontend.php (Web UI API gateway)
  • mobile.php (Mobile API gateway)
  • cli.php (CLI tooling)
  • asterisk.php (Asterisk integration)
  • internal.php (Internal API gateway)
  • kamailio.php (Kamailio integration)
  • wh.php (Webhooks)
  • ud363.php (HTTP upload / XEP-0363 placeholder)
  • qr.php (QR endpoint)
  • test.php (Local testing)
• API implementation (server/api)
• Base API class (server/api/api.php)
• Backends (server/backends)
• Base backend class (server/backends/backend.php)
• groups backend
• Utilities (server/utils) — catalog of all .php files
  • PDOExt (PDO helper)
  • loader.php (dynamic loaders)
• Auxiliary services (server/services)

Storage and services

• PostgreSQL (PDO) integration
• Redis usage
• MongoDB usage (files, GridFS)
• ClickHouse usage

Telephony and realtime

• Asterisk integration
• Kamailio integration
• MQTT integration

TT (tickets/workflows)

• TT overview
• Workflows (Lua)
• Filters and viewers
• Examples

Hardware

• IS syslog events
• QTech syslog events

Installation and operations

• Installation index (step files live in install/)
• Crontabs and scheduled jobs
• Maintenance mode
• Backups and recovery

Examples

• Server examples
• Custom server examples
• Custom client examples