Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 1.89 KB

README.md

File metadata and controls

83 lines (62 loc) · 1.89 KB
Raw

Node.js

This is a Node.js engine for running node apps with Nanobox.

Usage

To use the Node.js engine, specify nodejs as your engine in your boxfile.yml

run.config:
  engine: nodejs

Build Process

When running your app, this engine compiles code by doing the following:

  • yarn install

Configuration Options

This engine exposes configuration options through the Boxfile, a yaml config file used to provision and configure your app's infrastructure when using Nanobox.

Overview of Boxfile Configuration Options

run.config:
  engine: nodejs
  engine.config:
    runtime: nodejs-4.4
    dep_manager: yarn
    python_version: python-2.7

runtime

Specifies which Node.js runtime and version to use. The following runtimes are available:

  • nodejs-0.8
  • nodejs-0.10
  • nodejs-0.12
  • nodejs-4.8
  • nodejs-5.12
  • nodejs-6.11
  • nodejs-7.10
  • nodejs-8.6
  • nodejs-8.9
run.config:
  engine: nodejs
  engine.config:
    runtime: nodejs-8.6

dep_manager

Specifies whether the engine should use npm or yarn to fetch node modules. Defaults to yarn.

run.config:
  engine.config:
    dep_manager: yarn

python_version

Specifies the version of Python to install with the following available values:

  • python-2.7
  • python-3.4
  • python-3.5
  • python-3.6 (Default)
run.config:
  engine.config:
    python_version: python-2.7

Help & Support

This is a generic (non-framework-specific) Node.js engine provided by Nanobox. If you need help with this engine, you can reach out to us in the #nanobox IRC channel. If you are running into an issue with the engine, feel free to create a new issue on this project.