Interface IEnvConfig

Интерфейс конфигурации окружения Определяет структуру переменных окружения для приложения

Remarks

Все поля являются опциональными и могут быть определены в файле .env. loadEnvFile возвращает все переменные файла, поэтому кроме известных фреймворку полей доступны и собственные (API_TOKEN и т.п.) — через индекс.

Example

// Пример файла .env
TELEGRAM_TOKEN=123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
VK_TOKEN=vk1.a.1234567890abcdef
DB_HOST=localhost
DB_USER=root
DB_PASSWORD=secret
DB_NAME=myapp

interface IEnvConfig {
    ALISA_TOKEN?: string;
    DB_HOST?: string;
    DB_NAME?: string;
    DB_PASSWORD?: string;
    DB_USER?: string;
    MARUSIA_TOKEN?: string;
    MAX_TOKEN?: string;
    MAX_WEBHOOK_SECRET?: string;
    SMARTAPP_TOKEN?: string;
    SPEECH_KIT_TOKEN?: string;
    TELEGRAM_TOKEN?: string;
    TELEGRAM_WEBHOOK_SECRET?: string;
    VIBER_TOKEN?: string;
    VK_CONFIRMATION_TOKEN?: string;
    VK_SECRET_KEY?: string;
    VK_TOKEN?: string;
    YANDEX_TOKEN?: string;
    [name: string]: string | undefined;
}

Indexable

[name: string]: string | undefined
Собственные переменные проекта из того же файла .env
Example
```
const apiToken = loadEnvFile('.env').data?.['API_TOKEN'];
```

Index

Properties

ALISA_TOKEN? DB_HOST? DB_NAME? DB_PASSWORD? DB_USER? MARUSIA_TOKEN? MAX_TOKEN? MAX_WEBHOOK_SECRET? SMARTAPP_TOKEN? SPEECH_KIT_TOKEN? TELEGRAM_TOKEN? TELEGRAM_WEBHOOK_SECRET? VIBER_TOKEN? VK_CONFIRMATION_TOKEN? VK_SECRET_KEY? VK_TOKEN? YANDEX_TOKEN?

Properties

`Optional`ALISA_TOKEN

ALISA_TOKEN?: string

Токен для Яндекс.Диалоги (Алиса) Используется для авторизации в API Яндекс.Диалогов.

Заменяет YANDEX_TOKEN (сохранён для BC). При одновременном задании обоих приоритет у ALISA_TOKEN.

Example

ALISA_TOKEN=1234567890abcdef

`Optional`DB_HOST

DB_HOST?: string

Адрес сервера базы данных

Remarks

Может быть указан как:

localhost
IP-адрес
доменное имя

Example

DB_HOST=localhost
DB_HOST=127.0.0.1
DB_HOST=db.example.com

`Optional`DB_NAME

DB_NAME?: string

Название базы данных

Example

DB_NAME=myapp

`Optional`DB_PASSWORD

DB_PASSWORD?: string

Пароль для подключения к базе данных

Remarks

Рекомендуется использовать сложные пароли и хранить их в безопасном месте

Example

DB_PASSWORD=my_secure_password

`Optional`DB_USER

DB_USER?: string

Имя пользователя для подключения к базе данных

Example

DB_USER=root

`Optional`MARUSIA_TOKEN

MARUSIA_TOKEN?: string

Токен для Маруси Используется для авторизации в API Маруси

Example

MARUSIA_TOKEN=1234567890abcdef

`Optional`MAX_TOKEN

MAX_TOKEN?: string

Токен для Max Используется для авторизации в API MAX

Example

MAX_TOKEN=1234567890abcdef

`Optional`MAX_WEBHOOK_SECRET

MAX_WEBHOOK_SECRET?: string

Секрет вебхука MAX (secret из POST /subscriptions). Записывается в tokens.max_app.webhookSecret и включает проверку заголовка X-Max-Bot-Api-Secret. Команда npx umbot webhook max <url> генерирует его и регистрирует подписку с ним.

Example

MAX_WEBHOOK_SECRET=Hk3v...43 символа

`Optional`SMARTAPP_TOKEN

SMARTAPP_TOKEN?: string

Токен для Сбер SmartApp Используется для авторизации в API Сбер SmartApp

Example

SMARTAPP_TOKEN=1234567890abcdef

`Optional`SPEECH_KIT_TOKEN

SPEECH_KIT_TOKEN?: string

