Skip to navigation
ReferenceStatus and ConfigurationCLI and Configuration

DocsFab Host Environment Variables

Dev
View as Markdown

Look up environment variables that select private storage, retry behavior, and host configuration. Keep credential values outside the repository.

Host and Private Configuration

The following table lists the host and private configuration settings.

SettingPurpose
DOCSFAB_CONFIG_ROOTSelect one normalized absolute directory for writable host configuration, profiles, and default state.
DOCSFAB_STATE_DIROverride the run-record state directory used to locate durable stops and continuation records. It does not relocate live-agent sessions.
DOCSFAB_SKILL_CRATE_DIROverride the skill crate directory. Unset uses paths.skillCrateDir from host.yaml, then the packaged skill-crate directory.
DOCSFAB_PUBLIC_ROOTSDeclare host directories that DocsFab may publish as written. Unset declares none. Refer to Host Paths in Published Output.
DOCSFAB_READ_ONLY_MAX_RETRIESSet retries for configured read-only inference failures. Despite its name, it also bounds the create-documentation revision writer, which retries a retryable malformed reply after DocsFab restores candidate 0. Unset uses 3; 0 turns off contract-correction retries only. Throttled and transport-fault attempts use DOCSFAB_READ_ONLY_MAX_TRANSPORT_RETRIES instead. The maximum is 3.
DOCSFAB_READ_ONLY_MAX_TRANSPORT_RETRIESLower the separate transport retry budget, from 0 through 6. Throttled and provider transport-fault attempts spend it instead of the read-only retry count; 0 turns off transport retries. With both at their defaults, a read-only step makes at most 10 attempts.
DOCSFAB_RETRY_BASE_DELAY_MSSet the initial retry delay.
DOCSFAB_RETRY_MAX_DELAY_MSSet the maximum retry delay.
DOCSFAB_RETRYABLE_CATEGORIESSelect from the runtime’s closed retry-category set.
DOCSFAB_ANSWER_SUBMISSIONChoose how the final quality evaluator in review-documentation answers. Unset, or recorded, uses the submit_quality_evaluation tool call on a route whose composition recorded that capability, and the text answer elsewhere. text-final keeps the text answer on every route. Any other value stops the command with answer-submission-option-invalid. Every evaluator attempt records the path it took and why.
DOCSFAB_INFERENCE_REJECTED_REPLY_SHAPE_MAX_DEPTHSet how deep a rejected reply’s shape fingerprint describes nesting. Unset uses 8; the range is 1 through 32.
DOCSFAB_INFERENCE_REJECTED_REPLY_SHAPE_MAX_ENTRIESSet how many key paths and top-level keys a rejected reply’s shape fingerprint lists. Unset uses 128; the range is 8 through 1024.
DOCSFAB_INFERENCE_REJECTED_REPLY_EXCERPT_CHARSSet how many reply characters each segment of a rejected reply’s redacted excerpt keeps in the private run record. Unset uses 512; the range is 0 through 4096, and 0 keeps no reply text.
DOCSFAB_JOB_TREE_BUDGETSet the concurrent job-tree admission limit for each hosted project. Unset uses 16. A higher value admits a larger backlog but does not increase execution capacity.
DOCSFAB_NATIVE_PREFLIGHT_TIMEOUT_MSShrink the native preflight child timeout. Unset uses 10000.
DOCSFAB_NATIVE_PREFLIGHT_VERSION_STDOUT_BYTESShrink the native preflight --version capture ceiling. Unset uses 4096.
DOCSFAB_NATIVE_PREFLIGHT_AUTHENTICATION_STDOUT_BYTESShrink the native preflight authentication capture ceiling. Unset uses 16384.
DOCSFAB_NATIVE_PREFLIGHT_CATALOG_STDOUT_BYTESShrink the Codex bundled-model catalog capture ceiling. Unset uses 2097152.
DOCSFAB_NATIVE_PREFLIGHT_MAX_STDERR_BYTESShrink the native preflight stderr capture ceiling. Unset uses 16384.
DOCSFAB_NATIVE_PREFLIGHT_RECORDED_DURATION_MSShrink the recorded native preflight duration notice threshold. Unset uses 600000. Measured duration stays the actual value.
DOCSFAB_NATIVE_PREFLIGHT_RECORDED_STDOUT_BYTESShrink the recorded native preflight stdout notice threshold. Unset uses 4194304. Measured stdout stays the actual value.
DOCSFAB_NATIVE_PREFLIGHT_RECORDED_STDERR_BYTESShrink the recorded native preflight stderr notice threshold. Unset uses 1048576. Measured stderr stays the actual value.
DOCSFAB_AUTONOMY_AUTHORIZATION_WINDOW_MSShrink the maximum docsfab auto --once authorization window. Unset uses 3600000.
DOCSFAB_AUTONOMY_AUTHORIZATION_WINDOW_DEFAULT_MSShrink the default docsfab auto --once authorization window. Unset uses 900000. Must stay at or under the effective maximum.

DOCSFAB_JOB_TREE_BUDGET accepts a plain positive decimal integer with up to nine digits. Values such as an empty string, 0, 010, 1e3, a signed value, or a value with whitespace prevent the host from starting. The setting controls admission only: each project consumer still runs one packet at a time. Increase it when interactive submissions must enter a temporary backlog instead of failing with job-tree-budget-exhausted, then reduce it after the backlog drains.

Keep private configuration outside the project checkout. The runtime rejects an empty, relative, non-normalized, or null-containing DOCSFAB_CONFIG_ROOT. Live-agent sessions are stored under <DOCSFAB_CONFIG_ROOT>/.docsfab/live-agent/sessions. DocsFab protects that directory with owner-only 0700 permissions and each session file with owner-only 0600 permissions. docsfab sessions list and docsfab sessions delete list and delete them, and DOCSFAB_LIVE_AGENT_SESSION_MAX_AGE_DAYS removes sessions older than that many days when docsfab live-agent starts. For details, refer to Stored Sessions and Deletion. Refer to the installed command and checked-in source for exact value ranges.

For the installed model, serving-route, transport, and credential compositions, refer to Execution Compositions in DocsFab.