spec-3nweb-server 1.7.11 → 1.7.13

package/build/config/cli/index.d.ts

@@ -6,4 +6,5 @@ export declare function parseProcessArgv(): {
     runCmd?: ParsedRunArgs;
     signupCmd?: ParsedSignupArgs;
     showUsage?: CliUsageDisplay;
+    showSampleConfig?: CliUsageDisplay;
 };

package/build/config/cli/index.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2023 3NSoft Inc.
+ Copyright (C) 2023, 2025 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -17,8 +17,9 @@
 */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseProcessArgv = void 0;
-const path_1 = require("path");
+const default_confs_1 = require("../default-confs");
 const run_cmd_1 = require("./run-cmd");
+const show_sample_config_1 = require("./show-sample-config");
 const signup_cmd_1 = require("./signup-cmd");
 const utils_1 = require("./utils");
 function mainUsage(execName) {
@@ -35,7 +36,8 @@ function mainUsage(execName) {
             header: 'Available commands:',
             content: [
                 run_cmd_1.runCmd,
-                signup_cmd_1.signupCmd
+                signup_cmd_1.signupCmd,
+                show_sample_config_1.showSampleConfigCmd
             ]
         },
         {
@@ -46,22 +48,26 @@ function mainUsage(execName) {
 }
 function parseProcessArgv() {
     const args = process.argv.slice(2);
-    const execName = (0, path_1.basename)(process.argv0);
     if (args.length === 0) {
-        return (0, utils_1.toUsageDisplay)(0, mainUsage(execName));
+        return (0, utils_1.toUsageDisplay)(0, mainUsage(default_confs_1.EXECUTABLE_NAME));
     }
     if (args[0] === run_cmd_1.runCmd.name) {
-        return (0, run_cmd_1.parseRunArgs)(args.slice(1), execName);
+        return (0, run_cmd_1.parseRunArgs)(args.slice(1), default_confs_1.EXECUTABLE_NAME);
     }
     else if (args[0] === signup_cmd_1.signupCmd.name) {
-        return (0, signup_cmd_1.parseSignupArgs)(args.slice(1), execName);
+        return (0, signup_cmd_1.parseSignupArgs)(args.slice(1), default_confs_1.EXECUTABLE_NAME);
+    }
+    else if (args[0] === show_sample_config_1.showSampleConfigCmd.name) {
+        return { showSampleConfig: {
+                txtToDisplay: show_sample_config_1.sampleConfig, exitStatus: 0
+            } };
     }
     else {
         const opts = (0, utils_1.parseArgv)(args, [utils_1.helpOpt], { partial: true });
         if (opts.help) {
-            return (0, utils_1.toUsageDisplay)(0, mainUsage(execName));
+            return (0, utils_1.toUsageDisplay)(0, mainUsage(default_confs_1.EXECUTABLE_NAME));
         }
-        return (0, utils_1.toUsageDisplay)(-1, (0, utils_1.toErrorUsage)(mainUsage(execName), `Unknown command '${args[0]}'`));
+        return (0, utils_1.toUsageDisplay)(-1, (0, utils_1.toErrorUsage)(mainUsage(default_confs_1.EXECUTABLE_NAME), `Unknown command '${args[0]}'`));
     }
 }
 exports.parseProcessArgv = parseProcessArgv;

package/build/config/cli/show-sample-config.d.ts

@@ -0,0 +1,3 @@
+import { CommandDef } from "./utils";
+export declare const showSampleConfigCmd: CommandDef<'show-sample-config'>;
+export declare const sampleConfig = "\n# This is a sample configuration yaml file.\n# Uncomment and set required values.\n# Default path of this file is /etc/3nweb/conf.yaml\n\n# Uncomment to enable service\nenabledServices:\n  # asmail: true\n  # storage: true\n  # mailerId: true\n\n# Data root folder. Set non-default value, if required.\n# rootFolder: /var/3nweb\n\n# Customize domain at which clients reach this server from an outside.\n# This value is used by users' MailerId-based login: assertion challenges\n# cryptographically imprint this domain to assure client that there is no\n# missuse.\ndomain: service-for.example.com\n\n# If MailerId provider service is enabled, this is its configuration\nmailerId:\n  certs: /etc/3nweb/mailerid/certs\n\n# Customize servicesConnect before starting this server.\nservicesConnect:\n\n  port: 7070\n  # Hostname allows to restrict on which address service is listening for incoming connections\n  # hostname: \"1.2.3.4\"\n\n  # Uncomment path to Let's Encrypt folder, if it is used. This implicitly tells\n  # server to HTTPS with given certificates.\n  # letsencrypt: /etc/letsencrypt/live/service-for.example.com\n\n  # By default HTTPS service reloads when certificates change. Skip, if required.\n  # skipReloadOnCertsChange: false\n\n  # Set TLS cert and key to do HTTPS. Use either this, or letsencrypt, but not both.\n  # sslOpts: {\n  #   It is Node's https.ServerOptions. Follow https://nodejs.org/docs/latest/api/https.html\n  # }\n\n# Configuration for signup service that creates new accounts on this server.\n# Comment out to disable signup service completely.\n# Note that signup cli commands should be used to create token, without which\n# signup doesn't happen, unless a no-token configuration file is provided.\nsignup: {\n  # noTokenFile: /some/path/to/json\n}\n";

package/build/config/cli/show-sample-config.js

@@ -0,0 +1,75 @@
+"use strict";
+/*
+ Copyright (C) 2025 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sampleConfig = exports.showSampleConfigCmd = void 0;
+exports.showSampleConfigCmd = {
+    name: 'show-sample-config',
+    summary: 'prints out a template configuration yaml file with comments'
+};
+exports.sampleConfig = `
+# This is a sample configuration yaml file.
+# Uncomment and set required values.
+# Default path of this file is /etc/3nweb/conf.yaml
+
+# Uncomment to enable service
+enabledServices:
+  # asmail: true
+  # storage: true
+  # mailerId: true
+
+# Data root folder. Set non-default value, if required.
+# rootFolder: /var/3nweb
+
+# Customize domain at which clients reach this server from an outside.
+# This value is used by users' MailerId-based login: assertion challenges
+# cryptographically imprint this domain to assure client that there is no
+# missuse.
+domain: service-for.example.com
+
+# If MailerId provider service is enabled, this is its configuration
+mailerId:
+  certs: /etc/3nweb/mailerid/certs
+
+# Customize servicesConnect before starting this server.
+servicesConnect:
+
+  port: 7070
+  # Hostname allows to restrict on which address service is listening for incoming connections
+  # hostname: "1.2.3.4"
+
+  # Uncomment path to Let's Encrypt folder, if it is used. This implicitly tells
+  # server to HTTPS with given certificates.
+  # letsencrypt: /etc/letsencrypt/live/service-for.example.com
+
+  # By default HTTPS service reloads when certificates change. Skip, if required.
+  # skipReloadOnCertsChange: false
+
+  # Set TLS cert and key to do HTTPS. Use either this, or letsencrypt, but not both.
+  # sslOpts: {
+  #   It is Node's https.ServerOptions. Follow https://nodejs.org/docs/latest/api/https.html
+  # }
+
+# Configuration for signup service that creates new accounts on this server.
+# Comment out to disable signup service completely.
+# Note that signup cli commands should be used to create token, without which
+# signup doesn't happen, unless a no-token configuration file is provided.
+signup: {
+  # noTokenFile: /some/path/to/json
+}
+`;
+Object.freeze(exports);

package/build/config/default-confs.d.ts

@@ -0,0 +1,3 @@
+export declare const EXECUTABLE_NAME = "3nweb";
+export declare const DEFAULT_DATA_ROOT_PATH = "/var/3nweb";
+export declare const DEFAULT_CONFIG_PATH = "/etc/3nweb/conf.yaml";

package/build/config/default-confs.js

@@ -0,0 +1,22 @@
+"use strict";
+/*
+ Copyright (C) 2025 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_CONFIG_PATH = exports.DEFAULT_DATA_ROOT_PATH = exports.EXECUTABLE_NAME = void 0;
+exports.EXECUTABLE_NAME = '3nweb';
+exports.DEFAULT_DATA_ROOT_PATH = '/var/3nweb';
+exports.DEFAULT_CONFIG_PATH = `/etc/3nweb/conf.yaml`;

package/build/config/from-yaml.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2023 3NSoft Inc.
+ Copyright (C) 2023, 2025 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -19,9 +19,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.readYamlConfFile = void 0;
 const fs_1 = require("fs");
 const yaml = require("js-yaml");
+const default_confs_1 = require("./default-confs");
 function readYamlConfFile(path) {
     const txt = (0, fs_1.readFileSync)(path, 'utf8');
     const conf = yaml.load(txt);
+    if (conf.rootFolder) {
+        conf.rootFolder = default_confs_1.DEFAULT_DATA_ROOT_PATH;
+    }
     return conf;
 }
 exports.readYamlConfFile = readYamlConfFile;

package/build/main.d.ts

@@ -1 +1,2 @@
+#!/usr/bin/env node
 export {};

package/build/main.js

@@ -1,6 +1,7 @@
+#!/usr/bin/env node
 "use strict";
 /*
- Copyright (C) 2015 - 2016, 2019 3NSoft Inc.
+ Copyright (C) 2015 - 2016, 2019, 2025 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -21,9 +22,11 @@ const from_yaml_1 = require("./config/from-yaml");
 const letsencrypt_1 = require("./config/letsencrypt");
 const lib_1 = require("./lib");
 const signup_1 = require("./config/signup");
+const default_confs_1 = require("./config/default-confs");
+const file_1 = require("./lib-common/exceptions/file");
 async function run(conf) {
     if (!conf.servicesConnect) {
-        console.error(`No connection settings found in ??.`);
+        console.error(`❌ No connection settings found in configuration.`);
         process.exit(-1);
         return;
     }
@@ -39,7 +42,7 @@ async function run(conf) {
             return;
         }
         try {
-            console.log(`Stopping app ...`);
+            console.log(`🏁 Stopping app ...`);
             await app.stop();
             console.log(`app has stopped.`);
         }
@@ -53,11 +56,11 @@ async function run(conf) {
     }
     async function startAppWithTLS(sslOpts, port, hostname) {
         await app.start(sslOpts, port, hostname);
-        console.log(`Started 3NWeb server on port ${port},${hostname ? ` hostname ${hostname},` : ''} with TLS.`);
+        console.log(`🚀 Started 3NWeb server on port ${port},${hostname ? ` hostname ${hostname},` : ''} with TLS.`);
     }
     async function startAppWithoutTLS(port, hostname) {
         await app.start(undefined, port, hostname);
-        console.log(`Started 3NWeb server on port ${port},${hostname ? ` hostname ${hostname},` : ''} without TLS, and requiring TLS reverse proxy infront.`);
+        console.log(`🚀 Started 3NWeb server on port ${port},${hostname ? ` hostname ${hostname},` : ''} without TLS, and requiring TLS reverse proxy infront.`);
     }
     try {
         app = createApp(conf);
@@ -67,7 +70,7 @@ async function run(conf) {
             await startAppWithTLS(tls.sslOpts, port, hostname);
             if (!skipReloadOnCertsChange) {
                 tls.onCertsUpdate(async (newOpts, originalOpts) => {
-                    console.log(`Reloading server app server on TLS certificates change`);
+                    console.log(`🗘  Reloading server app server on TLS certificates change`);
                     try {
                         await stopProcess();
                         app = createApp(conf);
@@ -75,7 +78,7 @@ async function run(conf) {
                     }
                     catch (err) {
                         console.error(err);
-                        console.log(`Failed to reload with new TLS certs. Attempting to load with original ones.`);
+                        console.log(`⚠️  Failed to reload with new TLS certs. Attempting to load with original ones.`);
                         try {
                             await stopProcess();
                             app = createApp(conf);
@@ -112,11 +115,19 @@ function showUsage({ txtToDisplay, exitStatus }) {
     process.exit(exitStatus);
 }
 function assembleConfig(configPath) {
-    if (configPath) {
+    if (!configPath) {
+        configPath = default_confs_1.DEFAULT_CONFIG_PATH;
+        console.log(`Looking for configuration in default location: ${configPath}`);
+    }
+    try {
         return (0, from_yaml_1.readYamlConfFile)(configPath);
     }
-    else {
-        throw new Error(`Config path must be given`);
+    catch (err) {
+        if (err.code === file_1.Code.notFound) {
+            console.error(`❌ Configuration file ${configPath} is not found.`);
+            process.exit(-2);
+        }
+        throw err;
     }
 }
 async function displaySignupInfo(conf) {
@@ -222,12 +233,21 @@ else if (cmd.signupCmd) {
         }
     }
     else {
-        throw new Error(`CLI parser failed to capture invalid command`);
+        showUsage({
+            txtToDisplay: `❌ No recognized subcommand given to signup module`,
+            exitStatus: -1
+        });
     }
 }
+else if (cmd.showSampleConfig) {
+    showUsage(cmd.showSampleConfig);
+}
 else if (cmd.showUsage) {
     showUsage(cmd.showUsage);
 }
 else {
-    throw new Error(`CLI parser failed to trigger useful action`);
+    showUsage({
+        txtToDisplay: `❌ No recognized command given`,
+        exitStatus: -1
+    });
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "spec-3nweb-server",
-  "version": "1.7.11",
+  "version": "1.7.13",
   "description": "3NWeb spec server.",
   "main": "build/lib.js",
   "types": "build/lib.d.ts",
   "bin": {
-    "3nweb": "node build/main.js"
+    "3nweb": "build/main.js"
   },
   "scripts": {
     "build": "tsc -p ts-code",