dendrite admin interface

樹突管理介面

使用管理 API 和一些資料庫介面來管理 Dendrite 伺服器的機器人介面

非常歡迎貢獻，但此時建議您在貢獻之前加入討論室，以確保您的貢獻與專案的最終目標保持一致

請隨意為每個請求的功能提出問題，這樣當我最終有時間時，我就會有一個清單可以檢查和核對。

空間：#admin-interface:pain.agency |討論室：#admin-interface-support:pain.agency

設定

• 確保您安裝了最新版本的node和npm，我目前在我的vps上使用node v18.18.0 （使用node -v檢查）和npm版本9.2.0 。如果您像我在 vps 上一樣運行 debian，您可能想要從 snap 商店或從原始程式碼建置獲取更新版本的節點。
• 從 https://github.com/jjj333-p/dendrite-admin-interface/releases 下載並解壓縮最新的穩定版或測試版 .zip 或 .tar.gz，或者如果您想處於最前沿，則可以從main分支克隆。
• 執行npm install應該安裝所有必要的依賴項。
• 將examples/login.yaml中找到的檔案複製到db/login.yaml並填寫該資訊。範例文件的註釋中有填寫該資訊的說明。
• 運行機器人（ node index.js ）。
• 指令僅在 login.yaml 檔案中定義的管理室中可用。

目前執行的命令：

• evacuate User MXID | Room ID | Room Alias> ?<--preserve | -p>

  • 當提供房間 ID 或別名時，介面會在該 roomID 或別名上執行疏散房間端點，導致該伺服器上的所有使用者離開該房間。如果未提供--preserve或-p標誌，則也會執行清除房間端點，從資料庫中清除房間狀態。
  • 當提供本機使用者的 MXID（即@localpart:your.server時，該介面將在該使用者上執行 evacuate user 端點，使該帳戶離開其所在的所有房間。

• passwd <mxid/localpart> <log out accounts?> ?<password>

  重置用戶密碼

  • mxid/localpart - 您可以提供使用者的本地部分（即jjj333 ），或整個 mxid （即@jjj333:pain.agency ）。請注意，這必須是本機用戶，因為遠端用戶無法執行任何操作。
  • log out accounts?
    • t或true登出帳戶的所有登入工作階段。
    • f或false使所有會話保持登入狀態。
  • ? password - 可以選擇設定要重設的密碼。如果未提供密碼，則預設會傳回隨機的 35 位元組 base64 字串。由於 Dendrite，密碼必須至少為 8 個字元。由於技術困難，您無法在透過此介面設定的密碼中包含任何空格。

• newaccount <mxid/localpart> ?<password>

  建立一個新的普通使用者帳戶。

  • mxid/localpart - 為使用者建立的使用者名稱。這可以是本地部分，也可以是完整的 mxid。
  • ? password - 為新帳戶設定的密碼。如果未提供，將產生並傳回 35 位元組的 Base64 字串。

• deactivate <mxid/localpart>

  停用給定用戶

  • mxid/localpart - 您可以提供使用者的本地部分（即jjj333 ），或整個 mxid （即@jjj333:pain.agency ）。請注意，這必須是本機用戶，因為遠端用戶無法執行任何操作。
  • 將顯示名稱和 pfp 設定為機器人 login.yaml 中定義的名稱，因為樹突在停用之前不會刪除這些內容，因此我們需要進行清理，同時我們可以為其添加功能。
  • 會要求確認以防止意外運行
  • 注意：該命令是永久性的，請謹慎使用！