Changing the management console's URL
When you start a WSO2 server, the URL of the management console will be printed on the terminal. The URL format is as follows:
https://<Server Host>:<Management Console Port>/carbon/. When accessing the management console from the same server where it is installed, you can type
localhost instead of the IP address.
You can change the URL by modifying the value of the
<MgtHostName> property in the
<EI_HOME>/conf/carbon.xml file. When the host is internal or not resolved by a DNS, map the hostname alias to its IP address in the
/etc/hosts file of your system, and then enter that alias as the value of the
<MgtHostName> property in
carbon.xml. For example:
Configuring the session time-out
If you leave the management console unattended for a defined time, its login session will time out. The default timeout value is 15 minutes, but you can change this in the
<PRODUCT_HOME>/repository/conf/tomcat/carbon/WEB-INF/web.xml file as follows.
Changing the management console's interface
The user interfaces of every Carbon product allows you to configure, monitor, tune, and maintain the product. The components that formulate the design and style of these user interfaces are defined in resource (JAR) files.
The user interface of every Carbon product consists of two layers:
The common product layout/design inherited from the Carbon platform: All the common templates, styles (CSS files), and images are stored in the Carbon core UI bundle, which is named
<version-number>is the particular version of the bundle). This bundle is responsible for the overall look and feel of the entire Carbon platform.
- The styles/images unique to each product: Each Carbon product (that is built on Carbon kernel) has another style bundle, which contains all the overriding style sheets and images:
You can customize the user interfaces by modifying these resource files. You need to create a fragment bundle for the original resource file. Then, you can pack the modified resource files in the required bundle. The files in the required bundle will get precedence and will override the files in the original bundle.
You can use this same technique to customize any aspect of the user interfaces. The advantage of this technique is that you will not lose your customizations when you apply official patches to the product by replacing the original bundles.
For example, when you access the Management Console using the following URL, by default, it has the WSO2 product logo as shown below: https://10.100.5.72:9443/carbon/
Note that the images and instructions given on this page are valid for WSO2 products that are based on Carbon 4.4.x.
Follow the steps below to customize the above management console by changing the logo.
<PRODUCT_HOME>/repository/components/plugins/directory. You need to find the bundle that contains the resource files that you want to modify. In this case, the logo and the related CSS files are contained in the
org.wso2.carbon.ui_<version-number>.jarfile. Copy the
org.wso2.carbon.ui_<version-number>.jarfile to a separate location on your computer, and extract the file. Note the symbolic name of this bundle, which is '
Create a new Maven project using your IDE. Be sure to include the symbolic name of the original bundle that you extracted in the previous step (which is '
org.wso2.carbon.ui_<version-number>') in the Maven project name. For example, you can use
rg.wso2.carbon.ui_<version-number>_patchas the Maven project name.
Add the following content to the
pom.xmlfile of the
org.wso2.carbon.ui_<version-number>_patchproject. In this
pom.xmlfile, be sure to replace the
_patchwith the correct version value.
Create directories in your Maven project as explained below.
/webfolder under the
/src/main/resourcesdirectory of the
Then, create the /admin directory under /web.
Finally, create the
_patchproject should now look as shown below.
Create a new CSS file (e.g.
customizations.css) with the following content.
This file includes the logo customization styles.
customizations.cssfile to the
template.jsp file that is in the
org.wso2.carbon.ui_<version-number>.jarbundle, which you extracted in step 1 above. You will find template
.jsp file inside the
web/admin/layout/directory. Then, copy this file to the
Locate the following line in the
web/admin/layout/template.jspfile, which you added in the previous step:
Replace the above line with the following:
Add the below image as the new logo (e.g.
new-logo.png) to the
Create another Maven project using your IDE. Be sure to include the symbolic name of the original bundle that you extracted in step 1 above (which is '
org.wso2.carbon.ui_<version-number>') in the project name. For example, you can use
rg.wso2.carbon.ui_<version-number>_fragmentas the Maven project name.
This creates a project for the fragment bundle. Since the symbolic name of the original bundle is ‘
org.wso2.carbon.ui’, the fragment host value of this bundle should be the same (e.g. o
rg.wso2.carbon.ui_<version-number>_fragment). This fragment bundle will not contain anything (expect the
pom.xmlfile) when it is built.
Add the following content to the
pom.xmlfile of the
org.wso2.carbon.ui_<version-number>_fragmentproject. In this
pom.xmlfile, replace the
_fragmentwith the correct version value.
pom.xmlfile of the fragment bundle defines properties, which includes the required bundle value (i.e. ‘
- Now you can build the two projects. Open a terminal, navigate to the relevant project directory (listed above), and execute the following command: mvn
- Once the project is built, copy the two JAR files listed below (from the
<PROJECT_HOME>/target/directory) to the
- Restart the WSO2 product server.
Access the management console of your WSO2 product using the following URL: https://10.100.5.12:9443/carbon/. You view the new logo, which the patch bundle contains as shown below.