Skip to content

deploy.adoc

Latest commit

 

History

History
55 lines (41 loc) · 1.93 KB

deploy.adoc

File metadata and controls

55 lines (41 loc) · 1.93 KB

deploy

An Interbit CLI command that deploys an application.

Syntax

interbit deploy [--manifest path/to/interbit.manifest.json] \
                [--artifacts path/to/build/artifacts/directory] \
                --port number \
                [--key-pair path/to/key/file]

Options

--manifest String Optional Default=./interbit.manifest.json

The path to an Interbit manifest file, used for deployment instructions. If a path is not provided, the manifest is read from the --artifacts path (if specified), or the current directory.
--artifacts String Optional Default=./

The path to a directory of build artifacts to deploy. The directory should contain an Interbit manifest file and one or more packed covenants. If --artifacts is not provided, artifacts are searched for in a folder called dist in the current working directory. An error is displayed if no valid build artifacts are found.
--port Integer

The port number that your deployed Interbit node uses to communicate.
--key-pair String Optional

The path to a Javascript or JSON file that exports a key pair to be used to boot the hypervisor. If a path is not provided, a random key pair is generated.

Important

If random key pairs are generated, these keys are not included in the blockchain’s access control list. This means that the hypervisor cannot perform any actions and your blockchain cannot function.

Discussion

deploy tells the local hypervisor to host the chains described in the provided manifest file.

Note
 Hosting the static index.html is a separate concern handled elsewhere. The deploy command does not deploy your front-end application, it only deploys your blockchain nodes.