FastComments On Prem позволяет развернуть наше решение для живых комментариев, включая все инструменты модерации и администрирования, на вашем собственном оборудовании.

Это означает, что вы контролируете свои данные, и систему комментариев можно ограничить вашей локальной сетью (LAN) или корпоративной сетью.

Требуемые компоненты

Для On-Prem, FastComments состоит только из сервера приложения и базы данных. Мы упростили развёртывание так, чтобы приложение могло обслуживать весь трафик напрямую без добавления других компонентов.

Сервер приложения предоставляется в Docker-образе и может быть развернут с любой системой управления контейнерами.

База данных, MongoDB, может запускаться самостоятельно или размещаться у другого провайдера, такого как AWS DocumentDB или MongoDB Atlas.

FastComments в настоящее время тестируется с MongoDB 7, однако мы стремимся обеспечить совместимость с DocumentDB для упрощения развёртывания.

Размеры инстансов

Вы увидите, что FastComments довольно хорошо оптимизирован и не требует больших машин для самого приложения, чтобы поддерживать низкие P99s.

Все пакетные и cron-задачи используют потоковую обработку, чтобы ограничить общее потребление памяти.

Ниже приведённые таблицы для сервера приложения и базы данных помогут с подбором размеров.

Экземпляры сервера приложения

Например, одно ядро, обслуживающее около 100 веток комментариев в секунду, обычно не использует более 250mb RSS.

Экземпляры сервера базы данных

Размер базы данных зависит от размера рабочего набора, то есть объёма данных, к которым вы обращаетесь в определённый момент времени, а также от количества одновременных запросов.

FastComments довольно бережно относится к Mongo: для «горячих» запросов он использует подсказки индекса, потоковые курсоры и имеет ограничения параллелизма в различных областях, чтобы предотвратить перегрузку downstream-систем.

Ниже приведена общая рекомендация по размерам экземпляров базы данных. Обратите внимание, что это на экземпляр, а не суммарные ресурсы в кластере.

Приведённые выше таблицы — консервативные оценки. Вы можете обнаружить, что фактические требования отличаются в зависимости от вашей конкретной конфигурации (размеры страниц, объём комментариев и т. п.).

FastComments использует переменные окружения для конфигурации. Ниже приведён список всех поддерживаемых переменных, имеющих отношение к On-Prem.

Обратите внимание, что все переменные, связанные с доменом, используют постфикс _HOST или _ADDR. Разница:

• _HOST: example.com
• _ADDR: https://example.com

Параметр EMAIL_CONFIG_PATH должен содержать путь к JSON-файлу со следующим примером формата:

Конфигурация электронной почты

Copy

1

2{

3 "defaultDKIM": {

4 "domainName": "mycompany.org",

5 "keySelector": "2024",

6 "privateKey": "-----BEGIN PRIVATE KEY-----\nABCDEFG\n-----END PRIVATE KEY-----"

7 },

8 "providerTransports": {

9 "yahoo.com": "specialTransport"

10 },

11 "defaultTransport": "mailgun",

12 "transports": {

13 "mailgun": {

14 "host": "smtp.mailgun.org",

15 "port": 587,

16 "secure": false,

17 "auth": {

18 "user": "admin@somewhere.com",

19 "pass": "password"

20 },

21 "tls": {

22 "ciphers": "SSLv3"

23 }

24 },

25 "specialTransport": {

26 "host": "smtp.someplace.org",

27 "port": 587,

28 "secure": false,

29 "auth": {

30 "user": "admin@example.com",

31 "pass": "password"

32 },

33 "tls": {

34 "ciphers": "SSLv3"

35 }

36 }

37 }

38}

39

В приведённом выше примере мы определяем транспорт по умолчанию SMTP с названием mailgun. Также мы определяем специальный транспорт, который используем конкретно для писем @yahoo.com. В некоторых сценариях бывает целесообразно использовать конкретного провайдера или исходный IP для домена, чтобы настроить доставку. Это опционально.

DocumentDB

При подключении к DocumentDB рекомендуется указать MONGO_ENABLE_SSL=true MONGO_SSL_CA=/some/path.pem, чтобы быть совместимым с настройками по умолчанию.

FastComments поддерживает автоматический режим обслуживания. Если база данных выйдет из строя, он может продолжать обслуживать популярные ветки комментариев.

Кроме того, в режиме обслуживания все комментарии сохраняются в BACKUP_DIR. Они будут обработаны (проверены на спам и т.д.) и сохранены после восстановления системы.

Это делается следующим образом: каждый час определяется топ-100 самых популярных веток комментариев и их содержимое кэшируется на диске. Определение топ-100 веток выполняется уже на основе предварительно вычисленного состояния, поэтому это не тяжёлая периодическая задача.

Это полностью опционально и включается только если установлены CACHE_DIR и BACKUP_DIR. Это, разумеется, делает узлы приложения сохраняющими состояние, однако это состояние может быть утрачено в любой момент без нарушения работы приложения.

Обратите внимание, что в режиме обслуживания корректная аутентификация веток комментариев невозможна, поэтому периодически резервируются только те ветки, которые с уверенностью считаются публичными.

В режиме обслуживания многие функции недоступны.

Фрагменты кода фронтенда и библиотеки для On-Prem такие же, как и для SaaS-продукта. Однако вы должны указать apiHost и корректный путь к скрипту:

Код комментариев для On-Prem

Copy

1

2<script async src="https://my.host.com/js/embed-v2-async.min.js"></script>

3<div id="fastcomments-widget"></div>

4<script>

5 window.fcConfigs = [{

6 target: '#fastcomments-widget',

7 tenantId: "demo",

8 apiHost: "https://my.host.com"

9 // ... также можно передать полезную нагрузку SSO и т.д.

10 }];

11</script>

12

Выше показан очень простой пример. Также мы можем использовать официальные библиотеки для React, Angular, Vue, Svelte и т.д.

К API можно получить доступ так же, как и к обычному SaaS-продукту: вы входите в панель управления On-Prem, чтобы создать API-ключи и использовать эти ключи для доступа к API. Конечные точки API on-prem такие же, как и для SaaS-продукта.

Ваша локальная (On-Prem) установка FastComments может обслуживать комментарии для нескольких внутренних доменов, например app.mycorp.org и hr.mycorp.org. Вы можете настроить их отдельно, но разместить их на одной On-Prem установке, создав отдельные Customization Rules для настройки их индивидуального поведения.

По умолчанию FastComments предполагает, что потоки комментариев являются общедоступными. Чтобы повысить уровень безопасности, рекомендуется создать правило настройки (Customization Rule) с включенной опцией Requires SSO.

Это приведёт к тому, что все конечные точки, связанные с комментариями, будут требовать аутентификацию SSO.