make ssl an alias of tls

Author: thornjad

README.md

@@ -62,7 +62,7 @@ This will install `http-server` globally so that it may be run from the command
 
 |`--username` |Username for basic authentication | |
 |`--password` |Password for basic authentication | |
-|`-S` or `--ssl` |Enable https.| |
+|`-S`, `--tls` or `--ssl` |Enable secure request serving with TLS/SSL (HTTPS)|`false`|
 |`-C` or `--cert` |Path to ssl cert file |`cert.pem` | 
 |`-K` or `--key` |Path to ssl key file |`key.pem` |
 |`-r` or `--robots` | Automatically provide a /robots.txt (The content of which defaults to `User-agent: *\nDisallow: /`)  | `false` |

bin/http-server

@@ -7,8 +7,12 @@ var colors     = require('colors/safe'),
     httpServer = require('../lib/http-server'),
     portfinder = require('portfinder'),
     opener     = require('opener'),
-    fs         = require('fs'),
-    argv       = require('minimist')(process.argv.slice(2));
+    fs         = require('fs');
+var argv = require('minimist')(process.argv.slice(2), {
+  alias: {
+    tls: 'ssl'
+  }
+});
 var ifaces = os.networkInterfaces();
 
 process.title = 'http-server';
@@ -38,17 +42,17 @@ if (argv.h || argv.help) {
     '  -U --utc     Use UTC time format in log messages.',
     '  --log-ip     Enable logging of the client\'s IP address',
     '',
-    '  -P --proxy         Fallback proxy if the request cannot be resolved. e.g.: http://someurl.com',
+    '  -P --proxy       Fallback proxy if the request cannot be resolved. e.g.: http://someurl.com',
     '  --proxy-options  Pass options to proxy using nested dotted objects. e.g.: --proxy-options.secure false',
     '',
     '  --username   Username for basic authentication [none]',
     '               Can also be specified with the env variable NODE_HTTP_SERVER_USERNAME',
     '  --password   Password for basic authentication [none]',
     '               Can also be specified with the env variable NODE_HTTP_SERVER_PASSWORD',
     '',
-    '  -S --ssl     Enable https.',
-    '  -C --cert    Path to ssl cert file (default: cert.pem).',
-    '  -K --key     Path to ssl key file (default: key.pem).',
+    '  -S --tls --ssl   Enable secure request serving with TLS/SSL (HTTPS)',
+    '  -C --cert    Path to TLS cert file (default: cert.pem)',
+    '  -K --key     Path to TLS key file (default: key.pem)',
     '',
     '  -r --robots        Respond to /robots.txt [User-agent: *\\nDisallow: /]',
     '  --no-dotfiles      Do not show dotfiles',
@@ -61,7 +65,7 @@ if (argv.h || argv.help) {
 
 var port = argv.p || argv.port || parseInt(process.env.PORT, 10),
     host = argv.a || '0.0.0.0',
-    ssl = argv.S || argv.ssl,
+    tls = argv.S || argv.tls,
     proxy = argv.P || argv.proxy,
     proxyOptions = argv['proxy-options'],
     utc = argv.U || argv.utc,
@@ -156,7 +160,7 @@ function listen(port) {
     }
   }
 
-  if (ssl) {
+  if (tls) {
     options.https = {
       cert: argv.C || argv.cert || 'cert.pem',
       key: argv.K || argv.key || 'key.pem'
@@ -179,16 +183,18 @@ function listen(port) {
 
   var server = httpServer.createServer(options);
   server.listen(port, host, function () {
-    var protocol = ssl ? 'https://' : 'http://';
+    var protocol = tls ? 'https://' : 'http://';
 
-    logger.info([colors.yellow('Starting up http-server, serving '),
+    logger.info([
+      colors.yellow('Starting up http-server, serving '),
       colors.cyan(server.root),
-      ssl ? (colors.yellow(' through') + colors.cyan(' https')) : ''
+      tls ? (colors.yellow(' through') + colors.cyan(' https')) : ''
     ].join(''));
 
     logger.info([colors.yellow('\nhttp-server version: '), colors.cyan(require('../package.json').version)].join(''));
 
-    logger.info([colors.yellow('\nhttp-server settings: '),
+    logger.info([
+      colors.yellow('\nhttp-server settings: '),
       ([colors.yellow('CORS: '), argv.cors ? colors.cyan(argv.cors) : colors.red('disabled')].join('')),
       ([colors.yellow('Cache: '), argv.c ? (argv.c === '-1' ? colors.red('disabled') : colors.cyan(argv.c + ' seconds')) : colors.cyan('3600 seconds')].join('')),
       ([colors.yellow('Connection Timeout: '), argv.t === '0' ? colors.red('disabled') : (argv.t ? colors.cyan(argv.t + ' seconds') : colors.cyan('120 seconds'))].join('')),

doc/http-server.1

@@ -102,7 +102,7 @@ Can also be specified with the environment variable NODE_HTTP_SERVER_PASSWORD.
 Defaults to none.
 
 .TP
-.BI \-S ", " \-\-ssl
+.BI \-S ", " \-\-tls ", " \-\-ssl
 Enable https.
 
 .TP

lib/http-server.js

@@ -33,8 +33,7 @@ function HttpServer(options) {
 
   if (options.root) {
     this.root = options.root;
-  }
-  else {
+  } else {
     try {
       fs.lstatSync('./public');
       this.root = './public';

package-lock.json

@@ -35,14 +35,15 @@ test('proxy options', (t) => {
       brotli: true,
       gzip: true
     })
+    // TODO #723 we should use portfinder
     server.listen(8080, async () => {
       try {
 
         // Another server proxies 8081 to 8080
         const proxyServer = httpServer.createServer({
           proxy: 'http://localhost:8080',
           root: path.join(__dirname, 'fixtures'),
-          ssl: true,
+          tls: true,
           https: httpsOpts,
           proxyOptions: {
             secure: false