feat(nginx): setup ssl renew cron script

refs #216
- add crontab script that calls `ghost ssl-renew` every month
- add support for setup stage "descriptions" - longer blocks of text
- deps: [email protected]

Author: acburdine

extensions/nginx/commands/ssl-renew.js

@@ -5,6 +5,7 @@ const letsencrypt = require('../letsencrypt');
 class SslRenewCommand extends cli.Command {
     run() {
         let instance = this.system.getInstance();
+        instance.checkEnvironment();
 
         if (!instance.cliConfig.has('extension.sslemail')) {
             return Promise.reject(new cli.errors.SystemError('No saved email found, skipping automatic letsencrypt renewal'));

extensions/nginx/index.js

@@ -21,6 +21,7 @@ class NginxExtension extends cli.Extension {
 
         cmd.addStage('nginx', this.setupNginx.bind(this));
         cmd.addStage('ssl', this.setupSSL.bind(this));
+        cmd.addStage('ssl-renew', this.setupRenew.bind(this), 'automatic ssl renewal');
     }
 
     setupNginx(argv, ctx, task) {
@@ -215,6 +216,15 @@ class NginxExtension extends cli.Extension {
         }], false);
     }
 
+    setupRenew(argv, ctx) {
+        return this._cron((cron) => {
+            // Ensure any crontab with the same instance name is removed
+            cron.remove({comment: ctx.instance.name});
+            let cmd = `cd ${ctx.instance.dir} && ${process.argv.slice(0, 2).join(' ')} ssl-renew`;
+            cron.create(cmd, '@monthly', ctx.instance.name);
+        });
+    }
+
     _addProxyBlock(location, port) {
         location._add('proxy_set_header', 'X-Forwarded-For $proxy_add_x_forwarded_for');
         location._add('proxy_set_header', 'X-Forwarded-Proto $scheme');
@@ -231,11 +241,30 @@ class NginxExtension extends cli.Extension {
         let parsedUrl = url.parse(instance.config.get('url'));
         let confFile = `${parsedUrl.hostname}.conf`;
 
+        let promises = [
+            this._cron(cron => cron.remove({comment: instance.name}))
+        ];
+
         if (fs.existsSync(`/etc/nginx/sites-available/${confFile}`)) {
-            return this.ui.sudo(`rm /etc/nginx/sites-available/${confFile}`).then(() => {
-                return this.ui.sudo(`rm /etc/nginx/sites-enabled/${confFile}`);
-            }).catch(() => Promise.reject(new cli.errors.SystemError('Nginx config file link could not be removed, you will need to do this manually.')));
+            promises.push(
+                this.ui.sudo(`rm /etc/nginx/sites-available/${confFile}`).then(() => {
+                    return this.ui.sudo(`rm /etc/nginx/sites-enabled/${confFile}`);
+                }).catch(
+                    () => Promise.reject(new cli.errors.SystemError('Nginx config file link could not be removed, you will need to do this manually.'))
+                )
+            );
         }
+
+        return Promise.all(promises);
+    }
+
+    _cron(fn) {
+        const crontab = require('crontab');
+
+        return Promise.fromCallback(cb => crontab.load(cb)).then((cron) => {
+            fn(cron);
+            return Promise.fromCallback(cb => cron.save(cb));
+        });
     }
 
     restartNginx() {

lib/commands/setup.js

@@ -33,9 +33,10 @@ class SetupCommand extends Command {
         this.stages = [];
     }
 
-    addStage(name, fn) {
+    addStage(name, fn, description) {
         this.stages.push({
             name: name,
+            description: description || name,
             fn: fn
         });
     }
@@ -94,7 +95,7 @@ class SetupCommand extends Command {
                 }
 
                 return this.ui.listr([{
-                    title: `Setting up ${stage.name}`,
+                    title: `Setting up ${stage.description}`,
                     task: (ctx, task) => stage.fn(argv, ctx, task)
                 }], {single: true, instance: instance});
             });
@@ -117,7 +118,7 @@ class SetupCommand extends Command {
                             return stage.fn(argv, ctx, task);
                         }
 
-                        return this.ui.confirm(`Do you wish to set up ${stage.name}?`, true).then((res) => {
+                        return this.ui.confirm(`Do you wish to set up ${stage.description}?`, true).then((res) => {
                             if (!res.yes) {
                                 return task.skip();
                             }

package.json

@@ -42,6 +42,7 @@
     "bluebird": "3.5.0",
     "chalk": "1.1.3",
     "cli-table2": "0.2.0",
+    "crontab": "1.1.3",
     "debug": "2.6.8",
     "decompress": "4.2.0",
     "download": "6.2.5",

yarn.lock

@@ -572,6 +572,12 @@ create-error-class@^3.0.0:
   dependencies:
     capture-stack-trace "^1.0.0"
 
+[email protected]:
+  version "1.1.3"
+  resolved "https://registry.yarnpkg.com/crontab/-/crontab-1.1.3.tgz#5469a2a76c505d8b7808e5b769061ab26dca3420"
+  dependencies:
+    underscore "^1.6.0"
+
 cross-spawn-async@^2.1.1:
   version "2.2.5"
   resolved "https://registry.yarnpkg.com/cross-spawn-async/-/cross-spawn-async-2.2.5.tgz#845ff0c0834a3ded9d160daca6d390906bb288cc"
@@ -3660,6 +3666,10 @@ unbzip2-stream@^1.0.9:
     buffer "^3.0.1"
     through "^2.3.6"
 
+underscore@^1.6.0:
+  version "1.8.3"
+  resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.8.3.tgz#4f3fb53b106e6097fcf9cb4109f2a5e9bdfa5022"
+
 unique-string@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/unique-string/-/unique-string-1.0.0.tgz#9e1057cca851abb93398f8b33ae187b99caec11a"