Page History

...

Microgateway Toolkit

1. Ensure that your system meets the following basic prerequisites.

   JDK	Development environment with Open JDK 1.8 (e.g., AdoptOpenJDK 8, OpenJDK 8)

2. Set up JAVA_HOME based on your operating system.

   • Setup JAVA_HOME for Linux/Mac OS.
     

     You must set your JAVA_HOME environment variable to point to the directory where the Java Development Kit (JDK) is installed on the computer.

     Info
     icon false
     Environment variables are global system variables accessible by all the processes running under the operating system.

     1. In your home directory, open the bashrc file (.bash_profile file
 on Mac) using editors such as vi, emacs, pico, or mcedit.

     2. Assuming you have JDK 1.8.0_171 in your system, add the following two lines at the bottom of the file, replacing /usr/java/jdk1.8.0_171 with the actual directory where the JDK is installed.

        Code Block
        On Linux: export JAVA_HOME=/usr/java/jdk1.8.0_171 export PATH=${JAVA_HOME}/bin:${PATH}   On OS X: export JAVA_HOME=/System/Library/Java/JavaVirtualMachines/1.8.0.jdk/Contents/Home

     3. Save the file.

        Info
        If you do not know how to work with text editors in a Linux SSH session, run the following command: cat >> .bashrc. Paste the string from the clipboard and press "Ctrl+D."

     4. To verify that the JAVA_HOME variable is set correctly, execute the following command:

     5. The system returns the JDK installation path.

        Code Block
        On Linux: echo $JAVA_HOME   On OS X: which java If the above command gives you a path like /usr/bin/java, then it is a symbolic link to the real location. To get the real location, run the following: ls -l `which java`

   • Setup JAVA_HOME for Windows.
     Set the  JAVA_HOME  environment variable as a user variable via the edit system properties UI.
     

3. Log in to the command line (Terminal on Mac).

4. Download the WSO2 API Microgateway toolkit distribution.

5. Extract the archive file to a dedicated directory for the WSO2 API Microgateway Toolkit, which will hereafter be referred to as  <MGW-TK_HOME> .

6. Append the full path of the /bin folder of the extracted WSO2 API Microgateway toolkit distribution to the PATH environment variable.
   This allows you to run the WSO2 API Microgateway toolkit related commands from any directory location.

   • Linux and OS X

     Code Block
     title Example
     export PATH=$PATH:<extracted_toolkit_location>/bin

   • Windows
     Use one of the following approaches to define the paths.

     • Set the Microgateway toolkit distribution path using the following command in the terminal.

       Code Block
       title Example
       setx "%path%;<extracted_toolkit_location>/bin"

     • Set the Microgateway toolkit distribution path using the UI in Windows.

       Note
       The steps involved in setting the environment variables may vary based on the version of your Windows OS.

       1. Copy the path to the Microgateway Toolkit bin folder (<path-to-wso2am-micro-gw-toolkit>\bin).
       2. Click Edit the system preferences.
          '
       3. Navigate to the Advanced tab and click Environment Variables.
          

       4. Navigate to the path system variable and click Edit.

          

       5. Click New,  add the path of the Microgateway Toolkit bin folder that you copied previously and click OK three times to save the newly added system variable.
          

7. Optionally, configure WSO2 API Microgateway Toolkit with WSO2 API Manager 3.0.0.

   Note
   This is only applicable if you are working with WSO2 API Manager 3.0.0.

Microgateway Runtime

1. Ensure that your system meets the following basic prerequisites.

   Memory	256MB
   Cores	2
   OS	Any

2. Log in to the command line (Terminal on Mac).

3. Download the WSO2 API Microgateway distribution based on your OS and extract it.

4. Extract the archive file to a dedicated directory for the WSO2 API Microgateway Runtime, which will hereafter be referred to as <MGW_HOME>.

5. Append the full path of the /bin folder of the extracted WSO2 API Microgateway distribution to the PATH environment variable.
   This allows you to run the WSO2 API Microgateway distribution-related commands from any directory location.

   • Linux and OS X

     Code Block
     title Example
     export PATH=$PATH:<extracted_distribution_location>/bin

   • Windows

     Use one of the following approaches to define the paths.

     • Set the Microgateway toolkit distribution path using the following command in the terminal.

       Code Block
       title Example
       setx "%path%;<extracted_distribution_location>/bin"

     • Set the Microgateway runtime distribution path using the UI in Windows.

6. Optionally, configure WSO2 API Microgateway Runtime with WSO2 API Manager 3.0.0.

   Note
   This is only applicable if you are working with WSO2 API Manager 3.0.0.