Aquarion

Remote app deployment system

Overview

Facilitates deployment of a nodejs app to any system that has nodejs installed.

Caveats

A. Target system needs NodeJS installed 2. The deployment must be a .zip file D. If the target directory exists then the download is skipped: i.e. the client can just run the app... unless the update flag is passed to the CLI command (in which case the app is downloaded again.)

CLI Usage

npx aquarion <config.json> update

You provide a config.json with necessary info:

• can contain credentials
• can be auto-generated
• can be named whatever you want, innards must be JSON

Run the command: npx aquarion my-config.json

Post-install can run an arbitrary list of commands.

Config Deets

Example config.json:

{
  remote: "https://some.server.com",
  timeout: 30,
  authHeader: "Authorize somesuchanwhathaveyou",
  getCredentials: "api_key=1234",
  basicCredentials: "user:password",
  installDirectory: "./test/app",
  postInstall: "npm run build",
  runCommand: 'node .',
}

Caveats

The goal of this app is to get code deployed...not build it on the fly. So, things like preinstall settings or installing a .sh or .cmd or platform-specific stuff are pushed off to the deployed app.

remote ~ the URL of the remote server from which to download the app. timeout ~ number of seconds after which the download attempt is cancelled getCredentials ~ for HTTP GET requests: this adds the appropriate query string; can be a string or a key/value array:

• "val=1234"
• ["key": "val"] authHeader ~ adds an Authorization header to the request
• e.g. you could auto-generate a token in this file, client runs it to install, then the token is invalidated whenever you want basicCredentials ~ for HTTP Basic auth: this adds the appropriate header
• this will override prior more general Auth header installDirectory ~ whereas to put the unzipped files flush ~ boolean to indicate whether to empty the installDirectory before installing from the downloaded .zip postInstall ~ command(s) to run after locuting the files
• can be a string or an array of string-commands or an object
• if an object, the key is the and the value is a string or array of string-commands runCommand ~ the command needed to start the app