Jama Connect User Guide

Install Jama Connect
  1. Make sure the application server has access to the Internet. If your security requirements do not permit this, consider airgap installation.

  2. Use a browser on your work station to access the admin console with the URL referenced during admin console installation. You will first receive a browser TLS warning. This is normal. If you have a trusted certificate you want to install you can do so in the admin console

    tls_warning.png
  3. Provide private key and TLS certificate  (optional) or choose to use a self-signed (SSL) certificate to secure the admin console.

    installation 02 - https for admin console.png
  4. Select Choose license to upload the license file provided by Jama Software. This is a small file with the file extension .rli.

    (If you are restoring from a Replicated snapshot, choose Restore from snapshot instead).

    installation 03 - upload your license.png

    Note

    This is your only chance to upload a license. If you install the wrong license you will need to reinstall the admin console.

  5. Secure the admin console in a way that is compatible with your organization's policies. This setting can be changed later.

    installation 05 - secure the admin console.png
    • Anonymous

      No authentication is required to access the admin console.

    • Password

      You can either create a password if one does not exist or update the existing password.

    • LDAP

      Configure or update LDAP authentication. This will allow users to access the admin console using their existing LDAP credentials. 

    Note

    This only applies to the admin console and does not affect the authentication and authorization of the Jama Connect application. The admin console should be properly secured for any kind of business critical usage or when the installation has access to any critical data.

  6. The console will run a preflight check for any configurations that do not meet the requirements to successfully install the application.

    Items meeting requirements will be in green. Anything that does not meet the requirements will be in yellow and will include an explanation of why it failed.

    preflights_warning.png

    If any of these requirements are accompanied by a warning, a pop-up will appear once you select Continue.

    preflight_warning_continue.png

    If you decide to proceed with the installation, select Continue to proceed with the installation. Otherwise, select Cancel and make the recommended changes. 

  7. Enter your database settings.

    setting-database.png
  8. If you are restoring from an XML or JAMA file enter the filepath to the backup you are using here. 

    restore_backup (2).png
  9. Optionally, enter your web server settings.

  10. Enter your host name and make sure it matches the TLS certificate.

  11. Provide custom private key and TLS certificates to secure the application (optional) or choose to reuse the certificate of the admin console from step 3.

    tls_config.png
  12. Configure your TLS certificate.

  13. Optionally configure memory, startup and New Relic settings. (You can also configure these later. You may need to fine tune your memory setting as users start accessing the application. Be sure to monitor usage and fine tune the memory settings as needed. )

  14. Settings will not take place until you restart the application, which will cause downtime for any users. Select Save and you will see the confirmation that your settings have been saved.

    If you want to come back later to apply changes (when downtime won't be an issue for users) select Cancel and restart later.

    If you are ready to restart the application and apply the changes now, select Restart now).

    change settings 02 - settings saved - restart now.png
  15. Select Dashboard in the header. The display reads Starting while the application components are downloaded from our private and secure registry. 

    jama_starting.png
  16. The display reads Queued while the components are initialized. It also shows more detailed information about the status, such as how the data is provisioned (depending on your installation mode), how the database is upgraded (patching), and how the initial search index is built. 

    Note

    If the dashboard reads Starting or Queued for a long time with no progress, or if it reads Error, check the log files on the application server. Specifically, look for errors, exceptions and stack traces in the following:

    • /logs/tomcat/catalina.out
      
    • /logs/tomcat/contour/contour.log
  17. Select Open in the upper left panel to open Jama Connect in a new tab.

    jama_started.png
  18. Log in as root and verify that the installation was successful. 

    Note

    Here's what to do if these errors occur:

    • "This webpage is not available"

      Verify that the "Host Name" section of the settings was correctly entered to point to the application server.

    • "Not private" or "Not secure"

      This might happen if you chose a self-signed certificate or uploaded an invalid certificate. Verify that you correctly entered the Custom TLS configuration in the Host Name window.

      If this only happens for other users and not the system administrator, and the admin console is using a self-signed certificate, you may have already told your web browser to "Proceed ... (unsafe)" or "Add exception," while other users have not. Verify you have selected the setting you want for Reuse admin console TLS configuration in the Host Name window.

    • "Problem: Cannot create database jama: Connections could not be acquired from the underlying database!"

      Most likely there’s something wrong with your database settings, or the ability of the application server to connect the database server. Double-check your database settings in the admin console.

  19. Follow any post-installation instructions that are applicable to your organization.

If this is not working please contact us at support@jamasoftware.com. You should generate a support bundle to help Customer Care understand what happened.