Settings reference

The scripts/docsgen generator writes this page from the source code. Do not edit this page. To update it, run make docs-generate.

This page lists the name, the type, and the default of each setting. It shows no value from a deployment.

Catalog settings

The Starmap catalog descriptors define these settings. The configuration view and the configuration save use the same list.

Variable	Type	Scope	Default	Mutability	Sensitive
`STARPORT_CATALOG_SOURCE`	string	deployment	`public`	runtime-replacement	No
`STARPORT_CATALOG_SOURCE_URL`	string	deployment	None	runtime-replacement	No
`STARPORT_CATALOG_SOURCE_API_KEY`	string	deployment	None	runtime-replacement	Yes
`STARPORT_CATALOG_SOURCE_REPOSITORY`	string	deployment	`agentstation/starmap`	runtime-replacement	No
`STARPORT_CATALOG_SOURCE_CHANNEL`	string	deployment	`catalog/v2`	runtime-replacement	No
`STARPORT_CATALOG_SOURCE_SIGNER_WORKFLOW`	string	deployment	None	runtime-replacement	No
`STARPORT_CATALOG_SOURCE_TOKEN`	string	deployment	None	runtime-replacement	Yes
`STARPORT_CATALOG_SOURCE_REFRESH_MODE`	string	deployment	`automatic`	runtime-replacement	No
`STARPORT_CATALOG_GENERATION_PIN`	string	deployment	None	runtime-replacement	No
`STARPORT_CATALOG_NETWORK_MODE`	string	deployment	`configured`	runtime-replacement	No
`STARPORT_CATALOG_SOURCE_POLL_INTERVAL`	duration	deployment	`1h0m0s` duration	runtime-replacement	No
`STARPORT_CATALOG_SOURCE_STARTUP_POLICY`	string	deployment	`prefer_source`	runtime-replacement	No
`STARPORT_CATALOG_SOURCE_AUTHORITY_ID`	string	deployment	None	restart	No
`STARPORT_CATALOG_SOURCE_POLICY_ID`	string	deployment	None	restart	No
`STARPORT_CATALOG_SOURCE_MAX_AGE`	duration	deployment	`6h0m0s` duration	runtime-replacement	No
`STARPORT_CATALOG_SOURCE_MAX_HOPS`	integer	deployment	`8` hops	runtime-replacement	No
`STARPORT_CATALOG_SOURCE_ALIASES`	string-list	node	None	restart	No
`STARPORT_CATALOG_ACQUISITION_ENABLED`	boolean	deployment	`true`	runtime-replacement	No
`STARPORT_CATALOG_ACQUISITION_SOURCES`	string-list	deployment	None	restart	No
`STARPORT_CATALOG_MODELS_DEV_GIT_COMMIT`	string	deployment	None	restart	No
`STARPORT_CATALOG_ACQUISITION_INTERVAL`	duration	deployment	`4h0m0s` duration	runtime-replacement	No
`STARPORT_CATALOG_PROVIDER_BINDINGS`	provider-bindings	deployment	None	restart	No
`STARPORT_CATALOG_COALESCE_WINDOW`	duration	deployment	`30s` duration	runtime-replacement	No
`STARPORT_CATALOG_WORKSPACE_PATH`	string	node	None	restart	No
`STARPORT_CATALOG_STARTUP_SPREAD`	duration	deployment	`15m0s` duration	runtime-replacement	No
`STARPORT_CATALOG_TRANSFER_IDLE_TIMEOUT`	duration	deployment	`2m0s` duration	runtime-replacement	No
`STARPORT_CATALOG_TRANSFER_MAX_DURATION`	duration	deployment	`1h0m0s` duration	runtime-replacement	No
`STARPORT_CATALOG_REFRESH_TIMEOUT`	duration	deployment	`0s` duration	runtime-replacement	No
`STARPORT_CATALOG_STATE_DIR`	string	node	None	restart	No
`STARPORT_SCHEDULER_IDENTITY`	string	node	None	restart	No
`STARPORT_CATALOG_RETENTION_ENABLED`	boolean	deployment	`true`	runtime-replacement	No
`STARPORT_CATALOG_RETENTION_INTERVAL`	duration	deployment	`1h0m0s` duration	runtime-replacement	No
`STARPORT_CATALOG_RETENTION_MAX_GENERATIONS`	integer	deployment	`32` generations	runtime-replacement	No
`STARPORT_CATALOG_RETENTION_MAX_BYTES`	integer	deployment	`536870912` bytes	runtime-replacement	No
`STARPORT_CATALOG_RETENTION_SCAN_ENTRIES`	integer	deployment	`4096` entries	runtime-replacement	No
`STARPORT_CATALOG_RETENTION_INPUT_MAX_BYTES`	integer	deployment	`268435456` bytes	runtime-replacement	No
`STARPORT_CONFIG_MANAGEMENT`	string	node	None	migration-only	No

