Updated to support local.ecosystem.json and to have a separate Install guide

Author: Nishad Bakshi

app/templates/INSTALL.mdown

@@ -0,0 +1,82 @@
+#Deploying to a server
+
+To deploy, make sure both your local machine and your remote server/deployment target have pm2 installed with:
+
+`npm install pm2 -g`
+
+Make sure you have the file `ecosystem.json` with any saved deployment targets inside, to create this file or add a new deployment target run:
+
+`gulp add-deploy-target`
+
+`ecosystem.json` will include any config as well as any deployment config along with your credentials. If you need to put in any credentials or sensitive information that can't be in the repository then answer the final question from `gulp add-deploy-target` with a yes and it will put the deployment config into `local.ecosystem.json`.
+
+Once you've got your TARGETNAME (answer to the first question in `gulp add-deploy-target`) you can initialize the target host with:
+
+`pm2 deploy TARGETNAME setup`
+
+Then deploy your latest code from your git repository and run any post-deploy commands with:
+
+`pm2 deploy TARGETNAME`
+
+**Hint**, pm2 automatically looks for `ecosystem.json` in your current directory, but you can use your `local.ecosystem.json` configuration with `pm2 deploy local.ecosystem.json TARGETNAME`
+
+If you have files you haven't commited, pm2 will ask you to commit them before deploying, to ignore this use `--force`:
+
+`pm2 deploy TARGETNAME --force`
+
+You will now need to ssh into the server, once you've ssh'd in it's very **Important** that when deploying to a secure server that you do all pm2 commands as the pm2 user by using:
+
+`sudo su pm2`
+
+You can then navigate to the app's folder that you chose during `gulp add-deploy-target`.
+
+Once you're in the folder you should have 3 folders: 'current',  'shared', and 'source'; go into the current folder:
+
+`cd current`
+
+You can now launch the app using pm2 with:
+
+`pm2 startOrRestart ecosystem.json`
+
+You can also launch the app using different environment configurations in ecosystem.json (env name prefixed with "env_"), for example:
+
+`pm2 startOrRestart ecosystem.json --env prod`
+
+You should then save your current pm2 deployments with:
+
+`pm2 save`
+
+Running `pm2 save` whenever you deploy a new app is very important as in the event of a server restart the previously saved apps will be resurrected.
+
+Now that the app is started you will not have to stop or restart it when making updates. pm2 will automatically restart the app if any of it's files are changed so you can do `pm2 deploy TARGETNAME --force` from your local machine and the pm2 will automatically restart the app with any changes!
+
+#Administration
+
+To view all running pm2 applications use:
+
+`pm2 list`
+
+To view any logs use:
+
+`pm2 logs`
+
+To monitor ram or cpu usage use:
+
+`pm2 monit`
+
+**If** you've deployed applications previously but don't see them when you run pm2 list then it might be because you're not logged in as the pm2 user or you deployed them under a different user.
+
+If you accidently launch pm2 under your own account then you can kill the process with:
+
+`pm2 kill`
+
+And if you accidently run that command when logged in as the pm2 user then you can start pm2 and resurrect all processes from the last `pm2 save` with:
+
+`pm2 resurrect`
+
+For more information use the help commands or consult the documentation [here](http://pm2.keymetrics.io/docs/usage/quick-start/):
+
+`pm2 help`
+
+`pm2 deploy help`
+

app/templates/README.mdown

@@ -69,85 +69,3 @@ Or on Windows:
 The application comes with a sample set of JSON data. The detail controller,
 the part that handles showing your data, can not only handle JSON, but also
 XML, Binary, and Text data out of the box.
-
-## Running with PM2
-
-To run you must first install pm2 if you do not have it with:
-
-`npm install pm2 -g`
-
-It's very **Important** that when deploying to a secure server that you do all pm2 commands as the pm2 user by using:
-
-`sudo su pm2`
-
-You can then launch the app using pm2 with:
-
-`pm2 startOrRestart boot.json`
-
-You can also launch the app using different environment configurations in boot.json (env name prefixed with "env_"), for example:
-
-`pm2 startOrRestart boot.json --env prod`
-
-You can also save your current pm2 deployments with:
-
-`pm2 save`
-
-You should run `pm2 save` whenever you deploy a new app.
-
-To view all running pm2 applications use:
-
-`pm2 list`
-
-To view any logs use:
-
-`pm2 logs`
-
-To monitor ram or cpu usage use:
-
-`pm2 monit`
-
-**If** you've deployed applications previously but don't see them when you run pm2 list then it might be because you're not logged in as the pm2 user or you deployed them under a different user.
-
-If you accidently launch pm2 under your own account then you can kill the process with:
-
-`pm2 kill`
-
-And if you accidently run that command when logged in as the pm2 user then you can start pm2 and resurrect all processes from the last `pm2 save` with:
-
-`pm2 resurrect`
-
-For more information use:
-
-`pm2 help`
-
-## Deploying with PM2
-
-To deploy, make sure both your local machine and your remote server/deployment target have pm2 installed with:
-
-`npm install pm2 -g`
-
-Make sure you have the file `ecosystem.json` with any saved deployment targets inside, to create this file or add a new deployment target run:
-
-`gulp add-deploy-target`
-
-`ecosystem.json` will include any config as well as any deployment config along with your credentials. It is git ignored by default and we recommend you avoid commiting it and instead put any repository appropriate configuration in `boot.json`
-
-First initialize the target host:
-
-`pm2 deploy TARGETNAME setup`
-
-Then deploy your latest code from your git repository and run any post-deploy commands with:
-
-`pm2 deploy TARGETNAME`
-
-**Hint**, pm2 automatically looks `ecosystem.json` in your current directory, but you can use other config files with `pm2 deploy otherEcosystemFile.json TARGETNAME`
-
-If you have files you haven't commited, pm2 will ask you to commit them before deploying, to ignore this use `--force`:
-
-`pm2 deploy TARGETNAME --force`
-
-With your application deployed follow the above "Running with PM2" instructions to start the application, once you've started the app it will listen for changes and automatically restart when you make deploy changes with `pm2 deploy TARGETNAME`.
-
-For more information use:
-
-`pm2 deploy help`

app/templates/_gitignore

@@ -4,7 +4,7 @@ coverage
 ui/fonts
 deploy/local.properties
 local.json
-ecosystem.json
+local.ecosystem.json
 /dist
 .DS_Store
 *.pid

app/templates/boot.json renamed to app/templates/ecosystem.json

@@ -3,6 +3,7 @@
     "name": "@sample-app-name",
     "script": "./node-server/node-app.js",
     "watch": true,
+    "restart_delay": 4000,
     "env": {
       "NODE_ENV": "local"
     },
@@ -15,5 +16,6 @@
     "env_prod": {
       "NODE_ENV": "prod"
     }
-  }]
+  }],
+  "deploy": {}
 }

