FastComments On Prem 允許您部署我們的即時留言解決方案，包含所有的審核與管理工具， 在您自己的硬體上。

這意味著您可以掌控您的資料，且留言系統可以限制在您本地區域網路或企業網路內。

Required Components

For On-Prem, FastComments just consists of an application server and a database. We have simplified the deployment so that the application can serve all traffic directly without adding other components.

The application server is provided in a Docker image and can be deployed with any container management solution.

The database, MongoDB, can be self-ran or hosted by another provider like AWS DocumentDB or MongoDB Atlas.

FastComments is currently tested with MongoDB 7, however we aim to be DocumentDB compatible to ease deployment.

Instance Sizes

You will find that FastComments is fairly well optimized and doesn't require large machines for the application itself to keep low P99s.

All batch and cron jobs use streaming to limit total memory usage.

The below tables for the application server and database can assist with sizing.

Application Server Instances

For example, a single core serving around 100 comment threads a second usually never uses more than 250mb RSS.

Database Server Instances

Sizing the database depends on working set size, which is the amount of data you access at a given point in time, as well as concurrent requests.

FastComments is fairly kind to Mongo, in that for the hot queries it uses index hints, streaming cursors, and has concurrency limits in various areas to prevent overloading of downstream systems.

The below is a general guideline on database instance sizes. Note that this is per instance, not total resources in the cluster.

The above tables are conservative estimates. You may find actual requirements differ based on your specific configuration (page sizes, comment volume, etc).

FastComments 使用環境變數來進行設定。以下列出所有與 On-Prem 相關且支援的變數。

請注意，所有與網域相關的變數都使用 _HOST 或 _ADDR 後綴。兩者的差別為：

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

The EMAIL_CONFIG_PATH should contain a path to a JSON file with the following example format:

電子郵件設定

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

在上方範例中，我們定義了一個名為 mailgun 的預設 SMTP 電子郵件傳輸。我們也定義了一個專門用於 @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 並使用正確的腳本路徑：

內部部署評論程式碼

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

上述是一個非常簡單的範例。我們也可以使用官方第一方的 React、Angular、Vue、Svelte 等函式庫。

API 可以像一般的 SaaS 產品一樣存取，您會登入 On-Prem 儀表板來建立 API 金鑰，並使用這些金鑰來存取 API。API 端點在 on-prem 與 SaaS 產品相同。

您的 On-Prem FastComments 安裝可以為多個內部網域提供留言功能，例如 app.mycorp.org 和 hr.mycorp.org。您可以分別為這些 進行設定，但可透過建立個別的自訂規則（Customization Rules）在同一個 On-Prem 設定中託管它們，並配置它們各自的行為。

預設情況下，FastComments 假定評論串為公開。要增加一層安全性，建議建立一個自訂規則並勾選 Requires SSO 選項。這將導致所有與評論相關的端點需要 SSO 身份驗證。