leighmcculloch/unison

Docker-Unison

镜像概述和主要用途

Docker-Unison是一个使用Unison的Docker卷容器，用于实现快速双向文件夹同步。该镜像旨在替代OS X上速度较慢的boot2docker卷，解决本地开发环境中文件同步效率低下的问题。

Docker镜像可在Docker Hub获取：https://registry.hub.docker.com/u/leighmcculloch/unison/

核心功能和特性

• 双向同步：支持本地文件夹与容器内文件夹的双向文件同步
• 高效性能：相比传统boot2docker卷提供更快的同步速度
• 版本兼容性：提供多种Unison和OCaml版本组合的镜像标签，满足不同客户端版本需求
• 灵活集成：可通过volumes_from与其他容器共享同步卷
• 自动化支持：可结合fswatch实现文件变更自动同步

使用场景和适用范围

• OS X环境下使用boot2docker或Docker Desktop时的本地开发文件同步
• 需要在容器与本地之间保持文件实时双向更新的开发场景
• 替代Docker原生卷在特定系统上的性能瓶颈问题

使用方法和配置说明

Docker

1. 启动Unison卷容器

首先启动一个暴露Unison卷的容器：

bash
$ CID=$(docker run -d -p 5000:5000 -e UNISON_WORKING_DIR=/unison -v /unison leighmcculloch/unison:latest)

2. 同步本地文件夹到容器

使用Unison客户端将本地文件夹同步到容器内的/unison目录：

bash
$ unison . socket://<docker>:5000/ -auto -batch

注：<docker>需替换为Docker主机的IP地址或域名

3. 连接卷到其他容器

启动一个使用该同步卷的容器：

bash
$ docker run -it --volumes-from $CID ubuntu /bin/sh

Docker Compose

在Docker Compose管理的开发环境中，可使用volumes_from指令挂载Unison卷。

docker-compose.yml配置示例

yaml
mywebserver:  
  build: .  
  volumes_from:  
    - unison  
unison:  
  image: leighmcculloch/unison:latest  
  environment:  
    - UNISON_WORKING_DIR=/unison  
  volumes:
    - /unison
  ports:  
    - "5000:5000"

同步命令

使用Unison客户端同步本地文件夹：

bash
$ unison . socket://<docker>:5000/ -ignore 'Path .git' -auto -batch

自动同步配置

结合fswatch实现文件变更自动同步：

bash
$ fswatch -o . | xargs -n1 -I{} unison . socket://<docker>:5000/ -ignore 'Path .git' -auto -batch

本地安装Unison

Unison要求客户端（运行在主机）和服务器（运行在容器）版本必须匹配。支持的版本组合：

• 2.40.102（可通过Ubuntu 14.04/14.10/15.04的apt-get install unison安装，基于OCaml 4.01编译）
• 2.48.4（可通过Mac OS X的brew install unison安装，基于OCaml 4.03编译）

若从源码安装Unison，可通过ocaml --version查看编译时使用的OCaml版本。

可用Unison镜像

该Docker仓库包含多种Unison服务器版本，编译自不同OCaml版本。可通过选择适当标签的镜像来匹配客户端版本。镜像标签格式：

VERSION-[unisonUNISON_VERSION[-OCAML_VERSION]]

支持的版本组合：

• Unison：2.40.102、2.48.3、2.48.4
• OCaml：4.01、4.02、4.03

如需其他版本，可通过Issue请求添加。

镜像标签示例

本地安装fswatch

• Mac OS X：brew install fswatch
• 其他系统：从fswatch发布页面下载并编译

许可证

本Docker镜像基于GPLv3许可证，因Unison使用GPLv3许可证并包含在镜像中。详见LICENSE。