Vagrant-SSHFS 项目使用教程

Vagrant-SSHFS 项目使用教程

vagrant-sshfsSSHFS synced folder implementation for Vagrant.项目地址:https://gitcode.com/gh_mirrors/va/vagrant-sshfs

1. 项目的目录结构及介绍

Vagrant-SSHFS 项目的目录结构如下：

.
├── Gemfile
├── LICENSE
├── README.adoc
├── Rakefile
├── vagrant-sshfs.gemspec
├── lib
│   ├── vagrant-sshfs
│   │   ├── action.rb
│   │   ├── config.rb
│   │   ├── driver.rb
│   │   ├── errors.rb
│   │   ├── plugin.rb
│   │   └── version.rb
│   └── vagrant-sshfs.rb
├── locales
│   └── en.yml
└── test
    └── misc
        └── test_helper.rb

目录介绍

• Gemfile：定义了项目所需的 Ruby 依赖。
• LICENSE：项目的许可证文件，采用 GPL-2.0 许可证。
• README.adoc：项目的说明文档。
• Rakefile：用于定义项目的构建任务。
• vagrant-sshfs.gemspec：项目的 gem 规范文件。
• lib：包含项目的主要代码。
  • vagrant-sshfs：核心代码目录。
    • action.rb：定义了 Vagrant 插件的动作。
    • config.rb：定义了 Vagrant 插件的配置。
    • driver.rb：定义了 Vagrant 插件的驱动。
    • errors.rb：定义了 Vagrant 插件的错误处理。
    • plugin.rb：定义了 Vagrant 插件的入口点。
    • version.rb：定义了 Vagrant 插件的版本。
  • vagrant-sshfs.rb：项目的入口文件。
• locales：包含项目的本地化文件。
  • en.yml：英文本地化文件。
• test：包含项目的测试代码。
  • misc：包含一些辅助测试文件。
    • test_helper.rb：测试辅助文件。

2. 项目的启动文件介绍

项目的启动文件是 lib/vagrant-sshfs.rb，这个文件是 Vagrant 插件的入口点，负责加载和初始化插件。

require "vagrant-sshfs/plugin"

module VagrantPlugins
  module SyncedFolderSSHFS
    def self.source_root
      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
    end
  end
end

启动文件介绍

• require "vagrant-sshfs/plugin"：加载插件的核心模块。
• module VagrantPlugins：定义了插件的命名空间。
• def self.source_root：定义了项目的根路径。

3. 项目的配置文件介绍

项目的配置文件是 lib/vagrant-sshfs/config.rb，这个文件定义了 Vagrant 插件的配置选项。

module VagrantPlugins
  module SyncedFolderSSHFS
    class Config < Vagrant.plugin("2", :config)
      attr_accessor :ssh_opts
      attr_accessor :sshfs_opts
      attr_accessor :reverse
      attr_accessor :host_ip
      attr_accessor :host_port
      attr_accessor :host_ssh_port
      attr_accessor :guest_path
      attr_accessor :host_path
      attr_accessor :uid_map
      attr_accessor :gid_map
      attr_accessor :auto_mount
      attr_accessor :auto_unmount

      def initialize
        super
        @ssh_opts = UNSET_VALUE
        @sshfs_opts = UNSET_VALUE
        @reverse = UNSET_VALUE
        @host_ip = UNSET_VALUE
        @host_port = UNSET_VALUE
        @host_ssh_port = UNSET_VALUE
        @guest_path = UNSET_VALUE
        @host_path = UNSET_VALUE
        @uid_map = UNSET_VALUE
        @gid_map = UNSET_VALUE
        @auto_mount = UNSET_VALUE
        @auto_unmount = UNSET_VALUE
      end

      def finalize!
        @ssh_opts = {} if @ssh_opts == UNSET_VALUE
        @

vagrant-sshfsSSHFS synced folder implementation for Vagrant.项目地址:https://gitcode.com/gh_mirrors/va/vagrant-sshfs