nomo-webon-cli v0.1.11

Nomo WebOn CLI

nomo-webon-cli is a command line tool for building and deploying WebOns. See the nomo-webon-kit for general docs about WebOns.

Why Nomo WebOn CLI?

At its core, nomo-webon-cli enables to deploy frontends in a way such that multiple versions can co-exist at the same time (e.g. production-frontends, staging-frontends and so on).

As such, nomo-webon-cli follows a similar philosophy like Netlify and the Jamstack.

However, nomo-webon-cli adds a few unique features that are not available in other solutions:

• Fully decentralized: Everyone can setup their own server and deploy WebOns via SSH
• Nomo Update Notifications: The Nomo App will show notifications when a WebOn has been updated.
• Fully customizable: With only a few lines of JS-config, you can setup an arbitrary number of staging-tracks / testing-tracks or whatever is needed for your WebOn.

How to use

First, you need static web-assets made with some other build-system or framework. Assuming that your web-assets are in a folder out, you can build and deploy a WebOn like so:

nomo-webon-cli build out

nomo-webon-cli deploy nomo.tar.gz staging
nomo-webon-cli deploy nomo.tar.gz production

The out folder needs to contain files like nomo_manifest.json and nomo_icon.svg. Use nomo-webon-cli init if you do not yet have a nomo_manifest.json.

Deployment Targets

nomo-webon-cli offers the following options for deployment:

• Raw SSH deployments: Deploy via SSH to an arbitrary location
• ZENCON deployments: Deploy to ZENCON-managed infrastructure

Installation

Add nomo-webon-cli to your dev-dependencies:

npm install --save-dev nomo-webon-cli

For Windows, you can run it via npx:

npx nomo-webon-cli --help

Config

The nomo-webon-cli is configured with a file nomo_cli.config.cjs. See the following example for configuring your deployTargets:

const mnemonic = process.env.CACHE_SIGN_MNEMONIC;

const nomoCliConfig = {
  deployTargets: {
    production: {
      rawSSH: {
        /**
         * sshHost is the remote-host for deploying your WebOn.
         * Please ensure that you have valid SSH-credentials before trying to deploy anything.
         */
        sshHost: "root@<IP-address>",

        /**
         * sshBaseDir is a remote-directory for deploying your WebOn.
         */
        sshBaseDir: "/var/www/production_webons/my_webon",

        /**
         * publicBaseUrl is a URL where sshBaseDir gets exposed to the Internet.
         * publicBaseUrl is needed to generate a deeplink for installing your WebOn.
         * For example, you could configure an nginx-server to map sshBaseDir to a publicBaseUrl.
         */
        publicBaseUrl: "https://w.nomo.app/my_webon",

        /**
         * If true, the WebOn will be deployed both as a tar.gz as well as a normal website.
         */
        hybrid: true,

        /**
         * If false, the WebOn will only be deployed as a normal website.
         */
        targz: true,

        /**
         * If set, the cli will generate a signature of the tar.gz-cache.
        */
        mnemonic,
      },
    },
    staging: {
      rawSSH: {
        /**
         * sshHost could be taken from an environment-variable to hide your target IP address.
         */
        sshHost: process.env.SSH_TARGET,
        sshBaseDir: "/var/www/staging_webons/my_webon",
        publicBaseUrl: "https://staging.nomo.app/my_webon",

        /**
         * Optional. The default sshPort is 22.
         */
        sshPort: 22,
      },
      // ZENCON deployments are not yet available. Please use rawSSH for the time being.
      //zencon: {},
    },
  },
};

module.exports = nomoCliConfig;

Usage Options

Run nomo-webon-cli --help to see a list of available commands:

Options:
  -v, --version     output the version number
Commands:
  build <assetDir>                 Build a WebOn archive
  deploy <archive> <deployTarget>  Deploy a WebOn archive
  init <publicDir>                 Create a cli-config and/or a manifest.
  bumpVersion <manifest>           Increases the version of a WebOn.