The env tags of the Starport configuration define these settings. The starport config show command shows a secret setting as <redacted>. A platform path default is in the data root. The file reference gives the root for each platform.

server

Variable	Type	Default	Secret
`STARPORT_SERVER_PORT`	`int`	`8080`	No
`STARPORT_SERVER_HOST`	`string`	`127.0.0.1`	No
`STARPORT_SERVER_READ_TIMEOUT`	`time.Duration`	`30s`	No
`STARPORT_SERVER_WRITE_TIMEOUT`	`time.Duration`	`30s`	No
`STARPORT_SERVER_IDLE_TIMEOUT`	`time.Duration`	`120s`	No
`STARPORT_SERVER_REQUEST_TIMEOUT`	`time.Duration`	`60s`	No
`STARPORT_SERVER_MAX_REQUEST_SIZE`	`int64`	`33554432`	No
`STARPORT_SERVER_MAX_HEADER_BYTES`	`int`	`1048576`	No
`STARPORT_SERVER_SHUTDOWN_TIMEOUT`	`time.Duration`	`30s`	No
`STARPORT_SERVER_ENABLE_PROFILING`	`bool`	`false`	No
`STARPORT_SERVER_ENABLE_HEALTH_CHECK`	`bool`	`true`	No

storage

Variable	Type	Default	Secret
`STARPORT_STORAGE_MODE`	`string`	`badger`	No
`STARPORT_STORAGE_BADGER_PATH`	`string`	Platform path	No
`STARPORT_STORAGE_BADGER_SYNC_WRITES`	`bool`	`true`	No
`STARPORT_STORAGE_BADGER_COMPRESSION`	`string`	`snappy`	No
`STARPORT_STORAGE_BADGER_GC_INTERVAL`	`time.Duration`	`5m`	No
`STARPORT_STORAGE_BADGER_GC_DISCARD_RATIO`	`float64`	`0.5`	No
`STARPORT_STORAGE_VALKEY_USERNAME`	`string`	None	No
`STARPORT_STORAGE_VALKEY_CA_FILE`	`string`	None	No
`STARPORT_STORAGE_VALKEY_ALLOW_INSECURE`	`bool`	`false`	No
`STARPORT_STORAGE_VALKEY_URL`	`string`	`valkey://localhost:6379`	Yes
`STARPORT_STORAGE_VALKEY_MAX_CONNECTIONS`	`int`	`50`	No
`STARPORT_STORAGE_VALKEY_MIN_IDLE_CONNS`	`int`	`10`	No
`STARPORT_STORAGE_VALKEY_DIAL_TIMEOUT`	`time.Duration`	`5s`	No
`STARPORT_STORAGE_VALKEY_READ_TIMEOUT`	`time.Duration`	`3s`	No
`STARPORT_STORAGE_VALKEY_WRITE_TIMEOUT`	`time.Duration`	`3s`	No
`STARPORT_STORAGE_VALKEY_IDLE_TIMEOUT`	`time.Duration`	`5m`	No
`STARPORT_STORAGE_VALKEY_CLUSTER_MODE`	`bool`	`false`	No
`STARPORT_STORAGE_VALKEY_PASSWORD`	`string`	None	Yes
`STARPORT_STORAGE_SQL_MODE`	`string`	`sqlite`	No
`STARPORT_STORAGE_SQL_SQLITE_PATH`	`string`	Platform path	No
`STARPORT_STORAGE_SQL_POSTGRES_URL`	`string`	None	Yes
`STARPORT_STORAGE_SQL_MYSQL_DSN`	`string`	None	Yes

