About this guide

This guide describes how to install API Gateway components on all supported platforms.

Who should read this guide

The intended audience for this guide is system engineers who are responsible for installing, configuring, and maintaining API Gateway.

Before installing API Gateway you should have an understanding of API Gateway concepts and features. For more information, see the API Gateway Concepts Guide.

Others who might find parts of this guide useful include network or systems administrators and other technical or business users.

How to use this guide

This guide should be used in conjunction with the other guides in the API Gateway documentation set.

Before you begin installing API Gateway, review this guide thoroughly. The following is a brief description of the contents of each section:

  • Quick start installation – Enables you to install quickly using standard settings.
  • Plan the deployment – Describes what you should consider when planning for deploying and configuring your system architecture.
  • Prerequisites – Describes the prerequisites for installing, including the system requirements.
  • Install API Gateway – Describes how to perform an installation using the GUI mode or unattended command-line mode.
  • Install API Gateway components – Describes how to install the API Gateway components.
  • Post-installation – Provides instructions on how to check if the installation was successful and describes additional tasks, such as securing API Gateway, that you should perform after installation.
  • Run API Management in Docker – Describes how to build and run a sample multi-node API Gateway system in Docker, and how to customize this recommended API Gateway topology to suit your environment.
  • Update API Gateway – Describes how to apply service packs or patches to update your API Gateway installation.

Related topics

API Management documentation set

Related documentation

Related Links