Follow the instructions below to install WSO2 products the required applications and the product on Windows.
| Info | ||
|---|---|---|
| ||
Before you install the product, ensure that your system meets the minimum hardware and software requirements described in section, Installation Prerequisites. |
Step 1. Obtain Installation Pack
Download the latest version of the program (for downloading instructions, refer to section, Downloading the Product ).
Step 2. Extract the Archive
After the download is complete, extract installation files to the user-defined folder (further to be referred to as PRODUCT_HOME).
Step 3. Set up JAVA_HOME
...
Installing the supporting applications
Be sure your system meets the Installation Prerequisites. Java Development Kit (JDK) is essential to run the product.
Installing the product
- If you have not done so already, download the latest version of the product as described in Downloading the Product.
Extract the archive file to a dedicated directory for the product, which will hereafter be referred to as
<PRODUCT_HOME>.
Setting JAVA_HOME
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 | ||
|---|---|---|
| ||
Environment variables are global system variables accessible by all the processes running under the operating system. |
Locate the Installation Folder of the Java™ Development Kit (JDK) on the Machine
1. In order to set the variable, it is necessary to know the system folder to which JDK is installed. Unless the installation path was changed by the user during the installation process, it is installed into the default folder Typically, the JDK is installed in a directory under C:\Program Files\Java. Open the directory , such as C:\Program Files\Java using the browser.2. Inside that path there will be one or more subdirectories, for example, \jdk1.56.0_0827 . If you just have multiple versions installed the Java Development Kit, it is in the newest directory, choose the latest one, which you can find by sorting by date. For example, it may be installed in C:\Program Files\Java\jdk1.6.0_27 .
There are two ways to set up JAVA_HOME: via "System Properties", or via "Windows Command Prompt".
JAVA_HOME Setup via System Properties
Follow the instructions below to set up the JAVA_HOME environment variable using "System Properties".
1.
| Info |
|---|
Environment variables are global system variables accessible by all the processes running under the operating system. You can define an environment variable as a system variable, which applies to all users, or as a user variable, which applies only to the user who is currently logged in. |
You can set JAVA_HOME using the system properties, as described below. Alternatively, if you just want to set JAVA_HOME temporarily in the current command prompt window, set it at the command prompt .
Setting JAVA_HOME using the System Properties
- Right-click the "My Computer" icon on the desktop and
...
- choose Properties.
...
...
- In the System Properties
...
...
- window, click the Advanced tab, and then click the Environment Variables button.
- Click the New button under "System variables" (for all users) or under "User variables" (just for the user who is currently logged in).
...
- Enter the following information:
- In the "Variable name" field, enter
...
- :
JAVA_HOME
- :
...
- In the "Variable value" field, enter the installation path of the Java Development Kit
...
- , such as:
c:\Program Files\Javajdk1.6.0_27
- , such as:
...
5. In the "New User Variable" popup, fill in the required fields:
- In the "Variable name" field, enter "JAVA_HOME" without quotes.
- In the "Variable value" field, enter the installation path of the Java Development Kit, for example,
C:\Program Files\java\jdk1.6.0_27.
6. Click "OK."
| Info | ||
|---|---|---|
| ||
In case there is a need to set up variables only for the user currently logged in, |
| Note | ||
|---|---|---|
| ||
Variable set up will be effective for the CMD opened after this operation. In case a CMD had run before the variable was set up, this change will not be effective for it. To ensure the variable set up is effective, and variable value is reset, close and reopen the CMD you are running the Application Server from, or close and re-open the browser (e.g. Total Commander) you are going to run the CMD from. |
- Click OK.
The JAVA_HOME variable is now set and will apply to any subsequent command prompt windows you open. If you have existing command prompt windows running, you must close and reopen them for the JAVA_HOME variable to take effect, or manually set the JAVA_HOME variable in those command prompt windows as described in the next section. To verify that the JAVA_HOME variable is set correctly, open a command window (from the Start menu, click Run, and then type CMD and click Enter) and execute the following command:
| Code Block |
|---|
set JAVA_HOME |
The system returns the JDK installation path.
Anchor cmd cmd
Setting JAVA_HOME temporarily using the Windows command prompt (CMD)
| cmd | |
| cmd |
Alternatively, you You can temporarily set the JAVA_HOME environment variable within a Windows command prompt window (CMD).
1. Open the "CMD" prompt. (Click the "Start" -> "Run" and then type "cmd" and click "OK" to run the CMD)
2. In the opened CMDThis is useful when you have an existing command prompt window running and you do not want to restart it.
- In the command prompt window, enter the following command
...
- where
<JDK_INSTALLATION_PATH>is the JDK installation directory and press Enter:set JAVA_HOME=<JDK_INSTALLATION_PATH>
...
Where "<JDK_INSTALLATION_PATH>" is the actual JDK installation directory.
...
For example:
set JAVA_HOME=c:\Program Files\java\jdk1.6.0_27
...
...
The
JAVA_HOME
...
| title | Notice |
|---|
...
variable is now set for the current CMD session only.
Step 4. Verify JAVA_HOME Set Up
Follow the instructions below to check if JAVA_HOME was set up correctly:
1. Open the "CMD" prompt. (Click the "Start" -> "Run" and then type "cmd" and click "OK" to run the CMD)
2. In the opened CMD window, enter the following command and press "Enter":
- To verify that the
JAVA_HOMEvariable is set correctly, execute the following command:set JAVA_HOME
...
...
The system returns the JDK installation path
...
Step 5. Running the Product
The WSO2 product is installed and environment variables are set. The product can be started by running its start script.
1. Go to <CARBON_HOME>/bin, where <CARBON_HOME> is the actual folder where product files are stored.
2. Execute the following command to start the product.
| Code Block |
|---|
wso2server.bat --run |
3. The operation log is displayed. The last line of the log, which is similar to "WSO2 Carbon Started in n seconds", indicates that the product has been started successfully.
4. Proceed to section, Introducing the Management Console for instructions on how to access the Management Console.
Step 6. Stopping the Server
...
.
Setting system properties
If you need to set additional system properties when the server starts, you can take the following approaches:
- Set the properties from a script
Setting your system properties in the startup script is ideal, because it ensures that you set the properties every time you start the server. To avoid having to modify the script each time you upgrade, the best approach is to create your own startup script that wraps the WSO2 startup script and add the properties you want to set, rather than editing the WSO2 startup script directly.
- Set the properties from an external registry
If you want to access properties from an external registry, you could create Java code that reads the properties at runtime from that registry. Be sure to store sensitive data such as, username and password to connect to the registry in a properties file, instead of in the Java code and secure the properties file with the secure vault.
You are now ready to run the product.