README.md

   1 # vagrant-dotfiles
   2
   3 Now you can copy your dotfiles into your vagrant box, so that you don't feel like visiting Mars whenever you are in vagrant shell.
   4
   5 This project from forked from https://github.com/akshaymankar/copy_my_conf on 9/28/2018.
   6
   7 ## How to Use
   8
   9 It is a simple 2 step process
  10
  11 ### Add gem in your vagrant
  12
  13     $ vagrant plugin install vagrant-dotfiles
  14
  15 ### Create a ~/.vagrant/dotfiles files
  16
  17 Each line in the file should be a dotfile in your home directory of your workstations.
  18
  19 The plugin will copy this file into your /home/vagrant directory during the 'vagrant up' action.
  20
  21 Don't worry if you have any other provisioners, vagrant can work with multiple provisioners. Yay \o/
  22
  23 If home directory of the user is not `/home/vagrant` then you can specify that using the `user_home` option in above code
  24
  25       config.vm.provision :vagrant-dotfiles do |dotfiles_config|
  26           dotfiles_conf.user_home = '/home/some_other_user'
  27       emd
  28
  29 Note there are some edge cases with trying to copy your .ssh and .ssh/authorized_keys and .tmpssh* files over so the plugin doesn't clobber
  30 the vagrant key stored in .ssh/authorized_keys.
  31
  32 ### Fire !
  33
  34     $ vagrant up
  35
  36 And you'll be good to go.
  37
  38 ## Development Notes
  39
  40 Reminders for the occasional/accidental rubyist
  41
  42 Rebuilding the gem: gem build vagrant-dotfiles.gemspec
  43 Running the tests: rspec spec
  44 Loading the gem to the local dev environment: vagrant plugin install --local ./vagrant-dotfiles-1.0.0.gem
  45
  46 ## Feedback
  47 This is my first gem so any kind of feedback would be appreciated.
  48 Feel free fork, edit and send pull requests.
  49
  50 ## Copyrights & Author
  51
  52 Copyright(c) 2018 Jude Nagurney <jude@pwan.org>
  53 License: [MIT License](http://mit-license.org/)