/vagrant-impressbox

Vagrant plugin for creating Vagrant templates and do provisions for ImpressCMS development boxes

Primary LanguageRubyMIT LicenseMIT

Gem Gem license Inline docs codebeat badge

ImpressBox

NOTE: this readme is for 0.2 version. Please wait for the release!

ImpressBox is plugin to make easier to configure web development virtual enviroment for Vagrant. It comes with some predefined templates for some frameworks and CMS'es (latest versions):

Installation

Run below command from your command line:

vagrant plugin install vagrant-impressbox

Usage

To use Impressbox plugin, you can run vagrant impressbox command from command line. It will create required configuration files. Also it's possible to use some options to modify default configuration files creation behavior:

vagrant impressbox [options]

  -b, --box=BOX_NAME               Box name for new box
      --ip=IP                      Defines IP
      --url=HOSTNAME               Hostname associated with this box
      --memory=RAM                 How much RAM (in megabytes)?
      --cpus=CPU_NUMBER            How much CPU?
  -r, --recreate                   Recreates config instead of updating (so you don't need to delete first)
  -t, --template=NAME              This argument says that predefined config will be used when creating box.
  -h, --help                       Print this help

For example if you want to create new a project based on ImpressCMS, you must execute this command:

vagrant impressbox -t impresscms -r

Also such command would work in this case too:

vagrant impressbox -r

For Laravel such command is needed:

vagrant impressbox -t laravel -r

And so on.

Development & Contributing

If you want to try add something to this plugin, you need before starting do these things:

  • Clone this repository
  • Open command line in cloned directory
  • Run bundle

If you want to your changes, you can run bundle exec vagrant impressbox command (also here is possible to use some commands options).

Bug reports and pull requests are welcome on GitHub.