update documentation for heroku and openshift deployment

Author: DaftMonk

app/templates/server/config/local.env.js

@@ -7,10 +7,10 @@
 
 module.exports = {
   SESSION_SECRET: "<%= _.slugify(appname) + '-secret' %>",
-  FACEBOOK_ID: "FACEBOOK-APP-ID",
-  FACEBOOK_SECRET: "FACEBOOK-SECRET",
-  TWITTER_ID: "TWITTER-APP-ID",
-  TWITTER_SECRET: "TWITTER-SECRET",
-  GOOGLE_ID: "GOOGLE-APP-ID",
-  GOOGLE_SECRET: "GOOGLE-SECRET"
+  FACEBOOK_ID: "app-id",
+  FACEBOOK_SECRET: "secret",
+  TWITTER_ID: "app-id",
+  TWITTER_SECRET: "secret",
+  GOOGLE_ID: "app-id",
+  GOOGLE_SECRET: "secret"
 };

heroku/index.js

@@ -138,25 +138,40 @@ Generator.prototype.gitForcePush = function gitForcePush() {
     if (err) {
       this.log.error(err);
     } else {
+      var hasWarning = false;
+
       if(this.filters.mongoose) {
         this.log(chalk.yellow('\nBecause you\'re using mongoose, you must add mongoDB to your heroku app.\n\t' + 'from `/dist`: ' + chalk.bold('heroku addons:add mongohq') + '\n'));
+        hasWarning = true;
       }
       if(this.filters.socketio) {
         this.log(chalk.yellow('Because you\'re using socketIO, you must enable websockets on your heroku app.\n\t' + 'from `/dist`: ' + chalk.bold('heroku labs:enable websockets') + '\n'));
+        hasWarning = true;
       }
 
       if(this.filters.facebookAuth) {
-        this.log(chalk.yellow('Facebook auth requires you to set environment variables for\n\t' + 'FACEBOOK-APP-ID\n\t' + 'FACEBOOK-SECRET'));
+        this.log(chalk.yellow('You will need to set environment variables for facebook auth. From `/dist`:\n\t' +
+        chalk.bold('heroku config:set FACEBOOK_ID=appId\n\t') +
+        chalk.bold('heroku config:set FACEBOOK_SECRET=secret\n')));
+        hasWarning = true;
       }
       if(this.filters.googleAuth) {
-        this.log(chalk.yellow('Google auth requires you to set environment variables for\n\t' + 'GOOGLE-APP-ID\n\t' + 'GOOGLE-SECRET'));
-
+        this.log(chalk.yellow('You will need to set environment variables for google auth. From `/dist`:\n\t' +
+        chalk.bold('heroku config:set GOOGLE_ID=appId\n\t') +
+        chalk.bold('heroku config:set GOOGLE_SECRET=secret\n')));
+        hasWarning = true;
       }
       if(this.filters.twitterAuth) {
-        this.log(chalk.yellow('Twitter auth requires you to set environment variables for\n\t' + 'TWITTER-APP-ID\n\t' + 'TWITTER-SECRET'));
+        this.log(chalk.yellow('You will need to set environment variables for twitter auth. From `/dist`:\n\t' +
+        chalk.bold('heroku config:set TWITTER_ID=appId\n\t') +
+        chalk.bold('heroku config:set TWITTER_SECRET=secret\n')));
+        hasWarning = true;
       }
 
       this.log(chalk.green('\nYour app should now be live. To view it run\n\t' + chalk.bold('cd dist && heroku open')));
+      if(hasWarning) {
+        this.log(chalk.green('\nYou may need to address the issues mentioned above and restart the server for the app to work correctly.'));
+      }
 
       this.log(chalk.cyan('\nTo deploy a new build\n\t' + chalk.bold('grunt build') +
                 '\nThen enter the dist folder to commit these updates:\n\t' + chalk.bold('cd dist && git add -A && git commit -m "describe your changes here"')));

openshift/index.js

@@ -238,26 +238,40 @@ Generator.prototype.gitForcePush = function gitForcePush() {
       this.log.error(err);
     } else {
       var host_url = '';
+      var hasWarning = false;
       var before_hostname = this.dist_repo_url.indexOf('@') + 1;
       var after_hostname = this.dist_repo_url.length - ( this.deployedName.length + 12 );
       host_url = 'http://' + this.dist_repo_url.slice(before_hostname, after_hostname);
 
       if(this.filters.socketio) {
         this.log(chalk.yellow('Openshift websockets use port 8000, you will need to update the client to connect to the correct port for sockets to work.\n\t' + 'in `/client/app/components/socket/socket.service`: ' + chalk.bold('var ioSocket = io.connect(\'' + host_url + ':8000' + '\')' + '\n')));
+        hasWarning = true;
       }
 
       if(this.filters.facebookAuth) {
-        this.log(chalk.yellow('Facebook auth requires you to set environment variables for\n\t' + 'FACEBOOK-APP-ID\n\t' + 'FACEBOOK-SECRET'));
+        this.log(chalk.yellow('You will need to set environment variables for facebook auth:\n\t' +
+        chalk.bold('rhc set-env FACEBOOK_ID=id -a ' + this.deployedName + '\n\t') +
+        chalk.bold('rhc set-env FACEBOOK_SECRET=secret -a ' + this.deployedName + '\n')));
+        hasWarning = true;
       }
       if(this.filters.googleAuth) {
-        this.log(chalk.yellow('Google auth requires you to set environment variables for\n\t' + 'GOOGLE-APP-ID\n\t' + 'GOOGLE-SECRET'));
-
+        this.log(chalk.yellow('You will need to set environment variables for google auth:\n\t' +
+        chalk.bold('rhc set-env GOOGLE_ID=id -a ' + this.deployedName + '\n\t') +
+        chalk.bold('rhc set-env GOOGLE_SECRET=secret -a ' + this.deployedName + '\n')));
+        hasWarning = true;
       }
       if(this.filters.twitterAuth) {
-        this.log(chalk.yellow('Twitter auth requires you to set environment variables for\n\t' + 'TWITTER-APP-ID\n\t' + 'TWITTER-SECRET'));
+        this.log(chalk.yellow('You will need to set environment variables for twitter auth:\n\t' +
+        chalk.bold('rhc set-env TWITTER_ID=id -a ' + this.deployedName + '\n\t') +
+        chalk.bold('rhc set-env TWITTER_SECRET=secret -a ' + this.deployedName + '\n')));
+        hasWarning = true;
       }
 
       this.log(chalk.green('\nYour app should now be live at \n\t' + chalk.bold(host_url)));
+      if(hasWarning) {
+        this.log(chalk.green('\nYou may need to address the issues mentioned above and restart the server for the app to work correctly \n\t' +
+          'rhc app-restart -a ' + this.deployedName));
+      }
       this.log(chalk.yellow('After app modification run\n\t' + chalk.bold('grunt build') +
       '\nThen enter the dist folder to commit these updates:\n\t' + chalk.bold('cd dist && git add -A && git commit -m "describe your changes here"')));
       this.log(chalk.green('Finally, deploy your updated build to OpenShift with\n\t' + chalk.bold('git push -f '+this.deployedName+' master')));