catalog

Variable	Type	Default	Secret
`STARPORT_CATALOG_SOURCE`	`string`	`public`	No
`STARPORT_CATALOG_SOURCE_URL`	`string`	None	Yes
`STARPORT_CATALOG_SOURCE_API_KEY`	`string`	None	Yes
`STARPORT_CATALOG_SOURCE_REPOSITORY`	`string`	`agentstation/starmap`	No
`STARPORT_CATALOG_SOURCE_CHANNEL`	`string`	`catalog/v2`	No
`STARPORT_CATALOG_SOURCE_SIGNER_WORKFLOW`	`string`	None	No
`STARPORT_CATALOG_SOURCE_TOKEN`	`string`	None	Yes
`STARPORT_CATALOG_SOURCE_POLL_INTERVAL`	`time.Duration`	`1h0m0s`	No
`STARPORT_CATALOG_SOURCE_STARTUP_POLICY`	`string`	`prefer_source`	No
`STARPORT_CATALOG_SOURCE_AUTHORITY_ID`	`string`	None	No
`STARPORT_CATALOG_SOURCE_POLICY_ID`	`string`	None	No
`STARPORT_CATALOG_SOURCE_MAX_AGE`	`time.Duration`	`6h0m0s`	No
`STARPORT_CATALOG_SOURCE_MAX_HOPS`	`int`	`8`	No
`STARPORT_CATALOG_ACQUISITION_ENABLED`	`bool`	`true`	No
`STARPORT_CATALOG_ACQUISITION_INTERVAL`	`time.Duration`	`4h0m0s`	No
`STARPORT_CATALOG_WORKSPACE_PATH`	`string`	None	No
`STARPORT_CATALOG_STATE_DIR`	`string`	None	No
`STARPORT_CATALOG_STARTUP_SPREAD`	`time.Duration`	`15m0s`	No
`STARPORT_CATALOG_TRANSFER_IDLE_TIMEOUT`	`time.Duration`	`2m0s`	No
`STARPORT_CATALOG_TRANSFER_MAX_DURATION`	`time.Duration`	`1h0m0s`	No
`STARPORT_CATALOG_REFRESH_TIMEOUT`	`time.Duration`	`0s`	No

management

Variable	Type	Default	Secret
`STARPORT_CONFIG_MANAGEMENT`	`string`	None	No

credential_sources

Variable	Type	Default	Secret
`STARPORT_CREDENTIAL_SOURCES_MANAGED_ENTRIES`	`int`	`1024`	No
`STARPORT_CREDENTIAL_SOURCES_MANAGED_SECRET_BYTES`	`int`	`16777216`	No
`STARPORT_CREDENTIAL_SOURCES_MANAGED_CONCURRENT_LOADS`	`int`	`4`	No
`STARPORT_CREDENTIAL_SOURCES_MANAGED_TENANT_CONCURRENT_LOADS`	`int`	`2`	No
`STARPORT_CREDENTIAL_SOURCES_MANAGED_VALIDITY`	`time.Duration`	`5s`	No
`STARPORT_CREDENTIAL_SOURCES_MANAGED_LOAD_TIMEOUT`	`time.Duration`	`1s`	No
`STARPORT_CREDENTIAL_SOURCES_MANAGED_IDLE`	`time.Duration`	`1m`	No
`STARPORT_CREDENTIAL_SOURCES_MANAGED_REFRESH_INTERVAL`	`time.Duration`	`1s`	No
`STARPORT_CREDENTIAL_SOURCES_ALLOW_STARMAP_FALLBACK`	`bool`	`false`	No
`STARPORT_CREDENTIAL_SOURCES_REMOTE_REFRESH_INTERVAL`	`time.Duration`	`5m`	No
`STARPORT_CREDENTIAL_SOURCES_RECONCILE_INTERVAL`	`time.Duration`	`1m`	No
`STARPORT_CREDENTIAL_SOURCES_RECONCILE_TIMEOUT`	`time.Duration`	`10s`	No

