Applies to Collaborator 12.2, last modified on October 07, 2019

In order to use Collaborator, you must first install and configure the server side of the Collaborator.

1. Download Collaborator server

Navigate to SmartBear Downloads Center: http://support.smartbear.com/downloads/collaborator/ and download the "Server Installer" that corresponds to a platform of your server.

2. Install Collaborator server

Launch server installer and go through the wizard to complete the installation.

Note: During the installation you may configure advanced settings for the Collaborator server: server port, authentication type, database type and so on. For first-time and evaluation installations we suggest that you leave the default values for these settings.

Once the installation is finished, your default browser will start and open the Collaborator Web Client. The rest of the configuration and administration process is done using the Web Client.

3. Initialize database

When opening the Web Client for the first time, the database initialization screen is displayed.

Database Initialization Screen

Click Get Started to continue.

4. Perform first-run initialization

If you have chosen the default values for advanced settings or chosen Internal Authentication during the installation process, then specify the same username and password that you have provided during the installation.

If you have chosen the LDAP or AD authentication during the installation process, then specify the same username and password that you have provided when configuring your LDAP/AD integration. Please see LDAP Authentication for more information.

Login screen

Click Sign In.

Once you have logged in as the admin, you will be redirected to the First-Run Initialization page. This page is displayed only once after the installation and asks you to provide necessary information to set up the Collaborator server.

In the Product Initialization section you will need to choose which product you would like to use: Collaborator Community, Collaborator Team or Collaborator Enterprise.

Product Initialization screen

All products have the same goal, to make your peer review process easier and more effective, but provide different sets of features. Collaborator Community is intended for small developer groups, Collaborator Team is for medium groups and Collaborator Enterprise is for large enterprise level companies. To view all differences between Collaborator editions, please read this page.

Note: Depending on certain features that were chosen during the installation, the Product Initialization section may show a smaller set of available products. For example, if Oracle database was selected during the installation, then only Collaborator Enterprise will be available.

5. Configure basic system settings

After the first-run initialization, you are redirected to the Home page. This will be the starting page for administrating and working with Collaborator. Later on, after logging in you will start your work with Collaborator from the Home page.

This page looks much the same as your average Collaborator user’s home page. For the administrators the page additionally displays the Admin section on the top toolbar and the System link in page footer.

Collaborator Web Client Home Page

Click the image to enlarge it.

As the Collaborator administrator, you would like to familiarize yourself with the administration settings, so click the Admin section in header menu.

The Site-Wide Administration Settings section is where you can configure the settings of your Collaborator server.

Site-Wide Administration Settings

Click the image to enlarge it.

The administration settings are grouped into a number of categories: General, Users, Groups and so on. You can read the detailed description of each setting in the Collaborator Settings section.

When configuring a Collaborator server for the first time, pay your attention to the following settings from the System category:

  • External URL – Enter the full URL to the main page of the web server on which Collaborator was installed, as it would be seen by external clients.
  • Display > Global "Create User" – When you are starting out, and you do not want to manually create usernames for all users, mark this field as "Show" so the users can create their own username and password. Mark it as "Hide" if you want to control the creation of users and usernames.
  • Access Restrictions – Control who has access to reviews, reports, subscriptions, and systems information.
  • Review Process – Control what users can or cannot do during the review process.

Besides, most likely you would need to configure the following categories, as well:

  • Email - Configure SMTP server settings and email notifications.
  • Remote System Integrations – Setup integrations with remote repository systems like GitHub, GitLab or Bitbucket, or with issue-trackers like JIRA.

6. Activate your license

If you have an external Internet connection, Collaborator will attempt to contact our licensing server so that we can automatically set you up with a 30-day trial license. Your licensing status is displayed in the bottom-left side of home page footer.

Licensing status description

If you do not have an external connection, or if a firewall prevents access to our licensing server, you need to obtain a license code manually.

To request a license, please fill out this form:

https://smartbear.com/product/collaborator/free-trial/

To enter a permanent license code, or a trial license code that you obtained manually:

  1. Click Licensing category of the Admin section.

    This will open a page that gives you information regarding the licensing, such as when the license expires, when the support and upgrades expire, how many seats you have and so forth.

  2. Find the Node ID field in the Current License pane. The Node ID is an 8-character value that is unique to every installation. Node ID is tied to every license code we generate.

    Current License pane
  3. Copy an 8-character value of Node ID and send it to your Account Manager to activate your license. If you do not know who your Account Manager is, just send the Node ID to sales@smartbear.com.

  4. After you send us the Node ID, you will receive an email with a company key and license code. The company key is "trial" for temporary licenses and a word or phrase for permanent licenses. The license code will be a 32-character code. Enter the company key and the license code in their respective fields, and click Save.

    Configuration pane

That is all. Collaborator server is installed, configured and ready for operation.

Where to go next

To get detailed information about the server, its configuration and maintenance, read Collaborator Server section.

To learn how to upgrade an existing Collaborator server, read Server Upgrades section.

To learn about using Collaborator in a daily work, see Getting Started For Users and Working With Collaborator sections.

Highlight search results