Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.26 KB

quick-install-with-docker-compose.md

File metadata and controls

54 lines (36 loc) · 2.26 KB
Raw

Quick Install Gravitee API Management with Docker Compose

{% hint style="warning" %} You cannot install Gravitee API Management (APIM) with custom plugins using this installation method. To install custom plugins, see Custom Install with Docker Compose. {% endhint %}

Before you begin

  • You must install Docker. For more information about installing Docker, go to Install Docker Engine.
  • If you are deploying the Enterprise Edition of Gravitee, ensure that you have your license key. For more information about license keys, see Gravitee Platform Pricing.

Installing Gravitee API Management

  1. Download the docker-compose.yml file as docker-compose-apim.yml using the following command:

    curl -L https://bit.ly/docker-apim-4x -o docker-compose-apim.yml

  2. (Optional) If you are installing the Enterprise Edition, add you license key by completing the follow sub-steps:

    a. In a text editor, open docker-compose-apim.yml.

b. Navigate to $services.management_api.volumes.

c. On a new line, add the path to the license key. This addition ensures that the Gateway can access the licensing key.

 - /gravitee/license.key:/opt/graviteeio-gateway/license/license.key
  1. Download, and then start the components using the following command: 
docker compose -f docker-compose-apim.yml up -d

{% hint style="info" %} APIM can take up to a minute to fully initialize with Docker. {% endhint %}

  1. Once Docker is initialized, You can access the Console and the Developer Portal by following the following steps:

    a. To open the Console, start your browser, and then go to http://localhost:8084.

    b. To open the Developer Portal, start your browser, and then go to http://localhost:8085.

{% hint style="info" %}

  • The default username for the Console and the Developer Portal is admin.
  • The default password for the Developer Portal is admin. {% endhint %}

{% hint style="success" %} Congratulations! Now that APIM is up and running, check out the Quickstart Guide for your next steps. {% endhint %}