EteSync CalDAV/CardDAV 代理镜像文档

镜像概述

该Docker镜像提供EteSync的CalDAV和CardDAV协议前端代理服务，通过协议转换机制，将标准CalDAV（日历）和CardDAV（联系人）协议请求转换为EteSync API调用，使不原生支持EteSync的客户端（如Thunderbird、macOS Calendar、iOS Contacts等）能够访问和同步EteSync后端数据。

核心功能

• 协议转换：实现CalDAV/CardDAV协议与EteSync API的双向转换，确保客户端请求正确映射至EteSync服务
• 客户端兼容性：支持所有遵循CalDAV/CardDAV标准协议的客户端，无需客户端安装EteSync原生插件
• 数据同步：保持与EteSync后端的数据实时同步，确保客户端数据一致性
• 轻量部署：基于Docker容器化设计，部署简单，资源占用低

使用场景

• 需通过标准日历/联系人客户端（如Thunderbird、Evolution、Windows Calendar等）访问EteSync数据的个人用户
• 在不支持EteSync原生客户端的设备（如智能手表、部分嵌入式系统）上使用EteSync服务
• 企业或团队环境中，需将EteSync服务集成至现有基于CalDAV/CardDAV的客户端生态

使用方法

快速部署（Docker Run）

通过以下命令快速启动代理服务：

bash
docker run -d \
  --name etesync-proxy \
  -p 8000:8000 \
  -e ETESYNC_API_URL="[***]" \
  -e PROXY_USER="your_etesync_username" \
  -e PROXY_PASSWORD="your_etesync_password" \
  etesync/caldav-carddav-proxy:latest

环境变量说明

Docker Compose 配置示例

创建docker-compose.yml文件，内容如下：

yaml
version: '3'
services:
  etesync-proxy:
    image: etesync/caldav-carddav-proxy:latest
    container_name: etesync-proxy
    ports:
      - "8000:8000"
    environment:
      - ETESYNC_API_URL=[***]
      - PROXY_USER=your_etesync_username
      - PROXY_PASSWORD=your_etesync_password
      - LOG_LEVEL=info
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

客户端配置

代理服务启动后，在CalDAV/CardDAV客户端中配置如下：

• 服务器地址：http://<宿主机IP>:8000
• 用户名：与PROXY_USER一致
• 密码：与PROXY_PASSWORD一致
• 日历路径：/caldav（CalDAV）
• 联系人路径：/carddav（CardDAV）

注意事项

• 确保EteSync后端API地址（ETESYNC_API_URL）可被容器访问
• 生产环境建议使用HTTPS加密传输，可配合反向代理（如Nginx）配置SSL证书
• 敏感信息（如密码）建议通过Docker Secrets或环境变量文件管理，避免明文暴露