56 lines
4.9 KiB
Plaintext
56 lines
4.9 KiB
Plaintext
# ============================================================================
|
||
# workspaces-api — пример переменных окружения
|
||
#
|
||
# Скопируйте нужные строки в .env в корне репозитория workspaces-api.
|
||
# Разбор выполняется библиотекой envconfig (config/config.go, config.FromEnv).
|
||
# envconfig НЕ помечает переменные как required — процесс стартует даже без них,
|
||
# но без корректных значений БД/documentation сервис работать не будет.
|
||
# Пометка (нужна) ниже означает практическую обязательность, а не env-required.
|
||
# bool принимает 1/0, true/false, t/f.
|
||
# ============================================================================
|
||
|
||
# --- HTTP-сервер ------------------------------------------------------------
|
||
API_ADDRESS=0.0.0.0:6666 # (нужна) адрес прослушивания HTTP-сервера host:port (эндпоинт /ping)
|
||
|
||
# --- PostgreSQL -------------------------------------------------------------
|
||
POSTGRES_ADDRESS=127.0.0.1 # (нужна) хост PostgreSQL
|
||
POSTGRES_PORT=5432 # (нужна) порт PostgreSQL
|
||
POSTGRES_DB=workspaces # (нужна) имя базы данных
|
||
POSTGRES_USER=user # (нужна) пользователь БД
|
||
POSTGRES_PASSWORD=password # (нужна) пароль пользователя БД
|
||
POSTGRES_POOL_SIZE=10 # размер пула соединений (по умолчанию 0)
|
||
ENABLE_SQL_QUERY=1 # логировать SQL-запросы (по умолчанию 0)
|
||
ENABLE_SSL=0 # TLS к PostgreSQL с проверкой по YC-PG-CERTIFICATE (по умолчанию 0)
|
||
# YC-PG-CERTIFICATE= # содержимое (PEM) CA-сертификата PostgreSQL; нужно при ENABLE_SSL=1
|
||
|
||
# --- Сервис documentation ---------------------------------------------------
|
||
DOCUMENTATION_HOST=https://stage-api.sarex.io/documentation # (нужна) базовый URL сервиса documentation
|
||
DOCUMENTATION_ORIGINATOR=local_ws # идентификатор источника, передаваемый в documentation
|
||
DOCUMENTATION_LOGGER_FEATURE=1 # фича логирования обращений к documentation (по умолчанию 0)
|
||
|
||
# --- Bundles ----------------------------------------------------------------
|
||
# BUNDLES_RETRY_COUNT=5 # число ретраев клиента bundles (по умолчанию/при <=0 берётся 3)
|
||
# BUNDLES_NJOBS=5 # число параллельных задач при работе с bundles (по умолчанию/при <=0 берётся 3)
|
||
|
||
# --- Sentry -----------------------------------------------------------------
|
||
SENTRY_DSN=https://62dbe0a9ee5745eead25f2a705cb35ce@o279218.ingest.sentry.io/6229949 # DSN Sentry
|
||
SENTRY_DEBUG=0 # debug-режим Sentry (по умолчанию 0)
|
||
ENVIRONMENT=local # имя окружения (передаётся в Sentry как environment)
|
||
|
||
# --- Трейсинг OpenTelemetry (необязательно) ---------------------------------
|
||
# TRACER_USE=false # включить трейсинг и otel-логгер (по умолчанию false)
|
||
# TRACER_HOST=localhost:4317 # адрес OTLP-коллектора
|
||
# TRACER_USE_INSECURE=true # подключение без TLS (по умолчанию true)
|
||
# SERVICE_NAME=workspaces # имя сервиса в трейсах (по умолчанию workspaces)
|
||
# TRACER_LOGGER_NAME=tracer_logger # имя otel-логгера (по умолчанию tracer_logger)
|
||
|
||
# --- Вспомогательные (не читаются config.Config) ----------------------------
|
||
POSTGRES_EXTERNAL_PORT=5432 # внешний порт проброса контейнера Postgres в docker-compose
|
||
API_PORT=6666 # порт API в docker-compose (сервис api там закомментирован)
|
||
# FAKE_API_ADDRESS=0.0.0.0:7777 # адрес фейкового bundle-API (fake_bundle_api/main.go; локальная разработка/тесты)
|
||
# NAMESPACE=workspaces # задаётся в манифестах/чарте, кодом приложения не читается
|
||
# INTERNAL_PATH=/internal/ # задаётся в чарте, кодом приложения не читается
|
||
# DJANGO_HOST=... # задаётся в манифестах iac, но config.Config его НЕ читает
|
||
# DJANGO_ORIGINATOR=... # задаётся в манифестах iac, но config.Config его НЕ читает
|
||
# DJANGO_BASIC_AUTH=... # инъектируется из секрета в манифестах iac, но config.Config его НЕ читает
|