Skip to content

Technical Documentation

Daniel Neto edited this page Oct 30, 2026 · 2 revisions

Technical documentation

This section is for developers, advanced administrators and the AVideo AI assistant. For ordinary setup and use, start with the User Manual, Admin Manual or plugin setup guides.

Both the basic guides and these technical references live in the AVideo wiki repository. The technical/ directory separates their source files locally; unique Technical- page names and this index organize navigation on GitHub Wiki. The wiki's general page list can still display technical pages.

Read by task

Task Reference
Understand components and request processing Architecture
Understand a plugin, its settings, dependencies and entry points All 132 plugins
Understand plugin loading, hooks and settings Plugin framework
Trace a configuration field Configuration
Investigate stale reads, tables or migrations Database and caching
Trace uploads, encoding, callbacks and preview images Encoding
Investigate ingest, HLS, restream or recording Live streaming
Investigate file locations, remote objects or playback Storage and delivery
Build an integration or investigate an API request API contracts
Investigate payment credit or purchased access Payments
Investigate cron, queues and watchdogs Background jobs
Work on the browser/player interface Frontend
Diagnose a failure across components Troubleshooting
Maintain backups and documentation Maintenance
Confirm a yptDocker restore and diagnose lock contention Docker restore verification
Understand wiki organization and AI ingestion Wiki and AI ingestion
Look up exact source symbols Source references
Check revisions, coverage and untested areas Coverage

How to interpret the references

The baseline was reviewed on 2026-10-29. Source-derived plugin pages identify the owning repository, source revision and locally modified source where applicable. Plugin versions are independent of Streamer and Encoder versions.

Behavioral guides explain traced workflows. Generated references inventory named functions, direct configuration assignments, dependency declarations, request-field references and SQL table declarations. An inventory is not a complete endpoint schema, an exhaustive functional/security audit, or proof that a provider integration works.

Use the installed version and actual deployment configuration when diagnosing a site. Private installation configuration, credentials and tokens are not part of this documentation.

Clone this wiki locally