Added a few more options to the Ngrok script.

Author: neonexus

.gitignore

@@ -146,3 +146,6 @@ app.zip
 # SSL files
 *.key
 *.crt
+
+# Downloaded binary files
+.bin

.idea/dictionaries/neonexusdemortis.xml

@@ -1,4 +1,12 @@
 # Changelog
+## [v4.2.1](https://github.com/neonexus/sails-react-bootstrap-webpack/compare/v4.2.0...v4.2.1) (2023-04-23)
+### Features
+
+* Removed optional dependencies from `package.json`, as the setup would remove optional dependencies when installing new packages without use of `--include=optional`...
+* Changed use of `NGROK_URL` -> `BASE_URL`.
+* Renamed `NGROK_AUTH` -> `NGROK_TOKEN` to avoid confusion with the `ngrok.js` config option `auth`.
+* Added some Ngrok config options.
+* Updated dependencies.
 
 ## [v4.2.0](https://github.com/neonexus/sails-react-bootstrap-webpack/compare/v4.1.1...v4.2.0) (2023-04-20)
 ### Features

.idea/runConfigurations/Start_Ngrok__nobuild_.xml

@@ -14,7 +14,6 @@ Gitter: [![Join the chat at https://gitter.im/sails-react-bootstrap-webpack/comm
 * [Main Features](#main-features)
 * [Branch Warning](#branch-warning)
 * [Current Dependencies](#current-dependencies)
-    * [Optional Dependencies](#optional-dependencies)
 * [How to Use](#how-to-use)
 * [Configuration](#configuration)
     * [Custom Configuration Options](#custom-configuration-options)
@@ -72,12 +71,6 @@ the [`releases section`](https://github.com/neonexus/sails-react-bootstrap-webpa
 * [React-Bootstrap](https://react-bootstrap.github.io) **v2**
 * [Webpack](https://webpack.js.org) **v5**
 
-### Optional Dependencies
-
-Optional dependencies are not automatically installed in this repo. You must either manually install them with `npm i`, or you can install all optional dependencies: `npm i --include=optional`.
-
-There are currently 2 optional dependencies in this repo: [`ngrok`](#working-with-ngrok) and [`sails-hook-autoreload`](#support-for-sails-hook-autoreload).
-
 See the [`package.json` for more details](package.json).
 
 ## How to Use
@@ -282,7 +275,7 @@ and [`config/env/production.js`](config/env/production.js)
 | `DB_PORT`                                            | 3306                                      | The port number for the datastore.                                                                                              |
 | `DB_SSL`                                             | true                                      | If the datastore requires SSL, set this to "true".                                                                              |
 | `SESSION_SECRET`                                     | "" (empty string)                         | Used to sign cookies, and SHOULD be set, especially on PRODUCTION environments.                                                 |
-| `NGROK_AUTH`                                         | "" (empty string)                         | Ngrok auth token used in the [`ngrok.js`](#working-with-ngrok) script.                                                          |
+| `NGROK_TOKEN`                                        | "" (empty string)                         | Ngrok auth token used in the [`ngrok.js`](#working-with-ngrok) script.                                                          |
 
 [//]: # (| DATA_ENCRYPTION_KEY | "" (empty string) | **DATA_ENCRYPTION_KEY** | **"" (empty string)** | **Currently unused; intended for future use.**                                                                                  |)
 
@@ -368,26 +361,29 @@ This repo has a custom script ([`ngrok.js`](ngrok.js)), which will start an Ngro
 
 You will want to get an auth token (and create an account if you haven't already): https://dashboard.ngrok.com/tunnels/authtokens
 
-You will need to `npm i ngrok --save-dev` (or install optional dependencies) before you can do anything. I've opted to not have it pre-installed, as it does add a bit of bloat, and not everyone is going to use it.
+You will need to `npm i ngrok --save-dev` before you can do anything. I've opted to not have it pre-installed, as it does add a bit of bloat, and not everyone is going to use it.
 
-After you have it installed, you can run `ngrok.js`, like this: `node ngrok`.
+After you have it installed, you can run `ngrok.js`, with node: `node ngrok` or just directly: `./ngrok.js`.
 
 ### Script Options
 
-These are the current configuration flags. Order does not matter. There will likely be more in the future.
+These are the current configuration flags. Order does not matter.
 
-| Option                        | Description                                                                                                                                                                                                                                                                                                                         |
-|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `nobuild`                     | Adding this flag will disable asset building.                                                                                                                                                                                                                                                                                       |
-| `auth=TOKEN`                  | Adding this flag (replacing TOKEN with your actual token) will set your Ngrok auth token. In most cases, ngrok will automatically save this token in your home folder, and re-use it later. You can test this out by omitting your token on next run, and go to your [Ngrok dashboard](https://dashboard.ngrok.com/tunnels/agents). |
+| Option                | Description                                                                                                                                                                                                                                                                                |
+|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `auth=USER:PASS`      | This will protect the Ngrok tunnel with HTTP Basic Auth, using the USER / PASS you supply.                                                                                                                                                                                                 |
+| `nobuild`             | Adding this flag will disable asset building.                                                                                                                                                                                                                                              |
+| `domain=MYDOMAIN`     | The domain to connect the tunnel from Sails to.                                                                                                                                                                                                                                            |
+| `region=MYREGION`     | The region to use for connection to the Ngrok services. One of Ngrok regions (`us`, `eu`, `au`, `ap`, `sa`, `jp`, `in`). Defaults to `us`.                                                                                                                                                 |
+| `token=MY_AUTH_TOKEN` | Adding this flag will set your Ngrok auth token. In most cases, ngrok will automatically save this token in your home folder, and re-use it later. You can test this out by omitting your token on next run, and go to your [Ngrok dashboard](https://dashboard.ngrok.com/tunnels/agents). |
 
-You can also use the environment variable `NGROK_AUTH` to pass your auth token.
+You can also use the environment variable `NGROK_TOKEN` to pass your auth token. If both environment variable, and script flag are set, the script flag will take priority.
 
-Full example: `node ngrok nobuild auth=S1T2A3Y4I5N6G7A8L9I0V1E`
+An example: `node ngrok nobuild token=S1T2A3Y4I5N6G7A8L9I0V1E region=us`
 
 ## Support for `sails-hook-autoreload`
 
-If you would like to use [`sails-hook-autoreload`](https://npmjs.com/package/sails-hook-autoreload), just install it: `npm i sails-hook-autoreload --save-dev` (or install optional dependencies). The config file [`config/autoreload.js`](config/autoreload.js) is already pre-configured for this repo.
+If you would like to use [`sails-hook-autoreload`](https://npmjs.com/package/sails-hook-autoreload), just install it: `npm i sails-hook-autoreload --save-dev`. The config file [`config/autoreload.js`](config/autoreload.js) is already pre-configured for this repo.
 
 ## What about SEO?
 

CHANGELOG.md

@@ -1,17 +1,20 @@
+#!/usr/bin/env node
+
 /**
  * This is the file used to lift Sails, build assets, and start Ngrok.
+ *
+ * Run it via node: `node ngrok` OR `node ngrok.js`
+ * Run it directly: `./ngrok.js`
  */
 let ngrok;
 
 try {
     ngrok = require('ngrok');
 } catch (e) { // eslint-disable-line
     console.log('');
-    console.log('In order to run this script, you must either install `Ngrok`:');
-    console.log('npm i ngrok --save-dev');
+    console.log('In order to run this script, you must install `Ngrok`:');
     console.log('');
-    console.log('Or install all the optional dependencies (will also install sails-hook-autoreload):');
-    console.log('npm i --include=optional');
+    console.log('npm i ngrok --save-dev');
     console.log('');
 
     return process.exit(1);
@@ -67,23 +70,37 @@ try {
 }
 
 // Set our defaults.
-config.authtoken = process.env.NGROK_AUTH || null;
+config.auth = null;
+config.token = process.env.NGROK_TOKEN || null;
 config.buildAssets = true;
+config.domain = null;
 config.port = process.env.PORT || config.port || 1337;
+config.region = null;
 
 // Read our console config flags.
 for (let i = 2; i < process.argv.length; ++i) {
-    if (process.argv[i].toLowerCase() === 'nobuild') {
+    const thisFlag = process.argv[i].toLowerCase();
+
+    if (thisFlag === 'nobuild') {
         config.buildAssets = false;
-    } else if (process.argv[i].toLowerCase().startsWith('auth=')) {
-        config.authtoken = process.argv[i].substring(5);
+    } else if (thisFlag.startsWith('auth=')) {
+        config.auth = process.argv[i].substring(5);
+    } else if (thisFlag.startsWith('domain=')) {
+        config.domain = thisFlag.substring(7);
+    } else if (thisFlag.startsWith('region=')) {
+        config.region = thisFlag.substring(7);
+    } else if (thisFlag.startsWith('token=')) {
+        config.token = process.argv[i].substring(6);
     }
 }
 
 ngrok.connect({
-    authtoken: config.authtoken,
+    auth: config.auth, // HTTP Basic auth
+    authtoken: config.token,
     addr: config.port,
-    scheme: 'https' // Currently, this does nothing, but will force Ngrok to open ONLY an HTTPs tunnel, when v5 of `ngrok` package is released.
+    subdomain: config.domain,
+    region: config.region,
+    scheme: 'https' // Currently, this does nothing, but will force Ngrok to open ONLY an HTTPS tunnel, when v5 of `ngrok` package is released.
 }).then((ngrokUrl) => {
     // Close our "http" tunnel (leaving our "https" tunnel open). Hacky, but required until v5.
     const ngrokApi = ngrok.getApi();
@@ -97,16 +114,17 @@ ngrok.connect({
 
     let origins;
 
+    // Smaller helper function, to output the Ngrok URLs.
     function sendUrls() {
         console.log('');
         console.log('Ngrok URL: ' + ngrokUrl);
         console.log('Ngrok Dashboard: http://localhost:4040');
         console.log('');
     }
 
+    // Build our assets in the background.
     if (config.buildAssets) {
-        // Build our assets in the background.
-        const assetBuilderProcess = spawn('npm', ['run', 'build'], {env: {...process.env, NGROK_URL: ngrokUrl}});
+        const assetBuilderProcess = spawn('npm', ['run', 'build'], {env: {...process.env, BASE_URL: ngrokUrl}});
 
         assetBuilderProcess.stderr.on('data', (data) => {
             console.log('Error:');
@@ -129,12 +147,14 @@ ngrok.connect({
         console.log('');
     }
 
+    // Add the Ngrok URL to our allowed origins.
     if (config.security && config.security.cors && config.security.cors.allowOrigins) {
         origins = [...config.security.cors.allowOrigins, ngrokUrl];
     } else {
         origins = [ngrokUrl];
     }
 
+    // Start Sails.
     sails.lift({
         ...rc('sails'),
         baseUrl: ngrokUrl,
@@ -150,6 +170,8 @@ ngrok.connect({
             return process.exit(1);
         }
 
+        // Sails tends to be faster at startup than asset building...
+        // Assume we are still waiting for assets (which will output URLs when finished)...
         if (config.buildAssets) {
             console.log('');
             console.log('Please wait for assets...');