This documentation is for WSO2 API Manager 2.6.0. View documentation for the latest release.

All docs This doc

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: More changes https://github.com/wso2/docs-apim/issues/636

...

  1. Open the <API-M_HOME>/repository/conf/carbon.xml file and set the following properties as shown below.

    Localtab Group
    Localtab
    activetrue
    idFormat-hostname
    titleFormat
    Code Block
    languagexml
    <HostName>{hostname}</HostName>
    <MgtHostName>{management-hostname}</MgtHostName>
    • {hostname} - Hostname or IP address of the machine hosting this server. This becomes part of the endpoint reference of the services deployed on this server instance.

    • {management-hostname} - Hostname that is used for the WSO2 API-M Management console.

    Localtab
    idexample-hostname
    titleExample
    Code Block
    languagexml
    <HostName>am.dev.wso2.com</HostName>
    <MgtHostName>am.dev.wso2.com</MgtHostName>
  2. Open the <API-M_HOME>/repository/conf/api-manager.xml file and set the HostName and MgtHostName property as the following properties as shown below. 

    1. Configure the Store URL, which is used to access the Store web app from the Publisher application. 

      Localtab Group
      Localtab
      idFormat-storeURL
      titleFormat
      Code Block
      languagexml
      <APIStore>
              <!--GroupingExtractor>org.wso2.carbon.apimgt.impl.DefaultGroupIDExtractorImpl</GroupingExtractor-->
              ...
              <URL>https://[mgt-transport-https-hostname]:[mgt-transport-https-port]/store</URL>
      		...
      </APIStore>
      • [mgt-transport-https-port] - This port is optional, because if you are fronting the Store nodes with a load balancer, you need to enter the load balancer URL as the Store URL as opposed to entering the hostname and port separately.

      Localtab
      idexample-storeURL
      titleExample
      Code Block
      languagexml
      <APIStore>
              <!--GroupingExtractor>org.wso2.carbon.apimgt.impl.DefaultGroupIDExtractorImpl</GroupingExtractor-->
              ...
              <URL>https://store.wso2.com</URL>
      		...
      </APIStore>
    2. Configure the Publisher URL, which is the URL that is used to access the tenant Store and public Store.

      Localtab Group
      Localtab
      idFormat-publisherURL
      titleFormat
      Code Block
      languagexml
          <APIPublisher>
              ...
              <URL>https://[mgt-transport-https-hostname]:[mgt-transport-https-port]/publisher</URL>
      		...
          </APIPublisher>
      Localtab
      idexample-publisherURL
      titleExample
      Code Block
      languagexml
          <APIPublisher>
              ...
              <URL>https://publisher.wso2.com</URL>
      		...
          </APIPublisher>
    3. Configure the environment configurations by defining the endpoint URL for both the REST APIs and Web Socket (WS) APIs that are hosted in the API Gateway.

      Localtab Group
      Localtab
      idFormat-APIURL
      titleFormat
      Code Block
      languagexml
          <APIGateway>
              <Environments>
                  <Environment type="[environment-type]" api-console="true">   
      				<!-- Endpoint URLs for the APIs hosted in this API gateway.-->
                      <GatewayEndpoint>http://[http-gateway-hostname]:[http-gateway-nio-port],https://[https-gateway-hostname]:[https-gateway-nio-port]</GatewayEndpoint>
                      <!-- Endpoint of the Websocket APIs hosted in this API Gateway -->
                      <GatewayWSEndpoint>ws://[gateway-hostname]:[gateway-ws-port]</GatewayWSEndpoint>
                  </Environment>
              </Environments>
          </APIGateway>
      Localtab
      idexample-apiURL
      titleExample
      Code Block
      languagexml
          <APIGateway>
              <Environments>
                  <Environment type="[environment-type]" api-console="true">   
      				<!-- Endpoint URLs for the APIs hosted in this API gateway.-->          
                      <GatewayEndpoint>http://gateway.wso2.com,https://gateway.wso2.com</GatewayEndpoint>
                      <!-- Endpoint of the Websocket APIs hosted in this API Gateway -->
                      <GatewayWSEndpoint>ws://gateway.wso2.com</GatewayWSEndpoint>
                  </Environment>
              </Environments>
          </APIGateway>
  3. Generate a key store, export the public certificate from the keystore, and import that certificate to the  client­-truststore.jks  file.
    For more information, see Creating New Keystores in the WSO2 Administration guide.

...