Installing on Windows

Installing on Windows

Installation using a package management system on Windows.

This installation guide only supports 64-bit systems. See Supported platforms for the complete list of platforms supported by Couchbase Server.

Prerequisites

To install Couchbase Server on Windows, you need to perform following prerequisites:

  1. Make sure that you have no anti-virus software running on the machine before you start the installation process.
  2. Verify that you have administrator privileges using a local system account on the machine where you are performing the installation.
  3. By default, on Windows the TCP/IP has default number of ports available for client communication.

    You need to follow the information provided in Avoiding TCP/IP Port Exhaustion to adjust the configuration and increase the number of available ports.

  4. By default, the Windows system does not provide an adequate number of ephemeral ports for Couchbase Server clusters. Without the correct number of open ephemeral ports, you can experience errors during rebalance, timeouts on clients, and failed backups.

    The Couchbase Server installer will automatically check for your current port setting and adjust it if needed. See Microsoft KB-196271.

Note: On Windows earlier than 10 or Server 2016, Windows Updates need to be applied to ensure the universal CRT is installed. For other versions of Windows, see Update for Universal C Runtime in Windows.

Downloading on Windows Systems

You can download Couchbase Server directly using the wget.exe command for Windows or Powershell scripting.

The basic syntax of the wget command is:
$ wget [option]... [url]...
For example, the following command downloads Couchbase Server Enterprise Edition for Windows Server 2012 R2:
$ wget.exe --no-check-certificate http://packages.couchbase.com/releases/version/couchbase-server-enterprise-version-windows_amd64.msi 

Interactive Installation

To install Couchbase Server on Windows using interactive install wizard follow the steps below:

  1. In Windows Explorer, locate the downloaded couchbase-server-enterprise_version-windows_amd64.msi file, which typically is located in the default Downloads folder. Double click on the executable file.

    The installer for Windows detects if you need to install any redistributable packages included with Couchbase Server. If these packages are not already on your system, they are automatically installed along with Couchbase Server.

  2. You will be prompted with the Installation Location screen. You can change the location where the Couchbase Server application is located, which configures the server location and not the location where the persistent data is stored.

    The installer copies necessary files to the system. During the installation process, the installer also verifies that the default administration port is not already in use by another application. If the default port is unavailable, the installer prompts for a different port to be used for administration of Couchbase Server. The installer asks you to set up sufficient ports available for the node.

    By default, Microsoft Server will not have an adequate number of ephemeral ports, see Microsoft Knowledge Base Article 196271:

  3. Click Yes to continue.

    Without a sufficient number of ephemeral ports, a Couchbase Server cluster fails during rebalance and backup. Other operations, such as client requests, will time-out. If you already changed this setting, you can click No. The installer displays this panel to confirm the update.

  4. After installation, follow the server setup instructions.
Attention: If the Windows installer hangs on the Computing Space Requirements screen, there is an issue with your setup or installation environment, such as other running applications.

You can implement this workaround to complete the installation:

  1. Stop any other browsers and applications that were running when you started installing Couchbase Server.
  2. Kill the installation process and uninstall the failed setup.
  3. Delete or rename the temp location under C:\Users\[logonuser]\AppData\Temp.
  4. Reboot and try again.

Unattended Installation

To perform an unattended installation, also referred to as silent or headless installation, use the \qn or \quiet options with msiexec executable. Note that for a completely unattended installation, you must run the command from an Administrator command prompt.

The following command installs Couchbase Server Enterprise Edition on the default directory:
msiexec /i couchbase-server-enterprise-version-windows_amd64.msi /qn
To install to a non-standard directory, use the following command:
msiexec /i couchbase-server-enterprise-version-windows_amd64.msi /qn INSTALLDIR=C:\my-install-dir
Note: msiexec immediately returns control to the command prompt and does not wait for the installation to complete or report any errors. You may want to wait a minute or two for the actual installation to complete.