Skip to content

Product Startup Options

Given below are the options that are available when starting a WSO2 product. The product startup scripts are stored in the <IS_HOME>/bin/ directory. When you execute the startup script, you can pass a system property by appending it next to the start-up script as shown below.

sh -<startup option>

For example:

./ -Dsetup (In Linux)
wso2server.bat -Dsetup (In Windows)

Listed below are some general options that can be used for starting the server.

Startup Option Description
-start Starts the Carbon server using "nohup" in the background. This option is not available for Windows.
-stop Stops the Carbon server process. This option is not available for Windows.
-restart Restarts the Carbon server process. This option is not available for windows.
-cleanRegistry Cleans the registry space. Caution: All registry data will be lost.
-debug \<port> Starts the server in remote debugging mode. The remote debugging port should be specified.
-version Shows the version of the product that you are running.
-help Lists all the available commands and system properties.

Listed below are some system properties that can be used when starting the server.

Startup Options Description
-DosgiConsole=[port] Starts the Carbon server with the Equinox OSGi console. If the optional 'port' parameter is provided, a telnet port will be opened.
-DosgiDebugOptions=[options-file] Starts the Carbon server with OSGi debugging enabled. Debug options are loaded from the <IS_HOME>/repository/conf/etc/osgi-debug.options .
-Dsetup Cleans the registry and other configurations, recreates DB, re-populates the configuration and starts the server. Note: It is not recommended to use this option in a production environment. Instead, you can manually run the DB scripts directly in the database.

Starts the product as a worker node, which means the front-end features of your product will not be enabled.


Note that from Carbon 4.4.1 onwards, you can also start the worker profile by setting the following system property to 'true' in the product startup script before the script is executed.

-DserverRoles=<roles> A comma separated list of roles used in deploying Carbon applications.
-Dprofile=<profileName> Starts the server with the specified profile, e.g., worker profile.
-Dtenant.idle.time=<time> If a tenant is idle for the specified time, the tenant will be unloaded. The default tenant idle time is 30 minutes. This is required in clustered setups, which has master and worker nodes.