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

Це означає, що ви маєте контроль над своїми даними, і систему коментування можна обмежити вашою локальною LAN або корпоративною мережею.

Необхідні компоненти

Для On-Prem, FastComments складається лише з серверу застосунку та бази даних. Ми спростили розгортання так, щоб застосунок міг обслуговувати весь трафік без додавання інших компонентів.

Сервер застосунку постачається у Docker image і може бути розгорнутий з будь-яким рішенням для керування контейнерами.

Базу даних, MongoDB, можна запускати самостійно або використовувати хостинг від іншого провайдера, наприклад AWS DocumentDB або MongoDB Atlas.

FastComments наразі тестується з MongoDB 7, проте ми прагнемо забезпечити сумісність з DocumentDB для полегшення розгортання.

Розміри інстансів

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

Усі пакетні та cron-завдання використовують потокову обробку, щоб обмежити загальне використання пам'яті.

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

Інстанси серверу застосунку

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

Інстанси серверу бази даних

Визначення розміру бази даних залежить від розміру робочого набору (working set) — кількості даних, до яких ви звертаєтесь у певний момент часу, а також від одночасних запитів.

FastComments досить «дружній» до Mongo: для гарячих запитів він використовує index hints, streaming cursors і має concurrency limits у різних ділянках, щоб запобігти перевантаженню підсистем.

Нижченаведене — загальна орієнтовна таблиця розмірів інстансів бази даних. Зверніть увагу, що це на один інстанс, а не загальні ресурси кластера.

Вищенаведені таблиці — консервативні оцінки. Ви можете виявити, що фактичні вимоги відрізняються в залежності від вашої конкретної конфігурації (розміри сторінок, обсяг коментарів тощо).

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 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 // ... can also pass SSO payload etc.

9 });

10</script>

11

Вищенаведений приклад — дуже простий. Ми також можемо використовувати офіційні бібліотеки для 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 вважає, що треди коментарів є публічними. Щоб додати рівень безпеки, рекомендується створити правило налаштувань з Requires SSO опцією, встановленою. Це спричинить, що всі кінцеві точки, пов'язані з коментарями, вимагатимуть аутентифікації SSO.