Running the setup from the command line

This topic provides step-by-step details about setting up your server from the command-line.

Before you begin

Important: If you are using a Derby database, before running the setup command, ensure that the location of the database and data warehouse database in the file is an absolute path. For example:
Prior to running the setup command, you must have installed the Jazz™ Team Server and any ELM applications, created your databases, and deployed and started the applications on your application server.

About this task

The setup command is a repository tools command that allows you to set up a Jazz Team Server and associated applications in an automated way. The command may be run in interactive mode which will help capture the response file needed to drive future automated installs.


  1. Open a command window and change the directory to JazzInstallDir/server.
  2. Enter the following command to start the setup:
    For Unix operating systems
    ./ -setup repositoryURL= adminUserID=ADMIN adminPassword=ADMIN
    For Windows operating system
    repotools-jts.bat -setup repositoryURL= adminUserID=ADMIN adminPassword=ADMIN
    Tip: For detailed information about each parameter, see Repository tools command to configure the server
  3. Configure the Public URI and then hit Enter.
  4. Read the warning and confirm your public URI:
    • [1] I understand
    • [2] Cancel and exit setup - default
  5. At the Configure Database step, enter a number to choose a DB type:
    • [1] JDBC - default
    • [2] J2EE
  6. Enter a number to choose a database vendor:
    • [1] Derby - default
    • [2] Db2®
    • [3] SQL Server
    • [4] Db2 for z/OS
    • [5] Db2 i
    • [6] Derby Net
    • [7] Oracle
  7. Enter a location for the database.
  8. Choose a DB type for data warehouse database:
    • [1] JDBC - default
    • [2] J2EE
  9. Enter a number to choose a database vendor for data warehouse:
    • [1] Derby - default
    • [2] Db2
    • [3] SQL Server
    • [4] Db2 for z/OS
    • [5] Db2 i
    • [6] Derby Net
    • [7] Oracle
  10. Enter a location for the data warehouse database.
  11. Select the Database Network Server Port. The port must be unique within the hosting server machine. The default is 1527.
  12. Enter Y to enable the email notification. Enter N to skip.
  13. At the Configure User Registry step, enter one of the following:
    • [1] LIBERTY
    • [2] LDAP
    • [3] Non-LDAP External Registry
  14. Enter the following information to create an administrative user.
    • User ID
    • Password (The password is not displayed on the screen.)
    • Re-Type Password
    • Your full name
    • Email address
    If you selected LDAP, the logged in user information is imported. If you selected Non-LDAP, the password is not required.
  15. After you created the administrative user, you can disable the default ADMIN user. Choose one these options:
    • [1] Disable - default
    • [2] Do Not Disable
  16. Next, depending on installed applications, you will be asked to register local applications. Enter Y to confirm and enter the instance name (context root) and discovery URL for each application.
    Note: A local application is an application that is installed under the same application server as Jazz Team Server and its details can be discovered. A non-local application is either installed in a distributed environment or not installed in the same application server as Jazz Team Server and its details must be provided by the user.
  17. If you installed any applications, you will be asked to assign licenses. For example, if you installed Change and Configuration Management, choose a license from the following options:
    • [1] None - default
    • [2] Contributor - 60-day Trial
    • [3] Stakeholder - 60-day Trial
    • [4] Developer - 60-day Trial
    • [5] Developer for IBM Enterprise Platforms - 60-day Trial
  18. The Setup Report Builder step creates known data sources and imports the ready-to-use reports so that Jazz Reporting Service is ready to use. If the data warehouse has not been set up or a Derby database is being used then no password is required. Otherwise, enter a password for data warehouse. This step might take a few minutes.
  19. At the end of the setup, you should see message on the screen that the setup completed successfully.

video icon Video channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community forums library

support icon Support

IBM Support Community
Deployment wiki