Skip to content

Commit

Permalink
docs: add env parameters info
Browse files Browse the repository at this point in the history
  • Loading branch information
elizaveta-andreeva committed Aug 30, 2024
1 parent f2867e5 commit 128e112
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions env_parameters.md
Original file line number Diff line number Diff line change
@@ -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` система будет работать в режиме отладки, выводя дополнительные сообщения и логи. | `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` |

0 comments on commit 128e112

Please sign in to comment.