ddvk/rmfakecloud

ReMarkable云API自托管Docker镜像文档

镜像概述

本Docker镜像用于自托管ReMarkable云API，允许用户在私有服务器上部署和管理ReMarkable相关云服务，实现数据自主控制，摆脱对官方云服务的依赖。通过配置环境变量，可自定义服务端口、数据存储路径、集成手写识别及邮件发送功能。

核心功能和特性

• 自托管云API：提供ReMarkable设备所需的核心云API功能，支持本地部署
• 手写识别集成：通过myScript开发者账户配置后，支持手写内容识别（需单独注册myScript开发者账户）
• 邮件发送功能：支持通过SMTP服务器发送邮件，可自定义发件人信息
• 灵活配置：支持自定义服务端口、数据存储目录、日志级别及存储URL
• 数据自主控制：数据存储在本地服务器，提升数据隐私与安全性

使用场景和适用范围

• 注重数据隐私的ReMarkable设备用户，需将数据存储在私有服务器
• 需要自定义云服务配置的企业或开发者，如调整存储路径、集成第三方服务
• 希望摆脱官方云服务依赖，实现服务自主管理的个人或组织
• 开发或测试环境中需要模拟ReMarkable云API的场景

使用方法和配置说明

默认配置

• 默认端口：3000（可通过环境变量PORT修改）
• 工作目录：/data（数据文件默认存储路径）
• 存储URL：需设置为设备可解析的主机名（通过STORAGE_URL环境变量指定，默认值为http://hostname:port）

环境变量说明

部署示例

1. Docker Run命令

bash
docker run -d \
  --name remarkable-selfhosted \
  -p 3000:3000 \
  -v /path/to/local/data:/data \
  -e STORAGE_URL="http://your-server-ip:3000" \
  -e LOGLEVEL="info" \
  -e RM_SMTP_SERVER="smtp.gmail.com:465" \
  -e RM_SMTP_USERNAME="user@example.com" \
  -e RM_SMTP_PASSWORD="your-app-password" \
  -e RM_SMTP_FROM='"ReMarkable自托管服务" <user@example.com>' \
  [镜像名称]

2. Docker Compose配置

yaml
version: '3'
services:
  remarkable-api:
    image: docker.xuanyuan.run/[镜像名称]
    container_name: remarkable-selfhosted
    ports:
      - "3000:3000"
    volumes:
      - /path/to/local/data:/data
    environment:
      - STORAGE_URL=http://your-server-ip:3000
      - LOGLEVEL=info
      - RM_SMTP_SERVER=smtp.gmail.com:465
      - RM_SMTP_USERNAME=user@example.com
      - RM_SMTP_PASSWORD=your-app-password
      - RM_SMTP_FROM='"ReMarkable自托管服务" <user@example.com>'
    restart: unless-stopped

注：替换[镜像名称]为实际Docker镜像名称，/path/to/local/data为本地数据存储路径，根据实际需求调整环境变量参数。手写识别功能需额外配置RMAPI_HWR_APPLICATIONKEY和RMAPI_HWR_HMAC。