A newer version of this documentation is available.

View Latest

Installing on Windows

Installation using a package management system on Windows.

This installation guide only supports 64-bit systems. Windows 7 and 8 are supported only for development purposes. See Supported platforms for details.


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.

Couchbase Server uses the Microsoft C++ redistributable package, which is automatically downloaded during installation. However, if another application on your machine is already using the package, your installation process can fail. To make sure that your installation process completes successfully, shut down all other running applications during installation. For Windows 2008, you must upgrade your Windows Server 2008 R2 installation with Service Pack 1 installed before running Couchbase Server. You can obtain Service Pack 1 from Microsoft TechNet.

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 a version of Couchbase Server and that runs on Windows Server 2012 R2:

$ wget.exe --no-check-certificate http://packages.couchbase.com/releases/version/couchbase-server-enterprise-version-windows_amd64.exe

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.exe 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:

    wizard 01
  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.

    wizard 02
  4. After installation, follow the server setup instructions.

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

An unattended installation, also referred to as silent or headless installation, uses a script to install Couchbase Server.

To use the unattended installation process:

  1. Record your installation settings in the wizard installation. These settings are saved to a file, which is used to silently install other nodes of the same version.

    1. Open a Command Terminal or Power and start the installation executable with the /r command-line option:

      > couchbase_server_version.exe /r /f1your_file_name.iss
    2. Provide your installation options when prompted. Accept an increase in MaxUserPort (recommended).

      The wizard completes the server installation and provides a file with your recorded options at C:\Windows\your_file_name.iss.

      Refer to a sample installation settings file available in the following gist.
  2. Copy the your_file_name.iss file into the same directory as the installer executable. Run the installer from the command-line using the /s option:

    > couchbase_server_version.exe /s -f1your_file_name.iss
  3. To repeat this process on multiple machines, copy the installation package and the your_file_name.iss file to the same directory on each machine.