app/templates/gulpfile.js

@@ -244,23 +244,6 @@ gulp.task('init-prod', function(done) {
 gulp.task('add-deploy-target', function(done) {
   log('Update ecosystem.json targets or create new ones!');
 
-  var ecosystem = 'ecosystem.json';
-
-  if (!fs.existsSync(ecosystem)) {
-    try {
-      var configJSON = {};
-      configJSON.deploy = {};
-
-      var configString = JSON.stringify(configJSON, null, 2) + '\n';
-
-      fs.writeFileSync('ecosystem.json', configString, {
-        encoding: 'utf8'
-      });
-    } catch (e) {
-      console.log('failed to write ecosystem.json: ' + e.message);
-    }
-  }
-
   var properties = fs.readFileSync('deploy/build.properties', {
     encoding: 'utf8'
   });
@@ -269,6 +252,10 @@ gulp.task('add-deploy-target', function(done) {
   var gitUrl = 'https://github.com/';
   var folderPath = '/space/projects/' + name;
 
+  var ecosystem = 'ecosystem.json';
+
+  ecosystemMustExist(ecosystem, name);
+
   $.git.exec({
     args: 'config --get remote.origin.url',
     quiet: true
@@ -312,11 +299,22 @@ gulp.task('add-deploy-target', function(done) {
       name: 'folder',
       message: 'Where do you want to store the project on your target server?',
       default: folderPath
+    }, {
+      type: 'list',
+      name: 'local',
+      message: 'Is there any sensitive information or credentials here that shouldn\'t go in source control?',
+      choices: ['no', 'yes'],
+      default: 0
     }];
 
     gulp.src(ecosystem)
       .pipe($.prompt.prompt(questions, function(answers) {
 
+        if (answers.local === 'yes') {
+          ecosystem = 'local.ecosystem.json';
+          ecosystemMustExist(ecosystem, name);
+        }
+
         gulp.src(ecosystem)
           .pipe($.jsonEditor(function(json) {
             json.deploy[answers.targetName] = {
@@ -326,7 +324,7 @@ gulp.task('add-deploy-target', function(done) {
               'ref': 'origin/' + answers.branch,
               'repo': answers.gitUrl,
               'path': answers.folder,
-              'post-deploy': 'npm install; bower install; gulp build'
+              'post-deploy': 'npm install && bower install && gulp build'
             };
             return json; // must return JSON object.
           }))
@@ -335,6 +333,42 @@ gulp.task('add-deploy-target', function(done) {
   });
 });
 
+function ecosystemMustExist(ecosystem, name) {
+  if (!fs.existsSync(ecosystem)) {
+    try {
+      var configJSON = {
+        'apps': [{
+          'name': name,
+          'script': './node-server/node-app.js',
+          'watch': true,
+          'restart_delay': 4000,
+          'env': {
+            'NODE_ENV': 'local'
+          },
+          'env_local': {
+            'NODE_ENV': 'local'
+          },
+          'env_dev': {
+            'NODE_ENV': 'dev'
+          },
+          'env_prod': {
+            'NODE_ENV': 'prod'
+          }
+        }],
+        'deploy': {}
+      };
+
+      var configString = JSON.stringify(configJSON, null, 2) + '\n';
+
+      fs.writeFileSync(ecosystem, configString, {
+        encoding: 'utf8'
+      });
+    } catch (e) {
+      console.log('failed to write ecosystem.json: ' + e.message);
+    }
+  }
+}
+
 /**
  * Run the spec runner
  * @param  {Function} done - callback when complete