This automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here using GitHub Flavored Markdown, select a template crafted by a designer, and publish. After your page is generated, you can check out the new branch:
If you're using the GitHub for Mac, simply sync your repository and you'll see the new branch.
+
+
Designer Templates
+
+
We've crafted some handsome templates for you to use. Go ahead and continue to layouts to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved if it remained markdown format.
+
+
Rather Drive Stick?
+
+
If you prefer to not use the automatic generator, push a branch named gh-pages to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator written by our own Tom Preston-Werner. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.
+
+
Authors and Contributors
+
+
You can @mention a GitHub username to generate a link to their profile. The resulting <a> element will link to the contributor's GitHub Profile. For example: In 2007, Chris Wanstrath (@defunkt), PJ Hyett (@pjhyett), and Tom Preston-Werner (@mojombo) founded GitHub.
You can @mention a GitHub username to generate a link to their profile. The resulting <a> element will link to the contributor's GitHub Profile. For example: In 2007, Chris Wanstrath (@defunkt), PJ Hyett (@pjhyett), and Tom Preston-Werner (@mojombo) founded GitHub.
+
Export
-
Support or Contact
+
Node Foreman is designed to be in a development environment,
+however it can export an Upstart job for use in production.
+The Upstart file has no dependency on Node Foreman.
$ nf start web=2,api=2
+
+18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000
+18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001
+18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100
+18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101
+
Export
@@ -74,7 +115,7 @@
Export
however it can export an Upstart job for use in production.
The Upstart file has no dependency on Node Foreman.
-
nf export upstart -a JOBNAME /etc/init
+
$ nf export upstart -a JOBNAME /etc/init
diff --git a/params.json b/params.json
index 216b7fa..023abb1 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"tagline":"A Node.js Version of Foreman","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n npm install -g foreman\r\n\r\n## Usage\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node server.js\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nStart your process with `nf` (node-foreman):\r\n\r\n nf start\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n nf start web=5\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable.\r\n\r\n## Export\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n nf export upstart -a JOBNAME /etc/init\r\n\r\n","google":""}
\ No newline at end of file
+{"tagline":"A Node.js Version of Foreman","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node server.js\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables, by concatenating the nested\r\nvalues with an underscore.\r\n\r\nStart your process with `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n .env\r\n package.js\r\n server.js\r\n Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different type will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME /etc/init\r\n\r\n\r\n","google":""}
\ No newline at end of file
From 9435dd6fd6378a0cf907518fb00d3b20f0367f54 Mon Sep 17 00:00:00 2001
From: Jacob Groundwater
Date: Sat, 20 Oct 2012 18:58:54 -0700
Subject: [PATCH 04/18] Create gh-pages branch via GitHub
---
index.html | 4 +++-
params.json | 2 +-
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/index.html b/index.html
index af0c728..ec056e4 100644
--- a/index.html
+++ b/index.html
@@ -44,7 +44,9 @@
Optionally create a .env file to pre-load environmental variables:
diff --git a/params.json b/params.json
index 023abb1..bf10449 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"tagline":"A Node.js Version of Foreman","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node server.js\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables, by concatenating the nested\r\nvalues with an underscore.\r\n\r\nStart your process with `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n .env\r\n package.js\r\n server.js\r\n Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different type will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME /etc/init\r\n\r\n\r\n","google":""}
\ No newline at end of file
+{"tagline":"A Node.js Version of Foreman","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables, by concatenating the nested\r\nvalues with an underscore.\r\n\r\nStart your process with `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n .env\r\n package.js\r\n server.js\r\n Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different type will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME /etc/init\r\n\r\n\r\n","google":""}
\ No newline at end of file
From dd829bbd3a13cba4372f3686ae6b2e8187f9af4a Mon Sep 17 00:00:00 2001
From: Jacob Groundwater
Date: Sat, 20 Oct 2012 21:25:39 -0700
Subject: [PATCH 05/18] Create gh-pages branch via GitHub
---
index.html | 25 +++++++++++++++++--------
params.json | 2 +-
2 files changed, 18 insertions(+), 9 deletions(-)
diff --git a/index.html b/index.html
index ec056e4..fd0593f 100644
--- a/index.html
+++ b/index.html
@@ -55,7 +55,7 @@
Usage
MYSQL_PASS=cryptonite
-
The .env file may alternatively be a valid JSON document:
+
The equivalent .env file may alternatively be a valid JSON document:
{
"mysql":{
@@ -65,8 +65,10 @@
Usage
}
-
The above JSON document will be flattened into env variables, by concatenating the nested
-values with an underscore.
+
The above JSON document will be flattened into env variables by
+concatenating the nested values with an underscore.
+Environmental variables are passed in fully capitalized.
+There is no need to specify which type of file you wish to use.
Start your process with nf (node-foreman):
@@ -79,10 +81,11 @@
Usage
Your module directory should end up looking like the following:
Each job will be started as its own process, receiving a different PORT
environmental variable.
The port number for processes of the same type will be offset by 1.
-The port number for processes of different type will be offset by 100.
+The port number for processes of different types will be offset by 100.
$ nf start web=2,api=2
@@ -118,6 +121,12 @@
Export
The Upstart file has no dependency on Node Foreman.
$ nf export upstart -a JOBNAME /etc/init
+
+
+
Start and stop your jobs with
+
+
$ sudo start JOBNAME
+$ sudo stop JOBNAME
diff --git a/params.json b/params.json
index bf10449..0cb629e 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"tagline":"A Node.js Version of Foreman","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables, by concatenating the nested\r\nvalues with an underscore.\r\n\r\nStart your process with `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n .env\r\n package.js\r\n server.js\r\n Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different type will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME /etc/init\r\n\r\n\r\n","google":""}
\ No newline at end of file
+{"tagline":"A Node.js Version of Foreman","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\nThere is no need to specify which type of file you wish to use.\r\n\r\nStart your process with `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME /etc/init\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\n","google":""}
\ No newline at end of file
From e8b453813e40b1549ea210804ba7308092c1554e Mon Sep 17 00:00:00 2001
From: Jacob Groundwater
Date: Sun, 21 Oct 2012 22:09:05 -0700
Subject: [PATCH 06/18] Create gh-pages branch via GitHub
---
index.html | 22 ++++++++++++++++++----
params.json | 2 +-
2 files changed, 19 insertions(+), 5 deletions(-)
diff --git a/index.html b/index.html
index fd0593f..1e5b54d 100644
--- a/index.html
+++ b/index.html
@@ -42,6 +42,8 @@
Install
Usage
+
Procfile
+
Create a Procfile in the form of:
web: node web_server.js
@@ -49,6 +51,8 @@
Usage
log: node log_server.js
+
Environmental Variables
+
Optionally create a .env file to pre-load environmental variables:
MYSQL_NAME=superman
@@ -67,10 +71,20 @@
Usage
The above JSON document will be flattened into env variables by
concatenating the nested values with an underscore.
-Environmental variables are passed in fully capitalized.
-There is no need to specify which type of file you wish to use.
+Environmental variables are passed in fully capitalized.
+
+
There is no need to specify which type of file you wish to use.
+
+
Basic Usage
-
Start your process with nf (node-foreman):
+
To start your processes use nf (node-foreman):
$ nf start
@@ -114,7 +128,7 @@
Advanced Usage
18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101
-
Export
+
Export to Production
Node Foreman is designed to be in a development environment,
however it can export an Upstart job for use in production.
diff --git a/params.json b/params.json
index 0cb629e..43481c3 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"tagline":"A Node.js Version of Foreman","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\nThere is no need to specify which type of file you wish to use.\r\n\r\nStart your process with `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME /etc/init\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\n","google":""}
\ No newline at end of file
+{"note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","google":"","tagline":"A Node.js Version of Foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\n### Procfile\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\n### Environmental Variables\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\n\r\n\r\n{\r\n \"mysql\":{\r\n \"name\": \"superman\", # => MYSQL_NAME=superman\r\n \"pass\": \"cryptonite\" # => MYSQL_PASS=cryptonite\r\n }\r\n}\r\n\r\nThere is no need to specify which type of file you wish to use.\r\n\r\n### Basic Usage\r\n\r\nTo start your processes use `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export to Production\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME /etc/init\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\n"}
\ No newline at end of file
From 93c0491b6a33eb249392029ee6b95e69bb15f3fa Mon Sep 17 00:00:00 2001
From: Jacob Groundwater
Date: Sun, 21 Oct 2012 22:10:42 -0700
Subject: [PATCH 07/18] Create gh-pages branch via GitHub
---
index.html | 5 +++--
params.json | 2 +-
2 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/index.html b/index.html
index 1e5b54d..83d6ee4 100644
--- a/index.html
+++ b/index.html
@@ -73,12 +73,13 @@
Environmental Variables
concatenating the nested values with an underscore.
Environmental variables are passed in fully capitalized.
There is no need to specify which type of file you wish to use.
diff --git a/params.json b/params.json
index 43481c3..6d9ef5a 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","google":"","tagline":"A Node.js Version of Foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\n### Procfile\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\n### Environmental Variables\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\n\r\n\r\n{\r\n \"mysql\":{\r\n \"name\": \"superman\", # => MYSQL_NAME=superman\r\n \"pass\": \"cryptonite\" # => MYSQL_PASS=cryptonite\r\n }\r\n}\r\n\r\nThere is no need to specify which type of file you wish to use.\r\n\r\n### Basic Usage\r\n\r\nTo start your processes use `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export to Production\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME /etc/init\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\n"}
\ No newline at end of file
+{"name":"Node-foreman","tagline":"A Node.js Version of Foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\n### Procfile\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\n### Environmental Variables\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\n\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\", # => MYSQL_NAME=superman\r\n \"pass\": \"cryptonite\" # => MYSQL_PASS=cryptonite\r\n }\r\n }\r\n\r\nThere is no need to specify which type of file you wish to use.\r\n\r\n### Basic Usage\r\n\r\nTo start your processes use `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export to Production\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME /etc/init\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
From 217456e985df24542ffb5ffc08c727c78a5df002 Mon Sep 17 00:00:00 2001
From: Jacob Groundwater
Date: Sun, 21 Oct 2012 22:13:18 -0700
Subject: [PATCH 08/18] Create gh-pages branch via GitHub
---
index.html | 2 +-
params.json | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/index.html b/index.html
index 83d6ee4..4f90223 100644
--- a/index.html
+++ b/index.html
@@ -135,7 +135,7 @@
Export to Production
however it can export an Upstart job for use in production.
The Upstart file has no dependency on Node Foreman.
-
$ nf export upstart -a JOBNAME /etc/init
+
$ nf export upstart -a JOBNAME -o /etc/init
Start and stop your jobs with
diff --git a/params.json b/params.json
index 6d9ef5a..f6fbf2f 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"name":"Node-foreman","tagline":"A Node.js Version of Foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\n### Procfile\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\n### Environmental Variables\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\n\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\", # => MYSQL_NAME=superman\r\n \"pass\": \"cryptonite\" # => MYSQL_PASS=cryptonite\r\n }\r\n }\r\n\r\nThere is no need to specify which type of file you wish to use.\r\n\r\n### Basic Usage\r\n\r\nTo start your processes use `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export to Production\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME /etc/init\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
+{"google":"","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\n### Procfile\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\n### Environmental Variables\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\n\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\", # => MYSQL_NAME=superman\r\n \"pass\": \"cryptonite\" # => MYSQL_PASS=cryptonite\r\n }\r\n }\r\n\r\nThere is no need to specify which type of file you wish to use.\r\n\r\n### Basic Usage\r\n\r\nTo start your processes use `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export to Production\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME -o /etc/init\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\n","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","tagline":"A Node.js Version of Foreman"}
\ No newline at end of file
From 125967056b037f8fea8a2122066cf1fc15ababd9 Mon Sep 17 00:00:00 2001
From: Jacob Groundwater
Date: Sun, 21 Oct 2012 22:29:09 -0700
Subject: [PATCH 09/18] Create gh-pages branch via GitHub
---
index.html | 14 ++++++++++++++
params.json | 2 +-
2 files changed, 15 insertions(+), 1 deletion(-)
diff --git a/index.html b/index.html
index 4f90223..926277f 100644
--- a/index.html
+++ b/index.html
@@ -143,6 +143,20 @@
Export to Production
$ sudo start JOBNAME
$ sudo stop JOBNAME
+
+
The export will occur with whatever environmental variables are
+listed in the .env file.
+
+
You can specify the type and number of processes exported using
+the type=num syntax:
+
+
$ nf export upstart -a JOBNAME -o /etc/init web=2,api=2
+
+
+
Use -u <USER> to have the exported job run as USER.
+Note that if you need to bind to privileged ports, you must
+start as root. In such a case, we advise you to drop user
+permissions after binding.
diff --git a/params.json b/params.json
index f6fbf2f..c21948a 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"google":"","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\n### Procfile\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\n### Environmental Variables\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\n\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\", # => MYSQL_NAME=superman\r\n \"pass\": \"cryptonite\" # => MYSQL_PASS=cryptonite\r\n }\r\n }\r\n\r\nThere is no need to specify which type of file you wish to use.\r\n\r\n### Basic Usage\r\n\r\nTo start your processes use `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export to Production\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME -o /etc/init\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\n","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","tagline":"A Node.js Version of Foreman"}
\ No newline at end of file
+{"name":"Node-foreman","tagline":"A Node.js Version of Foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\n### Procfile\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\n### Environmental Variables\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\n\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\", # => MYSQL_NAME=superman\r\n \"pass\": \"cryptonite\" # => MYSQL_PASS=cryptonite\r\n }\r\n }\r\n\r\nThere is no need to specify which type of file you wish to use.\r\n\r\n### Basic Usage\r\n\r\nTo start your processes use `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export to Production\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME -o /etc/init\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\nThe export will occur with whatever environmental variables are \r\nlisted in the .env file.\r\n\r\nYou can specify the type and number of processes exported using \r\nthe `type=num` syntax:\r\n\r\n $ nf export upstart -a JOBNAME -o /etc/init web=2,api=2\r\n\r\nUse `-u ` to have the exported job run as `USER`.\r\nNote that if you need to bind to privileged ports, you _must_\r\nstart as `root`. In such a case, we advise you to drop user\r\npermissions after binding.\r\n\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
From 71ab3f32279d428397757eb84a4e0fea66d782ed Mon Sep 17 00:00:00 2001
From: Jacob Groundwater
Date: Mon, 22 Oct 2012 00:22:53 -0700
Subject: [PATCH 10/18] Create gh-pages branch via GitHub
---
index.html | 26 ++++++++++++++++++++++++--
params.json | 2 +-
2 files changed, 25 insertions(+), 3 deletions(-)
diff --git a/index.html b/index.html
index 926277f..7031ca9 100644
--- a/index.html
+++ b/index.html
@@ -135,7 +135,29 @@
Export to Production
however it can export an Upstart job for use in production.
The Upstart file has no dependency on Node Foreman.
-
You can specify the type and number of processes exported using
the type=num syntax:
-
$ nf export upstart -a JOBNAME -o /etc/init web=2,api=2
+
$ nf export -a JOBNAME -o /etc/init web=2,api=2
Use -u <USER> to have the exported job run as USER.
diff --git a/params.json b/params.json
index c21948a..636d8b8 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"name":"Node-foreman","tagline":"A Node.js Version of Foreman","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\n### Procfile\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\n### Environmental Variables\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\n\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\", # => MYSQL_NAME=superman\r\n \"pass\": \"cryptonite\" # => MYSQL_PASS=cryptonite\r\n }\r\n }\r\n\r\nThere is no need to specify which type of file you wish to use.\r\n\r\n### Basic Usage\r\n\r\nTo start your processes use `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export to Production\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export upstart -a JOBNAME -o /etc/init\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\nThe export will occur with whatever environmental variables are \r\nlisted in the .env file.\r\n\r\nYou can specify the type and number of processes exported using \r\nthe `type=num` syntax:\r\n\r\n $ nf export upstart -a JOBNAME -o /etc/init web=2,api=2\r\n\r\nUse `-u ` to have the exported job run as `USER`.\r\nNote that if you need to bind to privileged ports, you _must_\r\nstart as `root`. In such a case, we advise you to drop user\r\npermissions after binding.\r\n\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
+{"body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\n### Procfile\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\n### Environmental Variables\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\n\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\", # => MYSQL_NAME=superman\r\n \"pass\": \"cryptonite\" # => MYSQL_PASS=cryptonite\r\n }\r\n }\r\n\r\nThere is no need to specify which type of file you wish to use.\r\n\r\n### Basic Usage\r\n\r\nTo start your processes use `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export to Production\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export\r\n Loaded ENV .env File as JSON Format\r\n Wrote : ./foreman-web-1.conf\r\n Wrote : ./foreman-web.conf\r\n Wrote : ./foreman-api-1.conf\r\n Wrote : ./foreman-api.conf\r\n Wrote : ./foreman-log-1.conf\r\n Wrote : ./foreman-log.conf\r\n Wrote : ./foreman.conf\r\n\r\nYou can inspect your upstart files before placing them in the right\r\ndirectory, or have foreman do it for you:\r\n\r\n $ sudo nf export -o /etc/init\r\n Loaded ENV .env File as JSON Format\r\n Wrote : /etc/init/foreman-api-1.conf\r\n Wrote : /etc/init/foreman-web.conf\r\n Wrote : /etc/init/foreman-api.conf\r\n Wrote : /etc/init/foreman-log.conf\r\n Wrote : /etc/init/foreman-log-1.conf\r\n Wrote : /etc/init/foreman-web-1.conf\r\n Wrote : /etc/init/foreman.conf\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\nThe export will occur with whatever environmental variables are \r\nlisted in the .env file.\r\n\r\nYou can specify the type and number of processes exported using \r\nthe `type=num` syntax:\r\n\r\n $ nf export -a JOBNAME -o /etc/init web=2,api=2\r\n\r\nUse `-u ` to have the exported job run as `USER`.\r\nNote that if you need to bind to privileged ports, you _must_\r\nstart as `root`. In such a case, we advise you to drop user\r\npermissions after binding.\r\n\r\n","google":"","tagline":"A Node.js Version of Foreman","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman"}
\ No newline at end of file
From e4df2d32254313ea0470c2448ccb3be7fc8283a5 Mon Sep 17 00:00:00 2001
From: Jacob Groundwater
Date: Mon, 22 Oct 2012 00:59:51 -0700
Subject: [PATCH 11/18] Create gh-pages branch via GitHub
---
index.html | 10 +++++++++-
params.json | 2 +-
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/index.html b/index.html
index 7031ca9..6de25f6 100644
--- a/index.html
+++ b/index.html
@@ -30,9 +30,17 @@
A Node.js Version of Foreman
Node Foreman
-
Node Foreman is a Node.js version of the popular Foreman tool,
+
Node Foreman is a Node.js version of the popular
+Foreman tool,
with a few Node specific changes.
+
+
Foreman is a manager for Procfile-based applications.
+Its aim is to abstract away the details of the Procfile
+format, and allow you to either run your application
+directly or export it to some other process management format.
+
+
Install
Install the command line tool
diff --git a/params.json b/params.json
index 636d8b8..9775f76 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular Foreman tool,\r\nwith a few Node specific changes.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\n### Procfile\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\n### Environmental Variables\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\n\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\", # => MYSQL_NAME=superman\r\n \"pass\": \"cryptonite\" # => MYSQL_PASS=cryptonite\r\n }\r\n }\r\n\r\nThere is no need to specify which type of file you wish to use.\r\n\r\n### Basic Usage\r\n\r\nTo start your processes use `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export to Production\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export\r\n Loaded ENV .env File as JSON Format\r\n Wrote : ./foreman-web-1.conf\r\n Wrote : ./foreman-web.conf\r\n Wrote : ./foreman-api-1.conf\r\n Wrote : ./foreman-api.conf\r\n Wrote : ./foreman-log-1.conf\r\n Wrote : ./foreman-log.conf\r\n Wrote : ./foreman.conf\r\n\r\nYou can inspect your upstart files before placing them in the right\r\ndirectory, or have foreman do it for you:\r\n\r\n $ sudo nf export -o /etc/init\r\n Loaded ENV .env File as JSON Format\r\n Wrote : /etc/init/foreman-api-1.conf\r\n Wrote : /etc/init/foreman-web.conf\r\n Wrote : /etc/init/foreman-api.conf\r\n Wrote : /etc/init/foreman-log.conf\r\n Wrote : /etc/init/foreman-log-1.conf\r\n Wrote : /etc/init/foreman-web-1.conf\r\n Wrote : /etc/init/foreman.conf\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\nThe export will occur with whatever environmental variables are \r\nlisted in the .env file.\r\n\r\nYou can specify the type and number of processes exported using \r\nthe `type=num` syntax:\r\n\r\n $ nf export -a JOBNAME -o /etc/init web=2,api=2\r\n\r\nUse `-u ` to have the exported job run as `USER`.\r\nNote that if you need to bind to privileged ports, you _must_\r\nstart as `root`. In such a case, we advise you to drop user\r\npermissions after binding.\r\n\r\n","google":"","tagline":"A Node.js Version of Foreman","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman"}
\ No newline at end of file
+{"tagline":"A Node.js Version of Foreman","note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Node-foreman","google":"","body":"# Node Foreman\r\n\r\nNode Foreman is a Node.js version of the popular \r\n[Foreman](http://ddollar.github.com/foreman/) tool,\r\nwith a few Node specific changes.\r\n\r\n> Foreman is a manager for Procfile-based applications. \r\n> Its aim is to abstract away the details of the Procfile \r\n> format, and allow you to either run your application \r\n> directly or export it to some other process management format.\r\n\r\n## Install\r\n\r\nInstall the command line tool\r\n\r\n $ npm install -g foreman\r\n\r\n## Usage\r\n\r\n### Procfile\r\n\r\nCreate a `Procfile` in the form of:\r\n \r\n web: node web_server.js\r\n api: node api_server.js\r\n log: node log_server.js\r\n\r\n### Environmental Variables\r\n\r\nOptionally create a `.env` file to pre-load environmental variables:\r\n\r\n MYSQL_NAME=superman\r\n MYSQL_PASS=cryptonite\r\n\r\nThe equivalent `.env` file may alternatively be a valid JSON document:\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\",\r\n \"pass\": \"cryptonite\"\r\n }\r\n }\r\n\r\nThe above JSON document will be flattened into env variables by \r\nconcatenating the nested values with an underscore.\r\nEnvironmental variables are passed in fully capitalized.\r\n\r\n\r\n {\r\n \"mysql\":{\r\n \"name\": \"superman\", # => MYSQL_NAME=superman\r\n \"pass\": \"cryptonite\" # => MYSQL_PASS=cryptonite\r\n }\r\n }\r\n\r\nThere is no need to specify which type of file you wish to use.\r\n\r\n### Basic Usage\r\n\r\nTo start your processes use `nf` (node-foreman):\r\n\r\n $ nf start\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:13: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:13: log.1 | Log Server started listening on 0.0.0.0:5200\r\n\r\nYour module directory should end up looking like the following:\r\n\r\n /\r\n ├─ .env\r\n ├─ package.js\r\n ├─ server.js\r\n ├─ Procfile\r\n\r\n### Advanced Usage\r\n\r\nNode Foreman lets you start multiple jobs of the same type:\r\n\r\n $ nf start web=5\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: web.3 | Web Server started listening on 0.0.0.0:5002\r\n 18:51:12: web.4 | Web Server started listening on 0.0.0.0:5003\r\n 18:51:12: web.5 | Web Server started listening on 0.0.0.0:5004\r\n\r\nEach job will be started as its own process, receiving a different `PORT`\r\nenvironmental variable. \r\nThe port number for processes of the same type will be offset by 1.\r\nThe port number for processes of different types will be offset by 100.\r\n\r\n $ nf start web=2,api=2\r\n \r\n 18:51:12: web.1 | Web Server started listening on 0.0.0.0:5000\r\n 18:51:12: web.2 | Web Server started listening on 0.0.0.0:5001\r\n 18:51:12: api.1 | Api Server started listening on 0.0.0.0:5100\r\n 18:51:12: api.2 | Api Server started listening on 0.0.0.0:5101\r\n\r\n## Export to Production\r\n\r\nNode Foreman is designed to be in a development environment,\r\nhowever it can export an Upstart job for use in production.\r\nThe Upstart file has _no_ dependency on Node Foreman.\r\n\r\n $ nf export\r\n Loaded ENV .env File as JSON Format\r\n Wrote : ./foreman-web-1.conf\r\n Wrote : ./foreman-web.conf\r\n Wrote : ./foreman-api-1.conf\r\n Wrote : ./foreman-api.conf\r\n Wrote : ./foreman-log-1.conf\r\n Wrote : ./foreman-log.conf\r\n Wrote : ./foreman.conf\r\n\r\nYou can inspect your upstart files before placing them in the right\r\ndirectory, or have foreman do it for you:\r\n\r\n $ sudo nf export -o /etc/init\r\n Loaded ENV .env File as JSON Format\r\n Wrote : /etc/init/foreman-api-1.conf\r\n Wrote : /etc/init/foreman-web.conf\r\n Wrote : /etc/init/foreman-api.conf\r\n Wrote : /etc/init/foreman-log.conf\r\n Wrote : /etc/init/foreman-log-1.conf\r\n Wrote : /etc/init/foreman-web-1.conf\r\n Wrote : /etc/init/foreman.conf\r\n\r\nStart and stop your jobs with\r\n\r\n $ sudo start JOBNAME\r\n $ sudo stop JOBNAME\r\n\r\nThe export will occur with whatever environmental variables are \r\nlisted in the .env file.\r\n\r\nYou can specify the type and number of processes exported using \r\nthe `type=num` syntax:\r\n\r\n $ nf export -a JOBNAME -o /etc/init web=2,api=2\r\n\r\nUse `-u ` to have the exported job run as `USER`.\r\nNote that if you need to bind to privileged ports, you _must_\r\nstart as `root`. In such a case, we advise you to drop user\r\npermissions after binding.\r\n\r\n"}
\ No newline at end of file
From 85b2122f361b526c7d0beaea55104d64b53df318 Mon Sep 17 00:00:00 2001
From: Jacob Groundwater
Date: Mon, 22 Oct 2012 09:45:00 -0700
Subject: [PATCH 12/18] Create gh-pages branch via GitHub
---
index.html | 12 +++++++++++-
params.json | 2 +-
2 files changed, 12 insertions(+), 2 deletions(-)
diff --git a/index.html b/index.html
index 6de25f6..d4f90df 100644
--- a/index.html
+++ b/index.html
@@ -190,6 +190,16 @@