Install the API Gateway Core Server

Contents

Overview
Prerequisites
Install the API Gateway Core Server
Start API Gateway

Overview

The API Gateway Core Server is the main runtime environment consisting of an API Gateway instance and a Node Manager. For more details on API Gateway components and concepts, see the API Gateway Concepts Guide.

[Note] Note

It is not necessary to install the API Gateway Core Server on the API Gateway appliance because this component is pre-installed on the appliance.

Prerequisites

Ensure that all of the prerequisites detailed in the section called “Prerequisites” are met.

Install the API Gateway Core Server

To install the API Gateway Core Server in GUI mode, perform an installation following the steps described in the section called “GUI installation”, using the following selections:

  • Select to install the API Gateway Core Server component only.

To install the API Gateway Core Server in unattended mode, follow the steps described in the section called “Unattended installation”.

The following example shows how to install the API Gateway Core Server component in unattended mode:

Windows 

OAG-11.1.2.3.0-windows-installer.exe --mode unattended 
--setup_type advanced
--enable-components apigateway 
--disable-components nodemanager,analytics,policystudio,
apitester,configurationstudio

Linux 

./OAG-11.1.2.3.0-linux-installer.run --mode unattended 
--setup_type advanced
--enable-components apigateway 
--disable-components nodemanager,analytics,policystudio,
apitester,configurationstudio

[Note] Note

This topic describes how to install the API Gateway Core Server component only. For details on installing other components, see the following topics:

Start API Gateway

If you selected to start the API Gateway after installation, the Admin Node Manager and API Gateway instance start automatically.

To start the API Gateway manually, follow these steps:

  1. Open a command prompt in the following directory:

    Windows INSTALL_DIR\apigateway\Win32\bin
    Linux/UNIX INSTALL_DIR/apigateway/posix/bin


  2. Run the startinstance command, for example: 

    startinstance -n "Server1" -g "Group1"

    [Note] Note

    On UNIX/Linux, you must ensure that the startinstance has execute permissions.

  3. To manage and monitor the API Gateway, you must ensure that the Admin Node Manager is running. Use the nodemanager command to start the Admin Node Manager from the same directory.

[Important] Important

You can encrypt all sensitive API Gateway configuration data with an encryption passphrase. For example, you can specify this passphrase in your API Gateway configuration file, or on the command line when the API Gateway is starting up. For more details, see the Oracle API Gateway Administrator Guide.

Prev  Up  Next
  Home