coder95/boomcatch

boomcatch Docker镜像文档

支持的标签及对应的Dockerfile链接

• 3.2.5 , latest https://github.com/aananthraj/docker-boomcatch.git

镜像概述

boomcatch是一个基于node.js的独立beacon接收器，专为boomerang设计。本镜像基于Alpine Linux构建，具有轻量级特性，压缩大小仅28MB，完整大小81.3MB，适合高效部署和运行。

快速参考

完整文档、参数及指南请访问以下链接：

• https://github.com/springernature/boomcatch
• [***]

使用方法

查看命令行选项

如需查看所有命令行选项，运行：

docker run --name <容器名称> <镜像名称>

不带参数启动容器将返回boomcatch的帮助信息：

docker run -it --name boomcatch-web-server coder95/boomcatch

输出示例：

用法：boomcatch [选项] 选项： -h, --help 输出使用信息 -V, --version 输出版本号 ...

可用选项说明

--host <name>： 接受HTTP连接的主机名。默认值为0.0.0.0（INADDR_ANY）。

--port <port>： 接受HTTP连接的端口。默认值：HTTP为80，HTTPS为443。

--https： 以HTTPS模式启动服务器。

--httpsPfx： 用于HTTPS模式的PFX/PKCX12字符串，包含私钥、证书和CA证书。

--httpsKey： HTTPS模式的私钥文件路径。若设置--httpsPfx，此选项将被忽略。

--httpsCert： HTTPS模式的证书文件路径。若设置--httpsPfx，此选项将被忽略。

--httpsPass： --httpsPfx或--httpsKey选项的密码。

--path <path>： 接受请求的URL路径。默认值为/beacon。

--referer <regex>： 允许的HTTP referer（使用正则表达式）。默认值为.*（任意referer）。

--origin <origin>： Access-Control-Allow-Origin头的URL列表（逗号分隔）。默认值为*（任意源），指定'null'可强制同源。

--limit <milliseconds>： 同一IP地址请求之间允许的最小间隔时间（毫秒）。默认值为0。

--maxSize <bytes>： POST请求允许的最大body大小（字节）。默认值为-1（无限制）。

--silent： 禁止命令向控制台输出日志。

--syslog <facility>： 使用符合syslog的日志记录，指定设施级别。

--workers <count>： 生成的工作进程数。默认值为-1（每个CPU一个工作进程）。

--delayRespawn <milliseconds>： 重新生成工作进程前的延迟时间（毫秒）。默认值为0。

--maxRespawn <count>： 重新生成工作进程的最大次数。默认值为-1（无限制）。

--validator <path>： 用于接受或拒绝请求数据的验证器。默认值为permissive（始终接受请求）。

--mapper <path>： 转发前转换数据的数据映射器（通过require加载）。默认值为statsd。

--prefix <prefix>： 映射指标名称的前缀。默认值为空字符串（无前缀）。

--forwarder <path>： 用于发送数据的转发器（通过require加载）。默认值为udp。

--fwdHost <name>： 转发映射数据的主机名。默认值为127.0.0.1。仅对UDP转发器有效。

--fwdPort <port>： 转发映射数据的端口。默认值为8125。仅对UDP转发器有效。

--fwdSize <bytes>： 转发数据的最大数据包大小（字节）。默认值为512。仅对UDP转发器有效。

--fwdUrl <url>： 转发映射数据的URL。仅对HTTP转发器有效。

--fwdMethod <method>： 转发映射数据的HTTP方法。默认值为GET。仅对HTTP转发器有效。

--fwdDir <path>： 写入映射数据的目录。仅对文件转发器有效。

使用示例

后台启动带参数的服务器

可通过以下命令启动后台运行的容器，并指定所需参数：

docker run -d -p 9000:9000 --name boomcatch-web-server coder95/boomcatch --port 9000 --prefix "my_boomcatch" --fwdHost exmaple.udp.server.com --fwdPort 8125

查看后台容器日志

使用以下命令查看后台容器的日志：

docker logs -f boomcatch-web-server

输出示例：

2017-08-22 07:35:11 INFO boomcatch: 在进程1中启动boomcatch，选项： { "port": 9000, "prefix": "my_boomcatch", "fwdHost": "exmaple.udp.server.com", "fwdPort": 8125, "log": {}, "workers": 2 } 2017-08-22 07:35:12 INFO boomcatch: 工作进程10启动 2017-08-22 07:35:12 INFO boomcatch: 工作进程11启动 2017-08-22 07:35:12 INFO boomcatch: 监听0.0.0.0:9000/beacon 2017-08-22 07:35:12 INFO boomcatch: 监听0.0.0.0:9000/beacon