Nanobox

Nanobox automates the creation of isolated, repeatable environments for local and production applications. When developing locally, Nanobox provisions your app's infrastructure inside of a virtual machine (VM) and mounts your local codebase into the VM. Any changes made to your codebase are reflected inside the virtual environment.

Once code is built and tested locally, Nanobox provisions and deploys an identical infrastructure on a production platform.

How It Works

Nanobox uses Virtual Box and Docker to create virtual development environments on your local machine. App configuration is handled in the boxfile.yml, a small yaml config file used to provision and configure your apps' environments both locally and in production.

Why Nanobox?

Nanobox allows you to stop configuring environments and just code. It guarantees that any project you start will work the same for anyone else collaborating on the project. When it's time to launch the project, you'll know that your production app will work, because it already works locally.

Installation

Nanobox can be installed in two different ways:

1. By using the Nanobox installer. (Recommended) .The installer includes all required dependencies (Virtual Box & Docker).
2. Manually installing the nanobox binaries.

Manually Installing Nanobox Binaries:

Nanobox requires two binaries:

• nanobox - The Nanobox CLI
• nanobox-update - The Nanobox update manager

Nanobox needs Virtual Box and Docker in order to run. If you don't already have these installed, you'll need to install them.

OSX and Linux:

1. Download the nanobox binaries.

$ wget https://s3.amazonaws.com/tools.nanobox.io/nanobox/v1/linux/amd64/nanobox
$ wget https://s3.amazonaws.com/tools.nanobox.io/nanobox/v1/linux/amd64/nanobox-update

2. Place the binaries in your $PATH (ex. ~/usr/bin) and run chmod 755 nanobox.
3. Run which nanobox to ensure it's accessible from your $PATH.
4. Type nanobox to view a list of available commands.

Windows

1. Place the nanobox.exe and nanobox-update.exe files in your $PATH (ex. C:\Program Files\Nanobox).
2. From a command line prompt, run where nanobox to ensure it's accessable from your $PATH.
3. Type nanobox to view a list of available commands.

Usage

Usage:
  nanobox [flags]
  nanobox [command]

Available Commands:
  status      Displays the status of your Nanobox VM & running platforms.
  deploy      Deploys your generated build package to a production app.
  console     Opens an interactive console inside a production component.
  link        Manages links between local & production apps.
  login       Authenticates your nanobox client with your nanobox.io account.
  logout      Removes your nanobox.io api token from your local nanobox client.
  build       Generates a deployable build package.
  clean       Clean out any environemnts that no longer exist
  dev         Manages your 'development' environment.
  sim         Manages your 'simulated' environment.
  tunnel      Creates a secure tunnel between your local machine & a production component.
  destroy     Destroys the Nanobox virtual machine.
  start       Starts the Nanobox virtual machine.
  stop        Stop the Nanobox virtual machine.

Flags:
      --debug         Increases display output and sets level to debug
  -h, --help          help for nanobox
  -v, --verbose       Increases display output and sets level to debug
  -V, --veryverbose   Increases display output and sets level to trace

Use "nanobox [command] --help" for more information about a command.

Documentation

• Nanobox documentation is available at docs.nanobox.io.
• Guides for popular languages, frameworks and services are avaialble at guides.nanobox.io.

Contributing

Contributing to Nanobox is easy. Just follow these contribution guidelines.

Contact

For help using Nanobox or if you have any questions/suggestions, please reach out to [email protected] or find us on IRC at #nanobox (freenode). You can also create a new issue on this project.