mclogs:基于 Docker 与 MongoDB 的日志分享与分析平台项目

粘贴、分享和分析您的日志
专为 Minecraft 和 Hytale 打造

功能特性

• 通过粘贴或上传文件分享日志
• 自动移除敏感信息（如 IP 地址）
• 便于分享的短链接
• 语法高亮显示
• 行号标注
• 特定行的直接链接
• 使用 codex 进行分析和解析

面向开发者

• 通过 API 上传日志
• 为共享日志添加元数据，例如版本号、服务器 ID 等
• 通过 API 检索日志及其元数据
• 开源且可自行托管

自行托管

您可以使用 Docker 自行托管 mclogs。GitHub 容器注册表中提供了 docker 镜像：ghcr.io/aternosorg/mclogs。 运行 mclogs 还需要一个 MongoDB 实例。

自行托管的示例 docker compose 文件可在此处找到：docker/compose.production.yaml。

配置

您可以通过在根目录创建 config.json 文件来配置 mclogs，参见 example.config.json，也可以通过设置环境变量进行配置。环境变量会覆盖配置文件中的设置。

以下是所有可用配置选项的列表：

变量 / JSON 路径	默认值	描述说明
MCLOGS_STORAGE_TTL storage.ttl	7776000（90 天）	日志最后查看后直至删除的时间
MCLOGS_STORAGE_LIMIT_BYTES storage.limit.bytes	10485760（10 MiB）	日志的最大大小（字节）
MCLOGS_STORAGE_LIMIT_LINES storage.limit.lines	25000	日志的最大行数
MCLOGS_MONGODB_URL mongodb.url	"mongodb://mongo"	MongoDB 连接 URL
MCLOGS_MONGODB_DATABASE mongodb.database	"mclogs"	MongoDB 数据库名称
MCLOGS_ID_LENGTH id.length	7	新 ID 的默认长度
MCLOGS_LEGAL_ABUSE legal.abuse	null	用于举报滥用行为的公开电子邮件地址
MCLOGS_LEGAL_IMPRINT legal.imprint	null	imprint URL
MCLOGS_LEGAL_PRIVACY legal.privacy	null	隐私政策 URL
MCLOGS_FRONTEND_NAME frontend.name	null	实例名称（默认为域名）
MCLOGS_FRONTEND_COLOR_ACCENT frontend.color.accent	#5cb85c	强调色/主色调
MCLOGS_FRONTEND_COLOR_BACKGROUND frontend.color.background	#1a1a1a	背景色
MCLOGS_FRONTEND_COLOR_TEXT frontend.color.text	#e8e8e8	文本颜色
MCLOGS_FRONTEND_COLOR_ERROR frontend.color.error	#f62451	错误颜色
MCLOGS_WORKER_REQUESTS worker.requests	500	单个工作进程的最大请求数

还有一些其他环境变量可用于直接修改 FrankenPHP/Caddy 设置：

变量	默认值	描述说明
SERVER_NAME	":80"	设置 Caddy 服务器名称，将其设置为您的域名可实现自动 SSL
TRUSTED_PROXIES	"private_ranges"	设置受信任代理地址范围
FRANKENPHP_WORKERS	16	FrankenPHP 工作进程数量

开发环境设置

前提条件

• Docker 和 Docker Compose
• PHP 8.5+
• Composer

安装步骤

# clone repository
git clone git@github.com:aternosorg/mclogs.git

# install composer dependencies
cd mclogs
composer install

# start development environment
cd dev
docker compose up

在浏览器中打开 http://localhost 即可开始使用。