cata_log_hub.settings module

class cata_log_hub.settings.Settings[source]

Bases: BaseSettings

Configuration for the Cata-Log server. You can configure the settings with these command-line arguments or environment variables starting with CATA_LOG_.

model_config: ClassVar[SettingsConfigDict] = {'arbitrary_types_allowed': True, 'case_sensitive': False, 'cli_avoid_json': False, 'cli_enforce_required': False, 'cli_exit_on_error': True, 'cli_flag_prefix_char': '-', 'cli_hide_none_type': False, 'cli_ignore_unknown_args': True, 'cli_implicit_flags': False, 'cli_kebab_case': True, 'cli_parse_args': True, 'cli_parse_none_str': None, 'cli_prefix': '', 'cli_prog_name': None, 'cli_shortcuts': None, 'cli_use_class_docs_for_groups': False, 'enable_decoding': True, 'env_file': '.env', 'env_file_encoding': None, 'env_ignore_empty': False, 'env_nested_delimiter': None, 'env_nested_max_split': None, 'env_parse_enums': None, 'env_parse_none_str': None, 'env_prefix': 'CATA_LOG_', 'env_prefix_target': 'variable', 'extra': 'forbid', 'json_file': None, 'json_file_encoding': None, 'nested_model_default_partial_update': False, 'protected_namespaces': ('model_validate', 'model_dump', 'settings_customise_sources'), 'secrets_dir': None, 'toml_file': None, 'validate_default': True, 'yaml_config_section': None, 'yaml_file': None, 'yaml_file_encoding': None}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

username: str
password: str
data_path: Path
storage_path: Path
database_path: Path
plugin_path: Path
logs_path: Path
external_database_url: PostgresDsn | MySQLDsn | Literal['']
dev_mode: bool
public_get: bool
request_timeout: Annotated[int, Gt(gt=0)]
retry_delay: Annotated[int, Gt(gt=0)]
expiration_days: Annotated[int, Ge(ge=0)]
log_level: str
log_file_backup_count: Annotated[int, Ge(ge=0)]
log_file_maxsize: Annotated[int, Ge(ge=0)]
api_default_pagination_page_size: Annotated[int, Gt(gt=0)]
api_max_pagination_page_size: Annotated[int, Gt(gt=0)]
host: IPvAnyAddress
port: int
forwarded_allow_ips: str
root_path: str
allowed_hosts: list[str]
classmethod ensure_dirs(value)[source]

Create non-existent paths.

Return type:

Any

Returns:

The path.

Parameters:

value (Any)

cata_log_hub.settings.get_settings()[source]

Get the current settings.

Return type:

Settings