Skip to content
This repository has been archived by the owner on May 14, 2021. It is now read-only.

Latest commit

 

History

History
132 lines (94 loc) · 4.29 KB

README.md

File metadata and controls

132 lines (94 loc) · 4.29 KB
Raw

Application_Javascript Cookbook

Build Status Gem Version Cookbook Version Coverage Gemnasium License

A Chef cookbook to deploy server-side JavaScript applications using Node.js or io.js.

Quick Start

To deploy an Express application from git:

application '/srv/myapp' do
  git 'https://github.com/example/myapp.git'
  npm_install
  npm_start
end

Requirements

Chef 12.1 or newer is required.

Resources

application_javascript

The application_javascript resource installs a JavaScript runtime for the deployment.

application '/srv/myapp' do
  javascript '3'
end

All actions and properties are the same as the javascript_runtime resource.

application_javascript_service

The application_javascript_javascript_service resource creates a service for a JavaScript command.

application '/srv/myapp' do
  javascript_service 'main.js'
end

Actions

  • :enable – Create, enable and start the service. (default)
  • :disable – Stop, disable, and destroy the service.
  • :start – Start the service.
  • :stop – Stop the service.
  • :restart – Stop and then start the service.
  • :reload – Send the configured reload signal to the service.

Properties

  • command – Command to run. (name attribute)
  • path – Base path for the application. (default: application path)
  • service_name – Name of the service to create. (default: auto-detect)

user – User to run the service as. (default: application owner)

application_node_package

The application_node_package resource installs NPM packages for the deployment.

application '/srv/myapp' do
  node_package 'grunt-cli'
end

All actions and properties are the same as the node_package resource, except that the group and user properties default to the application-level data if not specified.

application_npm_start

The application_npm_start resource creates a service for a JavaScript application using npm start.

application '/srv/myapp' do
  npm_start
end

Actions

  • :enable – Create, enable and start the service. (default)
  • :disable – Stop, disable, and destroy the service.
  • :start – Start the service.
  • :stop – Stop the service.
  • :restart – Stop and then start the service.
  • :reload – Send the configured reload signal to the service.

Properties

  • path – Base path for the application. (default: name attribute)
  • command – NPM subcommand to run. (default: start)
  • service_name – Name of the service to create. (default: auto-detect)

user – User to run the service as. (default: application owner)

Sponsors

Development sponsored by Chef Software, Symonds & Son, and Orion.

The Poise test server infrastructure is sponsored by Rackspace.

License

Copyright 2015-2017, Noah Kantrowitz

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.