Gemfile.local.example 1.5 KB

123456789101112131415161718192021222324252627282930313233343536
  1. ##
  2. # Example Gemfile.local file for Metasploit Framework
  3. #
  4. # The Gemfile.local file provides a way to use other gems that are not
  5. # included in the standard Gemfile provided with Metasploit.
  6. # This filename is included in Metasploit's .gitignore file, so local changes
  7. # to this file will not accidentally show up in future pull requests. This
  8. # example Gemfile.local includes all gems in Gemfile using instance_eval.
  9. # It also creates a new bundle group, 'local', to hold additional gems.
  10. #
  11. # This file will not be used by default within the framework. As such, one
  12. # must first install the custom Gemfile.local with bundle:
  13. # bundle install --gemfile Gemfile.local
  14. #
  15. # Note that msfupdate does not consider Gemfile.local when updating the
  16. # framework. If it is used, it may be necessary to run the above bundle
  17. # command after the update.
  18. #
  19. ###
  20. # Include the Gemfile included with the framework. This is very
  21. # important for picking up new gem dependencies.
  22. msf_gemfile = File.join(File.dirname(__FILE__), 'Gemfile')
  23. if File.readable?(msf_gemfile)
  24. instance_eval(File.read(msf_gemfile))
  25. end
  26. # Create a custom group
  27. group :local do
  28. # This is the first way to add a non-standard gem file dependency in.
  29. gem 'lab', '~> 0.2.7'
  30. # And this is another way that references local directories to find and compile the gem file as needed.
  31. # This is the optimal method for testing Gem PRs such as those in rex-text or rex-powershell.
  32. gem 'rex-powershell', path: '../rex-powershell'
  33. end