[Collapse]Collaborator 10
 [Expand]General Information/viewarticle/80040/
 [Expand]Getting Started/viewarticle/80359/
 [Collapse]Collaborator Server/viewarticle/80060/
    System Requirements/viewarticle/80366/
   [Expand]Database Installation/viewarticle/80364/
    Server Installation/viewarticle/80363/
   [Expand]Server Upgrades/viewarticle/80401/
    Platform-Specific Notes/viewarticle/80409/
  [Expand]Server Administration/viewarticle/80108/
  [Expand]Collaborator Settings/viewarticle/80061/
 [Expand]Web Client/viewarticle/80107/
 [Expand]Desktop Clients/viewarticle/80151/
 [Expand]Version Control Integration/viewarticle/80048/
 [Expand]External Integrations/viewarticle/80340/
 [Expand]Techniques & Best Practices/viewarticle/80403/
Updated: 12/23/2016 Applies To: Collaborator 10 Rating: No votes Click to rate: PoorNot badAverageGoodExcellent

Collaborator Server > Installation

Top |Previous |Next

Collaborator Server Installation

Collaborator uses a stand-alone web server for a cross-platform, no-client, firewall-friendly user interface. Please review the System Requirements section before continuing.

First, you need to download the correct installer for your platform from our website:


To learn how to upgrade an existing Collaborator server, please see Server Upgrades.

In this section:

The Graphical Installer

Normal Installation

Advanced Installation

Upgrade Installation

The Non-Graphical Installer

Install Tips

Installing more than one server instance on a single machine

Installing on a system with multiple JRE installations

The Graphical Installer

Installers can be run in a graphical, interactive mode or an automatic mode. For first installation, you will need to run the graphical version so you can select options.

Normal Installation

The first screen of the wizard lets you know it is working:


The second screen is the End User License Agreement (EULA):


In the third screen the installer prompts to create the first user of your Collaborator server.


Important: The first user will have Administrator privileges on this Collaborator server.

Fill in company name, full name, email address, phone number, username and password. The contact information is primarily there for your users to know who to contact if they are having issues with Collaborator. SmartBear only uses this information to contact you when there is a critical issue with your Collaborator installation; we will not sell or share this information.

The next screen allows you to select whether to configure advanced options. By default, this checkbox is unselected and the default options are recommended for first-time and evaluation installations.


After this, the installer copies the server files, stopping any existing server if necessary. Once the new files are installed, the server is started automatically, and the installer tells you it is finished:


After you click Finish, a web browser will open, pointed at your installed server.

Warning: If the server has not quite had enough time to fully start up, it might take a while for the web page to load and it might even fail to open. Just "refresh" the browser.

Advanced Installation

Selecting the 'Configure Advanced Settings" checkbox, allows you to override the default settings and specify your own configuration.

On the first step of advanced configuration, you can select disk location for the installation files.


This directory should be writable by the server because several dynamic files are created here including web server logs, temporary storage, and long-term storage for file content uploaded by users. All of these locations can be changed if it is critical that the installation location be read-only, but this requires significant work on the part of the administrator and makes upgrades more difficult.

Make sure at least 5 gigabytes of space is available in the named directory. Your users will need the space for file uploads. You can always move the file upload directory.

On the next screen, you can specify port number for your server:


The port number should be selected as to not conflict with any existing services. The installer will attempt to connect to this port when you click Next; if the port is already taken by another process, you will get a warning message. You can elect to try a different port or continue. Continue at your own risk -- probably the server will not be able to start up and you will have to make the port available and restart the server manually.

Additionally, your firewall settings may prevent remote access on the default port or on your selected port. In order to allow access, you will have to modify your firewall settings accordingly. For more information see the troubleshooting section.

Next, you configure the database connection. The database should already be installed and ready:


For trial installations, you will probably want to select the default "Embedded" database. You should migrate to a full-featured database before you use the server in production.

If you picked anything but the "Embedded" database, the next screen lets you configure the connection to the database server:


The exact format of this screen depends on the database you chose. The Username and Password fields here refer to the database username and password. Typically, you will want to create a special database username and password for the Collaborator application so you can control exactly which data it has access to. This usually means full access to the database created for Collaborator and no access to any other database.

The next screen lets you decide how users will be authenticated in Collaborator.


The simplest setting is "Internal," which means Collaborator should maintain usernames/passwords in its own database.

If your company uses LDAP or ActiveDirectory, you can use that method to authenticate users in Collaborator, which means you do not have to maintain the Collaborator user list at all. If you select the LDAP method you will get an additional wizard screen that lets you supply the settings for your LDAP server. See the LDAP section for details.

You will also have the option to choose "Existing LDAP authentication configuration" if you are upgrading an existing installation.

The next screen allows you to specify the approximate number simultaneous users and automatically configure your server to support this number of users.


Upgrade Installation

If the installer detects an existing Collaborator server, either to upgrade the existing server or to install into another directory.


When upgrading, the installer retains the current configuration of a server, that is, it assigns the same installation folder and all setting values as in the current configuration - though they can be edited, if desired.

The Non-Graphical Installer

If you are upgrading the server instead of installing from scratch, you have the option of installing without any graphical user interface.

We recommend that you always use the graphical interface when possible because it gives you the chance to review settings, especially new settings that we might have added since your last installation.

To run the installer without a GUI, run the installer from a command-line using the -q switch. To set the installation directory from the command-line, use the -dir [directory] switch. The -q switch gives you a silent install and will not prompt you for any installation instructions. If you would like to be prompted for installation instructions without using the graphical installer, you can run the installer from the console using the -c command.

Install Tips

Installing more than one server instance on a single machine

All server instances need to be running on unique and available ports. Each server instance will also need a separate database and license code.

On Windows, install the different instances in different directories, on different ports, with separate database instances. This will get all of the software installed, but only the last one will be properly installed as a service. To install the others as a service, run the following command from the command line:

<install-dir>\ccollab-server /install service-name

This will install that instance as a Windows service with the specified service name. To uninstall a service that was misnamed or no longer used:

<install-dir>\ccollab-server /uninstall service-name

On *nix platforms, you should install the server in multiple directories and then edit your /etc/init.d scripts accordingly.

Installing on a system with multiple JRE installations

On systems with multiple JREs installed, it may be necessary to specify to the installer which JRE should be used for Collaborator. On Windows platforms, running the installer with the -manual argument will suppress the JRE search and cause the installer to prompt for the JRE location (specifically, java.exe). On *nix platforms, you can specify the JRE location by setting the INSTALL4J_JAVA_HOME_OVERRIDE environment variable to the JAVA_HOME value.

© 2020 SmartBear Software. All rights reserved.
Email Send feedback on this document