Installing Edge Microgateway

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation.

Edge Microgateway v. 2.3.x


Use this guide if you need to install or uninstall Edge Microgateway.


  • You must have Node.js version 4.5 LTS or later installed on your system. See additional Node.js instructions below.
  • Windows requires OpenSSL to be installed and added to the PATH.
  • If you are using Apigee Edge Private Cloud to configure with Edge Microgateway, you must be running Private Cloud version 4.15.07 or later.

Installing Node.js

You must have Node.js version 4.5 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 if you have an internet connection

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

  1. Install the latest version of Edge Microgateway with npm using the following command. This command installs the software and puts the edgemicro executable in your path. To find out exactly where the following command installs Edge Microgateway, see Where is Edge Microgateway installed?.
    npm install edgemicro -g

    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.3.1, use the following command.

    npm install edgemicro@2.3.1 -g
  2. Check the version number. For example, if you installed version 2.3.5:
    edgemicro --version
    current nodejs version is v6.1.0
    current edgemicro version is 2.3.5
  3. Run this command to create a default configuration file in your home directory.
    edgemicro init
  4. (Optional) A config file called default.yaml file was placed in your home directory in a subdirectory called .edgemicro. Check now to be sure this file exists:
    ls ~/.edgemicro

    Note: In the Edge Microgateway docs, we refer to the home directory with the tilde (~), which is a UNIX shortcut. If you're on Windows, if you're running a shell that does not support the tilde, you will need to substitute the appropriate environment variable for the tilde in commands that reference the home directory. For example: %USERPROFILE%/.edgemicro.

  5. Follow the steps in Installing Edge Microgateway.

Operating Edge Microgateway on Windows as a Service

You can operate Edge Microgateway on Windows as a service. For details, see Best practices for operational management of Microgateway (edgemicro) on Windows on the Apigee Community.

Can I install Edge Microgateway without an internet connection?

On sites that do not have ready internet access, it is possible for an administrator to install and maintain a private npm registry on your internal network. Instructions for setting up a private npm registry are beyond the scope of this guide; however, you can search for and find helpful instructions. With a private npm registry installed, you can follow the installation instructions given above.

Getting started

If you're new to Edge Microgateway, the Installing 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.

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 [prefix]/lib/node_modules/edgemicro, where [prefix] is the npm prefix as explained in Where is Edge Microgateway installed?
  2. Delete or archive the log files. By default, edgemicro-*.log files are in /var/tmp/, but this location is configurable. Check configuration file if in doubt, as explained in "Managing log files."
  3. Delete or archive the runtime config and cache config files: