controller.utilities.configuration.BaseEnvModel
- class controller.utilities.configuration.BaseEnvModel(**data)[source]
- Parameters:
data (
Any)FRONTEND_FRAMEWORK (FRONTEND_FRAMEWORK_VALUES)
FRONTEND_BUILD_MODE (FRONTEND_BUILD_MODE_VALUES)
NETWORK_MTU (int)
DOCKER_LOGGING_DRIVER (DOCKER_LOGGING_DRIVERS)
HEALTHCHECK_INTERVAL (str)
HEALTHCHECK_BACKEND_CMD (str)
LOG_LEVEL (LOG_LEVEL_VALUES)
FILE_LOGLEVEL (LOG_LEVEL_VALUES)
LOG_RETENTION (int)
MIN_PASSWORD_SCORE (int)
ACTIVATE_BACKEND (zero_or_one)
ACTIVATE_PROXY (zero_or_one)
ACTIVATE_ALCHEMY (zero_or_one)
ACTIVATE_POSTGRES (zero_or_one)
ACTIVATE_NEO4J (zero_or_one)
ACTIVATE_RABBIT (zero_or_one)
ACTIVATE_REDIS (zero_or_one)
ACTIVATE_CELERY (zero_or_one)
ACTIVATE_CELERYBEAT (zero_or_one)
ACTIVATE_FLOWER (zero_or_one)
ACTIVATE_FTP (zero_or_one)
ACTIVATE_SMTP (zero_or_one)
ACTIVATE_SMTP_SERVER (zero_or_one)
ACTIVATE_SWAGGERUI (zero_or_one)
ACTIVATE_ADMINER (zero_or_one)
ACTIVATE_MYPY (zero_or_one)
MYPY_DISALLOW_UNTYPED_DEFS (zero_or_one)
MYPY_IGNORE_LIBS (str)
MYPY_ADD_LIBS (str)
MAX_LOGS_LENGTH (int)
APP_MODE (APP_MODE_VALUES)
FLASK_HOST (str)
FLASK_DEFAULT_PORT (int)
FLASK_DEBUG (zero_or_one)
API_AUTOSTART (zero_or_one)
BACKEND_PORT (int)
BACKEND_API_PORT (int)
BACKEND_URL (str)
BACKEND_PYTHON_VERSION (BACKEND_PYTHON_VERSION_VALUES)
PYTHON_MAIN_FILE (str)
PYTHONASYNCIODEBUG (zero_or_one)
PYTHONFAULTHANDLER (zero_or_one)
PYTHONMALLOC (PYTHONMALLOC_VALUES)
BACKEND_PREFIX (str)
APP_SECRETS (Path)
DATA_PATH (Path)
DATA_IMPORT_FOLDER (Path)
GUNICORN_WORKERS (int)
GUNICORN_WORKERS_PER_CORE (int)
GUNICORN_MAX_NUM_WORKERS (int)
CRONTAB_ENABLE (zero_or_one)
GZIP_COMPRESSION_ENABLE (zero_or_one)
GZIP_COMPRESSION_THRESHOLD (int)
GZIP_COMPRESSION_LEVEL (int)
ALEMBIC_AUTO_MIGRATE (zero_or_one)
PROXY_HOST (str)
PROXY_DEV_PORT (int)
PROXY_PROD_PORT (int)
PROXIED_CONNECTION (zero_or_one)
DOMAIN_ALIASES (str | None)
SET_UNSAFE_EVAL (str | None)
SET_UNSAFE_INLINE (str | None)
SET_STYLE_UNSAFE_INLINE (str | None)
SET_CSP_SCRIPT_SRC (str | None)
SET_CSP_IMG_SRC (str | None)
SET_CSP_FONT_SRC (str | None)
SET_CSP_CONNECT_SRC (str | None)
SET_CSP_FRAME_SRC (str | None)
SET_MAX_REQUESTS_PER_SECOND_AUTH (int)
SET_MAX_REQUESTS_BURST_AUTH (int)
SET_MAX_REQUESTS_PER_SECOND_API (int)
SET_MAX_REQUESTS_BURST_API (int)
CORS_ALLOWED_ORIGIN (str | None)
SSL_VERIFY_CLIENT (zero_or_one)
SSL_FORCE_SELF_SIGNED (zero_or_one)
ALCHEMY_ENABLE_CONNECTOR (zero_or_one)
ALCHEMY_EXPIRATION_TIME (int)
ALCHEMY_VERIFICATION_TIME (int)
ALCHEMY_HOST (str)
ALCHEMY_PORT (int)
ALCHEMY_DBTYPE (ALCHEMY_DBTYPE_VALUES)
ALCHEMY_USER (str)
ALCHEMY_PASSWORD (str)
ALCHEMY_DB (str)
ALCHEMY_DBS (str)
ALCHEMY_POOLSIZE (int)
POSTGRES_MAX_CONNECTIONS (int)
POSTGRES_SHARED_BUFFERS (str)
POSTGRES_WAL_BUFFERS (str)
POSTGRES_EFFECTIVE_CACHE_SIZE (str)
POSTGRES_WORK_MEM (str)
POSTGRES_MAINTENANCE_WORK_MEM (str)
POSTGRES_EFFECTIVE_IO_CONCURRENCY (int)
POSTGRES_MAX_WORKER_PROCESSES (int)
NEO4J_ENABLE_CONNECTOR (zero_or_one)
NEO4J_EXPIRATION_TIME (int)
NEO4J_VERIFICATION_TIME (int)
NEO4J_HOST (str)
NEO4J_BOLT_PORT (int)
NEO4J_USER (str)
NEO4J_PASSWORD (str)
NEO4J_EXPOSED_WEB_INTERFACE_PORT (int)
NEO4J_WEB_INTERFACE_PORT (int)
NEO4J_SSL_ENABLED (bool)
NEO4J_BOLT_TLS_LEVEL (NEO4J_BOLT_TLS_LEVEL_VALUES)
NEO4J_HEAP_SIZE (str | PLACEHOLDER_VALUE)
NEO4J_PAGECACHE_SIZE (str | PLACEHOLDER_VALUE)
NEO4J_ALLOW_UPGRADE (bool)
NEO4J_RECOVERY_MODE (bool)
ELASTIC_HOST (str)
ELASTIC_PORT (int)
RABBITMQ_ENABLE_CONNECTOR (zero_or_one)
RABBITMQ_EXPIRATION_TIME (int)
RABBITMQ_VERIFICATION_TIME (int)
RABBITMQ_HOST (str)
RABBITMQ_PORT (int)
RABBITMQ_VHOST (str)
RABBITMQ_USER (str)
RABBITMQ_PASSWORD (str)
RABBITMQ_MANAGEMENT_PORT (int)
RABBITMQ_ENABLE_SHOVEL_PLUGIN (zero_or_one)
RABBITMQ_SSL_CERTFILE (Path | None)
RABBITMQ_SSL_KEYFILE (Path | None)
RABBITMQ_SSL_FAIL_IF_NO_PEER_CERT (true_or_false | None)
RABBITMQ_SSL_ENABLED (zero_or_one)
REDIS_ENABLE_CONNECTOR (zero_or_one)
REDIS_EXPIRATION_TIME (int)
REDIS_VERIFICATION_TIME (int)
REDIS_HOST (str)
REDIS_PORT (int)
REDIS_PASSWORD (str)
FTP_ENABLE_CONNECTOR (zero_or_one)
FTP_EXPIRATION_TIME (int)
FTP_VERIFICATION_TIME (int)
FTP_HOST (str)
FTP_PORT (int)
FTP_USER (str)
FTP_PASSWORD (str)
FTP_SSL_ENABLED (zero_or_one)
NFS_HOST (str | None)
NFS_EXPORTS_SECRETS (Path)
NFS_EXPORTS_RABBITDATA (Path)
NFS_EXPORTS_SQLDATA (Path)
NFS_EXPORTS_GRAPHDATA (Path)
NFS_EXPORTS_DATA_IMPORTS (Path)
NFS_EXPORTS_PUREFTPD (Path)
NFS_EXPORTS_SSL_CERTS (Path)
NFS_EXPORTS_FLOWER_DB (Path)
NFS_EXPORTS_REDISDATA (Path)
CELERY_ENABLE_CONNECTOR (zero_or_one)
CELERY_EXPIRATION_TIME (int)
CELERY_VERIFICATION_TIME (int)
CELERY_BROKER (CELERY_BROKER_VALUES)
CELERY_BACKEND (CELERY_BACKEND_VALUES)
CELERY_POOL_MODE (CELERY_POOL_MODE_VALUES)
FLOWER_USER (str)
FLOWER_PASSWORD (str)
FLOWER_DBDIR (Path)
FLOWER_PORT (int)
FLOWER_SSL_OPTIONS (str | None)
FLOWER_PROTOCOL (FLOWER_PROTOCOL_VALUES)
DEFAULT_SCALE_BACKEND (int)
DEFAULT_SCALE_CELERY (int)
DEFAULT_SCALE_CELERYBEAT (int)
DEFAULT_SCALE_SWAGGERUI (int)
ASSIGNED_CPU_BACKEND (str)
ASSIGNED_MEMORY_BACKEND (str)
ASSIGNED_CPU_PROXY (str)
ASSIGNED_MEMORY_PROXY (str)
ASSIGNED_CPU_POSTGRES (str)
ASSIGNED_MEMORY_POSTGRES (str)
ASSIGNED_CPU_NEO4J (str)
ASSIGNED_MEMORY_NEO4J (str)
ASSIGNED_CPU_CELERY (str)
ASSIGNED_MEMORY_CELERY (str)
ASSIGNED_CPU_CELERYBEAT (str)
ASSIGNED_MEMORY_CELERYBEAT (str)
ASSIGNED_CPU_RABBIT (str)
ASSIGNED_MEMORY_RABBIT (str)
ASSIGNED_CPU_REDIS (str)
ASSIGNED_MEMORY_REDIS (str)
ASSIGNED_CPU_FLOWER (str)
ASSIGNED_MEMORY_FLOWER (str)
ASSIGNED_CPU_SWAGGERUI (str)
ASSIGNED_MEMORY_SWAGGERUI (str)
ASSIGNED_CPU_ADMINER (str)
ASSIGNED_MEMORY_ADMINER (str)
ASSIGNED_CPU_FTP (str)
ASSIGNED_MEMORY_FTP (str)
ASSIGNED_CPU_SMTP (str)
ASSIGNED_MEMORY_SMTP (str)
ASSIGNED_CPU_REGISTRY (str)
ASSIGNED_MEMORY_REGISTRY (str)
REGISTRY_HOST (str | None)
REGISTRY_PORT (int)
REGISTRY_USERNAME (str)
REGISTRY_PASSWORD (str)
REGISTRY_HTTP_SECRET (str | None)
ACTIVATE_FAIL2BAN (zero_or_one)
SWARM_MANAGER_ADDRESS (str | None)
SMTP_ENABLE_CONNECTOR (zero_or_one)
SMTP_EXPIRATION_TIME (int)
SMTP_VERIFICATION_TIME (int)
SMTP_ADMIN (str | None)
SMTP_NOREPLY (str | None)
SMTP_REPLYTO (str | None)
SMTP_HOST (str | None)
SMTP_PORT (int)
SMTP_USERNAME (str | None)
SMTP_PASSWORD (str | None)
SMTP_SERVER_HOST (str)
SMTP_SERVER_PORT (int)
FRONTEND_URL (str)
FRONTEND_PREFIX (str)
ALLOW_PASSWORD_RESET (zero_or_one)
ALLOW_REGISTRATION (zero_or_one)
ALLOW_TERMS_OF_USE (zero_or_one)
REGISTRATION_NOTIFICATIONS (zero_or_one)
SENTRY_URL (str | None)
SHOW_LOGIN (zero_or_one)
ENABLE_FOOTER (zero_or_one)
ENABLE_ANGULAR_SSR (zero_or_one)
ENABLE_YARN_PNP (zero_or_one)
ENABLE_ANGULAR_MULTI_LANGUAGE (zero_or_one)
FORCE_SSR_SERVER_MODE (zero_or_one)
SPINNER_TYPE (SPINNER_TYPES)
ACTIVATE_AUTH (zero_or_one)
AUTH_SERVICE (AUTH_SERVICE_VALUES)
AUTH_DEFAULT_USERNAME (str)
AUTH_DEFAULT_PASSWORD (str)
AUTH_MIN_PASSWORD_LENGTH (int)
AUTH_FORCE_FIRST_PASSWORD_CHANGE (zero_or_one)
AUTH_MAX_PASSWORD_VALIDITY (int)
AUTH_DISABLE_UNUSED_CREDENTIALS_AFTER (int)
AUTH_MAX_LOGIN_ATTEMPTS (int)
AUTH_LOGIN_BAN_TIME (int)
AUTH_SECOND_FACTOR_AUTHENTICATION (zero_or_one)
AUTH_TOTP_VALIDITY_WINDOW (int)
AUTH_JWT_TOKEN_TTL (int)
AUTH_TOKEN_SAVE_FREQUENCY (int)
AUTH_TOKEN_IP_GRACE_PERIOD (int)
ALLOW_ACCESS_TOKEN_PARAMETER (zero_or_one)
DEFAULT_DHLEN (int)
PASSWORD_EXPIRATION_WARNING (int)
FORCE_PRODUCTION_TESTS (zero_or_one)
- __init__(**data)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- Parameters:
data (
Any)- Return type:
None
Methods
__init__(**data)Create a new model by parsing and validating input data from keyword arguments.
construct([_fields_set])- param _fields_set:
copy(*[, include, exclude, update, deep])Returns a copy of the model.
dict(*[, include, exclude, by_alias, ...])- param include:
from_orm(obj)- param obj:
json(*[, include, exclude, by_alias, ...])- param include:
model_construct([_fields_set])Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])Usage docs: https://docs.pydantic.dev/2.7/concepts/serialization/#model_copy
model_dump(*[, mode, include, exclude, ...])Usage docs: https://docs.pydantic.dev/2.7/concepts/serialization/#modelmodel_dump
model_dump_json(*[, indent, include, ...])Usage docs: https://docs.pydantic.dev/2.7/concepts/serialization/#modelmodel_dump_json
model_json_schema([by_alias, ref_template, ...])Generates a JSON schema for a model class.
model_parametrized_name(params)Compute the class name for parametrizations of generic classes.
model_post_init(_BaseModel__context)Override this method to perform additional initialization after __init__ and model_construct.
model_rebuild(*[, force, raise_errors, ...])Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, ...])Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])Usage docs: https://docs.pydantic.dev/2.7/concepts/json/#json-parsing
model_validate_strings(obj, *[, strict, context])Validate the given object contains string data against the Pydantic model.
parse_file(path, *[, content_type, ...])- param path:
parse_obj(obj)- param obj:
parse_raw(b, *[, content_type, encoding, ...])- param b:
schema([by_alias, ref_template])- param by_alias:
schema_json(*[, by_alias, ref_template])- param by_alias:
update_forward_refs(**localns)- param localns:
validate(value)- param value:
Attributes
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
Get extra fields set during validation.
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
Returns the set of fields that have been explicitly set on this model instance.