outrigger/unison

Unison文件同步容器

镜像概述和主要用途

该容器用于同步本地文件与Docker容器中的卷，在Mac OSX环境下相比NFS挂载能显著提升文件操作性能，特别适合处理大量小文件（如node_modules等）场景，解决NFS挂载在处理此类文件时速度缓慢的问题。

核心功能和特性

• 高性能同步：相比NFS挂载，大幅提升Mac OSX环境下容器内文件操作性能
• 双向同步：本地文件变更同步至容器卷，容器卷文件变更同步至本地
• 冲突处理：同步冲突时，本地文件优先
• 日志记录：生成同步日志文件，便于追踪同步活动

安装要求

在Mac上安装以下依赖：

• brew install unison
• brew tap eugenmayer/dockersync
• brew install eugenmayer/dockersync/unox

项目设置

1. 修改docker-compose.yml

将本地目录挂载替换为命名卷。默认卷名称为{ProjectName}-sync。

例如，若原配置为：

yaml
www:
  volumes:
    - .:/var/www

修改为：

yaml
www:
  volumes:
    - ProjectName-sync:/var/www

2. 定义命名卷

在docker-compose.yml末尾添加以下内容定义命名卷：

yaml
volumes:
  ProjectName-sync:
    external: true

使用方法

1. 启动Unison容器

使用提供的unison.sh脚本启动同步：

bash
./unison.sh ProjectName

• 此命令会创建命名Docker卷、启动Unison服务容器，并启动本地Unison进程监听文件变化
• 运行脚本的目录将与docker-compose.yml中指定的挂载点（如/var/www）同步
• 若省略ProjectName参数，将使用当前目录名称作为项目名

2. 启动项目容器

正常启动项目容器：

bash
docker-compose up -d

• 本地文件变更会同步至容器卷
• 容器卷内文件变更会同步至本地Mac
• 同步冲突时，本地文件优先
• 同步日志文件ProjectName-sync.log会生成在运行unison.sh的目录下，记录同步活动

3. 停止同步

停止同步容器即可：

bash
docker stop ProjectName-sync