To install the actual TestRail application on Windows Server, upload and extract the TestRail installation archive to your web server and copy the files to your web server’s wwwroot directory (e.g., C:\inetpub\wwwroot). Alternatively, you can set up a virtual directory in IIS and install the TestRail files in another location.
Next, point your web browser to the new TestRail directory on your webserver to launch the TestRail Installation Wizard (e.g. http://<server>/testrail/) and follow the instructions.
Permission problem (401)? If you get a 401 permission error when you try to access the TestRail installer, make sure that IIS can read and execute the PHP files. To do this, right-click the testrail directory in Explorer, right-click Properties, and then select the Security tab. If the IIS user isn’t listed, click Add, enter the IIS user (IUSR under Windows 2008 and later, IUSR_<hostname> under Windows 2003), and confirm with OK. Then check the Read & Execute, List Folder Contents, and Read permissions. Also important: Click the Advanced button and check the Replace permission entries on all child objects with entries shown here that apply to child objects. Close all dialogs by clicking OK.
SQL Server Express / named instance? If you installed SQL Server Express (or another SQL Server edition) as a named-instance, you might need to enter the instance name as part of the server name when connecting TestRail to your database. That is, on the second installation wizard page, you would need to enter both the hostname as well as for instance name into the Server field. For example, for a local SQL Server Express instance, with an instance name of sqlexpress enter the value localhostsqlexpress
- Review and accept the license terms to proceed
-
Database Settings
Select the appropriate MS SQL driver for your database. In this document, we will select ‘MS SQL Server (2008, 2012, 2014, or 2016)’ from the Driver dropdown menu. Enter values for all required fields on this page before proceeding.
Here, the following example values are used (you can have the values you wish at installation):
- Server: localhost (hostname). In this case, the PC Name is used, appended by \SQLEXPRESS. This information is also located in your SQL Server Management Studio (screenshot below). Please note, your information will vary.
- Database: TestRail (the DB name you created in SQL Server)
- User: testrail
-
Password: the password used when creating the ‘testrail’ Login
- Server: localhost (hostname). In this case, the PC Name is used, appended by \SQLEXPRESS. This information is also located in your SQL Server Management Studio (screenshot below). Please note, your information will vary.
-
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
The use of RabbitMQ is optional. If you wish to take advantage of some of the Webhooks functionality, RabbitMQ needs to be configured. As none of these fields are required to proceed with the installation, you can proceed to the next step if you wish.
For more information on downloading and installing RabbitMQ in your operating system, refer to the official installation documentation.
If you wish to configure RabbitMQ, the default values 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 example 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 ‘C:\testrail\attachments\’ (You have 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 ‘C:\testrail\reports\’ (You have to manually create this directory).
- Log Directory: ‘C:\testrail\logs\’ by default (You have to manually create this directory).
-
Audit Directory: ‘C:\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 webserver. With the attachment and report directories, for security reasons, you should also make sure that they aren’t directly accessible with a web browser. Make sure to specify a directory outside your wwwroot directory (for example, C:\TestRailAttachments). To make the directories writable by IIS, add the IUSR user to the security settings of the directories and grant full permissions to this user (on Windows Server 2003 systems, the user is usually called IUSR_<hostname>). Make sure IUSRS is the owner of the directories:
-
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'.
-
Administrator Account
Create your first user account and enter your TestRail license key.
- Full Name: For example, John Doe or Jane Doe
- Email Address: For example. john.doe@email.com or jane.doe@email.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 finally install TestRail.
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. Learn how to activate the TestRail background task here.
Once you finish the steps, you will see a success screen at the end.
You can start using the application by clicking Log in to TestRail or by accessing it with your web browser, i.e.:
http://<server>/testrail