A newer version of this documentation is available.

View Latest

Using IPv6 With Couchbase

      +
      Couchbase Server supports IP version 6 (IPv6). Set-up is required for each platform.
      IPv6 support is only available in Couchbase Server Enterprise Edition.

      IPv6 Overview

      By default, when Couchbase Server starts up, it uses IPv4. To enable IPv6, set-up is required for each platform, as described in the sections below. Note that the steps for Linux and macOS are to be performed after the basic Couchbase Server installation is complete, and the steps for Windows are integrated into the basic installation procedure itself.

      In a clustered setup, IPv6 is enabled only when IPv6 is enabled on all of the nodes.

      See Installing the Couchbase Server Cluster for more information about installation procedures.

      IPv6 Set-Up for Linux

      After the Couchbase Server package has been installed, the couchbase service is started by default. Select the appropriate set-up procedure from the two procedures provided below, according to the cluster’s Couchbase server-version.

      Version 6.0.0

      Proceed as follows:

      1. Stop the couchbase-server service.

      2. In /opt/couchbase/etc/couchbase/static_config, set ipv6 to true.

      3. Delete /opt/couchbase/var/lib/couchbase/config/config.dat.

      4. Restart the couchbase-server service (this starts Couchbase Server in IPv6 mode). To check, point a supported web browser to http://[::1]:8091, which is the IPv6 address and port number on which Couchbase Server should be running.

      This concludes the procedure.

      Version 6.0.1 and All Higher 6.0.* Versions

      For version 6.0.1, and all higher 6.0.* versions, proceed as follows:

      1. On each node, execute the following command:

        curl http://<node-ip-address>:8091/node/controller/setupNetConfig -u <AdminName> -d 'afamily=ipv6'
      2. Restart the node. (See Startup and Shutdown for instructions.)

      This concludes the procedure.

      IPv6 Set-Up for Windows

      IPv6 set-up requirements are incorporated into the InstallShield wizard itself. During installation of the Couchbase package, a check box is available to enable IPv6 mode. (Note that after installation, any subsequent mode-change requires re-installation.)

      IPv6 Set-Up for macOS

      For a macOS-based cluster, after installing the Couchbase Server application, select the appropriate set-up procedure from the two procedures provided below, according to the cluster’s Couchbase server-version.

      Version 6.0.0

      Proceed as follows:

      1. Ensure that the couchbase-server service is stopped. (Quit the Couchbase Server application, if it is running.)

      2. In /Applications/Couchbase\ Server.app/Contents/Resources/couchbase-core/etc/couchbase/static_config.in, set ipv6 to true.

      3. Delete ~/Library/Application\ Support/Couchbase/var/lib/couchbase/config/config.dat.

      4. Restart the couchbase-server service (this starts Couchbase Server in IPv6 mode). To check, point a supported web browser to http://[::1]:8091, which is the IPv6 address and port number on which Couchbase Server should be running.

      This concludes the procedure.

      Version 6.0.1 and All Higher 6.0.* Versions

      For version 6.0.1, and all higher 6.0.* versions, proceed as follows:

      1. On each node, execute the following command:

        curl http://<node-ip-address>:8091/node/controller/setupNetConfig -u <AdminName> -d 'afamily=ipv6'
      2. Restart the node. (See Startup and Shutdown, for instructions.)

      This concludes the procedure.