Prepare to install Jama

  Administration > System administration > Server > Install, Upgrade, and Migrate Jama > Install Jama >

Prepare to install Jama

Previous pageNext page Print this topic! Mail us feedback on this topic!

Determine how you want to install Jama

Knowing what type of installation you want will help you determine what steps to take.

1.New Installation: You want to install Jama with the embedded sample data set.
2.Migrating Data: You want to install Jama with an existing data folder and existing database
1.Connect to an existing database and use existing data: Connect a new Jama server to an existing database and manually migrate the data. This only applies if you are migrating from a supported database system (MySQL or Microsoft SQL Server) to the same database system.
2.Restore from a backup:
1.XML file: If you are migrating between different types of databases, you must use the Jama backup to XML export function.You will also need to migrate the data manually.
2..jama file: You can also restore from an existing Jama instance. Export a .jama file to create a zipped archive that includes:
XML export of the database
All filesystem assets, like attachments, reports, etc.

This is a good choice if you are migrating from a database system that is no longer supported, like Oracle.

 

Prerequisites:

A License file provided by Jama. This is a small file with the file extension .rli.

 

Application server: see System Requirements

For users and administrators to properly access Jama, the following ports must be accessible to inbound traffic. Work with your network administrator to ensure your network is configured properly.
Port 22: The SSH port. This allows administrators to make remote connections to the application server using SSH.
Port 8800: The Admin Console port. This is needed for administrators to access the Replicated Admin Console used to configure, install, and upgrade Jama.
Port 80: The Jama port for clear text communication (HTTP). This port can be used to access Jama. It can be disabled or the port number can be reconfigured.
Port 443: The Jama port for SSL/TLS communication (HTTPS). This port can be used to access Jama. It can be disabled or the port number can be reconfigured.
For Jama to successfully run its processes, the following User IDs must be reserved.
User ID 91
User IDs 480 - 499
To ensure accurate time on the application server sync the time on a routine schedule. For example, use the command: ntpdate pool.ntp.org
You must allow all inbound and outbound communication on all ports from the Jama application server to itself, including over the public IP of the Jama server. This is necessary for the orchestration and back-end communication of the Docker containers which run Jama. Closing access to ports for communication within the server is not supported and can cause many unforeseen issues.
If you plan to use a proxy server, you must install Docker prior to installing Replicated. See Configure Proxy Settings for further information.

Note: If you are using CentOS, there is a conflict with firewalld and Docker that can render containers unable to communicate with each other. Firewalld must be disabled once Jama 8.24 is installed.

 

Database server: see System Requirements

The following information is needed when connecting Jama to the database server:
Type/vendor: MySQL or Microsoft SQL Server
Database host
Listening Ports
Database schema name  (check installation troubleshooting if you need to change this later)
Username
Password
The database user must be able to either create a new database schema or create tables inside an existing database schema of the given name.
The database must be able to accept a minimum of 300 concurrent connections.
The database name must start with a letter (a-z), followed by any number of characters: a-z, 0-9 or an underscore ("_"). Letters must be lowercase. Check Installation Troubleshooting if you need to change this later.
The Jama application server must be allowed to communicate with the database server over the listening ports. The default port for MySQL is 3306 and for SQL Server is 1433.

Note: For MySQL installations with an pre-existing databaseyour database must be set to use UTF-8 encoding.

Note: For Microsoft SQL Server installations, make sure that an existing database, or one that you just prepared for this installation, has Read-Committed Snapshots enabled. This can be done as follows:

ALTER DATABASE name SET READ_COMMITTED_SNAPSHOT ON WITH ROLLBACK IMMEDIATE;

Optional prerequisites:

Private key and TLS certificate to secure the Admin Console.
Private key and TLS certificate to secure Jama.
Domain Whitelisting - During installation, the Jama application will reach out to external URLs for information it needs to proceed. For example, Replicated may reach out to the following domains: https://www.replicated.com/docs/kb/developer-resources/domains-required-by-replicated/

 

Your firewall or proxy whitelist settings may need to be adjusted to allow domains like these to pass through.

 

Note: This list is not exhaustive. If you need to whitelist domains for your firewall or proxy to install Jama, we always recommend reaching out to your account owner for more information on Jama's airgap distribution. Jama Support cannot assist you with accessing these domains through your firewall or proxy nor can they verify all domains necessary to install Jama.