itzg/rcon-hub

rcon-hub 镜像文档

镜像概述

rcon-hub 是一个提供SSH服务器的工具，用于通过RCON协议连接到已配置的游戏服务器。它允许用户通过SSH客户端访问简单的shell环境，管理和操作多个RCON连接，适用于需要集中管理游戏服务器RCON访问的场景。

核心功能与特性

• SSH服务器：提供SSH访问接口，支持密码认证
• RCON连接管理：可配置多个RCON连接，通过名称快速切换
• 灵活配置：支持YAML配置文件或环境变量两种配置方式
• 命令历史：内置命令历史记录功能，支持上下箭头访问
• 自动密钥生成：若未指定主机密钥文件，自动生成RSA私钥

配置说明

配置文件

创建名为config.yml的配置文件，可放置在以下位置：

• 当前目录
• /etc/rcon-hub目录
• 用户主目录下的.rcon-hub目录

顶级配置项

• host-key-file：PEM编码的SSH主机密钥文件路径。若文件不存在，将自动创建RSA私钥文件；若未指定，启动时会在内存中生成（每次启动需移除known hosts条目）
• history-size：命令历史记录大小，默认值为100
• bind：SSH连接监听地址和端口，格式为host:port，默认值为:2222

用户配置（users）

在users键下可配置一个或多个用户，子键为用户名，对象需包含：

• password：用户的SSH登录密码

连接配置（connections）

在connections键下可配置一个或多个RCON连接，子键为连接名称（用于connect命令），对象需包含：

• address：RCON端点地址，格式为host:port
• password：RCON认证密码

配置示例

yaml
users:
  testing:
    password: pw
connections:
  mc:
    address: localhost:25575
    password: minecraft
host-key-file: host_key.pem

使用方法

本地使用

使用上述配置文件，启动rcon-hub：

bash
rcon-hub

执行help或--help可查看更多命令行选项。

Docker使用

容器化版本镜像为itzg/rcon-hub，暴露SSH端口2222，并定义两个卷：

• /etc/rcon-hub：配置文件config.yml加载目录
• /data：默认主机密钥文件写入路径/data/host_key.pem，也可挂载预生成的密钥文件

环境变量支持

无需配置文件，可通过以下环境变量配置：

• RH_USER：SSH认证用户名，默认值为user
• RH_PASSWORD：若指定，将创建用户$RH_USER并设置此密码
• RH_CONNECTION：空格分隔的连接定义列表，格式为name=password@host:port

Docker启动示例

以下命令启动一个与上述YAML配置等效的容器：

bash
docker run -d --name rcon-hub -p 2222:2222 \
  -e RH_USER=testing -e RH_PASSWORD=pw -e RH_CONNECTION=mc=minecraft@localhost:25575 \
  itzg/rcon-hub

连接到rcon-hub

使用任何SSH客户端通过密码认证连接到运行中的hub服务器：

bash
ssh -p 2222 testing@localhost

Shell使用

连接后将进入简单的shell环境，可使用以下功能：

• help命令：列出所有可用命令
• 命令历史：通过上下箭头键访问历史命令
• connect命令：通过连接名称切换RCON连接