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 中定义的内容，因为树突在停用之前不会删除这些内容，因此我们需要进行清理，同时我们可以为其添加功能。
  • 会要求确认以防止意外运行
  • 注意：该命令是永久性的，请谨慎使用！