Configuration

This section auto-documents the repository application configuration.

pydantic settings app.core.config.Settings

Settings model for API.

Config:

• extra: str = ignore

• env_file: str = .env

• env_file_encoding: str = utf-8

Fields:

• allowed_import_domains (list[str])

• app_name (str)

• auth_provider (Literal['azure', 'keycloak', 'both'])

• azure_application_id (str)

• azure_blob_config (app.core.config.AzureBlobConfig | None)

• azure_login_url (str)

• bypass_auth (bool | None)

• cli_client_id (str | None)

• cors_allow_origins (list[str])

• db_config (app.core.config.DatabaseConfig)

• dedup_scoring (app.core.config.DedupCandidateScoringConfig)

• default_download_file_chunk_size (Literal[1])

• default_es_indexing_chunk_size (int)

• default_es_percolation_chunk_size (int)

• default_pending_enhancement_lease_duration (datetime.timedelta)

• default_upload_file_chunk_size (int)

• env (app.core.config.Environment)

• es_aggregation_max_buckets (int)

• es_config (app.core.config.ESConfig)

• es_indexing_chunk_size_override (dict[app.core.config.ESIndexingOperation, int])

• es_percolation_chunk_size_override (dict[app.core.config.ESPercolationOperation, int])

• es_reference_repair_max_batch_size (int)

• feature_flags (app.core.config.FeatureFlags)

• full_text_max_byte_size (int)

• import_reference_retry_count (int)

• keycloak_client_id (str | None)

• keycloak_issuer_url (str | None)

• keycloak_realm (str)

• keycloak_url (str | None)

• log_level (app.core.config.LogLevel)

• max_lookup_reference_query_length (int)

• max_pending_enhancements_batch_size (int)

• message_broker_namespace (str | None)

• message_broker_priority_queue_max_wait (int)

• message_broker_priority_queue_name (str)

• message_broker_queue_max_wait (int)

• message_broker_queue_name (str)

• message_broker_url (str | None)

• message_lock_renewal_duration (int)

• minio_config (app.core.config.MinioConfig | None)

• otel_config (app.core.config.OTelConfig | None)

• otel_enabled (bool)

• presigned_url_expiry_seconds (int)

• project_root (pathlib.Path)

• tests_use_rabbitmq (bool)

• toml (app.core.config.TOML)

• trusted_unique_identifier_types (set[destiny_sdk.identifiers.ExternalIdentifierType])

• upload_file_chunk_size_override (dict[app.core.config.UploadFile, int])

Validators:

• _validate_keycloak_settings » all fields

field allowed_import_domains: list[str] = ['blob.core.windows.net']

Allowed domain suffixes for import storage URLs. URLs whose hostname does not match are rejected with 403. Empty list disables the check.

Validated by:

• _validate_keycloak_settings

field app_name: str [Required]

Validated by:

• _validate_keycloak_settings

field auth_provider: Literal['azure', 'keycloak', 'both'] = 'azure'

The authentication provider to use: ‘azure’, ‘keycloak’, or ‘both’ for multi-issuer.

Validated by:

• _validate_keycloak_settings

field azure_application_id: str [Required]

Validated by:

• _validate_keycloak_settings

field azure_blob_config: AzureBlobConfig | None = None

Validated by:

• _validate_keycloak_settings

field azure_login_url: str = 'https://login.microsoftonline.com'

Validated by:

• _validate_keycloak_settings

field bypass_auth: bool | None = None

Override auth bypass behavior. When None (default), auth is bypassed only when running locally (ENV=local/test). Set to False to enforce auth even locally.

Validated by:

• _validate_keycloak_settings

field cli_client_id: str | None = None

Validated by:

• _validate_keycloak_settings

field cors_allow_origins: list[str] [Optional]

List of allowed origins for CORS.

Validated by:

• _validate_keycloak_settings

field db_config: DatabaseConfig [Required]

Validated by:

• _validate_keycloak_settings

field dedup_scoring: DedupCandidateScoringConfig = DedupCandidateScoringConfig(max_author_clauses=25, min_author_token_length=2)

Validated by:

• _validate_keycloak_settings

field default_download_file_chunk_size: Literal[1] = 1

Number of records to process in a single file chunk when downloading.Not configurable or used, just representing that we stream line-by-line at this point.

Validated by:

• _validate_keycloak_settings

field default_es_indexing_chunk_size: int = 1000

Number of records to process in a single chunk when indexing to Elasticsearch.

Validated by:

• _validate_keycloak_settings

field default_es_percolation_chunk_size: int = 1000

Number of records to process in a single chunk when percolating to Elasticsearch.

Validated by:

• _validate_keycloak_settings

field default_pending_enhancement_lease_duration: timedelta = datetime.timedelta(seconds=600)

The default duration to lease pending enhancements for, provided in ISO 8601 duration format eg ‘PT10M’.

Validated by:

• _validate_keycloak_settings

field default_upload_file_chunk_size: int = 1

Number of records to process in a single file chunk when uploading.

Validated by:

• _validate_keycloak_settings

field env: Environment = Environment.PRODUCTION

The environment the app is running in.

Validated by:

• _validate_keycloak_settings

field es_aggregation_max_buckets: int = 1000

