You are viewing the documentation for a prerelease version.

View Latest

Install Couchbase Server on Ubuntu and Debian

Couchbase Server can be installed on Ubuntu Linux and Debian Linux for production and development use-cases. Root and non-root installations are supported.

Use the instructions on this page to install Couchbase Server on Ubuntu and Debian platforms using Couchbase-provided deb packages. The instructions support both Enterprise and Community editions.

If you’re upgrading an existing installation of Couchbase Server, refer to Upgrading Couchbase Server.

Before You Install

Couchbase Server works out-of-the-box with most OS configurations. However, the procedures on this page assume the following:

For production deployments, make sure to follow the deployment guidelines so that your systems and environment are properly sized and configured before installation.

Basic Installation

You must be logged in as root (superuser) or use sudo to run the installation commands.

Install Using Apt

The Advanced Package Tool (apt) provides the simplest and most comprehensive way to install Couchbase Server on Ubuntu and Debian platforms. This method involves downloading and installing a small meta package from Couchbase, which apt can then use to automatically download and install Couchbase Server and all of its dependencies.

  1. Download the meta package.

    curl -O https://packages.couchbase.com/releases/couchbase-release/couchbase-release-1.0-6-amd64.deb
  2. Install the meta package.

    sudo dpkg -i ./couchbase-release-1.0-6-amd64.deb

    The meta package installs the necessary information for apt to be able to retrieve all of the necessary Couchbase Server installation packages and dependencies.

  3. Reload the local package database.

    sudo apt-get update
  4. Install Couchbase Server.

    • Enterprise

    • Community

    To install the latest release
    sudo apt-get install couchbase-server
    To install a specific release
    1. List the available releases.

      apt list -a couchbase-server

      Available releases are listed with their full version-build number:

      couchbase-server/xenial 6.0.0-1693-1 amd64
    2. Specify a release to install it.

      sudo apt-get install couchbase-server=version-string

      Using the example listing from the previous step, the resulting installation command would be:

      sudo apt-get install couchbase-server=6.0.0-1693-1
    To install the latest release
    sudo apt-get install couchbase-server-community
    To install a specific release
    1. List the available releases.

      apt list -a couchbase-server-community

      Available releases are listed with their full version-build number:

      couchbase-server-community/xenial 6.0.0-1693-1 amd64
    2. Specify a release to install it.

      sudo apt-get install couchbase-server-community=version-string

      Using the example listing from the previous step, the resulting installation command would be:

      sudo apt-get install couchbase-server-community=6.0.0-1693-1

    The apt-get command automatically downloads and installs the latest version of Couchbase Server, along with all of its dependencies.

    Once installation is complete, Couchbase Server will start automatically (and will continue to start automatically at run levels 2, 3, 4, and 5, and explicitly shut down at run levels 0, 1, and 6). You can use the systemctl command (service on older operating systems) to start and stop the Couchbase Server service, as well as check the current status. Refer to Couchbase Server Startup and Shutdown for more information.

  5. Open a web browser and access the Couchbase Web Console to verify that the installation was successful and that the node is available.

Install Using Deb Package

Install Couchbase Server on Ubuntu and Debian using a full deb package provided by Couchbase.

  1. Download the appropriate package from the Couchbase downloads page.

  2. Reload the local package database.

    sudo apt-get update
  3. Install Couchbase Server.

    sudo dpkg -i ./package-name.deb

    If dpkg reports any errors about missing dependencies, issue the following command to download and install those dependencies from the internet:

    sudo apt-get -f install

    Once installation is complete, Couchbase Server will start automatically (and will continue to start automatically at run levels 2, 3, 4, and 5, and explicitly shut down at run levels 0, 1, and 6). You can use the systemctl command (service on older operating systems) to start and stop the Couchbase Server service, as well as check the current status. Refer to Couchbase Server Startup and Shutdown for more information.

  4. Open a web browser and access the Couchbase Web Console to verify that the installation was successful and that the node is available.

Installing as non-root, non-sudo

A non-root, non-sudo installation will run Couchbase Server and all Couchbase Server command-line tools.

Only 64 bit systems are supported.
  1. After downloading the Couchbase Server DEB package, go to the directory where it is located and extract it:

    dpkg-deb -x couchbase-server-version.deb $HOME

    In the directory where you extracted the files, you will see /opt and /etc subdirectories.

  2. After you extract the Couchbase Server installation files, go to the subdirectory:

    cd opt/couchbase
  3. Run the following script to relocate the Couchbase Server installation to the present working directory (PWD):

    ./bin/install/reloc.sh `pwd`

    This allows you to continue the installation as a non-root, non-sudo user.

  4. To run the server use

    ./bin/couchbase-server -- -noinput -detached
  5. To stop the server use

    ./bin/couchbase-server -k

Next Steps

Following installation and start-up of Couchbase Server, a node must be initialized and provisioned.

  • If it is the first node in a deployment, initialization and provisioning happens all at once when you create a cluster of one.

    Refer to Create a Cluster

  • If you already have an existing cluster, the node is initialized and provisioned when you add it to the cluster.

  • Optionally, initialization can be performed explicitly and independently of provisioning, as a prior process, in order to establish certain configurations, such as custom disk-paths.