To run WSO2 API Manager, you start the API Manager server at the command line. You can then run the Management Console application to configure and manage the product. This page describes how to run the product in the following sections:
Starting the Server
To start the server, you run the script
wso2server.bat (on Windows) or
wso2server.sh (on Linux/Solaris) from the
- Open a command prompt:
- On Windows, choose Start -> Run, type
cmdat the prompt, and press Enter.
- On Linux/Solaris, establish a SSH connection to the server or log in to the text Linux console.
<APIM_HOME>is the directory where you installed the API Manager distribution:
- On Windows:
- On Linux/Solaris:
The operation log appears. When the API Manager server is running, the log displays the message "WSO2 Carbon started in 'n' seconds."
We do not recommend starting WSO2 products as a daemon, because there is a known issue that causes automatic restarts in the wrapper mode. Instead, you can configure the heap memory allocations in the wso2server.sh script and run it using the nohup command. For example:
nohup ./wso2server.sh &
Running the Management Console
Once the server has started, you can run the Management Console by opening a Web browser and typing in the management console's URL. You can find the URL in the start script's log. For example:
The URL should be in the following format:
You can use this URL to access the Management Console on this computer from any other computer connected to the Internet or LAN. When accessing the Management Console from the same server where it's installed, you can type "localhost" instead of the IP address:
At the sign-in screen, sign in to the Management Console using admin as both the username and password. You can then use the Management Console to manage the API Manager. The tabs and menu items in the navigation pane on the left may vary depending on the features you have installed. To view information about a particular page, click the Help link at the top right corner of that page , or click the Docs link to open this documentation for full information on managing the API Manager.
Stopping the Server
To stop the server, press Ctrl+C in the command window, or click the Shutdown/Restart link in the navigation pane in the Management Console.