Docker-Sync 跨平台安装与配置指南

Docker-Sync 跨平台安装与配置指南

docker-sync Run your application at full speed while syncing your code for development, finally empowering you to utilize docker for development under OSX/Windows/*Linux 项目地址: https://gitcode.com/gh_mirrors/do/docker-sync

前言

Docker-Sync 是一个强大的工具，用于解决开发者在 Docker 环境下遇到的性能问题，特别是在跨平台开发时。本文将详细介绍 Docker-Sync 在不同操作系统上的安装和配置方法，帮助开发者快速搭建高效的开发环境。

基础安装

无论您使用哪种操作系统，都可以通过 RubyGems 来安装 Docker-Sync：

gem install docker-sync

非 root 用户安装

如果您不希望以 root 权限安装，可以使用以下命令：

gem install --user-install docker-sync

安装完成后，需要将 Docker-Sync 添加到您的 PATH 环境变量中。编辑 .bashrc 文件并添加以下内容：

if which ruby >/dev/null && which gem >/dev/null; then
  PATH="$(ruby -r rubygems -e 'puts Gem.user_dir')/bin:$PATH"
fi

保存后，开启新的终端会话即可使用 docker-sync 命令。

各操作系统详细配置

macOS 配置

依赖项

1. Docker for Mac 用户：可以直接使用 native_osx 同步策略，无需额外依赖
2. docker-machine 用户：需要使用其他同步策略，因为 native_osx 策略不兼容 docker-machine

可选组件

如果您需要使用 Unison 同步策略：

brew install unison
brew install eugenmayer/dockersync/unox

如果选择 rsync 策略：

brew install rsync

注意：从 Docker-Sync 0.7.0 开始，Unison 策略用户还可以选择安装替代方案 unison-fsmonitor，它可能提供更好的性能。

Linux 配置

注意：Linux 支持目前仍处于 Beta 阶段

基础依赖

默认的 native 同步策略不需要额外依赖。

可选组件

如果需要使用 Unison 策略（以 Ubuntu 为例）：

sudo apt-get install build-essential ocaml
wget https://github.com/bcpierce00/unison/archive/v2.51.3.tar.gz
tar xvf v2.51.3.tar.gz
cd unison-2.51.3
make UISTYLE=text
sudo cp src/unison /usr/local/bin/unison
sudo cp src/unison-fsmonitor /usr/local/bin/unison-fsmonitor

目前 rsync 策略在 Linux 上不完全支持，需要额外配置。

Windows 配置

注意：Windows 支持目前仍处于 Beta 阶段

准备工作

1. 启用 WSL（Windows 子系统 Linux）
2. 从 Microsoft Store 安装 Linux 发行版（如 Debian、Ubuntu）
3. 更新系统：

sudo apt update
sudo apt upgrade

安装 Docker 和 Docker Compose

1. 按照官方文档安装 Docker CE
2. 创建符号链接（Windows 10 1803+）：

sudo ln -s "/mnt/c/Program Files/Docker/Docker/resources/bin/docker.exe" /usr/local/bin/docker

3. 安装 Docker Compose：

sudo apt install docker-compose

或创建符号链接：

sudo ln -s "/mnt/c/Program Files/Docker/Docker/resources/bin/docker-compose.exe" /usr/local/bin/docker-compose

安装 Docker-Sync

1. 安装 Ruby：

sudo apt-get install ruby ruby-dev

2. 安装 Docker-Sync：

sudo gem install docker-sync

3. 配置 Docker 主机环境变量：

echo "export DOCKER_HOST=tcp://127.0.0.1:2375" >> ~/.bashrc

编译安装 OCaml 和 Unison

1. 安装构建工具：

sudo apt-get install build-essential

2. 编译安装 OCaml：

wget https://caml.inria.fr/pub/distrib/ocaml-4.12/ocaml-4.12.0.tar.gz
tar xvf ocaml-4.12.0.tar.gz
cd ocaml-4.12.0
./configure
make world
make opt
umask 022
sudo make install
sudo make clean

3. 编译安装 Unison：

wget https://github.com/bcpierce00/unison/archive/v2.51.3.tar.gz
tar xvf v2.51.3.tar.gz
cd unison-2.51.3
curl https://github.com/bcpierce00/unison/commit/14b885316e0a4b41cb80fe3daef7950f88be5c8f.patch?full_index=1 -o patch.diff
git apply patch.diff
make UISTYLE=text
sudo cp src/unison /usr/local/bin/unison
sudo cp src/unison-fsmonitor /usr/local/bin/unison-fsmonitor

其他配置

1. 设置时区
2. 绑定自定义挂载点（解决 Docker for Windows 和 WSL 差异）
3. 对于 Laradock 用户，需要修改同步策略为 'unison' 并添加特定参数

FreeBSD 配置

注意：FreeBSD 支持目前仍处于 Beta 阶段

基础依赖

默认使用 rsync 策略，需要先安装：

pkg install rsync

配置示例

version: "2"

syncs:
  code-sync:
    sync_strategy: "rsync"
    src: "path/to/src"
    sync_host_port: 10871
    # sync_host_allow: "..."

sync_host_port 是必需的且必须唯一。sync_host_allow 可能需要指定以允许特定 IP 连接。

结语

通过本文的详细指导，您应该能够在不同操作系统上成功安装和配置 Docker-Sync。根据您的具体开发环境和需求选择合适的同步策略，可以显著提升开发效率。如果在使用过程中遇到问题，建议查阅项目文档或社区讨论获取更多帮助。

docker-sync Run your application at full speed while syncing your code for development, finally empowering you to utilize docker for development under OSX/Windows/*Linux 项目地址: https://gitcode.com/gh_mirrors/do/docker-sync