rate_limiting

Variable	Type	Default	Secret
`STARPORT_RATE_LIMITING_DEFAULT_REQUESTS_PER_MINUTE`	`int`	`60`	No
`STARPORT_RATE_LIMITING_WINDOW_SIZE`	`time.Duration`	`1m`	No

budget_admission

Variable	Type	Default	Secret
`STARPORT_BUDGET_ADMISSION_MODE`	`string`	`atomic`	No

security

Variable	Type	Default	Secret
`STARPORT_SECURITY_MASTER_KEY`	`string`	None	Yes
`STARPORT_SECURITY_TLS_CERT_PATH`	`string`	None	No
`STARPORT_SECURITY_TLS_KEY_PATH`	`string`	None	No
`STARPORT_SECURITY_ENABLE_TLS`	`bool`	`false`	No
`STARPORT_SECURITY_ALLOWED_ORIGINS`	`string`	None	No
`STARPORT_SECURITY_ENABLE_CORS`	`bool`	`false`	No
`STARPORT_SECURITY_JWT_SECRET`	`string`	None	Yes
`STARPORT_SECURITY_API_KEY_HEADER`	`string`	`Authorization`	No
`STARPORT_SECURITY_ENABLE_RATE_LIMITING`	`bool`	`true`	No
`STARPORT_SECURITY_AUTH_MODE`	`authmode.Mode`	None	No
`STARPORT_SECURITY_ALLOW_REMOTE_NO_AUTH`	`bool`	`false`	No
`STARPORT_SECURITY_UNAUTHENTICATED_SCOPES`	`[]string`	None	No

logging

Variable	Type	Default	Secret
`STARPORT_LOGGING_LEVEL`	`string`	`info`	No
`STARPORT_LOGGING_FORMAT`	`string`	`json`	No
`STARPORT_LOGGING_OUTPUT`	`string`	`stdout`	No
`STARPORT_LOGGING_FILE_PATH`	`string`	None	No
`STARPORT_LOGGING_MAX_SIZE`	`int`	`100`	No
`STARPORT_LOGGING_MAX_BACKUPS`	`int`	`3`	No
`STARPORT_LOGGING_MAX_AGE`	`int`	`7`	No
`STARPORT_LOGGING_COMPRESS`	`bool`	`true`	No

cache

Variable	Type	Default	Secret
`STARPORT_CACHE_CHAT_ENABLED`	`bool`	`true`	No
`STARPORT_CACHE_EMBEDDINGS_ENABLED`	`bool`	`true`	No
`STARPORT_CACHE_MODELS_ENABLED`	`bool`	`true`	No
`STARPORT_CACHE_PROVIDERS_ENABLED`	`bool`	`true`	No
`STARPORT_CACHE_EXTRACTIONS_ENABLED`	`bool`	`true`	No
`STARPORT_CACHE_CA_FILE`	`string`	None	No
`STARPORT_CACHE_ENABLED`	`bool`	`true`	No
`STARPORT_CACHE_BACKEND`	`string`	`local`	No
`STARPORT_CACHE_URL`	`string`	None	Yes
`STARPORT_CACHE_ALLOW_INSECURE`	`bool`	`false`	No

files

