nagrant
v1.3.0
Published
Nagrant is a pre-packaged Vagrant box providing a default environment in a minute
Downloads
91
Readme
Nagrant
Intro
Nagrant is a completely disposable pre-package vagrant box that provide you a simple development environment to create nodejs servers without requiring your to install anything (except nodejs and vagrant). Box can be created an launched in a minutes, with a minimal configuration !
Nagrant can run on Linux, Windows and Mac and include Nodejs v8, MongoDB 3.4, MySQL and Redis. More will be added.
How to use
You can either instal Nagrant as a global or local package.
- global :
nagrant make
- local :
$(npm bin)/nagrant make
Command list :
COMMANDS :
make --force --example --after create nagrant box
help <command> Show help
ARGUMENTS :
--force Force rewrite of Nagrant files
--example Include creation of Nagrant.yml.example file
--after Include creation of after script
OPTIONS :
--quiet Quiet mode
-v, --verbose Verbose mode
Requirements
Before using Nagrant, you must install Vagrant and any supported virtualization software (Virtualbox, VMWare or Parallels).
Node
To add any node instance to the vagran box, you can edit the node
property of the Nagrant.yml
file.
node:
- dir: /home/vagrant/node/
script: index.js
To send parameters to your node instance, you can use the params
property. Any property will be set as environment variable reachable with process.env
.
node:
- dir: /home/vagrant/node/
script: index.js
params:
- PORT: 8080
- MONGODB_NAME: testproject
Folders
To add any shared folders to the vagrant box, you can edit the folders
property of the Nagrant.yml
file.
folders:
- map: ~/Directory
to: /home/vagrant/Directory
Ports
This is a list of default ports fowarded to your Nagrant env:
- HTTP: 8000 → 80
- HTTPS: 44300 → 443
- MySQL: 33060 → 3306
- MongoDB: 27047 → 27017
- Redis: 63790 → 6379
Fowarding additional pots
ports:
- from: 8080
to: 80
- from: 443
to: 44300