tlsd 2.10.1 → 2.11.1

package/README.md

@@ -2,36 +2,21 @@
 # tlsd
 
 This is a node.js based webserver.
+It is designed for development work on prototype web applications.
+It is *not* designed for production websites.
 
 ## Features
 
-	- SSL/TLS magically via Greenlock
+	- SSL/TLS via Greenlock
 	- Websockets built in
 	- Standardised Websockets/RPC protocol for front/back end communcations
 	- Utility command 'tlsd'
-    - Browser reload on src changes
 
 
 ## Installing
 
-There are 2 ways to use this:
 
-  1. Install globally as CLI command "tlsd"
-  2. Install locally to an existing project directory and executed with "npx tlsd"
-
-
-### Install Globally
-
-    npm install -g tlsd
-
-You should how have a CLI command "tlsd"
-
-	tlsd
-
-This way lets you run a project without having to have tlsd included in it.
-
-
-### Install Locally
+Install tlsd into your project:
 
 	npm install tlsd
 
@@ -40,13 +25,14 @@ run it this way:
 
 	npx tlsd
 
-This way you can just use it to serve your local project in dev or production mode.
+This way you can just use it to serve your local project in dev or TLS mode.
 
 
 ## tlsd init
 
 Creates empty scaffolding files for a project:
 
+    mkdir my_project
 	tlsd init my_project
 
 This can then be tested by starting the server:
@@ -54,7 +40,7 @@ This can then be tested by starting the server:
 	tlsd run dev my_project 12345 3
 
 And then browsing to "http://localhost:12345".
-You should see the pages being delivered and a websocket connecting being established.
+You should see the pages being delivered and a websocket connection being established.
 
 
 ## tlsd run dev
@@ -64,12 +50,12 @@ This is for local (your computer) development:
 
     tlsd root_dir port_num log_level
 
-All arguments are required
+All arguments are required.
 
 
 ## tlsd domain
 
-Adds a domain to Greenlock for production.
+Adds a domain to Greenlock so that you can serve site with HTTPS:
 
 	tlsd domain example.com
 
@@ -79,9 +65,9 @@ Adds a domain to Greenlock for production.
 Displays the current version of tlsd
 
 
-### Production Mode
+### TLS Mode
 
-In production mode, you must specify the dir containing links/dirs for domains to serve
+In HTTPS mode, you must specify the dir containing links/dirs for domains to serve
 it will run on HTTP on 80 (redirecting to 443), HTTPS on 443, and magically
 generate certs and serve secure sites like nodes:
 
@@ -93,9 +79,7 @@ You must also add your domain to greenlock before running nodes or it won't be r
 
 	npx greenlock add --subject example.com --altnames example.com,www.example.com
 
-Production mode serves files with Letsencrypt SSL certs magically.
-
-The browser reload feature does not operate in production mode.
+TLS mode serves files with Letsencrypt SSL certs magically.
 
 
 

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "tlsd",
-  "version": "2.10.1",
+  "version": "2.11.1",
   "description": "A server for web app prototyping with HTTPS and Websockets",
   "main": "tlsd.js",
   "bin": {
     "tlsd": "tlsd"
   },
   "scripts": {
-    "dev": "./tlsd run dev scaffold 12345 5",
+    "dev": "./tlsd run dev scaffold 12344 5",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "Joe Hitchens <joe@sleepless.com>",

package/rpc_static/rpc/rpc.js

@@ -28,7 +28,6 @@
 		if( RPC.debug ) {
             args.unshift( "RPC:" ); 
             console.log.apply( this, args );
-			//console.log( "RPC: ", args );
 		}
 	};
 
