Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Installing Edge Microgateway

Edge Microgateway v. 2.1.x


This guide is intended for operators who need to install or uninstall Edge Microgateway.

Getting started

If you're new to Edge Microgateway, the Setting up and configuring Edge Microgateway  is the best place to start after you complete the install. The setup and configuration guide covers all the steps you need to do to install, configure, start, and use an instance of Edge Microgateway.


  • You must have Node.js version 4.x LTS or later installed on your system. See additional Node.js instructions below.
  • Windows requires OpenSSL to be installed and added to the PATH.

Installing Node.js

You must have Node.js version 4.x or later installed on your system. You can check by executing:

node -v

There are many ways to obtain or update Node.js. For example, you can use HomeBrew, yum, or download it directly from the Node.js site:

Installing Edge Microgateway

This section explains how to install Edge Microgateway and intialize a default configuration.

  1. Install Edge Microgateway with npm using the global install option. To install a specific version of Edge Microgateway, you need to specify the version number in the installation command. If you do not specify the version number, the latest version will be installed. For example, to install version 2.1.2, use the following command. This command installs the software and puts the edgemicro executable in your path:
    npm install edgemicro@2.1.2 -g
    To verify the version you can look in the package.json file in the directory where Edge Microgateway is installed. See Where is Edge Microgateway installed?
  2. Run this command to create a default configuration file in ~/.edgemicro:
    edgemicro init
  3. (Optional) Check to see that the default.yaml file is in ~/.edgemicro:
    ls ~/.edgemicro
  4. (Optional) Make any configuration changes to the ~/.edgemicro/default.yaml file that you wish to make. For example, you can add plugins or make other configuration changes.
  5. Follow the steps in Setting up and configuring Edge Microgateway.

Where is Edge Microgateway installed?

When you use npm with the global option (npm install -g edgemicro), the software is installed in [prefix]/lib/node_modules/edgemicro. You can find the value of [prefix] with this command:

npm config get prefix

The value of [prefix] is configurable. See npm-folders for more information. 

Uninstalling Edge Microgateway

If you need to remove Edge Microgateway:

  1. Delete or archive the installation directory containing the Edge Microgateway folders.
  2. Delete or archive the log files:
  3. Delete or archive the runtime config and cache config files:

Help or comments?