Variable	Type	Default	Secret
`STARPORT_FILES_BACKEND`	`string`	`filesystem`	No
`STARPORT_FILES_PATH`	`string`	Platform path	No
`STARPORT_FILES_MAX_UPLOAD_BYTES`	`int64`	`536870912`	No
`STARPORT_FILES_RETENTION`	`time.Duration`	`720h`	No
`STARPORT_FILES_SWEEP_INTERVAL`	`time.Duration`	`1h`	No
`STARPORT_FILES_OBJECT_STORE_BUCKET`	`string`	None	No
`STARPORT_FILES_OBJECT_STORE_REGION`	`string`	None	No
`STARPORT_FILES_OBJECT_STORE_ENDPOINT`	`string`	None	Yes
`STARPORT_FILES_OBJECT_STORE_PREFIX`	`string`	None	No
`STARPORT_FILES_OBJECT_STORE_ACCESS_KEY_ID`	`string`	None	Yes
`STARPORT_FILES_OBJECT_STORE_SECRET_ACCESS_KEY`	`string`	None	Yes

jobs

Variable	Type	Default	Secret
`STARPORT_JOBS_ASSET_DOWNLOAD_ORIGINS`	`[]string`	None	No
`STARPORT_JOBS_MAX_WORKERS`	`int`	`2`	No
`STARPORT_JOBS_EXECUTION_TIMEOUT`	`time.Duration`	`10m`	No
`STARPORT_JOBS_ASSET_RETENTION`	`time.Duration`	`24h`	No
`STARPORT_JOBS_MAX_ASSET_BYTES`	`int64`	`268435456`	No
`STARPORT_JOBS_SWEEP_INTERVAL`	`time.Duration`	`1h`	No

console

Variable	Type	Default	Secret
`STARPORT_CONSOLE_ENABLED`	`bool`	`true`	No

identity

Variable	Type	Default	Secret
`STARPORT_IDENTITY_CALLBACK_BASE_URL`	`string`	None	Yes
`STARPORT_IDENTITY_OAUTH_GOOGLE_CLIENT_ID`	`string`	None	No
`STARPORT_IDENTITY_OAUTH_GOOGLE_CLIENT_SECRET`	`string`	None	Yes
`STARPORT_IDENTITY_OAUTH_GITHUB_CLIENT_ID`	`string`	None	No
`STARPORT_IDENTITY_OAUTH_GITHUB_CLIENT_SECRET`	`string`	None	Yes
`STARPORT_IDENTITY_WORKOS_API_KEY`	`string`	None	Yes
`STARPORT_IDENTITY_WORKOS_CLIENT_ID`	`string`	None	No
`STARPORT_IDENTITY_WORKOS_ORGANIZATION`	`string`	None	No
`STARPORT_IDENTITY_WORKOS_CONNECTION`	`string`	None	No

telemetry

Variable	Type	Default	Secret
`STARPORT_TELEMETRY_METRICS`	`string`	`on`	No
`STARPORT_TELEMETRY_USAGE_EXPORT`	`string`	None	No

audit

Variable	Type	Default	Secret
`STARPORT_AUDIT_RETENTION`	`time.Duration`	`9600h`	No

events

Variable	Type	Default	Secret
`STARPORT_EVENTS_WEBHOOK_URLS`	`string`	None	No
`STARPORT_EVENTS_WEBHOOK_SECRET`	`string`	None	Yes

guardrails

Variable	Type	Default	Secret
`STARPORT_GUARDRAILS_CHECKS`	`string`	None	No
`STARPORT_GUARDRAILS_PII_MODE`	`string`	None	No
`STARPORT_GUARDRAILS_MODERATION_MODEL`	`string`	None	No
`STARPORT_GUARDRAILS_MODERATION_THRESHOLD`	`float64`	None	No
`STARPORT_GUARDRAILS_MODERATION_THRESHOLDS`	`string`	None	No

semantic_cache

Variable	Type	Default	Secret
`STARPORT_SEMANTIC_CACHE_ENABLED`	`bool`	None	No
`STARPORT_SEMANTIC_CACHE_MODEL`	`string`	None	No
`STARPORT_SEMANTIC_CACHE_THRESHOLD`	`float64`	None	No
`STARPORT_SEMANTIC_CACHE_MAX_ENTRIES`	`int`	None	No