Appearance

Конфигурация сервиса Notifications ​

Логгер ​

КлючОписание
notifications.log.lvlуровень логгирования приложения
5 - debug
4 - info
3 - warning
2 - error
Пример env: POTENTIAL_NOTIFICATIONS_LOG_LVL=5
notifications.log.pathпуть до лога сервиса
Пример env: POTENTIAL_NOTIFICATIONS_LOG_PATH=/tmp/next_box/notifications.log
пример части конфигурации в yml конфиге
yaml
notifications:
  log:
    lvl: 5
    path: /tmp/next_box/notifications.log

Http сервер ​

КлючОписание
notifications.http.hostАдрес http сервера
Пример env: POTENTIAL_NOTIFICATIONS_HTTP_HOST=0.0.0.0
notifications.http.portПорт http сервера
Пример env: POTENTIAL_NOTIFICATIONS_HTTP_PORT=6004
notifications.http.max_multipart_body_sizeмаксимальный размер тела, при мультипарт запросах POTENTIAL_NOTIFICATIONS_HTTP_MAX_MULTIPART_BODY_SIZE=0
notifications.http.read_timeoutмаксимальная продолжительность чтения всего запроса, включая текст. Нулевое или отрицательное значение означает, что тайм-аута не будет. POTENTIAL_NOTIFICATIONS_HTTP_READ_TIMEOUT=3
notifications.http.write_timeoutмаксимальное время до истечения времени ожидания записи ответа. Оно сбрасывается всякий раз, когда считывается заголовок нового запроса. Как и ReadTimeout, оно не позволяет обработчикам принимать решения для каждого отдельного запроса. Нулевое или отрицательное значение означает, что тайм-аута не будет.
Пример env: POTENTIAL_NOTIFICATIONS_HTTP_WRITE_TIMEOUT=3
notifications.internal_http.mtls_enableВключение шифрование трафика mTLS между сервисами NB.
Пример env: POTENTIAL_NOTIFICATIONS_INTERNAL_HTTP_MTLS_ENABLE=false
notifications.internal_http.server_cert_key_pathПриватный ключ сервера для mTLS.
Пример env: POTENTIAL_NOTIFICATIONS_INTERNAL_HTTP_SERVER_CERT_KEY_PATH=./host.docker.internal.key
notifications.internal_http.server_cert_pathСертификат сервера для mTLS.
Пример env: POTENTIAL_NOTIFICATIONS_INTERNAL_HTTP_SERVER_CERT_PATH=./host.docker.internal.crt
notifications.internal_http.client_cert_key_pathПриватный ключ клиента для mTLS.
Пример env: POTENTIAL_NOTIFICATIONS_INTERNAL_HTTP_CLIENT_CERT_KEY_PATH=./client.key
notifications.internal_http.client_cert_pathСертификат сервера для mTLS.
Пример env: POTENTIAL_NOTIFICATIONS_INTERNAL_HTTP_CLIENT_CERT_PATH=./client.crt
notifications.internal_http.ca_cert_pathКорневой сертификат для mTLS.
Пример env: POTENTIAL_NOTIFICATIONS_INTERNAL_HTTP_CA_CERT_PATH=./cert.crt
пример части конфигурации в yml конфиге
yaml
notifications:
  http:
    host: 0.0.0.0
    max_multipart_body_size: 0
    port: 6004
    read_timeout: 0
    write_timeout: 0
  internal_http:
    ca_cert_path: ./cert.crt
    client_cert_key_path: ./client.key
    client_cert_path: ./client.crt
    mtls_enable: false
    server_cert_key_path: ./host.docker.internal.key
    server_cert_path: ./host.docker.internal.crt

База данных ​

КлючОписание
notifications.database.dsnDsn для доступа к базе данных в формате:
postgres://<login>:<password>@<address>:<port>/notifications"
login - логин базы
password - пароль от базы
address - адрес до базы
port - порт до базы
Пример env: POTENTIAL_NOTIFICATIONS_DATABASE_DSN=postgres://admin:admin@127.0.0.1:5432/notifications
пример части конфигурации в yml конфиге
yaml
notifications:
  database:
    dsn: postgres://admin:admin@127.0.0.1:5432/notifications