@@ -281,7 +280,7 @@
 
 	}, ( evt, detail ) => {
 		// event occurred
-		DBG( "Event:", evt );
+		DBG( "Event:", evt, detail );
 		if( evt === "connect" ) {
 			RPC.connected = true;
 		}

package/scaffold/rpc/index.js

@@ -1,12 +1,10 @@
 
-/*
-	This is the back end script that handles message from the front end.
-	The "input" object is the exact same that was given to RPC()
-	on the front end.
-	Use okay() to return a normal response, or fail() to return an error.
-	These correspond to the same okay()/fail() functions given to RPC() on
-	the front end.
-*/
+//	This is the back end script that handles messages from the front end.
+//	The "input" object is exactly the same thing that was given to RPC()
+//	on the front end.
+//	Use okay() to return a normal response, or fail() to return an error.
+//	These correspond to the same okay()/fail() functions given to RPC() on
+//	the front end.
 
 module.exports = ( input, okay, fail ) => {
 

package/scaffold/static/index.html

@@ -1,51 +1,50 @@
 <html>
-<head>
-    <link href="/local.sass.css" rel="stylesheet">
-</head>
-<body>
-	
-	<h1>TLSD Test Page</h1>
-    <script>
-        document.write( Date() );
-    </script>
-
-    <div id=connect_status>?</div>
-
-	<script src="/rpc/rpc.js"></script>
-
-	<script>
-
-		/*
-		RPC is used to send msgs to the back end.
-		If you call RPC() directly, it will decide whether or not
-		to use Websocket or REST as transport based on size of object.
-		Otherwise, you can explicitly choose the transport by using
-		RPC.POST() or RPC.WS().
-		*/
-
-        RPC.debug = true;   // enables debug output to browser console
-
-        RPC.onmessage = msg => {
-            // Message originating from server (not a response to client message)
-            // returning true will prevent tlsd from doing anything further
-            // with the message, such as try to detect hot-reload messages, etc.
-            return false;
-        };
-
-		RPC.on_connect = function( evt ) {
-			// RPC is ready to be used
-			RPC( { action: "hello" }, msg => {
-                document.getElementById( "connect_status" ).innerText = msg;
-            } );
-		}
-
-		RPC.on_disconnect = function( evt ) {
-            // The websocket connection ws lost for some reason
-            // The RPC code will reconnect automatically
-            document.getElementById( "connect_status" ).innerText = "[ DISCONNECTED ]";
-        }
-
-	</script>
-
-</body>
+    <head>
+        <title>TLSD Test Page</title>
+    </head>
+    <body>
+        
+        <h1>TLSD Test Page</h1>
+
+        <h2>
+            <script>
+                document.write( Date() );
+            </script>
+        <h2>
+
+        <h3 id=connect_status>...</h3>
+
+        <script src="/rpc/rpc.js"></script>
+
+        <script>
+
+            // RPC is used to send msgs to the back end.
+            // If you call RPC() directly, it will decide whether or not to use
+            // Websocket or REST based on the size of the JSON encoded msg.
+            // Otherwise, you can explicitly choose the transport by using
+            // RPC.POST() or RPC.WS().
+
+            RPC.onmessage = msg => {
+                // Message originating from server (not a response to client message).
+                // Returning true will prevent tlsd from doing anything further
+                // with the message.
+                return false;
+            };
+
+            RPC.on_connect = function( evt ) {
+                // RPC is ready to be used (websocket is connected)
+                RPC( { action: "hello" }, msg => {
+                    document.getElementById( "connect_status" ).innerText = msg;
+                } );
+            }
+
+            RPC.on_disconnect = function( evt ) {
+                // The websocket connection was lost for some reason.
+                // The RPC code will reconnect automatically.
+                document.getElementById( "connect_status" ).innerText = "[ DISCONNECTED ]";
+            }
+
+        </script>
+
+    </body>
 </html>

package/tlsd.js

@@ -1,8 +1,6 @@
 
-/*
-Copyright 2023 Sleepless Software Inc.
-All Rights Reserved
-*/
+//Copyright 2024 Sleepless Software Inc.
+//All Rights Reserved
 
 const { path, http, https, fs, crypto, tls, } = require( "allcore" );
 
@@ -23,7 +21,7 @@ function usage() {
 	const base = path.basename( module.filename );
 	log(
 `Usage:
-    Production mode:
+    TLS mode:
     	DOMAINS_ROOT=./my_domains MAINTAINER_EMAIL=foo@bar.com VERBOSITY=4  node ` + base + `
     Dev mode:
     	node ` + base + ` site_root listen_port verbosity
@@ -141,12 +139,12 @@ const basic_handler = function( root ) {
 			return
 		}
 
-		// Only allow POSTS to /rpc in production mode.
+		// Only allow POSTS to /rpc in tlsd mode.
 		// In dev mode, GET is allowed as well with query args.
 		let input = body;
 		if( method != "POST" ) {
 			if( ! ( method == "GET" && dev_mode ) ) {
-				W( "GET /rpc is disallowed in production mode" );
+				W( "GET /rpc is disallowed in tlsd mode" );
 				res.writeHead( 405 ); // Method Not Allowed
 				res.end();
 				return;
@@ -407,7 +405,7 @@ if( argv.length == 2 ) {
 	if( DOMAINS_ROOT && MAINTAINER_EMAIL && VERBOSITY ) {
 		L( toInt( VERBOSITY ) );
 
-		I( "=== PRODUCTION MODE ===" );
+		I( "=== TLS MODE ===" );
 		V( "DOMAINS_ROOT: " + DOMAINS_ROOT );
 		V( "MAINTAINER_EMAIL: " + MAINTAINER_EMAIL );
 		V( "VERBOSITY: " + VERBOSITY );

package/scaffold/static/404/index.html

@@ -1,16 +0,0 @@
-<!DOCTYPE html>
-<html>
-	<head>
-		<title>Page Not Found </title>
-	</head>
-	<body>
-        <h1>Sorry, nothing there, mate!</h1>
-        <p>
-            <script>
-                let url = decodeURIComponent( document.location.search.split( "=" ).pop() );
-                document.write( "Requested URL: " + url );
-            </script>
-        </p>
-	</body>
-</html>
-

package/scaffold/static/local.sass

@@ -1,15 +0,0 @@
-
-body
-    margin: 2em 2vw
-    font-family: sans-serif
-    text-align: center
-
-h1
-  font-size: 40px
-  a
-    font-style: italic
-
-#connect_status
-    margin: 2em 0
-    font-size: 200%
-    font-size: 100%

package/scaffold/static/local.sass.css

@@ -1,18 +0,0 @@
-body {
-  margin: 2em 2vw;
-  font-family: sans-serif;
-  text-align: center;
-}
-
-h1 {
-  font-size: 40px;
-}
-h1 a {
-  font-style: italic;
-}
-
-#connect_status {
-  margin: 2em 0;
-  font-size: 200%;
-  font-size: 100%;
-}