Skip to content

#155 Env parameters info #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
elizaveta-andreeva wants to merge 4 commits into
base: master
Choose a base branch
from
+22 −1
Open

#155 Env parameters info #167

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
128e112
docs: add env parameters info
elizaveta-andreeva Aug 30, 2024
fe951fc
docs: update env_parameters.md
elizaveta-andreeva Aug 30, 2024
7fbb427
docs: update env_parameters.md
elizaveta-andreeva Aug 30, 2024
1629995
docs: include reference to env_parameters.md in README
elizaveta-andreeva Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions env_parameters.md
View file
Open in desktop
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` |