Общие настройки сервиса ​

КлючОписание
notifications.service.tokenТокен для межсервисного общения. Такой же токен должен быть у каждого сервиса nextbox.
Пример env: POTENTIAL_NOTIFICATIONS_SERVICE_TOKEN=qwe123
notifications.service.nameНазвание сервиса
Пример env: POTENTIAL_NOTIFICATIONS_SERVICE_NAME=Notifications
notifications.service.route_nameНазвание роута сервиса, лучше не менять, иначе возможны проблемы в общении между сервисами!
Пример env: POTENTIAL_NOTIFICATIONS_SERVICE_ROUTE_NAME=notifications
notifications.service.back_urlАдрес по которому обращаются к сервису другие сервисы NB.
Пример env: POTENTIAL_NOTIFICATIONS_SERVICE_BACK_URL=http://127.0.0.1:6004
notifications.service.instance_numberНомер сервиса. Используется для горизонтального масштабирования сервисов. В текущем сервисе не должен отличаться от 1
Пример env: POTENTIAL_NOTIFICATIONS_SERVICE_INSTANCE_NUMBER=1
notifications.discovery.urlАдрес discovery сервиса в NB. В котором регистрируются все сервисы в NB
Пример env: POTENTIAL_NOTIFICATIONS_DISCOVERY_URL=http://127.0.0.1:6001
пример части конфигурации в yml конфиге
yaml
notifications:
  service:
    back_url: http://127.0.0.1:6004
    instance_number: 1
    name: Notifications
    route_name: notifications
    token: qwe123
  discovery:
    url: http://127.0.0.1:6001

Безопасность ​

КлючОписание
notifications.tokens.sign_keyСекретный ключ для подписи авторизационных JWT токенов.
Пример env: POTENTIAL_NOTIFICATIONS_TOKENS_LIMIT_SIGN_KEY=qwe123
пример части конфигурации в yml конфиге
yaml
notifications:
  tokens:
    sign_key: qwe123

Настройки rabbitmq ​

КлючОписание
notifications.rabbit_mq.userЛогин пользователя в rabbitmq.
Пример env: POTENTIAL_NOTIFICATIONS_RABBIT_MQ_USER=guest
notifications.rabbit_mq.passwordПароль пользователя в rabbitmq.
Пример env: POTENTIAL_NOTIFICATIONS_RABBIT_MQ_PASSWORD=guest
notifications.rabbit_mq.hostАдрес сервера rabbitmq.
Пример env: POTENTIAL_NOTIFICATIONS_RABBIT_MQ_HOST=127.0.0.1
notifications.rabbit_mq.portПорт сервера rabbitmq.
Пример env: POTENTIAL_NOTIFICATIONS_RABBIT_MQ_PORT=5672
notifications.rabbit_mq.vhostvhost rabbitmq.
Пример env: POTENTIAL_NOTIFICATIONS_RABBIT_MQ_VHOST=
пример части конфигурации в yml конфиге
yaml
notifications:
  rabbit_mq:
    host: 127.0.0.1
    password: guest
    port: "5672"
    user: guest
    vhost: ""

Настройки redis ​

КлючОписание
notifications.redis.hostАдрес redis.
Пример env: POTENTIAL_NOTIFICATIONS_REDIS_HOST=127.0.0.1
notifications.redis.portПорт redis.
Пример env: POTENTIAL_NOTIFICATIONS_REDIS_PORT=6379
notifications.redis.loginЛогин redis.
Пример env: POTENTIAL_NOTIFICATIONS_REDIS_LOGIN=
notifications.redis.passwordПароль redis.
Пример env: POTENTIAL_NOTIFICATIONS_REDIS_PASSWORD=
notifications.redis.db_numНомер базы redis.
Пример env: POTENTIAL_NOTIFICATIONS_REDIS_DB_NUM=0
пример части конфигурации в yml конфиге
yaml
notifications:
  redis:
    db_num: 0
    host: 127.0.0.1
    login: ""
    password: ""
    port: 6379