vimagick/ot-recorder

OwnTracks Recorder 镜像文档

镜像概述和主要用途

OwnTracks Recorder是一个轻量级程序，用于存储和访问由OwnTracks应用通过MQTT（或HTTP）协议发布的位置数据。它能够接收、持久化存储位置信息，并提供API接口供查询和管理，是个人或家庭位置追踪的理想解决方案。

核心功能和特性

• 轻量级设计：资源占用低，适合在各类设备上部署
• 多协议支持：支持MQTT和HTTP协议接收位置数据
• 数据持久化：本地存储位置数据，确保数据安全可控
• API访问：提供API接口，方便数据查询和集成
• 前端集成：可与OwnTracks前端配合，实现位置数据可视化

使用场景和适用范围

• 个人位置追踪：记录个人移动轨迹和历史位置
• 家庭位置监控：实时掌握家庭成员位置信息
• 团队位置管理：企业或组织成员的位置追踪与管理
• 物联网联动：基于位置数据触发其他IoT设备操作

使用方法和配置说明

Docker Compose配置示例

以下是完整的docker-compose.yml配置，包含Recorder服务和前端服务：

yaml
version: "3.7"

services:

  recorder:
    image: vimagick/ot-recorder
    ports:
      - "8083:8083"  # API端口映射
    volumes:
      - ./data:/var/spool/owntracks/recorder/store  # 位置数据持久化存储
    environment:
      - OTR_HOST=iot.eclipse.org  # MQTT服务器地址
      - OTR_PORT=1883  # MQTT服务器端口
      - OTR_USER=username  # MQTT认证用户名（如需要）
      - OTR_PASS=password  # MQTT认证密码（如需要）
      - OTR_TOPICS=owntracks/#  # 订阅的MQTT主题
      # OTR_CAFILE=/etc/ssl/certs/DST_Root_CA_X3.pem  # SSL证书路径（如需安全连接）
      # OTR_BROWSERAPIKEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX  # Google地图API密钥
      # OTR_OPTIONS=--debug  # 额外运行参数（如调试模式）
    restart: unless-stopped

  frontend:
    image: owntracks/frontend  # OwnTracks前端镜像
    ports:
      - 8080:80  # 前端Web界面端口
    environment:
      - SERVER_HOST=recorder  # 后端recorder服务名
      - SERVER_PORT=8083  # 后端API端口
    restart: unless-stopped

环境变量说明

注意：部分变量（如OTR_QOS、OTR_CAFILE）可能无法按https://github.com/owntracks/recorder#configuration-file%E6%89%80%E8%BF%B0%E6%AD%A3%E5%B8%B8%E5%B7%A5%E4%BD%9C%EF%BC%8C%E5%8F%AF%E9%80%9A%E8%BF%87OTR_OPTIONS%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E4%BC%A0%E9%80%92%E4%BB%BB%E4%BD%95%E6%94%AF%E6%8C%81%E7%9A%84%E7%A8%8B%E5%BA%8F%E9%80%89%E9%A1%B9%E3%80%82

部署与运行步骤

1. 准备配置文件
   创建docker-compose.yml文件，根据实际需求修改环境变量（如MQTT服务器地址、认证信息等）。

2. 启动服务
   在配置文件所在目录执行以下命令启动服务：

   bash
   docker-compose up -d
   

3. 查看数据存储
   位置数据会保存在当前目录的data文件夹中，可通过以下命令查看目录结构：

   bash
   tree data
   

4. 数据查询与管理
   进入recorder容器，使用ocat工具查询位置数据：

   bash
   docker-compose exec recorder bash
   # 列出所有用户
   ocat --list
   # 查询特定用户设备的位置数据（替换foo为用户名，bar为设备名）
   ocat --user foo --device bar
   

获取Google地图API密钥

若需在前端界面显示地图，需获取Google地图API密钥，可通过Google地图API文档生成。