Checkbox 7 - On-Premises Installation Guide

This guide will walk you through the steps to install Checkbox 7 On-Premise on your server for the first time. If you are upgrading or patching, please follow the Checkbox 7 Upgrade Instructions instead. 

Important Note: This document applies to version 7.19.0 or later. If you are using an older version, please download a newer version from your customer portal.

Checkbox 7 Technical Requirements

Requirement #1 - Server/Environment Requirements

Before beginning the installation, please ensure that your server environment meets the minimum system requirements for Checkbox 7. Updated requirements can always be found at https://www.checkbox.com/support/technical-requirements/.

COMPONENT

MINIMUM REQUIREMENTS

Operating System

32 and 64 bit versions of Windows Server 2008 R2, 2012, 2016, 2019

Web Server

Microsoft Internet Information Server (IIS) 7.0 or higher with AT LEAST 4 GB RAM*; Important: check the IIS module requirements to make sure that you have the proper IIS components enabled on your server.

Database

Microsoft SQL Server 2008, 2012, 2014, 2016. SQL Server Express Editions also supported**

Cloud Hosting

Amazon EC2, Amazon Elastic Beanstalk, Azure Virtual Machines, Rackspace Cloud Servers. Checkbox supports virtual machine environments on Microsoft Azure and Rackspace. Checkbox does NOT support  Rackspace Application hosting tools.

Browser

Microsoft Internet Explorer 11 or higher; Microsoft Edge, most recent versions of Chrome, Firefox, Safari***

Privileges

Administrator access to Web Server and Database Server required for installation.

Disk Space

1GB for application installation and base database; Overall database size depends on the number of surveys, users, and responses.

ASP.NET

.NET 4.6.1

Email

Checkbox supports using SMTP or Amazon Web Services SES for sending system emails, including survey invitations.

 

Requirement #2 - URLs + SSL

The Checkbox 7 On Premises installer provides two options for installation:

  • Option 1: A single URL and IIS web site (default / recommended)
    This approach requires a single URL, e.g. https://www.yoursite.com, and then installs each of the three applications in virtual directories/folders so that the end result is that you have https://www.yoursite.com/api for the API, https://www.yoursite.com/admin for the Checkbox admin app, and https://www.yoursite.com/surveys for the site used to take surveys. 
     
  • Option 2: Three URLs and three IIS web sites
    This approach requires three unique / valid URLs. Each Checkbox site is configured with the application in the root of the URL. This approach is generally useful for scenarios where you'd like to install each Checkbox app on a different server or have more granular control over the settings or amount of system resources used by each application.

SSL
We highly recommend that you use SSL on your Checkbox sites. Note that you cannot use SSL on some of the web sites -- it is all or nothing.

Requirement #3 - Checkbox License File

Obtain a valid Checkbox 7 license file (.lic file). For trial customers, there is a 30 day license included in the trial download. For licensed Checkbox customers, please download a Checkbox 7 license from your customer portal.

Installing Checkbox for the first time:

Step 1. Create TWO new databases for Checkbox.

One database will be used for application data and the other will be used for messaging. These databases must not contain any tables or existing data.

Important Note While it is possible to use a single database for both the Checkbox application and the Checkbox Messaging Service, this is not recommended and may result in performance issues over time.

Step 2: Unzip the Checkbox download files

Unzip the files into a temporary location. 

IMPORTANT NOTE: The installer will copy the files to a location of your choice. 

Step 3: Install the license files

You will need to place your Checkbox 7 license file (.lic) in both the API\bin folder and CheckboxService folders in the location specified in step 2. Please do this prior to running the installer.

Step 4:  Run the .exe file named “Checkbox-7-Install-UI.exe” in the “installer” directory. 

This installer will request important setting information about your installation that will be used to configure the web applications and service for you. The installer will setup and configure the websites in IIS.

This tool will also generate all of the database tables, stored procedures, and starting data that you need for Checkbox.

Lastly, this installer will configure and install the required Checkbox Service, which will allow you to schedule invitations using Checkbox. 

Please note: Windows Management Framework 4.0 is required to run the installer. If your system does not have it installed, you can install it from http://www.microsoft.com/en-us/download/details.aspx?id=40855

Step 5: (Optional) Enable Write Permission for the Logging Folder

By default, Checkbox writes error log files to the local disk in API\App_Data\Logs (if these folders don't exist, please create them).

You will need to give the Application Pool user write permission to this folder for this functionality to work correctly. Follow the "Default Logging Configuration / Installation Step" in the Configuring Error Logging instructions.

You can complete this step later if you'd like.

Step 6: (Optional) Add reCAPTCHA keys

If you'd like to use the reCAPTCHA survey item (used to stop spam survey responses), you'll need to follow the reCAPTCHA configuration instructions.  Note that this step can be completed at a later time if you'd like.

Step 7. Test the Installation

Once the sites have been configured the application should be available to access. Navigate to the URL of your Checkbox Admin application. You should see a login page asking for a username and password.

Your initial username and password will be “admin” for both. This will be your System Administrator (super-user) for the account and should not be deleted.  

Security Warning We strongly recommend that you immediately change the password. To do this, navigate to the main Contacts area and edit the admin user to change the username and/or password. Note that you should NOT change the User roles for this user.

Have more questions? Submit a request

0 Comments

Article is closed for comments.