我想控制我的服务器 (IWTCMS)

我想控制我的服务器 (IWTCMS)

简单的Minecraft模组,可让你连接到你的服务器并进行控制

管理

我想控制我的服务器

或者就叫 IWTCMS

简单的 Minecraft 模组,允许你连接到你的服务器并控制它

迷你文档结构:

关于客户端

关于 SSL

关于用户

关于 Api


客户端

返回顶部

 

官方 IWTCMS CLI 客户端

要启动官方客户端,请输入:python iwtcms_client.py --help

由 AXCWG 制作的非官方 IWTCMS GUI 客户端

 

如果你在浏览器中访问服务器主页,也可以下载官方客户端 Main Page

SSL

返回顶部

 

我不会在这里告诉你如何生成证书,我只会告诉你如何在 IWTCMS 中使用它。我们简短地说

在配置文件中,我们有 ssl 部分:

// 其他设置

# 在此处阅读有关设置 ssl 的更多信息:https://modrinth.com/mod/i-want-to-control-my-server
ssl {
  # use SSL:为嵌入式服务器启用 SSL,客户端必须使用 SSL 连接,否则无法发送/接收任何数据。默认情况下它是禁用的(false),但强烈建议启用(true)并设置 SSL 连接。
  use SSL = false // boolean
  # custom Sertificate:如果启用,IWTCMS 将不会生成新证书,而是从 config/iwtcms/keystore.jks 读取证书
  custom Sertificate = false // boolean
  # 实际上我不知道这玩意儿是干嘛的,但必须在这里输入别名。通常你用它来为自定义生成的证书指定别名。默认是 "iwtcms"。你可以在这里阅读更多:https://security.stackexchange.com/questions/123944/what-is-the-purpose-role-of-the-alias-attribute-in-java-keystore-files
  ssl Alias = "iwtcms" // string
  # sslPass:证书的密码,证书将使用此密码自动生成,或者如果你使用其他证书,它将使用该密码来读取它。
  ssl Pass = "keystorePassword" // string
}

// 其他设置

事实上,注释里已经写得很清楚了,但我想补充:

use SSL - 我总是建议启用它,即使你没有生成证书,如果 custom Sertificate 已禁用,IWTCMS 将在每次启动时生成新证书,SSL 应该可以正常工作。

顺便说一句,如果启用了 use SSL,非 SSL 连接将完全禁用,你无法连接到它。 使用 https:// 代替 http://,使用 wss:// 代替 ws://

 

custom Sertificate - 只是禁用证书自动生成,而是从 config/iwtcms/keystore.jks 读取证书

 

ssl Alias 和 ssl Pass 必须与生成的证书中的别名和密码匹配


用户

返回顶部

 

IWTCMS 支持用户配置,非常简单但有用

// 其他设置

auth {
  # useAuthentication:为客户端启用密码,客户端在登录之前无法接收/发送来自/到服务器的消息。默认情况下它是禁用的(false),但强烈建议启用(true)密码。
  use Authentication = false // boolean

  # 仅当 useAuthentication 启用时才需要
  # 在这里你可以配置用户
  # 你可以添加自定义用户或删除现有用户
  users : [ // 列表
    {
      # 匿名
      name : anonymous // string # 如果你想保留匿名用户的权限,请不要更改
      # password : anonymous # 无关紧要
      permits : {
        read real time logs : false // boolean
        read logs history : false // boolean
        execute commands : false // boolean
      }
    }
    {
      # 管理员
      name : admin // string
      password : iwtcms // string
      permits : {
        read real time logs : true // boolean
        read logs history : true // boolean
        execute commands : true // boolean
      }
    }
    {
      # 访客
      name : guest // string
      password : guest // string
      permits : {
        read real time logs : true // boolean
        read logs history : false // boolean
        execute commands : false // boolean
      }
    }
  ]
}

// 其他设置

配置中的 auth 块负责所有身份验证

use Authentication - 启用身份验证,如果禁用,任何人都可以连接、监听、发送命令,以及使用 IWTCMS 对服务器做任何其他事情。

 

users - 所有用户的列表,用户数量没有限制

每个用户都有自己的权限,False 禁止该用户执行操作,True 允许执行操作。

如果任何权限未定义,IWTCMS 将使用匿名用户的对应权限。

如果匿名用户或匿名权限不存在,则遵循此模式:未定义?- 禁止

如果用户在没有 cookie(未登录)的情况下发出请求,则使用匿名用户的权限。

匿名用户不需要密码,如果他的密码存在,IWTCMS 将忽略此密码。


Api

返回顶部

 

Api 的锚点:

有趣的事实:IWTCMS 遵循 REST API,酷吧?

https://127.0.0.1/apiList | ApiListGET

https://127.0.0.1/api/logsHistory | LogsHistoryGET

https://127.0.0.1/api/login | LoginPOST

https://127.0.0.1/api/permits/{username} | PermitsGET

wss://127.0.0.1/ws/console | WsConsole

静态文件

这部分文档是为想要编写自己客户端的开发者编写的

顺便说一句,如果你编写了很酷的客户端,你可以打开 issue进行推广, 如果你的客户端运行良好,你的客户端可以作为客户端或示例代码添加到关于客户端中

顺便说一句 2 如果你需要客户端示例 请查看关于客户端和官方 IWTCMS CLI 客户端 (用 python 编写)

该死的 API(我已经厌倦了写这个文档,但我仍然需要写一整章关于 Api 的内容)

这里作为示例,我将使用已启用的 SSL 和端口为 25566 的 localhost(127.0.0.1:25566), 将 127.0.0.1 替换为你的 IP,将 25566 替换为你的端口,并为相应的协议使用适当的前缀 (参见关于 SSL)

让我们开始:

如果你想查看所有可用的请求页面(以及 websocket),请前往:

https://127.0.0.1/apiList

我建议在这里找到你客户端中的链接,页面名称不太可能更改, 但 URL 可能会更改(抱歉,但 IWTCMS 仍在开发中)

页面名称 类型 响应类型 使用 auth api(需要 cookie)? 需要 body
ApiListGET GET JSON 否 否

 

如果你想查看自服务器启动以来的所有日志历史,请前往:

https://127.0.0.1/api/logsHistory

返回自服务器启动以来的所有日志列表

页面名称 类型 响应类型 使用 auth api(需要 cookie)? 需要 body
LogsHistoryGET GET JSON 是 否

 

如果你想登录,请前往:

https://127.0.0.1/api/login

将包含用户名和密码的 JSON 放入请求 body 中并登录

body 示例:

{
    "username": "guest",
    "password": "guest"
}
页面名称 类型 响应类型 使用 auth api(需要 cookie)? 需要 body
LoginPOST POST 纯文本(登录成功 / 登录失败) 否(设置 cookie) 是

 

如果你想查看用户的所有权限,请前往:

https://127.0.0.1/api/permits/{username}

将 "{username}" 替换为你想要了解其权限的用户名

页面名称 类型 响应类型 使用 auth api(需要 cookie)? 需要 body
PermitsGET GET JSON 否 否

 

如果你想访问服务器控制台,请前往:

wss://127.0.0.1/ws/console

IWTCMS 的主要功能,连接到 websocket 并获取所有日志! 如果你想执行 Minecraft 命令,请通过 websocket 将命令作为纯文本发送到服务器, 它将被 IWTCMS 执行

页面名称 类型 响应类型 使用 auth api(需要 cookie)? 需要 body
WsConsole Websocket Websocket 纯文本消息(日志) 是 否

 

静态文件

由于 IWTCMS 集成了真正的 ktor Web 服务器,它随之托管了许多静态文件,以下是它们的列表:

文件名 路径 替代路径 文件类型
style.css /style.css css
404.html /404.html 任何未找到的路径(404) html
index.html /index.html / html
favicon.ico ico
icon_clearbg.png / icon_clearbg.png png
iwtcms_client.zip /iwtcms_client.zip zip