onnimonni/unison

Docker-Unison

镜像概述和主要用途

Docker-Unison是一个使用Unison的Docker卷容器，用于实现快速双向文件夹同步。它被创建作为OS X上Docker卷访问速度慢问题的替代方案。

该镜像力求最小化，大小仅为14.41MB。Docker镜像可在Docker Hub获取：https://registry.hub.docker.com/u/onnimonni/unison/

核心功能和特性

• 基于Alpine Linux构建，保持轻量级（14.41MB）
• 支持双向文件夹同步，解决OS X上Docker卷性能问题
• 可通过环境变量灵活配置同步目录、用户ID/组ID等
• 支持Docker Compose集成，适用于开发环境

使用场景和适用范围

• OS X系统中需要提升Docker卷文件访问性能的开发环境
• 需在本地主机与Docker容器间保持文件双向同步的场景
• 开发过程中需要实时同步代码变更到容器内的工作流

使用方法和配置说明

Docker使用

启动卷容器

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

bash
$ CID=$(docker run -d -p 5000:5000 -e UNISON_DIR=/data -v /data onnimonni/unison)

同步本地文件夹

将本地文件夹同步到容器中的$UNISON_DIR（默认值：/data）：

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

连接其他容器

启动一个连接到该卷的容器（卷路径为/data）：

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

Docker Compose使用

如果使用Docker Compose管理开发环境，可使用volumes_from指令。以下docker-compose.yml示例将unison容器的/var/www/project文件夹挂载到mywebserver容器中：

yaml
mywebserver:
  build: .
  volumes_from:
    - unison
unison:
  image: onnimonni/unison
  environment:
    - UNISON_DIR=/var/www/project
    - UNISON_UID=10000
    - UNISON_GID=10000
  ports:
    - "5000:5000"
  volumes:
    - /var/www/project

同步本地文件夹到Compose环境

使用Unison客户端将本地文件夹同步到容器中的/var/www/project：

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

实时同步文件变更

使用-repeat watch选项实现文件变更时自动同步：

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

注意：使用-repeat选项需要安装unison-fsmonitor。

配置参数

容器支持以下环境变量配置：

• UNISON_DIR - 容器内接收Unison同步数据的目录，可通过volumes_from在其他容器中使用
• UNISON_GID - 容器内运行Unison的用户组ID
• UNISON_UID - 容器内运行Unison的用户ID
• UNISON_USER - 同步用户的用户名（UID更为重要）
• UNISON_GROUP - 同步用户的组名（GID更为重要）

本地安装Unison

Unison要求主机上的客户端版本与容器内的服务器版本匹配。Docker镜像标签对应容器内安装的Unison版本，例如onnimonni/unison:2.51.2对应2.51.2版本。

可用版本及安装方式：

• 2.40.102（可通过apt-get install unison在Ubuntu 14.04、14.10、15.04上安装）
• 2.48.4（可通过apt install unison在Ubuntu 18.04上安装）
• 2.51.2（可通过brew install unison在Mac OS X上安装）[默认版本]

如需其他版本，可提交Issue请求添加。

在OSX上安装unison-fsmonitor（unox）

bash
# 安装unox依赖
$ pip install MacFSEvents

# 安装unison-fsmonitor脚本
$ curl -o /usr/local/bin/unison-fsmonitor -L https://raw.githubusercontent.com/hnsl/unox/master/unox.py
$ chmod +x /usr/local/bin/unison-fsmonitor

致谢

感谢https://github.com/leighmcculloch/docker-unison%E5%B1%95%E7%A4%BA%E4%BA%86%E5%A6%82%E4%BD%95%E5%B0%86Unison%E4%B8%8EDocker%E7%BB%93%E5%90%88%E4%BD%BF%E7%94%A8%E3%80%82

许可证

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