diff --git a/README.md b/README.md index d2145e5..6833191 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 1. Создать бота в Telegram (см. инструкцию по [ссылке](https://sendpulse.com/ru/knowledge-base/chatbot/telegram/create-telegram-chatbot)) 2. Склонировать репозиторий 3. В папке репозитория создать файл с названием `.env ` -4. Скопировать в файл `.env` информацию из файла `env_file` +4. Скопировать в файл `.env` информацию из файла `env_file`. [Подробнее о параметрах `.env`](env_parameters.md). 5. Заменить в файле `.env` `PasteYourTelegramToken` на токен созданного бота в Telegram 6. Установить режим отладки бота (в `.env` указать `DEBUG=true` или `DEBUG=false`) 7. В терминале в папке репозитория выполнить команды: diff --git a/env_parameters.md b/env_parameters.md new file mode 100644 index 0000000..1941327 --- /dev/null +++ b/env_parameters.md @@ -0,0 +1,21 @@ +# Параметры .env + +| Параметр | Описание | Пример значения | +|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------| +| `TELEGRAM_TOKEN` | Строка, которая необходима для авторизации бота и отправки запросов к Telegram API. | `123456789:ABCDEF1234567890abcdef1234567890` | +| `MONGO_INITDB_ROOT_USERNAME` | Имя пользователя для доступа к MongoDB. Используется для установки аутентификации при инициализации базы данных. | `admin` | +| `MONGO_INITDB_ROOT_PASSWORD` | Пароль для пользователя MongoDB, указанного в параметре `MONGO_INITDB_ROOT_USERNAME`. | `password123` | +| `ADMIN` | Уникальный идентификатор администратора (например, идентификатор пользователя в Telegram), которому предоставлены расширенные права доступа. | `123456789` | +| `DEBUG_MODE` | Режим отладки (`true`, `false`). При значении `true` система будет работать в режиме отладки, выводя дополнительные сообщения и логи. | `true` | +| `NUMBER_OF_THREADS` | Количество потоков для обработки речи. Количество потоков от 1 до количества ядер процессора сервера. | `4` | +| `LANGUAGE` | Язык синтеза речи(`ru`, `uk`). | `ru` | +| `SAMPLE_RATE` | Частота дискретизации. Возможные значения: 48000, 24000, 8000. | `48000` | +| `SPEAKER` | Имя голосового модуля (спикера), который будет использоваться для озвучивания сообщений. (`ru` - `aidar` `baya` `kseniya` `xenia` `eugene` `random`; `uk` - `mykyta` `random`) | `baya` | +| `ASR_ENGINE` | Движок автоматического распознавания речи (ASR), который будет использоваться для обработки голосовых данных. | `openai_whisper` | +| `ASR_MODEL` | Модель распознавания речи, которая будет использоваться движком ASR. Модели могут отличаться по точности и скорости обработки (`tiny`, `base`, `small`, `medium`, `large` (only OpenAI Whisper), `large-v1`, `large-v2`, `large-v3`). | `base` | +| `KAFKA_ZOOKEEPER_CONNECT` | Адрес, который указывает Kafka, как связаться с ZooKeeper. | `zookeeper:2181` | +| `KAFKA_CREATE_TOPICS` | Список топиков, которые необходимо создать при запуске Kafka, с указанием количества партиций и реплик для каждой темы. | `stt:1:1,tts:1:1` | +| `KAFKA_LISTENERS` | Адреса и протоколы, которые Kafka будет использовать для прослушивания входящих соединений. | `INTERNAL://0.0.0.0:9092,OUTSIDE://0.0.0.0:9094` | +| `KAFKA_ADVERTISED_LISTENERS` | Адреса и протоколы, который клиенты должны использовать для подключения к брокеру Kafka. | `INTERNAL://kafka:9092,OUTSIDE://localhost:9094` | +| `KAFKA_LISTENER_SECURITY_PROTOCOL_MAP` | Пары ключ/значение соответствия между именами слушателей и протоколами безопасности, которые они используют. | `INTERNAL:PLAINTEXT,OUTSIDE:PLAINTEXT` | +| `KAFKA_INTER_BROKER_LISTENER_NAME` | Имя слушателя, используемого для внутреннего общения между брокерами Kafka. | `INTERNAL` |