xlrl/radicale

docker-radicale 镜像文档

镜像概述

docker-radicale 是 Radicale CalDAV/CardDAV 服务器的 Docker 容器化实现，用于提供自托管的日历（CalDAV）和联系人（CardDAV）同步服务。

核心功能

• 支持 CalDAV/CardDAV 协议，兼容主流客户端（如 Thunderbird、iOS 日历/联系人等）
• 基于 htpasswd 的用户认证机制，支持 bcrypt 加密
• 数据持久化存储，通过 Docker 卷挂载实现
• 集成 Git 版本控制，可跟踪日历/联系人数据变更
• 支持 Docker Compose 部署，配置灵活

使用场景

• 个人用户自托管日历和联系人服务，保障数据隐私
• 小型团队共享日历，实现日程协作
• 需要对日历/联系人数据变更进行版本跟踪和备份的场景

使用方法

快速启动

1. 创建数据目录及配置文件

创建本地数据目录（示例：/srv/radicale/data），并在该目录下创建最小化配置文件 config.ini：

ini
[auth]
type = htpasswd
# 容器内用户文件路径
htpasswd_filename = /var/radicale/users
# htpasswd 文件加密方式
htpasswd_encryption = bcrypt

[server]
hosts = 0.0.0.0:8000

[storage]
filesystem_folder = /var/radicale/collections

2. 启动容器

通过 docker run 命令启动容器，映射数据卷和端口：

shell
docker run -v /srv/radicale/data:/var/radicale -p 80:8000 -n radicale xlrl/radicale

3. 创建用户

使用 htpasswd 命令在容器内创建用户（需通过 docker exec 执行）：

shell
# 创建首个用户（-c 表示创建新文件，仅首次使用）
docker exec -ti radicale htpasswd -B -c /var/radicale/users user1
# 新增其他用户（无需 -c 参数）
docker exec -ti radicale htpasswd -B /var/radicale/users user2

4. 访问服务

浏览器访问 Docker 主机地址（映射端口 80），即可看到 Radicale 登录界面。

Docker Compose 配置

通过 docker-compose.yml 部署容器，示例配置如下：

yaml
version: '3.8'

services: 
  radicale:
    image: xlrl/radicale
    container_name: radicale
    environment: 
      - GIT_REPOSITORY=https://user:password@github.com/user/repo  # Git 仓库地址（私有仓库需包含认证信息）
      - GIT_USERNAME=username  # Git 提交用户名
      - GIT_EMAIL=usermail@mail.com  # Git 提交邮箱
      - RADICALE_USER=username  # Radicale 用户名
      - RADICALE_PASS=userpassword  # Radicale 用户密码
    ports: 
      - "8000:8000"  # 端口映射（主机:容器）
    volumes: 
      - /tmp/radicale:/var/radicale  # 数据卷挂载（主机目录:容器目录）

配置说明

环境变量

Git 版本控制配置

通过 Git 跟踪 Radicale 数据变更，步骤如下：

1. 创建 .gitignore 文件

在数据目录（/srv/radicale/data）下创建 .gitignore，排除临时文件：

.Radicale.cache
.Radicale.lock
.Radicale.tmp-*

2. 配置 Git 钩子

修改 config.ini，添加存储钩子（自动提交变更）：

ini
[storage]
filesystem_folder = /var/radicale/collections
hook = git add -A && (git diff --cached --quiet || git commit -m "Changes by %(user)s")

3. 初始化 Git 仓库

在数据目录初始化仓库并提交初始文件：

shell
cd /srv/radicale/data
git init
git add .
git commit -m "Initial commit"