During installation, the application server must have access to the Internet. If your security requirements do not permit this, you should consider airgap installation as an alternative.
The installation of Jama goes as follows:
|1.||Use a browser on your work station to access Admin Console. This will be the URL referenced during the final steps in Installation of the Admin Console.|
You will first receive a browser TLS warning. This is normal. If you have a trusted certificate you want to install on the Admin Console, you can do so prior to installation using these instructions.
|2.||Provide private key and TLS certificate to secure the Admin Console (optional) or choose to use a self-signed certificate to secure the Admin Console.|
|3.||Upload the license file provided by Jama. This is a small file with the file extension .rli.|
Note: This is the only time that you will upload a license. It is no longer necessary for a root user to set a license within the Jama application.
|4.||Secure the Admin Console in a way that is compatible with your organization's policies. This setting can be changed later.|
|a.||Anonymous: No authentication is required to access the Admin Console.|
|b.||Password: You can either create a password if one does not exist or update the existing password.|
|c.||LDAP: Configure or update LDAP authentication. This will allow users to access the Admin Console using their existing LDAP credentials.|
Note: This will not configure or update LDAP authentication within Jama itself.
Note: This only applies to the Admin Console. It does not affect the authentication and authorization of Jama itself. The Admin Console should be properly secured for any kind of business critical usage or when the installation has access to any critical data.
|5.||The console will run a preflight check for any configurations that do not meet the requirements to successfully install Jama. Select Continue to proceed with the installation.|
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.
If any of these requirements are accompanied by a warning, a pop-up will appear once you select Continue. If you decide to proceed with the installation, select Continue to proceed with the installation. Otherwise, select Cancel and make the recommended changes.
|6.||Enter the correct settings as described in the following steps.|
|7.||Enter the database settings (see Prerequisites).|
|8.||(Optional) If you need to connect to your database through an SSL encrypted connection you will need to provide additional connection string parameters.|
The Database Connection Parameters field allows you to specify parameters as key/value pairs in the format appropriate to your database.
SQL Server: ssl=require;appName=jama;bufferMinPackets
Comprehensive lists of options can be found at the following URLs:
SQL Server: http://jtds.sourceforge.net/faq.htm
|9.||Enter the context path of the Jama application.|
The web server configuration allows the use of SSL (TLS) or plain text connections. Both the TLS and plain text port can be set.
Note: The context path may be empty, or contain any number of characters: a-z, 0-9, the underscore ("_"), dash ("-") or period ("."). Letters must be lowercase. It allows you to override the path at which Jama will be available. This allows using /contour or /jama as the path at which Jama is available. The default is at the root: /
|10.||If you are restoring Jama from an XML file, enter the file path of the Jama backup file (.xml), such as /data/restore/your_backup.xml. Follow the instructions given to make sure that the file is available on the application server correctly.|
Note: In the case of XML file installation mode, it is very important to enter this file path before proceeding to install. Once the database is populated on the initial startup, changes to this setting will not be picked up.
|11.||In the case of an existing database installation mode or XML file installation mode, follow the steps below:|
|b.||Migrate the existing data folder|
|12.||Provide custom private key and TLS certificates to secure Jama (optional) or choose to reuse the certificate of the Admin Console from step 3.|
|13.||(Optional) If you have the need to connect Jama to a service protected by a certificate that was self-signed or issued by a local authority, you can ensure that Jama trusts the issuer by uploading the signing certificate to Jama. Jama's Settings page now includes a file upload button for Trusted Certificates. Upload a PEM-formatted public certificate or multiple PEM-formatted public certificates concatenated together into a single file. Jama will add these certificates to the default Java trust store.You may need this functionality to connect to your MySQL, SQL Server, LDAP, Crowd, IMAP, SMTP or other internal servers from Jama.|
|14.||Save the settings and go to the dashboard.|
|15.||Wait for the components that make up Jama to be downloaded from our private and secure registry on the Internet (pulling, downloading, pushing). The dashboard reads Starting during this phase.|
|16.||Wait for the components that make up Jama to be started and initialized. The dashboard reads Queued during this phase. It also shows more detailed information about the status, such as the data is provisioned (depending on your installation mode), the database is upgraded (patching), the initial search index is built, etc.|
|17.||Open Jama in a new browser window by selecting the Open link.|
|18.||Log into Jama.|
|19.||Verify the installation of Jama was successful.|
|20.||Follow any post-installation instructions that are applicable to your organization.|