Host Element Web 運行在 Nginx 上,並附有自訂 Homeserver。

若要在 Nginx 上託管自訂 Element Web 用戶端,請下載官方預先建置的 Element Web 版本,將其靜態檔案放置在您的 Web 伺服器上,設定config.jsonMatrix homeserver,然後透過 HTTPS 提供網站服務。 Nginx 本身不會執行 Element:它只提供瀏覽器應用程式文件,而應用程式則單獨連接到您的 Matrix homeserver。用戶端和 homeserver 請使用不同的主機名,例如 `<client_hostname>` 和chat.example.com` <homeserver_hostname> matrix.example.com`。

本指南假設您使用 Debian 或 Ubuntu 作業系統,並配置了具有公用 DNS 名稱的 Nginx 伺服器以及可透過 HTTPS 存取的現有 Matrix homeserver。本指南使用官方發布版本,而非開發版本。 Element 目前的專案文件將部署的 Web 應用程式描述為靜態內容,並要求進行關鍵配置和設定入口 URL 以避免快取。選擇版本或變更選項時,請務必查看發佈說明和目前設定檔。

1. 準備主機名稱和伺服器

建立一條 A 記錄,chat.example.com指向 Nginx 伺服器的公用 IPv4 位址。僅當伺服器可透過 IPv6 存取時才新增 AAAA 記錄。允許主機防火牆和雲端防火牆透過入站 TCP 連接埠 80 和 443。確認這些連接埠未被其他 Web 伺服器佔用。

安裝 Nginx 並為 Web 應用程式建立目錄:

sudo apt update
sudo apt install nginx
sudo mkdir -p /var/www/element

在另一台機器上,開啟Element Web 的官方發佈頁面,選擇一個已發佈的穩定版本。下載其預先編譯的 Web 歸檔文件,然後將該歸檔文件傳輸到伺服器。除非您打算執行預覽版軟體,否則請避免使用develop分支版本或每日建置版本進行公共服務。

2. 安裝靜態檔案並設定主伺服器

首先將發布版本壓縮包解壓縮到臨時目錄。檢查壓縮包的頂層目錄結構,然後將其中的 Web 檔案複製到該目錄/var/www/element;保持發布版本的目錄結構不變。軟體包結構可能會發生變化,因此請確保 Web檔案index.html、捆綁包i18n、設定檔以及 Nginx 的文檔根目錄指向的位置正確。

sudo mkdir -p /tmp/element-release
tar -xzf /tmp/element-web-REPLACE_WITH_RELEASE.tar.gz -C /tmp/element-release
find /tmp/element-release -maxdepth 2 -name index.html

將發佈內容複製到目標目錄時,請使用包含該目錄的檔案index.html作為來源目錄/var/www/element。如果歸檔檔案只有一個版本化的頂層目錄,請複製該目錄的內容,而不是建立額外的巢狀目錄。在新的檔案完整複製之前,請勿取代線上部署;不完整的複製可能會導致使用者缺少 JavaScript 套件。

如果歸檔文件中提供了發布版本,請將其複製到新文件config.sample.json中,然後編輯該文件。 Element 需要預設的家庭伺服器連線設定才能啟動。支援的首選格式是使用客戶端 API 的基本 URL。以下範例僅供參考;請將 URL 替換為您的 Matrix 家庭伺服器提供的實際 URL:config.jsondefault_server_config

{
  "default_server_config": {
    "m.homeserver": {
      "base_url": "https://matrix.example.com"
    }
  },
  "brand": "Example Chat"
}

Element 的設定文件也支援此功能default_server_name,它依賴 Matrix.well-known發現機制。default_server_config當您想要直接指定 homeserver URL 時,請使用此功能。請勿將密碼、存取權杖、簽署金鑰或其他機密資訊放入此公開 JSON 檔案中。此brand選項會更改一些應用程式標籤;它並非完整的白標品牌重塑。

3. 為應用程式設定 Nginx

建立一個類似這樣的 Nginx 伺服器區塊/etc/nginx/sites-available/element。如有需要,請替換網域名稱。這個簡單的配置會將 Element 作為靜態檔案提供,並將缺失的路徑傳送到index.html,同時標記所有回應以進行重新驗證。這種保守的快取策略可以避免使用者在發布後收到過時的應用程式外殼或配置;如果您的部署流程保留了 Element 所需的非快取路徑,則可以稍後調整資源快取。

server {
    listen 80;
    listen [::]:80;
    server_name chat.example.com;

    root /var/www/element;
    index index.html;

    location / {
        try_files $uri $uri/ =404;
        add_header Cache-Control "no-cache" always;
        add_header X-Frame-Options SAMEORIGIN always;
        add_header X-Content-Type-Options nosniff always;
        add_header Content-Security-Policy "frame-ancestors 'self'" always;
    }
}

Element 的網站託管說明指出,不要快取 `<head>` /config.*.json、/i18n`<body>`、/version`<body>` 或`<body> /index.html` 標籤,並建議在頁面載入時重新驗證瀏覽器。此範例適用no-cache於所有情況,可作為一個簡單的起點。它還包含 Element 推薦的安全標頭,包括框架策略和 MIME 嗅探保護。如果您已在其他地方定義了內容安全策略 (CSP),請將其合併frame-ancestors 'self'到該策略中,而不是發送相互衝突的策略。

