added automatic ipv6 ipv4 detection

b0cb9829784a141e24c220437154ec847c3106ee

BPplays <andymalbp@gmail.com>

default/config.yaml+4 -2 Viewed

 # Listen for incoming connections
 listen: false
 # Enables IPv6 and/or IPv4 protocols. Need to have at least one enabled!
+# - Use option "auto" to automatically detect support
+# - Use "enabled" or "disabled" to enable or disabled each protocol
 protocol:
-    ipv4: true
+    ipv4: auto
-    ipv6: false
+    ipv6: auto
 # Prefers IPv6 for DNS. Enable this on ISPs that don't have issues with IPv6
 dnsPreferIPv6: false
 # The hostname that autorun opens.

server.js+67 -22 Viewed

 import fs from 'node:fs';
 import http from 'node:http';
 import https from 'node:https';
+import os from 'os';
 import path from 'node:path';
 import util from 'node:util';
 import net from 'node:net';

 const DEFAULT_BASIC_AUTH = false;
 const DEFAULT_PER_USER_BASIC_AUTH = false;
-const DEFAULT_ENABLE_IPV6 = false;
+const DEFAULT_ENABLE_IPV6 = "auto";
-const DEFAULT_ENABLE_IPV4 = true;
+const DEFAULT_ENABLE_IPV4 = "auto";
 const DEFAULT_PREFER_IPV6 = false;

 const cliArguments = yargs(hideBin(process.argv))
     .usage('Usage: <your-start-script> <command> [options]')
-    .option('enableIPv6', {
+    .option('string', {
         type: 'boolean',
         default: null,
         describe: `Enables IPv6.\n[config default: ${DEFAULT_ENABLE_IPV6}]`,
-    }).option('enableIPv4', {
+    }).option('string', {
         type: 'boolean',
         default: null,
         describe: `Enables IPv4.\n[config default: ${DEFAULT_ENABLE_IPV4}]`,

@@ -280,7 +281,7 @@ if (dnsPreferIPv6) {
280	console.log('Preferring IPv4 for DNS resolution');	281	console.log('Preferring IPv4 for DNS resolution');
281	}	282	}
282		283
283	if (!enableIPv6 && !enableIPv4) {	284	if (enableIPv6 == "disabled" && enableIPv4 == "disabled") {
284	console.error('error: You can\'t disable all internet protocols: at least IPv6 or IPv4 must be enabled.');	285	console.error('error: You can\'t disable all internet protocols: at least IPv6 or IPv4 must be enabled.');
285	process.exit(1);	286	process.exit(1);
286	}	287	}

     return undefined;
+}
+async function getHasIP() {
+    let hasIPv6 = false;
+    let hasIPv4 = false;
+    const interfaces = os.networkInterfaces();
+    for (const iface of Object.values(interfaces)) {
+        if (iface === undefined) {
+            continue
+        }
+        for (const info of iface) {
+            if (info.family === 'IPv6') {
+                hasIPv6 = true;
+            }
+            if (info.family === 'IPv4') {
+                hasIPv4 = true;
+            }
+        }
+    }
+    return [hasIPv6, hasIPv4];
+}
 app.use(cookieSession({
     name: getCookieSessionName(),
     sameSite: 'strict',

@@ -685,18 +708,18 @@ const preSetupTasks = async function () {
685	* Gets the hostname to use for autorun in the browser.	708	* Gets the hostname to use for autorun in the browser.
686	* @returns {string} The hostname to use for autorun	709	* @returns {string} The hostname to use for autorun
687	*/	710	*/
688	function getAutorunHostname() {	711	function getAutorunHostname(useIPv6, useIPv4) {
689	if (autorunHostname === 'auto') {	712	if (autorunHostname === 'auto') {
690	if (enableIPv6 && enableIPv4) {	713	if (useIPv6 && useIPv4) {
691	if (avoidLocalhost) return '[::1]';	714	if (avoidLocalhost) return '[::1]';
692	return 'localhost';	715	return 'localhost';
693	}	716	}
694		717
695	if (enableIPv6) {	718	if (useIPv6) {
696	return '[::1]';	719	return '[::1]';
697	}	720	}
698		721
699	if (enableIPv4) {	722	if (useIPv4) {
700	return '127.0.0.1';	723	return '127.0.0.1';
701	}	724	}
702	}	725	}

  * @param {boolean} v6Failed If the server failed to start on IPv6
  * @param {boolean} v4Failed If the server failed to start on IPv4
  */
-const postSetupTasks = async function (v6Failed, v4Failed) {
+const postSetupTasks = async function (v6Failed, v4Failed, useIPv6, useIPv4) {
     const autorunUrl = new URL(
         (cliArguments.ssl ? 'https://' : 'http://') +
-        (getAutorunHostname()) +
+        (getAutorunHostname(useIPv6, useIPv4)) +
         (':') +
         ((autorunPortOverride >= 0) ? autorunPortOverride : server_port),
     );

@@ -725,11 +748,11 @@ const postSetupTasks = async function (v6Failed, v4Failed) {
725		748
726	let logListen = 'SillyTavern is listening on';	749	let logListen = 'SillyTavern is listening on';
727		750
728	if (enableIPv6 && !v6Failed) {	751	if (useIPv6 && !v6Failed) {
729	logListen += color.green(' IPv6: ' + tavernUrlV6.host);	752	logListen += color.green(' IPv6: ' + tavernUrlV6.host);
730	}	753	}
731		754
732	if (enableIPv4 && !v4Failed) {	755	if (useIPv4 && !v4Failed) {
733	logListen += color.green(' IPv4: ' + tavernUrl.host);	756	logListen += color.green(' IPv4: ' + tavernUrl.host);
734	}	757	}
735		758

  * @param {boolean} v6Failed If the server failed to start on IPv6
  * @param {boolean} v4Failed If the server failed to start on IPv4
  */
-function handleServerListenFail(v6Failed, v4Failed) {
+function handleServerListenFail(v6Failed, v4Failed, useIPv6, useIPv4) {
-    if (v6Failed && !enableIPv4) {
+    if (v6Failed && !useIPv4) {
         console.error(color.red('fatal error: Failed to start server on IPv6 and IPv4 disabled'));
         process.exit(1);
+    }
-    if (v4Failed && !enableIPv6) {
+    if (v4Failed && !useIPv6) {
         console.error(color.red('fatal error: Failed to start server on IPv4 and IPv6 disabled'));
         process.exit(1);
+    }

     });
+}
-async function startHTTPorHTTPS() {
+async function startHTTPorHTTPS(useIPv6, useIPv4) {
     let v6Failed = false;
     let v4Failed = false;
     const createFunc = cliArguments.ssl ? createHttpsServer : createHttpServer;
-    if (enableIPv6) {
+    if (useIPv6) {
         try {
             await createFunc(tavernUrlV6);
         } catch (error) {

@@ -873,7 +896,7 @@ async function startHTTPorHTTPS() {
873	}	896	}
874	}	897	}
875		898
876	if (enableIPv4) {	899	if (useIPv4) {
877	try {	900	try {
878	await createFunc(tavernUrl);	901	await createFunc(tavernUrl);
879	} catch (error) {	902	} catch (error) {

+}
 async function startServer() {
-    const [v6Failed, v4Failed] = await startHTTPorHTTPS();
+    let useIPv6 = (enableIPv6 == "enabled")
+    let useIPv4 = (enableIPv4 == "enabled")
+    const [hasIPv6, hasIPv4] = await getHasIP()
+    if (enableIPv6 == "auto") {
+        useIPv6 = hasIPv6;
+        if (useIPv6) {
+            console.log("IPv6 support detected")
+        }
+    }
+    if (enableIPv4 == "auto") {
+        useIPv4 = hasIPv4;
+        if (useIPv4) {
+            console.log("IPv4 support detected")
+        }
+    }
+    if (!useIPv6 && !useIPv4) {
+        console.log("No IPv6 and no IPv4 enabled")
+    }
+    const [v6Failed, v4Failed] = await startHTTPorHTTPS(useIPv6, useIPv4);
-    handleServerListenFail(v6Failed, v4Failed);
+    handleServerListenFail(v6Failed, v4Failed, useIPv6, useIPv4);
-    postSetupTasks(v6Failed, v4Failed);
+    postSetupTasks(v6Failed, v4Failed, useIPv6, useIPv4);
+}
 async function verifySecuritySettings() {