Repository navigation
Technical Maintenance
Audience: maintainers and advanced administrators. Baseline reviewed: 2026-10-29.
The wiki repository is the documentation source used by the AI agent. Keep implementation references in its technical/ directory and ordinary guides at their existing user-facing locations. Plugin/Encoder source remains independently versioned; documentation links and metadata must identify the actual source owner without moving the documentation out of this wiki.
The AVideo repository's .github/copilot-instructions.md is the canonical agent-policy entry point. Technical wiki pages document implementation knowledge; they do not replace repository instructions or authorize operational actions.
For changes affecting documented behavior, inspect and update the relevant basic and technical pages before considering the work complete. Typical triggers include setup/requirements, interface labels, configuration/defaults, dependencies, API/callback contracts, encoding, storage, payments, scheduled work, troubleshooting or compatibility.
Keep user guides focused on the actions and expected result a nontechnical user needs. Update detailed control flow, symbols and diagnostics here. Small internal changes that do not affect documented facts do not require unrelated wiki edits.
Requirements: Python standard library, Git and PHP 8.2+. From the wiki checkout, replace the example source path with the actual AVideo checkout:
python technical/tools/build_reference.py --source-root D:/path/to/AVideo --review-date 2026-10-29
python technical/tools/build_reference.py --source-root D:/path/to/AVideo --review-date 2026-10-29 --check
python technical/tools/validate_reference.py --source-root D:/path/to/AVideoThe default review date is the initial source baseline. Set a new date only after reviewing the corresponding source and explanations; regeneration does not perform semantic review automatically.
The generator reads tracked Streamer/plugin/Encoder implementation files and local plugin extensions. PHP files are tokenized without including configuration, executing handlers or connecting to services. Function bodies are cached outside the wiki in the operating system's temporary directory, while published references contain declarations and hashes rather than those bodies. Protect the local cache according to the source's access rules.
Generated pages carry an identifying comment. technical/tools/plugin-notes.json contains reviewed purpose/behavior notes. Hand-written guides are separate and are not overwritten. technical/source-manifest.json records relative source hashes, component revisions and generated pages.
--check compares expected references with files on disk. It is not a PHP application test, link-availability test, security audit or end-to-end validation. Review the diff, updated symbols/settings, renamed/removed plugins and stale pages after regeneration. The generator intentionally does not delete old pages automatically.
The core entry point is install/mysqlDump.php. In the reviewed source it is CLI-only, creates a private output path with createPrivateMySQLDumpPath() and calls dumpMySQLDatabase(). Its output location is reported on successful completion. Inspect the current entry point and helper before execution; do not invent command-line flags or assume a fixed dump filename.
For authorized backups, use that installation tool with its intended exclusions, preserve the AVideo videos directory and deployment configuration, and account for other sites/services as applicable. Verify the dump/archive and off-host recovery copy. A same-server copy alone does not provide independent recovery protection.
This documentation task did not run the backup tool, modify production data, execute retention jobs or test a database restore.
Discover actual vhosts, paths, PHP versions/SAPIs/extensions, databases, custom binaries, cron/timers, certificates, Docker projects, volumes and restart mechanisms. Deployment samples do not prove a running host matches them.
Operational work remains subject to the user's authorization and applicable production-service confirmation requirements. Documentation changes do not authorize restarts, reboots, upgrades, cleanup, database changes, publication or AI reindexing.
