Vagrant-bindfs 技术文档

本文档将详细介绍如何使用 vagrant-bindfs 插件，包括安装指南、使用说明以及 API 使用文档，帮助用户更好地了解和使用该插件。

1. 安装指南

vagrant-bindfs 是作为 Ruby gem 分发的。您可以通过以下命令安装它，就像安装其他 Vagrant 插件一样：

vagrant plugin install vagrant-bindfs

确保在执行此命令之前已经安装了 Vagrant。

2. 项目的使用说明

在您的 Vagrantfile 文件中，使用 config.bindfs.bind_folder 方法来配置在 VM 启动时将要绑定的文件夹。配置格式如下：

config.bindfs.bind_folder "/path/to/source", "/path/to/destination", options

默认情况下，所有文件夹在宿主机和虚拟机之间的文件夹同步后都会被绑定。您可以通过传递特殊的 :after 选项给 bind_folder 方法来选择何时绑定一个文件夹。支持的值有：

• :synced_folders（默认）
• :provision，在完成配置后绑定文件夹。

示例

Vagrant.configure("2") do |config|

  [...] # 您的 VM 配置

  # 基本使用
  config.bindfs.bind_folder "source/dir", "mount/point"

  # 高级选项
  config.bindfs.bind_folder "source/dir", "mount/point",
    perms: "u=rw:g=r:o=r", # 设置权限
    create_as_user: true

  # 完整的 NFS 共享文件夹示例

  # 静态 IP 是使用 NFS 共享文件夹所必需的，
  # 这仅适用于 Virtualbox 提供商
  config.vm.network "private_network", ip: "192.168.50.4"

  # 使用 Vagrant 语法声明共享文件夹
  config.vm.synced_folder "host/source/dir", "/vagrant-nfs", type: :nfs

  # 使用 vagrant-bindfs 重新挂载文件夹
  config.bindfs.bind_folder "/vagrant-nfs", "guest/mount/point"

  # 在配置后绑定一个文件夹
  config.bindfs.bind_folder "/vagrant-after-provision", "another/guest/mount/point", after: :provision

end

请注意，Vagrant 在虚拟机中使用 /vagrant 来自动共享包含 Vagrantfile 的项目目录，特别是用于配置和供应目的。将文件夹绑定到 /vagrant 或其子文件夹可能会暴露出预期之外的行为。

3. 项目 API 使用文档

bind_folder 配置接受您可以传递给 bindfs 的任何选项。vagrant-bindfs 与 bindfs 版本 1.9 到 1.14.7 兼容。支持的选项和默认值可以在 option_definitions.json 中找到，完整文档请阅读 bindfs man 页面。

长参数和短参数都支持。如果同时设置，短参数将优先。长参数可以用下划线（force_user）或短横线（force-user）编写，并且可以是字符串（force-user）或符号（:force_user 或 :'force-user'）。

选项参数值可以是任何可以通过 to_s 转换为字符串的内容。插件将尝试检测标志参数值是否为 true 或 false。

vagrant-bindfs 会检测安装的 bindfs 版本，根据需要翻译选项名称，并忽略不支持的操作。如果操作失败，它会警告您。

在 Debian（和 Ubuntu）、SUSE、Fedora、CentOS、Gentoo 和 OS X 客户系统上，如果未安装 bindfs，vagrant-bindfs 会尝试自动安装它。

OS X 客户机可能需要一些特定选项。具体细节请查看 bindfs README。

4. 项目安装方式

请参考上述“安装指南”部分，安装 vagrant-bindfs 的方式是通过 Vagrant 插件安装命令：

vagrant plugin install vagrant-bindfs