A newer version of this documentation is available.

View Latest

Do a Quick Install

    First-time users can get Couchbase Server running simply and rapidly by using Docker. After it has been downloaded, a single command is all you need; to obtain, install, configure, and run Couchbase Server.

    Download Docker

    Docker is a freely available application that lets you install a fully configured Couchbase Server with a single command. To download Docker, go to the Docker installation page. This displays an Install the Platform pane:

    docker download page

    Pick the version of Docker that is appropriate for your platform: Mac, Windows, or Linux. Then, left-click on the corresponding Download or Install button:

    • On Mac, the Docker.dmg package is now downloaded. When the download has completed, open the package by double left-clicking on the icon. An interactive screen is then displayed: follow the instruction it provides, and drag-and-drop Docker into your Applications folder.

    • On Windows, when you left-click on the Download, button, a .msi file is downloaded. When the download has completed, open the file, and proceed as directed with installation.

    • On Linux, a list of Docker-supported distributions is displayed. From this list, pick the entry that corresponds to your current platform. You now see an instruction-page, provided by Docker. Follow these instructions, to perform installation.

    Note: For installation, you may need supervisor privileges on your machine (obtained, for example, by means of the sudo command, on MacOS and Linux).

    Run Docker, to Install Couchbase Server

    First, bring up an interactive console on your screen. Then, against the console-prompt, enter the following command:

    $ docker run -t --name db -p 8091-8094:8091-8094 -p 11210:11210 couchbase/server-sandbox:5.0.1

    Docker now obtains, downloads, installs, and configures Couchbase Server. During the download process, you see output like the following, in your console:

    $ docker run -t --name db -p 8091-8094:8091-8094 -p 11210:11210 couchbase/server-sandbox:5.0.1
    Unable to find image 'couchbase/server:sandbox' locally
    sandbox: Pulling from couchbase/server
    862a3e9af0ae: Pull complete
    6498e51874bf: Pull complete
    159ebdd1959b: Pull complete
    0fdbedd3771a: Pull complete
    7a1f7116d1e3: Pull complete
    b46618b72574: Pull complete
    67ea61a8c297: Pull complete
    969bb5073704: Pull complete
    ef8eeaf0285d: Pull complete
    1a797cd531fd: Pull complete
    2667ee2d486a: Pull complete
    d12025fc6fb6: Pull complete
    fc670031c36d: Pull complete
    da07033be0a7: Pull complete
    Digest: sha256:02231569d6ac86c0f5a05bd53665e76472ccd515de460bb56f6e621c868b6305

    Eventually, Couchbase Server is started, in a Docker virtual environment:

    Starting Couchbase Server -- Web UI available at http://<ip>:8091 and logs available in /opt/couchbase/var/lib/couchbase/logs
    Configuring Couchbase Server.  Please wait (~60 sec)...
    Configuring index and memory quotas
    Configuring Services
    Creating default Administrator credentials
    Enabling memory optimized indexes
    Loading travel-sample bucket
    Configuration completed - Couchbase Admin UI: http://localhost:8091

    When start-up is thus concluded, Couchbase Server is running in a default configuration, and can be accessed.

    Note: From this point, while you are using Couchbase Server, don’t close the console; since this terminates both Docker and Couchbase Server.


    You can now proceed directly to the next stage of the Getting Started sequence, and Look at the Results of your installation and configuration, using the Couchbase Web Console.

    Other Destinations

    At the end of the Getting Started sequence, you’ll find a comprehensive list of links; which allow you to investigate in greater detail all the subjects introduced on this page. However, if you don’t want to wait, you can learn more about Couchbase Server installation and configuration right away, by visiting the following locations:

    • Installing On-Premises explains how to install Couchbase Server directly onto your host, without the use of Docker or any other virtual environment. This kind of direct install is the one you will certainly use for production-deployments, and possibly for additional development and testing activities.

    • Initialize the Cluster provides a detailed explanation of how to custom-configure Couchbase Server at start-up. This is the procedure you will certainly use in production; as well as for testing different configurations. The available options include use of the Couchbase Web Console UI, the Couchbase REST API, and the Couchbase Command Line Interface.

    • Couchbase Server Startup and Shutdown tells you how to start and stop the server, using commands specific to your underlying platform.

    Optionally, when you have inspected these other destinations, you can return to the current page, and continue working through the Getting Started sequence.