openmixer — generated API reference
    Preparing search index...

    Interface ResolveServerConfigOptions

    Options for resolveServerConfig.

    interface ResolveServerConfigOptions {
        configFile?: string;
        configJson?: unknown;
        env?: ProcessEnv;
        web?: { host?: string; manualDir?: string; port?: number };
    }
    Index
    configFile?: string

    Explicit config-file path (the --config flag). Fallback: OPENMIXER_CONFIG.

    configJson?: unknown

    The config file's contents, already read by readConfigFileJson — the bins read it for the network layer, so passing it here avoids a second read (and a file edited mid-boot yielding two different configs). Wins over configFile.

    env?: ProcessEnv

    The environment to read (default process.env).

    web?: { host?: string; manualDir?: string; port?: number }

    The fully-resolved web binding from the runtime-network resolver (persisted Setup > CLI > env > config file > default) — replaces the config's web section whole, since that resolver already owns the web-binding precedence chain and has ALREADY folded this file's web block in at its proper rank (issue #381).

    Type Declaration

    • Optionalhost?: string
    • OptionalmanualDir?: string

      OVERRIDE for the root of the prerendered documentation site. Normally UNSET.

      The location is DERIVED (resolveManualDir): the openmixer-manual package's /usr/share/openmixer/manual, else the workspace's packages/website/.output/public. A parameter the system can work out must not be one an operator has to remember — the RPM may set this, an odd layout may need it, and a hand-set value on a rig is the defect it replaced. No site in any of them → the mount answers 404; the console never fakes a page.

      The build ROOT, never a subdirectory of it: a prerendered page's stylesheet, chunks and fonts sit beside the pages, and the manual's topic pages are under docs/, so a subtree serves HTML whose every asset 404s. That is exactly how the manual was dead on the rig 2026-08-05, with this variable pointed one level too deep — diagnoseManualSite now says so in the log at boot.

    • Optionalport?: number