Maximum buckets returned per Elasticsearch terms aggregation. Capped at the Elasticsearch cluster default for search.max_buckets.

Constraints:

• ge = 1

• le = 65536

Validated by:

• _validate_keycloak_settings

field es_config: ESConfig [Required]

Validated by:

• _validate_keycloak_settings

field es_indexing_chunk_size_override: dict[ESIndexingOperation, int] [Optional]

Override the default Elasticsearch indexing chunk size.

Validated by:

• _validate_keycloak_settings

field es_percolation_chunk_size_override: dict[ESPercolationOperation, int] [Optional]

Override the default Elasticsearch percolation chunk size.

Validated by:

• _validate_keycloak_settings

field es_reference_repair_max_batch_size: int = 1000

Maximum number of reference records that may be repaired in a single task. Caps both the partition size used when distributing a full reference index repair and the size of a caller-supplied subset accepted by the repair endpoint. Be wary that if increased too far, then the repair_reference_index_for_chunk task will require long_running=True and subsequent lock management.

Validated by:

• _validate_keycloak_settings

field feature_flags: FeatureFlags = FeatureFlags(enable_percolation=True, enable_canonical_candidate_search=True)

Validated by:

• _validate_keycloak_settings

field full_text_max_byte_size: int = 1073741824

Maximum size in bytes accepted when fetching a remote full-text source. Aborts the stream and rejects the enhancement if exceeded.

Validated by:

• _validate_keycloak_settings

field import_reference_retry_count: int = 3

Number of times to retry importing a reference before marking it as failed. We only retry on errors we are confident can be resolved - eg network issues or inconsistent database state being loaded in parallel.

Validated by:

• _validate_keycloak_settings

field keycloak_client_id: str | None = None

The Keycloak client ID for token validation.

Validated by:

• _validate_keycloak_settings

field keycloak_issuer_url: str | None = None

The issuer URL for token validation. Defaults to keycloak_url if not set. Useful when the token issuer differs from the internal Keycloak URL (e.g., in Docker where tokens are issued with localhost but JWKS is fetched via internal network).

Validated by:

• _validate_keycloak_settings

field keycloak_realm: str = 'destiny'

The Keycloak realm name.

Validated by:

• _validate_keycloak_settings

field keycloak_url: str | None = None

The base URL of the Keycloak server (used for JWKS fetching).

Validated by:

• _validate_keycloak_settings

field log_level: LogLevel = LogLevel.INFO

The log level for the application. This applies to both opentelemetry and standard logging.

Validated by:

• _validate_keycloak_settings

field max_lookup_reference_query_length: int = 100

Maximum number of identifiers to allow in a single reference lookup query.

Validated by:

• _validate_keycloak_settings

field max_pending_enhancements_batch_size: int = 10000

Maximum number of pending enhancements to return in a single batch.

Validated by:

• _validate_keycloak_settings

field message_broker_namespace: str | None = None

Validated by:

• _validate_keycloak_settings

field message_broker_priority_queue_max_wait: int = 1

Max time to wait to receive messages on the high priority task queue (in seconds).

Validated by:

• _validate_keycloak_settings

field message_broker_priority_queue_name: str = 'taskiq-priority'

Validated by:

• _validate_keycloak_settings

field message_broker_queue_max_wait: int = 2

Max time to wait to receive messages on the normal priority task queue (in seconds).

Validated by:

• _validate_keycloak_settings

field message_broker_queue_name: str = 'taskiq'

Validated by:

• _validate_keycloak_settings

field message_broker_url: str | None = None

Validated by:

• _validate_keycloak_settings

field message_lock_renewal_duration: int = 10800

Duration in seconds to keep renewing message locks. Should be longer than expected processing time.

Validated by:

• _validate_keycloak_settings

field minio_config: MinioConfig | None = None

Validated by:

• _validate_keycloak_settings

field otel_config: OTelConfig | None = None

Validated by:

• _validate_keycloak_settings

field otel_enabled: bool = False

Validated by:

• _validate_keycloak_settings

field presigned_url_expiry_seconds: int = 3600

The number of seconds a signed URL is valid for.

Validated by:

• _validate_keycloak_settings

field project_root: Path = PosixPath('/home/runner/work/destiny-repository/destiny-repository')

Validated by:

• _validate_keycloak_settings

field tests_use_rabbitmq: bool = False

Whether to use RabbitMQ for tests. Only used in test environment. If false, uses in-memory broker.

Validated by:

• _validate_keycloak_settings

field toml: TOML = TOML(toml_path=PosixPath('/home/runner/work/destiny-repository/destiny-repository'))

Validated by:

• _validate_keycloak_settings

field trusted_unique_identifier_types: set[ExternalIdentifierType] [Optional]

Set of external identifier types that are considered trusted unique identifiers for references. These are used to shortcut deduplication. If empty, shortcutting is essentially feature-flagged off.

Validated by:

• _validate_keycloak_settings

field upload_file_chunk_size_override: dict[UploadFile, int] [Optional]

Override the default upload file chunk size.

Validated by:

• _validate_keycloak_settings

property running_locally: bool

Return True if the app is running locally.

property should_bypass_auth: bool

Return True if auth should be bypassed.

Auth can only be bypassed when running locally (ENV=local/test).

property trace_repr: str

Get a string representation of the config for tracing.