Configuration source reference¶
Source commit: 796717af517d50d52249a484fa35c42394ada304.
Generated from this revision's source declarations. These defaults and traits do not report a running installation's active settings, prove provider delivery, or establish that newly added components are integrated.
Source: api/app/config_values.py. Secret defaults are omitted; no environment values, persisted operator files, database records, or installation keys are read.
Directional overrides inherit FAX_BACKEND when empty. Omitted and null patches preserve values; secret masks are not stored credentials. The source activation model may require restart or maintenance for some edits; this table is not an activation result.
| Environment key | Patch field | Type | Source default |
|---|---|---|---|
FAX_DATA_DIR |
fax_data_dir |
string | "./faxdata" |
MAX_FILE_SIZE_MB |
max_file_size_mb |
integer | 10 |
FAX_DISABLED |
fax_disabled |
boolean | false |
API_KEY |
api_key |
string | secret (omitted) |
REQUIRE_API_KEY |
require_api_key |
boolean | false |
FAX_BACKEND |
backend |
string | "" |
FAX_OUTBOUND_BACKEND |
outbound_backend |
string | "" |
FAX_INBOUND_BACKEND |
inbound_backend |
string | "" |
ASTERISK_AMI_HOST |
ami_host |
string | "asterisk" |
ASTERISK_AMI_PORT |
ami_port |
integer | 5038 |
ASTERISK_AMI_USERNAME |
ami_username |
string | "api" |
ASTERISK_AMI_PASSWORD |
ami_password |
string | secret (omitted) |
FREESWITCH_ESL_HOST |
fs_esl_host |
string | "127.0.0.1" |
FREESWITCH_ESL_PORT |
fs_esl_port |
integer | 8021 |
FREESWITCH_ESL_PASSWORD |
fs_esl_password |
string | secret (omitted) |
FREESWITCH_GATEWAY_NAME |
fs_gateway_name |
string | "gw_signalwire" |
FREESWITCH_CALLER_ID_NUMBER |
fs_caller_id_number |
string | "" |
FREESWITCH_T38_ENABLE |
fs_t38_enable |
boolean | true |
SIP_TRUNK_PRESET |
sip_trunk_preset |
string | "" |
SIP_TRUNK_AUTH |
sip_trunk_auth |
string | "registration" |
SIP_TRUNK_HOST |
sip_trunk_host |
string | "" |
SIP_TRUNK_PORT |
sip_trunk_port |
integer | 0 |
SIP_TRUNK_TRANSPORT |
sip_trunk_transport |
string | "" |
SIP_TRUNK_USERNAME |
sip_trunk_username |
string | "" |
SIP_TRUNK_PASSWORD |
sip_trunk_password |
string | secret (omitted) |
SIP_TRUNK_OUTBOUND_PROXY |
sip_trunk_outbound_proxy |
string | "" |
SIP_TRUNK_CALLER_ID |
sip_trunk_caller_id |
string | "" |
SIP_TRUNK_DIDS |
sip_trunk_dids |
string | "" |
SIP_T38_ENABLED |
sip_t38_enabled |
boolean | true |
SIP_T38_ERROR_CORRECTION |
sip_t38_error_correction |
string | "redundancy" |
SIP_T38_MAX_DATAGRAM |
sip_t38_max_datagram |
integer | 400 |
SIP_FAX_MAX_RATE |
sip_fax_max_rate |
integer | 14400 |
SIP_FAX_ECM |
sip_fax_ecm |
boolean | true |
SIP_FAX_COMPRESSION |
sip_fax_compression |
string | "jbig" |
SIP_FAX_FINE |
sip_fax_fine |
boolean | true |
SIP_SSLFAX_ENABLED |
sip_sslfax_enabled |
boolean | true |
SIP_FAX_LINES |
sip_fax_lines |
integer | 2 |
SIP_TRUNK_MAX_CALLS |
sip_trunk_max_calls |
integer | 0 |
SIP_TRUNK_CALLS_PER_SECOND |
sip_trunk_calls_per_second |
integer | 0 |
SIP_SSLFAX_LISTENER_PORT |
sip_sslfax_listener_port |
integer | 10443 |
SIP_FAX_PREFERENCE_HEADER |
sip_fax_preference_header |
boolean | true |
SIP_TRUNK_CODECS |
sip_trunk_codecs |
string | "" |
SIP_TRUNK_DIAL_FORMAT |
sip_trunk_dial_format |
string | "" |
SIP_TRUNK_DIAL_PREFIX |
sip_trunk_dial_prefix |
string | "" |
SIP_EXTERNAL_ADDRESS |
sip_external_address |
string | "" |
SIP_PUBLIC_ADDRESS_CHECK_MINUTES |
sip_public_address_check_minutes |
integer | 5 |
SIP_ROUTER_PORTS |
sip_router_ports |
boolean | true |
TELNYX_API_KEY |
telnyx_api_key |
string | secret (omitted) |
PHAXIO_API_KEY |
phaxio_api_key |
string | secret (omitted) |
PHAXIO_API_SECRET |
phaxio_api_secret |
string | secret (omitted) |
PHAXIO_CALLBACK_TOKEN |
phaxio_callback_token |
string | secret (omitted) |
PHAXIO_STATUS_CALLBACK_URL |
phaxio_status_callback_url |
string | "" |
PHAXIO_VERIFY_SIGNATURE |
phaxio_verify_signature |
boolean | true |
PUBLIC_API_URL |
public_api_url |
string | "http://localhost:8080" |
SINCH_BASE_URL |
sinch_base_url |
string | "" |
SINCH_PROJECT_ID |
sinch_project_id |
string | "" |
SINCH_API_KEY |
sinch_api_key |
string | secret (omitted) |
SINCH_API_SECRET |
sinch_api_secret |
string | secret (omitted) |
SIGNALWIRE_SPACE_URL |
signalwire_space_url |
string | "" |
SIGNALWIRE_PROJECT_ID |
signalwire_project_id |
string | "" |
SIGNALWIRE_API_TOKEN |
signalwire_api_token |
string | secret (omitted) |
SIGNALWIRE_FAX_FROM_E164 |
signalwire_fax_from_e164 |
string | "" |
SIGNALWIRE_SMS_FROM_E164 |
signalwire_sms_from_e164 |
string | "" |
SIGNALWIRE_STATUS_CALLBACK_URL |
signalwire_status_callback_url |
string | "" |
SIGNALWIRE_WEBHOOK_SIGNING_KEY |
signalwire_webhook_signing_key |
string | secret (omitted) |
SIGNALWIRE_STATUS_POLL_SECONDS |
signalwire_status_poll_seconds |
integer | 0 |
DOCUMO_API_KEY |
documo_api_key |
string | secret (omitted) |
DOCUMO_BASE_URL |
documo_base_url |
string | "https://api.documo.com" |
DOCUMO_SANDBOX |
documo_use_sandbox |
boolean | false |
HUMBLEFAX_ACCESS_KEY |
humblefax_access_key |
string | secret (omitted) |
HUMBLEFAX_SECRET_KEY |
humblefax_secret_key |
string | secret (omitted) |
HUMBLEFAX_FROM_NUMBER |
humblefax_from_number |
string | "" |
EFAX_APP_ID |
efax_app_id |
string | secret (omitted) |
EFAX_API_KEY |
efax_api_key |
string | secret (omitted) |
EFAX_USER_ID |
efax_user_id |
string | secret (omitted) |
EFAX_CALLER_ID |
efax_caller_id |
string | "" |
EFAX_CSID |
efax_csid |
string | "" |
EFAX_POLL_SECONDS |
efax_poll_seconds |
integer | 60 |
EFAX_DELETE_AFTER_DOWNLOAD |
efax_delete_after_download |
boolean | false |
EFAX_WEBHOOK_SECRET |
efax_webhook_secret |
string | secret (omitted) |
FAX_HEADER |
fax_header |
string | "Faxbot" |
FAX_LOCAL_STATION_ID |
fax_station_id |
string | "" |
FAX_DEFAULT_COUNTRY |
fax_default_country |
string | "US" |
DATABASE_URL |
database_url |
string | secret (omitted) |
PDF_TOKEN_TTL_MINUTES |
pdf_token_ttl_minutes |
integer | 60 |
ENFORCE_PUBLIC_HTTPS |
enforce_public_https |
boolean | true |
ARTIFACT_TTL_DAYS |
artifact_ttl_days |
integer | 0 |
CLEANUP_INTERVAL_MINUTES |
cleanup_interval_minutes |
integer | 1440 |
MAX_REQUESTS_PER_MINUTE |
max_requests_per_minute |
integer | 0 |
AUDIT_LOG_ENABLED |
audit_log_enabled |
boolean | false |
AUDIT_LOG_FORMAT |
audit_log_format |
string | "json" |
AUDIT_LOG_FILE |
audit_log_file |
string | "" |
AUDIT_LOG_SYSLOG |
audit_log_syslog |
boolean | false |
AUDIT_LOG_SYSLOG_ADDRESS |
audit_log_syslog_address |
string | "/dev/log" |
INBOUND_ENABLED |
inbound_enabled |
boolean | false |
INBOUND_RETENTION_DAYS |
inbound_retention_days |
integer | 30 |
INBOUND_TOKEN_TTL_MINUTES |
inbound_token_ttl_minutes |
integer | 60 |
ASTERISK_INBOUND_SECRET |
asterisk_inbound_secret |
string | secret (omitted) |
PHAXIO_INBOUND_VERIFY_SIGNATURE |
phaxio_inbound_verify_signature |
boolean | true |
SINCH_INBOUND_BASIC_USER |
sinch_inbound_basic_user |
string | "" |
SINCH_INBOUND_BASIC_PASS |
sinch_inbound_basic_pass |
string | secret (omitted) |
STORAGE_BACKEND |
storage_backend |
string | "local" |
S3_BUCKET |
s3_bucket |
string | "" |
S3_PREFIX |
s3_prefix |
string | "inbound/" |
S3_REGION |
s3_region |
string | "" |
S3_ENDPOINT_URL |
s3_endpoint_url |
string | "" |
S3_KMS_KEY_ID |
s3_kms_key_id |
string | "" |
ENABLE_S3_DIAGNOSTICS |
enable_s3_diagnostics |
boolean | false |
INBOUND_LIST_RPM |
inbound_list_rpm |
integer | 30 |
INBOUND_GET_RPM |
inbound_get_rpm |
integer | 60 |
ADMIN_ALLOW_RESTART |
admin_allow_restart |
boolean | false |
ENABLE_MCP_SSE |
enable_mcp_sse |
boolean | false |
MCP_SSE_PATH |
mcp_sse_path |
string | "/mcp/sse" |
REQUIRE_MCP_OAUTH |
require_mcp_oauth |
boolean | false |
OAUTH_ISSUER |
oauth_issuer |
string | "" |
OAUTH_AUDIENCE |
oauth_audience |
string | "" |
OAUTH_JWKS_URL |
oauth_jwks_url |
string | "" |
ENABLE_MCP_HTTP |
enable_mcp_http |
boolean | false |
MCP_HTTP_PATH |
mcp_http_path |
string | "/mcp/http" |
FEATURE_V3_PLUGINS |
feature_v3_plugins |
boolean | false |
FAXBOT_CONFIG_PATH |
faxbot_config_path |
string | packaged resource path |
FEATURE_PLUGIN_INSTALL |
feature_plugin_install |
boolean | false |
ENABLE_PERSISTED_SETTINGS |
enable_persisted_settings |
boolean | false |
PERSISTED_ENV_PATH |
persisted_env_path |
string | "/faxdata/faxbot.env" |
FAXBOT_PROVIDERS_DIR |
providers_dir |
string | packaged resource path |
FAX_OUTBOUND_ROUTES |
outbound_routes |
string | "" |
FAX_ROUTE_MIN_SUCCESS_PERCENT |
route_min_success_percent |
integer | 80 |
FAX_LOCAL_DELIVERY |
local_delivery_enabled |
boolean | true |
INTAKE_EMAIL_ENABLED |
intake_email_enabled |
boolean | false |
INTAKE_SMTP_HOST |
intake_smtp_host |
string | "" |
INTAKE_SMTP_PORT |
intake_smtp_port |
integer | 587 |
INTAKE_SMTP_SECURITY |
intake_smtp_security |
string | "starttls" |
INTAKE_SMTP_USERNAME |
intake_smtp_username |
string | "" |
INTAKE_SMTP_PASSWORD |
intake_smtp_password |
string | secret (omitted) |
INTAKE_EMAIL_FROM |
intake_email_from |
string | "" |
INTAKE_EMAIL_TO |
intake_email_to |
string | "" |
INTAKE_EMAIL_SUBJECT |
intake_email_subject |
string | "Fax from {from_number}" |
DIRECT_DELIVERY_ENABLED |
direct_delivery_enabled |
boolean | false |
DIRECT_ORGANIZATION |
direct_organization |
string | "" |
DIRECT_FAX_NUMBER |
direct_fax_number |
string | "" |
DIRECT_ALLOW_PRIVATE_PEERS |
direct_allow_private_peers |
boolean | false |
WORK_ACKNOWLEDGE_HOURS |
work_acknowledge_hours |
integer | 0 |
MOBILE_LOCAL_BASE |
mobile_local_base |
string | "" |
DOCS_BASE_URL |
docs_base_url |
string | "https://docs.faxbot.net/latest/" |
FAX_TIME_ZONE |
time_zone |
string | "" |