請啟用網站並驗證 Nginx,然後再重新載入頁面:

sudo ln -s /etc/nginx/sites-available/element /etc/nginx/sites-enabled/element
sudo nginx -t
sudo systemctl reload nginx

4. 新增 HTTPS 並測試客戶端

該元素應透過 HTTPS 提供服務。 DNS 解析至此伺服器且 80 連接埠可存取後,請依照適用於您發行版的最新說明安裝 Certbot,然後使用其 Nginx 整合請求並安裝憑證。 Certbot 專案文件記錄了整個certbot --nginx流程和續約檢查;軟體包安裝因作業系統而異,因此請使用適用於您發行版的最新 Nginx 安裝說明。如果 Certbot 修改了伺服器區塊,請sudo nginx -t再次執行並確認續期已排程。

在隱私瀏覽視窗中開啟https://chat.example.comElement 登入介面。 Element 登入介面應該能夠正常加載,沒有缺少的腳本或樣式,顯示預期的 homeserver 訊息,並且瀏覽器網址列中應該顯示有效的鎖形圖示。使用測試帳戶登錄,並確認瀏覽器可以連接到 homeserver。如果登入失敗,請檢查瀏覽器開發者控制台和網路面板,查看是否有被封鎖的請求、憑證錯誤或錯誤的位址base_url。

常見的部署問題

  • 空白頁面或半載入頁面:檢查 Nginxroot是否指向包含該目錄的目錄index.html,以及捆綁包和i18n目錄是否已與其一起複製。
  • 出現了錯誤的 homeserver:請驗證 JSON 語法config.json並確認該檔案位於網站根目錄。如果您設定了特定於網域的 homeserver config.chat.example.com.json,Element 先嘗試使用該檔案config.json;因此,這些檔案不會合併。
  • 更新後使用者看到的是舊設定:請確保`<configuration> index.html`、version`<configuration> i18n`、`<configuration>` 和設定 JSON 檔案未被快取。更改 Nginx 策略後,請清除或重新驗證瀏覽器快取。
  • 登入頁面載入正常,但 API 請求失敗:請檢查 homeserver URL 是否正確、是否使用 HTTPS 協議,以及是否已配置瀏覽器訪問,包括必要的 CORS 配置。 Nginx 上的 Hosting Element 不會代理或取代 Matrix homeserver。

為了成功部署,客戶端會透過 HTTPS 協定存取自訂域名,其配置指向目標伺服器,並且測試帳戶可以正常登錄,不會出現網路請求失敗的情況。 Element 的Web 託管說明和Nginx 索引文件是本文所述靜態部署和伺服器區塊行為的主要參考資料。

留下評論

使用 Docker 將 Mjölnir 運行為 Matrix Room 管理機器人

使用 Docker 將 Mjölnir 運行為 Matrix Room 管理機器人

使用專用 Matrix 帳戶、加密管理室、Docker Compose、政策清單和權限檢查來設定 Mjölnir。

啟用原生矩陣滑動同步,加快行動端載入速度

啟用原生矩陣滑動同步,加快行動端載入速度

跳過已停用的代理,配置 Synapse 內建的滑動同步功能。檢查客戶端發現情況,然後在相容的手機上測量房間清單載入和重新連接行為。

Host Element Web 運行在 Nginx 上,並附有自訂 Homeserver。

將 Element Web 部署為靜態站點,將其指向您的 Matrix 主伺服器,新增 HTTPS,並配置 Nginx 以提供更新而不會出現過時的檔案。

在樹莓派 4 上執行輕量級矩陣家庭伺服器

在 64 位元 Raspberry Pi 4 上設定 Conduit,使其具有持久性資料、HTTPS 聯合身份驗證、受保護的註冊以及對正常工作的家庭伺服器的檢查。

在您自己的網域上設定自訂矩陣房間別名

使用 Element 或 Matrix API,在您的網域上為 Matrix 房間分配一個易於共享的地址,並檢查權限、Synapse 命名和聯合。

設定可靠的矩陣語音和視訊通話的 coturn

使用匹配的 TURN 憑證配置 coturn 和 Synapse,打開所需的中繼端口,並驗證 Matrix 用戶端是否可以取得中繼候選位址。

使用 Docker Compose 和 PostgreSQL 部署 Matrix Synapse

使用 Docker Compose 和 PostgreSQL 部署 Matrix Synapse

使用 Docker Compose、PostgreSQL、私人配置和檢查來設定持久的 Synapse 主伺服器,然後再透過 HTTPS 公開它。

自訂 Element Web 的主題和品牌

為您的 Element Web 部署設定品牌名稱、自訂色彩和登入資源,同時了解哪些部分仍保留 Element 品牌。

無需猜測即可提高 Synapse 的 Systemd 檔案限制

無需猜測即可提高 Synapse 的 Systemd 檔案限制

診斷 Synapse 是否達到其每個程序開啟檔案上限,為正確的服務或工作進程設定 systemd drop-in,並驗證即時限制。

元素顯示“解密失敗”?恢復遺失的房間鑰匙

元素顯示“解密失敗”?恢復遺失的房間鑰匙

確定錯誤是否僅限於一個瀏覽器或一個事件,然後使用 Element 的恢復金鑰或受信任的設備,而不會危及您剩餘的加密歷史記錄。