mozilla/syncstorage-rs

Rust Sync Storage 镜像文档

镜像概述

Rust Sync Storage 是一个基于 Rust 语言开发的同步存储服务镜像，利用 Rust 的内存安全特性和高性能优势，提供轻量级、可靠的数据同步与持久化存储解决方案。该镜像封装了完整的同步存储服务，支持多种存储后端配置，适用于需要跨设备/服务数据一致性保障的场景。

核心功能与特性

核心功能

• 高性能数据同步：采用高效同步算法，支持增量数据同步，降低网络带宽占用
• 多后端存储支持：兼容本地文件系统、SQLite、Redis 等多种存储后端
• 数据一致性保障：实现基于版本向量的冲突解决机制，确保跨节点数据一致性
• 持久化存储：支持数据本地持久化，防止服务重启导致数据丢失
• 轻量级设计：镜像体积小（<50MB），资源占用低，适合嵌入式设备及边缘计算环境

关键特性

• 零依赖运行：内置所有必要依赖，无需额外安装系统库
• 可配置同步策略：支持定时同步、事件触发同步等多种同步模式
• 完善日志系统：提供分级日志（DEBUG/INFO/WARN/ERROR），便于问题排查
• REST API 接口：提供标准 RESTful API，方便外部系统集成

使用场景

• 个人数据同步：跨设备（PC、手机、平板）的个人文件、配置数据同步
• 嵌入式设备存储：物联网设备、嵌入式系统的本地数据管理与远程同步
• 小型团队协作：团队内部文档、配置文件的轻量级同步共享
• 边缘节点数据汇聚：边缘计算场景下，多个边缘节点数据向中心节点同步

使用方法

基本运行

通过以下命令快速启动服务，默认使用本地文件系统作为存储后端：

bash
docker run -d \
  --name rust-sync-storage \
  -p 8080:8080 \
  -v ./data:/app/data \
  rust-sync-storage:latest

• -p 8080:8080：映射服务端口（容器内默认端口 8080）
• -v ./data:/app/data：挂载本地目录作为数据存储路径（持久化数据）

环境变量配置

通过环境变量自定义服务行为，常用配置如下：

示例：使用 SQLite 后端并设置同步间隔为 60 秒

bash
docker run -d \
  --name rust-sync-storage \
  -p 8080:8080 \
  -v ./data:/app/data \
  -e STORAGE_BACKEND=sqlite \
  -e SYNC_INTERVAL=60 \
  -e LOG_LEVEL=debug \
  rust-sync-storage:latest

Docker Compose 配置

创建 docker-compose.yml 文件，配置更复杂的部署场景（如结合 Redis 后端）：

yaml
version: '3'
services:
  rust-sync-storage:
    image: rust-sync-storage:latest
    ports:
      - "8080:8080"
    volumes:
      - ./data:/app/data
    environment:
      - STORAGE_BACKEND=redis
      - REDIS_URL=redis://redis:6379
      - SYNC_INTERVAL=120
      - API_KEY=my-secret-key
    depends_on:
      - redis

  redis:
    image: redis:alpine
    volumes:
      - redis-data:/data

volumes:
  redis-data:

启动服务：docker-compose up -d

验证服务

服务启动后，可通过以下命令验证运行状态：

bash
# 查看服务日志
docker logs -f rust-sync-storage

# 访问健康检查接口
curl http://localhost:8080/health
# 预期响应：{"status":"ok","version":"x.y.z"}

数据备份与迁移

为确保数据安全，建议定期备份挂载的 /app/data 目录（或对应后端存储数据）。迁移时只需将备份数据挂载到新实例的相同路径，并保持相同的存储后端配置即可。

注意事项

• 生产环境中建议设置 API_KEY 启用鉴权，防止未授权访问
• 高并发场景下，建议使用 Redis 后端并调整 MAX_CONCURRENT_SYNC 环境变量（默认 10）
• 嵌入式设备部署时，可通过 --memory=64m 限制内存使用（实际最低内存需求 ~32MB）