You can install API Gateway in GUI mode or in unattended command-line mode.
The API Gateway installer enables you to install the following API Gateway components:
-
API Gateway Server
-
API Gateway Analytics
-
Policy Studio
-
Configuration Studio
-
API Gateway Explorer
For more details on API Gateway components and concepts, see the API Gateway Concepts Guide. This topic describes how to install API Gateway components on the following platforms:
-
Windows
-
Linux
-
Solaris
You must ensure the following:
System requirements
See the System requirements to ensure that the target machine is of a suitable specification.
Executable permission
On Linux/UNIX, you must ensure that the installation executable has the appropriate
permissions in your environment. For example, you can use the chmod
command
to update the file permissions.
- Launch API Gateway installer
- Welcome
- Select components
- Specify installation directory
- Specify domain connection
- Specify Admin Node Manager details
- Specify local Node Manager details
- Specify Admin Node Manager connection details
- Specify Node Manager service details
- Select server configuration option
- Specify API Gateway server details
- Specify API Gateway service details
- Select startup option
- Acknowledge API Gateway Analytics information
- Installation summary
- Installing
- Installation complete
When you run the installation setup file it launches in GUI mode by default. The following sections detail the installation steps in GUI mode.
Locate and run the setup file for your operating system.
Windows
OAG-11.1.2.3.0-windows-installer.exe
Linux
OAG-11.1.2.3.0-linux-installer.run
![]() |
Tip |
---|---|
To run the setup in unattended mode, see the section called “Unattended installation”. |
When you run the setup file in GUI mode, you are presented with an introductory welcome window. Click Next to continue with the installation.
Select the components to be installed, and deselect those that are not to be installed. The Core Server component is selected by default.
Click Next to continue.
Enter a location or click the browse button to specify the directory where the API Gateway components are to be installed, for example:
Click Next to continue.
Select whether this is the first system in a new API Gateway domain. Defaults to Yes, which configures the system with a new Admin Node Manager.
If you select No, the system is configured with a local Node Manager, which connects to an existing Admin Node Manager. You are asked to enter the connection details to an existing Admin Node Manager.
Click Next to continue.
This window is only displayed if you selected No in the section called “Specify domain connection”.
Configure the following settings for the Node Manager:
Host Name or IP Address:
Select a host address from the list (defaults to the installation host name).
Local Management Port:
Enter the local port used to manage the Node Manager. Defaults to 8090
.
Click Next to continue.
This window is only displayed if you selected No in the section called “Specify domain connection”.
Configure the following settings for the local Node Manager:
Host Name or IP Address:
Select a host address from the list (for example, 127.0.0.1
).
Local Management Port:
Enter the local port used to manage the Node Manager. Defaults to 8090
.
Click Next to continue.
This window is only displayed if you selected No in the section called “Specify domain connection”.
Configure the following settings to connect to an existing Admin Node Manager:
Connection URL:
Enter the URL to connect to the Admin Node Manager. Defaults to the following:
https://[admin-node-hostname-or-IP]:8090
Modify Default Values:
Select whether to modify the default Admin Node Manager username/password
(admin/changeme
). When this is selected, enter a new
username/password. This setting is not selected by default.
Click Next to continue.
Configure the following settings:
Add a Service for the Node Manager:
Select whether to add a service for the Node Manager. Defaults to No.
Run Service as non default user:
Select whether to run the Node Manager service as a non-default user. This setting
is not selected by default. When you select this setting, you can enter a non-default
user in the Username field. The default user is admin
.
Click Next to continue.
Select whether to configure a new API Gateway server instance. Defaults to Yes.
Click Next to continue.
This window is only displayed if you selected Yes in the section called “Select server configuration option”.
Configure the following settings:
API Gateway Name:
Enter a name for the API Gateway instance. Defaults to Gateway1
.
API Gateway Group:
Enter a group name for the API Gateway instance. Defaults to Group1
.
Local Management Port:
Enter the local port that the Node Manager uses to manage the API Gateway instance.
Defaults to 8085
.
External Traffic Port:
Enter the port that the API Gateway uses for message traffic from external clients.
Defaults to 8080
.
Click Next to continue.
This window is only displayed if you selected Yes in the section called “Select server configuration option”.
Configure the following settings:
Add a Service for the API Gateway Instance:
Select whether to add a service for the API Gateway instance. Defaults to No.
Run Service as non default user:
Select whether to run the Node Manager service as a non-default user. This setting
is not selected by default. When you select this setting, you can enter a non-default
user in the Username field. The default user is admin
.
Click Next to continue.
Select whether to start the Admin Node Manager and the new API Gateway instance after installation. Defaults to Yes (recommended).
![]() |
Note |
---|---|
If you select No, you must start the Admin Node Manager and the new API Gateway instance manually after installation. |
Click Next to continue.
This window is only displayed if you selected to install API Gateway Analytics.
An information window is displayed to remind you that you must perform additional steps before you start API Gateway Analytics.
Review the information and click Next to continue.
The installer displays a summary of the components that will be installed on your system.
Review the information and click Next to begin installing.
A progress window is displayed showing the progress of the installation. When the installation is complete, click Next to continue.
A window is displayed to indicate that the installation is complete. If you selected to install Policy Studio you can select the option to Launch Oracle Policy Studio.
The URL of the Admin Node Manager is displayed (for example, https://127.0.0.1:8090
).
You can go to this URL in your browser to access the API Gateway Manager tools.
Click Finish to complete the installation. Policy Studio is launched if you selected that option.
You can run the API Gateway installer in unattended mode on the command line. Perform the following steps:
-
Change to the directory where the setup file is located.
-
Run the setup file with the
--mode unattended
option.
The following example shows how to install all API Gateway components in unattended mode:
Windows
OAG-11.1.2.3.0-windows-installer.exe --mode unattended --prefix C:\OAG-11.1.2.3.0
Linux
./OAG-11.1.2.3.0-linux-installer.run --mode unattended --prefix /opt/OAG-11.1.2.3.0
The components are installed in the background, in the directory specified by the --prefix
option.
For a description of all the available command-line options and their default settings, run the
setup file with the --help
option. This outputs the help text in
a separate console. For example:
Windows
OAG-11.1.2.3.0-windows-installer.exe --help
Linux
./OAG-11.1.2.3.0-linux-installer.run --help
The following table summarizes some of the more common options:
Option | Description |
---|---|
--help
|
Display available options and default settings. |
--mode
|
Specify an installation mode. |
--setup_type
|
Specify a setup type. |
--enable-components
|
Specify a comma-separated list of components to enable. |
--disable-components
|
Specify a comma-separated list of components to disable. |
--prefix
|
Specify an installation directory. |
--unattendedmodeui
|
Specify different levels of user interaction when installing on Windows or on a Linux/UNIX system with X-Windows. |
--optionfile
|
Specify options in a properties file. For more information on option files, go to:
|
To create a new managed domain and API Gateway instance, you can use the
managedomain
script.
You can run managedomain
from the following directory:
For more details on running managedomain
, see the API Gateway Administrator
Guide.