diff --git a/README.md b/README.md new file mode 100644 index 0000000..201bd5d --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# ProxiedProxy +这个插件允许你将现有的Velocity接入另一个Velocity。 + +## 配置文件结构 +``` +- proxied-proxy + - config.toml + - TrustedEntries.json + - privateKey.pem + - publicKey.pem + - entry.json +``` + +### config.toml +``` +# 服务器角色可用选项: +# - PROXY: 接受来自上游ENTRY服务器的连接 +# - ENTRY: 将客户端连接代理到PROXY服务器或Minecraft服务器。ENTRY应当设置为legacy/bungeeguard forwarding。 +# 下游Minecraft服务器(spigot/paper/...)应做相应设置。它们不支持基于RSA/KEY的验证。 +role = "PROXY" + +# 以下选项只针对PROXY服务器 +[proxy] +# 是否允许客户端直接连接PROXY +allow-client-connection = true + +# 以下选项只针对ENTRY服务器 +[entry] +# 替换/server指令 +server-command-alias = "hub" +# 验证类型可用选项: +# - RSA: 推荐 +# - KEY +# 下游PROXY服务器需要把entry.json中的内容添加到他们的TrustedEntries.json数组中。 +# entry.json是一个方便传输的文件,直接修改它不会有任何效果。 +verification-type = "RSA" +# ENTRY服务器的ID +entry-id = "" + +[entry.key] +# 仅verification-type设置为KEY时有效 +key = "" +``` + +### TrustedEntries.json +储存PROXY服务器信任的ENTRY服务器列表。 +``` +[ + { + "id": "...", + "publicKey": "..." + }, + { + "id": "...", + "key": "..." + } +] +``` + +### PROXY设置教程 +安装本插件,将上游ENTRY的公钥/KEY添加到`TrustedEntries.json`中(注意json格式),使用`/prox reload`重新加载配置文件。