aicohomelink/stash

HomeLINK Stash 镜像文档

镜像概述和主要用途

HomeLINK Stash 是一个类似 Logstash 的工具，专为获取和处理 HomeLINK 数据设计。它提供了便捷的数据获取能力，帮助用户轻松获取所有 HomeLINK 相关数据。更多信息请参考 官方帮助文档。

核心功能和特性

• 类似 Logstash 的数据处理能力
• 专为 HomeLINK 数据设计，优化数据获取流程
• 支持自定义配置，通过 settings.json 文件进行参数调整

使用场景和适用范围

适用于需要获取、处理 HomeLINK 数据的用户，尤其适合个人或小型团队在本地环境中部署使用，用于数据收集和初步处理。

使用方法和配置说明

前提条件

• 已安装 Docker 和 Node.js（用于构建镜像）
• 已准备好自定义的 settings.json 配置文件

构建镜像

在项目根目录下执行以下命令构建 Docker 镜像：

bash
npm run docker:build

运行容器

Linux 系统

bash
docker run -d --network host \
  --name homelink-stash \
  --restart unless-stopped \
  --log-opt max-size=10m \
  --log-opt max-file=5 \
  -v "$(pwd)/settings.json:/stash/settings.json" \
  homelinkstash:latest

Windows 系统（需使用 PowerShell）

powershell
docker run -d -h localhost `
  --name homelink-stash `
  --restart unless-stopped `
  --log-opt max-size=10m `
  --log-opt max-file=5 `
  -v ${pwd}/settings.json:/stash/settings.json `
  homelinkstash:latest

参数说明

• --network host（Linux）：使用主机网络模式
• -h localhost（Windows）：设置容器主机名为 localhost
• --name homelink-stash：指定容器名称
• --restart unless-stopped：容器退出时除非手动停止，否则自动重启
• --log-opt max-size=10m：限制日志文件大小为10MB
• --log-opt max-file=5：最多保留5个日志文件
• -v [本地路径]/settings.json:/stash/settings.json：挂载本地配置文件到容器内