To install the TestRail application on your Unix server, upload and extract the TestRail installation archive to your web server and copy the files to your web server’s www directory (e.g., on Ubuntu it’s /var/www/html/testrail). Some Unix systems do not support the unzip command by default, so you might have to install it first (example shows Ubuntu/Debian):
sudo apt-get install unzip
Then point your web browser to the new TestRail directory on your web server to launch the TestRail Installation Wizard (e.g. http://<server>/testrail/) and follow the instructions:
- Review and accept the license terms to proceed
- Database Settings
This guide assumes the following values:
- Driver: Select the appropriate MySQL driver for your database. In this document, we will select ‘MySQL (5.x and higher)’ from the Driver dropdown menu
- Server: localhost (hostname)
- Database: testRail (the DB name we created in MySQL)
- User: testrail
- Password: (the password used when creating the ‘testrail’ Login)
- Cassandra Settings
The installer will ask you to specify Cassandra information. This depends on the information you provided during installation.
The default values are:
- Server: localhost
- Port: 9042
- Keyspace: testrail or the name you provided when creating a Keyspace
- Username: cassandra or the user you created for TestRail and granted permissions to
- Password: cassandra or the password you gave the user you created
- RabbitMQ Settings
Please refer to the official RabbitMQ installation documentation for your operating system at:
Use of RabbitMQ is optional. If you would like to take advantage of some of our Webhooks functionality, RabbitMQ needs to be configured.
As none of these fields are required to proceed with the installation, you may proceed to the next step if you wish.
The default values used in this documentation are as follows:
- Message Queue Server: The Host name of the RabbitMQ server
- Message Queue Port: The RabbitMQ port (5672 by default)
- Message Queue User: The TestRail RabbitMQ user. This user needs permissions to manage queues (creation/deletion)
- Message Queue Password: password used for the TestRail RabbitMQ user above
- Use TLS: [enabled/disabled]
- Message Queue CA Certificate: The CA certificate for connecting to the RabbitMQ server if using a TLS
- Message Queue Client Certificate: The client certificate for connecting to the RabbitMQ server if using a TLS
- Message Queue Private Key: The client private key (PK) for connecting to the RabbitMQ server if using a TLS
- Application Settings
- Installation Name: The name of this TestRail installation. The installation name is displayed on the login screen and the dashboard.
- Web Address: The web address of your TestRail installation. Used, among other things, for links in email notifications. ‘http://localhost/testrail/’ was the value used in this documentation.
- Default Language: Determines the default language of the user interface. Users can override their language under My Settings.
- Default Locale: Determines how dates and numbers are formatted by default. Users can override their locale under My Settings.
- Default Time Zone: Determines the default time zone for dates and times.
- Attachment Directory: The directory on the web server where uploaded attachments are stored. Must be writable for TestRail and shouldn't be directly accessible with a web browser. In this document, we will use ‘/opt/testrail/attachments/’ (You will need to manually create this directory).
- Report Directory: The directory on the web server where generated reports are stored. Must be writable for TestRail and shouldn't be directly accessible with a web browser. In this document we will use ‘/opt/testrail/reports/’ (You will need to manually create this directory).
- Log Directory: ‘/opt/testrail/logs/’ (You will need to manually create this directory).
- Audit Directory: ‘/opt/testrail/audit/’ by default (You will need to manually create this directory).
The installer will also ask you to specify directories to store attachments, reports, and log files. Please create those directories and make sure that the directories are writable by the web server. With the attachment and report directories, also make sure that they aren’t directly accessible with a web browser for security reasons, so specify a directory outside your www directory (for example, /opt/testrail/attachments). To make the directories writable by your web server, just change the ownership of the directories to your web server user. For example, on Ubuntu systems:
sudo chown www-data:www-data /var/www/html/testrail/logs/
sudo chown www-data:www-data /opt/testrail/attachments/
sudo chown www-data:www-data /opt/testrail/reports/
- Email Settings
These are also optional settings. The server settings are used for email notifications and for the 'Forgot Password' functionality.
- Server: The hostname and port of the machine that is used for sending out emails. If the port differs from 25, append it like this: 'mail.example.com:50'.
- Email encryption: [Use SSL / Use TLS / No encryption] Enable this option if your email SMTP server uses and requires a secure connection (SSL/TLS).
- From: The email address that is used for sending out emails.
- User: Leave empty if the email server does not require authentication.
- Password: Leave empty if the email server does not require authentication.
- Enable email notifications: [Enable/Disable] Email notifications are sent for test changes and test results. Can also be disabled on a per-user basis via 'My Settings'.
Create your first user account and enter your TestRail license key.
- Full Name: For example, John Doe or Jane Doe
- Email Address: For example. firstname.lastname@example.org or email@example.com
- Password/Confirm Password: Enter and confirm password
- License Key: Paste your trial or full license key
- Confirm configuration
Review your settings and click Install to complete your TestRail installation.
You must activate the TestRail background task. This background task is responsible, among other things, for sending out email notifications for test changes if you have the feature enabled. To learn how to activate it, see the background task documentation.
Once you finish the steps, you will get this success screen at the end.
You may need to create a config.php file using the contents of the yellow box and save it in your instance’s wwwroot folder. In this document, we used ‘/var/www/html/testrail/’.
You can start using the application by clicking Log in to TestRail or by accessing it with your web browser, i.e.: