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

如果 Matrix 的管理分散在各個個人帳戶和聊天室中,可以將 Mjölnir 作為專用機器人運行,並為版主提供一個用於發布命令的私人管理聊天室。最簡單的自架方案使用 Docker Compose、獨立的 Matrix 帳戶和一個加密的管理聊天室;然後新增 Mjölnir 需要保護的社群聊天室,並驗證其權限。

雷神之鎚的作用——以及它需要什麼

Mjölnir 是一個 Matrix 管理機器人,它以獨立帳戶的形式應用策略清單和執行管理操作。主伺服器是託管使用者帳戶和房間的 Matrix 伺服器。管理房間是授權版主發布機器人指令的私密房間。受保護房間是 Mjölnir 監控並且可以進行管理的房間。

本指南要求您擁有主伺服器上的 Matrix 帳戶存取權、建立機器人帳戶和房間的權限,以及安裝了 Docker Engine 和 Docker Compose 外掛程式的主機。對於普通的房間管理,您無需將 Mjölnir 設定為主伺服器管理員。某些伺服器級操作(例如停用使用者或關閉房間)需要 Synapse 主伺服器和伺服器管理員權限;除非您的使用場景需要,否則請忽略這些權限。請參閱Mjölnir 專案的官方程式​​碼庫。

1. 建立一個機器人帳號和一個私人控制室

註冊一個專用帳戶,例如@mjolnir:example.org在您的主伺服器上。不要使用版主的個人帳戶:使用不同的憑證可以更方便地輪換存取權限,並確保機器人操作的獨立性。為版主創建一個私密房間,啟用端對端加密,並邀請人類版主和機器人加入。會員資格僅限您信任的人員。配置好的管理房間中的任何人都可以發出命令,而 Mjölnir 在該房間內不提供更細粒度的命令權限控制。

請在單獨的瀏覽器設定檔或隱私視窗中以機器人登入,並透過 Element 的「幫助與關於」設定來取得其 Matrix 存取權杖。將令牌安全地複製到您的配置中。關閉該瀏覽器窗口,但不要登出;登出會使令牌失效。官方設定文件建議對管理房間進行加密,並指出需要在 Mjölnir 的配置中啟用加密,以便機器人可以與 Mjölnir 通訊。

Matrix 帳戶設定表單,用於設定專用的 Mjölnir 機器人,其存取權杖已封鎖。
第一個設定任務是創建獨立的機器人身分;切勿在螢幕截圖或公共日誌中洩露其存取令牌。

2. 為您的家庭伺服器設定 Mjölnir

在 Docker 主機上,建立一個持久性資料目錄,並將專案的範例配置複製到該目錄下./mjolnir/config/production.yaml。範例檔案記錄了其他選項;請僅設定部署所需的選項。至少需要使用主伺服器的用戶端 API URL、機器人代幣、原生加密以及管理房間的 Matrix 房間 ID 或別名:

homeserverUrl: "https://matrix.example.org"
accessToken: "YOUR_BOT_ACCESS_TOKEN"
encryption:
  use: true
managementRoom: "!roomid:example.org"

請替換所有範例值。房間 ID 以 `<room_id>` 開頭!;別名以 `<alias_id>` 開頭#。請勿將matrix.to連結貼到managementRoom`<configuration_id>` 中。請將設定檔和令牌視為機密資訊:限製文件訪問,不要將其納入原始碼控制系統,也不要將其發佈在支援請求中。如果機器人無法解密管理房間,請重新檢查加密設定並確認機器人已加入房間。

以下 YAML 設定範例顯示了 homeserver URL、遮罩存取權杖、已啟用的加密以及管理房間 ID。
此範例展示了所需的設定欄位;請將範例中的伺服器、令牌和房間 ID 替換為您自己的值。

3. 啟動 Docker Compose 服務

官方 Docker 說明使用該matrixdotorg/mjolnir映像並將主機目錄掛載到指定位置。在該目錄旁邊/data建立:docker-compose.ymlmjolnir

services:
  mjolnir:
    image: matrixdotorg/mjolnir:latest
    restart: unless-stopped
    volumes:
      - ./mjolnir:/data

從該目錄啟動 Mjölnir docker compose up -d。掛載的目錄會在容器重建時保留配置和機器人資料。官方指南latest以 為範例;對於生產伺服器,請選擇您已測試過的版本標籤並記錄下來,以便進行有計劃的升級。啟動完成後docker compose logs -f --tail 100 mjolnir,請等待管理房間中顯示 Mjölnir 的啟動訊息後再進行下一步操作。

終端機顯示 Mjölnir Docker Compose 服務正在啟動,並具有持久性資料磁碟區。
從包含 Compose 檔案的目錄啟動服務,然後查看其日誌以查找啟動錯誤。

4. 建立策略清單並保護房間

在管理聊天室中詢問機器人,!mjolnir help如果機器人沒有回應,請建立包含短代碼和聊天室別名的封鎖列表,然後將其設定為預設列表:

!mjolnir list create COC code-of-conduct-ban-list
!mjolnir default COC

Mjölnir 會建立清單房間並邀請您加入。策略清單是一個包含管理規則的 Matrix 房間,因此在分享之前請檢查其可見性和成員資格。新增您希望 Mjölnir 監控的每個社區房間:

!mjolnir rooms add #community:example.org
!mjolnir verify

機器人需要在每個受保護的房間中擁有足夠的權限才能執行管理操作,通常是封鎖使用者和編輯事件。請使用房間的權限等級設置,僅授予所需的權限。該verify指令會檢查 Mjölnir 在受保護的房間中是否擁有所需的權限。在保護房間之前,請先將機器人加入房間。請勿protectAllJoinedRooms隨意設定權限:這會將保護範圍擴大到機器人加入的所有房間,從而降低逐個房間選擇權限的實用性。

加密的 Matrix 主持人房間顯示 Mjölnir 在線,並顯示建立 COC 策略清單的命令。
機器人一旦在私密管理室做出回應,就會建立一個清單並在其中測試命令。

檢查設定並避免常見錯誤

  • 機器人已上線: docker compose ps顯示服務正在運行,日誌顯示沒有重複的身份驗證或加密錯誤,並且機器人將其啟動狀態發佈到管理室。
  • 命令使用受限:!mjolnir status主持人只能在指定的房間內使用!mjolnir rules。請勿在公共房間內測試命令。
  • 房間受到保護: !mjolnir rooms列出計劃保護的房間,並!mjolnir verify報告足夠的電力水平。
  • 金鑰保持私密:令牌不會存在於公用儲存庫、shell歷史記錄或已發佈的日誌中。如果令牌洩露,請登出機器人會話並更新配置,然後再重新啟動,以此撤銷或輪換令牌。

如果機器人保持靜默,請先確認管理房間 ID 或別名是否正確,以及機器人是否已加入該房間。對於加密房間,請檢查加密是否已啟用,以及機器人是否可以解密訊息。如果僅在一個房間中審核失敗,請檢查該房間是否受到保護,以及其權限等級是否允許執行請求的操作。如需指令語法和設定選項,請參閱最新的Mjölnir 管理員指南、Docker 設定指南和範例設定。

留下評論

使用 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 的恢復金鑰或受信任的設備,而不會危及您剩餘的加密歷史記錄。