mirror of https://github.com/Vateron-Media/XC_VM.git synced 2026-10-30 11:03:21 +01:00

Files

T

Claude 79088ff0ef feat(fanout): add a master switch that stops the xc_fanout daemon

settings.fanout_enabled (migration 027, default on) is a new "Fanout
Delivery" toggle beside the other fanout settings. Streaming\Fanout\FanoutMode
reads it and applies it to a node:

- Off: FanoutMode::applyToNode() writes bin/xc_fanout/disabled, then stops
  run.sh (so it cannot respawn the daemon) and then xc_fanout. It runs on
  MAIN when the settings are saved, and on every node from RootSignalsCronJob
  within a minute. The RootSignals keepalive and the hourly fanout_binary
  self-heal skip the daemon while the flag is set; `service boot` and run.sh,
  which cannot read settings, check the flag file.
- Every daemon-facing gate honours the switch. LicenseGate::fanoutUsable()
  and each FanoutClient control-socket call behave as if the daemon were
  down. IngestFeeder::forStream() returns a no-op feeder, and DelayCommand
  stops queueing segments for it. fanout_sync stops writing the daemon
  config and closes the pid-0 connection rows the stopped daemon left.
- The dashboard no longer reports "xc_fanout down" when it was switched off.

The pre-fanout delivery paths for fanout off follow in the next commit.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Es8UhyPS8MNjuYTagqfGWi

2026-09-25 10:07:46 +00:00

4.4 KiB

Raw Blame History

Development Feature Flags

XC_VM uses constants and settings-driven flags to control environment behavior.

Application constants are defined by the appConfig() map in src/Core/Config/ConstantsInitializer.php.

Active Runtime Flag

`PHP_ERRORS`

define('PHP_ERRORS', $rShowErrors); // derived from $rSettings['debug_show_errors']

PHP_ERRORS controls PHP/debug verbosity and logger screen output:

Logger::init(PHP_ERRORS, LOGS_TMP_PATH . 'error_log.log');

`DB_ACCESS_ENABLED`

define('DB_ACCESS_ENABLED', false); // enables phpMiniAdmin tab/page in admin panel

DB_ACCESS_ENABLED controls access to phpMiniAdmin from admin UI only. It does not block core application database connections. Its companion DB_ACCESS_PWD (also in the appConfig() map) sets the password protecting that page — leave it empty to keep the tab off, set a strong value only while you need it.

`DEV_MODE`

define('DEV_MODE', false); // master development-mode flag

DEV_MODE is the compile-time development switch (bootstrap.php reads it into self::$devMode). When true it forces PHP_ERRORS on (verbose on-screen errors), surfaces reCAPTCHA diagnostics, and enables other developer conveniences.

⚠️ Never enable DEV_MODE or debug_show_errors on production — both expose internal errors/paths to visitors. PHP_ERRORS ends up true if either the DEV_MODE constant is set (bootstrap path) or the debug_show_errors setting is on (request-guard path); that is the resolution rule when the two overlap.

Settings-driven Flags (`$rSettings`)

Loaded from settings cache and used in runtime decision points.

Key	Type	Meaning
`debug_show_errors`	`bool`	show detailed errors/debug output
`recaptcha_enable`	`bool`	enable reCAPTCHA v2 on login
`verify_host`	`bool`	enforce host allowlist validation
`save_login_logs`	`bool`	persist login attempts in `login_logs`
`fanout_enabled`	`bool`	master switch for the xc_fanout daemon (default on); off stops it on every node and live delivery uses the pre-fanout paths (see streaming-subsystem, "Switching fanout off")
`fanout_supervise`	`bool`	hand live streams to the xc_fanout supervisor instead of a PHP monitor (default on)
`fanout_source_backend`	`auto` / `ffmpeg` / `native`	how sources become MPEG-TS; with supervision, whether copy-only streams run the native remuxer (`auto`: with ffmpeg fallback)

These values are loaded from CACHE_TMP_PATH/settings by request guards.

Static App Constants

From the appConfig() map in src/Core/Config/ConstantsInitializer.php (each entry is define()'d by ConstantsInitializer::init()):

'DB_ACCESS_ENABLED' => false,
'DB_ACCESS_PWD'     => '',       // password for the phpMiniAdmin tab (empty = off)
'DEV_MODE'          => false,    // master development-mode switch
'XC_VM_VERSION'     => '2.4.1',  // bumped every release — treat as illustrative
'GIT_OWNER'         => 'Vateron-Media',
'GIT_REPO_MAIN'     => 'XC_VM',
'GIT_REPO_UPDATE'   => 'XC_VM_Update',
'GIT_REPO_BIN'      => 'XC_VM_Binaries',
'GIT_REPO_FANOUT'   => 'XC_VM_Fanout', // xc_fanout daemon source + binaries
'GIT_REPO_PROXY'    => 'XC_VM_Proxy',
'MONITOR_CALLS'     => 3,
'OPENSSL_EXTRA'     => '...',    // literal fallback; the real per-install secret is read
                                 // from the config/openssl_extra file by init()

Adding New Flags

Use static constants in the appConfig() map (ConstantsInitializer.php) for fixed infrastructure/runtime constants (edited in code, take effect on next request). Use settings ($rSettings) for values an operator toggles from the admin panel (Settings page) — those are persisted in the settings DB table and read from CACHE_TMP_PATH/settings.

Avoid defining the same behavior in both places. When they unavoidably overlap (as with DEV_MODE vs debug_show_errors → PHP_ERRORS), the effective value is the OR of the two — either turning it on wins.

File	Purpose
`src/Core/Config/ConstantsInitializer.php`	static app constants (`appConfig()` map)
`src/Core/Http/RequestGuard.php`	loads `$rSettings`, sets `PHP_ERRORS`
`src/Core/Error/ErrorHandler.php`	uses `debug_show_errors` behavior
`src/Core/Logging/Logger.php`	debug/verbosity behavior

4.4 KiB Raw Blame History

Development Feature Flags

Active Runtime Flag

PHP_ERRORS

DB_ACCESS_ENABLED

DEV_MODE

Settings-driven Flags ($rSettings)