Токен Yandex SpeechKit Используется для синтеза речи (TTS) в чат-ботах: Telegram, VK и Max. Значение автоматически записывается в speech_kit_token токенов этих платформ.

Example

# API-ключ сервисного аккаунта (уходит как `Api-Key`) — рекомендуется;
# IAM-токен `t1.…` тоже принимается (уходит как `Bearer`), но живёт ≤12 ч.
SPEECH_KIT_TOKEN=AQVN...

`Optional`TELEGRAM_TOKEN

TELEGRAM_TOKEN?: string

Токен для Telegram Bot API Используется для авторизации бота в Telegram

Example

TELEGRAM_TOKEN=123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11

`Optional`TELEGRAM_WEBHOOK_SECRET

TELEGRAM_WEBHOOK_SECRET?: string

Секрет вебхука Telegram (secret_token из setWebhook). Записывается в tokens.telegram.webhookSecret и включает проверку заголовка X-Telegram-Bot-Api-Secret-Token. Команда npx umbot webhook telegram <url> генерирует его и регистрирует вебхук с ним.

Example

TELEGRAM_WEBHOOK_SECRET=Hk3v...43 символа

`Optional`VIBER_TOKEN

VIBER_TOKEN?: string

Токен для Viber API Используется для авторизации в Viber API

Example

VIBER_TOKEN=1234567890abcdef

`Optional`VK_CONFIRMATION_TOKEN

VK_CONFIRMATION_TOKEN?: string

Токен подтверждения для VK Callback API Используется для верификации запросов от VK

Example

VK_CONFIRMATION_TOKEN=abcdef123456

`Optional`VK_SECRET_KEY

VK_SECRET_KEY?: string

Секретный ключ для VK Callback API (опционально). Если включён в настройках группы VK, VK присылает поле secret в теле каждого callback-запроса. Адаптер сверяет его с этим значением для проверки подлинности запроса.

Example

VK_SECRET_KEY=abc123def456

`Optional`VK_TOKEN

VK_TOKEN?: string

Токен для VK API Используется для авторизации в VK API

Example

VK_TOKEN=vk1.a.1234567890abcdef

`Optional`YANDEX_TOKEN

YANDEX_TOKEN?: string

Токен для Яндекс.Диалоги (Алиса) Используется для авторизации в API Яндекс.Диалогов

⚠️ Deprecated: используйте ALISA_TOKEN. Этот ключ сохранён для обратной совместимости и будет удалён в следующей мажорной версии. Если заданы оба — приоритет у ALISA_TOKEN.

Deprecated

Используйте ALISA_TOKEN

Example

YANDEX_TOKEN=1234567890abcdef

Interface IEnvConfig

Remarks

Example

Indexable

Example

Index

Properties

Properties

OptionalALISA_TOKEN

Example

OptionalDB_HOST

Remarks

Example

OptionalDB_NAME

Example

OptionalDB_PASSWORD

Remarks

Example

OptionalDB_USER

Example

OptionalMARUSIA_TOKEN

Example

OptionalMAX_TOKEN

Example

OptionalMAX_WEBHOOK_SECRET

Example

OptionalSMARTAPP_TOKEN

Example

OptionalSPEECH_KIT_TOKEN

Example

OptionalTELEGRAM_TOKEN

Example

OptionalTELEGRAM_WEBHOOK_SECRET

Example

OptionalVIBER_TOKEN

Example

OptionalVK_CONFIRMATION_TOKEN

Example

OptionalVK_SECRET_KEY

Example

OptionalVK_TOKEN

Example

OptionalYANDEX_TOKEN

Deprecated

Example

Settings

On This Page

`Optional`ALISA_TOKEN

`Optional`DB_HOST

`Optional`DB_NAME

`Optional`DB_PASSWORD

`Optional`DB_USER

`Optional`MARUSIA_TOKEN

`Optional`MAX_TOKEN

`Optional`MAX_WEBHOOK_SECRET

`Optional`SMARTAPP_TOKEN

`Optional`SPEECH_KIT_TOKEN

`Optional`TELEGRAM_TOKEN

`Optional`TELEGRAM_WEBHOOK_SECRET

`Optional`VIBER_TOKEN

`Optional`VK_CONFIRMATION_TOKEN

`Optional`VK_SECRET_KEY

`Optional`VK_TOKEN

`Optional`YANDEX_TOKEN