WSO2 Carbon - Installation Guide [ Documentation Index ]
WSO2 Carbon Installation Guide
This installation guide provides information on,
- The prerequisites for running WSO2 Carbon
- Installation instructions
- How to start WSO2 Carbon, and
- How to access the management console
This document provides information on the distribution packages available in WSO2 Carbon -
the binary distribution and the source distribution for more advanced
users.
Contents
Distribution Packages
The following distribution packages are available for
download.
1. Binary Distribution : Includes binary files for both MS Windows and
Linux operating systems, compressed into a single a zip file. Recommended
for normal users.
2. Source Distribution : Includes the source code for both MS Windows and Linux
operating systems, compressed into a single zip file which can be used to build the binary files.
Recommended for more advanced users.
Installing and Running WSO2 Carbon using the Binary Distribution
Prerequisites
Java SEDevelopment Kit
|
1.6.x (For instructions on setting up the JDK on different operating
systems, visit http://java.sun.com)
To build WSO2 Carbon from the Source distribution, it is necessary
that you have JDK 1.6.x version and Maven 2.1.0 or later
|
Apache Maven- To build Carbon from Source
|
To build the WSO2 Carbon from its source distribution, you will need
Maven 2.1.0 or later
|
Memory |
No minimum requirement - A heap size of 256~512MB is generally
sufficient to process typical SOAP messages. Requirements may vary
with larger message size and on the number of messages processed
concurrently
|
Disk |
No minimum requirement. The installation will require ~125 MB
excluding space allocated for log files and Databases. |
Operating System |
Linux, Solaris, MS Windows - XP/ Vista. |
Installing on Linux/Unix
The following steps will guide you to install WSO2 Carbon binary distribution on Unix/Linux systems.
- Download
the WSO2 Carbon binary distribution.
- Extract the zip archive where you want the WSO2 Carbon installed.
- Set the JAVA_HOME
environment variable to your Java home using the
export command or by editing /etc/profile, and add the Java /bin
directory to your PATH
- Execute the WSO2 Carbon start script or the daemon script from the bin
directory. e.g. ./wso2server.sh OR ./daemon.sh start OR
./wso2server.sh --start
- Access the management console of WSO2 Carbon instance using the URL https://localhost:9443/carbon.
(Note that server start up may take time)
- Login as "admin" using the default password "admin"
Installing on MS Windows
The following steps will guide you to the WSO2 Carbon binary distribution on the MS
Windows operating system.
- Download
the WSO2 Carbon binary distribution.
-
Extract the zip archive where you want the WSO2 Carbon installed
- Set theJAVA_HOME
environment variable to your Java installation, and the PATH environment
variable to the Java /bin directory.
- Execute the WSO2 Carbon start script from the bin folder. e.g. wso2server.bat
- If you would like to install the WSO2 Carbon as a Windows service, use the
install.bat script
- Access the management console of WSO2 Carbon instance using the URL https://localhost:9443/carbon.
- Login as "admin" using the default password "admin"
Building WSO2 Carbon Using the Source Distribution
Prerequisites
Java SE
Development Kit
|
1.6.x (For instructions on setting up the JDK in different operating
systems, visit http://java.sun.com)
|
Apache Maven- To
build Carbon from Source
|
To build the WSO2 Carbon from its source distribution, you will need
Maven 2.1.0 or later
|
Operating System
|
Linux, Solaris, MS Windows - XP/ Vista
|
Setting up the Environment and Tools
Maven:
The WSO2 Carbon build is based on
Apache
Maven 2. Hence, it is a prerequisite to have Maven (version 2.1.0 or later)
and JDK (version 1.6.x) installed in order to build WSO2 Carbon from the
source distribution. Extensive instructions on using Maven 2 are available
on the Maven website.
Please refer to the
Maven
Getting Started Guide
for more information on Maven
-
Unix based OS (e.g., Linux)
-
Download Apache Maven tar ball or the zip archive.
-
Expand it to a directory of choice.
-
Set the environment variable M2_HOME and add M2_HOME/bin to the
path as well.
-
Run mvn --version to verify that it is correctly installed.
-
Download and run the Apache Maven Windows installer package.
-
Set the 'Environment Variables' (create the system variable M2_HOME
and edit the path. e.g., "C:\Program Files\Apache Software
Foundation\maven-2.0.6"; path %M2_HOME%\bin)
-
Make sure that the system variable JAVA_HOME
is set to the location of your JDK, e.g., C:\Program Files\Java\jdk1.5
-
Run mvn --version to verify that it is correctly installed.
Once Maven is properly installed, you can start building the WSO2 Carbon.
Building WSO2 Carbon
- Download
the source distribution, which is available as a zip archive.
-
Expand the source archive to a directory of your choice.
-
All the necessary build scripts are included with the source
distribution.
-
You can run the following command inside that directory to build the
WSO2 Carbon. Note that you will require a connection to the Internet for the Maven build
to download dependencies required for the build.
Command: mvn clean install
This will create the complete release artifacts including the binary and
source distributions in the modules/distribution/target/ directory which can be installed using
the above instructions.
Note: The first time you run Maven it will automatically download the
dependent .jar files. Therefore, the first run will take more time.