wpoke/poke-api
wpoke
自动构建
Poke API是一个调度器与API，核心目标是通过Apache Kafka触发agent，支持分片部署，需依赖PostgreSQL、Kafka和Warp10实例运行。
下载次数: 0状态：自动构建维护者：wpoke仓库类型：镜像最近更新：7 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
Poke API
Poke API是一个调度器和API，其核心目标是通过Apache Kafka触发agent。
环境变量
| 名称 | 描述 | 类型 |
|---|---|---|
| SCHEDULER_ENABLED | 启用调度器以向Kafka发送事件 | Boolean |
| SHARDING_ENABLED | 启用分片，允许启动多个启用调度功能的实例 | Boolean |
| SHARDING_NBSHARDS | 设置分片数量，必须为2的幂 | Number |
| APP_SECRET | 应用密钥 | String |
| MACAROONS_SECRET | Macaroon密钥 | String |
| JAAS_PATH | 包含Kafka凭证的.jaas文件路径 | String |
| POSTGRESQL_ADDON_URI | PostgreSQL数据库的URI | URI |
| POSTGRESQL_ADDON_PORT | PostgreSQL数据库的端口 | Number |
| POSTGRESQL_ADDON_DB | PostgreSQL数据库的名称 | String |
| POSTGRESQL_ADDON_USER | 用于PostgreSQL数据库的用户 | String |
| POSTGRESQL_ADDON_PASSWORD | PostgreSQL数据库用户的密码 | String |
| POSTGRESQL_ADDON_HOST | PostgreSQL数据库的主机 | String |
| WARP_PRODUCER | 生产者的UUID | UUID |
| WARP_SIP_HASH_APP | Warp 10实例的十六进制密钥 | Hex |
| WARP_SIP_HASH_TOKEN | Warp 10实例的十六进制密钥 | Hex |
| WARP_AES_TOKEN | Warp 10实例的十六进制密钥 | Hex |
| WARP_ENDPOINT | Warp 10实例的URL | URL |
| KAFKA_HOST | Kafka实例的主机（可含端口） | String |
| KAFKA_HTTPCHECKS_TOPIC | HTTP检查的主题 | String |
| KAFKA_HTTPCHECKS_INTERVAL | 处理消息批处理的间隔 | String |
| KAFKA_SSLCHECKS_TOPIC | SSL检查的主题 | String |
| KAFKA_SSLCHECKS_INTERVAL | 处理消息批处理的间隔 | String |
| KAFKA_DNSCHECKS_TOPIC | DNS检查的主题 | String |
| KAFKA_DNSCHECKS_INTERVAL | 处理消息批处理的间隔 | String |
| KAFKA_ICMPCHECKS_TOPIC | ICMP检查的主题 | String |
| KAFKA_ICMPCHECKS_INTERVAL | 处理消息批处理的间隔 | String |
| KAFKA_ENDPOINT | Kafka端点 | String |
| KAFKA_WRITER_USER | 具有写入权限的Kafka用户 | String |
| KAFKA_WRITER_PASSWORD | Kafka写入用户的密码 | String |
| KAFKA_SECURITY_PROTOCOL | Kafka安全协议，可选值为PLAINTEXT、SASL_PLAINTEXT、SASL_SSL和SSL | String |
| ZOOKEEPER_SERVERS | Zookeeper连接字符串（例如：192.168.0.1:2181,192.168.0.2:2181） | String |
使用场景
适用于需要通过Kafka触发agent的调度场景，如批量任务调度、分布式系统事件触发等。
配置说明
使用前需配置上述环境变量，确保PostgreSQL、Apache Kafka、Warp10等依赖组件已正常启动并可访问。
部署示例
编译（本地开发）
bashsbt stage
运行（生产环境）
bash./target/universal/stage/bin/poke-api
分片部署
若需启动多个启用调度的实例，需开启分片：
- 设置
SHARDING_ENABLED为true； - 设置
SHARDING_NBSHARDS为2的幂（建议选择足够大的数值以支持未来扩展）。
开发贡献
贡献项目需准备相同依赖组件，启动增量编译：
bashsbt [poke-api] $ ~compile
等待源码变更即可开始开发。
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
DockerHub 原生拉取命令
docker pull wpoke/poke-api:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"