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

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

Required Components

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

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

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

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

Instance Sizes

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

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

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

Application Server Instances

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

Database Server Instances

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

FastComments довольно бережно относится к Mongo: для горячих запросов используются подсказки индекса (index hints), стриминговые курсоры и имеются лимиты конкурентности в различных областях, чтобы предотвратить перегрузку 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. Это, конечно, делает узлы приложения сохраняющими состояние, однако это состояние может быть утрачено в любой момент без нарушения работы приложения.

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

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

The front end code snippets and libraries for On-Prem are the same as the SaaS product. However, you must specify apiHost and the correct script path:

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

Copy

1

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

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

4<script>

5 FastCommentsUI(document.getElementById('fastcomments-widget'), {

6 tenantId: "demo",

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

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

9 });

10</script>

11

The above is a very simple example. We could also use the 1st-party React, Angular, Vue, Svelte, etc, libraries.

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

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

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

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