Настройка сервера

Подключение SMTP-сервера

SMTP-сервер необходим для рассылки уведомлений и писем с ссылками для входа по электронной почте.

В файле backend.env необходимо указать следующие переменные окружения:

SMTP_HOST // адрес сервера
SMTP_PORT // порт сервера. Обычно 25, 587 или 465. Номер порта зависит от типа защищенного соединения
SMTP_USERNAME // имя пользователя
SMTP_PASSWORD // пароль пользователя
SMTP_TLS_ENABLED // использовать ли TLS при подключении 

API и Secret ключи

SMTP-сервер необходим для рассылки уведомлений и писем с ссылками для входа по электронной почте.

В файле backend.env необходимо указать следующие переменные окружения:

YACLOUD_API_KEY // используется для Yandex AI - Speechkit и YandexGPT
JWT_SHARED_SECRET // используется для кодирования jwt токенов пользователей, random string

Настройка APNS

Сервис Apple Push Notification System используется для рассылки оповещений пользователям YuChat на устройства с IOS.

Для корректной работы необходимо получить ключ в Apple.

Регистрация в Apple Developer Program

Чтобы получить доступ к APNs, вам необходимо быть членом Apple Developer Program. Если вы ещё не зарегистрированы, посетите официальный сайт Apple Developer и следуйте инструкциям для регистрации.

Доступ к Apple Developer Center

После регистрации или входа в свой аккаунт Apple Developer перейдите на Apple Developer Center.

Переход в Certificates, Identifiers & Profiles

В Apple Developer Center выберите раздел "Certificates, Identifiers & Profiles". Это централизованный интерфейс для управления сертификатами, идентификаторами приложений, профилями разработки и другими важными аспектами разработки под iOS и macOS.

Создание Certificate Signing Request (CSR)

На вашем Mac откройте приложение "Keychain Access" (Связка ключей).

Выберите в меню "Keychain Access" > "Certificate Assistant" > "Request a Certificate from a Certificate Authority".

Введите ваш адрес электронной почты и имя для сертификата, затем выберите "Saved to disk" и следуйте инструкциям для создания CSR.

Создание нового сертификата APNs в Apple Developer Center

Вернитесь в раздел "Certificates, Identifiers & Profiles" и выберите "Identifiers".

Найдите и выберите ваше приложение, для которого вы хотите настроить APNs.

В разделе Push Notifications следуйте инструкциям для создания нового сертификата APNs, используя созданный ранее CSR файл.

Загрузка и завершение создания сертификата

Загрузите CSR файл в Apple Developer Center. После обработки вашего запроса, Apple предоставит возможность скачать новый сертификат APNs.

Скачайте и сохраните сертификат

Далее укажите полученные данные в конфигурационном файле backend-config.yml:

apns:
  MACOS:
    app-id: "" #
    voip-app-id: ""
    key-id: ""
    team-id: ""
    signing-key-file-path: "AuthKey.p8"
    host-type: PRODUCTION
  IOS:
    app-id: ""
    voip-app-id: ""
    key-id: ""
    team-id: ""
    signing-key-file-path: "AuthKey.p8"
    host-type: PRODUCTION

Настройка FCM

Сервис FCM используется для рассылки оповещений пользователям YuChat на устройства с Android. Для настройки воспользуйтесь следующей инструкцией:

Перейти на сайт Firebase Console

Откройте браузер и перейдите на Firebase Console. Это официальная платформа для управления всеми сервисами Firebase, включая Cloud Messaging.

Вход в аккаунт Google

Если вы еще не вошли в свой аккаунт Google, вам будет предложено это сделать. Firebase требует Google-аккаунт для аутентификации.

Создание нового проекта

Нажмите на кнопку "Добавить проект" или "Create project" (в зависимости от языка интерфейса).

Введите название проекта. Это имя будет использоваться для идентификации вашего проекта в Firebase.

Примите условия Firebase, если это требуется.

Настройка проекта

Выберите страну/регион вашей организации. Это важно для соответствия местным законам о данных.

Определите, хотите ли вы включить или отключить Google Analytics для вашего проекта. Google Analytics предоставляет дополнительные аналитические возможности, но это необязательно для использования FCM.

Создание проекта

После заполнения всех необходимых данных нажмите на кнопку "Создать проект" или "Create project". Этот процесс может занять несколько минут.

После завершения создания проекта вы будете перенаправлены на страницу обзора проекта.

Получение Web API Key

В обзоре проекта найдите и скопируйте ваш Web API Key.

Этот ключ необходим для идентификации вашего сервера при обращении к сервисам Firebase, включая FCM.

Сохраните ключ в рабочей директории под именем fcm_key.json.

Эксплуатация сервера

Сервисы поддерживают экспорт журналов и статистических данных во внешние системы хранения и просмотра (Prometheus, Grafana / ElasticSearch, Kibana). Пакет поставки по умолчанию включает в себя Prometheus/Grafana. При наличии собственной инфраструктуры и необходимостью интеграции обратитесь к разработчику за консультациями.